smartystreets-javascript-sdk 5.2.0 → 6.1.0

package/tests/test_Batch.js

@@ -1,73 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const errors = require("../src/Errors");
-const Batch = require("../src/Batch");
-const Lookup = require("../src/us_street/Lookup");
-
-describe("A batch", function () {
-	let batch;
-
-	beforeEach(function () {
-		batch = new Batch();
-	});
-
-	it ("has a lookups field.", function () {
-		expect(batch.hasOwnProperty("lookups")).to.equal(true);
-		expect(Array.isArray(batch.lookups)).to.equal(true);
-	});
-
-	it ("can add a lookup to its array of lookups.", function () {
-		expect(batch.lookups.length).to.equal(0);
-		batch.add("Hi.");
-		expect(batch.lookups.length).to.equal(1);
-	});
-
-	it ("errors if you add a lookup when it's full.", function () {
-		for (let i = 0; i < 100; i++) {
-			let lookup = {};
-			batch.add(lookup);
-		}
-
-		expect(() => batch.add({})).to.throw(errors.BatchFullError);
-	});
-
-	it ("can be cleared.", function () {
-		batch.add("Hi.");
-		batch.clear();
-		expect(batch.lookups.length).to.equal(0);
-	});
-
-	it ("has a length.", function () {
-		expect(batch.length()).to.equal(0);
-		for (let i = 0; i < 50; i++) {
-			batch.add(i);
-		}
-		expect(batch.length()).to.equal(50);
-	});
-
-	it ("returns a lookup by index.", function () {
-		for (let i = 0; i < 100; i++) {
-			batch.add(i);
-		}
-
-		expect(batch.getByIndex(50)).to.equal(50);
-	});
-
-	it ("returns a lookup by input id.", function () {
-		for (let i = 0; i < 100; i++) {
-			let lookup = new Lookup();
-			lookup.inputId = i;
-			batch.add(lookup);
-		}
-
-		let expectedLookup = batch.getByIndex(50);
-
-		expect(batch.getByInputId(50)).to.deep.equal(expectedLookup);
-	});
-
-	it ("knows if it's empty.", function () {
-		expect(batch.isEmpty()).to.equal(true);
-		batch.add("1");
-		expect(batch.isEmpty()).to.equal(false);
-	});
-});

package/tests/test_CustomHeaderSender.js

@@ -1,31 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const CustomHeaderSender = require("../src/CustomHeaderSender");
-const Request = require("../src/Request");
-
-describe("A custom header sender", function () {
-	it ("adds custom headers to the request.", function () {
-		function MockSender () {
-			this.request;
-
-			this.send = (request) => {
-				this.request = request;
-			}
-		}
-
-		let mockSender = new MockSender();
-		let customHeaders = {
-			a: "1",
-			b: "2",
-		};
-		let customHeaderSender = new CustomHeaderSender(mockSender, customHeaders);
-		let request = new Request();
-
-		customHeaderSender.send(request);
-
-		expect(mockSender.request.headers.hasOwnProperty("a")).to.equal(true);
-		expect(mockSender.request.headers.a).to.equal("1");
-		expect(mockSender.request.headers.hasOwnProperty("b")).to.equal(true);
-		expect(mockSender.request.headers.b).to.equal("2");
-	});
-});

package/tests/test_ExtractExample.js

@@ -1,167 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const SmartySDK = require("../index");
-
-describe("Extract example test", () => {
-    const authId = "";
-    const authToken = "";
-    const SmartyCore = SmartySDK.core;
-    const credentials = new SmartyCore.StaticCredentials(authId, authToken);
-    const clientBuilder = new SmartyCore.ClientBuilder(credentials);
-    clientBuilder.withBaseUrl("https://us-extract.api.hobbes.smartyops.net");
-
-    const usExtractClient = clientBuilder.buildUsExtractClient();
-
-    it("Check multi-line test", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-        1476 Sandhill Rd, Orem, UT asdlfkjasldfkja sldfj 350 E University Pkwy, Orem, UT 84058 asldfkjasldfj asldkfjasldfj
-        417 W 1300 S, Orem, UT asdlfkjasldfkjal skdjf alskdjf 309 E University Pkwy, Orem, UT 84058
-        `);
-
-            lookup.addressesHaveLineBreaks = true;
-            lookup.addressesPerLine = 1;
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(2);
-            expect(result.result.meta.verifiedCount).to.equal(2);
-
-        }
-    });
-
-    it("Check HTML test", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-HTML is automatically detected and, if found, ignored. You can override this behavior with API calls by manually setting the 'html' parameter to true or false.
-
-For input with <b>HTML code</code> like this, addresses will be scraped from outside the tags. The HTML should be properly formatted, valid HTML.<br><br>
-
-7584<span class='street-name'>Big Canyon</span> Anaheim Hills, CA <span class='zip-code'>92808</span><br><br>
-
-You can force HTML mode if auto-detect doesn't work properly.
-            `);
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(1);
-        }
-    });
-
-    it("Check addresses with line breaks", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-This address is valid:
-
-1109 Ninth 85007
-
-but this one is not:
-
-3777 Las Vegas Blvd
-Las Vegas, Nevada
-
-However, this nearby location is valid, despite the poor spelling:
-
-3785 Las Vegs Av.
-Los Vegas, Nevada
-            `);
-
-            lookup.addressesHaveLineBreaks = true;
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(3);
-            expect(result.result.meta.verifiedCount).to.equal(2);
-        }
-    });
-
-    it("Check addresses needing aggressive mode", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-With aggressive mode on, popular US cities may be matched if no state or ZIP code can be found.
-
-This means addresses like 5455 North 250 West, Provo, can be found even though it doesn't have anything looking like a state or ZIP code following it.
-            `);
-
-            lookup.aggressive = true;
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(1);
-            expect(result.result.meta.verifiedCount).to.equal(1);
-        }
-    });
-
-    it("Check addresses in URLs", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-Smarty can handle addresses in URLs, as long as there are no spaces in them or they are surrounded by quotes.
-
-Address in one parameter: https://maps.google.com/?q=1+Rosedale+St+Baltimore+MD&ie=UTF8
-or,
-same URL with spaces surrounded by quotes: "https://maps.google.com/?q=1 Rosedale St Baltimore MD&ie=UTF8"
-...
-
-Address across multiple parameters: https://example.com/?street=4004%20Grant%20St%20&state=WA&zipcode=98660&city=Vancouver
-We can find them either way.
-            `);
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(3);
-            expect(result.result.meta.verifiedCount).to.equal(3);
-        }
-    });
-
-    it("Check address with unicode character", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-This address has a Unicode character in it (the special í in María): 123 María Lane Tempe, AZ, 85284
-
-Addresses with Unicode can still be found and verified.
-            `);
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(1);
-            expect(result.result.meta.verifiedCount).to.equal(1);
-        }
-    });
-
-    it("Check more addresses needing aggressive mode", async () => {
-        if (!(authId && authToken)) {
-            expect("bypass").to.equal("bypass");
-        } else {
-            const lookup = new SmartySDK.usExtract.Lookup(`
-Try this one with and without aggressive mode. The '10379' looks like a ZIP code but is actually a primary number:
-
-8465 Park Meadows Center Drive
-Lone Tree, CO
-303-799-3400
-
-10379 South State Street
-Sandy, UT 84070
-801-432-5100
-
-This input has two addresses and only one is found without aggressive mode.
-            `);
-
-            const result = await usExtractClient.send(lookup);
-
-            expect(result.result.meta.addressCount).to.equal(1);
-            expect(result.result.meta.verifiedCount).to.equal(1);
-        }
-    });
-});

package/tests/test_HttpSender.js

@@ -1,93 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Request = require("../src/Request");
-const HttpSender = require("../src/HttpSender");
-const {buildSmartyResponse} = require("../src/util/buildSmartyResponse");
-
-describe ("An Axios implementation of a HTTP sender", function () {
-	it("adds a data payload to the HTTP request config.", function () {
-		let expectedPayload = "test payload";
-		let request = new Request(expectedPayload);
-		let sender = new HttpSender();
-		let requestConfig = sender.buildRequestConfig(request);
-
-		expect(requestConfig.hasOwnProperty("data")).to.equal(true);
-		expect(requestConfig.data).to.equal(expectedPayload);
-	});
-
-	it ("adds a POST method to the HTTP request config when appropriate.", function () {
-		let request = new Request("test payload");
-		let sender = new HttpSender();
-		let requestConfig = sender.buildRequestConfig(request);
-
-		expect(requestConfig.hasOwnProperty("method")).to.equal(true);
-		expect(requestConfig.method).to.equal("POST");
-	});
-
-	it ("adds a GET method to the HTTP request config when appropriate.", function () {
-		let request = new Request();
-		let sender = new HttpSender();
-		let requestConfig = sender.buildRequestConfig(request);
-
-		expect(requestConfig.hasOwnProperty("method")).to.equal(true);
-		expect(requestConfig.method).to.equal("GET");
-	});
-
-	it ("add a timeout to the HTTP request config.", function () {
-		let request = new Request("test payload");
-		let sender = new HttpSender();
-		let requestConfig = sender.buildRequestConfig(request);
-
-		let customTimeoutSender = new HttpSender(5);
-		let customTimeoutRequestConfig = customTimeoutSender.buildRequestConfig(request);
-
-		expect(requestConfig.hasOwnProperty("timeout")).to.equal(true);
-		expect(requestConfig.timeout).to.equal(10000);
-
-		expect(customTimeoutRequestConfig.timeout).to.equal(5);
-	});
-
-	it ("adds parameters to the HTTP request config.", function () {
-		let request = new Request("");
-		let sender = new HttpSender();
-		request.parameters.test = "1";
-		let requestConfig = sender.buildRequestConfig(request);
-
-		expect(requestConfig.hasOwnProperty("params")).to.equal(true);
-		expect(requestConfig.params).to.deep.equal(request.parameters);
-	});
-
-	it ("adds headers to the HTTP request config.", function () {
-		let request = new Request("");
-		let sender = new HttpSender();
-		let requestConfig = sender.buildRequestConfig(request);
-		let version = require("../package.json").version;
-
-		expect(requestConfig.hasOwnProperty("headers")).to.equal(true);
-		expect(requestConfig.headers["Content-Type"]).to.equal("application/json; charset=utf-8");
-	});
-
-	it ("has a response with the right status code.", function () {
-		let sender = new HttpSender();
-		let mockResponse = {
-			status: 200
-		};
-		let smartyResponse = buildSmartyResponse(mockResponse);
-
-		expect(smartyResponse.hasOwnProperty("statusCode")).to.equal(true);
-		expect(smartyResponse.statusCode).to.equal(200);
-	});
-
-	it ("has a response with a payload.", function () {
-		let sender = new HttpSender();
-		let mockData = [1, 2, 3];
-		let mockResponse = {
-			status: 200,
-			data: mockData
-		};
-		let smartyResponse = buildSmartyResponse(mockResponse);
-
-		expect(smartyResponse.hasOwnProperty("payload")).to.equal(true);
-		expect(smartyResponse.payload).to.equal(mockData);
-	});
-});

package/tests/test_LicenseSender.js

@@ -1,40 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const LicenseSender = require("../src/LicenseSender");
-const Request = require("../src/Request");
-
-describe("A license sender", function () {
-	let innerSender;
-	let request;
-	let licenses;
-	let licenseSender;
-
-	beforeEach(() => {
-		innerSender = {
-			send: () => true
-		};
-		request = new Request();
-	});
-
-	it("appends licenses to parameters.", function () {
-		licenses = ["0", "1", "2"];
-		licenseSender = new LicenseSender(innerSender, licenses);
-		licenseSender.send(request);
-
-		expect(request.parameters).contains({"license": "0,1,2"});
-	});
-
-	it("doesn't append license to query if array is empty.", function () {
-		licenses = [];
-		licenseSender = new LicenseSender(innerSender, licenses);
-		licenseSender.send(request);
-		
-		expect(request.parameters).to.not.have.property("license");
-	});
-
-	it("returns a promise.", function () {
-		licenses = [];
-		licenseSender = new LicenseSender(innerSender, licenses);
-		expect(licenseSender.send(request) instanceof Promise).to.equal(true);
-	});
-});

package/tests/test_RetrySender.js

@@ -1,98 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const RetrySender = require("../src/RetrySender");
-const {MockSenderWithStatusCodesAndHeaders} = require("./fixtures/mock_senders");
-const Request = require("../src/Request.js");
-const MockSleeper = require("./fixtures/MockSleeper.js");
-
-async function sendWithRetry(retries, inner, sleeper) {
-	const request = new Request();
-	const sender = new RetrySender(retries, inner, sleeper);
-	return await sender.send(request);
-}
-
-describe ("Retry Sender tests", function () {
-	it("test success does not retry", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["200"]);
-		await sendWithRetry(5, inner, new MockSleeper());
-
-		expect(inner.currentStatusCodeIndex).to.equal(1);
-	});
-
-	it("test client error does not retry", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["422"]);
-		await sendWithRetry(5, inner, new MockSleeper());
-
-		expect(inner.currentStatusCodeIndex).to.equal(1);
-	});
-
-	it("test will retry until success", async function () {
-		let inner =  new MockSenderWithStatusCodesAndHeaders(["500", "500", "500", "200", "500"]);
-		await sendWithRetry(10, inner, new MockSleeper());
-
-		expect(inner.currentStatusCodeIndex).to.equal(4);
-	});
-
-	it("test return response if retry limit exceeded", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["500", "500", "500", "500", "500"]);
-		const sleeper = new MockSleeper();
-		const response = await sendWithRetry(4, inner, sleeper);
-
-		expect(response);
-		expect(inner.currentStatusCodeIndex).to.equal(5);
-		expect(response.statusCode).to.equal("500");
-		expect(sleeper.sleepDurations).to.deep.equal([0, 1, 2, 3]);
-	});
-
-	it("test backoff does not exceed max", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["500", "500", "500", "500", "500", "500", "500", "500", "500", "500", "500", "500", "500", "200"]);
-		const sleeper = new MockSleeper();
-
-		await sendWithRetry(20, inner, sleeper);
-
-		expect(sleeper.sleepDurations).to.deep.equal([0,1,2,3,4,5,6,7,8,9,10,10,10]);
-	});
-
-	it("test empty status does not retry", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders([]);
-		await sendWithRetry(5, inner, new MockSleeper());
-
-		expect(inner.currentStatusCodeIndex).to.equal(1);
-	});
-
-	it("test sleep on rate limit", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["429", "200"]);
-		const sleeper = new MockSleeper();
-
-		await sendWithRetry(5, inner, sleeper);
-
-		expect(sleeper.sleepDurations).to.deep.equal([10]);
-	});
-
-	it("test rate limit error return", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["429"], {"Retry-After": 7});
-		const sleeper = new MockSleeper();
-
-		await sendWithRetry(10, inner, sleeper);
-
-		expect(sleeper.sleepDurations).to.deep.equal([7]);
-	});
-
-	it("test retry after invalid value", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["429"], {"Retry-After": "a"});
-		const sleeper = new MockSleeper();
-
-		await sendWithRetry(10, inner, sleeper);
-
-		expect(sleeper.sleepDurations).to.deep.equal([10]);
-	});
-
-	it("test retry error", async function () {
-		let inner = new MockSenderWithStatusCodesAndHeaders(["429"], undefined, "Big Bad");
-		const sleeper = new MockSleeper();
-
-		const response = await sendWithRetry(10, inner, sleeper);
-
-		expect(response.error).to.equal("Big Bad");
-	});
-});

package/tests/test_SigningSender.js

@@ -1,56 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Request = require("../src/Request");
-const SigningSender = require("../src/SigningSender");
-const StaticCredentials = require("../src/StaticCredentials");
-const SharedCredentials = require("../src/SharedCredentials");
-const Errors = require("../src/Errors");
-
-describe("A signing sender", function () {
-	let mockAuthId = "testId";
-	let mockAuthToken = "testToken";
-	let mockHostName = "testHostName";
-	let mockSender = {
-		send: request => new Promise()
-	};
-	let request;
-
-	beforeEach(function () {
-		request = new Request();
-	});
-
-	it("signs a request with static credentials.", function () {
-		let staticCredentials = new StaticCredentials(mockAuthId, mockAuthToken);
-		let signingSender = new SigningSender(mockSender, staticCredentials);
-
-		signingSender.send(request);
-
-		expect(request.parameters.hasOwnProperty("auth-id")).to.equal(true);
-		expect(request.parameters["auth-id"]).to.equal(mockAuthId);
-		expect(request.parameters.hasOwnProperty("auth-token")).to.equal(true);
-		expect(request.parameters["auth-token"]).to.equal(mockAuthToken);
-	});
-
-	it("signs a request with shared credentials.", function () {
-		let sharedCredentials = new SharedCredentials(mockAuthId, mockHostName);
-		let signingSender = new SigningSender(mockSender, sharedCredentials);
-
-		signingSender.send(request);
-
-		expect(request.parameters.hasOwnProperty("key")).to.equal(true);
-		expect(request.parameters["key"]).to.equal(mockAuthId);
-		expect(request.headers.hasOwnProperty("Referer")).to.equal(true);
-		expect(request.headers["Referer"]).to.equal("https://" + mockHostName);
-	});
-
-	it("errors if signing a POST request with shared credentials.", function () {
-		let sharedCredentials = new SharedCredentials(mockAuthId, mockHostName);
-		let signingSender = new SigningSender(mockSender, sharedCredentials);
-		let mockRequestPayload = {
-			foo: "bar",
-		};
-		request.payload = mockRequestPayload;
-
-		expect(() => signingSender.send(request)).to.throw(Errors.UnprocessableEntityError);
-	});
-});

package/tests/test_StatusCodeSender.js

@@ -1,95 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const StatusCodeSender = require("../src/StatusCodeSender");
-const Response = require("../src/Response");
-const Request = require("../src/Request");
-const errors = require("../src/Errors");
-
-describe("A status code sender", function () {
-	it("doesn't attach an error on a 200.", function () {
-		let mockSender = {
-			send: () => {
-				return new Promise((resolve, reject) => {
-					resolve(new Response(200));
-				});
-			}
-		};
-
-		let statusCodeSender = new StatusCodeSender(mockSender);
-		let request = new Request();
-
-		return statusCodeSender.send(request).then(response => {
-			expect(response.error === undefined).to.equal(true);
-		});
-	});
-
-	it("gives a custom message for 400", function () {
-		const payload = {
-			errors: [
-				{message: "custom message"}
-			]
-		};
-		return expectedErrorWithPayloadMessage(400, payload);
-	})
-
-	it("returns an error message if payload is undefined", function () {
-		return expectedDefaultError()
-	})
-
-	it("gives an Internal Server Error on a 500.", function () {
-		return expectedErrorForStatusCode(errors.InternalServerError, 500);
-	});
-
-	it("gives an Service Unavailable error on a 503.", function () {
-		return expectedErrorForStatusCode(errors.ServiceUnavailableError, 503);
-	});
-
-	it("gives an Gateway Timeout error on a 504.", function () {
-		return expectedErrorForStatusCode(errors.GatewayTimeoutError, 504);
-	});
-});
-
-const expectedErrorWithPayloadMessage = (errorCode, payload) => {
-	let mockSender = generateMockSender(errorCode, payload);
-	let statusCodeSender = new StatusCodeSender(mockSender);
-	let request = new Request();
-
-	return statusCodeSender.send(request).then(() => {
-	}, error => {
-		expect(error.error).to.be.an.instanceOf(errors.DefaultError);
-		expect(error.error.message).to.be.equal(payload.errors[0].message);
-	})
-}
-
-const expectedDefaultError = () => {
-	let mockSender = generateMockSender(400);
-	let statusCodeSender = new StatusCodeSender(mockSender);
-	let request = new Request();
-
-	return statusCodeSender.send(request).then(() => {
-	}, error => {
-		expect(error.error).to.be.an.instanceOf(errors.DefaultError);
-		expect(error.error.message).to.be.equal("unexpected error");
-	})
-}
-
-function expectedErrorForStatusCode(expectedError, errorCode) {
-	let mockSender = generateMockSender(errorCode);
-	let statusCodeSender = new StatusCodeSender(mockSender);
-	let request = new Request();
-
-	return statusCodeSender.send(request).then(() => {
-	}, error => {
-		expect(error.error).to.be.an.instanceOf(expectedError);
-	})
-}
-
-function generateMockSender(errorCode, payload) {
-	return {
-		send: () => {
-			return new Promise((resolve, reject) => {
-				reject(new Response(errorCode, payload))
-			});
-		}
-	};
-}