Merge pull request #39 from usabilla/client-configuration

feat(usabilla): add support for configuring client

Author: spirosikmd

README.md

@@ -38,6 +38,29 @@ usabilla.websites.buttons.get().then((buttons) => {
 
 See the code in the [example folder](https://github.com/usabilla/api-js-node/tree/master/example) for more advanced ideas on how to use the client.
 
+### Configuration
+
+The client can be configured during instantiation with the following options:
+
+- `protocol` (default: `https`) - The protocol to use when making requests
+- `host` (default: `data.usabilla.com`) - The host to use when making requests
+- `port` (default: `null`) - The port to use when making requests
+- `iterator` (default: `true`) - Whether to iterate until all results are retrieved
+
+For example:
+
+```js
+const Usabilla = require('usabilla-api');
+const options = {
+  protocol: 'http',
+  host: 'proxy-host',
+  port: 'proxy-port'
+}
+const usabilla = new Usabilla('YOUR-ACCESS-KEY', 'YOUR-SECRET-KEY', options);
+
+// usabilla.websites.buttons.get()
+```
+
 ## Support
 
 The Usabilla Node.js Client API is maintained by Usabilla Development Team. Everyone is encouraged to file bug reports,

package.json

@@ -15,6 +15,7 @@
     "cz-conventional-changelog": "^2.0.0",
     "eslint": "^3.12.2",
     "gulp": "^3.9.1",
+    "husky": "^0.14.3",
     "isparta": "^4.0.0",
     "jasmine": "^2.5.2",
     "jasmine-core": "^2.5.2",
@@ -24,6 +25,8 @@
     "karma-coverage": "^1.1.1",
     "karma-coveralls": "^1.1.2",
     "karma-jasmine": "^1.0.2",
+    "lint-staged": "^4.2.3",
+    "prettier-eslint-cli": "^4.4.0",
     "semantic-release": "^6.3.2",
     "vinyl-source-stream": "^1.1.0",
     "wallabify": "0.0.14",
@@ -39,7 +42,9 @@
     "lint:fix": "npm run lint -- --fix",
     "posttest": "npm run lint",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post",
-    "commit": "git-cz"
+    "commit": "git-cz",
+    "precommit": "lint-staged",
+    "format": "prettier-eslint --write --single-quote"
   },
   "repository": {
     "type": "git",
@@ -55,5 +60,11 @@
     "commitizen": {
       "path": "node_modules/cz-conventional-changelog"
     }
+  },
+  "lint-staged": {
+    "*.js": [
+      "format",
+      "git add"
+    ]
   }
 }

src/index.js

@@ -8,24 +8,24 @@ const AppsProduct = require('./resources/appsProduct');
  * Needs to be instantiated with access and secret keys.
  */
 class Usabilla {
+  constructor(accessKey, secretKey, options = {}) {
+    this.config = Object.assign(
+      {},
+      {
+        protocol: 'https',
+        host: 'data.usabilla.com',
+        port: null,
+        iterator: true
+      },
+      options
+    );
 
-  constructor(accessKey, secretKey) {
-    this.config = {
-      method: 'GET',
-      host: 'data.usabilla.com',
-      iterator: true
-    };
-
-    const signatureFactory = new SignatureFactory(accessKey, secretKey, this.config.host);
+    const signatureFactory = new SignatureFactory(accessKey, secretKey);
 
     this.websites = new WebsitesProduct('/live', signatureFactory, this.config);
     this.email = new EmailProduct('/live', signatureFactory, this.config);
     this.apps = new AppsProduct('/live', signatureFactory, this.config);
   }
-
-  configure(options) {
-    Object.assign(this.config, options);
-  }
 }
 
 module.exports = Usabilla;

src/resources/appsProduct.js

@@ -4,7 +4,6 @@ const FormsResource = require('./formsResource');
  * Apps product endpoints.
  */
 class AppsProduct {
-
   constructor(base, signatureFactory, config) {
     const baseUrl = `${base}/apps`;
 

src/resources/buttonFeedbackResource.js

@@ -4,7 +4,6 @@ const Resource = require('./resource');
  * Websites Buttons feedback resource.
  */
 class ButtonFeedbackResource extends Resource {
-
   constructor(base, signatureFactory, config) {
     super(`${base}/:id/feedback`, signatureFactory, config);
   }

src/resources/buttonsResource.js

@@ -5,12 +5,15 @@ const ButtonFeedbackResource = require('./buttonFeedbackResource');
  * Websites Buttons resource.
  */
 class ButtonsResource extends Resource {
-
   constructor(base, signatureFactory, config) {
     const baseUrl = `${base}/button`;
     super(baseUrl, signatureFactory, config);
 
-    this.feedback = new ButtonFeedbackResource(baseUrl, signatureFactory, config);
+    this.feedback = new ButtonFeedbackResource(
+      baseUrl,
+      signatureFactory,
+      config
+    );
   }
 }
 

src/resources/campaignsResource.js

@@ -6,12 +6,15 @@ const CampaignsStatsResource = require('./campaignsStatsResource');
  * Websites Campaigns resource.
  */
 class CampaignsResource extends Resource {
-
   constructor(base, signatureFactory, config) {
     const baseUrl = `${base}/campaign`;
     super(baseUrl, signatureFactory, config);
 
-    this.results = new CampaignsResultsResource(baseUrl, signatureFactory, config);
+    this.results = new CampaignsResultsResource(
+      baseUrl,
+      signatureFactory,
+      config
+    );
     this.stats = new CampaignsStatsResource(baseUrl, signatureFactory, config);
   }
 }

src/resources/campaignsResultsResource.js

@@ -5,7 +5,6 @@ const Resource = require('./resource');
  * This resource provides the responses for a single or all campaigns.
  */
 class CampaignsResultsResource extends Resource {
-
   constructor(base, signatureFactory, config) {
     const baseUrl = `${base}/:id/results`;
     super(baseUrl, signatureFactory, config);

src/resources/campaignsStatsResource.js

@@ -5,7 +5,6 @@ const Resource = require('./resource');
  * This resource provides the main statistics from a campaign.
  */
 class CampaignsStatsResource extends Resource {
-
   constructor(base, signatureFactory, config) {
     const baseUrl = `${base}/:id/stats`;
     super(baseUrl, signatureFactory, config);

src/resources/emailProduct.js

@@ -4,7 +4,6 @@ const WidgetsResource = require('./widgetsResource');
  * Email product endpoints.
  */
 class EmailProduct {
-
   constructor(base, signatureFactory, config) {
     const baseUrl = `${base}/email`;