smartystreets-javascript-sdk 5.1.4 → 6.0.0

package/tests/us_autocomplete_pro/test_Client.js

@@ -1,116 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/us_autocomplete_pro/Client");
-const Lookup = require("../../src/us_autocomplete_pro/Lookup");
-const Suggestion = require("../../src/us_autocomplete_pro/Suggestion");
-const errors = require("../../src/Errors");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-
-describe("A US Autocomplete Pro Client", function () {
-	it("correctly builds parameters for a prefix only lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let search = '(>")>#';
-		let lookup = new Lookup(search);
-		let expectedParameters = {
-			exclude_states: "",
-			include_only_cities: "",
-			include_only_states: "",
-			include_only_zip_codes: "",
-			prefer_cities: "",
-			prefer_states: "",
-			prefer_zip_codes: "",
-			search: search,
-		};
-
-		client.send(lookup);
-
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("correctly builds parameters for a fully-populated lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let lookup = new Lookup();
-		lookup.search = "1";
-		lookup.selected = "2";
-		lookup.maxResults = "3";
-		lookup.includeOnlyCities = ["a,b", "c,d"];
-		lookup.includeOnlyStates = ["e", "f"];
-		lookup.includeOnlyZIPCodes = ["g", "h"];
-		lookup.excludeStates = ["i", "j"];
-		lookup.preferCities = ["k,l", "m,n"];
-		lookup.preferStates = ["o", "p"];
-		lookup.preferZIPCodes = ["q", "r"];
-		lookup.preferRatio = "s";
-		lookup.preferGeolocation = "t";
-		lookup.source = "all";
-
-		let expectedParameters = {
-			search: "1",
-			selected: "2",
-			max_results: "3",
-			include_only_cities: "a,b;c,d",
-			include_only_states: "e;f",
-			include_only_zip_codes: "g;h",
-			exclude_states: "i;j",
-			prefer_cities: "k,l;m,n",
-			prefer_states: "o;p",
-			prefer_zip_codes: "q;r",
-			prefer_ratio: "s",
-			prefer_geolocation: "t",
-			source: "all",
-		};
-
-		client.send(lookup);
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("throws an error if sending without a lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		expect(client.send).to.throw(errors.UndefinedLookupError);
-	});
-
-	it("rejects with an exception if the response comes back with an error.", function () {
-		let expectedError = new Error("I'm the error.");
-		let mockSender = new MockSenderWithResponse("", expectedError);
-		let client = new Client(mockSender);
-		let lookup = new Lookup("¯\\_(ツ)_/¯");
-
-		return client.send(lookup).catch((e) => {expect(e).to.equal(expectedError);});
-	});
-
-	it("returns an empty array when no suggestions are returned.", () => {
-		let mockExpectedPayload = {suggestions: null};
-		let mockSender = new MockSenderWithResponse(mockExpectedPayload);
-		let client = new Client(mockSender);
-		let lookup = new Lookup("Please let this be easy to test.");
-		let expectedSuggestion = [];
-
-		return client.send(lookup).then(response => {
-			expect(lookup.result).to.deep.equal(expectedSuggestion);
-		});
-	});
-
-	it("attaches suggestions from a response to a lookup.", function () {
-		const responseData = {
-			streetLine: "a",
-			secondary: "b",
-			city: "c",
-			state: "d",
-			zipcode: "e",
-			entries: "f",
-		};
-		let mockExpectedPayload = {suggestions: [responseData]};
-		let mockSender = new MockSenderWithResponse(mockExpectedPayload);
-		let client = new Client(mockSender);
-		let lookup = new Lookup("Trevor the Vampire");
-		let expectedSuggestion = new Suggestion(responseData);
-
-		return client.send(lookup).then(response => {
-			expect(lookup.result[0]).to.deep.equal(expectedSuggestion);
-		});
-	})
-});

package/tests/us_autocomplete_pro/test_Lookup.js

@@ -1,11 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Lookup = require("../../src/us_autocomplete_pro/Lookup");
-
-describe("A US Autocomplete Pro Lookup", function () {
-	it("can be newed up with a prefix.", function () {
-		const expectedSearch = "a";
-		let lookup = new Lookup(expectedSearch);
-		expect(lookup.search).to.equal(expectedSearch);
-	});
-});

package/tests/us_autocomplete_pro/test_Suggestion.js

@@ -1,24 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Suggestion = require("../../src/us_autocomplete_pro/Suggestion");
-
-describe("A US Autocomplete Pro Suggestion", function () {
-	it("is initialized correctly with API response data.", function () {
-		const mockSuggestion = {
-			street_line: "a",
-			secondary: "b",
-			city: "c",
-			state: "d",
-			zipcode: "e",
-			entries: "f",
-		};
-		let suggestion = new Suggestion(mockSuggestion);
-
-		expect(suggestion.streetLine).to.equal("a");
-		expect(suggestion.secondary).to.equal("b");
-		expect(suggestion.city).to.equal("c");
-		expect(suggestion.state).to.equal("d");
-		expect(suggestion.zipcode).to.equal("e");
-		expect(suggestion.entries).to.equal("f");
-	});
-});

package/tests/us_enrichment/test_Client.js

@@ -1,271 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/us_enrichment/Client");
-const Lookup = require("../../src/us_enrichment/Lookup");
-const errors = require("../../src/Errors");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-const {Response, FinancialResponse, GeoResponse} = require("../../src/us_enrichment/Response");
-
-describe("A US Enrichment Client", function () {
-    it("composes principal url path properly", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let smartyKey = "0";
-        let lookup = new Lookup(smartyKey);
-
-        client.sendPrincipal(lookup);
-
-        expect(mockSender.request.baseUrlParam).to.deep.equal("0/property/principal");
-    })
-
-    it("composes financial url path properly", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let smartyKey = "0";
-        let lookup = new Lookup(smartyKey);
-
-        client.sendFinancial(lookup);
-
-        expect(mockSender.request.baseUrlParam).to.deep.equal("0/property/financial");
-    })
-
-    it("composes geo url path properly", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let smartyKey = "0";
-        let lookup = new Lookup(smartyKey);
-
-        client.sendGeo(lookup);
-
-        expect(mockSender.request.baseUrlParam).to.deep.equal("0/geo-reference");
-    })
-
-    it("correctly builds parameters for a smartyKey only principal lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let smartyKey = '(>")>#';
-        let include = "1";
-        let lookup = new Lookup(smartyKey, include);
-        let expectedParameters = {
-            include: include,
-        };
-
-        client.sendPrincipal(lookup);
-
-        expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-    });
-
-    it("correctly builds parameters for a smartyKey only financial lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let smartyKey = '(>")>#';
-        let include = "1";
-        let lookup = new Lookup(smartyKey, include);
-        let expectedParameters = {
-            include: include,
-        };
-
-        client.sendFinancial(lookup);
-
-        expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-    });
-
-    it("correctly builds parameters for a smartyKey only geo lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let smartyKey = '(>")>#';
-        let include = "1";
-        let lookup = new Lookup(smartyKey, include);
-        let expectedParameters = {
-            include: include,
-        };
-
-        client.sendGeo(lookup);
-
-        expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-    });
-
-    it("correctly builds parameters for a fully-populated principal lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let lookup = new Lookup("0","1","2","3","4");
-
-        let expectedParameters = {
-            include: "1",
-            exclude: "2",
-            dataset: "3",
-            data_subset: "4",
-        };
-
-        client.sendPrincipal(lookup);
-        expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-    });
-
-    it("correctly builds parameters for a fully-populated financial lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let lookup = new Lookup("0","1","2","3","4");
-
-        let expectedParameters = {
-            include: "1",
-            exclude: "2",
-            dataset: "3",
-            data_subset: "4",
-        };
-
-        client.sendFinancial(lookup);
-        expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-    });
-
-    it("correctly builds parameters for a fully-populated geo lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        let lookup = new Lookup("0","1","2","3","4");
-
-        let expectedParameters = {
-            include: "1",
-            exclude: "2",
-            dataset: "3",
-            data_subset: "4",
-        };
-
-        client.sendGeo(lookup);
-        expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-    });
-
-    it("throws an error if sending without a principal lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        expect(client.sendPrincipal).to.throw(errors.UndefinedLookupError);
-    });
-
-    it("throws an error if sending without a financial lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        expect(client.sendFinancial).to.throw(errors.UndefinedLookupError);
-    });
-
-    it("throws an error if sending without a geo lookup.", function () {
-        let mockSender = new MockSender();
-        let client = new Client(mockSender);
-        expect(client.sendGeo).to.throw(errors.UndefinedLookupError);
-    });
-
-    it("rejects with an exception if the principal response comes back with an error.", function () {
-        let expectedError = new Error("I'm the error.");
-        let mockSender = new MockSenderWithResponse("", expectedError);
-        let client = new Client(mockSender);
-        let lookup = new Lookup("¯\\_(ツ)_/¯");
-
-        return client.sendPrincipal(lookup).catch((e) => {expect(e).to.equal(expectedError);});
-    });
-
-    it("rejects with an exception if the financial response comes back with an error.", function () {
-        let expectedError = new Error("I'm the error.");
-        let mockSender = new MockSenderWithResponse("", expectedError);
-        let client = new Client(mockSender);
-        let lookup = new Lookup("¯\\_(ツ)_/¯");
-
-        return client.sendFinancial(lookup).catch((e) => {expect(e).to.equal(expectedError);});
-    });
-
-    it("rejects with an exception if the geo response comes back with an error.", function () {
-        let expectedError = new Error("I'm the error.");
-        let mockSender = new MockSenderWithResponse("", expectedError);
-        let client = new Client(mockSender);
-        let lookup = new Lookup("¯\\_(ツ)_/¯");
-
-        return client.sendGeo(lookup).catch((e) => {expect(e).to.equal(expectedError);});
-    });
-
-    it("returns an empty array when no principal respo are returned.", () => {
-        let mockSender = new MockSenderWithResponse({});
-        let client = new Client(mockSender);
-        let lookup = new Lookup("smartyKey");
-
-        return client.sendPrincipal(lookup).then(response => {
-            expect(lookup.response).to.deep.equal({});
-        });
-    });
-
-    it("returns an empty array when no financial suggestions are returned.", () => {
-        let mockSender = new MockSenderWithResponse({});
-        let client = new Client(mockSender);
-        let lookup = new Lookup("smartyKey");
-
-        return client.sendFinancial(lookup).then(response => {
-            expect(lookup.response).to.deep.equal({});
-        });
-    });
-
-    it("returns an empty array when no geo suggestions are returned.", () => {
-        let mockSender = new MockSenderWithResponse({});
-        let client = new Client(mockSender);
-        let lookup = new Lookup("smartyKey");
-
-        return client.sendGeo(lookup).then(response => {
-            expect(lookup.response).to.deep.equal({});
-        });
-    });
-
-    it("attaches response to a principal lookup.", function () {
-        const rawMockResponse = {
-            smarty_key: "a",
-            data_set_name: "b",
-            data_subset_name: "c",
-            attributes: {
-                assessed_improvement_percent: "1"
-            },
-        };
-        let mockResponse = new Response(rawMockResponse);
-
-        let mockSender = new MockSenderWithResponse(mockResponse);
-        let client = new Client(mockSender);
-        let lookup = new Lookup("smartyKey");
-
-        return client.sendPrincipal(lookup).then(response => {
-            expect(lookup.response).to.deep.equal(mockResponse);
-        });
-    })
-
-    it("attaches response to a financial lookup.", function () {
-        const rawMockResponse = {
-            smarty_key: "a",
-            data_set_name: "b",
-            data_subset_name: "c",
-            attributes: {
-                assessed_improvement_percent: "1"
-            },
-        };
-        let mockResponse = new FinancialResponse(rawMockResponse);
-
-        let mockSender = new MockSenderWithResponse(mockResponse);
-        let client = new Client(mockSender);
-        let lookup = new Lookup("smartyKey");
-
-        return client.sendFinancial(lookup).then(response => {
-            expect(lookup.response).to.deep.equal(mockResponse);
-        });
-    })
-
-    it("attaches response to a geo lookup.", function () {
-        const rawMockResponse = {
-            smarty_key: "a",
-            data_set_name: "b",
-            data_subset_name: "c",
-            attributes: {
-                assessed_improvement_percent: "1"
-            },
-        };
-        let mockResponse = new GeoResponse(rawMockResponse);
-
-        let mockSender = new MockSenderWithResponse(mockResponse);
-        let client = new Client(mockSender);
-        let lookup = new Lookup("smartyKey");
-
-        return client.sendGeo(lookup).then(response => {
-            expect(lookup.response).to.deep.equal(mockResponse);
-        });
-    })
-});

package/tests/us_enrichment/test_Lookup.js

@@ -1,22 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Lookup = require("../../src/us_enrichment/Lookup");
-
-describe("A US Enrichment Lookup", function () {
-    it("can be newed up with all basic fields.", function () {
-        const expectedSmartyKey = "a";
-        const expectedInclude = "b";
-        const expectedExclude = "c";
-        const expectedDataset = "d";
-        const expectedDataSubset = "e";
-
-        let lookup = new Lookup(expectedSmartyKey, expectedInclude, expectedExclude, expectedDataset, expectedDataSubset);
-        expect(lookup.smartyKey).to.equal(expectedSmartyKey);
-        expect(lookup.include).to.equal(expectedInclude);
-        expect(lookup.exclude).to.equal(expectedExclude);
-        expect(lookup.dataset).to.equal(expectedDataset);
-        expect(lookup.dataSubset).to.equal(expectedDataSubset);
-    });
-
-
-});