Merge branch 'release/1.2.0'

Author: rjdavis3

.gitignore

@@ -4,3 +4,4 @@ dist/
 node_modules/
 reports/
 \.env
+\.stryker-tmp

.travis.yml

@@ -7,27 +7,37 @@ addons:
       secure: EHyqb+NjwY29lysfyfyogVYjhnTU2BTx/oLvRjZ15tXcFx2jUj3cfY/97zQYjF8r9laqdBonlryrTAIdOyp4he3cdY4Xll3I14e+biT49bdhyMofSAFQbNuFpxpBNuVcg4sJBfmj5CB1qhcvTTq+oEKNpAjJV3QZfTVcvsE1dNgRWHWOq3mm7G97TGYOF58Rjm601KaBEqXNAMKO1fCp2D6lJ/VA9uGAlhkTWz+7SsdjuxE7FqHFBeIqNyoR8utuh6GVkWnJmaMPlFnZLwmuB3ojz2Y6h5PVINPCnz7ZeLbAldOp5QXJQIL5Rt+ZBhP8bGlZTEzYwp3O/77TkQhgvfkyHXoDMmkweCtKP+fj/NAlcQpa+iiFvalEOVz9CV+21WL3SRqqOZNEpEqaj3zPIlflsFpD79Wk4Zxa44QtmV6AOPVE5JsQfPq2cDhyv2KS4sU3cIjaZOKKXwMJKga7F+eGI/i/kCw9LJqlCNxLHJLI9/c7byn+rUHhu1DN3bz5TmR/K08M9JMGbVUGfpA1vAn0eW58H2qm/Ifi4oF5WaFVpXPvAA36BwOHl7wzSd8uQKyoXc6IQhxAn+awxAgibOImgsyavUN09rAO7+RKwQpqiLpfU68fLhaz+O5PMDe+727Bt6F5ILteL0xp2uyIY+Aau5FIAdTemRin4t4YUGM=
 language: node_js
 node_js:
-- 8.10.0
+  - 8.10.0
 jdk:
-- oraclejdk8
+  - oraclejdk8
 install:
-- npm install
+  - npm install
 script:
-- npm test
-- npm run e2e
+  - npm test
+  - npm run e2e
 after_success:
-- bash .travis/overwrite-sonar-project-version.sh
-- sonar-scanner
+  - if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then bash .travis/overwrite-sonar-project-version.sh; fi
+  - if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then sonar-scanner; fi
 cache:
   directories:
-  - node_modules
-  - "$HOME/.sonar/cache"
+    - node_modules
+    - "$HOME/.sonar/cache"
 deploy:
-  provider: npm
-  skip_cleanup: true
-  email:
-    - "$NPM_EMAIL"
-  api_key:
-    - "$NPM_TOKEN"
-  on:
-    tags: true
+  - provider: npm
+    skip_cleanup: true
+    email:
+      - "$NPM_EMAIL"
+    api_key:
+      - "$NPM_TOKEN"
+    tag: develop
+    on:
+      branch: develop
+  - provider: npm
+    skip_cleanup: true
+    email:
+      - "$NPM_EMAIL"
+    api_key:
+      - "$NPM_TOKEN"
+    tag: latest
+    on:
+      branch: master

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing
+Thanks for taking the time to contribute to the ChannelApe SDK project!
+
+The following is a guide for contributing to the project. These are mostly guidelines and not rules. We are open for discussion on changes to this document in a Pull Request.
+
+## Table of contents
+- [Just have a question?](#just-have-a-question)
+- [Prerequisites](#prerequisites)
+- [Getting Started](#getting-started)
+- [Building and Testing](#building-and-testing)
+- [Reporting a bug](#reporting-a-bug)
+- [Suggesting a new feature](#suggesting-a-new-feature)
+- [Pull Request Template](#pull-request-template)
+- [Style Guide](#style-guide)
+- [Update README if applicable](#update-readme-if-applicable)
+
+## Just have a question?
+If you have a question please refrain from opening a GitHub issue. We have an official message board with a detailed FAQ and where the community chimes in with helpful advice if you have questions.
+- [ChannelApe Community](https://community.channelape.com/)
+
+## Prerequisites
+- NPM
+
+## Useful tools
+- vscode (This repo contains configuration files that will get you up and running straight away with vscode)
+
+## Getting Started
+ChannelApe uses the [gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) workflow for managing our projects. So depending on what you are working on will dictate which branch to start from and merge to.
+- Clone the repository locally.
+- New Features/Improvements start from the **'develop'** branch.
+- Hotfixes start from the **'master'** branch.
+- Run ``npm install `` from the root directory of the project.
+
+
+## Building and Testing
+ChannelApe uses different types of tests to verify functionality. 
+1. **Unit tests** - Automated tests that validate a specific piece of functionality within code. Any new code added by the contributor should be covered.
+2. **Integration tests** - End to End tests to validate the logical flow of the program. Cucumber is used to automate the integration tests.
+3. **Driver Test** - Tests that actually make calls to external dependencies to validate your code works without having to run it locally. These aren't run during the building of the project.
+
+#### Running all tests
+
+``npm run test``
+
+#### Coverage
+The goal is to get line and branch coverage to **100%** on new code.
+
+ChannelApe uses [Mocha](https://mochajs.org/) for running tests and [NYC](https://www.npmjs.com/package/nyc) for simple code coverage.
+
+Additionally ChannelApe uses [Stryker](https://stryker-mutator.io/) for running mutations on unit tests. This ensures that tests are well written. The goal for mutation coverage is equal to or greater than the threshold. The threshold is defined in **stryker.conf.js**. If you are to increase mutation coverage, please update the threshold to reflect the new coverage percentage.
+
+## Reporting a bug
+If you find a bug and would like to report it, please follow the guidelines below:
+- Verify that a bug for this doesn't already exist [here](https://github.com/ChannelApe/channelape-typescript-sdk/issues).
+- If a bug is closed and you find that it is possibly still an issue, open a new one and reference the old one.
+- Use a clear descriptive title.
+- Describe in detail how to reproduce the issue.
+- Examples can help if you have them (especially if you can't reliably reproduce).
+- Describe expected behavior and why.
+
+## Suggesting a new feature
+If you would like to suggest a new feature, please follow the guidelines below:
+- Verify that a feature request doesn't already exist [here](https://github.com/ChannelApe/channelape-typescript-sdk/issues).
+- Use a clear descriptive title.
+- Describe in detail how the new feature should work.
+- Examples can help if you have them.
+- Describe expected behavior and why.
+
+## Pull Request Template
+All of the following should be filled out as descriptive as possible or the pull request will be denied at the maintainers discretion.
+
+#### Title
+Pull requests titles should be meaningful to the context of what you are adding/fixing.
+
+#### Description of Changes
+What you are adding/fixing and why.
+
+#### Possible Drawbacks
+If there are known caveats or tradeoffs with the code, please note them here and why we should consider this change.
+
+## Style Guide
+
+Please review our style guide. ChannelApe will request changes based on this style guide if needed on Pull Requests. The JavaScript style guide can be found [here](https://channelape.github.io/styleguide/js/javascriptguide.html).
+
+## Update README if applicable
+If you make any changes that affect the end user, please update the README.md to reflect this.

README.md

@@ -15,6 +15,13 @@ TypeScript and JavaScript SDK for the [ChannelApe REST API](https://docs.channel
 
 The ChannelApe SDK is asynchronous and all functions return promises.
 
+### Using in a browser based app?
+
+Make sure when you install the SDK you install with the *--no-optional* flag
+```
+npm i channelape-sdk --save --no-optional
+```
+
 #### Creating a client
 
 Create a new instance of the ChannelApeClient with your sessionId.
@@ -31,6 +38,8 @@ const channelApeClient = new ChannelApeClient({
 * endpoint - Envrionment endpoint you would like to hit. Defaults to https://api.channelape.com
 * logLevel - Level of logs you wish to see from the SDK. Defaults to OFF.
 * maximumRequestRetryTimeout - Number of milliseconds to keep retrying a request for when an undesired response status code is received. Defaults to 180000 (3 minutes). Cannot be set lower than 2000 (2 seconds).
+* minimumRequestRetryRandomDelay - Minimum number of milliseconds to randomly delay by when an undesired response status code is received. Defaults to 1000 (1 second). Cannot be set lower than 1000 (1 second).
+* maximumRequestRetryRandomDelay - Maximum number of milliseconds to randomly delay by when an undesired response status code is received. Defaults to 5000 (5 seconds). Cannot be set lower than 2000 (2 seconds).
 
 ### Sessions
 

e2e/ChannelApeClient.spec.ts

@@ -7,21 +7,22 @@ import OrdersQueryRequestByBusinessId from '../src/orders/model/OrdersQueryReque
 import { LogLevel } from 'channelape-logger';
 
 describe('ChannelApe Client', () => {
-
   describe('Given valid session ID', () => {
     const sessionId = getSessionId();
 
     const channelApeClient = new ChannelApeClient({
       sessionId,
-      logLevel: LogLevel.OFF
+      logLevel: LogLevel.OFF,
+      maximumRequestRetryRandomDelay: 2000,
+      minimumRequestRetryRandomDelay: 1000,
+      maximumRequestRetryTimeout: 30000
     });
 
     describe('And valid action ID for action with error processing status', () => {
       context('When retrieving action', () => {
-        const expectedActionId = 'a85d7463-a2f2-46ae-95a1-549e70ecb2ca';
-        const actualActionPromise = channelApeClient.actions().get(expectedActionId);
-
         it('Then return action', () => {
+          const expectedActionId = 'a85d7463-a2f2-46ae-95a1-549e70ecb2ca';
+          const actualActionPromise = channelApeClient.actions().get(expectedActionId);
           return actualActionPromise.then((actualAction) => {
             expect(actualAction.action).to.equal('PRODUCT_PULL');
             expect(actualAction.businessId).to.equal('4baafa5b-4fbf-404e-9766-8a02ad45c3a4');
@@ -43,10 +44,9 @@ describe('ChannelApe Client', () => {
 
     describe('And valid action ID for action with completed processing status', () => {
       context('When retrieving action', () => {
-        const expectedActionId = '4da63571-a4c5-4774-ae20-4fee24ab98e5';
-        const actualActionPromise = channelApeClient.actions().get(expectedActionId);
-
         it('Then return action', () => {
+          const expectedActionId = '4da63571-a4c5-4774-ae20-4fee24ab98e5';
+          const actualActionPromise = channelApeClient.actions().get(expectedActionId);
           return actualActionPromise.then((actualAction) => {
             expect(actualAction.action).to.equal('PRODUCT_PUSH');
             expect(actualAction.businessId).to.equal('4baafa5b-4fbf-404e-9766-8a02ad45c3a4');
@@ -73,10 +73,9 @@ describe('ChannelApe Client', () => {
 
     describe('And invalid action ID', () => {
       context('When retrieving action', () => {
-        const expectedActionId = '676cb925-b603-4140-a3dd-2af160c257d1';
-        const actualActionPromise = channelApeClient.actions().get(expectedActionId);
-
         it('Then return 404 status code and action not found error message', () => {
+          const expectedActionId = '676cb925-b603-4140-a3dd-2af160c257d1';
+          const actualActionPromise = channelApeClient.actions().get(expectedActionId);
           return actualActionPromise.then((actualAction) => {
             throw new Error('Expected rejected promise');
           }).catch((actualChannelApeError: ChannelApeError) => {
@@ -93,16 +92,15 @@ describe('ChannelApe Client', () => {
 
     describe('And valid channel ID', () => {
       context('When retrieving channel', () => {
-        const expectedChannelId = '9c728601-0286-457d-b0d6-ec19292d4485';
-        const actualChannelPromise = channelApeClient.channels().get(expectedChannelId);
-
         it('Then return channel', () => {
+          const expectedChannelId = '9c728601-0286-457d-b0d6-ec19292d4485';
+          const actualChannelPromise = channelApeClient.channels().get(expectedChannelId);
           return actualChannelPromise.then((actualChannel) => {
             expect(actualChannel.id).to.equal('9c728601-0286-457d-b0d6-ec19292d4485');
             expect(actualChannel.businessId).to.equal('4baafa5b-4fbf-404e-9766-8a02ad45c3a4');
             expect(actualChannel.enabled).to.equal(true);
             expect(actualChannel.integrationId).to.equal('02df0b31-a071-4791-b9c2-aa01e4fb0ce6');
-            expect(actualChannel.name).to.equal('Custom Column Export');
+            expect(actualChannel.name).to.equal('EuropaSports Snacks / Foods');
             expect(actualChannel.settings.allowCreate).to.equal(false);
             expect(actualChannel.settings.allowRead).to.equal(true);
             expect(actualChannel.settings.allowUpdate).to.equal(false);
@@ -130,10 +128,9 @@ describe('ChannelApe Client', () => {
 
     describe('And valid order ID', () => {
       context('When retrieving order', () => {
-        const expectedOrderId = '3bc9120d-b706-49cd-ad81-6445ce77d8ad';
-        const actualOrderPromise = channelApeClient.orders().get(expectedOrderId);
-
         it('Then return order', () => {
+          const expectedOrderId = '3bc9120d-b706-49cd-ad81-6445ce77d8ad';
+          const actualOrderPromise = channelApeClient.orders().get(expectedOrderId);
           return actualOrderPromise.then((actualOrder) => {
             expect(actualOrder.id).to.equal(expectedOrderId);
             expect(actualOrder.businessId).to.equal('4baafa5b-4fbf-404e-9766-8a02ad45c3a4');
@@ -149,52 +146,52 @@ describe('ChannelApe Client', () => {
     });
 
     describe('And valid business ID', () => {
-      context('When retrieving orders', () => {
-        const expectedBusinessId = '4baafa5b-4fbf-404e-9766-8a02ad45c3a4';
-        const ordersQueryRequestByBusinessId: OrdersQueryRequestByBusinessId = {
-          businessId: expectedBusinessId
-        };
-        const actualOrdersPromise = channelApeClient.orders().get(ordersQueryRequestByBusinessId);
-
-        it('Then return all orders for the business', () => {
-          return actualOrdersPromise.then((actualOrders) => {
-            expect(actualOrders).to.be.an('array');
-            expect(actualOrders.length).to.equal(201);
-            expect(actualOrders[0].id).to.equal('3bc9120d-b706-49cd-ad81-6445ce77d8ad');
+      describe('And a startDate of "2018-03-29T17:00:51.000Z" and an endDate of "2018-08-23T12:41:33.000Z"', () => {
+        context('When retrieving orders', () => {
+          it('Then return the 228 orders between those dates', () => {
+            const expectedBusinessId = '4baafa5b-4fbf-404e-9766-8a02ad45c3a4';
+            const ordersQueryRequestByBusinessId: OrdersQueryRequestByBusinessId = {
+              businessId: expectedBusinessId,
+              startDate: new Date('2018-03-29T17:00:51.000Z'),
+              endDate: new Date('2018-08-23T12:41:33.000Z')
+            };
+            const actualOrdersPromise = channelApeClient.orders().get(ordersQueryRequestByBusinessId);
+            return actualOrdersPromise.then((actualOrders) => {
+              expect(actualOrders).to.be.an('array');
+              expect(actualOrders.length).to.equal(228);
+              expect(actualOrders[0].id).to.equal('dda8a05f-d5dd-4535-9261-b55c501085ef');
+            });
           });
         });
       });
 
-      describe('And query request size of 150 And business has 201 orders', () => {
+      describe('And query request size of 150 And business has more than 150 orders', () => {
         context('When retrieving a single page of orders', () => {
-          const expectedBusinessId = '4baafa5b-4fbf-404e-9766-8a02ad45c3a4';
-          const ordersQueryRequestByBusinessId: OrdersQueryRequestByBusinessId = {
-            businessId: expectedBusinessId,
-            size: 150
-          };
-          const actualOrdersPromise = channelApeClient.orders().getPage(ordersQueryRequestByBusinessId);
-
           it('Then return a single page of 150 orders for the business', () => {
+            const expectedBusinessId = '4baafa5b-4fbf-404e-9766-8a02ad45c3a4';
+            const ordersQueryRequestByBusinessId: OrdersQueryRequestByBusinessId = {
+              businessId: expectedBusinessId,
+              size: 150
+            };
+            const actualOrdersPromise = channelApeClient.orders().getPage(ordersQueryRequestByBusinessId);
             return actualOrdersPromise.then((actualOrders) => {
               expect(actualOrders.orders).to.be.an('array');
               expect(actualOrders.orders.length).to.equal(150);
-              expect(actualOrders.orders[0].id).to.equal('3bc9120d-b706-49cd-ad81-6445ce77d8ad');
               expect(actualOrders.pagination.lastPage).to.equal(false);
             });
           });
         });
 
         describe('And lastKey of "1f557ede-3df5-4335-a64b-cb4181943965"', () => {
           context('When retrieving the next single page of orders', () => {
-            const expectedBusinessId = '4baafa5b-4fbf-404e-9766-8a02ad45c3a4';
-            const ordersQueryRequestByBusinessId: OrdersQueryRequestByBusinessId = {
-              businessId: expectedBusinessId,
-              lastKey: '1f557ede-3df5-4335-a64b-cb4181943965',
-              size: 150
-            };
-            const actualOrdersPromise = channelApeClient.orders().getPage(ordersQueryRequestByBusinessId);
-
             it('Then return the last single page of 51 orders for the business', () => {
+              const expectedBusinessId = '4baafa5b-4fbf-404e-9766-8a02ad45c3a4';
+              const ordersQueryRequestByBusinessId: OrdersQueryRequestByBusinessId = {
+                businessId: expectedBusinessId,
+                lastKey: '1f557ede-3df5-4335-a64b-cb4181943965',
+                size: 150
+              };
+              const actualOrdersPromise = channelApeClient.orders().getPage(ordersQueryRequestByBusinessId);
               return actualOrdersPromise.then((actualOrders) => {
                 expect(actualOrders.orders).to.be.an('array');
                 expect(actualOrders.orders.length).to.equal(51);