Merge pull request #99 from companieshouse/update-search-post-to-get

Update SDK to use GET method instead of POST

Author: caismith-ch

src/http/http-client.ts

@@ -63,7 +63,7 @@ export default interface IHttpClient {
    *
    * @param url the url relative to the base url
    */
-  httpGet(url: string): Promise<HttpResponse>;
+  httpGet(url: string, headers?: Headers): Promise<HttpResponse>;
   httpPost(url: string, body?: any, headers?: Headers): Promise<HttpResponse>;
   httpPatch(url: string, body?: any, headers?: Headers): Promise<HttpResponse>;
   httpPut(url: string, body?: any, headers?: Headers): Promise<HttpResponse>;
@@ -122,7 +122,7 @@ export abstract class AbstractClient implements IHttpClient {
    *
    * @param url the full url to make a request to
    */
-  public abstract httpGet(url: string): Promise<HttpResponse>;
+  public abstract httpGet(url: string, headers?: Headers): Promise<HttpResponse>;
 
   public abstract httpPost(url: string, body?: any, headers?: Headers): Promise<HttpResponse>;
 

src/http/request-client.ts

@@ -6,8 +6,8 @@ import rq from "request-promise-native";
  * library.
  */
 export default class RequestClient extends AbstractClient {
-    public async httpGet (url: string): Promise<HttpResponse> {
-        return this.request({ method: "GET", url });
+    public async httpGet (url: string, headers?: Headers): Promise<HttpResponse> {
+        return this.request({ method: "GET", url, headers });
     }
 
     public async httpPost (url: string, body?: any, headers?: Headers): Promise<HttpResponse> {

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

@@ -1,16 +1,17 @@
 import { IHttpClient } from "../../../http";
-import { AlphabeticalSearchPostRequest, CompaniesResource } from "./types";
+import { CompaniesResource } from "./types";
 import Resource from "../../resource";
 
 export default class AlphabeticalSearchService {
     constructor (private readonly client: IHttpClient) { }
-    public async getCompanies (companyName: AlphabeticalSearchPostRequest, requestId: string): Promise<Resource<CompaniesResource>> {
+    public async getCompanies (companyName: string, requestId: string): Promise<Resource<CompaniesResource>> {
         const additionalHeaders = {
             "X-Request-ID": requestId,
             "Content-Type": "application/json"
         }
+        const alphabeticalSearchURL = "/alphabetical-search/companies?q=" + companyName;
 
-        const resp = await this.client.httpPost("/alphabetical-search/corporate-name", companyName, additionalHeaders);
+        const resp = await this.client.httpGet(alphabeticalSearchURL, additionalHeaders);
 
         const resource: Resource<CompaniesResource> = {
             httpStatusCode: resp.status

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

@@ -21,8 +21,3 @@ export interface Items {
 export interface Links {
     self: string;
 }
-
-// AlphabeticalSearchPostRequest
-export interface AlphabeticalSearchPostRequest {
-    company_name: string
-}

test/http/http-client.spec.ts

@@ -19,7 +19,7 @@ class TestClient extends AbstractClient {
         throw new Error("Method not implemented.");
     }
 
-    public async httpGet (url: string): Promise<HttpResponse> {
+    public async httpGet (url: string, headers: any): Promise<HttpResponse> {
         return { status: 200 };
     }
 }

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

@@ -3,7 +3,7 @@ import sinon from "sinon";
 
 import { AlphabeticalSearchService } from "../../../../src/services/search/alphabetical-search";
 import { RequestClient } from "../../../../src/http";
-import { AlphabeticalSearchPostRequest, CompaniesResource } from "../../../../src/services/search/alphabetical-search/types";
+import { CompaniesResource } from "../../../../src/services/search/alphabetical-search/types";
 import Resource from "../../../../src/services/resource";
 const expect = chai.expect;
 
@@ -29,13 +29,10 @@ const mockResponseBody : CompaniesResource = ({
     ]
 });
 
-const mockRequestBody: AlphabeticalSearchPostRequest = ({
-    company_name: "TEST"
-});
-
 const mockRequestId = "fdskfhsdoifhsffsif";
+const testCompanyName = "TEST COMPANY NAME";
 
-describe("create a alphabetical search POST", () => {
+describe("create a alphabetical search GET", () => {
     beforeEach(() => {
         sinon.reset();
         sinon.restore();
@@ -48,28 +45,28 @@ describe("create a alphabetical search POST", () => {
     });
 
     it("returns an error response on failure", async () => {
-        const mockPostRequest = {
+        const mockGetRequest = {
             status: 401,
             error: "An error occurred"
         };
 
-        const mockRequest = sinon.stub(requestClient, "httpPost").resolves(mockPostRequest);
+        const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
         const search: AlphabeticalSearchService = new AlphabeticalSearchService(requestClient);
-        const data: Resource<CompaniesResource> = await search.getCompanies(mockRequestBody, mockRequestId);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId);
 
         expect(data.httpStatusCode).to.equal(401);
         expect(data.resource).to.be.undefined;
     });
 
     it("returns alphabetical search results correctly", async () => {
-        const mockPostRequest = {
+        const mockGetRequest = {
             status: 200,
             body: mockResponseBody
         };
 
-        const mockRequest = sinon.stub(requestClient, "httpPost").resolves(mockPostRequest);
+        const mockRequest = sinon.stub(requestClient, "httpGet").resolves(mockGetRequest);
         const search: AlphabeticalSearchService = new AlphabeticalSearchService(requestClient);
-        const data: Resource<CompaniesResource> = await search.getCompanies(mockRequestBody, mockRequestId);
+        const data: Resource<CompaniesResource> = await search.getCompanies(testCompanyName, mockRequestId);
 
         expect(data.httpStatusCode).to.equal(200);
         expect(data.resource.topHit).to.equal(mockResponseBody.topHit);