Merge pull request #203 from companieshouse/BI-8655-add-enhanced-search-api-endpoint-to-sdk

add enhanced search api call

Author: ethatcher83

package-lock.json

@@ -20,7 +20,8 @@
     "camelcase-keys": "~6.2.2",
     "request": "~2.88.2",
     "request-promise-native": "~1.0.9",
-    "snakecase-keys": "~3.2.0"
+    "snakecase-keys": "~3.2.0",
+    "url-search-params-polyfill": "~8.1.1"
   },
   "devDependencies": {
     "@types/chai": "~4.2.14",

package.json

@@ -9,6 +9,7 @@ import CompanyFilingHistoryService from "./services/company-filing-history/servi
 import { RefreshTokenService } from "./services/refresh-token";
 import AlphabeticalSearchService from "./services/search/alphabetical-search/service";
 import DissolvedSearchService from "./services/search/dissolved-search/service";
+import EnhancedSearchService from "./services/search/enhanced-search/service";
 import PSCDiscrepancyService from "./services/psc-discrepancies/service";
 import PSCDiscrepanciesReportService from "./services/psc-discrepancies-report/service";
 import TransactionService from "./services/transaction/service";
@@ -31,6 +32,7 @@ export default class ApiClient {
   public readonly refreshToken: RefreshTokenService;
   public readonly alphabeticalSearch: AlphabeticalSearchService;
   public readonly dissolvedSearch: DissolvedSearchService;
+  public readonly enhancedSearch: EnhancedSearchService;
   public readonly pscDiscrepancies: PSCDiscrepancyService;
   public readonly pscDiscrepancyReport: PSCDiscrepanciesReportService;
   public readonly transaction: TransactionService;
@@ -50,6 +52,7 @@ export default class ApiClient {
       this.mid = new MidService(apiClient);
       this.alphabeticalSearch = new AlphabeticalSearchService(apiClient);
       this.dissolvedSearch = new DissolvedSearchService(apiClient);
+      this.enhancedSearch = new EnhancedSearchService(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/client.ts

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

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

@@ -0,0 +1,52 @@
+import { IHttpClient } from "../../../http";
+import { CompaniesResource } from "./types";
+import Resource from "../../resource";
+import "url-search-params-polyfill";
+
+export default class EnhancedSearchService {
+    constructor (private readonly client: IHttpClient) { }
+    public async getCompanies (companyName: string | null, location: string | null, incorporatedFrom: string | null,
+        incorporatedTo: string | null, requestId: string): Promise<Resource<CompaniesResource>> {
+        const COMPANY_NAME_QUERY = "company_name";
+        const LOCATION_QUERY = "location";
+        const INCORPORATED_FROM_QUERY = "incorporated_from";
+        const INCORPORATED_TO_QUERY = "incorporated_to";
+        const additionalHeaders = {
+            "X-Request-ID": requestId,
+            "Content-Type": "application/json"
+        }
+        const buildEnhancedSearchURL = new URLSearchParams("/enhanced-search/companies?");
+
+        if (companyName !== null) {
+            buildEnhancedSearchURL.append(COMPANY_NAME_QUERY, companyName)
+        }
+
+        if (location !== null) {
+            buildEnhancedSearchURL.append(LOCATION_QUERY, location)
+        }
+
+        if (incorporatedFrom !== null) {
+            buildEnhancedSearchURL.append(INCORPORATED_FROM_QUERY, incorporatedFrom)
+        }
+
+        if (incorporatedTo !== null) {
+            buildEnhancedSearchURL.append(INCORPORATED_TO_QUERY, incorporatedTo)
+        }
+
+        const enhancedSearchUrl = buildEnhancedSearchURL.toString();
+
+        const resp = await this.client.httpGet(enhancedSearchUrl, additionalHeaders);
+
+        const resource: Resource<CompaniesResource> = {
+            httpStatusCode: resp.status
+        };
+
+        if (resp.error) {
+            return resource;
+        }
+
+        resource.resource = resp.body as CompaniesResource;
+
+        return resource;
+    }
+}

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

@@ -0,0 +1,44 @@
+export interface CompaniesResource {
+    etag: string;
+    top_hit: TopHit;
+    items: Items[];
+    kind: string;
+    hits: number;
+}
+
+export interface Items {
+    company_name: string;
+    company_number: string;
+    company_status: string;
+    company_type: string;
+    kind: string;
+    links: Links;
+    date_of_cessation: Date;
+    date_of_creation: Date;
+    registered_office_address: Address;
+}
+
+export interface Address {
+    address_line_1: string;
+    address_line_2: string;
+    locality: string;
+    postal_code: string;
+    premises: string;
+    country: string;
+}
+
+export interface TopHit {
+    company_name: string;
+    company_number: string;
+    company_status: string;
+    company_type: string;
+    kind: string;
+    links: Links;
+    date_of_cessation: Date;
+    date_of_creation: Date;
+    registered_office_address: Address;
+}
+
+export interface Links {
+    company_profile: string;
+}

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

@@ -0,0 +1,137 @@
+import chai from "chai";
+import sinon from "sinon";
+
+import { EnhancedSearchService } from "../../../../src/services/search/enhanced-search";
+import { RequestClient } from "../../../../src/http";
+import { CompaniesResource } from "../../../../src/services/search/enhanced-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",
+    top_hit: {
+        company_name: "test company",
+        company_number: "0000789",
+        company_status: "active",
+        company_type: "company type",
+        kind: "kind",
+        links: {
+            company_profile: "/company/FC022000"
+        },
+        date_of_cessation: (new Date("19910212")),
+        date_of_creation: (new Date("19910212")),
+        registered_office_address: {
+            address_line_1: "test house",
+            address_line_2: "test street",
+            locality: "cardiff",
+            postal_code: "cf5 6rb",
+            premises: "premises",
+            country: "country"
+        }
+    },
+    items: [
+        {
+            company_name: "test company",
+            company_number: "0000789",
+            company_status: "active",
+            company_type: "company type",
+            kind: "kind",
+            links: {
+                company_profile: "/company/FC022000"
+            },
+            date_of_cessation: (new Date("19910212")),
+            date_of_creation: (new Date("19910212")),
+            registered_office_address: {
+                address_line_1: "test house",
+                address_line_2: "test street",
+                locality: "cardiff",
+                postal_code: "cf5 6rb",
+                premises: "premises",
+                country: "country"
+            }
+        }
+    ],
+    kind: "kind",
+    hits: 1
+})
+
+const mockRequestId = "fdskfhsdoifhsffsif";
+const testCompanyName = "TEST COMPANY NAME";
+const testLocation = "TEST LOCATION";
+const testIncorporatedFrom = " TEST INCORPORATED FROM";
+const testIncorporatedTo = " TEST INCORPORATED TO";
+const searchType = "enhanced";
+
+describe("create an enhanced 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: EnhancedSearchService = new EnhancedSearchService(requestClient);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, testLocation, testIncorporatedFrom, testIncorporatedTo, mockRequestId);
+
+        expect(data.httpStatusCode).to.equal(401);
+        expect(data.resource).to.be.undefined;
+    });
+
+    it("returns enhanced search results correctly", async () => {
+        const mockGetRequest = {
+            status: 200,
+            body: mockResponseBody
+        };
+
+        const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
+        const search: EnhancedSearchService = new EnhancedSearchService(requestClient);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, testLocation, testIncorporatedFrom, testIncorporatedTo, 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(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.company_type).to.equal(mockResponseBody.top_hit.company_type);
+        expect(data.resource.top_hit.kind).to.equal(mockResponseBody.top_hit.kind);
+        expect(data.resource.top_hit.links.company_profile).to.equal(mockResponseBody.top_hit.links.company_profile);
+        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.registered_office_address.address_line_1).to.equal(mockResponseBody.top_hit.registered_office_address.address_line_1);
+        expect(data.resource.top_hit.registered_office_address.address_line_2).to.equal(mockResponseBody.top_hit.registered_office_address.address_line_2);
+        expect(data.resource.top_hit.registered_office_address.locality).to.equal(mockResponseBody.top_hit.registered_office_address.locality);
+        expect(data.resource.top_hit.registered_office_address.postal_code).to.equal(mockResponseBody.top_hit.registered_office_address.postal_code);
+        expect(data.resource.top_hit.registered_office_address.premises).to.equal(mockResponseBody.top_hit.registered_office_address.premises);
+        expect(data.resource.top_hit.registered_office_address.country).to.equal(mockResponseBody.top_hit.registered_office_address.country);
+        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.kind).to.equal(mockItem.kind);
+        expect(item.links.company_profile).to.equal(mockItem.links.company_profile);
+        expect(item.date_of_cessation).to.equal(mockItem.date_of_cessation);
+        expect(item.date_of_creation).to.equal(mockItem.date_of_creation);
+        expect(item.registered_office_address.address_line_1).to.equal(mockItem.registered_office_address.address_line_1);
+        expect(item.registered_office_address.address_line_2).to.equal(mockItem.registered_office_address.address_line_2);
+        expect(item.registered_office_address.locality).to.equal(mockItem.registered_office_address.locality);
+        expect(item.registered_office_address.postal_code).to.equal(mockItem.registered_office_address.postal_code);
+        expect(item.registered_office_address.premises).to.equal(mockItem.registered_office_address.premises);
+        expect(data.resource.kind).to.equal(mockResponseBody.kind);
+        expect(data.resource.hits).to.equal(mockResponseBody.hits);
+    });
+});