Merge pull request #811 from companieshouse/feature/dynamo/ci

CSE-867 - Condensed SIC Code API

Author: imclaughlin-ch

src/client.ts

@@ -37,6 +37,7 @@ import { AccountsFilingService } from "./services/accounts-filing";
 import PscService from "./services/psc/service";
 import { LimitedPartnershipsService } from "./services/limited-partnerships"
 import AssociationsService from "./services/associations/service";
+import { CondensedSicCodeService } from "./services/sic-code";
 
 /**
  * ApiClient is the class that all service objects hang off.
@@ -78,6 +79,7 @@ export default class ApiClient {
     public readonly pscService: PscService;
     public readonly limitedPartnershipsService: LimitedPartnershipsService;
     public readonly associationsService: AssociationsService;
+    public readonly sicCodeService: CondensedSicCodeService;
 
     constructor (readonly apiClient: IHttpClient, readonly accountClient: IHttpClient) {
         // services on the api domain using the apiClient
@@ -118,5 +120,6 @@ export default class ApiClient {
         this.pscService = new PscService(apiClient);
         this.limitedPartnershipsService = new LimitedPartnershipsService(apiClient);
         this.associationsService = new AssociationsService(accountClient);
+        this.sicCodeService = new CondensedSicCodeService(apiClient);
     }
 }

src/services/sic-code/index.ts

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

src/services/sic-code/service.ts

@@ -0,0 +1,31 @@
+import { CondensedSicCodeData } from "./types";
+import { HttpResponse, IHttpClient } from "../../http";
+import Resource from "../resource";
+
+export default class {
+    constructor (private readonly client: IHttpClient) {}
+
+    public async getCondensedSicCodes (): Promise<Resource<CondensedSicCodeData[]>> {
+        const url: string = "/internal/condensed-sic-codes";
+
+        const resp: HttpResponse = await this.client.httpGet(url);
+
+        const resource: Resource<CondensedSicCodeData[]> = {
+            httpStatusCode: resp.status
+        };
+
+        if (resp.error && resp.status !== 400) {
+            resource.resource = resp.error;
+            return resource;
+        }
+
+        const apiResource: CondensedSicCodeData[] = resp.body ? resp.body : resp.error;
+
+        if (!apiResource) {
+            throw new Error(`No body or error body returned from ${url} API call - http status from API = ${resp.status}`);
+        }
+        resource.resource = apiResource;
+
+        return resource;
+    }
+}

src/services/sic-code/types.ts

@@ -0,0 +1,4 @@
+export interface CondensedSicCodeData {
+    sic_code: string,
+    sic_description: string,
+}

test/services/sic-code/service.spec.ts

@@ -0,0 +1,41 @@
+import { CondensedSicCodeService, CondensedSicCodeData } from "../../../src/services/sic-code";
+import sinon from "sinon";
+import chai from "chai";
+import Resource, { ApiErrorResponse } from "../../../src/services/resource";
+import { RequestClient } from "../../../src/http";
+
+const requestClient = new RequestClient({ baseUrl: "URL-NOT-USED", oauthToken: "TOKEN-NOT-USED" });
+const expect = chai.expect;
+
+beforeEach(() => {
+    sinon.reset();
+    sinon.restore();
+});
+
+afterEach((done) => {
+    sinon.reset();
+    sinon.restore();
+    done();
+});
+
+describe("Get Condensed SIC Code data", () => {
+    it("Should return Condensed SIC Code data", async () => {
+        const mockResponseBody = [
+            { sic_code: "00001", sic_description: "SIC 1" },
+            { sic_code: "00002", sic_description: "SIC 2" },
+            { sic_code: "00003", sic_description: "SIC 3" }
+        ];
+
+        sinon.stub(requestClient, "httpGet").resolves({
+            status: 200,
+            body: mockResponseBody
+        });
+
+        const service: CondensedSicCodeService = new CondensedSicCodeService(requestClient);
+
+        const response = await service.getCondensedSicCodes() as Resource<CondensedSicCodeData[]>;
+
+        expect(response.httpStatusCode).to.be.equal(200);
+        expect(response.resource).to.be.equal(mockResponseBody);
+    });
+});