Merge pull request #14 from ideal-postcodes/check_key_fix

Fix for check_key in present of licensee

Author: cblanc

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [3.0.6] 2017-11-02
+- Fix: Sublicensee key now passed into key checking API calls if `check_key: true`
+
 ## [3.0.5] 2017-11-02
 - Added placeholder to input field. The placeholder is determined by the `placeholder_label` attribute
 - Added `onDropdownDestroyed` destroyed callback, invoked when dropdown is removed from DOM following a new search

bower.json

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

dist/postcodes.js

@@ -1,4 +1,4 @@
-/*! Ideal Postcodes jQuery Plugin - v3.0.5 - 2017-11-16
+/*! Ideal Postcodes jQuery Plugin - v3.0.6 - 2017-11-17
 * https://github.com/ideal-postcodes/jquery.postcodes
 2017 Ideal Postcodes; Licensed MIT */
 (function($) {
@@ -816,9 +816,11 @@
 
     // Check if key is usable if necessary
     if (options.check_key) {
-      $.idealPostcodes.checkKey({
-        api_key: options.api_key 
-      }, initPlugin, failedKeyCheck);
+      var keyOptions = { api_key: options.api_key };
+      if (options.licensee) {
+        keyOptions.licensee = options.licensee;
+      }
+      $.idealPostcodes.checkKey(keyOptions, initPlugin, failedKeyCheck);
     } else {
       initPlugin();
     }

dist/postcodes.min.js

@@ -1562,6 +1562,11 @@ fake.registerWebservice('https://api.ideal-postcodes.co.uk/v1/keys/idklicensees'
 	return (data.licensee === "testlicensee") ? keyCheckPass : uncataloguedError;
 });
 
+// Mocked Licensees Requests
+fake.registerWebservice('https://api.ideal-postcodes.co.uk/v1/keys/iddlicensees', function(data) {
+	return (data.licensee === "testlicensee") ? keyCheckPass : keyCheckFail;
+});
+
 fake.registerWebservice('https://api.ideal-postcodes.co.uk/v1/postcodes/id11li', function(data) {
 	return (data.licensee === "testlicensee") ? testPostcodeResult : uncataloguedError;
 });

libs/fake/webservices.fake.js

@@ -1,6 +1,6 @@
 {
   "name": "jquery-postcodes",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "engines": {
     "node": ">= 0.8.0"
   },

package.json

@@ -2,7 +2,7 @@
   "name": "postcodes",
   "title": "Ideal Postcodes jQuery Plugin",
   "description": "Add UK Address lookups using postcodes on any address form using Royal Mail's addressing database",
-  "version": "3.0.5",
+  "version": "3.0.6",
   "homepage": "https://github.com/ideal-postcodes/jquery.postcodes",
   "author": {
     "name": "Ideal Postcodes",

postcodes.jquery.json

@@ -824,9 +824,11 @@
 
     // Check if key is usable if necessary
     if (options.check_key) {
-      $.idealPostcodes.checkKey({
-        api_key: options.api_key 
-      }, initPlugin, failedKeyCheck);
+      var keyOptions = { api_key: options.api_key };
+      if (options.licensee) {
+        keyOptions.licensee = options.licensee;
+      }
+      $.idealPostcodes.checkKey(keyOptions, initPlugin, failedKeyCheck);
     } else {
       initPlugin();
     }

src/jquery.postcodes.js

@@ -185,4 +185,29 @@
     equal($lookup_button.length, 0, "there is no button");
   });
 
+  module("Sublicensee: Pre-initialisation check", { 
+    setup: function () {
+      stop();
+      var startTests = function () {
+        $input_field = $("#"+defaults.input_id);
+        $lookup_button = $("#"+defaults.button_id);
+        start();
+      };
+      $("#postcode_lookup_field").setupPostcodeLookup({
+        // Test key which will return false
+        api_key: "iddlicensees",
+        licensee: "testlicensee",
+        check_key: true,
+        disable_interval: 0,
+        onFailedCheck: startTests,
+        onLoaded: startTests
+      });
+    } 
+  });
+
+  test("has postcode lookup tools setup", 2, function () {
+    equal($input_field.length, 1, "there is postcode input");
+    equal($lookup_button.length, 1, "there is button");
+  });
+
 }(jQuery));