Merge pull request #17 from ideal-postcodes/3.0.7

3.0.7

Author: cblanc

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [3.0.7] 2018-03-14
+- Fix: Custom API endpoint can be passed to setup configuration object
+- Fix: Class Methods `lookupPostcode`, `lookupAddress` and `checkKey` accept custom endpoint
+- Reduce library size. Commented out optional configuration attributes which currently serve as documentation. Will be removed altogether in final minified payload
+
 ## [3.0.6] 2017-11-02
 - Fix: Sublicensee key now passed into key checking API calls if `check_key: true`
 

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "jquery.postcodes",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "authors": [
     "support@ideal-postcodes.co.uk"
   ],

dist/postcodes.js

@@ -1,6 +1,6 @@
-/*! Ideal Postcodes jQuery Plugin - v3.0.6 - 2017-11-17
+/*! Ideal Postcodes jQuery Plugin - v3.0.7 - 2018-03-14
 * https://github.com/ideal-postcodes/jquery.postcodes
-2017 Ideal Postcodes; Licensed MIT */
+2018 Ideal Postcodes; Licensed MIT */
 (function($) {
   "use strict";
   // Cache for all new instances of the plugin
@@ -23,23 +23,23 @@
       line_2: "#line_2",
       line_3: "#line_3",
       post_town: "#post_town",
-      postcode: "#postcode",
-      postcode_inward: undefined,
-      postcode_outward: undefined,
-      udprn: undefined,
-      dependant_locality: undefined,
-      double_dependant_locality: undefined,
-      thoroughfare: undefined,
-      dependant_thoroughfare: undefined,
-      building_number: undefined,
-      building_name: undefined,
-      sub_building_name: undefined,
-      po_box: undefined,
-      department_name: undefined,
-      organisation_name: undefined,
-      postcode_type: undefined,
-      su_organisation_indicator: undefined,
-      delivery_point_suffix: undefined
+      postcode: "#postcode"
+      // postcode_inward: undefined,
+      // postcode_outward: undefined,
+      // udprn: undefined,
+      // dependant_locality: undefined,
+      // double_dependant_locality: undefined,
+      // thoroughfare: undefined,
+      // dependant_thoroughfare: undefined,
+      // building_number: undefined,
+      // building_name: undefined,
+      // sub_building_name: undefined,
+      // po_box: undefined,
+      // department_name: undefined,
+      // organisation_name: undefined,
+      // postcode_type: undefined,
+      // su_organisation_indicator: undefined,
+      // delivery_point_suffix: undefined
     },
 
     /* 
@@ -49,38 +49,38 @@
     endpoint: "https://api.ideal-postcodes.co.uk/v1",
 
     // Input Field Configuration
-    input: undefined,
-    $input: undefined,
+    // input: undefined,
+    // $input: undefined,
     input_label: "Please enter your postcode",
     placeholder_label: "",
     input_muted_style: "color:#CBCBCB;",
     input_class: "",
     input_id: "idpc_input",
 
     // Button configuration
-    button: undefined,
-    $button: undefined,
+    // button: undefined,
+    // $button: undefined,
     button_id: "idpc_button",
     button_label: "Find my Address",
     button_class: "",
     button_disabled_message: "Looking up postcode...",
 
     // Dropdown configuration
-    $dropdown: undefined,
+    // $dropdown: undefined,
     dropdown_id: "idpc_dropdown",
     dropdown_select_message: "Please select your address",
     dropdown_class: "",
-    dropdown_container: undefined,
+    // dropdown_container: undefined,
 
     // Error Message Configuration
-    $error_message: undefined,
+    // $error_message: undefined,
     error_message_id: "idpc_error_message",
     error_message_invalid_postcode: "Please check your postcode, it seems to be incorrect",
     error_message_not_found: "Your postcode could not be found. Please type in your address",
     error_message_address_not_found: "We could not find a match for your address. Please type in your address",
     error_message_default: "Sorry, we weren't able to get the address you were looking for. Please type your address manually",
     error_message_class: "",
-    error_message_container: undefined,
+    // error_message_container: undefined,
 
     // Address search fallback - if enabled, postcode searches which fail validation will be forward to the Address search API
     address_search: false,
@@ -125,19 +125,19 @@
     },
 
     // Register callbacks at specific stages
-    onLoaded: undefined,              // When plugin is initialised
-    onFailedCheck: undefined,         // When key check fails (requires check_key: true)
-    onSearchCompleted: undefined,     // When a lookup succeeds, E.g. Server responds that Postcode is found or doesn't exist
-    onAddressesRetrieved: undefined,  // When a lookup succeeds with a list of addresses
-    onAddressSelected: undefined,     // User has clicked an address in dropdown
-    onDropdownCreated: undefined,     // When the address selection dropdown is inserted to DOM
-    onDropdownDestroyed: undefined,   // When the address selection dropdown is removed (following new search)
-    onLookupTriggered: undefined,     // When user clicks the button to trigger a lookup
-    shouldLookupTrigger: undefined,   // 
-    onSearchError: undefined,         // When a request succeeds but the API returns an error code
+    // onLoaded: undefined,              // When plugin is initialised
+    // onFailedCheck: undefined,         // When key check fails (requires check_key: true)
+    // onSearchCompleted: undefined,     // When a lookup succeeds, E.g. Server responds that Postcode is found or doesn't exist
+    // onAddressesRetrieved: undefined,  // When a lookup succeeds with a list of addresses
+    // onAddressSelected: undefined,     // User has clicked an address in dropdown
+    // onDropdownCreated: undefined,     // When the address selection dropdown is inserted to DOM
+    // onDropdownDestroyed: undefined,   // When the address selection dropdown is removed (following new search)
+    // onLookupTriggered: undefined,     // When user clicks the button to trigger a lookup
+    // shouldLookupTrigger: undefined,   // 
+    // onSearchError: undefined,         // When a request succeeds but the API returns an error code
 
     // Tags to be included with search requests
-    tags: undefined
+    // tags: undefined
   };
 
   /* 
@@ -188,9 +188,7 @@
    *
    * If a selector (this.input) is specified, that input is used
    * If no selector specified, a new input field is generated and added to context
-   *
    */
-
   AddressFinderController.prototype.setupInputField = function () {
     var self = this;
     if ($(this.input).length) {
@@ -231,9 +229,7 @@
 
   /*
    * Connects clickable element to the plugin to trigger
-   *
    */
-
   AddressFinderController.prototype.setupLookupButton = function () {
     var self = this;
     if ($(self.button).length) {
@@ -280,7 +276,6 @@
   /*
    * Prevents lookup button from being triggered
    */
-
   AddressFinderController.prototype.disableLookup = function (message) {
     // Cancel if custom button
     if (this.button) {
@@ -293,7 +288,6 @@
   /*
    * Allows lookup button to be triggered
    */
-
   AddressFinderController.prototype.enableLookup = function () {
     // Cancel if custom button
     if (this.button) {
@@ -311,19 +305,15 @@
 
   /*
    * Clears the following fields
-   *
    */
-
   AddressFinderController.prototype.clearAll = function () {
     this.setDropDown();
     this.setErrorMessage();
   };
 
   /*
    * Removes all elements from DOM
-   *
    */
-
   AddressFinderController.prototype.removeAll = function () {
     this.$context = null;
 
@@ -340,7 +330,6 @@
    *  - On successful search but no addresses, show error message
    *  - On failed search, show error message
    */
-
   AddressFinderController.prototype.executeSearch = function (term) {
     var self = this;
     var message;
@@ -386,12 +375,12 @@
   /*
    * Invoke postcode lookup
    */
-
   AddressFinderController.prototype.executePostcodeSearch = function (postcode, callback) {
     var self = this;
     var options = {
       query: postcode, 
-      api_key: self.api_key
+      api_key: self.api_key,
+      endpoint: self.endpoint
     };
 
     if (self.tags) {
@@ -408,12 +397,12 @@
   /*
    * Invoke an address search
    */
-
   AddressFinderController.prototype.executeAddressSearch = function (query, callback) {
     var self = this;
     var options = {
       query: query,
-      api_key: self.api_key
+      api_key: self.api_key,
+      endpoint: self.endpoint
     };
 
     if (typeof self.address_search === "object") {
@@ -434,7 +423,6 @@
   /*
    *  Caches search result with raw data object
    */ 
-
   AddressFinderController.prototype.cacheSearchResults = function (data) {
     if (data === null) {
       return null;
@@ -450,7 +438,6 @@
    *
    * Removes dropdown from DOM if data is undefined
    */
-
   AddressFinderController.prototype.setDropDown = function (data) {
     var self = this;
 
@@ -528,7 +515,6 @@
    *
    * Removes error message from DOM if undefined
    */
-
   AddressFinderController.prototype.setErrorMessage = function (message) {
     if (this.$error_message && this.$error_message.length) {
       this.$error_message.remove();
@@ -561,7 +547,6 @@
    *
    * Empties output fields if undefined
    */
-
   AddressFinderController.prototype.setAddressFields = function (data) {
     data = data || {};
 
@@ -590,14 +575,14 @@
      *  - options.query: (string) Postcode to lookup, case and space insensitive
      *  - options.api_key: (string) API Key required
      *  - options.licensee: (string) Licensee key
+     *  - options.endpoint: (string) API endpoint
      * - success: (function) Callback invoked upon successful request
      * - error: (function) Optional callback invoked upon failed HTTP request
      */
-
     lookupPostcode: function (o, callback) {
       var postcode = o.query || o.postcode || "";
       var api_key = o.api_key || "";
-      var endpoint = defaults.endpoint;
+      var endpoint = o.endpoint || defaults.endpoint;
       var resource = "postcodes";
       var url = [endpoint, resource, encodeURI(postcode)].join('/');
       var queryString = {
@@ -647,14 +632,14 @@
      *   - options.api_key: (string) API Key required
      *   - options.licensee: (string) Licensee key
      *   - options.limit: (number) Maximum number of addresses to return (default 10)
+     *   - options.endpoint: (string) API endpoint 
      * - success: (function) Callback invoked upon successful request
      * - error: (function) Optional callback invoked upon failed HTTP request
      */
-
     lookupAddress: function (o, callback) {
       var query = o.query || "";
       var api_key = o.api_key || "";
-      var endpoint = defaults.endpoint;
+      var endpoint = o.endpoint || defaults.endpoint;
       var resource = "addresses";
       var url = [endpoint, resource].join('/');
       var queryString = {
@@ -703,10 +688,10 @@
      * - options: (object) Configuration object for key checking
      *  - options.api_key: (string) API Key to test
      *  - options.licensee: (string) Licensee key
+     *  - options.endpoint: (string) API endpoint
      * - success: (function) Callback invoked when key is available
      * - error: (function) Optional callback invoked when key is not available or HTTP request failed
      */
-
     checkKey: function (o, success, error) {
       var api_key = o.api_key || "";
 
@@ -734,7 +719,7 @@
         };
       }
 
-      var endpoint = defaults.endpoint;
+      var endpoint = o.endpoint || defaults.endpoint;
       var resource = "keys";
       var url = [endpoint, resource, api_key].join('/');
       var options = {
@@ -817,6 +802,9 @@
     // Check if key is usable if necessary
     if (options.check_key) {
       var keyOptions = { api_key: options.api_key };
+      if (options.endpoint) {
+        keyOptions.endpoint = options.endpoint;
+      }
       if (options.licensee) {
         keyOptions.licensee = options.licensee;
       }