feat(Resolve): Resolve address suggestions

Retrieve GBR formatted fully resolved addresses

Author: cblanc

lib/resources/autocomplete.ts

@@ -1,5 +1,5 @@
-import { listMethod } from "./resource";
-import { AddressSuggestionResponse } from "@ideal-postcodes/api-typings";
+import { listMethod, retrieveMethod } from "./resource";
+import { AddressSuggestionResponse, GbrResolveResponse } from "../types";
 import { OptionalStringMap } from "../util";
 import { Client } from "../client";
 import { HttpResponse } from "../agent";
@@ -64,3 +64,19 @@ export interface List {
 
 export const list: List = (client, request) =>
   listMethod<Request, AddressSuggestionResponse>({ resource, client })(request);
+
+export interface GbrResponse extends HttpResponse {
+  body: GbrResolveResponse;
+}
+
+export interface Gbr {
+  (client: Client, id: string, request: Request): Promise<GbrResponse>;
+}
+
+// Resolves address to the GBR format
+export const gbr: Gbr = (client, id, request) =>
+  retrieveMethod<Request, GbrResolveResponse>({
+    resource,
+    client,
+    action: "gbr",
+  })(id, request);

test/autocomplete.resource.ts

@@ -1,13 +1,13 @@
 import * as sinon from "sinon";
 import { IdpcRequestFailedError, IdpcBalanceDepletedError } from "../lib/error";
 import { errors, autocomplete } from "@ideal-postcodes/api-fixtures";
-import { list } from "../lib/resources/autocomplete";
+import { list, gbr } from "../lib/resources/autocomplete";
 import { HttpVerb } from "../lib/agent";
 import { Client, defaults } from "../lib/index";
 import { assert } from "chai";
 import { newConfig, toResponse } from "./helper/index";
 
-describe("AutocompleteResource", () => {
+describe("AutocompleteResource: List", () => {
   afterEach(() => sinon.restore());
 
   const api_key = "foo";
@@ -42,6 +42,7 @@ describe("AutocompleteResource", () => {
       .resolves(toResponse(autocomplete.success, expectedRequest));
 
     list(client, { query }).then((response) => {
+      //@ts-ignore
       assert.deepEqual(response.body, autocomplete.success.body);
       done();
     });
@@ -74,3 +75,126 @@ describe("AutocompleteResource", () => {
       });
   });
 });
+
+describe("AutocompleteResource: Resolve", () => {
+  const fixture = {
+    description: "UDPRN address retrieval",
+    url: "/v1/udprn/23747208",
+    query: {
+      api_key: "<VALID_API_KEY>",
+    },
+    headers: {},
+    httpStatus: 200,
+    body: {
+      result: {
+        postcode: "SW1A 0AA",
+        postcode_inward: "0AA",
+        postcode_outward: "SW1A",
+        post_town: "LONDON",
+        dependant_locality: "",
+        double_dependant_locality: "",
+        thoroughfare: "",
+        dependant_thoroughfare: "",
+        building_number: "",
+        building_name: "Houses Of Parliament",
+        sub_building_name: "",
+        po_box: "",
+        department_name: "",
+        organisation_name: "House Of Commons",
+        udprn: 23747208,
+        umprn: "",
+        postcode_type: "L",
+        su_organisation_indicator: "",
+        delivery_point_suffix: "1A",
+        line_1: "House Of Commons",
+        line_2: "Houses Of Parliament",
+        line_3: "",
+        premise: "Houses Of Parliament",
+        longitude: -0.1246375,
+        latitude: 51.4998415,
+        eastings: 530268,
+        northings: 179545,
+        country: "England",
+        traditional_county: "Greater London",
+        administrative_county: "",
+        postal_county: "London",
+        county: "London",
+        district: "Westminster",
+        ward: "St James's",
+        uprn: "10033540874",
+        dataset: "paf",
+        id: "paf_23747208",
+        country_iso: "GBR",
+      },
+      code: 2000,
+      message: "Success",
+    },
+  };
+
+  afterEach(() => sinon.restore());
+
+  const api_key = "foo";
+  const id = "paf_123456";
+  const query = { api_key };
+  const client = new Client(newConfig());
+  const expectedRequest = {
+    method: "GET" as HttpVerb,
+    header: defaults.header,
+    query,
+    timeout: client.config.timeout,
+    url: `https://api.ideal-postcodes.co.uk/v1/autocomplete/addresses/${id}/gbr`,
+  };
+
+  describe("contract", () => {
+    it("generates API request on agent", (done) => {
+      const stub = sinon
+        .stub(client.config.agent, "http")
+        .resolves(toResponse(fixture, expectedRequest));
+
+      gbr(client, id, { query }).then(() => {
+        sinon.assert.calledOnce(stub);
+        sinon.assert.calledWithExactly(stub, expectedRequest);
+        done();
+      });
+    });
+  });
+
+  it("returns resolved address", (done) => {
+    sinon
+      .stub(client.config.agent, "http")
+      .resolves(toResponse(fixture, expectedRequest));
+
+    gbr(client, id, { query }).then((response) => {
+      //@ts-ignore
+      assert.deepEqual(response.body, fixture.body);
+      done();
+    });
+  });
+
+  it("returns non API errors (e.g. connection error)", (done) => {
+    sinon.stub(client.config.agent, "http").rejects(new Error("timeout!"));
+
+    gbr(client, id, { query })
+      .then(() => {
+        done(new Error("Promise should be rejected"));
+      })
+      .catch((error) => {
+        assert.instanceOf(error, Error);
+        done();
+      });
+  });
+
+  it("returns API errors", (done) => {
+    sinon
+      .stub(client.config.agent, "http")
+      .resolves(toResponse(errors.balanceDepleted, expectedRequest));
+
+    gbr(client, id, { query })
+      .then(() => done(new Error("Promise should be rejected")))
+      .catch((error) => {
+        assert.instanceOf(error, IdpcBalanceDepletedError);
+        assert.isTrue(error instanceof IdpcRequestFailedError);
+        done();
+      });
+  });
+});