Merge pull request #25 from TourCMS/release/1.3.0

release/1.3.0

Author: paulslugocki

node-tourcms.js

@@ -17,7 +17,9 @@ function TourCMS(options) {
     apiKey: '',
     marketplaceId: 0,
     channelId: 0,
-    channels: []
+    channels: [],
+    userAgent: '',
+    prependCallerToUserAgent: true
   };
 
   if(typeof options !== 'undefined') {
@@ -30,6 +32,9 @@ function TourCMS(options) {
 
     if(typeof options.channelId !== 'undefined')
       this.options.channelId = options.channelId;
+      
+    if(typeof options.userAgent !== 'undefined')
+      this.options.userAgent = options.userAgent;
   }
 
 }
@@ -60,16 +65,20 @@ TourCMS.prototype.makeRequest = function(a) {
   // Generate the signature
   var signature = this.generateSignature(a.path, a.channelId, a.verb, outboundTime, this.options.apiKey);
 
+  var headers = {
+    'x-tourcms-date': outboundTime,
+    'Authorization': 'TourCMS ' + a.channelId + ':' + this.options.marketplaceId + ':' + signature,
+    'Content-type': 'text/xml;charset="utf-8"',
+    'Content-length': Buffer.byteLength(apiParams, 'utf8')
+  };
+
+  headers = this.addUserAgent(headers, a);
+
   var options = {
     method: a.verb,
     hostname: this.options.hostname,
     path: a.path,
-    headers: {
-      'x-tourcms-date': outboundTime,
-      'Authorization': 'TourCMS ' + a.channelId + ':' + this.options.marketplaceId + ':' + signature,
-      'Content-type': 'text/xml;charset="utf-8"',
-      'Content-length': Buffer.byteLength(apiParams, 'utf8')
-    }
+    headers: headers
   };
 
   var req = https.request(options, function(response) {
@@ -1296,6 +1305,22 @@ TourCMS.prototype.generateSignature = function(path, channelId, verb, outboundTi
   return signature;
 };
 
+TourCMS.prototype.addUserAgent = function(headers, a) {
+
+  let userAgent = this.options.userAgent;
+
+  if(userAgent == '')
+    return headers;
+
+  if(this.options.prependCallerToUserAgent) 
+      userAgent = userAgent + ' (' + this.options.marketplaceId + "_" + a.channelId + ')';
+
+  headers['User-Agent'] = userAgent;
+
+  return headers;
+
+}
+
 // Generate the current Unix Timestamp (PHP style)
 TourCMS.prototype.generateTime = function() {
   return Math.floor(new Date().getTime() / 1000);

package.json

@@ -6,7 +6,7 @@
     "api"
   ],
   "homepage": "https://github.com/tourcms/node-tourcms",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "author": "TourCMS <[email protected]> (http://www.tourcms.com)",
   "contributors": [
     "Paul Slugocki <[email protected]> (https://github.com/paulslugocki)"

readme.md

@@ -74,7 +74,8 @@ Create a new `tourcms` API object, passing in your API credentials
 var TourCMS = new TourCMSApi({
     channelId: YOUR_CHANNEL_ID,
     apiKey: 'YOUR_API_KEY',
-    marketplaceId: YOUR_MARKETPLACE_ID
+    marketplaceId: YOUR_MARKETPLACE_ID,
+    userAgent: 'Your app name'
   });
 ```
 Then call one of the API methods below.