Skip to content

refactor alpha search model to match api response #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ethatcher83 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

refactor alpha search model to match api response #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions src/services/search/alphabetical-search/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
export interface CompaniesResource {
etag: string;
searchType: string;
topHit: string;
results: Result[];
topHit: TopHit;
items: Items[];
}

export interface Result {
ID: string;
company_type: string;
items: Items;
links: Links;
}

export interface Items {
company_number: string;
company_status: string;
corporate_name: string;
record_type: string;
ordered_alpha_key: string;
ordered_alpha_key_with_id: string;
kind: string;
links: Links;
company_type: string;
}

export interface Links {
self: string;
}
export interface TopHit {
company_name: string;
company_number: string;
company_status: string;
ordered_alpha_key_with_id: string;
kind: string;
}
74 changes: 38 additions & 36 deletions test/services/search/alphabetical-search/service.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,28 @@ const expect = chai.expect;
const requestClient = new RequestClient({ baseUrl: "URL-NOT-USED", oauthToken: "TOKEN-NOT-USED" });

const mockResponseBody : CompaniesResource = ({
etag: "etag",
searchType: "",
topHit: "TEST COMPANY",
results: [
topHit: {
company_name: "test company",
company_number: "0000789",
company_status: "active",
kind: "kind",
ordered_alpha_key_with_id: "testcompany:0000789"
},
items: [
{
ID: "FC022000",
company_type: "oversea-company",
items: {
company_number: "FC022000",
company_status: "active",
corporate_name: "corporate name",
record_type: "record type",
ordered_alpha_key: "ordered alpha key",
ordered_alpha_key_with_id: "COMPANY:00000000"
},
company_number: "FC022000",
company_status: "active",
corporate_name: "corporate name",
record_type: "record type",
ordered_alpha_key: "ordered alpha key",
ordered_alpha_key_with_id: "COMPANY:00000000",
links: {
self: "/company/FC022000"
}
},
kind: "kind"
}
]
});
Expand Down Expand Up @@ -75,14 +80,13 @@ describe("create a alphabetical search GET", () => {

expect(data.httpStatusCode).to.equal(200);
expect(data.resource.topHit).to.equal(mockResponseBody.topHit);
expect(data.resource.results[0].ID).to.equal(mockResponseBody.results[0].ID);
expect(data.resource.results[0].company_type).to.equal(mockResponseBody.results[0].company_type)
expect(data.resource.results[0].items.company_number).to.equal(mockResponseBody.results[0].items.company_number);
expect(data.resource.results[0].items.company_status).to.equal(mockResponseBody.results[0].items.company_status);
expect(data.resource.results[0].items.corporate_name).to.equal(mockResponseBody.results[0].items.corporate_name);
expect(data.resource.results[0].items.record_type).to.equal(mockResponseBody.results[0].items.record_type);
expect(data.resource.results[0].items.ordered_alpha_key).to.equal(mockResponseBody.results[0].items.ordered_alpha_key);
expect(data.resource.results[0].links).to.equal(mockResponseBody.results[0].links);
expect(data.resource.items[0].company_type).to.equal(mockResponseBody.items[0].company_type)
expect(data.resource.items[0].company_number).to.equal(mockResponseBody.items[0].company_number);
expect(data.resource.items[0].company_status).to.equal(mockResponseBody.items[0].company_status);
expect(data.resource.items[0].corporate_name).to.equal(mockResponseBody.items[0].corporate_name);
expect(data.resource.items[0].record_type).to.equal(mockResponseBody.items[0].record_type);
expect(data.resource.items[0].ordered_alpha_key).to.equal(mockResponseBody.items[0].ordered_alpha_key);
expect(data.resource.items[0].links).to.equal(mockResponseBody.items[0].links);
});

it("returns alphabetical search results correctly when searching previous results", async () => {
Expand All @@ -97,14 +101,13 @@ describe("create a alphabetical search GET", () => {

expect(data.httpStatusCode).to.equal(200);
expect(data.resource.topHit).to.equal(mockResponseBody.topHit);
expect(data.resource.results[0].ID).to.equal(mockResponseBody.results[0].ID);
expect(data.resource.results[0].company_type).to.equal(mockResponseBody.results[0].company_type)
expect(data.resource.results[0].items.company_number).to.equal(mockResponseBody.results[0].items.company_number);
expect(data.resource.results[0].items.company_status).to.equal(mockResponseBody.results[0].items.company_status);
expect(data.resource.results[0].items.corporate_name).to.equal(mockResponseBody.results[0].items.corporate_name);
expect(data.resource.results[0].items.record_type).to.equal(mockResponseBody.results[0].items.record_type);
expect(data.resource.results[0].items.ordered_alpha_key).to.equal(mockResponseBody.results[0].items.ordered_alpha_key);
expect(data.resource.results[0].links).to.equal(mockResponseBody.results[0].links);
expect(data.resource.items[0].company_type).to.equal(mockResponseBody.items[0].company_type)
expect(data.resource.items[0].company_number).to.equal(mockResponseBody.items[0].company_number);
expect(data.resource.items[0].company_status).to.equal(mockResponseBody.items[0].company_status);
expect(data.resource.items[0].corporate_name).to.equal(mockResponseBody.items[0].corporate_name);
expect(data.resource.items[0].record_type).to.equal(mockResponseBody.items[0].record_type);
expect(data.resource.items[0].ordered_alpha_key).to.equal(mockResponseBody.items[0].ordered_alpha_key);
expect(data.resource.items[0].links).to.equal(mockResponseBody.items[0].links);
});

it("returns alphabetical search results correctly when searching next results", async () => {
Expand All @@ -119,13 +122,12 @@ describe("create a alphabetical search GET", () => {

expect(data.httpStatusCode).to.equal(200);
expect(data.resource.topHit).to.equal(mockResponseBody.topHit);
expect(data.resource.results[0].ID).to.equal(mockResponseBody.results[0].ID);
expect(data.resource.results[0].company_type).to.equal(mockResponseBody.results[0].company_type)
expect(data.resource.results[0].items.company_number).to.equal(mockResponseBody.results[0].items.company_number);
expect(data.resource.results[0].items.company_status).to.equal(mockResponseBody.results[0].items.company_status);
expect(data.resource.results[0].items.corporate_name).to.equal(mockResponseBody.results[0].items.corporate_name);
expect(data.resource.results[0].items.record_type).to.equal(mockResponseBody.results[0].items.record_type);
expect(data.resource.results[0].items.ordered_alpha_key).to.equal(mockResponseBody.results[0].items.ordered_alpha_key);
expect(data.resource.results[0].links).to.equal(mockResponseBody.results[0].links);
expect(data.resource.items[0].company_type).to.equal(mockResponseBody.items[0].company_type)
expect(data.resource.items[0].company_number).to.equal(mockResponseBody.items[0].company_number);
expect(data.resource.items[0].company_status).to.equal(mockResponseBody.items[0].company_status);
expect(data.resource.items[0].corporate_name).to.equal(mockResponseBody.items[0].corporate_name);
expect(data.resource.items[0].record_type).to.equal(mockResponseBody.items[0].record_type);
expect(data.resource.items[0].ordered_alpha_key).to.equal(mockResponseBody.items[0].ordered_alpha_key);
expect(data.resource.items[0].links).to.equal(mockResponseBody.items[0].links);
});
});