smartystreets-javascript-sdk 4.0.1 → 5.0.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/index.js

@@ -15,10 +15,6 @@ module.exports = {
 		Lookup: require("./src/us_zipcode/Lookup"),
 		Result: require("./src/us_zipcode/Result"),
 	},
-	usAutocomplete: {
-		Lookup: require("./src/us_autocomplete/Lookup"),
-		Suggestion: require("./src/us_autocomplete/Suggestion"),
-	},
 	usAutocompletePro: {
 		Lookup: require("./src/us_autocomplete_pro/Lookup"),
 		Suggestion: require("./src/us_autocomplete_pro/Suggestion"),

package/package.json

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

package/src/ClientBuilder.js

@@ -14,7 +14,6 @@ const Sleeper = require("./util/Sleeper.js");
 //TODO: refactor this to work more cleanly with a bundler.
 const UsStreetClient = require("./us_street/Client");
 const UsZipcodeClient = require("./us_zipcode/Client");
-const UsAutocompleteClient = require("./us_autocomplete/Client");
 const UsAutocompleteProClient = require("./us_autocomplete_pro/Client");
 const UsExtractClient = require("./us_extract/Client");
 const InternationalStreetClient = require("./international_street/Client");
@@ -22,7 +21,6 @@ const UsReverseGeoClient = require("./us_reverse_geo/Client");
 const InternationalAddressAutocompleteClient = require("./international_address_autocomplete/Client");
 
 const INTERNATIONAL_STREET_API_URI = "https://international-street.api.smarty.com/verify";
-const US_AUTOCOMPLETE_API_URL = "https://us-autocomplete.api.smarty.com/suggest";
 const US_AUTOCOMPLETE_PRO_API_URL = "https://us-autocomplete-pro.api.smarty.com/lookup";
 const US_EXTRACT_API_URL = "https://us-extract.api.smarty.com/";
 const US_STREET_API_URL = "https://us-street.api.smarty.com/street-address";
@@ -184,10 +182,6 @@ class ClientBuilder {
 		return this.buildClient(US_ZIP_CODE_API_URL, UsZipcodeClient);
 	}
 
-	buildUsAutocompleteClient() { // Deprecated
-		return this.buildClient(US_AUTOCOMPLETE_API_URL, UsAutocompleteClient);
-	}
-
 	buildUsAutocompleteProClient() {
 		return this.buildClient(US_AUTOCOMPLETE_PRO_API_URL, UsAutocompleteProClient);
 	}

package/src/HttpSender.js

@@ -1,4 +1,4 @@
-const Axios = require("axios");
+const Axios = require("axios").default;
 const {buildSmartyResponse} = require("../src/util/buildSmartyResponse");
 
 class HttpSender {

package/src/util/buildClients.js

@@ -8,10 +8,6 @@ function buildUsStreetApiClient(credentials) {
 	return instantiateClientBuilder(credentials).buildUsStreetApiClient();
 }
 
-function buildUsAutocompleteApiClient(credentials) {
-	return instantiateClientBuilder(credentials).buildUsAutocompleteClient();
-}
-
 function buildUsAutocompleteProApiClient(credentials) {
 	return instantiateClientBuilder(credentials).buildUsAutocompleteProClient();
 }
@@ -38,7 +34,6 @@ function buildInternationalAddressAutocompleteApiClient(credentials) {
 
 module.exports = {
 	usStreet: buildUsStreetApiClient,
-	usAutocomplete: buildUsAutocompleteApiClient,
 	usAutocompletePro: buildUsAutocompleteProApiClient,
 	usExtract: buildUsExtractApiClient,
 	usZipcode: buildUsZipcodeApiClient,

package/src/us_autocomplete/Client.js

@@ -1,56 +0,0 @@
-const Errors = require("../Errors");
-const Request = require("../Request");
-const Suggestion = require("./Suggestion");
-
-/**
- * This client sends lookups to the Smarty US Autocomplete API, <br>
- *     and attaches the results to the appropriate Lookup objects.
- */
-class Client {
-	constructor(sender) {
-		this.sender = sender;
-	}
-
-	send(lookup) {
-		if (typeof lookup === "undefined") throw new Errors.UndefinedLookupError();
-
-		let request = new Request();
-		request.parameters = buildRequestParameters(lookup);
-
-		return new Promise((resolve, reject) => {
-			this.sender.send(request)
-				.then(response => {
-					if (response.error) reject(response.error);
-
-					lookup.result = buildSuggestionsFromResponse(response.payload);
-					resolve(lookup);
-				})
-				.catch(reject);
-		});
-
-		function buildRequestParameters(lookup) {
-			return {
-				prefix: lookup.prefix,
-				suggestions: lookup.maxSuggestions,
-				city_filter: joinFieldWith(lookup.cityFilter, ","),
-				state_filter: joinFieldWith(lookup.stateFilter, ","),
-				prefer: joinFieldWith(lookup.prefer, ";"),
-				prefer_ratio: lookup.preferRatio,
-				geolocate: lookup.geolocate,
-				geolocate_precision: lookup.geolocatePrecision,
-			};
-
-			function joinFieldWith(field, delimiter) {
-				if (field.length) return field.join(delimiter);
-			}
-		}
-
-		function buildSuggestionsFromResponse(payload) {
-			if (payload.suggestions === null) return [];
-
-			return payload.suggestions.map(suggestion => new Suggestion(suggestion));
-		}
-	}
-}
-
-module.exports = Client;

package/src/us_autocomplete/Lookup.js

@@ -1,24 +0,0 @@
-/**
- * In addition to holding all of the input data for this lookup, this class also<br>
- *     will contain the result of the lookup after it comes back from the API.
- *     @see "https://www.smarty.com/docs/cloud/us-autocomplete-api#http-request-input-fields"
- */
-class Lookup {
-	/**
-	 * @param prefix The beginning of an address. This is required to be set.
-	 */
-	constructor(prefix) {
-		this.result = [];
-
-		this.prefix = prefix;
-		this.maxSuggestions = undefined;
-		this.cityFilter = [];
-		this.stateFilter = [];
-		this.prefer = [];
-		this.preferRatio = undefined;
-		this.geolocate = undefined;
-		this.geolocatePrecision = undefined;
-	}
-}
-
-module.exports = Lookup;

package/src/us_autocomplete/Suggestion.js

@@ -1,13 +0,0 @@
-/**
- * @see "https://www.smarty.com/docs/cloud/us-autocomplete-api#http-response"
- */
-class Suggestion {
-	constructor(responseData) {
-		this.text = responseData.text;
-		this.streetLine = responseData.street_line;
-		this.city = responseData.city;
-		this.state = responseData.state;
-	}
-}
-
-module.exports = Suggestion;

package/tests/us_autocomplete/test_Client.js

@@ -1,105 +0,0 @@
-const chai = require("chai");
-const expect = chai.expect;
-const Client = require("../../src/us_autocomplete/Client");
-const Lookup = require("../../src/us_autocomplete/Lookup");
-const Suggestion = require("../../src/us_autocomplete/Suggestion");
-const errors = require("../../src/Errors");
-const MockSender = require("../fixtures/mock_senders").MockSender;
-const MockSenderWithResponse = require("../fixtures/mock_senders").MockSenderWithResponse;
-
-describe("A US Autocomplete Client", function () {
-	it("correctly builds parameters for a prefix only lookup.", function () {
-		let mockSender = new MockSender();
-		let client = new Client(mockSender);
-		let prefix = '(>")>#';
-		let lookup = new Lookup(prefix);
-		let expectedParameters = {
-			prefix: prefix,
-			suggestions: undefined,
-			city_filter: undefined,
-			state_filter: undefined,
-			prefer: undefined,
-			prefer_ratio: undefined,
-			geolocate: undefined,
-			geolocate_precision: undefined,
-		};
-
-		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.prefix = "1";
-		lookup.maxSuggestions = "2";
-		lookup.cityFilter.push("a");
-		lookup.cityFilter.push("b");
-		lookup.stateFilter = ["c", "d"];
-		lookup.prefer = ["e", "f", "g"];
-		lookup.preferRatio = "5";
-		lookup.geolocate = "6";
-		lookup.geolocatePrecision = "7";
-
-		let expectedParameters = {
-			prefix: "1",
-			suggestions: "2",
-			city_filter: "a,b",
-			state_filter: "c,d",
-			prefer: "e;f;g",
-			prefer_ratio: "5",
-			geolocate: "6",
-			geolocate_precision: "7",
-		};
-
-		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 = {
-			text: "a",
-			street_line: "b",
-			city: "c",
-			state: "d",
-		};
-		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/test_Lookup.js

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

package/tests/us_autocomplete/test_Suggestion.js

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