Merge pull request #185 from companieshouse/ncs-449-add-transaction-to-sdk

NCS-449 adding transaction to SDK

Author: SVarallo

src/client.ts

@@ -11,6 +11,7 @@ import AlphabeticalSearchService from "./services/search/alphabetical-search/ser
 import DissolvedSearchService from "./services/search/dissolved-search/service";
 import PSCDiscrepancyService from "./services/psc-discrepancies/service";
 import PSCDiscrepanciesReportService from "./services/psc-discrepancies-report/service";
+import TransactionService from "./services/transaction/service";
 
 /**
  * ApiClient is the class that all service objects hang off.
@@ -31,7 +32,8 @@ export default class ApiClient {
   public readonly alphabeticalSearch: AlphabeticalSearchService;
   public readonly dissolvedSearch: DissolvedSearchService;
   public readonly pscDiscrepancies: PSCDiscrepancyService;
-  public readonly pscDiscrepancyReport:PSCDiscrepanciesReportService;
+  public readonly pscDiscrepancyReport: PSCDiscrepanciesReportService;
+  public readonly transaction: TransactionService;
 
   constructor (readonly apiClient: IHttpClient, readonly accountClient: IHttpClient) {
       // services on the api domain using the apiClient
@@ -53,5 +55,6 @@ export default class ApiClient {
       this.refreshToken = new RefreshTokenService(accountClient);
       this.pscDiscrepancies = new PSCDiscrepancyService(apiClient);
       this.pscDiscrepancyReport = new PSCDiscrepanciesReportService(apiClient);
+      this.transaction = new TransactionService(apiClient);
   }
 }

src/services/transaction/index.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./service";

src/services/transaction/service.ts

@@ -0,0 +1,51 @@
+import { IHttpClient } from "../../http";
+import {
+    Transaction, TransactionResource
+
+} from "./types";
+import Resource from "../resource";
+
+export default class TransactionService {
+    constructor (private readonly client: IHttpClient) { }
+
+    /**
+   * Post a transaction.
+   *
+   * @param transaction the transaction to create
+   */
+    public async postTransaction (transaction: Transaction): Promise<Resource<Transaction>> {
+        let url = "/transactions"
+        if (transaction.id) {
+            url += "/" + transaction.id
+        }
+
+        const resp = await this.client.httpPost(url);
+
+        const resource: Resource<Transaction> = {
+            httpStatusCode: resp.status
+        };
+
+        if (resp.error) {
+            return resource;
+        }
+
+        // cast the response body to the expected type
+        const body = resp.body as TransactionResource;
+
+        resource.resource = {
+            id: body.id,
+            etag: body.etag,
+            links: body.links,
+            reference: body.reference,
+            status: body.status,
+            kind: body.kind,
+            companyName: body.company_name,
+            companyNumber: body.company_number,
+            createdAt: body.created_at,
+            createdBy: body.created_by,
+            updatedAt: body.updated_at,
+            description: body.description
+        }
+        return resource;
+    }
+}

src/services/transaction/types.ts

@@ -0,0 +1,40 @@
+/**
+ * TransactionResource is what is returned from the api.
+ */
+export interface TransactionResource {
+    id?: string,
+    etag?: string,
+    links?: {self: string},
+    reference: string,
+    status?: string,
+    kind?: string,
+    company_name?: string,
+    company_number: string,
+    created_at?: string,
+    created_by?: {
+        language: string,
+        id: string,
+        email: string
+    },
+    updated_at?: string,
+    description: string
+}
+
+export interface Transaction {
+    id?: string,
+    etag?: string,
+    links?: {self: string},
+    reference: string,
+    status?: string,
+    kind?: string,
+    companyName?: string,
+    companyNumber: string,
+    createdAt?: string,
+    createdBy?: {
+        language: string,
+        id: string,
+        email: string
+    },
+    updatedAt?: string,
+    description: string
+}

test/services/transaction/service.spec.ts

@@ -0,0 +1,65 @@
+import chai from "chai";
+import sinon from "sinon";
+
+import TransactionService from "../../../src/services/transaction/service";
+import { RequestClient } from "../../../src/http";
+import { Transaction, TransactionResource } from "../../../src/services/transaction";
+const expect = chai.expect;
+
+const requestClient = new RequestClient({ baseUrl: "URL-NOT-USED", oauthToken: "TOKEN-NOT-USED" });
+
+describe("transaction", () => {
+    beforeEach(() => {
+        sinon.reset();
+        sinon.restore();
+    });
+
+    afterEach(done => {
+        sinon.reset();
+        sinon.restore();
+        done();
+    });
+
+    it("returns an error response on failure", async () => {
+        const mockPostResponse = {
+            status: 401,
+            error: "An error occurred"
+        };
+
+        const mockRequest = sinon.stub(requestClient, "httpPost").resolves(mockPostResponse);
+        const transaction : TransactionService = new TransactionService(requestClient);
+        const data = await transaction.postTransaction({} as Transaction);
+
+        expect(data.httpStatusCode).to.equal(401);
+        expect(data.resource).to.be.undefined;
+    });
+
+    it("maps the company field data items correctly", async () => {
+        const mockResponseBody : TransactionResource = ({
+            id: "12345678",
+            company_name: "HELLO LTD",
+            company_number: "88",
+            links: {
+                self: "/self"
+            },
+            reference: "ref",
+            description: "desc"
+        });
+
+        const mockPostResponse = {
+            status: 200,
+            body: mockResponseBody
+        };
+
+        const mockRequest = sinon.stub(requestClient, "httpPost").resolves(mockPostResponse);
+        const transaction : TransactionService = new TransactionService(requestClient);
+        const data = await transaction.postTransaction({} as Transaction);
+
+        expect(data.httpStatusCode).to.equal(200);
+        expect(data.resource.companyName).to.equal(mockResponseBody.company_name);
+        expect(data.resource.companyNumber).to.equal(mockResponseBody.company_number);
+        expect(data.resource.links.self).to.equal(mockResponseBody.links.self);
+        expect(data.resource.reference).to.equal(mockResponseBody.reference);
+        expect(data.resource.description).to.equal(mockResponseBody.description);
+    });
+});