Merge pull request #10 from zero-bites/test-epic-final-touches

[Chore] Post-characterization testing adjustments

Author: zero-bites

.mocharc.json

@@ -2,7 +2,7 @@
   "ui": "bdd",
   "timeout": 15000,
   "extension": ["ts"],
-  "spec": ["test/integration/*Spec.ts"],
+  "spec": ["'test/integration/*Spec.ts'"],
   "require": ["ts-node/register", "test/hooks.ts"],
   "package": "./package.json"
 }

lib/BatchGateway.ts

@@ -119,7 +119,7 @@ export class BatchGateway {
 
     const result = await this.gateway.client.patch<types.Batch.Result>(endPoint, body);
 
-    return true;
+    return Batch.factory(result.batch);
   }
 
   /**

lib/OfflinePaymentGateway.ts

@@ -71,12 +71,11 @@ export class OfflinePaymentGateway {
       offlinePaymentId,
     );
 
-    const result = await this.gateway.client.patch<{ ok: boolean }>(
-      endPoint,
-      body,
-    );
+    const result = await this.gateway.client.patch<
+         types.OfflinePayment.Response
+        >(endPoint, body);
 
-    return true;
+    return OfflinePayment.factory(result.offlinePayment);
   }
 
   /**

lib/RecipientGateway.ts

@@ -102,7 +102,7 @@ export class RecipientGateway {
 
     const result = await this.gateway.client.patch<types.Recipient.Response>(endPoint, body);
 
-    return true;
+    return Recipient.factory(result.recipient);
   }
 
   /**
@@ -120,7 +120,7 @@ export class RecipientGateway {
     return true;
   }
 
-  async search(page: number, pageSize: number, term: string) {
+  async search(page: number = 1, pageSize: number = 10, term: string = "") {
     // tslint:disable-next-line:max-line-length
     const endPoint = buildURL('recipients');
     const query = querystring.stringify({

package.json

@@ -5,16 +5,14 @@
   "main": "./dist/index",
   "types": "./dist/index",
   "directories": {
-    "test": "tests"
+    "test": "test"
   },
   "files": [
     "dist",
     "lib"
   ],
   "scripts": {
-    "test": "npm run test:unit",
-    "test:unit": "TS_NODE_PROJECT=test/tsconfig.json mocha --require ts-node/register \"test/unit/**/*Spec.ts\"",
-    "test:integration": "TS_NODE_PROJECT=test/tsconfig.json mocha --require ts-node/register \"test/integration/**/*Spec.ts\"",
+    "test": "mocha",
     "build": "rm -rf dist/ && tsc && echo Done",
     "docs": "./node_modules/.bin/typedoc --mode file --name 'Payment Rails JavaScript SDK' --readme none --theme markdown --out docs --hideGenerator lib",
     "clean": "rm -rf dist/"

test/integration/BalanceSpec.ts

@@ -1,29 +1,31 @@
-import {startNockRec, testingApiClient} from "./helpers/integrationTestsHelpers";
-import * as assert from "assert";
-
-describe("Balance", () => {
-    it("lists all balances", async () => {
-        const nockDone = await startNockRec('balance-all.json');
-
-        const balances = await testingApiClient.balances.all();
-
-        assert.ok(balances);
-        assert.strictEqual(2, balances.length);
-        assert.strictEqual("paymentrails", balances[0].type);
-        assert.strictEqual("paypal", balances[1].type);
-
-        nockDone();
-    });
-
-    it("lists balances for a given kind", async () => {
-        const nockDone = await startNockRec('balance-find.json');
-
-        const balances = await testingApiClient.balances.find("paypal");
-
-        assert.ok(balances);
-        assert.strictEqual(1, balances.length);
-        assert.strictEqual("paypal", balances[0].type);
-
-        nockDone();
-    });
-});
+import { startNockRec, testingApiClient } from "./helpers/integrationTestsHelpers";
+import * as assert from "assert";
+import { Balance } from "../../lib";
+
+describe("Balance", () => {
+    it("lists all balances", async () => {
+        const nockDone = await startNockRec('balance-all.json');
+
+        const balances = await testingApiClient.balances.all();
+
+        nockDone();
+
+        assert.ok(balances);
+        assert.strictEqual(balances.length, 1);
+        assert.strictEqual(balances[0].constructor, Balance);
+        assert.strictEqual(balances[0].type, "paymentrails");
+    });
+
+    it("lists balances for a given kind", async () => {
+        const nockDone = await startNockRec('balance-find.json');
+
+        const balances = await testingApiClient.balances.find("paymentrails");
+
+        nockDone();
+
+        assert.ok(balances);
+        assert.strictEqual(balances.length, 1);
+        assert.strictEqual(balances[0].constructor, Balance);
+        assert.strictEqual(balances[0].type, "paymentrails");
+    });
+});

test/integration/batchSpec.ts test/integration/BatchSpec.tstest/integration/batchSpec.ts renamed to test/integration/BatchSpec.ts

@@ -1,32 +1,43 @@
 import * as assert from "assert";
-import {testingApiClient, startNockRec} from "./helpers/integrationTestsHelpers";
-import {BatchFactory} from "./factories/BatchFactory";
-import {RecipientFactory} from "./factories/RecipientFactory";
-import {RecipientAccountFactory} from "./factories/RecipientAccountFactory";
-
-const batchFactory = new BatchFactory();
-const recipientFactory = new RecipientFactory();
-const recipientAccountFactory = new RecipientAccountFactory();
+import { testingApiClient, startNockRec } from "./helpers/integrationTestsHelpers";
+import { BatchFactory } from "./factories/BatchFactory";
+import { RecipientFactory } from "./factories/RecipientFactory";
+import { RecipientAccountFactory } from "./factories/RecipientAccountFactory";
+import { Batch } from "../../lib";
+
+let batchFactory: BatchFactory;
+let recipientFactory: RecipientFactory;
+let recipientAccountFactory: RecipientAccountFactory;
+
+before(async () => {
+    batchFactory = new BatchFactory();
+    recipientFactory = new RecipientFactory();
+    recipientAccountFactory = new RecipientAccountFactory();
+});
 
 async function createRecipient(email: string) {
    const recipient = await recipientFactory.createResource({ email });
    await recipientAccountFactory.createResource({ recipient });
+
    return recipient;
  }
 
-describe("Batch/Payment Integration", () => {
+describe("Batch", () => {
   it('creates a batch', async () => {
     const nockDone = await startNockRec('batch-create.json');
 
     const batch = await batchFactory.createResource();
     const all = await testingApiClient.batch.all();
 
+    nockDone();
+
     assert.ok(batch);
     assert.ok(batch.id);
     assert.ok(all.length > 0);
 
-    nockDone();
-  })
+    assert.strictEqual(batch.constructor, Batch);
+    assert.strictEqual(batch.description, batchFactory.defaultAttrs.description);
+  });
 
   it("updates a batch", async () => {
     const nockDone = await startNockRec('batch-update.json');
@@ -36,20 +47,21 @@ describe("Batch/Payment Integration", () => {
     });
     assert.strictEqual(batch.description, "Integration Test Update");
 
-    await testingApiClient.batch.update(batch.id, {
+    batch = await testingApiClient.batch.update(batch.id, {
       description: "Integration Test Update 2",
     });
-    batch = await testingApiClient.batch.find(batch.id);
+
+    nockDone();
+
     assert.ok(batch);
+
+    assert.strictEqual(batch.constructor, Batch);
     assert.strictEqual(batch.description, "Integration Test Update 2");
     assert.strictEqual(batch.status, "open");
+  });
 
-    nockDone();
-  })
-
-  //tslint:disable-next-line:mocha-no-side-effect-code
   it("create with payments", async () => {
-    const nockDone = await startNockRec('batch-create-with-payments.json')
+    const nockDone = await startNockRec('batch-create-with-payments.json');
 
     const recipient = await createRecipient('[email protected]');
     const otherRecipient = await createRecipient('[email protected]');
@@ -65,59 +77,58 @@ describe("Batch/Payment Integration", () => {
           sourceAmount: "10.00",
           recipient: { id: otherRecipient.id },
         },
-      ]
+      ],
     });
 
-    assert.ok(batch);
-    assert.ok(batch.id);
     const findBatch = await testingApiClient.batch.find(batch.id);
 
+    nockDone();
+
+    assert.ok(batch);
+    assert.ok(batch.id);
     assert.ok(findBatch);
+
+    assert.strictEqual(batch.constructor, Batch);
     assert.strictEqual(batch.totalPayments, 2);
 
-    let payments = await testingApiClient.batch.paymentList(batch.id);
+    const payments = await testingApiClient.batch.paymentList(batch.id);
     for (const item of payments) {
       assert.strictEqual(item.status, "pending");
     }
-
-    nockDone();
   });
 
-  //tslint:disable-next-line:mocha-no-side-effect-code
   it("starts processing batch payments", async () => {
-    const nockDone = await startNockRec('batch-processing-payments.json')
+    const nockDone = await startNockRec('batch-processing-payments.json');
 
     const recipient = await createRecipient('[email protected]');
-    const other_recipient = await createRecipient('[email protected]');
+    const otherRecipient = await createRecipient('[email protected]');
 
     const batch = await batchFactory.createResource({
       payments: [
         {
           targetAmount: "10.00",
           targetCurrency: "EUR",
-          recipient: {id: recipient.id},
+          recipient: { id: recipient.id },
         },
         {
           sourceAmount: "10.00",
-          recipient: {id: other_recipient.id},
+          recipient: { id: otherRecipient.id },
         },
-      ]
+      ],
     });
 
-    assert.ok(batch);
-    assert.ok(batch.id);
-
     const summary = await testingApiClient.batch.summary(batch.id);
-    assert.strictEqual(2, summary.detail["bank-transfer"].count, "Bad Count");
-
     const quote = await testingApiClient.batch.generateQuote(batch.id);
-    assert.ok(quote, "failed to get quote");
 
     // There's an issue here when it runs too quick. It returns "Operation In Progress"
     // Sleep when running against real API
     const start = await testingApiClient.batch.startProcessing(batch.id);
-    assert.ok(start, "Failed to start");
 
     nockDone();
+
+    assert.ok(batch);
+    assert.ok(batch.id);
+    assert.ok(quote, "failed to get quote");
+    assert.ok(start, "Failed to start");
   });
 });

test/integration/InvoiceLineSpec.ts

@@ -3,6 +3,7 @@ import { RecipientFactory } from './factories/RecipientFactory';
 import { InvoiceFactory } from './factories/InvoiceFactory';
 import { InvoiceLineFactory } from './factories/InvoiceLineFactory';
 import * as assert from 'assert';
+import { InvoiceLine } from "../../lib/InvoiceLine";
 
 let recipientFactory: RecipientFactory;
 let invoiceFactory: InvoiceFactory;
@@ -26,7 +27,8 @@ describe('InvoiceLine', () => {
 
         assert.ok(invoiceLines);
         assert.strictEqual(invoiceLines.length, 1);
-        assert.strictEqual('testInvoiceLine', invoiceLines[0].externalId);
+        assert.strictEqual(invoiceLines[0].constructor, InvoiceLine);
+        assert.strictEqual(invoiceLines[0].externalId, 'testInvoiceLine');
     });
 
     it('updates an invoice line', async () => {
@@ -51,7 +53,10 @@ describe('InvoiceLine', () => {
         nockDone();
 
         assert.ok(updatedInvoice);
-        assert.strictEqual('updated line description', updatedInvoice.lines[0].description);
+        assert.strictEqual(invoiceLines.length, 1);
+        assert.strictEqual(invoiceLines[0].constructor, InvoiceLine);
+        assert.strictEqual(updatedInvoice.lines.length, 1);
+        assert.strictEqual(updatedInvoice.lines[0].description, 'updated line description');
     });
 
     it('deletes an invoice line', async () => {