Merge pull request #109 from companieshouse/BI-6634-add-dissolved-search

Add dissolved search to node sdk

Author: ethatcher83

src/client.ts

@@ -8,6 +8,7 @@ import { PaymentService } from "./services/payment/";
 import CompanyFilingHistoryService from "./services/company-filing-history/service";
 import { RefreshTokenService } from "./services/refresh-token";
 import AlphabeticalSearchService from "./services/search/alphabetical-search/service";
+import DissolvedSearchService from "./services/search/dissolved-search/service";
 
 /**
  * ApiClient is the class that all service objects hang off.
@@ -26,6 +27,7 @@ export default class ApiClient {
   public readonly mid : MidService;
   public readonly refreshToken: RefreshTokenService;
   public readonly alphabeticalSearch: AlphabeticalSearchService;
+  public readonly dissolvedSearch: DissolvedSearchService;
 
   constructor (readonly apiClient: IHttpClient, readonly accountClient: IHttpClient) {
       // services on the api domain using the apiClient
@@ -41,6 +43,7 @@ export default class ApiClient {
       this.order = new OrderService(apiClient);
       this.mid = new MidService(apiClient);
       this.alphabeticalSearch = new AlphabeticalSearchService(apiClient);
+      this.dissolvedSearch = new DissolvedSearchService(apiClient);
       // service on the account/identity domain using the accountClient
       // e.g. user profile service can be added here when required
       this.refreshToken = new RefreshTokenService(accountClient);

src/mapping/mapping.ts

@@ -1,12 +1,16 @@
 import camelCaseKeys from "camelcase-keys";
 import snakeCaseKeys from "snakecase-keys";
 
+type ObjArray = { [key: string]: any; }[]
+type Obj = { [key: string]: any; }
+type ObjOptions = Obj | ObjArray;
+
 export default class Mapping {
     public static camelCaseKeys<T> (input: any): T {
         return camelCaseKeys(input, { deep: true }) as T;
     }
 
-    public static snakeCaseKeys<T> (input: any): T {
-        return snakeCaseKeys(input, { deep: true }) as T;
+    public static snakeCaseKeys (input: ObjOptions) {
+        return snakeCaseKeys(input, { deep: true });
     }
 }

src/services/payment/service.ts

@@ -41,8 +41,8 @@ export default class PaymentService {
 
     private async createPaymentHandler (createPaymentRequest: CreatePaymentRequest, path: string):
     Promise<ApiResult<ApiResponse<Payment>>> {
-        const createPaymentRequestResource: CreatePaymentRequestResource =
-      Mapping.snakeCaseKeys<CreatePaymentRequestResource>(createPaymentRequest);
+        const createPaymentRequestResource =
+      Mapping.snakeCaseKeys(createPaymentRequest);
 
         const resp: HttpResponse = await this.client.httpPost(path, createPaymentRequestResource);
 

src/services/search/dissolved-search/index.ts

@@ -0,0 +1,2 @@
+export { default as DissolvedSearchService } from "./service";
+export * from "./types";

src/services/search/dissolved-search/service.ts

@@ -0,0 +1,28 @@
+import { IHttpClient } from "../../../http";
+import { CompaniesResource } from "./types";
+import Resource from "../../resource";
+
+export default class DissolvedSearchService {
+    constructor (private readonly client: IHttpClient) { }
+    public async getCompanies (companyName: string, requestId: string): Promise<Resource<CompaniesResource>> {
+        const additionalHeaders = {
+            "X-Request-ID": requestId,
+            "Content-Type": "application/json"
+        }
+        const dissolvedSearchURL = "/dissolved-search/companies?q=" + companyName;
+
+        const resp = await this.client.httpGet(dissolvedSearchURL, additionalHeaders);
+
+        const resource: Resource<CompaniesResource> = {
+            httpStatusCode: resp.status
+        };
+
+        if (resp.error) {
+            return resource;
+        }
+
+        resource.resource = resp.body as CompaniesResource;
+
+        return resource;
+    }
+}

src/services/search/dissolved-search/types.ts

@@ -0,0 +1,39 @@
+export interface CompaniesResource {
+    etag: string;
+    items: Items[];
+    kind: string;
+    top_hit: TopHit;
+}
+
+export interface Items {
+    address: Address;
+    company_name: string;
+    company_number: string;
+    company_status: string;
+    date_of_cessation: string;
+    date_of_creation: string;
+    kind: string;
+    previous_company_names: PreviousCompanyNames[];
+}
+
+export interface Address {
+    locality: string;
+    postal_code: string;
+}
+
+export interface PreviousCompanyNames {
+    ceased_on: string;
+    effective_from: string;
+    name: string;
+}
+
+export interface TopHit {
+    address: Address;
+    company_name: string;
+    company_number: string;
+    company_status: string;
+    date_of_cessation: string;
+    date_of_creation: string;
+    kind: string;
+    previous_company_names: PreviousCompanyNames[];
+}

test/services/search/dissolved-search/service.spec.ts

@@ -0,0 +1,124 @@
+import chai from "chai";
+import sinon from "sinon";
+
+import { DissolvedSearchService } from "../../../../src/services/search/dissolved-search";
+import { RequestClient } from "../../../../src/http";
+import { CompaniesResource } from "../../../../src/services/search/dissolved-search/types";
+import Resource from "../../../../src/services/resource";
+const expect = chai.expect;
+
+const requestClient = new RequestClient({ baseUrl: "URL-NOT-USED", oauthToken: "TOKEN-NOT-USED" });
+
+const mockResponseBody : CompaniesResource = ({
+    etag: "etag",
+    items: [
+        {
+            address: {
+                locality: "cardiff",
+                postal_code: "cf5 6rb"
+            },
+            company_name: "test company",
+            company_number: "0000789",
+            company_status: "active",
+            date_of_cessation: "19910212",
+            date_of_creation: "19910212",
+            kind: "kind",
+            previous_company_names: [
+                {
+                    ceased_on: "19910212",
+                    effective_from: "19910212",
+                    name: "old name"
+                }
+            ]
+        }
+    ],
+    kind: "kind",
+    top_hit: {
+        address: {
+            locality: "cardiff",
+            postal_code: "cf5 6rb"
+        },
+        company_name: "test company",
+        company_number: "0000789",
+        company_status: "active",
+        date_of_cessation: "19910212",
+        date_of_creation: "19910212",
+        kind: "kind",
+        previous_company_names: [
+            {
+                ceased_on: "19910212",
+                effective_from: "19910212",
+                name: "old name"
+            }
+        ]
+    }
+});
+
+const mockRequestId = "fdskfhsdoifhsffsif";
+const testCompanyName = "TEST COMPANY NAME";
+
+describe("create a dissolved search GET", () => {
+    beforeEach(() => {
+        sinon.reset();
+        sinon.restore();
+    });
+
+    afterEach(done => {
+        sinon.reset();
+        sinon.restore();
+        done();
+    });
+
+    it("returns an error response on failure", async () => {
+        const mockGetRequest = {
+            status: 401,
+            error: "An error occurred"
+        };
+
+        const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
+        const search: DissolvedSearchService = new DissolvedSearchService(requestClient);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId);
+
+        expect(data.httpStatusCode).to.equal(401);
+        expect(data.resource).to.be.undefined;
+    });
+
+    it("returns dissolved search results correctly", async () => {
+        const mockGetRequest = {
+            status: 200,
+            body: mockResponseBody
+        };
+
+        const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
+        const search: DissolvedSearchService = new DissolvedSearchService(requestClient);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId);
+        const item = data.resource.items[0];
+        const mockItem = mockResponseBody.items[0];
+
+        expect(data.httpStatusCode).to.equal(200);
+        expect(data.resource.etag).to.equal(mockResponseBody.etag);
+        expect(item.address.locality).to.equal(mockItem.address.locality);
+        expect(item.address.postal_code).to.equal(mockItem.address.postal_code);
+        expect(item.company_name).to.equal(mockItem.company_name);
+        expect(item.company_number).to.equal(mockItem.company_number);
+        expect(item.company_status).to.equal(mockItem.company_status);
+        expect(item.date_of_cessation).to.equal(mockItem.date_of_cessation);
+        expect(item.date_of_creation).to.equal(mockItem.date_of_creation);
+        expect(item.kind).to.equal(mockItem.kind);
+        expect(item.previous_company_names[0].ceased_on).to.equal(mockItem.previous_company_names[0].ceased_on);
+        expect(item.previous_company_names[0].effective_from).to.equal(mockItem.previous_company_names[0].effective_from);
+        expect(item.previous_company_names[0].name).to.equal(mockItem.previous_company_names[0].name);
+        expect(data.resource.kind).to.equal(mockResponseBody.kind);
+        expect(data.resource.top_hit.address.locality).to.equal(mockResponseBody.top_hit.address.locality);
+        expect(data.resource.top_hit.address.postal_code).to.equal(mockResponseBody.top_hit.address.postal_code);
+        expect(data.resource.top_hit.company_name).to.equal(mockResponseBody.top_hit.company_name);
+        expect(data.resource.top_hit.company_number).to.equal(mockResponseBody.top_hit.company_number);
+        expect(data.resource.top_hit.company_status).to.equal(mockResponseBody.top_hit.company_status);
+        expect(data.resource.top_hit.date_of_cessation).to.equal(mockResponseBody.top_hit.date_of_cessation);
+        expect(data.resource.top_hit.date_of_creation).to.equal(mockResponseBody.top_hit.date_of_creation);
+        expect(data.resource.top_hit.kind).to.equal(mockResponseBody.top_hit.kind);
+        expect(data.resource.top_hit.previous_company_names[0].ceased_on).to.equal(mockResponseBody.top_hit.previous_company_names[0].ceased_on);
+        expect(data.resource.top_hit.previous_company_names[0].effective_from).to.equal(mockResponseBody.top_hit.previous_company_names[0].effective_from);
+        expect(data.resource.top_hit.previous_company_names[0].name).to.equal(mockResponseBody.top_hit.previous_company_names[0].name);
+    });
+});