smartystreets-javascript-sdk 5.1.4 → 6.0.0

package/tests/us_extract/test_Address.js

@@ -1,67 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Address = require("../../src/us_extract/Address");
-const Candidate = require("../../src/us_street/Candidate");
-
-describe("A US Extract Address", function () {
-	it("populates fields correctly.", function () {
-		let mockResponseAddress = {
-			"text": "5732 Lincoln Drive Minneapolis MN",
-			"verified": true,
-			"line": 4,
-			"start": 16,
-			"end": 49,
-			"api_output": [
-				{
-					"candidate_index": 0,
-					"delivery_line_1": "5732 Lincoln Dr",
-					"last_line": "Minneapolis MN 55436-1608",
-					"delivery_point_barcode": "554361608327",
-					"components": {
-						"primary_number": "5732",
-						"street_name": "Lincoln",
-						"street_suffix": "Dr",
-						"city_name": "Minneapolis",
-						"state_abbreviation": "MN",
-						"zipcode": "55436",
-						"plus4_code": "1608",
-						"delivery_point": "32",
-						"delivery_point_check_digit": "7"
-					},
-					"metadata": {
-						"record_type": "S",
-						"zip_type": "Standard",
-						"county_fips": "27053",
-						"county_name": "Hennepin",
-						"carrier_route": "C009",
-						"congressional_district": "03",
-						"rdi": "Commercial",
-						"elot_sequence": "0035",
-						"elot_sort": "A",
-						"latitude": 44.90127,
-						"longitude": -93.40045,
-						"precision": "Zip9",
-						"time_zone": "Central",
-						"utc_offset": -6,
-						"dst": true
-					},
-					"analysis": {
-						"dpv_match_code": "Y",
-						"dpv_footnotes": "AABB",
-						"dpv_cmra": "N",
-						"dpv_vacant": "N",
-						"active": "Y",
-						"footnotes": "N#"
-					},
-				},
-			],
-		};
-		let address = new Address(mockResponseAddress);
-		expect(address.candidates[0]).to.be.an.instanceOf(Candidate);
-		expect(address.text).to.equal(mockResponseAddress.text);
-		expect(address.verified).to.equal(mockResponseAddress.verified);
-		expect(address.line).to.equal(mockResponseAddress.line);
-		expect(address.start).to.equal(mockResponseAddress.start);
-		expect(address.end).to.equal(mockResponseAddress.end);
-	});
-});

package/tests/us_extract/test_Client.js

@@ -1,148 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/us_extract/Client");
-const Lookup = require("../../src/us_extract/Lookup");
-const Result = require("../../src/us_extract/Result");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-const errors = require("../../src/Errors");
-
-describe("A US Extract Client", function () {
-	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 builds a payload for a text only lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let mockText = "yump.";
-		let lookup = new Lookup(mockText);
-		let expectedPayload = mockText;
-
-		client.send(lookup);
-
-		expect(mockSender.request.payload).to.deep.equal(expectedPayload);
-	});
-
-	it("correctly builds a payload for a fully-populated lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		const mockText = "The flocculated scunge is subprime for human consumption.";
-		let lookup = new Lookup(mockText);
-		let expectedPayload = mockText;
-
-		client.send(lookup);
-
-		expect(mockSender.request.payload).to.deep.equal(expectedPayload);
-	});
-
-	it("correctly builds parameters for a lookup.", () => {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		const mockText = "Picard is coming back. All power to the engines.";
-		let lookup = new Lookup(mockText);
-		lookup.html = 1;
-		lookup.aggressive = 2;
-		lookup.addressesHaveLineBreaks = 3;
-		lookup.addressesPerLine = 4;
-
-		let expectedParams = {
-			html: 1,
-			aggressive: 2,
-			addr_line_breaks: 3,
-			addr_per_line: 4,
-		};
-
-		client.send(lookup);
-
-		expect(mockSender.request.parameters).to.deep.equal(expectedParams);
-	});
-
-	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("Shine on you crazy diamond.");
-
-		return client.send(lookup).catch((e) => {expect(e).to.equal(expectedError);});
-	});
-
-	it("attaches result from a response to a lookup.", function () {
-		const responseData = {
-			"meta": {
-				"lines": 6,
-				"unicode": false,
-				"address_count": 1,
-				"verified_count": 1,
-				"bytes": 53,
-				"character_count": 53
-			},
-			"addresses": [
-				{
-					"text": "5732 Lincoln Drive Minneapolis MN",
-					"verified": true,
-					"line": 4,
-					"start": 16,
-					"end": 49,
-					"api_output": [
-						{
-							"candidate_index": 0,
-							"delivery_line_1": "5732 Lincoln Dr",
-							"last_line": "Minneapolis MN 55436-1608",
-							"delivery_point_barcode": "554361608327",
-							"components": {
-								"primary_number": "5732",
-								"street_name": "Lincoln",
-								"street_suffix": "Dr",
-								"city_name": "Minneapolis",
-								"state_abbreviation": "MN",
-								"zipcode": "55436",
-								"plus4_code": "1608",
-								"delivery_point": "32",
-								"delivery_point_check_digit": "7"
-							},
-							"metadata": {
-								"record_type": "S",
-								"zip_type": "Standard",
-								"county_fips": "27053",
-								"county_name": "Hennepin",
-								"carrier_route": "C009",
-								"congressional_district": "03",
-								"rdi": "Commercial",
-								"elot_sequence": "0035",
-								"elot_sort": "A",
-								"latitude": 44.90127,
-								"longitude": -93.40045,
-								"precision": "Zip9",
-								"time_zone": "Central",
-								"utc_offset": -6,
-								"dst": true
-							},
-							"analysis": {
-								"dpv_match_code": "Y",
-								"dpv_footnotes": "AABB",
-								"dpv_cmra": "N",
-								"dpv_vacant": "N",
-								"dpv_no_stat": "N",
-								"active": "Y",
-								"footnotes": "N#"
-							}
-						}
-					]
-				}
-			]
-		};
-
-		let mockSender = new MockSenderWithResponse(responseData);
-		let client = new Client(mockSender);
-		let lookup = new Lookup("Sometimes when you're testing this field doesn't matter too much.");
-		let expectedResult = new Result(responseData);
-
-		return client.send(lookup).then(response => {
-			expect(lookup.result).to.deep.equal(expectedResult);
-		});
-	})
-});

package/tests/us_extract/test_Lookup.js

@@ -1,19 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Lookup = require("../../src/us_extract/Lookup");
-
-describe("A US Extract Lookup", function () {
-	it("correctly populates fields.", function () {
-		let lookup = new Lookup("some text");
-		lookup.html = true;
-		lookup.aggressive = true;
-		lookup.addressesHaveLineBreaks = true;
-		lookup.addressesPerLine = 10;
-
-		expect(lookup.text).to.equal("some text");
-		expect(lookup.html).to.equal(true);
-		expect(lookup.aggressive).to.equal(true);
-		expect(lookup.addressesHaveLineBreaks).to.equal(true);
-		expect(lookup.addressesPerLine).to.equal(10);
-	});
-});

package/tests/us_extract/test_Result.js

@@ -1,39 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Result = require("../../src/us_extract/Result");
-const Address = require("../../src/us_extract/Address");
-
-describe("A US Extract Result", function () {
-	it("correctly populates fields.", function () {
-		const mockResponseData = {
-			"meta": {
-				"lines": 6,
-				"unicode": false,
-				"address_count": 1,
-				"verified_count": 1,
-				"bytes": 53,
-				"character_count": 53,
-			},
-			"addresses": [
-				{
-					"text": "5732 Lincoln Drive Minneapolis MN",
-					"verified": true,
-					"line": 4,
-					"start": 16,
-					"end": 49,
-					"api_output": [{}]
-				}
-			]
-		};
-		let result = new Result(mockResponseData);
-
-		expect(result.meta.lines).to.equal(6);
-		expect(result.meta.unicode).to.equal(false);
-		expect(result.meta.addressCount).to.equal(1);
-		expect(result.meta.verifiedCount).to.equal(1);
-		expect(result.meta.bytes).to.equal(53);
-		expect(result.meta.characterCount).to.equal(53);
-
-		expect(result.addresses[0]).to.be.an.instanceOf(Address);
-	});
-});

package/tests/us_reverse_geo/test_Client.js

@@ -1,48 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/us_reverse_geo/Client");
-const Lookup = require("../../src/us_reverse_geo/Lookup");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-const Response = require("../../src/us_reverse_geo/Response");
-
-describe("A US Reverse Geo 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("attaches a result from a response to a lookup.", function () {
-		const expectedMockPayload = {
-			"results": [
-				{
-					"coordinate": {
-						"latitude": 40.111111,
-						"longitude": -111.111111,
-						"accuracy": "Rooftop",
-						"license": "SmartyStreets"
-					},
-					"distance": 2.7207432,
-					"address": {
-						"street": "2335 S State St",
-						"city": "Provo",
-						"state_abbreviation": "UT",
-						"zipcode": "84606",
-						"source": "postal"
-					}
-				},
-			]
-		};
-		let mockSender = new MockSenderWithResponse(expectedMockPayload);
-		const client = new Client(mockSender);
-		let lookup = new Lookup(44.888888888, -111.111111111, "postal");
-
-		return client.send(lookup).then(() => {
-			expect(lookup.response).to.deep.equal(expectedMockPayload);
-			expect(lookup.response).to.be.an.instanceOf(Response);
-		});
-	});
-});

package/tests/us_reverse_geo/test_Lookup.js

@@ -1,14 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Lookup = require("../../src/us_reverse_geo/Lookup");
-
-describe("A US Reverse Geo lookup", function () {
-	it("correctly populates fields.", function () {
-		let lookup = new Lookup(44.888888888, -111.111111111, "postal");
-
-		expect(lookup.source).to.equal("postal")
-		expect(lookup.latitude).to.equal("44.88888889");
-		expect(lookup.longitude).to.equal("-111.11111111");
-		expect(lookup.response.results).to.deep.equal([]);
-	});
-});

package/tests/us_reverse_geo/test_Response.js

@@ -1,44 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Response = require("../../src/us_reverse_geo/Response");
-
-describe("A US Reverse Geo match response", function () {
-	it("populates with the appropriate fields.", function () {
-		const sampleResponse = {
-			results: [
-				{
-					coordinate: {
-						latitude: 1.1,
-						longitude: 2.2,
-						accuracy: "3",
-						license: 1
-					},
-					distance: 4.4,
-					address: {
-						street: "5",
-						city: "6",
-						state_abbreviation: "7",
-						zipcode: "8",
-						source: "postal"
-					}
-				},
-			]
-		};
-
-		const response = new Response(sampleResponse);
-		const result = response.results[0];
-
-		expect(result.distance).to.equal(4.4);
-		let address = result.address;
-		expect(address.street).to.equal("5");
-		expect(address.city).to.equal("6");
-		expect(address.state_abbreviation).to.equal("7");
-		expect(address.zipcode).to.equal("8");
-		expect(address.source).to.equal("postal");
-		let coordinate = result.coordinate;
-		expect(coordinate.latitude).to.equal(1.1);
-		expect(coordinate.longitude).to.equal(2.2);
-		expect(coordinate.accuracy).to.equal("3");
-		expect(coordinate.license).to.equal("SmartyStreets Proprietary");
-	});
-});

package/tests/us_street/test_Candidate.js

@@ -1,133 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Candidate = require("../../src/us_street/Candidate");
-
-describe("A match candidate", function () {
-	it("has populated fields.", function () {
-		const sampleResponse = {
-			input_index: 0,
-			candidate_index: 1,
-			addressee: "2",
-			delivery_line_1: "3",
-			delivery_line_2: "4",
-			last_line: "5",
-			delivery_point_barcode: "6",
-			smarty_key: "0000",
-			components: {
-				urbanization: "7",
-				primary_number: "8",
-				street_name: "9",
-				street_predirection: "10",
-				street_postdirection: "11",
-				street_suffix: "12",
-				secondary_number: "13",
-				secondary_designator: "14",
-				extra_secondary_number: "15",
-				extra_secondary_designator: "16",
-				pmb_designator: "17",
-				pmb_number: "18",
-				city_name: "19",
-				default_city_name: "20",
-				state_abbreviation: "21",
-				zipcode: "22",
-				plus4_code: "23",
-				delivery_point: "24",
-				delivery_point_check_digit: "25"
-			},
-			metadata: {
-				record_type: "26",
-				zip_type: "27",
-				county_fips: "28",
-				county_name: "29",
-				carrier_route: "30",
-				congressional_district: "31",
-				building_default_indicator: "32",
-				rdi: "33",
-				elot_sequence: "34",
-				elot_sort: "35",
-				latitude: 36.0,
-				longitude: 37.0,
-				coordinate_license: 1,
-				precision: "38",
-				time_zone: "39",
-				utc_offset: 40.0,
-				dst: "41",
-				ews_match: "47"
-			},
-			analysis: {
-				dpv_match_code: "42",
-				dpv_footnotes: "43",
-				dpv_cmra: "44",
-				dpv_vacant: "45",
-				active: "46",
-				footnotes: "48",
-				lacslink_code: "49",
-				lacslink_indicator: "50",
-				suitelink_match: "51",
-				dpv_no_stat: "52",
-				enhanced_match: "53",
-			}
-		};
-		const candidate = new Candidate(sampleResponse);
-
-		expect(candidate.inputIndex).to.equal(0);
-		expect(candidate.candidateIndex).to.equal(1);
-		expect(candidate.addressee).to.equal('2');
-		expect(candidate.deliveryLine1).to.equal('3');
-		expect(candidate.deliveryLine2).to.equal('4');
-		expect(candidate.lastLine).to.equal('5');
-		expect(candidate.deliveryPointBarcode).to.equal('6');
-		expect(candidate.smartyKey).to.equal('0000');
-
-		expect(candidate.components.urbanization).to.equal('7');
-		expect(candidate.components.primaryNumber).to.equal('8');
-		expect(candidate.components.streetName).to.equal('9');
-		expect(candidate.components.streetPredirection).to.equal('10');
-		expect(candidate.components.streetPostdirection).to.equal('11');
-		expect(candidate.components.streetSuffix).to.equal('12');
-		expect(candidate.components.secondaryNumber).to.equal('13');
-		expect(candidate.components.secondaryDesignator).to.equal('14');
-		expect(candidate.components.extraSecondaryNumber).to.equal('15');
-		expect(candidate.components.extraSecondaryDesignator).to.equal('16');
-		expect(candidate.components.pmbDesignator).to.equal('17');
-		expect(candidate.components.pmbNumber).to.equal('18');
-		expect(candidate.components.cityName).to.equal('19');
-		expect(candidate.components.defaultCityName).to.equal('20');
-		expect(candidate.components.state).to.equal('21');
-		expect(candidate.components.zipCode).to.equal('22');
-		expect(candidate.components.plus4Code).to.equal('23');
-		expect(candidate.components.deliveryPoint).to.equal('24');
-		expect(candidate.components.deliveryPointCheckDigit).to.equal('25');
-
-		expect(candidate.metadata.recordType).to.equal('26');
-		expect(candidate.metadata.zipType).to.equal('27');
-		expect(candidate.metadata.countyFips).to.equal('28');
-		expect(candidate.metadata.countyName).to.equal('29');
-		expect(candidate.metadata.carrierRoute).to.equal('30');
-		expect(candidate.metadata.congressionalDistrict).to.equal('31');
-		expect(candidate.metadata.buildingDefaultIndicator).to.equal('32');
-		expect(candidate.metadata.rdi).to.equal('33');
-		expect(candidate.metadata.elotSequence).to.equal('34');
-		expect(candidate.metadata.elotSort).to.equal('35');
-		expect(candidate.metadata.latitude).to.equal(36.0);
-		expect(candidate.metadata.longitude).to.equal(37.0);
-		expect(candidate.metadata.coordinateLicense).to.equal("SmartyStreets Proprietary");
-		expect(candidate.metadata.precision).to.equal('38');
-		expect(candidate.metadata.timeZone).to.equal('39');
-		expect(candidate.metadata.utcOffset).to.equal(40.0);
-		expect(candidate.metadata.obeysDst).to.equal('41');
-		expect(candidate.metadata.isEwsMatch).to.equal('47');
-
-		expect(candidate.analysis.dpvMatchCode).to.equal('42');
-		expect(candidate.analysis.dpvFootnotes).to.equal('43');
-		expect(candidate.analysis.cmra).to.equal('44');
-		expect(candidate.analysis.vacant).to.equal('45');
-		expect(candidate.analysis.active).to.equal('46');
-		expect(candidate.analysis.footnotes).to.equal('48');
-		expect(candidate.analysis.lacsLinkCode).to.equal('49');
-		expect(candidate.analysis.lacsLinkIndicator).to.equal('50');
-		expect(candidate.analysis.isSuiteLinkMatch).to.equal('51');
-		expect(candidate.analysis.noStat).to.equal('52');
-		expect(candidate.analysis.enhancedMatch).to.equal('53');
-	});
-});

package/tests/us_street/test_Client.js

@@ -1,150 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/us_street/Client");
-const ClientBuilder = require("../../src/ClientBuilder");
-const Lookup = require("../../src/us_street/Lookup");
-const Candidate = require("../../src/us_street/Candidate");
-const Batch = require("../../src/Batch");
-const errors = require("../../src/Errors");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-
-describe("A US Street client", function () {
-	it("calls its inner sender's send function.", function () {
-		const mockSender = {
-			send: function (request) {
-				sentFlag = true;
-				mockSenderRequest = request;
-			}
-		};
-		const client = new Client(mockSender);
-		let lookup = new Lookup();
-		let sentFlag = false;
-		let mockSenderRequest = {};
-
-		client.send(lookup);
-
-		expect(sentFlag).to.equal(true);
-	});
-
-	it("builds a request for a single lookup with the correct request parameters.", function () {
-		let mockSender = new MockSender();
-		const client = new Client(mockSender);
-		let lookup = new Lookup("1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12");
-		let expectedParameters = {
-			street: "1",
-			street2: "2",
-			secondary: "3",
-			city: "4",
-			state: "5",
-			zipcode: "6",
-			lastline: "7",
-			addressee: "8",
-			urbanization: "9",
-			match: "10",
-			candidates: "11",
-		};
-
-		client.send(lookup);
-
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("defaults maxCandidates to 5 when match type is enhanced.", function () {
-		let mockSender = new MockSender();
-		const client = new Client(mockSender);
-		let lookup = new Lookup();
-		lookup.match = "enhanced";
-		let expectedParameters = {
-			match: "enhanced",
-			candidates: 5,
-		};
-
-		client.send(lookup);
-
-		expect(mockSender.request.parameters).to.deep.equal(expectedParameters);
-	});
-
-	it("doesn't send an empty batch.", function () {
-		let mockSender = new MockSender();
-		const client = new Client(mockSender);
-		let batch = new Batch();
-
-		expect(() => client.send(batch)).to.throw(errors.BatchEmptyError);
-	});
-
-	it("attaches a match candidate from a response to a lookup.", function () {
-		const expectedMockPayload = [{delivery_line_1: "An address", input_index: 0}];
-		let mockSender = new MockSenderWithResponse(expectedMockPayload);
-		const client = new Client(mockSender);
-		let lookup = new Lookup();
-		let expectedResult = new Candidate({delivery_line_1: "An address", input_index: 0});
-
-		return client.send(lookup).then(response => {
-			expect(lookup.result[0]).to.deep.equal(expectedResult);
-		});
-	});
-
-	it("attaches match candidates to their corresponding lookups.", function () {
-		const expectedMockPayload = JSON.stringify([
-			{delivery_line_1: "Address 0", input_index: 0},
-			{delivery_line_1: "Alternate address 0", input_index: 0},
-			{delivery_line_1: "Address 1", input_index: 1},
-			{delivery_line_1: "Address 3", input_index: 3},
-		]);
-		let mockSender = new MockSenderWithResponse(expectedMockPayload);
-		let client = new Client(mockSender);
-		let lookup0 = new Lookup();
-		let lookup1 = new Lookup();
-		let lookup2 = new Lookup();
-		let lookup3 = new Lookup();
-		let batch = new Batch();
-
-		batch.add(lookup0);
-		batch.add(lookup1);
-		batch.add(lookup2);
-		batch.add(lookup3);
-
-		client.send(batch).then(response => {
-			expect(batch.getByIndex(0).result[0].deliveryLine1).to.equal("Address 0");
-			expect(batch.getByIndex(0).result[1].deliveryLine1).to.equal("Alternate address 0");
-			expect(batch.getByIndex(1).result[0].deliveryLine1).to.equal("Address 1");
-			expect(batch.getByIndex(2).result).to.deep.equal([]);
-			expect(batch.getByIndex(3).result[0].deliveryLine1).to.equal("Address 3");
-		});
-	});
-
-	it("rejects with an exception if the response comes back with an error.", function () {
-		const expectedMockError = new Error("Stamn! She's a tough one!");
-		let mockSender = new MockSenderWithResponse([], expectedMockError);
-		let client = new Client(mockSender);
-		let lookup = new Lookup();
-
-		return client.send(lookup).catch((e) => {expect(e).to.equal(expectedMockError);});
-	});
-
-	it("throws an exception if a lookup is undefined.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-
-		expect(() => client.send()).to.throw(errors.UndefinedLookupError);
-	});
-
-	it("attaches request parameters for batches with a single lookup and a request payload for batches with more than 1 lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let lookup1 = new Lookup("a");
-		let lookup2 = new Lookup("b");
-		let batch = new Batch();
-
-		batch.add(lookup1);
-		client.send(batch);
-
-		expect(mockSender.request.parameters).not.to.deep.equal({});
-
-		batch.add(lookup2);
-		client.send(batch);
-
-		expect(mockSender.request.payload).not.to.equal(undefined);
-	});
-});