Merge pull request #798 from companieshouse/feature/siv-461-amendments-for-associations-companies-company-number

SIV-461 amendments for associations companies company number

Author: mmodzelewski-ch

src/services/associations/service.ts

@@ -31,7 +31,6 @@ export default class AssociationsService {
      * @param includeRemoved - a flag to get a list of companies where status is "removed". Default value: false.
      * @param pageIndex - a page number to be returned. Default value: 0.
      * @param itemsPerPage - a number of items to be returned per page. Default value: 15.
-     * @param userEmail - an email address of a user to check if associated with the company.
      * @param userId - a unique identifier of a user to check if associated with the company.
      * @returns a promise that resolves to the HTTP response from the server that includes the associations or errors object.
      */
@@ -40,7 +39,6 @@ export default class AssociationsService {
         includeRemoved?: boolean,
         pageIndex?: number,
         itemsPerPage?: number,
-        userEmail?: string,
         userId?: string
     ): Promise<Resource<AssociationList | Errors>> {
         let queryString: string = "";
@@ -54,25 +52,34 @@ export default class AssociationsService {
             queryString = this.getQueryString(queryParameters);
         }
 
-        let headers: Headers;
-        if (userEmail) {
-            headers = { user_email: userEmail };
-        }
-
         const url = `/associations/companies/${companyNumber}${queryString}`;
-        const response = await this.client.httpGet(url, headers);
+        const response = await this.client.httpGet(url);
 
         return this.getResource(response) as Resource<AssociationList | Errors>;
     }
 
     /**
-     * Initiates an HTTP GET request to retrieve the associations searched based on association status.
-     * @param associationStatus - an association status used to filter associations. This parameter is required. Available values: confirmed, awaiting-approval, removed. Default value: confirmed.
-     * @param pageIndex - a page to be returned. Default value: 0.
-     * @param itemsPerPage - a number of items returned per page. Default value: 15.
-     * @param companyNumber - a filter based on company number.
-     * @returns a promise that resolves to the HTTP response from the server that includes the associations or errors object.
+     * Initiates an HTTP GET request to retrieve the association for a company for the provided user email.
+     * @param companyNumber  - a company number of the company for which the associations should be retrieved.
+     * @param userEmail - an email address of a user to check if associated with the company.
+     * @returns a promise that resolves to the HTTP response from the server that includes the association or errors object.
      */
+    public async getCompanyAssociationByUserEmail (companyNumber: string, userEmail: string): Promise<Resource<Association | Errors>> {
+        const url = `/associations/companies/${companyNumber}`;
+        const body = { user_email: userEmail }
+        const response = await this.client.httpPost(url, body);
+
+        return this.getResource(response) as Resource<Association | Errors>;
+    }
+
+    /**
+         * Initiates an HTTP GET request to retrieve the associations searched based on association status.
+         * @param associationStatus - an association status used to filter associations. This parameter is required. Available values: confirmed, awaiting-approval, removed. Default value: confirmed.
+         * @param pageIndex - a page to be returned. Default value: 0.
+         * @param itemsPerPage - a number of items returned per page. Default value: 15.
+         * @param companyNumber - a filter based on company number.
+         * @returns a promise that resolves to the HTTP response from the server that includes the associations or errors object.
+         */
     public async searchAssociations (
         associationStatus: AssociationStatus[],
         pageIndex?: number,

test/services/associations/service.spec.ts

@@ -213,6 +213,96 @@ describe("AssociationsService", () => {
         });
     });
 
+    describe("getCompanyAssociationByUserEmail", () => {
+        let associationsService: AssociationsService;
+
+        beforeEach(() => {
+            sinon.reset();
+            sinon.restore();
+            associationsService = new AssociationsService(requestClient);
+        });
+
+        it("should return 200 response with the company association", async () => {
+            sinon.stub(requestClient, "httpPost").resolves({ status: 200, body: mockAssociationResource });
+            const companyNumber = mockAssociationResource.company_number;
+            const userEmail = mockAssociationResource.user_email;
+            await associationsService.getCompanyAssociationByUserEmail(companyNumber, userEmail)
+                .then((data) => {
+                    expect(data.httpStatusCode).to.equal(200);
+
+                    const castedData: Resource<Association> = data as Resource<Association>;
+                    expect(castedData).to.exist;
+                    const association = castedData.resource as Association;
+                    expect(association).to.exist;
+                    expect(association.etag).to.equal("ABC");
+                    expect(association.id).to.equal("0123456789");
+                    expect(association.userId).to.equal("9876543210");
+                    expect(association.userEmail).to.equal("[email protected]");
+                    expect(association.displayName).to.equal("John Doe");
+                    expect(association.companyNumber).to.equal("AB123456");
+                    expect(association.companyName).to.equal("Company Ltd.");
+                    expect(association.status).to.equal(AssociationStatus.AWAITING_APPROVAL);
+                    expect(association.createdAt).to.equal("2022-03-05T11:41:09.568+00:00 UTC");
+                    expect(association.approvedAt).to.equal("");
+                    expect(association.removedAt).to.equal("");
+                    expect(association.kind).to.equal("association");
+                    expect(association.approvalRoute).to.equal(ApprovalRoute.INVITATION);
+                    expect(association.approvalExpiryAt).to.equal("2022-05-05T11:41:09.568+00:00 UTC");
+                    expect(association.links.self).to.equal("/12345");
+                });
+        });
+
+        it("should return 400 response", async () => {
+            sinon.stub(requestClient, "httpPost").resolves(mockGetResponse[400]);
+            const companyNumber = mockAssociationResource.company_number;
+            const userEmail = mockAssociationResource.user_email;
+            await associationsService.getCompanyAssociationByUserEmail(companyNumber, userEmail)
+                .then((data) => {
+                    expect(data.httpStatusCode).to.equal(400);
+                });
+        });
+
+        it("should return 401 response", async () => {
+            sinon.stub(requestClient, "httpPost").resolves(mockGetResponse[401]);
+            const companyNumber = mockAssociationResource.company_number;
+            const userEmail = mockAssociationResource.user_email;
+            await associationsService.getCompanyAssociationByUserEmail(companyNumber, userEmail)
+                .then((data) => {
+                    expect(data.httpStatusCode).to.equal(401);
+                });
+        });
+
+        it("should return 403 response", async () => {
+            sinon.stub(requestClient, "httpPost").resolves(mockGetResponse[403]);
+            const companyNumber = mockAssociationResource.company_number;
+            const userEmail = mockAssociationResource.user_email;
+            await associationsService.getCompanyAssociationByUserEmail(companyNumber, userEmail)
+                .then((data) => {
+                    expect(data.httpStatusCode).to.equal(403);
+                });
+        });
+
+        it("should return 404 response", async () => {
+            sinon.stub(requestClient, "httpPost").resolves(mockGetResponse[404]);
+            const companyNumber = mockAssociationResource.company_number;
+            const userEmail = mockAssociationResource.user_email;
+            await associationsService.getCompanyAssociationByUserEmail(companyNumber, userEmail)
+                .then((data) => {
+                    expect(data.httpStatusCode).to.equal(404);
+                });
+        });
+
+        it("should return 500 response", async () => {
+            sinon.stub(requestClient, "httpPost").resolves(mockGetResponse[500]);
+            const companyNumber = mockAssociationResource.company_number;
+            const userEmail = mockAssociationResource.user_email;
+            await associationsService.getCompanyAssociationByUserEmail(companyNumber, userEmail)
+                .then((data) => {
+                    expect(data.httpStatusCode).to.equal(500);
+                });
+        });
+    });
+
     describe("searchAssociations", () => {
         let associationsService: AssociationsService;