smartystreets-javascript-sdk 2.2.1 → 3.1.0

package/Makefile

@@ -1,6 +1,6 @@
 #!/usr/bin/make -f
 
-VERSION           := $(shell tagit -p --dry-run)
+VERSION           := $(shell tagit -m --dry-run)
 VERSION_FILE1     := package.json
 VERSION_FILE2     := package-lock.json
 
@@ -11,7 +11,7 @@ node_modules:
 	npm install
 
 publish: test version upload unversion
-	tagit -p
+	tagit -m
 	git push origin --tags
 
 upload:

package/examples/us_autocomplete_pro.js

@@ -3,13 +3,13 @@ const SmartyCore = SmartySDK.core;
 const Lookup = SmartySDK.usAutocompletePro.Lookup;
 
 // for Server-to-server requests, use this code:
-let authId = "f0fd813a-2c37-2afe-a322-1a46794d6c91";
-let authToken = "sPDMxTLaMh8BCp6YWSNW";
-const credentials = new SmartyCore.StaticCredentials(authId, authToken);
+// let authId = process.env.SMARTY_AUTH_ID;
+// let authToken = process.env.SMARTY_AUTH_TOKEN;
+// const credentials = new SmartyCore.StaticCredentials(authId, authToken);
 
 // for client-side requests (browser/mobile), use this code:
-// let key = process.env.SMARTY_EMBEDDED_KEY;
-// const credentials = new SmartyCore.SharedCredentials(key);
+let key = process.env.SMARTY_EMBEDDED_KEY;
+const credentials = new SmartyCore.SharedCredentials(key);
 
 // The appropriate license values to be used for your subscriptions
 // can be found on the Subscription page of the account dashboard.
@@ -23,11 +23,26 @@ let client = clientBuilder.buildUsAutocompleteProClient();
 
 // *** Simple Lookup ***
 let lookup = new Lookup("4770 Lincoln");
-lookup.excludeStates = ["CA"];
 
-(async () => {
-	await handleRequest(lookup, "Simple Lookup");
-})()
+await handleRequest(lookup, "Simple Lookup");
+
+// *** Using Filter and Prefer ***
+lookup = new Lookup("4770 Lincoln");
+
+lookup.maxResults = 10;
+lookup.includeOnlyCities = ["Chicago,La Grange,IL", "Blaine,WA"];
+lookup.preferStates = ["IL"];
+lookup.preferRatio = 33;
+lookup.source = "all";
+
+await handleRequest(lookup, "Using Filter and Prefer");
+
+// *** Using 'selected' to Expand Secondaries ***
+lookup = new Lookup("4770 Lincoln");
+
+lookup.selected = "4770 N Lincoln Ave Ste 2 (3) Chicago, IL 60625";
+
+await handleRequest(lookup, "Using 'selected' to Expand Secondaries")
 
 // ************************************************
 

package/package.json

@@ -1,6 +1,6 @@
 {
  "name": "smartystreets-javascript-sdk",
- "version": "2.2.1",
+ "version": "3.1.0",
  "description": "Quick and easy Smarty address validation.",
  "keywords": [
   "smarty",

package/src/Errors.js

@@ -1,7 +1,14 @@
 class SmartyError extends Error {
+	constructor(message = "unexpected error") {
+		super(message);
+	}
+}
+
+class DefaultError extends SmartyError {
 	constructor(message) {
 		super(message);
 	}
+
 }
 
 class BatchFullError extends SmartyError {
@@ -88,5 +95,6 @@ module.exports = {
 	TooManyRequestsError: TooManyRequestsError,
 	InternalServerError: InternalServerError,
 	ServiceUnavailableError: ServiceUnavailableError,
-	GatewayTimeoutError: GatewayTimeoutError
+	GatewayTimeoutError: GatewayTimeoutError,
+	DefaultError: DefaultError
 };

package/src/StatusCodeSender.js

@@ -11,30 +11,6 @@ class StatusCodeSender {
 				.then(resolve)
 				.catch(error => {
 					switch (error.statusCode) {
-						case 400:
-							error.error = new Errors.BadRequestError();
-							break;
-
-						case 401:
-							error.error = new Errors.BadCredentialsError();
-							break;
-
-						case 402:
-							error.error = new Errors.PaymentRequiredError();
-							break;
-
-						case 413:
-							error.error = new Errors.RequestEntityTooLargeError();
-							break;
-
-						case 422:
-							error.error = new Errors.UnprocessableEntityError("GET request lacked required fields.");
-							break;
-
-						case 429:
-							error.error = new Errors.TooManyRequestsError();
-							break;
-
 						case 500:
 							error.error = new Errors.InternalServerError();
 							break;
@@ -46,8 +22,10 @@ class StatusCodeSender {
 						case 504:
 							error.error = new Errors.GatewayTimeoutError();
 							break;
-					}
 
+						default:
+							error.error = new Errors.DefaultError(error && error.payload && error.payload.errors[0] && error.payload.errors[0].message);
+					}
 					reject(error);
 				});
 		});

package/src/us_street/Candidate.js

@@ -14,6 +14,7 @@ class Candidate {
 		this.deliveryLine2 = responseData.delivery_line_2;
 		this.lastLine = responseData.last_line;
 		this.deliveryPointBarcode = responseData.delivery_point_barcode;
+		this.smartyKey = responseData.smarty_key;
 
 		this.components = {};
 		if (responseData.components !== undefined) {

package/tests/test_StatusCodeSender.js

@@ -23,35 +23,24 @@ describe("A status code sender", function () {
 		});
 	});
 
-	it("gives a Bad Credentials error on a 401.", function () {
-		return expectedErrorForStatusCode(errors.BadCredentialsError, 401);
-	});
-
-	it("gives a Payment Required error on a 402.", function () {
-		return expectedErrorForStatusCode(errors.PaymentRequiredError, 402);
-	});
-
-	it("gives a Request Entity Too Large error on a 413.", function () {
-		return expectedErrorForStatusCode(errors.RequestEntityTooLargeError, 413);
-	});
-
-	it("gives a Bad Request error on a 400.", function () {
-		return expectedErrorForStatusCode(errors.BadRequestError, 400);
-	});
-
-	it("gives an Unprocessable Entity error on a 422.", function () {
-		return expectedErrorForStatusCode(errors.UnprocessableEntityError, 422);
-	});
+	it("gives a custom message for 400", function () {
+		const payload = {
+			errors: [
+				{message: "custom message"}
+			]
+		};
+		return expectedErrorWithPayloadMessage(400, payload);
+	})
 
-	it("gives a Too Many Requests error on a 429.", function () {
-		return expectedErrorForStatusCode(errors.TooManyRequestsError, 429);
-	});
+	it("returns an error message if payload is undefined", function () {
+		return expectedDefaultError()
+	})
 
-	it("gives an Internal Server Error error on a 500.", function () {
+	it("gives an Internal Server Error on a 500.", function () {
 		return expectedErrorForStatusCode(errors.InternalServerError, 500);
 	});
 
-	it("gives an Service Unvailable error on a 503.", function () {
+	it("gives an Service Unavailable error on a 503.", function () {
 		return expectedErrorForStatusCode(errors.ServiceUnavailableError, 503);
 	});
 
@@ -60,22 +49,46 @@ describe("A status code sender", function () {
 	});
 });
 
+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(response => {
+	return statusCodeSender.send(request).then(() => {
 	}, error => {
 		expect(error.error).to.be.an.instanceOf(expectedError);
 	})
 }
 
-function generateMockSender(errorCode) {
+function generateMockSender(errorCode, payload) {
 	return {
 		send: () => {
 			return new Promise((resolve, reject) => {
-				reject(new Response(errorCode))
+				reject(new Response(errorCode, payload))
 			});
 		}
 	};

package/tests/us_street/test_Candidate.js

@@ -12,6 +12,7 @@ describe("A match candidate", function () {
 			delivery_line_2: "4",
 			last_line: "5",
 			delivery_point_barcode: "6",
+			smarty_key: "0000",
 			components: {
 				urbanization: "7",
 				primary_number: "8",
@@ -76,6 +77,7 @@ describe("A match candidate", function () {
 		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');