test(shiptheory) test config and authentication

Author: ndvo

package.json

@@ -4,7 +4,7 @@
   "description": "Run serverless functions on Netlify to work with the Foxy.io hypermedia API.",
   "private": false,
   "scripts": {
-    "test": "nyc mocha \"src/**/*.test.js\"",
+    "test": "nyc mocha \"test/**/*.test.js\"",
     "start": "netlify dev",
     "start-http": "http-server ./src/functions --port 9000 -c-1"
   },

src/functions/shiptheory/DataStore.js

@@ -40,7 +40,6 @@ class DataStore extends DataStoreBase {
    */
   async authenticate() {
     if (!this.token) {
-      console.log('credentials', this.credentials);
       const response = await fetch(this.buildEndpoint('token'), {
         body: JSON.stringify({
           email: this.credentials.email,
@@ -50,7 +49,6 @@ class DataStore extends DataStoreBase {
         method: 'POST'
       });
       const parsed = await response.json();
-      console.log('parsed', parsed);
       this.token = parsed.success && parsed.data.token;
     } 
     return !!this.token;

src/functions/shiptheory/README.md

@@ -9,6 +9,7 @@ This integration allows you to create shipments in ShipTheory for Foxy.io transa
 - Grab the function URL
 - Configure your Foxy Store to use that URL
 
+You will also need to configure your SipTheory rules.
 
 # Reference
 

test/functions/shiptheory/DataStore.test.js

@@ -0,0 +1,51 @@
+const { after, afterEach, before, beforeEach, describe, it } = require("mocha");
+const {expect} = require("chai");
+const rewire = require("rewire");
+const DataStore = rewire("../../../src/functions/shiptheory/DataStore.js");
+const mockShipTheoryAPI = require("./MockShipTheoryAPI");
+
+
+
+
+describe("ShipTheory Client", function() {
+  let restore;
+  before(
+    function() {
+      restore = DataStore.__set__('fetch', mockShipTheoryAPI.fetch);
+    }
+  );
+
+  after(
+    function() {
+      restore();
+    }
+  );
+
+  it ("Should be configured usig environment variables.", function() {
+    const ds = new DataStore();
+    process.env["FOXY_SHIPTHEORY_EMAIL"] = 'email';
+    process.env["FOXY_SHIPTHEORY_PASSWORD"] = 'password';
+    ds.setCredentials();
+    expect(ds.credentials).to.exist;
+    expect(ds.credentials).to.deep.equal({email:'email', password:'password'});
+  });
+
+  it ("Should always add Accept and Content-Type to headers", function() {
+    const ds = new DataStore();
+    const defaultHeader = ds.getDefaultHeader();
+    expect(defaultHeader.Accept).to.exist;
+    expect(defaultHeader['Content-Type']).to.exist;
+    expect(defaultHeader.Accept).to.equal('application/json');
+  });
+
+  it ("Should authenticate in ShipTheory", async function() {
+    const ds = new DataStore();
+    const result = await ds.authenticate();
+    expect(ds.token).to.exist;
+    expect(ds.token).to.equal('token');;
+  });
+
+  
+
+
+});

test/functions/shiptheory/MockShipTheoryAPI.js

@@ -0,0 +1,25 @@
+
+
+async function fetch(endpoint, options) {
+  if (endpoint.match(/token/)){
+    return {
+      json: async function() {
+        return {
+          data: {token: 'token'},
+          success: true,
+        }
+      }
+    }
+  } else if (enpoint.match(/shipments/)) {
+    return {
+      json: async function() {
+        return {
+          success: true,
+        }
+      }
+    }
+  }
+}
+
+
+exports.fetch = fetch

test/functions/shiptheory/index.test.js

@@ -0,0 +1,43 @@
+const { after, afterEach, before, beforeEach, describe, it } = require("mocha");
+const {expect} = require("chai");
+const handler = require("../../../src/functions/shiptheory/index.js");
+const sinon = require("sinon"); 
+
+describe("Shiptheory", function() {
+
+  describe("Validation", function() {
+    describe ("Should warn about invalid configuration", async function () {
+      let stub;
+      beforeEach(
+        function () {
+          stub = sinon.stub(console, "error");
+        }
+      );
+      afterEach(
+        function () {
+          stub.restore();
+        }
+      );
+      const requiredVariables = {
+        "FOXY_SHIPTHEORY_EMAIL": "[email protected]",
+        "FOXY_SHIPTHEORY_PASSWORD": "foobar",
+        "FOXY_WEBHOOK_ENCRYPTION_KEY": "12341234"
+      };
+      for (let k of Object.keys(requiredVariables)) {
+        const missingOne = {...requiredVariables};
+        delete missingOne[k];
+        process.env = missingOne;
+        it ("Should detect invalid " + k, async function() {
+          await handler.handler({});
+          stub.calledWithMatch(k);
+        });
+      }
+    });
+  });
+
+
+  describe("Authentication", function() {
+  });
+
+
+});