Allow configured protocol - #18

README.md

@@ -14,6 +14,7 @@ Create a `fogbugz.conf.json` in your app's root directory.  It should look like
 
 ```json
 {
+  "protocol": "https",
   "host": "zzz.fogbugz.com",
   "username": "zzz@yyy.com",
   "password": "Password1"

index.js

@@ -17,9 +17,10 @@
  this:
  ```json
  {
+   "protocol": "https",
    "host": "zzz.fogbugz.com",
    "username": "zzz@yyy.com",
- "password": "Password1"
+   "password": "Password1"
  }
  ```
  Usage
@@ -49,12 +50,6 @@ var cache = require('memory-cache');
 var conf;
 var fogbugz;
 
-/**
- * Default protocol
- * @type {string}
- */
-var PROTOCOL = 'https';
-
 /**
  * URL masks for the various API calls
  * @type {{logon: string, logoff: string, listFilters: string,
@@ -201,7 +196,7 @@ fogbugz = {
     if (!token) {
       dfrd.reject(MODULE_ERRORS.undefinedToken);
     } else {
-      request(format(URLs.logoff, PROTOCOL, conf.host, token),
+      request(format(URLs.logoff, conf.protocol, conf.host, token),
         function(err) {
           if (err) {
             dfrd.reject(err);
@@ -236,7 +231,7 @@ fogbugz = {
       });
     }
 
-    request(format(URLs.logon, PROTOCOL, conf.host, conf.username,
+    request(format(URLs.logon, conf.protocol, conf.host, conf.username,
         conf.password),
       function(err, res, body) {
         var newToken;
@@ -285,7 +280,7 @@ fogbugz = {
               type: filter.$.type,
               id: filter.$.sFilter,
               url: format('%s://%s/default.asp?pgx=LF&ixFilter=%s',
-                PROTOCOL, conf.host, filter.$.sFilter)
+                conf.protocol, conf.host, filter.$.sFilter)
             });
           });
       }
@@ -294,7 +289,7 @@ fogbugz = {
     if (!token) {
       dfrd.reject(MODULE_ERRORS.undefinedToken);
     } else {
-      request(format(URLs.listFilters, PROTOCOL, conf.host, token),
+      request(format(URLs.listFilters, conf.protocol, conf.host, token),
         function(err, res, body) {
           var filters;
           if (err) {
@@ -327,7 +322,7 @@ fogbugz = {
       dfrd.reject(MODULE_ERRORS.undefinedToken);
     } else {
       id = typeof filter === 'string' ? filter : filter.id;
-      request(format(URLs.setCurrentFilter, PROTOCOL, conf.host, id,
+      request(format(URLs.setCurrentFilter, conf.protocol, conf.host, id,
         token), function(err, res, body) {
         if (err) {
           dfrd.reject(err);
@@ -370,7 +365,7 @@ fogbugz = {
           operations: kase.$.operations.split(','),
           title: kase.sTitle[0].trim(),
           status: kase.sStatus[0].trim(),
-          url: format('%s://%s/default.asp?%s', PROTOCOL, conf.host,
+          url: format('%s://%s/default.asp?%s', conf.protocol, conf.host,
             kase.$.ixBug),
           fixFor: kase.sFixFor[0].trim()
         });
@@ -410,7 +405,7 @@ fogbugz = {
     if (!token) {
       dfrd.reject(MODULE_ERRORS.undefinedToken);
     } else {
-      url = format(URLs.search, PROTOCOL, conf.host, query, fields, max,
+      url = format(URLs.search, conf.protocol, conf.host, query, fields, max,
         token);
       request(url, function(err, res, body) {
         var newCases;
@@ -457,7 +452,7 @@ fogbugz = {
           operations: kase.$.operations.split(','),
           title: kase.sTitle[0].trim(),
           status: kase.sStatus[0].trim(),
-          url: format('%s://%s/default.asp?%s', PROTOCOL, conf.host,
+          url: format('%s://%s/default.asp?%s', conf.protocol, conf.host,
             kase.$.ixBug),
           fixFor: kase.sFixFor[0].trim()
         });
@@ -497,7 +492,7 @@ fogbugz = {
     if (!token) {
       dfrd.reject(MODULE_ERRORS.undefinedToken);
     } else {
-      url = format(URLs.edit, PROTOCOL, conf.host, token, id, fields);
+      url = format(URLs.edit, conf.protocol, conf.host, token, id, fields);
       // Some work need to do, parameters .....
       Object.keys(parameters).forEach(function(k) {
         url += '&' + k + '=' + parameters[k];
@@ -537,6 +532,9 @@ if (process.env.NODE_FOGBUGZ_CONFIG) {
   conf = require('./fogbugz.conf.json');
 }
 
+//Default to https if protocol not specified in conf (backwards compatibility)
+conf.protocol = conf.protocol || 'https';
+
 module.exports = fogbugz;
 module.exports.Filter = Filter;
 module.exports.Case = Case;