Change to object configuration. Closes #2

Author: RyanTheAllmighty

README.md

@@ -4,15 +4,18 @@ Node.js module for interacting with the ATLauncher API.
 
 Examples
 ----
-To get started simply require the package and optionally provide the arguments it needs.
+To get started simply require the package and optionally provide an optional object with settings.
 
 ```
-var api = require('atlauncher-api')(API_KEY, FORCE);
+var api = require('atlauncher-api')({
+    api_key: 'my-api-key,
+    force_run: false
+});
 ```
 
-The API_KEY argument is your API-KEY used for admin or PSP api calls.
+The api_key argument is your API-KEY used for admin or PSP api calls.
 
-The FORCE argument is a boolean (true/false) if we should ignore breaking api calls. For instance when you're about to reach your request limit and get IP banned the force option will allow you to bypass the exception which gets thrown halting execution.
+The force_run argument is a boolean (true/false) if we should ignore breaking api calls. For instance when you're about to reach your request limit and get IP banned the force option will allow you to bypass the exception which gets thrown halting execution.
 
 For instance for running public api calls such as getting a list of all packs you can use the following:
 

index.js

@@ -16,15 +16,24 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 
-module.exports = function (apiKey, forceRun, baseUrl, version) {
+module.exports = function (obj) {
     var request = require('request'),
         fs = require('fs'),
-        baseUrl = baseUrl || 'https://api.atlauncher.com/',
-        version = version || 'v1',
-        forceRun = forceRun || false;
+        merge = require('merge');
+
+    var settings = {
+        base_url: 'https://api.atlauncher.com/',
+        api_version: 'v1',
+        api_key: false,
+        force_run: false
+    };
+
+    if (obj !== undefined) {
+        settings = merge(settings, obj);
+    }
 
     var makeUrl = function (path) {
-        return baseUrl + version + '/' + (path ? path : '');
+        return settings.base_url + settings.api_version + '/' + (path ? path : '');
     };
 
     var saveToFile = function (err, res, saveTo, base64, callback) {
@@ -55,7 +64,7 @@ module.exports = function (apiKey, forceRun, baseUrl, version) {
     };
 
     var makeRequest = function (needsApiKey, path, method, data, callback) {
-        if (needsApiKey && !apiKey) {
+        if (needsApiKey && !settings.api_key) {
             return console.error('An API Key must be set in order to make this request!');
         }
 
@@ -77,16 +86,16 @@ module.exports = function (apiKey, forceRun, baseUrl, version) {
             options.body = data;
         }
 
-        if (apiKey) {
-            options.headers['API-KEY'] = apiKey;
+        if (settings.api_key) {
+            options.headers['API-KEY'] = settings.api_key;
         }
 
         request(options, function (err, req, body) {
             if (!err && body.error && body.code == 401 && body.message == 'API key missing or invalid!') {
                 console.error('The API key provided was not valid!');
             }
 
-            if (!err && body && body.code == 429 && !forceRun) {
+            if (!err && body && body.code == 429 && !settings.force_run) {
                 // Exceeded API request limit, we must stop now
                 throw new Error(body.message);
             }
@@ -97,7 +106,7 @@ module.exports = function (apiKey, forceRun, baseUrl, version) {
 
     return {
         heartbeat: function (callback) {
-            makeRequest(false, baseUrl, 'GET', callback);
+            makeRequest(false, settings.base_url, 'GET', callback);
         },
         pack: function (name, version, callback) {
             if (version && !callback) {

package.json

@@ -1,27 +1,28 @@
 {
-    "name": "atlauncher-api",
-    "version": "1.0.3",
-    "description": "Node.js module for interacting with the ATLauncher API",
-    "main": "index.js",
-    "scripts": {
-        "test": "node tests/test.js"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/ATLauncher/ATLauncher-API---NodeJS.git"
-    },
-    "keywords": [
-        "atlauncher",
-        "minecraft",
-        "api"
-    ],
-    "author": "ATLauncher",
-    "license": "GNU GPLv3",
-    "bugs": {
-        "url": "https://github.com/ATLauncher/ATLauncher-API---NodeJS/issues"
-    },
-    "homepage": "https://github.com/ATLauncher/ATLauncher-API---NodeJS",
-    "dependencies": {
-        "request": "^2.54.0"
-    }
+  "name": "atlauncher-api",
+  "version": "1.1.0",
+  "description": "Node.js module for interacting with the ATLauncher API",
+  "main": "index.js",
+  "scripts": {
+    "test": "node tests/test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ATLauncher/ATLauncher-API---NodeJS.git"
+  },
+  "keywords": [
+    "atlauncher",
+    "minecraft",
+    "api"
+  ],
+  "author": "ATLauncher",
+  "license": "GNU GPLv3",
+  "bugs": {
+    "url": "https://github.com/ATLauncher/ATLauncher-API---NodeJS/issues"
+  },
+  "homepage": "https://github.com/ATLauncher/ATLauncher-API---NodeJS",
+  "dependencies": {
+    "merge": "^1.2.0",
+    "request": "^2.54.0"
+  }
 }

tests/admin.js

@@ -18,7 +18,9 @@
 
 'use strict';
 
-var atlauncher = require('../index')(process.env.API_KEY),
+var atlauncher = require('../index')({
+        api_key: process.env.API_KEY
+    }),
     assert = require('assert');
 
 

tests/psp.js

@@ -18,7 +18,9 @@
 
 'use strict';
 
-var atlauncher = require('../index')(process.env.PSP_API_KEY),
+var atlauncher = require('../index')({
+        api_key: process.env.PSP_API_KEY
+    }),
     assert = require('assert');
 
 atlauncher.psp.packs.all(function (err, res) {

tests/public.js

@@ -18,7 +18,9 @@
 
 'use strict';
 
-var atlauncher = require('../index')(process.env.API_KEY),
+var atlauncher = require('../index')({
+        api_key: process.env.API_KEY
+    }),
     assert = require('assert');
 
 atlauncher.heartbeat(function (err, res) {