jive-sdk
Version:
Node.js SDK for Jive Software to assist with the development of add-ons
478 lines (378 loc) • 13.3 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Jive SDK Source: jive-sdk-api/lib/util/request.js</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.spacelab.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top navbar-inverse">
<div class="navbar-inner">
<a class="brand" href="index.html">Jive SDK</a>
<ul class="nav">
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="module-abstractDefinitions.html">abstractDefinitions</a>
</li>
<li>
<a href="module-abstractInstances.html">abstractInstances</a>
</li>
<li>
<a href="module-addOnRoutes.html">addOnRoutes</a>
</li>
<li>
<a href="module-api.html">api</a>
</li>
<li>
<a href="module-community.html">community</a>
</li>
<li>
<a href="module-constants.html">constants</a>
</li>
<li>
<a href="module-devRoutes.html">devRoutes</a>
</li>
<li>
<a href="module-events.html">events</a>
</li>
<li>
<a href="module-extensions.html">extensions</a>
</li>
<li>
<a href="module-extstreamsInstances.html">extstreamsInstances</a>
</li>
<li>
<a href="module-jiveutil.html">jiveutil</a>
</li>
<li>
<a href="module-oauthRoutes.html">oauthRoutes</a>
</li>
<li>
<a href="module-request.html">request</a>
</li>
<li>
<a href="module-security.html">security</a>
</li>
<li>
<a href="module-service.html">service</a>
</li>
<li>
<a href="module-tasks.html">tasks</a>
</li>
<li>
<a href="module-tileInstances.html">tileInstances</a>
</li>
<li>
<a href="module-tileRoutes.html">tileRoutes</a>
</li>
<li>
<a href="module-tilesDefinitions.html">tilesDefinitions</a>
</li>
<li>
<a href="module-webhooks.html">webhooks</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="extstreamsDefinitions.html">extstreamsDefinitions</a>
</li>
<li>
<a href="filePersistence.html">filePersistence</a>
</li>
<li>
<a href="memoryPersistence.html">memoryPersistence</a>
</li>
<li>
<a href="memoryScheduler.html">memoryScheduler</a>
</li>
<li>
<a href="oauthHandler.html">oauthHandler</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span12">
<div id="main">
<h1 class="page-title">Source: jive-sdk-api/lib/util/request.js</h1>
<section>
<article>
<pre class="sunlight-highlight-javascript linenums">/*
* Copyright 2013 Jive Software
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Library of methods for making requests.
* @module request
* @abstract
*/
///////////////////////////////////////////////////////////////////////////////////
// private
var URL = require('url');
var request = require('request');
var q = require('q');
var jive = require('../../api');
var constants = require("./constants");
/**
* By default this will build a request of type 'application/json'. Set a Content-Type header
* explicitly if its supposed to be a different type.
* @param {String} url
* @param {String} method
* @param {Object} postBody leave null unless PUT or POST
* @param {Object} headers leave null or empty [] if no additional headers
* @param {Object} requestOptions leave null or empty [] if no additional request optinos
* @return {Promise} Promise
*/
exports.buildRequest = function (url, method, postBody, headers, requestOptions) {
var urlParts = URL.parse(url, true);
var path = urlParts.path;
var host = urlParts.hostname;
var port = urlParts.port;
var protocol = urlParts.protocol;
var deferred = q.defer();
requestOptions = requestOptions || {};
if ( jive.context && jive.context.config ) {
if ( jive.context.config['development'] == true ) {
requestOptions['rejectUnauthorized'] = false;
}
}
requestMaker(
method,
{ host: host, port: port },
path,
headers || {},
postBody,
protocol && protocol.indexOf('https') == 0,
requestOptions || {}
).execute(
// success
function (response) {
var body = response && response.entity && response.entity.body;
if (body && body.indexOf && body.indexOf(constants.SECURITY_STRING) === 0) {
response.entity.body = body.substring(constants.SECURITY_STRING.length);
}
deferred.resolve(response);
},
// failure
function (response) {
deferred.reject(response);
}
);
return deferred.promise;
};
var jsonResponseCallbackWrapper = function (response, body, successCallback, errCallback) {
var responseHeaders = response['headers'];
var statusCode = response['statusCode'];
var isErrorCode = !( statusCode >= 200 && statusCode <= 299 );
var resp = {
'statusCode': statusCode,
'headers': responseHeaders
};
if (body && body.length > 0) {
try {
resp['entity'] = JSON.parse(body);
} catch (e) {
resp['entity'] = {status: statusCode, body: body }
}
}
if (isErrorCode && errCallback) {
jive.logger.debug("err:", resp);
errCallback(resp);
} else if (successCallback) {
jive.logger.debug("success:", resp);
successCallback(resp);
}
};
var requestMaker = function (method, serverInfo, path, headers, body, secure, requestOptions) {
if (typeof body === 'undefined' || body === null) {
body = '';
}
// these are used in the http or https .request
var options = {
host: serverInfo.host,
port: serverInfo.port,
method: method || 'GET',
path: path,
headers: headers || {}
};
if (requestOptions) {
for (var key in requestOptions) {
if (requestOptions.hasOwnProperty(key)) {
options[key] = requestOptions[key];
}
}
}
var postBodyStr;
if (method === 'POST' || method === 'PUT') {
if (!(headers['Content-Type'])) {
if (typeof body === 'object') {
headers['Content-Type'] = 'application/json'; //If it's an object, set default content type to application/json
}
else if (typeof body === 'string') {
try {
var parsed = JSON.parse(body);
headers['Content-Type'] = 'application/json'; //If it parses as a JSON object set Content-Type to application/json
} catch (e) {
//do nothing, send request without content type
}
}
}
postBodyStr = '';
var contentType = headers['Content-Type'];
if (contentType === 'application/json') {
if (typeof body === 'object') {
postBodyStr = JSON.stringify(body);
} else if (typeof body === 'string') {
postBodyStr = body;
} else {
throw new Error("Illegal type of post body; only object or string is permitted.");
}
} else if (contentType === 'application/x-www-form-urlencoded') {
var postObject;
if (typeof body === 'string') {
try {
postObject = JSON.parse(body);
} catch (e) {
postBodyStr = body;
}
} else if (typeof body === 'object') {
postObject = body;
}
else {
throw new Error("Illegal type of post body; only object or string is permitted.");
}
for (var key in postObject) {
if (postObject.hasOwnProperty(key)) {
if (postBodyStr.length > 0) {
postBodyStr += '&';
}
postBodyStr += encodeURIComponent(key) + '=' + encodeURIComponent(postObject[key]);
}
}
}
else {
postBodyStr = body.toString();
}
headers['Content-Length'] = Buffer.byteLength(postBodyStr, 'utf8');
}
return {
execute: function (successCallback, errCallback) {
var request = require('request');
var url = ( secure ? 'https' : 'http') + '://' +
options['host'] +
( options['port'] ? ':' + options['port'] : ( secure ? (':' + 443) : '' ) ) +
options['path']
;
options['url'] = url;
if (postBodyStr) {
options['body'] = postBodyStr;
}
delete options['host'];
delete options['path'];
jive.logger.debug("Request: " + url + ", body: " + postBodyStr);
request(options, function (error, response, body) {
if (error) {
jive.logger.warn("Error making request: %s", JSON.stringify(error));
jive.logger.debug("response body: ", response ? (response.statusCode || "no status code") : "no response", body || "no body");
jive.logger.debug("Options: %s", JSON.stringify(options));
errCallback(error);
}
else {
jsonResponseCallbackWrapper(response, body, successCallback, errCallback);
}
});
}
}
};
exports.parseJiveExtensionHeaders = function(req) {
var authorization = req.headers['authorization'];
if (!authorization) {
return;
}
var jiveIdentity = {};
var authVars = authorization.split(' ');
if (authVars[0] == 'JiveEXTN') {
// try to parse out jiveURL
var authParams = authVars[1].split('&');
authParams.forEach(function (p) {
if (p.indexOf('jive_url') == 0) {
jiveIdentity['jiveURL'] = decodeURIComponent(p.split("=")[1]);
}
if (p.indexOf('tenant_id') == 0) {
var tenantID = decodeURIComponent(p.split("=")[1]);
jiveIdentity['tenantID'] = tenantID;
}
});
return jiveIdentity;
} else {
return undefined;
}
};
</pre>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
Jive Software, Inc
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-dev</a>
on Wed Jan 22 2014 12:29:37 GMT-0800 (PST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>