Skip to content

Commit

Permalink
Initaial, after separation from twiz-server source code
Browse files Browse the repository at this point in the history
  • Loading branch information
@gits2501
gits2501 committed May 16, 2018
0 parents commit f0523d5
Show file tree
Hide file tree
Showing 3 changed files with 307 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules/
17 changes: 17 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "twiz-server-options",
"version": "1.0.0",
"description": " Makes request options out or user sent parameters",
"main": "src/Options.js",
"directories": {
"test": "test"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"author": "gits2501",
"license": "MIT",
"dependencies": {
"twiz-client-utils": "file:../../../testing/TwizClientWithBroserify/dependencies/twiz-client-utils"
}
}
289 changes: 289 additions & 0 deletions src/Options.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,289 @@
var CustomError = require('twiz-client-utils').CustomError;
var percentEncode = require('twiz-client-utils').percentEncode;
var EventEmitter = require('events').EventEmitter;
var url = require('url');

function Options (options, vault, args){ // builds request options and confugures user supplied parameters

vault.consumer_key = "", // app's consumer key
vault.consumer_secret = "",
vault.cert = "", // certificate (can be selfsigned)
vault.key = "" // private key (used for https encription)


var reqHeaders = { // holds headers of a request
'accept': "",
'authorization': "",
'accept-language': "",
'content-length': '0' // must be zero when method is POST with no body
}

function addUtils() {
this.missingVal_SBS = {
consumer_key: 'consumer_key',// Name of consumer key as it stands in OAuth (for SBS), without 'oauth'
// prefix. Used when inserting consumer_key value
token: 'token', // Name of access token param for SBS string. Used for inserting token.
marker: percentEncode("=&"), // "%3D%26" missing value marker for signature base string
offset: 3 // Esentialy length of percent encoded "&", we place missing between "="
// and "&"
},

this.missingVal_AHS = {
signature:'signature',
marker: "=\"\"", // ="" - missing value marker for authorization header string (AHS)
offset: 1
},

this.SBS_AHS_insert = function(phase, key, value){ // inserts missing keyValue pair to SBS and AH
var sbs = this[phase + 'SBS']; console.log('sbs_ah insert:',phase,sbs) // sbs of a phase)
this[phase + 'SBS'] = this.insertKey(sbs, this.missingVal_SBS, key, value); // set key in SBS

var ahs = this[phase + 'AH']; // take authorization header string of a phase
this[phase + 'AH'] = this.insertKey(ahs, this.missingVal_AHS, key , value, true);// set key/val in AH

},

this.insertKey = function(insertString, missingVal, keyName, keyValue, ah){ // insert missing key/value
var str = insertString;
var len = (keyName.length + missingVal.marker.length) - missingVal.offset;// calcualte idx from where // we insert the value
var idx = str.indexOf(keyName); // take index of the key we search
// console.log("marker: "+missingVal.marker, "consumer_key: "+ value, "idx: "+idx, "len: "+len)
var front = str.slice(0, idx + len); // taking first part
var end = str.slice(idx + len ) // taking second part
// console.log("front: " + front)
keyValue = ah ? percentEncode(keyValue) : percentEncode(percentEncode(keyValue));
// single encoding if
// insertString is AHS
str = front + keyValue + end; // assemble the string with new key/value
console.log("inserted: "+ str);
return str;
}

this.removeSubstr = function removeSubstr(str, regstr){ // removes subtring from a string
var regexp = new RegExp(regstr); // create regexp object from string
var removed = str.replace(regexp,''); // replace regexp pattern with empty string (remove it)

return removed;
}

this.trimEnd = function (str, endChars){ // Trims ending chars we specify, from a string
var endlength = endChars.length; // Lenght of characters we search at the end
var strlength = str.length // Lenght of the string
var end = str.slice(strlength - endlength, strlength); // Take end of the string
console.log('end', end)
if(end === endChars) return str.slice(0, strlength - endlength); // Chars are at the end, slice them
else return str; // Or return unchanged string

}

}

function addPhaseParams(){ // Adds parametars for each phase we support
addUtils.call(this); // add utility function that use phase params
this.apiSBS = ''; // SBS for api calls
this.apiAH = ''; // Ah for api calls
this.apiHost = ''; // host we hit for api calls
this.apiPath = '';
this.apiMethod = '';


this.legSBS = ''; // Signature base string for OAuth legs (steps)
this.legAH = ''; // Authorization header string
this.legHost = '';
this.legPath = '';
this.legMethod = '';

this.verSBS = '' // SBS for verify credentials
this.verAH = '';
this.verHost = '';
this.verPath = '';
this.verMethod = '';
}

function addFinalParams(){ // Adds parameters that node.js uses when sending a request
addPhaseParams.call(this)
this.host = "";
this.path = "";
this.method = "";
this.headers = "";
this.key = "";
this.cert = "";
}

addFinalParams.call(options);

CustomError.call(this);
this.addCustomErrors({
twiz: '[twiz-server] ',
consumerKeyNotSet: "You must provide consumer_key which identifies your app",
consumerSecretNotSet: "You must provide consumer_secret which identifies your app",
certNotSet: "You must provide cert (certificate) used in https encription when connecting to twitter.",
keyNotSet: "You must provide key (private key) used in https encription when connecting to twitter",
requestNotSet: "You must provide request (read) stream",
responseNotSet: "You must provide response (write) stream",
})

this.initOptions = function init(req, res, next){
console.log("in INIT")
// Encompases server logic
args.request = req;
args.response = res;
args.next = next;

this.setUserParams(args, vault); // Params needed for this lib to work
if(this.isPreflight()) return; // on preflighted requests stop here
console.log('before getOptions');
this.getOptions(reqHeaders); // Options sent in query portion of client request url and headers
this.setOptions(vault, reqHeaders, options); // sets options used for twitter request

this.setAppContext();
}

};

Options.prototype = Object.create(EventEmitter.prototype) // link EE prototype

Options.prototype.setUserParams = function(args, vault){
for(var name in args){
switch(name){
case "request":
this.request = args[name]; // set request stream
break;
case "response":
this.response = args[name]; // set response stream
break;
case "next":
this.next = args[name];
break;
case "consumer_key": // confidential app data
vault.consumer_key = args[name];
break;
case "consumer_secret":
vault.consumer_secret = args[name];
break;
case "key":
vault.key = args[name]; // reference to private key used in https encription
break;
case "cert":
vault.cert = args[name]; // reference to certificate used in https encription
break;
default:
console.log(name + " not supported");
}
}

this.checkAllParams(vault); // checks that all important params are in place

};

Options.prototype.checkAllParams = function (vault){

for(var name in vault){

switch(name){

case "key":
if(!vault[name]) throw this.CustomError('keyNotSet');
break;
case "cert":
if(!vault[name]) throw this.CustomError('certNotSet');
break;
case "consumer_key":
if(!vault[name]) throw this.CustomError('consumerKeyNotSet');
break;
case "consumer_secret":
if(!vault[name]) throw this.CustomError('consumerSecretNotSet');
break;
//for now we dont check for this.next (for compatibility with other frameworks)
}
}
if(!this.request) throw this.CustomError('requestNotSet');
if(!this.response) throw this.CustomError('responseNotSet');
}

Options.prototype.getOptions = function(reqHeaders){ // gets params from query portion of request url
this.sentOptions = url.parse(this.request.url, true).query // parses options sent in client request url
console.log('sentOptions: ', this.sentOptions);

this.getRequestHeaders(reqHeaders); // gets headers from client request and puts them in reqHeaders
};

Options.prototype.getRequestHeaders = function(reqHeaders){ // takes headers from request if header
// is supported ( is in reqHeaders)
var sentHeaders = this.request.headers // headers from request stream
for(var name in reqHeaders){ // omiting content-length, since it must be 0, for POST with no body
if(sentHeaders.hasOwnProperty(name) && name !== 'content-length') reqHeaders[name] = sentHeaders[name];
}
console.log("reqHeaders: " , reqHeaders);
};

Options.prototype.setOptions = function(vault, reqHeaders, options){ // Uses params sent in url to set
// them along options' prototype
// chain if those
// param names exists in prototype
for(var name in options){
if(this.sentOptions[name])
options[name] = this.sentOptions[name]; // If sentOptions has that
// property and it is not undefined.
// Querystring object is not
// connected to Object from node 6.0
// It doesnt have hasOwnProperty(..)
}

options.headers = reqHeaders // sets headers
options.cert = vault.cert; // sets certificate (https)
options.key = vault.key; // sets private_key used for https encription

console.log(" OPTIONS: ",options);
};


Options.prototype.setAppContext = function(){ // check the framework
this.app; // Can be reference to 'this.req.app' when in Express, or 'this' when in Connect

if(this.request.app){ // check express context
this.app = this.request.app;
console.log('express confirmed');
}
else if(this.next){ // For connect context just check if there is 'next' function
EventEmitter.init.call(this); // Call emitter constructor on this object
this.app = this; // app is 'this', since we are linked to EventEmitter
console.log('Connect confirmed')
}
};

Options.prototype.isPreflight = function() { // has to go as saparate middleware
var preflight; console.log('Preflight: method:', this.request.method);
if (this.request.method == "OPTIONS"){ // Both needs to be plased for PREFLIGHT
preflight = true;
console.log("preflight request with OPTIONS");
this.response.setHeader("Access-Control-Allow-Headers","content-type , authorization");
this.response.setHeader("Access-Control-Allow-Origin", "https://gits2501.github.io");
}
else {
this.response.setHeader("Access-Control-Allow-Origin","https://gits2501.github.io"); // Other (no preflight) can have just this.
// this.response.setHeader("Content-Type", "application/json");
return preflight;
}

console.log("URL source: " + this.request.url); console.log("url parsed:", url.parse(this.request.url, true).query)
console.log("domain: " + this.request.domain)
var body = "";

this.request.on('end', function(){ console.log("REQ ended")
console.log("Sent BODY: "+ body)
console.log("resp headers: " + this.response.headers)
}.bind(this))

this.request.on('error', function(err){
console.log("Error: "+ err);
this.next(err)
}.bind(this))
this.response.end();


return preflight;

}

module.exports = Options;

0 comments on commit f0523d5

Please sign in to comment.