smartystreets-javascript-sdk 5.2.0 → 6.0.0

package/tests/international_address_autocomplete/test_Client.js

@@ -1,86 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/international_address_autocomplete/Client");
-const Lookup = require("../../src/international_address_autocomplete/Lookup");
-const Suggestion = require("../../src/international_address_autocomplete/Suggestion");
-const errors = require("../../src/Errors");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-
-describe("An International Address Autocomplete Client", function () {
-	it("correctly builds parameter", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let search = "(";
-		let lookup = new Lookup({search});
-		let expectedParameters = {
-			max_results: 5,
-			search: "(",
-		};
-
-		client.send(lookup);
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("builds parameters for different country", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let search = "(";
-		let lookup = new Lookup({search});
-		lookup.search = search;
-		lookup.country = "Russia";
-		let expectedParameters = {
-			country: "Russia",
-			max_results: 5,
-			search: search,
-		};
-
-		client.send(lookup);
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("builds parameters with different max results", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let search = "(";
-		let lookup = new Lookup({search});
-		lookup.search = search;
-		lookup.maxResults = 10;
-		let expectedParameters = {
-			max_results: 10,
-			search: search,
-		};
-
-		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("attaches suggestions from a response to a lookup", function () {
-		const responseData = {
-			candidates: [
-				{
-					"street": "L alleya",
-					"locality": "Novosibirsk",
-					"administrative_area": "Novosibirskaya oblast'",
-					"postal_code": "40000",
-					"country_iso3": "RUS",
-				}
-			]
-		};
-
-		let mockSender = new MockSenderWithResponse(responseData);
-		let client = new Client(mockSender);
-		let lookup = new Lookup({search: "f"});
-		let expectedSuggestion = new Suggestion(responseData.candidates[0]);
-
-		return client.send(lookup).then(() => {
-			expect(lookup.result[0]).to.deep.equal(expectedSuggestion);
-		});
-	});
-});

package/tests/international_address_autocomplete/test_Lookup.js

@@ -1,55 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Lookup = require("../../src/international_address_autocomplete/Lookup");
-
-describe("An International Address Autocomplete lookup", function () {
-	it("Can be newed up with a prefix", function () {
-		const expectedPrefix = "z";
-		let lookup = new Lookup({search: expectedPrefix});
-		expect(lookup.search).to.equal(expectedPrefix);
-	});
-
-	it("Set address ID", function () {
-		const addressId = "111";
-		let lookup = new Lookup({addressId});
-		expect(lookup.addressId).to.equal(addressId);
-	});
-
-	it("Set country", function () {
-		const country = "Russia";
-		let lookup = new Lookup({country});
-		expect(lookup.country).to.equal(country);
-	});
-
-	it("Set max results", function () {
-		const maxResults = 10000;
-		let lookup = new Lookup({maxResults});
-		expect(lookup.maxResults).to.equal(maxResults);
-	});
-
-	it("Set include only include locality param", function () {
-		const onlyIncludeLocality = "locality";
-		let lookup = new Lookup({includeOnlyLocality: onlyIncludeLocality});
-		expect(lookup.includeOnlyLocality).to.equal(onlyIncludeLocality);
-	});
-
-	it("Set include only include postal code param", function () {
-		const onlyIncludePostalCode = "post code";
-		let lookup = new Lookup({includeOnlyPostalCode: onlyIncludePostalCode});
-		expect(lookup.includeOnlyPostalCode).to.equal(onlyIncludePostalCode);
-	});
-
-	it("Checking defaults of params on instantiation ", function () {
-		const defaultLookup = {
-			result: [],
-			search: undefined,
-			addressId: undefined,
-			country: undefined,
-			maxResults: 5,
-			includeOnlyLocality: undefined,
-			includeOnlyPostalCode: undefined,
-		};
-		let lookup = new Lookup();
-		expect(lookup).to.deep.equal(defaultLookup);
-	});
-});

package/tests/international_street/test_Candidate.js

@@ -1,268 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Candidate = require("../../src/international_street/Candidate");
-
-describe("An International match candidate", function () {
-	it("populates with the appropriate fields.", function () {
-		const sampleResponse = {
-			organization: "1",
-			address1: "2",
-			address2: "3",
-			address3: "4",
-			address4: "5",
-			address5: "6",
-			address6: "7",
-			address7: "8",
-			address8: "9",
-			address9: "10",
-			address10: "11",
-			address11: "12",
-			address12: "13",
-			components: {
-				country_iso_3: "14",
-				super_administrative_area: "15",
-				administrative_area: "16",
-				administrative_area_short: "16.1",
-				administrative_area_long: "16.2",
-				sub_administrative_area: "17",
-				dependent_locality: "18",
-				dependent_locality_name: "19",
-				double_dependent_locality: "20",
-				locality: "21",
-				postal_code: "22",
-				postal_code_short: "23",
-				postal_code_extra: "24",
-				premise: "25",
-				premise_extra: "26",
-				premise_prefix_number: "26.5",
-				premise_number: "27",
-				premise_type: "28",
-				thoroughfare: "29",
-				thoroughfare_predirection: "30",
-				thoroughfare_postdirection: "31",
-				thoroughfare_name: "32",
-				thoroughfare_trailing_type: "33",
-				thoroughfare_type: "34",
-				dependent_thoroughfare: "35",
-				dependent_thoroughfare_predirection: "36",
-				dependent_thoroughfare_postdirection: "37",
-				dependent_thoroughfare_name: "38",
-				dependent_thoroughfare_trailing_type: "39",
-				dependent_thoroughfare_type: "40",
-				building: "41",
-				building_leading_type: "42",
-				building_name: "43",
-				building_trailing_type: "44",
-				sub_building_type: "45",
-				sub_building_number: "46",
-				sub_building_name: "47",
-				sub_building: "48",
-				level_type: "48.1",
-				level_number: "48.2",
-				post_box: "49",
-				post_box_type: "50",
-				post_box_number: "51",
-			},
-			metadata: {
-				latitude: 52.0,
-				longitude: 53.0,
-				geocode_precision: "54",
-				max_geocode_precision: "55",
-				address_format: "56",
-			},
-			analysis: {
-				verification_status: "57",
-				address_precision: "58",
-				max_address_precision: "59",
-				changes: {
-					organization: "60",
-					address1: "61",
-					address2: "62",
-					address3: "63",
-					address4: "64",
-					address5: "65",
-					address6: "66",
-					address7: "67",
-					address8: "68",
-					address9: "69",
-					address10: "70",
-					address11: "71",
-					address12: "72",
-					components: {
-						country_iso_3: "73",
-						super_administrative_area: "74",
-						administrative_area: "75",
-						administrative_area_short: "75.1",
-						administrative_area_long: "75.2",
-						sub_administrative_area: "76",
-						dependent_locality: "77",
-						dependent_locality_name: "78",
-						double_dependent_locality: "79",
-						locality: "80",
-						postal_code: "81",
-						postal_code_short: "82",
-						postal_code_extra: "83",
-						premise: "84",
-						premise_extra: "85",
-						premise_prefix_number: "86",
-						premise_number: "87",
-						premise_type: "88",
-						thoroughfare: "89",
-						thoroughfare_predirection: "90",
-						thoroughfare_postdirection: "91",
-						thoroughfare_name: "92",
-						thoroughfare_trailing_type: "93",
-						thoroughfare_type: "94",
-						dependent_thoroughfare: "95",
-						dependent_thoroughfare_predirection: "96",
-						dependent_thoroughfare_postdirection: "97",
-						dependent_thoroughfare_name: "98",
-						dependent_thoroughfare_trailing_type: "99",
-						dependent_thoroughfare_type: "100",
-						building: "101",
-						building_leading_type: "102",
-						building_name: "103",
-						building_trailing_type: "104",
-						sub_building_type: "105",
-						sub_building_number: "106",
-						sub_building_name: "107",
-						sub_building: "108",
-						level_type: "108.1",
-						level_number: "108.2",
-						post_box: "109",
-						post_box_type: "110",
-						post_box_number: "111",
-					},
-				},
-			},
-		};
-
-		const candidate = new Candidate(sampleResponse);
-
-		expect(candidate.organization).to.equal("1");
-		expect(candidate.address1).to.equal("2");
-		expect(candidate.address2).to.equal("3");
-		expect(candidate.address3).to.equal("4");
-		expect(candidate.address4).to.equal("5");
-		expect(candidate.address5).to.equal("6");
-		expect(candidate.address6).to.equal("7");
-		expect(candidate.address7).to.equal("8");
-		expect(candidate.address8).to.equal("9");
-		expect(candidate.address9).to.equal("10");
-		expect(candidate.address10).to.equal("11");
-		expect(candidate.address11).to.equal("12");
-		expect(candidate.address12).to.equal("13");
-		let components = candidate.components;
-		expect(components.countryIso3).to.equal("14");
-		expect(components.superAdministrativeArea).to.equal("15");
-		expect(components.administrativeArea).to.equal("16");
-		expect(components.administrativeAreaShort).to.equal("16.1");
-		expect(components.administrativeAreaLong).to.equal("16.2");
-		expect(components.subAdministrativeArea).to.equal("17");
-		expect(components.dependentLocality).to.equal("18");
-		expect(components.dependentLocalityName).to.equal("19");
-		expect(components.doubleDependentLocality).to.equal("20");
-		expect(components.locality).to.equal("21");
-		expect(components.postalCode).to.equal("22");
-		expect(components.postalCodeShort).to.equal("23");
-		expect(components.postalCodeExtra).to.equal("24");
-		expect(components.premise).to.equal("25");
-		expect(components.premiseExtra).to.equal("26");
-		expect(components.premisePrefixNumber).to.equal("26.5");
-		expect(components.premiseNumber).to.equal("27");
-		expect(components.premiseType).to.equal("28");
-		expect(components.thoroughfare).to.equal("29");
-		expect(components.thoroughfarePredirection).to.equal("30");
-		expect(components.thoroughfarePostdirection).to.equal("31");
-		expect(components.thoroughfareName).to.equal("32");
-		expect(components.thoroughfareTrailingType).to.equal("33");
-		expect(components.thoroughfareType).to.equal("34");
-		expect(components.dependentThoroughfare).to.equal("35");
-		expect(components.dependentThoroughfarePredirection).to.equal("36");
-		expect(components.dependentThoroughfarePostdirection).to.equal("37");
-		expect(components.dependentThoroughfareName).to.equal("38");
-		expect(components.dependentThoroughfareTrailingType).to.equal("39");
-		expect(components.dependentThoroughfareType).to.equal("40");
-		expect(components.building).to.equal("41");
-		expect(components.buildingLeadingType).to.equal("42");
-		expect(components.buildingName).to.equal("43");
-		expect(components.buildingTrailingType).to.equal("44");
-		expect(components.subBuildingType).to.equal("45");
-		expect(components.subBuildingNumber).to.equal("46");
-		expect(components.subBuildingName).to.equal("47");
-		expect(components.subBuilding).to.equal("48");
-		expect(components.levelType).to.equal("48.1");
-		expect(components.levelNumber).to.equal("48.2");
-		expect(components.postBox).to.equal("49");
-		expect(components.postBoxType).to.equal("50");
-		expect(components.postBoxNumber).to.equal("51");
-		let metadata = candidate.metadata;
-		expect(metadata.latitude).to.equal(52.0);
-		expect(metadata.longitude).to.equal(53.0);
-		expect(metadata.geocodePrecision).to.equal("54");
-		expect(metadata.maxGeocodePrecision).to.equal("55");
-		expect(metadata.addressFormat).to.equal("56");
-		let analysis = candidate.analysis;
-		expect(analysis.verificationStatus).to.equal("57");
-		expect(analysis.addressPrecision).to.equal("58");
-		expect(analysis.maxAddressPrecision).to.equal("59");
-		let changes = analysis.changes;
-		expect(changes.organization).to.equal("60");
-		expect(changes.address1).to.equal("61");
-		expect(changes.address2).to.equal("62");
-		expect(changes.address3).to.equal("63");
-		expect(changes.address4).to.equal("64");
-		expect(changes.address5).to.equal("65");
-		expect(changes.address6).to.equal("66");
-		expect(changes.address7).to.equal("67");
-		expect(changes.address8).to.equal("68");
-		expect(changes.address9).to.equal("69");
-		expect(changes.address10).to.equal("70");
-		expect(changes.address11).to.equal("71");
-		expect(changes.address12).to.equal("72");
-		let ccomponents = changes.components;
-		expect(ccomponents.countryIso3).to.equal("73");
-		expect(ccomponents.superAdministrativeArea).to.equal("74");
-		expect(ccomponents.administrativeArea).to.equal("75");
-		expect(ccomponents.administrativeAreaShort).to.equal("75.1");
-		expect(ccomponents.administrativeAreaLong).to.equal("75.2");
-		expect(ccomponents.subAdministrativeArea).to.equal("76");
-		expect(ccomponents.dependentLocality).to.equal("77");
-		expect(ccomponents.dependentLocalityName).to.equal("78");
-		expect(ccomponents.doubleDependentLocality).to.equal("79");
-		expect(ccomponents.locality).to.equal("80");
-		expect(ccomponents.postalCode).to.equal("81");
-		expect(ccomponents.postalCodeShort).to.equal("82");
-		expect(ccomponents.postalCodeExtra).to.equal("83");
-		expect(ccomponents.premise).to.equal("84");
-		expect(ccomponents.premiseExtra).to.equal("85");
-		expect(ccomponents.premisePrefixNumber).to.equal("86");
-		expect(ccomponents.premiseNumber).to.equal("87");
-		expect(ccomponents.premiseType).to.equal("88");
-		expect(ccomponents.thoroughfare).to.equal("89");
-		expect(ccomponents.thoroughfarePredirection).to.equal("90");
-		expect(ccomponents.thoroughfarePostdirection).to.equal("91");
-		expect(ccomponents.thoroughfareName).to.equal("92");
-		expect(ccomponents.thoroughfareTrailingType).to.equal("93");
-		expect(ccomponents.thoroughfareType).to.equal("94");
-		expect(ccomponents.dependentThoroughfare).to.equal("95");
-		expect(ccomponents.dependentThoroughfarePredirection).to.equal("96");
-		expect(ccomponents.dependentThoroughfarePostdirection).to.equal("97");
-		expect(ccomponents.dependentThoroughfareName).to.equal("98");
-		expect(ccomponents.dependentThoroughfareTrailingType).to.equal("99");
-		expect(ccomponents.dependentThoroughfareType).to.equal("100");
-		expect(ccomponents.building).to.equal("101");
-		expect(ccomponents.buildingLeadingType).to.equal("102");
-		expect(ccomponents.buildingName).to.equal("103");
-		expect(ccomponents.buildingTrailingType).to.equal("104");
-		expect(ccomponents.subBuildingType).to.equal("105");
-		expect(ccomponents.subBuildingNumber).to.equal("106");
-		expect(ccomponents.subBuildingName).to.equal("107");
-		expect(ccomponents.subBuilding).to.equal("108");
-		expect(ccomponents.levelType).to.equal("108.1");
-		expect(ccomponents.levelNumber).to.equal("108.2");
-		expect(ccomponents.postBox).to.equal("109");
-		expect(ccomponents.postBoxType).to.equal("110");
-		expect(ccomponents.postBoxNumber).to.equal("111");
-	});
-});

package/tests/international_street/test_Client.js

@@ -1,70 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/international_street/Client");
-const Lookup = require("../../src/international_street/Lookup");
-const Candidate = require("../../src/international_street/Candidate");
-const errors = require("../../src/Errors");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-
-describe("An International Street client", function () {
-	it("has an inner sender.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-
-		expect(client.sender).to.deep.equal(mockSender);
-	});
-
-	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("correctly assigns request parameters based on lookup input.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let lookup = new Lookup("a", "b");
-		lookup.address1 = "c";
-		lookup.address2 = "d";
-		lookup.address3 = "e";
-		lookup.address4 = "f";
-		lookup.organization = "g";
-		lookup.locality = "h";
-		lookup.administrativeArea = "i";
-		lookup.postalCode = "j";
-		lookup.geocode = "k";
-		lookup.language = "l";
-		let expectedParameters = {
-			country: "a",
-			freeform: "b",
-			address1: "c",
-			address2: "d",
-			address3: "e",
-			address4: "f",
-			organization: "g",
-			locality: "h",
-			administrative_area: "i",
-			postal_code: "j",
-			geocode: "k",
-			language: "l",
-		};
-
-		client.send(lookup);
-
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("attaches a match candidate from a response to a lookup.", function () {
-		const expectedMockPayload = [{address1: "A", }];
-		let mockSender = new MockSenderWithResponse(expectedMockPayload);
-		const client = new Client(mockSender);
-		let lookup = new Lookup();
-		let expectedResult = new Candidate({address1: "A"});
-
-		return client.send(lookup).then(response => {
-			expect(lookup.result[0]).to.deep.equal(expectedResult);
-		});
-	});
-});

package/tests/international_street/test_Lookup.js

@@ -1,108 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Lookup = require("../../src/international_street/Lookup");
-const errors = require("../../src/Errors");
-
-describe("An International Street lookup", function () {
-	const messages = {
-		countryRequired: "Country field is required.",
-		freeformOrAddress1Required: "Either freeform or address1 is required.",
-		insufficientInformation: "Insufficient information: One or more required fields were not set on the lookup.",
-		badGeocode: "Invalid input: geocode can only be set to 'true' (default is 'false'.",
-		invalidLanguage: "Invalid input: language can only be set to 'latin' or 'native'. When not set, the the output language will match the language of the input values."
-	};
-
-	it("correctly populates fields.", function () {
-		let lookup = new Lookup("a", "b");
-
-		expect(lookup.country).to.equal("a");
-		expect(lookup.freeform).to.equal("b");
-	});
-
-	it("rejects lookups without a country.", function () {
-		ensureValidationThrows(new Lookup().ensureEnoughInfo, messages.countryRequired);
-	});
-
-	it("rejects lookups with only a country.", function () {
-		ensureValidationThrows(new Lookup("a").ensureEnoughInfo, messages.freeformOrAddress1Required);
-	});
-
-	it("rejects lookups with only a country and address 1.", function () {
-		let lookup = new Lookup("a");
-		lookup.address1 = "b";
-
-		ensureValidationThrows(lookup.ensureEnoughInfo, messages.insufficientInformation);
-	});
-
-	it("rejects lookups with only a country, address 1, and locality.", function () {
-		let lookup = new Lookup("a");
-		lookup.address1 = "b";
-		lookup.locality = "c";
-
-		ensureValidationThrows(lookup.ensureEnoughInfo, messages.insufficientInformation);
-	});
-
-	it("rejects lookups with only a country, address 1, and adminstrative area.", function () {
-		let lookup = new Lookup("a");
-		lookup.address1 = "b";
-		lookup.administrativeArea = "c";
-
-		ensureValidationThrows(lookup.ensureEnoughInfo, messages.insufficientInformation);
-	});
-
-	it("rejects lookups with an invalid geocode value.", function () {
-		let lookup = new Lookup();
-		lookup.geocode = "Blarg!";
-
-		ensureValidationThrows(lookup.ensureValidData, messages.badGeocode);
-	});
-
-	it("rejects lookups with an invalid language.", function () {
-		let lookup = new Lookup();
-		lookup.language = "Rubberduckian";
-
-		ensureValidationThrows(lookup.ensureValidData, messages.invalidLanguage);
-	});
-
-	it("accepts lookups with enough info.", function () {
-		let lookup1 = new Lookup("a", "b");
-
-		let lookup2 = new Lookup("a");
-		lookup2.address1 = "b";
-		lookup2.postalCode = "c";
-
-		let lookup3 = new Lookup("a");
-		lookup3.address1 = "b";
-		lookup3.locality = "c";
-		lookup3.administrativeArea = "d";
-
-		expect(lookup1.ensureEnoughInfo()).to.equal(true);
-		expect(lookup2.ensureEnoughInfo()).to.equal(true);
-		expect(lookup3.ensureEnoughInfo()).to.equal(true);
-	});
-
-	it("accepts lookups with a valid language.", function () {
-		let lookup1 = new Lookup();
-		lookup1.language = "latin";
-
-		expect(lookup1.ensureValidData()).to.equal(true);
-
-		let lookup2 = new Lookup();
-		lookup2.language = "native";
-
-		expect(lookup2.ensureValidData()).to.equal(true);
-	});
-
-	function ensureValidationThrows(callback, message) {
-		let expectedError = new errors.UnprocessableEntityError(message);
-
-		try {
-			callback();
-			expect(true).to.equal(false);
-		}
-		catch (error) {
-			expect(error.message).to.equal(expectedError.message);
-			expect(error).to.be.an.instanceOf(errors.UnprocessableEntityError);
-		}
-	}
-});

package/tests/test_AgentSender.js

@@ -1,25 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Request = require("../src/Request");
-const AgentSender = require("../src/AgentSender");
-
-describe("An agent sender", function () {
-	it ("attaches an 'agent' parameter to the request config.", function () {
-		function MockSender() {
-			this.agentString = "";
-
-			this.send = (request) => {
-				this.agentString = request.parameters.agent;
-			}
-		}
-
-		let mockSender = new MockSender();
-		let agentSender = new AgentSender(mockSender);
-		let request = new Request();
-		let expectedAgentString = "smarty (sdk:javascript@" + require("../package.json").version + ")";
-
-		agentSender.send(request);
-
-		expect(mockSender.agentString).to.equal(expectedAgentString);
-	});
-});

package/tests/test_BaseUrlSender.js

@@ -1,31 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const BaseUrlSender = require("../src/BaseUrlSender");
-const Request = require("../src/Request");
-
-describe("A base url sender", function () {
-	let innerSender;
-	let request;
-	let urlOverride;
-	let baseUrlSender;
-
-	beforeEach(() => {
-		innerSender = {
-			send: () => true
-		};
-		request = new Request();
-		urlOverride = "I'm in your base, killing your mans.";
-		baseUrlSender = new BaseUrlSender(innerSender, urlOverride);
-	});
-
-	it("replaces the request's base url with a new value.", function () {
-		request.baseUrl = "All your baseUrl are belong to us.";
-		baseUrlSender.send(request);
-
-		expect(request.baseUrl).to.equal(urlOverride);
-	});
-
-	it("returns a promise.", function () {
-		expect(baseUrlSender.send(request) instanceof Promise).to.equal(true);
-	});
-});