Merge pull request #762 from companieshouse/lp550-create-usual-residential-address-for-general=partner-choice-page

lp550-create general partner usual residential  choice page

Author: HatiDev

src/services/limited-partnerships/service.ts

@@ -1,5 +1,10 @@
 import { HttpResponse, IHttpClient } from "../../http";
-import { LimitedPartnership, LimitedPartnershipResourceCreated, LimitedPartnershipIncorporation, GeneralPartner } from "./types";
+import {
+    LimitedPartnership,
+    LimitedPartnershipResourceCreated,
+    LimitedPartnershipIncorporation,
+    GeneralPartner
+} from "./types";
 import Resource, { ApiErrorResponse } from "../resource";
 
 export default class LimitedPartnershipsService {
@@ -50,7 +55,8 @@ export default class LimitedPartnershipsService {
      */
 
     public async postLimitedPartnershipIncorporation (
-        transactionId: string): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse> {
+        transactionId: string
+    ): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse> {
         const URL = `/transactions/${transactionId}/incorporation/limited-partnership`;
         const response: HttpResponse = await this.client.httpPost(URL);
 
@@ -63,8 +69,11 @@ export default class LimitedPartnershipsService {
     public async getLimitedPartnershipIncorporation (
         transactionId: string,
         filingResourceId: string,
-        includeSubResources?: boolean): Promise<Resource<LimitedPartnershipIncorporation> | ApiErrorResponse> {
-        const subResourcesQuery: string = (includeSubResources ? ("?include_sub_resources=" + includeSubResources) : "");
+        includeSubResources?: boolean
+    ): Promise<Resource<LimitedPartnershipIncorporation> | ApiErrorResponse> {
+        const subResourcesQuery: string = includeSubResources
+            ? "?include_sub_resources=" + includeSubResources
+            : "";
         const URL = `/transactions/${transactionId}/incorporation/limited-partnership/${filingResourceId}${subResourcesQuery}`;
 
         const response: HttpResponse = await this.client.httpGet(URL);
@@ -81,7 +90,8 @@ export default class LimitedPartnershipsService {
 
     public async postGeneralPartner (
         transactionId: string,
-        body: GeneralPartner): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse> {
+        body: GeneralPartner
+    ): Promise<Resource<LimitedPartnershipResourceCreated> | ApiErrorResponse> {
         const URL = `/transactions/${transactionId}/limited-partnership/general-partner`;
         const response: HttpResponse = await this.client.httpPost(URL, body);
 
@@ -90,4 +100,17 @@ export default class LimitedPartnershipsService {
             resource: { ...response.body }
         };
     }
+
+    public async getGeneralPartner (
+        transactionId: string,
+        generalPartnerId: string
+    ): Promise<Resource<GeneralPartner> | ApiErrorResponse> {
+        const URL = `/transactions/${transactionId}/limited-partnership/general-partner/${generalPartnerId}`;
+        const response: HttpResponse = await this.client.httpGet(URL);
+
+        return {
+            httpStatusCode: response.status,
+            resource: { ...response.body }
+        };
+    }
 }

test/services/limited-partnerships/limited.partnerships.mock.ts

@@ -156,3 +156,9 @@ export const mockPostGeneralPartnerResponse = {
     400: { status: 400, body: { error: BAD_REQUEST } },
     401: { status: 401, body: { error: UNAUTHORISED } }
 };
+
+export const mockGetGeneralPartnerResponse = {
+    200: { status: 200, body: GENERAL_PARTNER_OBJECT_MOCK },
+    404: { status: 404, body: { error: NOT_FOUND } },
+    401: { status: 401, body: { error: UNAUTHORISED } }
+};

test/services/limited-partnerships/limited.partnerships.spec.ts

@@ -8,7 +8,8 @@ import {
     LimitedPartnershipResourceCreated,
     LimitedPartnershipsService,
     LimitedPartnershipIncorporation,
-    NameEndingType
+    NameEndingType,
+    GeneralPartner
 } from "../../../src/services/limited-partnerships";
 import Resource from "../../../src/services/resource";
 
@@ -194,6 +195,7 @@ describe("LimitedPartnershipsService", () => {
                         "/transactions/12345/limited-partnership/partnership/09876"
                     )
                 ).to.be.true;
+
                 expect(response.httpStatusCode).to.equal(200);
                 expect(response?.resource).to.eql(mockValues.LIMITED_PARTNERSHIP_OBJECT_MOCK);
             });
@@ -498,4 +500,78 @@ describe("LimitedPartnershipsService", () => {
             });
         })
     });
+
+    describe("getGeneralPartner", () => {
+        it("should return a status 200 and the generalPartner object", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpGet")
+                .resolves(mockValues.mockGetGeneralPartnerResponse[200]);
+
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+
+            const response = await service.getGeneralPartner(
+                mockValues.TRANSACTION_ID,
+                mockValues.SUBMISSION_ID
+            ) as Resource<GeneralPartner>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partner/09876"
+                )
+            ).to.be.true;
+            expect(response.httpStatusCode).to.equal(200);
+            expect(response?.resource).to.eql(mockValues.GENERAL_PARTNER_OBJECT_MOCK);
+        });
+
+        it("should return error 401 (Unauthorised)", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpGet")
+                .resolves(mockValues.mockGetGeneralPartnerResponse[401]);
+
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+            const response = (await service.getGeneralPartner(
+                mockValues.TRANSACTION_ID,
+                mockValues.SUBMISSION_ID
+            )) as Resource<any>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partner/09876"
+                )
+            ).to.be.true;
+
+            expect(response.httpStatusCode).to.equal(401);
+            expect(response.resource.error).to.equal(mockValues.UNAUTHORISED);
+        });
+
+        it("should return error 404 (Not Found)", async () => {
+            const mockRequest = sinon
+                .stub(mockValues.requestClient, "httpGet")
+                .resolves(mockValues.mockGetGeneralPartnerResponse[404]);
+
+            const service = new LimitedPartnershipsService(
+                mockValues.requestClient
+            );
+            const response = (await service.getGeneralPartner(
+                mockValues.TRANSACTION_ID,
+                "wrong-id"
+            )) as Resource<any>;
+
+            expect(mockRequest).to.have.been.calledOnce;
+            expect(
+                mockRequest.calledWith(
+                    "/transactions/12345/limited-partnership/general-partner/wrong-id"
+                )
+            ).to.be.true;
+
+            expect(response.httpStatusCode).to.equal(404);
+            expect(response.resource.error).to.equal(mockValues.NOT_FOUND);
+        });
+    })
 });