├── .gitignore
├── .jshintrc
├── .travis.yml
├── Gruntfile.js
├── LICENSE
├── README.md
├── bower.json
├── dist
    ├── W3W.Geocoder.js
    └── W3W.Geocoder.min.js
├── package.json
├── src
    └── js
    │   ├── Bootstrap.js
    │   ├── Geocoder.js
    │   ├── Utils.js
    │   └── Xhr.js
└── test
    └── js
        ├── specs
            ├── environment.spec.js
            ├── geocoder.fr.spec.js
            ├── geocoder.spec.js
            └── multiple_requests.spec.js
        └── templates
            └── SpecRunner.tmpl


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | 


--------------------------------------------------------------------------------
/.jshintrc:
--------------------------------------------------------------------------------
1 | {
2 |     "globalstrict": false,
3 |     "globals": {
4 |         "define": false,
5 |         "module": false,
6 |         "window": false
7 |     }
8 | }
9 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: node_js
 2 | before_install: npm install -g grunt-cli
 3 | install: npm install
 4 | before_script: grunt build
 5 | env:
 6 |   matrix:
 7 |     secure: hpC35rZJAy0nWdEO99KjQw+wmS9q2TVyORpj17PdC5ZHBxdfT+HzJ6E0DPQSxBl2o9TSs3Y/gPC+yMF4SyUqqXTNIBf0fHTyA+Rq5c0NUdxdrAzQ9IPDOMKb3fl4mvywL56FciOfn0n074DVBFNF7GVeOs9wMPEEAydQjfGePKJdNAs4fpz36UgWh6QArc7yXh9DEfRFZhbogaY3HDZihQIwR6PU0whLQvNrXjpn9wht6959AjFufmuIAtFz2hQSi+j+A2VMoSw4k/xn9hPZB8h21LSciW8065iBGgta9o64AZcD8Mol6qh5hViYFkF6XiVSUkpwCXoA10yu7wiXIIE3SOfSbuPM4u2WuSftq0sQSdIRCOCsngS1fmCJfAr/tWQEt1jXYmkx8BeS6QXzBwBbwWh+HetHJTxZrIU+17h2mN06+xmExlaYElcKyEJ+17OyIMKRdG5OtcwBj62OpTnYUrhF0eIyOn8UP3T+PLujpyg0pcSZoqX604Kvf2U2CN6T2uyVr7BsIy4G9pUGfyc/gQSK5CKA1jSsNB9aKQTXbtMLsot2qIvNOLD9WDBoCT7zJUrTrZ2ohWH0P8SjtZyNYKVvcozgQ5coEj33+wJgzaCb/cMx7EluYONTyLHME0vORN6y149+1ORtG0bLr7abi5nap8pJ3GzTDPFfuh8=
 8 | notifications:
 9 |   slack:
10 |     secure: g1ccWDarVcARm6KYl4hJYKzGrTmA9Ck/MjIM/G+jEBiIQ9QdpCum42FEfh/Hc64aP6WYpOjf416QWKbq3GcwXToWWQikZIIBbARhApmKeOcsw7yWhOFyPD0bJW0bO371VigQYxc9i80tGXsZ43JhY2mcIMGBYhVEpipT+9XRLQ1JavX2n1LXAA/u+8kWHAOJ4LGTahP89JnNbvbFehLpXVzk4mhJt/n+6XU23LYI3g9csd04uXXhcBTAqUzSC+eRnjQjCPKnBTtusigxt4Vl8SX9WYWnk12WuysO1b6oKTELprX/2F+q+8TPr/TKEqSmoW70ZY2Bw/sjFz+MpVLUIgbuDjFMQ+96HvY5BOLKwefC8paWmisMLuK4Iv83DNJabMDhZrO3rmc8MpE+AgKyMRQZH8Z0ezWM3BpV36hJvxIJ0ryVCYwiu2ZC9we3CpiDUEaEVebvNT+EepVTLo8zc/McsSbB2YqasiBGdOthybYHK+jviFqy9cEz8jMubr1pF3jQmNL7g5adsWT2312H9xG7Sa60YXoOd44E2XNgAdrc61GmqBhCBe8+bmSPLJRBdtj6CZemt9wRwZ3n4uKeb2hvjrszfuGCXjuU3yYE6eGPYlSF0kFxyozLdYcgnb1OFymmETymFm5rUQyfRUBIR0ACa/yhNciImQYLkyAm8jU=
11 | 


--------------------------------------------------------------------------------
/Gruntfile.js:
--------------------------------------------------------------------------------
 1 | module.exports = function(grunt) {
 2 |     require('load-grunt-tasks')(grunt);
 3 | 
 4 |     grunt.initConfig({
 5 |         pkg: grunt.file.readJSON('package.json'),
 6 |         clean: {
 7 |             rebuild: ['dist/*']
 8 |         },
 9 |         concat: {
10 |             options: {
11 |                 banner: '(function() {\n',
12 |                 footer: '})();'
13 |             },
14 |             js: {
15 |                 src: [
16 |                     'src/js/Bootstrap.js',
17 |                     'src/js/Xhr.js',
18 |                     'src/js/Utils.js',
19 |                     'src/js/Geocoder.js'
20 |                 ],
21 |                 dest: 'dist/W3W.Geocoder.js'
22 |             }
23 |         },
24 |         jshint: {
25 |             options: {
26 |                 jshintrc: true
27 |             },
28 |             beforeconcat: ['src/js/**/*.js', 'test/js/**/*.js'],
29 |             afterconcat: ['dist/W3W.Geocoder.js'],
30 |             grunt: ['Gruntfile.js']
31 |         },
32 |         uglify: {
33 |             js: {
34 |                 files: {
35 |                     'dist/W3W.Geocoder.min.js': ['dist/W3W.Geocoder.js']
36 |                 }
37 |             }
38 |         },
39 |         jasmine: {
40 |             js: {
41 |                 src: 'dist/W3W.Geocoder.js',
42 |                 options: {
43 |                     specs: 'test/js/**/*.spec.js',
44 |                     vendor: ['node_modules/jasmine-expect/dist/jasmine-matchers.js'],
45 |                     template: 'test/js/templates/SpecRunner.tmpl',
46 |                     templateOptions: {
47 |                         api_key: process.env.W3W_API_KEY
48 |                     },
49 |                     '--web-security' : false,
50 |                     '--local-to-remote-url-access' : true,
51 |                     '--ignore-ssl-errors' : true
52 |                 }
53 |             }
54 |         },
55 |         version: {
56 |             project: {
57 |                 src: ['bower.json', 'src/js/Bootstrap.js', 'package.json']
58 |             }
59 |         },
60 |         watch: {
61 |             options: {
62 |                 livereload: true,
63 |             },
64 |             grunt: {
65 |                 files: ['Gruntfile.js'],
66 |                 tasks: ['jshint:grunt', 'build'],
67 |             },
68 |             js: {
69 |                 files: ['src/js/**/*.js'],
70 |                 tasks: ['jshint', 'concat']
71 |             },
72 |             uglify: {
73 |                 files: ['dist/*.js', '!dist/*.min.js'],
74 |                 tasks: ['uglify']
75 |             },
76 |             test: {
77 |                 files: ['dist/*.js', '!dist/*.min.js', 'test/js/**/*.tmpl', 'test/js/specs/**/*.js'],
78 |                 tasks: ['jshint', 'test']
79 |             }
80 |         }
81 |     });
82 | 
83 |     grunt.registerTask('default', ['watch']);
84 |     grunt.registerTask('nodsstore', function() {
85 |         grunt.file.expand({
86 |             filter: 'isFile',
87 |             cwd: '.'
88 |         }, ['**/.DS_Store']).forEach(function(file) {
89 |             grunt.file.delete(file);
90 |         });
91 |     });
92 |     grunt.registerTask('test', ['build', 'jasmine']);
93 |     grunt.registerTask('build', ['nodsstore', 'jshint', 'concat', 'uglify']);
94 |     grunt.registerTask('rebuild', ['clean', 'build', 'test']);
95 | };
96 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | The MIT License (MIT)
 2 | 
 3 | Copyright (c) 2015 what3words
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 
23 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [DEPRECATED] Please use our [JavaScript Wrapper](https://docs.what3words.com/wrapper/javascript/).


--------------------------------------------------------------------------------
/bower.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "w3w-javascript-wrapper",
 3 |     "version": "3.1.3",
 4 |     "homepage": "https://github.com/what3words/w3w-javascript-wrapper",
 5 |     "authors": [
 6 |         "Will Henderson <will@what3words.com>",
 7 |         "Gary Gale <gary@vicchi.org>",
 8 |         "Arnaud Ferrand <arnaud@what3words.com>",
 9 |         "David Piesse",
10 |         "Oliver Svenson"
11 |     ],
12 |     "description": "Javascript wrapper for the what3words API",
13 |     "main": "dist/W3W.Geocoder.js",
14 |     "moduleType": [
15 |         "globals"
16 |     ],
17 |     "keywords": [
18 |         "what3words",
19 |         "javascript",
20 |         "api"
21 |     ],
22 |     "license": "MIT",
23 |     "ignore": [
24 |         "**/.*",
25 |         "node_modules",
26 |         "bower_components"
27 |     ]
28 | }
29 | 


--------------------------------------------------------------------------------
/dist/W3W.Geocoder.js:
--------------------------------------------------------------------------------
  1 | (function() {
  2 | /*jshint -W097 */
  3 | 'use strict';
  4 | 
  5 | var W3W = {
  6 |     version: '3.2.0'
  7 | };
  8 | 
  9 | if (typeof module === 'object' && typeof module.exports === 'object') {
 10 |     module.exports = W3W;
 11 | }
 12 | 
 13 | else if (typeof define === 'function' && define.amd) {
 14 |     define(W3W);
 15 | }
 16 | 
 17 | if (typeof window !== 'undefined') {
 18 |     var oldW3W = window.W3W;
 19 | 
 20 |     W3W.noConflict = function() {
 21 |         window.W3W = oldW3W;
 22 |         return this;
 23 |     };
 24 | 
 25 |     window.W3W = W3W;
 26 | }
 27 | 
 28 | W3W.Xhr = {
 29 |     getXhr: function() {
 30 |         if (window.XMLHttpRequest) {
 31 |             return window.XMLHttpRequest;
 32 |         }
 33 |         else {
 34 |             if (window.ActiveXObject) {
 35 |                 try {
 36 |                     return new ActiveXObject('MSxml2.XMLHTTP');
 37 |                 }
 38 |                 catch (e) {
 39 |                     try {
 40 |                         return new ActiveXObject('Microsoft.XMLHTTP');
 41 |                     }
 42 |                     catch (exc) {
 43 |                         return false;
 44 |                     }
 45 |                 }
 46 |             }
 47 | 
 48 |             return false;
 49 |         }
 50 |     },
 51 | 
 52 |     handleRequest: function(url, callback, method, body) {
 53 |         var xhr = new XMLHttpRequest();
 54 |         method = (method) ? method : 'GET';
 55 | 
 56 |         xhr.open(method, url, true);
 57 |         xhr.onreadystatechange = function(event) {
 58 |             var json;
 59 |             if (xhr.readyState == 4) {
 60 |                 if (xhr.status == 200) {
 61 |                     json = JSON.parse(xhr.responseText);
 62 |                     if (json.hasOwnProperty('error') && callback.onFailure) {
 63 |                         callback.onFailure(json);
 64 |                     }
 65 |                     else if (callback.onSuccess) {
 66 |                         callback.onSuccess(json);
 67 |                     }
 68 |                 }
 69 |                 else {
 70 |                     if (callback.onFailure) {
 71 |                         json = JSON.parse(xhr.responseText);
 72 |                         callback.onFailure(json);
 73 |                     }
 74 |                 }
 75 |             }
 76 |         };
 77 | 
 78 |         if (body) {
 79 |             xhr.setRequestHeader('Content-Length', body.length);
 80 |             xhr.send(body);
 81 |         }
 82 |         else {
 83 |             xhr.send();
 84 |         }
 85 |     }
 86 | };
 87 | 
 88 | W3W.Utils = {
 89 |     mergeOptions: function(dest) {
 90 |         var i;
 91 |         var j;
 92 |         var len;
 93 |         var src;
 94 | 
 95 |         var options = JSON.parse(JSON.stringify(dest));
 96 | 
 97 |         for (i=1, len = arguments.length; i<len; i++) {
 98 |             src = arguments[i];
 99 |             for (j in src) {
100 |                 options[j] = src[j];
101 |             }
102 |         }
103 |         return options;
104 |     },
105 | 
106 |     assembleQuery: function(params) {
107 |         var query = [];
108 |         for (var key in params) {
109 |             query.push(key + '=' + encodeURIComponent(params[key]));
110 |         }
111 |         return query.join('&');
112 |     }
113 | };
114 | 
115 | W3W.Geocoder = function(options) {
116 |     this.base_url = 'https://api.what3words.com/v2/' ;
117 | 
118 |     if (typeof options === 'undefined') {
119 |         throw new Error('Missing what3words options');
120 |     }
121 |     else if (options && !options.hasOwnProperty('key')) {
122 |         throw new Error('Missing what3words API key');
123 |     }
124 |     this.options = {
125 |         lang: 'en',
126 |         format: 'json'
127 |     };
128 |     this.options = W3W.Utils.mergeOptions(this.options, options);
129 |     if (this.options.hasOwnProperty('base_url')) {
130 |         this.base_url = this.options.base_url;
131 |         delete this.options.base_url;
132 |     }
133 |     this.urls = {
134 |         forward: this.base_url + 'forward',
135 |         reverse: this.base_url + 'reverse',
136 |         autosuggest: this.base_url + 'autosuggest',
137 |         standardblend: this.base_url + 'standardblend',
138 |         autosuggest_ml: this.base_url + 'autosuggest-ml',
139 |         standardblend_ml: this.base_url + 'standardblend-ml',
140 |         grid: this.base_url + 'grid',
141 |         languages: this.base_url + 'languages'
142 |     };
143 | };
144 | 
145 | // var params = {
146 | //      addr: '3-word-address',
147 | //      lang: 'en',
148 | //      format: 'json|geojson'
149 | // };
150 | W3W.Geocoder.prototype.forward = function(params, callback) {
151 |     if (typeof params === 'undefined' || typeof params !== 'object') {
152 |         throw new Error('Missing or invalid params object');
153 |     }
154 | 
155 |     if (params) {
156 |         if (!params.hasOwnProperty('addr')) {
157 |             throw new Error('The params object is missing required addr property');
158 |         }
159 |         else if (typeof params.addr !== 'string') {
160 |             throw new Error('params.addr must be a string');
161 |         }
162 | 
163 |         if (params.hasOwnProperty('lang') && typeof params.lang !== 'string') {
164 |             throw new Error('params.lang must be a string');
165 |         }
166 | 
167 |         if (params.hasOwnProperty('format')) {
168 |             if (typeof params.format !== 'string') {
169 |                 throw new Error('params.format must be a string');
170 |             }
171 |             else if (params.format !== 'json' && params.format !== 'geojson') {
172 |                 throw new Error('params.format must have a value of "json" or "geojson"');
173 |             }
174 |         }
175 |     }
176 | 
177 |     if (typeof callback === 'undefined') {
178 |         throw new Error('Missing callback parameter');
179 |     }
180 |     else if (typeof callback !== 'object') {
181 |         throw new Error('Missing or invalid callback parameter');
182 |     }
183 | 
184 |     params = W3W.Utils.mergeOptions(this.options, params);
185 |     var url = this.urls.forward + '?' + W3W.Utils.assembleQuery(params);
186 |     W3W.Xhr.handleRequest(url, callback);
187 | };
188 | 
189 | // var params = {
190 | //      coords: [lat, long],
191 | //      coords: 'lat,long',
192 | //      lang: 'en',
193 | //      format: 'json|geojson'
194 | // };
195 | W3W.Geocoder.prototype.reverse = function(params, callback) {
196 |     if (typeof params === 'undefined' || typeof params !== 'object') {
197 |         throw new Error('Missing or invalid params object');
198 |     }
199 | 
200 |     if (params) {
201 |         if (!params.hasOwnProperty('coords')) {
202 |             throw new Error('The params object is missing required coords property');
203 |         }
204 |         else {
205 |             params.coords = this._formatCoords(params.coords);
206 |             if (null === params.coords) {
207 |                 throw new Error('Invalid format coordinates for params.coords');
208 |             }
209 |         }
210 | 
211 |         if (params.hasOwnProperty('lang') && typeof params.lang !== 'string') {
212 |             throw new Error('params.lang must be a string');
213 |         }
214 | 
215 |         if (params.hasOwnProperty('format')) {
216 |             if (typeof params.format !== 'string') {
217 |                 throw new Error('params.format must be a string');
218 |             }
219 |             else if (params.format !== 'json' && params.format !== 'geojson') {
220 |                 throw new Error('params.format must have a value of "json" or "geojson"');
221 |             }
222 |         }
223 |     }
224 | 
225 |     if (typeof callback === 'undefined') {
226 |         throw new Error('Missing callback parameter');
227 |     }
228 |     else if (typeof callback !== 'object') {
229 |         throw new Error('Missing or invalid callback parameter');
230 |     }
231 | 
232 |     params = W3W.Utils.mergeOptions(this.options, params);
233 |     var url = this.urls.reverse + '?' + W3W.Utils.assembleQuery(params);
234 |     W3W.Xhr.handleRequest(url, callback);
235 | };
236 | 
237 | // var params = {
238 | //      lang: 'en',
239 | //      addr: '3-word-address'
240 | //     focus: [lat, lng],
241 | //     focus: 'lat,lng',
242 | //     clip: {
243 | //         type: 'none'
244 | //     }
245 | //     clip: {
246 | //         type: 'radius',
247 | //         focus: [lat, lng],
248 | //         focus: 'lat,lng',
249 | //         distance: km
250 | //     },
251 | //     clip: {
252 | //         type: 'focus'
253 | //         distance: km
254 | //     },
255 | //     clip: {
256 | //         type: 'bbox',
257 | //         bbox: [lat,lng,lat,lng],
258 | //         bbox: 'lat,lng,lat,lng'
259 | //     }
260 | // };
261 | W3W.Geocoder.prototype.autosuggest = function(params, callback) {
262 |     if (typeof params === 'undefined' || typeof params !== 'object') {
263 |         throw new Error('Missing or invalid params object');
264 |     }
265 | 
266 |     var clip = {};
267 | 
268 |     if (params) {
269 |         if (!params.hasOwnProperty('addr')) {
270 |             throw new Error('The params object is missing required addr property');
271 |         }
272 |         else if (typeof params.addr !== 'string') {
273 |             throw new Error('params.addr must be a string');
274 |         }
275 | 
276 |         if (params.hasOwnProperty('focus')) {
277 |             params.focus = this._formatCoords(params.focus);
278 |             if (null === params.focus) {
279 |                 throw new Error('Invalid format coordinates for params.focus');
280 |             }
281 |         }
282 | 
283 |         if (!params.hasOwnProperty('lang')) {
284 |             throw new Error('The params object is missing required lang property');
285 |         }
286 |         else if (typeof params.lang !== 'string') {
287 |             throw new Error('params.lang must be a string');
288 |         }
289 | 
290 |         if (params.hasOwnProperty('format')) {
291 |             if (typeof params.format !== 'string') {
292 |                 throw new Error('params.format must be a string');
293 |             }
294 |             else if (params.format !== 'json') {
295 |                 throw new Error('params.format must have a value of "json"');
296 |             }
297 |         }
298 | 
299 |         if (params.hasOwnProperty('clip')) {
300 |             if (!params.clip.hasOwnProperty('type')) {
301 |                 throw new Error('Invalid clipping policy type for params.clip');
302 |             }
303 | 
304 |             switch (params.clip.type) {
305 |                 case 'none':
306 |                     clip = {
307 |                         clip: 'none'
308 |                     };
309 |                     break;
310 | 
311 |                 case 'radius':
312 |                     if (!params.clip.hasOwnProperty('distance')) {
313 |                         throw new Error('Invalid clipping policy for type radius; missing distance property');
314 |                     }
315 | 
316 |                     else if (!params.clip.hasOwnProperty('focus')) {
317 |                         throw new Error('Invalid clipping policy for type radius; missing focus property');
318 | 
319 |                     }
320 | 
321 |                     else {
322 |                         params.clip.focus = this._formatCoords(params.clip.focus);
323 |                         if (null === params.focus) {
324 |                             throw new Error('Invalid format coordinates for params.clip.focus');
325 |                         }
326 |                     }
327 | 
328 |                     clip = {
329 |                         clip: 'radius(' + params.clip.focus + ',' + params.clip.distance + ')'
330 |                     };
331 |                     break;
332 | 
333 |                 case 'focus':
334 |                     if (!params.clip.hasOwnProperty('distance')) {
335 |                         throw new Error('Invalid clipping policy for type focus; missing distance property');
336 |                     }
337 |                     else if (!params.hasOwnProperty('focus') || params.focus === null) {
338 |                         throw new Error('Invalid clipping policy for type focus; missing or invalid focus property');
339 |                     }
340 | 
341 |                     clip = {
342 |                         clip: 'focus(' + params.clip.distance + ')'
343 |                     };
344 |                     break;
345 | 
346 |                 case 'bbox':
347 |                     if (!params.clip.hasOwnProperty('bbox')) {
348 |                         throw new Error('Invalid clipping policy for type bbox; missing bbox property');
349 |                     }
350 |                     params.clip.bbox = this._formatBoundingBox(params.clip.bbox);
351 |                     if (null === params.clip.bbox) {
352 |                         throw new Error('Invalid format coordinates for params.clip.bbox');
353 |                     }
354 | 
355 |                     clip = {
356 |                         clip: 'bbox(' + params.clip.bbox + ')'
357 |                     };
358 |                     break;
359 | 
360 |                 default:
361 |                     throw new Error('Invalid or unrecognised clipping policy type');
362 |             }
363 |         }
364 |     }
365 | 
366 |     if (typeof callback === 'undefined') {
367 |         throw new Error('Missing callback parameter');
368 |     }
369 |     else if (typeof callback !== 'object') {
370 |         throw new Error('Missing or invalid callback parameter');
371 |     }
372 | 
373 |     params = W3W.Utils.mergeOptions(this.options, params, clip);
374 |     var url = this.urls.autosuggest + '?' + W3W.Utils.assembleQuery(params);
375 |     W3W.Xhr.handleRequest(url, callback);
376 | };
377 | 
378 | // var params = {
379 | //      lang: 'en',
380 | //      addr: '3-word-address'
381 | //     focus: [lat, lng],
382 | //     focus: 'lat,lng',
383 | //     clip: {
384 | //         type: 'none'
385 | //     }
386 | //     clip: {
387 | //         type: 'radius',
388 | //         focus: [lat, lng],
389 | //         focus: 'lat,lng',
390 | //         distance: km
391 | //     },
392 | //     clip: {
393 | //         type: 'focus'
394 | //         distance: km
395 | //     },
396 | //     clip: {
397 | //         type: 'bbox',
398 | //         bbox: [lat,lng,lat,lng],
399 | //         bbox: 'lat,lng,lat,lng'
400 | //     }
401 | // };
402 | W3W.Geocoder.prototype.autosuggest_ml = function(params, callback) {
403 |     if (typeof params === 'undefined' || typeof params !== 'object') {
404 |         throw new Error('Missing or invalid params object');
405 |     }
406 | 
407 |     var clip = {};
408 | 
409 |     if (params) {
410 |         if (!params.hasOwnProperty('addr')) {
411 |             throw new Error('The params object is missing required addr property');
412 |         }
413 |         else if (typeof params.addr !== 'string') {
414 |             throw new Error('params.addr must be a string');
415 |         }
416 | 
417 |         if (params.hasOwnProperty('focus')) {
418 |             params.focus = this._formatCoords(params.focus);
419 |             if (null === params.focus) {
420 |                 throw new Error('Invalid format coordinates for params.focus');
421 |             }
422 |         }
423 | 
424 |         if (!params.hasOwnProperty('lang')) {
425 |             throw new Error('The params object is missing required lang property');
426 |         }
427 |         else if (typeof params.lang !== 'string') {
428 |             throw new Error('params.lang must be a string');
429 |         }
430 | 
431 |         if (params.hasOwnProperty('format')) {
432 |             if (typeof params.format !== 'string') {
433 |                 throw new Error('params.format must be a string');
434 |             }
435 |             else if (params.format !== 'json') {
436 |                 throw new Error('params.format must have a value of "json"');
437 |             }
438 |         }
439 | 
440 |         if (params.hasOwnProperty('clip')) {
441 |             if (!params.clip.hasOwnProperty('type')) {
442 |                 throw new Error('Invalid clipping policy type for params.clip');
443 |             }
444 | 
445 |             switch (params.clip.type) {
446 |                 case 'none':
447 |                     clip = {
448 |                         clip: 'none'
449 |                     };
450 |                     break;
451 | 
452 |                 case 'radius':
453 |                     if (!params.clip.hasOwnProperty('distance')) {
454 |                         throw new Error('Invalid clipping policy for type radius; missing distance property');
455 |                     }
456 | 
457 |                     else if (!params.clip.hasOwnProperty('focus')) {
458 |                         throw new Error('Invalid clipping policy for type radius; missing focus property');
459 | 
460 |                     }
461 | 
462 |                     else {
463 |                         params.clip.focus = this._formatCoords(params.clip.focus);
464 |                         if (null === params.focus) {
465 |                             throw new Error('Invalid format coordinates for params.clip.focus');
466 |                         }
467 |                     }
468 | 
469 |                     clip = {
470 |                         clip: 'radius(' + params.clip.focus + ',' + params.clip.distance + ')'
471 |                     };
472 |                     break;
473 | 
474 |                 case 'focus':
475 |                     if (!params.clip.hasOwnProperty('distance')) {
476 |                         throw new Error('Invalid clipping policy for type focus; missing distance property');
477 |                     }
478 |                     else if (!params.hasOwnProperty('focus') || params.focus === null) {
479 |                         throw new Error('Invalid clipping policy for type focus; missing or invalid focus property');
480 |                     }
481 | 
482 |                     clip = {
483 |                         clip: 'focus(' + params.clip.distance + ')'
484 |                     };
485 |                     break;
486 | 
487 |                 case 'bbox':
488 |                     if (!params.clip.hasOwnProperty('bbox')) {
489 |                         throw new Error('Invalid clipping policy for type bbox; missing bbox property');
490 |                     }
491 |                     params.clip.bbox = this._formatBoundingBox(params.clip.bbox);
492 |                     if (null === params.clip.bbox) {
493 |                         throw new Error('Invalid format coordinates for params.clip.bbox');
494 |                     }
495 | 
496 |                     clip = {
497 |                         clip: 'bbox(' + params.clip.bbox + ')'
498 |                     };
499 |                     break;
500 | 
501 |                 default:
502 |                     throw new Error('Invalid or unrecognised clipping policy type');
503 |             }
504 |         }
505 |     }
506 | 
507 |     if (typeof callback === 'undefined') {
508 |         throw new Error('Missing callback parameter');
509 |     }
510 |     else if (typeof callback !== 'object') {
511 |         throw new Error('Missing or invalid callback parameter');
512 |     }
513 | 
514 |     params = W3W.Utils.mergeOptions(this.options, params, clip);
515 |     var url = this.urls.autosuggest_ml + '?' + W3W.Utils.assembleQuery(params);
516 |     W3W.Xhr.handleRequest(url, callback);
517 | };
518 | 
519 | // var params = {
520 | //      addr: '3-word-address',
521 | //      lang: 'en',
522 | //      focus: '[lat, lng]
523 | // };
524 | W3W.Geocoder.prototype.standardblend = function(params, callback) {
525 |     if (typeof params === 'undefined' || typeof params !== 'object') {
526 |         throw new Error('Missing or invalid params object');
527 |     }
528 | 
529 |     if (params) {
530 |         if (!params.hasOwnProperty('addr')) {
531 |             throw new Error('The params object is missing required addr property');
532 |         }
533 |         else if (typeof params.addr !== 'string') {
534 |             throw new Error('params.addr must be a string');
535 |         }
536 | 
537 |         if (params.hasOwnProperty('focus')) {
538 |             params.focus = this._formatCoords(params.focus);
539 |             if (null === params.focus) {
540 |                 throw new Error('Invalid format coordinates for params.focus');
541 |             }
542 |         }
543 | 
544 |         if (!params.hasOwnProperty('lang')) {
545 |             throw new Error('The params object is missing required lang property');
546 |         }
547 |         else if (typeof params.lang !== 'string') {
548 |             throw new Error('params.lang must be a string');
549 |         }
550 | 
551 |         if (params.hasOwnProperty('format')) {
552 |             if (typeof params.format !== 'string') {
553 |                 throw new Error('params.format must be a string');
554 |             }
555 |             else if (params.format !== 'json') {
556 |                 throw new Error('params.format must have a value of "json"');
557 |             }
558 |         }
559 |     }
560 | 
561 |     if (typeof callback === 'undefined') {
562 |         throw new Error('Missing callback parameter');
563 |     }
564 |     else if (typeof callback !== 'object') {
565 |         throw new Error('Missing or invalid callback parameter');
566 |     }
567 | 
568 |     params = W3W.Utils.mergeOptions(this.options, params);
569 |     var url = this.urls.standardblend + '?' + W3W.Utils.assembleQuery(params);
570 |     W3W.Xhr.handleRequest(url, callback);
571 | };
572 | 
573 | // var params = {
574 | //      addr: '3-word-address',
575 | //      lang: 'en',
576 | //      focus: '[lat, lng]
577 | // };
578 | W3W.Geocoder.prototype.standardblend_ml = function(params, callback) {
579 |     if (typeof params === 'undefined' || typeof params !== 'object') {
580 |         throw new Error('Missing or invalid params object');
581 |     }
582 | 
583 |     if (params) {
584 |         if (!params.hasOwnProperty('addr')) {
585 |             throw new Error('The params object is missing required addr property');
586 |         }
587 |         else if (typeof params.addr !== 'string') {
588 |             throw new Error('params.addr must be a string');
589 |         }
590 | 
591 |         if (params.hasOwnProperty('focus')) {
592 |             params.focus = this._formatCoords(params.focus);
593 |             if (null === params.focus) {
594 |                 throw new Error('Invalid format coordinates for params.focus');
595 |             }
596 |         }
597 | 
598 |         if (!params.hasOwnProperty('lang')) {
599 |             throw new Error('The params object is missing required lang property');
600 |         }
601 |         else if (typeof params.lang !== 'string') {
602 |             throw new Error('params.lang must be a string');
603 |         }
604 | 
605 |         if (params.hasOwnProperty('format')) {
606 |             if (typeof params.format !== 'string') {
607 |                 throw new Error('params.format must be a string');
608 |             }
609 |             else if (params.format !== 'json') {
610 |                 throw new Error('params.format must have a value of "json"');
611 |             }
612 |         }
613 |     }
614 | 
615 |     if (typeof callback === 'undefined') {
616 |         throw new Error('Missing callback parameter');
617 |     }
618 |     else if (typeof callback !== 'object') {
619 |         throw new Error('Missing or invalid callback parameter');
620 |     }
621 | 
622 |     params = W3W.Utils.mergeOptions(this.options, params);
623 |     var url = this.urls.standardblend_ml + '?' + W3W.Utils.assembleQuery(params);
624 |     W3W.Xhr.handleRequest(url, callback);
625 | };
626 | 
627 | // var params = {
628 | //      bbox: [nelat, nelng, swlat, swlng],
629 | //      format: 'json|geojson'
630 | // };
631 | W3W.Geocoder.prototype.grid = function(params, callback) {
632 |     if (typeof params === 'undefined' || typeof params !== 'object') {
633 |         throw new Error('Missing or invalid params object');
634 |     }
635 | 
636 |     if (params) {
637 |         if (!params.hasOwnProperty('bbox')) {
638 |             throw new Error('The params object is missing required bbox property');
639 |         }
640 | 
641 |         params.bbox = this._formatBoundingBox(params.bbox);
642 |         if (null === params.bbox) {
643 |             throw new Error('Invalid format coordinates for params.bbox');
644 |         }
645 | 
646 |         if (params.hasOwnProperty('format')) {
647 |             if (typeof params.format !== 'string') {
648 |                 throw new Error('params.format must be a string');
649 |             }
650 |             else if (params.format !== 'json' && params.format !== 'geojson') {
651 |                 throw new Error('params.format must have a value of "json" or "geojson"');
652 |             }
653 |         }
654 |     }
655 | 
656 |     if (typeof callback === 'undefined') {
657 |         throw new Error('Missing callback parameter');
658 |     }
659 |     else if (typeof callback !== 'object') {
660 |         throw new Error('Missing or invalid callback parameter');
661 |     }
662 | 
663 |     params = W3W.Utils.mergeOptions(this.options, params);
664 |     var url = this.urls.grid + '?' + W3W.Utils.assembleQuery(params);
665 |     W3W.Xhr.handleRequest(url, callback);
666 | };
667 | 
668 | W3W.Geocoder.prototype.languages = function(callback) {
669 |     if (typeof callback === 'undefined') {
670 |         throw new Error('Missing callback parameter');
671 |     }
672 |     else if (typeof callback !== 'object') {
673 |         throw new Error('Missing or invalid callback parameter');
674 |     }
675 | 
676 |     var params = {
677 |         key: this.options.key
678 |     };
679 |     var url = this.urls.languages + '?' + W3W.Utils.assembleQuery(params);
680 |     W3W.Xhr.handleRequest(url, callback);
681 | };
682 | 
683 | W3W.Geocoder.prototype._formatCoords = function(coords) {
684 |     if (typeof coords === 'object' && coords instanceof Array && coords.length === 2) {
685 |         return coords.join(',');
686 |     }
687 |     else if (typeof coords !== 'string' && !coords.match(/^[-.0-9]{1,},[-.0-9]{1,}$/)) {
688 |         return coords;
689 |     }
690 | 
691 |     return null;
692 | };
693 | 
694 | W3W.Geocoder.prototype._formatBoundingBox = function(coords) {
695 |     if (typeof coords === 'object' && coords instanceof Array && coords.length === 4) {
696 |         return coords.join(',');
697 |     }
698 |     else if (typeof coords !== 'string' && !coords.match(/^[-.0-9]{1,},[-.0-9]{1,},[-.0-9]{1,},[-.0-9]{1,}$/)) {
699 |         return coords;
700 |     }
701 | 
702 |     return null;
703 | };
704 | })();


--------------------------------------------------------------------------------
/dist/W3W.Geocoder.min.js:
--------------------------------------------------------------------------------
1 | !function(){"use strict";var a={version:"3.2.0"};if("object"==typeof module&&"object"==typeof module.exports?module.exports=a:"function"==typeof define&&define.amd&&define(a),"undefined"!=typeof window){var b=window.W3W;a.noConflict=function(){return window.W3W=b,this},window.W3W=a}a.Xhr={getXhr:function(){if(window.XMLHttpRequest)return window.XMLHttpRequest;if(window.ActiveXObject)try{return new ActiveXObject("MSxml2.XMLHTTP")}catch(a){try{return new ActiveXObject("Microsoft.XMLHTTP")}catch(b){return!1}}return!1},handleRequest:function(a,b,c,d){var e=new XMLHttpRequest;c=c?c:"GET",e.open(c,a,!0),e.onreadystatechange=function(a){var c;4==e.readyState&&(200==e.status?(c=JSON.parse(e.responseText),c.hasOwnProperty("error")&&b.onFailure?b.onFailure(c):b.onSuccess&&b.onSuccess(c)):b.onFailure&&(c=JSON.parse(e.responseText),b.onFailure(c)))},d?(e.setRequestHeader("Content-Length",d.length),e.send(d)):e.send()}},a.Utils={mergeOptions:function(a){var b,c,d,e,f=JSON.parse(JSON.stringify(a));for(b=1,d=arguments.length;b<d;b++){e=arguments[b];for(c in e)f[c]=e[c]}return f},assembleQuery:function(a){var b=[];for(var c in a)b.push(c+"="+encodeURIComponent(a[c]));return b.join("&")}},a.Geocoder=function(b){if(this.base_url="https://api.what3words.com/v2/","undefined"==typeof b)throw new Error("Missing what3words options");if(b&&!b.hasOwnProperty("key"))throw new Error("Missing what3words API key");this.options={lang:"en",format:"json"},this.options=a.Utils.mergeOptions(this.options,b),this.options.hasOwnProperty("base_url")&&(this.base_url=this.options.base_url,delete this.options.base_url),this.urls={forward:this.base_url+"forward",reverse:this.base_url+"reverse",autosuggest:this.base_url+"autosuggest",standardblend:this.base_url+"standardblend",autosuggest_ml:this.base_url+"autosuggest-ml",standardblend_ml:this.base_url+"standardblend-ml",grid:this.base_url+"grid",languages:this.base_url+"languages"}},a.Geocoder.prototype.forward=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");if(b){if(!b.hasOwnProperty("addr"))throw new Error("The params object is missing required addr property");if("string"!=typeof b.addr)throw new Error("params.addr must be a string");if(b.hasOwnProperty("lang")&&"string"!=typeof b.lang)throw new Error("params.lang must be a string");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format&&"geojson"!==b.format)throw new Error('params.format must have a value of "json" or "geojson"')}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b);var d=this.urls.forward+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(d,c)},a.Geocoder.prototype.reverse=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");if(b){if(!b.hasOwnProperty("coords"))throw new Error("The params object is missing required coords property");if(b.coords=this._formatCoords(b.coords),null===b.coords)throw new Error("Invalid format coordinates for params.coords");if(b.hasOwnProperty("lang")&&"string"!=typeof b.lang)throw new Error("params.lang must be a string");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format&&"geojson"!==b.format)throw new Error('params.format must have a value of "json" or "geojson"')}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b);var d=this.urls.reverse+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(d,c)},a.Geocoder.prototype.autosuggest=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");var d={};if(b){if(!b.hasOwnProperty("addr"))throw new Error("The params object is missing required addr property");if("string"!=typeof b.addr)throw new Error("params.addr must be a string");if(b.hasOwnProperty("focus")&&(b.focus=this._formatCoords(b.focus),null===b.focus))throw new Error("Invalid format coordinates for params.focus");if(!b.hasOwnProperty("lang"))throw new Error("The params object is missing required lang property");if("string"!=typeof b.lang)throw new Error("params.lang must be a string");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format)throw new Error('params.format must have a value of "json"')}if(b.hasOwnProperty("clip")){if(!b.clip.hasOwnProperty("type"))throw new Error("Invalid clipping policy type for params.clip");switch(b.clip.type){case"none":d={clip:"none"};break;case"radius":if(!b.clip.hasOwnProperty("distance"))throw new Error("Invalid clipping policy for type radius; missing distance property");if(!b.clip.hasOwnProperty("focus"))throw new Error("Invalid clipping policy for type radius; missing focus property");if(b.clip.focus=this._formatCoords(b.clip.focus),null===b.focus)throw new Error("Invalid format coordinates for params.clip.focus");d={clip:"radius("+b.clip.focus+","+b.clip.distance+")"};break;case"focus":if(!b.clip.hasOwnProperty("distance"))throw new Error("Invalid clipping policy for type focus; missing distance property");if(!b.hasOwnProperty("focus")||null===b.focus)throw new Error("Invalid clipping policy for type focus; missing or invalid focus property");d={clip:"focus("+b.clip.distance+")"};break;case"bbox":if(!b.clip.hasOwnProperty("bbox"))throw new Error("Invalid clipping policy for type bbox; missing bbox property");if(b.clip.bbox=this._formatBoundingBox(b.clip.bbox),null===b.clip.bbox)throw new Error("Invalid format coordinates for params.clip.bbox");d={clip:"bbox("+b.clip.bbox+")"};break;default:throw new Error("Invalid or unrecognised clipping policy type")}}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b,d);var e=this.urls.autosuggest+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(e,c)},a.Geocoder.prototype.autosuggest_ml=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");var d={};if(b){if(!b.hasOwnProperty("addr"))throw new Error("The params object is missing required addr property");if("string"!=typeof b.addr)throw new Error("params.addr must be a string");if(b.hasOwnProperty("focus")&&(b.focus=this._formatCoords(b.focus),null===b.focus))throw new Error("Invalid format coordinates for params.focus");if(!b.hasOwnProperty("lang"))throw new Error("The params object is missing required lang property");if("string"!=typeof b.lang)throw new Error("params.lang must be a string");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format)throw new Error('params.format must have a value of "json"')}if(b.hasOwnProperty("clip")){if(!b.clip.hasOwnProperty("type"))throw new Error("Invalid clipping policy type for params.clip");switch(b.clip.type){case"none":d={clip:"none"};break;case"radius":if(!b.clip.hasOwnProperty("distance"))throw new Error("Invalid clipping policy for type radius; missing distance property");if(!b.clip.hasOwnProperty("focus"))throw new Error("Invalid clipping policy for type radius; missing focus property");if(b.clip.focus=this._formatCoords(b.clip.focus),null===b.focus)throw new Error("Invalid format coordinates for params.clip.focus");d={clip:"radius("+b.clip.focus+","+b.clip.distance+")"};break;case"focus":if(!b.clip.hasOwnProperty("distance"))throw new Error("Invalid clipping policy for type focus; missing distance property");if(!b.hasOwnProperty("focus")||null===b.focus)throw new Error("Invalid clipping policy for type focus; missing or invalid focus property");d={clip:"focus("+b.clip.distance+")"};break;case"bbox":if(!b.clip.hasOwnProperty("bbox"))throw new Error("Invalid clipping policy for type bbox; missing bbox property");if(b.clip.bbox=this._formatBoundingBox(b.clip.bbox),null===b.clip.bbox)throw new Error("Invalid format coordinates for params.clip.bbox");d={clip:"bbox("+b.clip.bbox+")"};break;default:throw new Error("Invalid or unrecognised clipping policy type")}}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b,d);var e=this.urls.autosuggest_ml+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(e,c)},a.Geocoder.prototype.standardblend=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");if(b){if(!b.hasOwnProperty("addr"))throw new Error("The params object is missing required addr property");if("string"!=typeof b.addr)throw new Error("params.addr must be a string");if(b.hasOwnProperty("focus")&&(b.focus=this._formatCoords(b.focus),null===b.focus))throw new Error("Invalid format coordinates for params.focus");if(!b.hasOwnProperty("lang"))throw new Error("The params object is missing required lang property");if("string"!=typeof b.lang)throw new Error("params.lang must be a string");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format)throw new Error('params.format must have a value of "json"')}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b);var d=this.urls.standardblend+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(d,c)},a.Geocoder.prototype.standardblend_ml=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");if(b){if(!b.hasOwnProperty("addr"))throw new Error("The params object is missing required addr property");if("string"!=typeof b.addr)throw new Error("params.addr must be a string");if(b.hasOwnProperty("focus")&&(b.focus=this._formatCoords(b.focus),null===b.focus))throw new Error("Invalid format coordinates for params.focus");if(!b.hasOwnProperty("lang"))throw new Error("The params object is missing required lang property");if("string"!=typeof b.lang)throw new Error("params.lang must be a string");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format)throw new Error('params.format must have a value of "json"')}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b);var d=this.urls.standardblend_ml+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(d,c)},a.Geocoder.prototype.grid=function(b,c){if("undefined"==typeof b||"object"!=typeof b)throw new Error("Missing or invalid params object");if(b){if(!b.hasOwnProperty("bbox"))throw new Error("The params object is missing required bbox property");if(b.bbox=this._formatBoundingBox(b.bbox),null===b.bbox)throw new Error("Invalid format coordinates for params.bbox");if(b.hasOwnProperty("format")){if("string"!=typeof b.format)throw new Error("params.format must be a string");if("json"!==b.format&&"geojson"!==b.format)throw new Error('params.format must have a value of "json" or "geojson"')}}if("undefined"==typeof c)throw new Error("Missing callback parameter");if("object"!=typeof c)throw new Error("Missing or invalid callback parameter");b=a.Utils.mergeOptions(this.options,b);var d=this.urls.grid+"?"+a.Utils.assembleQuery(b);a.Xhr.handleRequest(d,c)},a.Geocoder.prototype.languages=function(b){if("undefined"==typeof b)throw new Error("Missing callback parameter");if("object"!=typeof b)throw new Error("Missing or invalid callback parameter");var c={key:this.options.key},d=this.urls.languages+"?"+a.Utils.assembleQuery(c);a.Xhr.handleRequest(d,b)},a.Geocoder.prototype._formatCoords=function(a){return"object"==typeof a&&a instanceof Array&&2===a.length?a.join(","):"string"==typeof a||a.match(/^[-.0-9]{1,},[-.0-9]{1,}$/)?null:a},a.Geocoder.prototype._formatBoundingBox=function(a){return"object"==typeof a&&a instanceof Array&&4===a.length?a.join(","):"string"==typeof a||a.match(/^[-.0-9]{1,},[-.0-9]{1,},[-.0-9]{1,},[-.0-9]{1,}$/)?null:a}}();


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "w3w-javascript-wrapper",
 3 |   "version": "3.2.1",
 4 |   "description": "Javascript wrapper for the what3words API",
 5 |   "main": "dist/W3W.Geocoder.js",
 6 |   "scripts": {
 7 |     "test": "grunt test"
 8 |   },
 9 |   "repository": {
10 |     "type": "git",
11 |     "url": "git+https://github.com/what3words/w3w-javascript-wrapper.git"
12 |   },
13 |   "keywords": [
14 |     "what3words",
15 |     "api",
16 |     "javascript"
17 |   ],
18 |   "author": "Gary Gale <gary@vicchi.org> (http://www.garygale.com)",
19 |   "contributors": [
20 |     {
21 |       "name": "Gary Gale",
22 |       "email": "gary@vicchi.org"
23 |     },
24 |     {
25 |       "name": "Will Henderson",
26 |       "email": "will@what3words.com"
27 |     },
28 |     {
29 |       "name": "David Piesse"
30 |     },
31 |     {
32 |       "name": "Oliver Svenson"
33 |     },
34 |     {
35 |       "name": "Arnaud Ferrand",
36 |       "email": "arnaud@what3words.com"
37 |     }
38 |   ],
39 |   "license": "MIT",
40 |   "bugs": {
41 |     "url": "https://github.com/what3words/w3w-javascript-wrapper/issues"
42 |   },
43 |   "homepage": "https://github.com/what3words/w3w-javascript-wrapper#readme",
44 |   "devDependencies": {
45 |     "grunt": "^0.4.5",
46 |     "grunt-contrib-clean": "^1.0.0",
47 |     "grunt-contrib-concat": "^0.5.1",
48 |     "grunt-contrib-jasmine": "^1.0.3",
49 |     "grunt-contrib-jshint": "^0.11.2",
50 |     "grunt-contrib-uglify": "^0.9.1",
51 |     "grunt-contrib-watch": "^0.6.1",
52 |     "grunt-version": "^1.1.1",
53 |     "jasmine-expect": "^2.0.2",
54 |     "load-grunt-tasks": "^3.5.0"
55 |   },
56 |   "dependencies": {}
57 | }
58 | 


--------------------------------------------------------------------------------
/src/js/Bootstrap.js:
--------------------------------------------------------------------------------
 1 | /*jshint -W097 */
 2 | 'use strict';
 3 | 
 4 | var W3W = {
 5 |     version: '3.2.0'
 6 | };
 7 | 
 8 | if (typeof module === 'object' && typeof module.exports === 'object') {
 9 |     module.exports = W3W;
10 | }
11 | 
12 | else if (typeof define === 'function' && define.amd) {
13 |     define(W3W);
14 | }
15 | 
16 | if (typeof window !== 'undefined') {
17 |     var oldW3W = window.W3W;
18 | 
19 |     W3W.noConflict = function() {
20 |         window.W3W = oldW3W;
21 |         return this;
22 |     };
23 | 
24 |     window.W3W = W3W;
25 | }
26 | 


--------------------------------------------------------------------------------
/src/js/Geocoder.js:
--------------------------------------------------------------------------------
  1 | W3W.Geocoder = function(options) {
  2 |     this.base_url = 'https://api.what3words.com/v2/' ;
  3 | 
  4 |     if (typeof options === 'undefined') {
  5 |         throw new Error('Missing what3words options');
  6 |     }
  7 |     else if (options && !options.hasOwnProperty('key')) {
  8 |         throw new Error('Missing what3words API key');
  9 |     }
 10 |     this.options = {
 11 |         lang: 'en',
 12 |         format: 'json'
 13 |     };
 14 |     this.options = W3W.Utils.mergeOptions(this.options, options);
 15 |     if (this.options.hasOwnProperty('base_url')) {
 16 |         this.base_url = this.options.base_url;
 17 |         delete this.options.base_url;
 18 |     }
 19 |     this.urls = {
 20 |         forward: this.base_url + 'forward',
 21 |         reverse: this.base_url + 'reverse',
 22 |         autosuggest: this.base_url + 'autosuggest',
 23 |         standardblend: this.base_url + 'standardblend',
 24 |         autosuggest_ml: this.base_url + 'autosuggest-ml',
 25 |         standardblend_ml: this.base_url + 'standardblend-ml',
 26 |         grid: this.base_url + 'grid',
 27 |         languages: this.base_url + 'languages'
 28 |     };
 29 | };
 30 | 
 31 | // var params = {
 32 | //      addr: '3-word-address',
 33 | //      lang: 'en',
 34 | //      format: 'json|geojson'
 35 | // };
 36 | W3W.Geocoder.prototype.forward = function(params, callback) {
 37 |     if (typeof params === 'undefined' || typeof params !== 'object') {
 38 |         throw new Error('Missing or invalid params object');
 39 |     }
 40 | 
 41 |     if (params) {
 42 |         if (!params.hasOwnProperty('addr')) {
 43 |             throw new Error('The params object is missing required addr property');
 44 |         }
 45 |         else if (typeof params.addr !== 'string') {
 46 |             throw new Error('params.addr must be a string');
 47 |         }
 48 | 
 49 |         if (params.hasOwnProperty('lang') && typeof params.lang !== 'string') {
 50 |             throw new Error('params.lang must be a string');
 51 |         }
 52 | 
 53 |         if (params.hasOwnProperty('format')) {
 54 |             if (typeof params.format !== 'string') {
 55 |                 throw new Error('params.format must be a string');
 56 |             }
 57 |             else if (params.format !== 'json' && params.format !== 'geojson') {
 58 |                 throw new Error('params.format must have a value of "json" or "geojson"');
 59 |             }
 60 |         }
 61 |     }
 62 | 
 63 |     if (typeof callback === 'undefined') {
 64 |         throw new Error('Missing callback parameter');
 65 |     }
 66 |     else if (typeof callback !== 'object') {
 67 |         throw new Error('Missing or invalid callback parameter');
 68 |     }
 69 | 
 70 |     params = W3W.Utils.mergeOptions(this.options, params);
 71 |     var url = this.urls.forward + '?' + W3W.Utils.assembleQuery(params);
 72 |     W3W.Xhr.handleRequest(url, callback);
 73 | };
 74 | 
 75 | // var params = {
 76 | //      coords: [lat, long],
 77 | //      coords: 'lat,long',
 78 | //      lang: 'en',
 79 | //      format: 'json|geojson'
 80 | // };
 81 | W3W.Geocoder.prototype.reverse = function(params, callback) {
 82 |     if (typeof params === 'undefined' || typeof params !== 'object') {
 83 |         throw new Error('Missing or invalid params object');
 84 |     }
 85 | 
 86 |     if (params) {
 87 |         if (!params.hasOwnProperty('coords')) {
 88 |             throw new Error('The params object is missing required coords property');
 89 |         }
 90 |         else {
 91 |             params.coords = this._formatCoords(params.coords);
 92 |             if (null === params.coords) {
 93 |                 throw new Error('Invalid format coordinates for params.coords');
 94 |             }
 95 |         }
 96 | 
 97 |         if (params.hasOwnProperty('lang') && typeof params.lang !== 'string') {
 98 |             throw new Error('params.lang must be a string');
 99 |         }
100 | 
101 |         if (params.hasOwnProperty('format')) {
102 |             if (typeof params.format !== 'string') {
103 |                 throw new Error('params.format must be a string');
104 |             }
105 |             else if (params.format !== 'json' && params.format !== 'geojson') {
106 |                 throw new Error('params.format must have a value of "json" or "geojson"');
107 |             }
108 |         }
109 |     }
110 | 
111 |     if (typeof callback === 'undefined') {
112 |         throw new Error('Missing callback parameter');
113 |     }
114 |     else if (typeof callback !== 'object') {
115 |         throw new Error('Missing or invalid callback parameter');
116 |     }
117 | 
118 |     params = W3W.Utils.mergeOptions(this.options, params);
119 |     var url = this.urls.reverse + '?' + W3W.Utils.assembleQuery(params);
120 |     W3W.Xhr.handleRequest(url, callback);
121 | };
122 | 
123 | // var params = {
124 | //      lang: 'en',
125 | //      addr: '3-word-address'
126 | //     focus: [lat, lng],
127 | //     focus: 'lat,lng',
128 | //     clip: {
129 | //         type: 'none'
130 | //     }
131 | //     clip: {
132 | //         type: 'radius',
133 | //         focus: [lat, lng],
134 | //         focus: 'lat,lng',
135 | //         distance: km
136 | //     },
137 | //     clip: {
138 | //         type: 'focus'
139 | //         distance: km
140 | //     },
141 | //     clip: {
142 | //         type: 'bbox',
143 | //         bbox: [lat,lng,lat,lng],
144 | //         bbox: 'lat,lng,lat,lng'
145 | //     }
146 | // };
147 | W3W.Geocoder.prototype.autosuggest = function(params, callback) {
148 |     if (typeof params === 'undefined' || typeof params !== 'object') {
149 |         throw new Error('Missing or invalid params object');
150 |     }
151 | 
152 |     var clip = {};
153 | 
154 |     if (params) {
155 |         if (!params.hasOwnProperty('addr')) {
156 |             throw new Error('The params object is missing required addr property');
157 |         }
158 |         else if (typeof params.addr !== 'string') {
159 |             throw new Error('params.addr must be a string');
160 |         }
161 | 
162 |         if (params.hasOwnProperty('focus')) {
163 |             params.focus = this._formatCoords(params.focus);
164 |             if (null === params.focus) {
165 |                 throw new Error('Invalid format coordinates for params.focus');
166 |             }
167 |         }
168 | 
169 |         if (!params.hasOwnProperty('lang')) {
170 |             throw new Error('The params object is missing required lang property');
171 |         }
172 |         else if (typeof params.lang !== 'string') {
173 |             throw new Error('params.lang must be a string');
174 |         }
175 | 
176 |         if (params.hasOwnProperty('format')) {
177 |             if (typeof params.format !== 'string') {
178 |                 throw new Error('params.format must be a string');
179 |             }
180 |             else if (params.format !== 'json') {
181 |                 throw new Error('params.format must have a value of "json"');
182 |             }
183 |         }
184 | 
185 |         if (params.hasOwnProperty('clip')) {
186 |             if (!params.clip.hasOwnProperty('type')) {
187 |                 throw new Error('Invalid clipping policy type for params.clip');
188 |             }
189 | 
190 |             switch (params.clip.type) {
191 |                 case 'none':
192 |                     clip = {
193 |                         clip: 'none'
194 |                     };
195 |                     break;
196 | 
197 |                 case 'radius':
198 |                     if (!params.clip.hasOwnProperty('distance')) {
199 |                         throw new Error('Invalid clipping policy for type radius; missing distance property');
200 |                     }
201 | 
202 |                     else if (!params.clip.hasOwnProperty('focus')) {
203 |                         throw new Error('Invalid clipping policy for type radius; missing focus property');
204 | 
205 |                     }
206 | 
207 |                     else {
208 |                         params.clip.focus = this._formatCoords(params.clip.focus);
209 |                         if (null === params.focus) {
210 |                             throw new Error('Invalid format coordinates for params.clip.focus');
211 |                         }
212 |                     }
213 | 
214 |                     clip = {
215 |                         clip: 'radius(' + params.clip.focus + ',' + params.clip.distance + ')'
216 |                     };
217 |                     break;
218 | 
219 |                 case 'focus':
220 |                     if (!params.clip.hasOwnProperty('distance')) {
221 |                         throw new Error('Invalid clipping policy for type focus; missing distance property');
222 |                     }
223 |                     else if (!params.hasOwnProperty('focus') || params.focus === null) {
224 |                         throw new Error('Invalid clipping policy for type focus; missing or invalid focus property');
225 |                     }
226 | 
227 |                     clip = {
228 |                         clip: 'focus(' + params.clip.distance + ')'
229 |                     };
230 |                     break;
231 | 
232 |                 case 'bbox':
233 |                     if (!params.clip.hasOwnProperty('bbox')) {
234 |                         throw new Error('Invalid clipping policy for type bbox; missing bbox property');
235 |                     }
236 |                     params.clip.bbox = this._formatBoundingBox(params.clip.bbox);
237 |                     if (null === params.clip.bbox) {
238 |                         throw new Error('Invalid format coordinates for params.clip.bbox');
239 |                     }
240 | 
241 |                     clip = {
242 |                         clip: 'bbox(' + params.clip.bbox + ')'
243 |                     };
244 |                     break;
245 | 
246 |                 default:
247 |                     throw new Error('Invalid or unrecognised clipping policy type');
248 |             }
249 |         }
250 |     }
251 | 
252 |     if (typeof callback === 'undefined') {
253 |         throw new Error('Missing callback parameter');
254 |     }
255 |     else if (typeof callback !== 'object') {
256 |         throw new Error('Missing or invalid callback parameter');
257 |     }
258 | 
259 |     params = W3W.Utils.mergeOptions(this.options, params, clip);
260 |     var url = this.urls.autosuggest + '?' + W3W.Utils.assembleQuery(params);
261 |     W3W.Xhr.handleRequest(url, callback);
262 | };
263 | 
264 | // var params = {
265 | //      lang: 'en',
266 | //      addr: '3-word-address'
267 | //     focus: [lat, lng],
268 | //     focus: 'lat,lng',
269 | //     clip: {
270 | //         type: 'none'
271 | //     }
272 | //     clip: {
273 | //         type: 'radius',
274 | //         focus: [lat, lng],
275 | //         focus: 'lat,lng',
276 | //         distance: km
277 | //     },
278 | //     clip: {
279 | //         type: 'focus'
280 | //         distance: km
281 | //     },
282 | //     clip: {
283 | //         type: 'bbox',
284 | //         bbox: [lat,lng,lat,lng],
285 | //         bbox: 'lat,lng,lat,lng'
286 | //     }
287 | // };
288 | W3W.Geocoder.prototype.autosuggest_ml = function(params, callback) {
289 |     if (typeof params === 'undefined' || typeof params !== 'object') {
290 |         throw new Error('Missing or invalid params object');
291 |     }
292 | 
293 |     var clip = {};
294 | 
295 |     if (params) {
296 |         if (!params.hasOwnProperty('addr')) {
297 |             throw new Error('The params object is missing required addr property');
298 |         }
299 |         else if (typeof params.addr !== 'string') {
300 |             throw new Error('params.addr must be a string');
301 |         }
302 | 
303 |         if (params.hasOwnProperty('focus')) {
304 |             params.focus = this._formatCoords(params.focus);
305 |             if (null === params.focus) {
306 |                 throw new Error('Invalid format coordinates for params.focus');
307 |             }
308 |         }
309 | 
310 |         if (!params.hasOwnProperty('lang')) {
311 |             throw new Error('The params object is missing required lang property');
312 |         }
313 |         else if (typeof params.lang !== 'string') {
314 |             throw new Error('params.lang must be a string');
315 |         }
316 | 
317 |         if (params.hasOwnProperty('format')) {
318 |             if (typeof params.format !== 'string') {
319 |                 throw new Error('params.format must be a string');
320 |             }
321 |             else if (params.format !== 'json') {
322 |                 throw new Error('params.format must have a value of "json"');
323 |             }
324 |         }
325 | 
326 |         if (params.hasOwnProperty('clip')) {
327 |             if (!params.clip.hasOwnProperty('type')) {
328 |                 throw new Error('Invalid clipping policy type for params.clip');
329 |             }
330 | 
331 |             switch (params.clip.type) {
332 |                 case 'none':
333 |                     clip = {
334 |                         clip: 'none'
335 |                     };
336 |                     break;
337 | 
338 |                 case 'radius':
339 |                     if (!params.clip.hasOwnProperty('distance')) {
340 |                         throw new Error('Invalid clipping policy for type radius; missing distance property');
341 |                     }
342 | 
343 |                     else if (!params.clip.hasOwnProperty('focus')) {
344 |                         throw new Error('Invalid clipping policy for type radius; missing focus property');
345 | 
346 |                     }
347 | 
348 |                     else {
349 |                         params.clip.focus = this._formatCoords(params.clip.focus);
350 |                         if (null === params.focus) {
351 |                             throw new Error('Invalid format coordinates for params.clip.focus');
352 |                         }
353 |                     }
354 | 
355 |                     clip = {
356 |                         clip: 'radius(' + params.clip.focus + ',' + params.clip.distance + ')'
357 |                     };
358 |                     break;
359 | 
360 |                 case 'focus':
361 |                     if (!params.clip.hasOwnProperty('distance')) {
362 |                         throw new Error('Invalid clipping policy for type focus; missing distance property');
363 |                     }
364 |                     else if (!params.hasOwnProperty('focus') || params.focus === null) {
365 |                         throw new Error('Invalid clipping policy for type focus; missing or invalid focus property');
366 |                     }
367 | 
368 |                     clip = {
369 |                         clip: 'focus(' + params.clip.distance + ')'
370 |                     };
371 |                     break;
372 | 
373 |                 case 'bbox':
374 |                     if (!params.clip.hasOwnProperty('bbox')) {
375 |                         throw new Error('Invalid clipping policy for type bbox; missing bbox property');
376 |                     }
377 |                     params.clip.bbox = this._formatBoundingBox(params.clip.bbox);
378 |                     if (null === params.clip.bbox) {
379 |                         throw new Error('Invalid format coordinates for params.clip.bbox');
380 |                     }
381 | 
382 |                     clip = {
383 |                         clip: 'bbox(' + params.clip.bbox + ')'
384 |                     };
385 |                     break;
386 | 
387 |                 default:
388 |                     throw new Error('Invalid or unrecognised clipping policy type');
389 |             }
390 |         }
391 |     }
392 | 
393 |     if (typeof callback === 'undefined') {
394 |         throw new Error('Missing callback parameter');
395 |     }
396 |     else if (typeof callback !== 'object') {
397 |         throw new Error('Missing or invalid callback parameter');
398 |     }
399 | 
400 |     params = W3W.Utils.mergeOptions(this.options, params, clip);
401 |     var url = this.urls.autosuggest_ml + '?' + W3W.Utils.assembleQuery(params);
402 |     W3W.Xhr.handleRequest(url, callback);
403 | };
404 | 
405 | // var params = {
406 | //      addr: '3-word-address',
407 | //      lang: 'en',
408 | //      focus: '[lat, lng]
409 | // };
410 | W3W.Geocoder.prototype.standardblend = function(params, callback) {
411 |     if (typeof params === 'undefined' || typeof params !== 'object') {
412 |         throw new Error('Missing or invalid params object');
413 |     }
414 | 
415 |     if (params) {
416 |         if (!params.hasOwnProperty('addr')) {
417 |             throw new Error('The params object is missing required addr property');
418 |         }
419 |         else if (typeof params.addr !== 'string') {
420 |             throw new Error('params.addr must be a string');
421 |         }
422 | 
423 |         if (params.hasOwnProperty('focus')) {
424 |             params.focus = this._formatCoords(params.focus);
425 |             if (null === params.focus) {
426 |                 throw new Error('Invalid format coordinates for params.focus');
427 |             }
428 |         }
429 | 
430 |         if (!params.hasOwnProperty('lang')) {
431 |             throw new Error('The params object is missing required lang property');
432 |         }
433 |         else if (typeof params.lang !== 'string') {
434 |             throw new Error('params.lang must be a string');
435 |         }
436 | 
437 |         if (params.hasOwnProperty('format')) {
438 |             if (typeof params.format !== 'string') {
439 |                 throw new Error('params.format must be a string');
440 |             }
441 |             else if (params.format !== 'json') {
442 |                 throw new Error('params.format must have a value of "json"');
443 |             }
444 |         }
445 |     }
446 | 
447 |     if (typeof callback === 'undefined') {
448 |         throw new Error('Missing callback parameter');
449 |     }
450 |     else if (typeof callback !== 'object') {
451 |         throw new Error('Missing or invalid callback parameter');
452 |     }
453 | 
454 |     params = W3W.Utils.mergeOptions(this.options, params);
455 |     var url = this.urls.standardblend + '?' + W3W.Utils.assembleQuery(params);
456 |     W3W.Xhr.handleRequest(url, callback);
457 | };
458 | 
459 | // var params = {
460 | //      addr: '3-word-address',
461 | //      lang: 'en',
462 | //      focus: '[lat, lng]
463 | // };
464 | W3W.Geocoder.prototype.standardblend_ml = function(params, callback) {
465 |     if (typeof params === 'undefined' || typeof params !== 'object') {
466 |         throw new Error('Missing or invalid params object');
467 |     }
468 | 
469 |     if (params) {
470 |         if (!params.hasOwnProperty('addr')) {
471 |             throw new Error('The params object is missing required addr property');
472 |         }
473 |         else if (typeof params.addr !== 'string') {
474 |             throw new Error('params.addr must be a string');
475 |         }
476 | 
477 |         if (params.hasOwnProperty('focus')) {
478 |             params.focus = this._formatCoords(params.focus);
479 |             if (null === params.focus) {
480 |                 throw new Error('Invalid format coordinates for params.focus');
481 |             }
482 |         }
483 | 
484 |         if (!params.hasOwnProperty('lang')) {
485 |             throw new Error('The params object is missing required lang property');
486 |         }
487 |         else if (typeof params.lang !== 'string') {
488 |             throw new Error('params.lang must be a string');
489 |         }
490 | 
491 |         if (params.hasOwnProperty('format')) {
492 |             if (typeof params.format !== 'string') {
493 |                 throw new Error('params.format must be a string');
494 |             }
495 |             else if (params.format !== 'json') {
496 |                 throw new Error('params.format must have a value of "json"');
497 |             }
498 |         }
499 |     }
500 | 
501 |     if (typeof callback === 'undefined') {
502 |         throw new Error('Missing callback parameter');
503 |     }
504 |     else if (typeof callback !== 'object') {
505 |         throw new Error('Missing or invalid callback parameter');
506 |     }
507 | 
508 |     params = W3W.Utils.mergeOptions(this.options, params);
509 |     var url = this.urls.standardblend_ml + '?' + W3W.Utils.assembleQuery(params);
510 |     W3W.Xhr.handleRequest(url, callback);
511 | };
512 | 
513 | // var params = {
514 | //      bbox: [nelat, nelng, swlat, swlng],
515 | //      format: 'json|geojson'
516 | // };
517 | W3W.Geocoder.prototype.grid = function(params, callback) {
518 |     if (typeof params === 'undefined' || typeof params !== 'object') {
519 |         throw new Error('Missing or invalid params object');
520 |     }
521 | 
522 |     if (params) {
523 |         if (!params.hasOwnProperty('bbox')) {
524 |             throw new Error('The params object is missing required bbox property');
525 |         }
526 | 
527 |         params.bbox = this._formatBoundingBox(params.bbox);
528 |         if (null === params.bbox) {
529 |             throw new Error('Invalid format coordinates for params.bbox');
530 |         }
531 | 
532 |         if (params.hasOwnProperty('format')) {
533 |             if (typeof params.format !== 'string') {
534 |                 throw new Error('params.format must be a string');
535 |             }
536 |             else if (params.format !== 'json' && params.format !== 'geojson') {
537 |                 throw new Error('params.format must have a value of "json" or "geojson"');
538 |             }
539 |         }
540 |     }
541 | 
542 |     if (typeof callback === 'undefined') {
543 |         throw new Error('Missing callback parameter');
544 |     }
545 |     else if (typeof callback !== 'object') {
546 |         throw new Error('Missing or invalid callback parameter');
547 |     }
548 | 
549 |     params = W3W.Utils.mergeOptions(this.options, params);
550 |     var url = this.urls.grid + '?' + W3W.Utils.assembleQuery(params);
551 |     W3W.Xhr.handleRequest(url, callback);
552 | };
553 | 
554 | W3W.Geocoder.prototype.languages = function(callback) {
555 |     if (typeof callback === 'undefined') {
556 |         throw new Error('Missing callback parameter');
557 |     }
558 |     else if (typeof callback !== 'object') {
559 |         throw new Error('Missing or invalid callback parameter');
560 |     }
561 | 
562 |     var params = {
563 |         key: this.options.key
564 |     };
565 |     var url = this.urls.languages + '?' + W3W.Utils.assembleQuery(params);
566 |     W3W.Xhr.handleRequest(url, callback);
567 | };
568 | 
569 | W3W.Geocoder.prototype._formatCoords = function(coords) {
570 |     if (typeof coords === 'object' && coords instanceof Array && coords.length === 2) {
571 |         return coords.join(',');
572 |     }
573 |     else if (typeof coords !== 'string' && !coords.match(/^[-.0-9]{1,},[-.0-9]{1,}$/)) {
574 |         return coords;
575 |     }
576 | 
577 |     return null;
578 | };
579 | 
580 | W3W.Geocoder.prototype._formatBoundingBox = function(coords) {
581 |     if (typeof coords === 'object' && coords instanceof Array && coords.length === 4) {
582 |         return coords.join(',');
583 |     }
584 |     else if (typeof coords !== 'string' && !coords.match(/^[-.0-9]{1,},[-.0-9]{1,},[-.0-9]{1,},[-.0-9]{1,}$/)) {
585 |         return coords;
586 |     }
587 | 
588 |     return null;
589 | };
590 | 


--------------------------------------------------------------------------------
/src/js/Utils.js:
--------------------------------------------------------------------------------
 1 | W3W.Utils = {
 2 |     mergeOptions: function(dest) {
 3 |         var i;
 4 |         var j;
 5 |         var len;
 6 |         var src;
 7 | 
 8 |         var options = JSON.parse(JSON.stringify(dest));
 9 | 
10 |         for (i=1, len = arguments.length; i<len; i++) {
11 |             src = arguments[i];
12 |             for (j in src) {
13 |                 options[j] = src[j];
14 |             }
15 |         }
16 |         return options;
17 |     },
18 | 
19 |     assembleQuery: function(params) {
20 |         var query = [];
21 |         for (var key in params) {
22 |             query.push(key + '=' + encodeURIComponent(params[key]));
23 |         }
24 |         return query.join('&');
25 |     }
26 | };
27 | 


--------------------------------------------------------------------------------
/src/js/Xhr.js:
--------------------------------------------------------------------------------
 1 | W3W.Xhr = {
 2 |     getXhr: function() {
 3 |         if (window.XMLHttpRequest) {
 4 |             return window.XMLHttpRequest;
 5 |         }
 6 |         else {
 7 |             if (window.ActiveXObject) {
 8 |                 try {
 9 |                     return new ActiveXObject('MSxml2.XMLHTTP');
10 |                 }
11 |                 catch (e) {
12 |                     try {
13 |                         return new ActiveXObject('Microsoft.XMLHTTP');
14 |                     }
15 |                     catch (exc) {
16 |                         return false;
17 |                     }
18 |                 }
19 |             }
20 | 
21 |             return false;
22 |         }
23 |     },
24 | 
25 |     handleRequest: function(url, callback, method, body) {
26 |         var xhr = new XMLHttpRequest();
27 |         method = (method) ? method : 'GET';
28 | 
29 |         xhr.open(method, url, true);
30 |         xhr.onreadystatechange = function(event) {
31 |             var json;
32 |             if (xhr.readyState == 4) {
33 |                 if (xhr.status == 200) {
34 |                     json = JSON.parse(xhr.responseText);
35 |                     if (json.hasOwnProperty('error') && callback.onFailure) {
36 |                         callback.onFailure(json);
37 |                     }
38 |                     else if (callback.onSuccess) {
39 |                         callback.onSuccess(json);
40 |                     }
41 |                 }
42 |                 else {
43 |                     if (callback.onFailure) {
44 |                         json = JSON.parse(xhr.responseText);
45 |                         callback.onFailure(json);
46 |                     }
47 |                 }
48 |             }
49 |         };
50 | 
51 |         if (body) {
52 |             xhr.setRequestHeader('Content-Length', body.length);
53 |             xhr.send(body);
54 |         }
55 |         else {
56 |             xhr.send();
57 |         }
58 |     }
59 | };
60 | 


--------------------------------------------------------------------------------
/test/js/specs/environment.spec.js:
--------------------------------------------------------------------------------
1 | describe('what3words', function () {
2 |     it('should find secure environment variables', function() {
3 |         expect(W3W_API_KEY).toBeDefined();
4 |     });
5 |     it('should find non-empty secure environment variables', function() {
6 |         expect(W3W_API_KEY).not.toBe('');
7 |     });
8 | });
9 | 


--------------------------------------------------------------------------------
/test/js/specs/geocoder.fr.spec.js:
--------------------------------------------------------------------------------
  1 | validateJSONPayloadFR = function(data) {
  2 |     validateHTTPStatus(data);
  3 |     expect(data.crs).toBeDefined();
  4 |     expect(data.words).toBeDefined();
  5 |     expect(data.words).toEqual('bassin.casanier.onction');
  6 |     expect(data.bounds).toBeDefined();
  7 |     expect(data.bounds.southwest).toBeDefined();
  8 |     expect(data.bounds.southwest.lng).toBeDefined();
  9 |     expect(data.bounds.southwest.lat).toBeDefined();
 10 |     expect(data.bounds.southwest.lng).toEqual(5.724518);
 11 |     expect(data.bounds.southwest.lat).toEqual(45.188524);
 12 |     expect(data.bounds.northeast).toBeDefined();
 13 |     expect(data.bounds.northeast.lng).toBeDefined();
 14 |     expect(data.bounds.northeast.lat).toBeDefined();
 15 |     expect(data.bounds.northeast.lng).toEqual(5.724556);
 16 |     expect(data.bounds.northeast.lat).toEqual(45.188551);
 17 |     expect(data.geometry).toBeDefined();
 18 |     expect(data.geometry.lng).toBeDefined();
 19 |     expect(data.geometry.lat).toBeDefined();
 20 |     expect(data.geometry.lng).toEqual(5.724537);
 21 |     expect(data.geometry.lat).toEqual(45.188538);
 22 |     expect(data.language).toBeDefined();
 23 |     expect(data.language).toEqual('fr');
 24 |     expect(data.map).toBeDefined();
 25 |     expect(data.map).toEqual('http://w3w.co/bassin.casanier.onction');
 26 | };
 27 | 
 28 | describe('what3words in french', function() {
 29 |     describe('#forward', function() {
 30 |         var what3words;
 31 |         var options = {
 32 |             key: W3W_API_KEY
 33 |         };
 34 | 
 35 |         beforeEach(function() {
 36 |             what3words = new W3W.Geocoder(options);
 37 |         });
 38 | 
 39 |         it('should forward geocode bassin.casanier.onction', function(done) {
 40 |             var callback = {
 41 |                 onSuccess: function(data) {
 42 |                     validateJSONPayloadFR(data);
 43 |                     done();
 44 |                 },
 45 |                 onFailure: function(data) {
 46 |                     validateHTTPStatus(data);
 47 |                     done();
 48 |                 }
 49 |             };
 50 |             var params = {
 51 |                 addr: 'bassin.casanier.onction',
 52 |                 lang: 'fr'
 53 |             };
 54 |             what3words.forward(params, callback);
 55 |         });
 56 |     });
 57 | 
 58 |     describe('#reverse', function() {
 59 |         var what3words;
 60 |         var options = {
 61 |             key: W3W_API_KEY
 62 |         };
 63 | 
 64 |         beforeEach(function() {
 65 |             what3words = new W3W.Geocoder(options);
 66 |         });
 67 | 
 68 |         it('should reverse geocode 45.188538, 5.724537', function(done) {
 69 |             var callback = {
 70 |                 onSuccess: function(data) {
 71 |                     validateJSONPayloadFR(data);
 72 |                     done();
 73 |                 },
 74 |                 onFailure: function(data) {
 75 |                     expect(data.status.status).toEqual(200);
 76 |                     done();
 77 |                 }
 78 |             };
 79 |             var params = {
 80 |                 coords: [45.188538, 5.724537],
 81 |                 lang: 'fr'
 82 |             };
 83 |             what3words.reverse(params, callback);
 84 |         });
 85 |     });
 86 | 
 87 |     describe('#standardblend', function() {
 88 |         var what3words;
 89 |         var options = {
 90 |             key: W3W_API_KEY
 91 |         };
 92 | 
 93 |         beforeEach(function() {
 94 |             what3words = new W3W.Geocoder(options);
 95 |         });
 96 | 
 97 |         it('should return a standardblend for bassin.casanier.onction with a focus of 45.188538, 5.724537', function(done) {
 98 |             var callback = {
 99 |                 onSuccess: function(data) {
100 |                     validateHTTPStatus(data);
101 | 
102 |                     expect(data.blends).toBeDefined();
103 |                     expect(data.blends).toBeArray();
104 |                     expect(data.blends.length).toEqual(3);
105 |                     expect(data.blends[0].words).toEqual('bassin.casanier.onction');
106 |                     expect(data.blends[1].words).toEqual('bassin.casanier.oncle');
107 |                     expect(data.blends[2].words).toEqual('bassin.casanier.noce');
108 |                     done();
109 |                 },
110 |                 onFailure: function(data) {
111 |                     validateHTTPStatus(data);
112 |                     done();
113 |                 }
114 |             };
115 |             var params = {
116 |                 addr: 'bassin.casanier.oncti',
117 |                 lang: 'fr',
118 |                 focus: [45.188538, 5.724537]
119 |             };
120 |             what3words.standardblend(params, callback);
121 |         });
122 |     });
123 | 
124 | 
125 | });
126 | 


--------------------------------------------------------------------------------
/test/js/specs/geocoder.spec.js:
--------------------------------------------------------------------------------
  1 | validateHTTPStatus = function(data) {
  2 |     expect(data.status).toBeDefined();
  3 |     expect(data.status.status).toBeDefined();
  4 |     expect(data.status.status).toEqual(200);
  5 | };
  6 | 
  7 | validateHTTPPropertyStatus = function(data) {
  8 |     expect(data.properties).toBeDefined();
  9 |     expect(data.properties.status).toBeDefined();
 10 |     expect(data.properties.status.status).toBeDefined();
 11 |     expect(data.properties.status.status).toEqual(200);
 12 | };
 13 | 
 14 | validateJSONPayload = function(data) {
 15 |     validateHTTPStatus(data);
 16 |     expect(data.crs).toBeDefined();
 17 |     expect(data.words).toBeDefined();
 18 |     expect(data.words).toEqual('index.home.raft');
 19 |     expect(data.bounds).toBeDefined();
 20 |     expect(data.bounds.southwest).toBeDefined();
 21 |     expect(data.bounds.southwest.lng).toBeDefined();
 22 |     expect(data.bounds.southwest.lat).toBeDefined();
 23 |     expect(data.bounds.southwest.lng).toEqual(-0.203607);
 24 |     expect(data.bounds.southwest.lat).toEqual(51.521238);
 25 |     expect(data.bounds.northeast).toBeDefined();
 26 |     expect(data.bounds.northeast.lng).toBeDefined();
 27 |     expect(data.bounds.northeast.lat).toBeDefined();
 28 |     expect(data.bounds.northeast.lng).toEqual(-0.203564);
 29 |     expect(data.bounds.northeast.lat).toEqual(51.521265);
 30 |     expect(data.geometry).toBeDefined();
 31 |     expect(data.geometry.lng).toBeDefined();
 32 |     expect(data.geometry.lat).toBeDefined();
 33 |     expect(data.geometry.lng).toEqual(-0.203586);
 34 |     expect(data.geometry.lat).toEqual(51.521251);
 35 |     expect(data.language).toBeDefined();
 36 |     expect(data.language).toEqual('en');
 37 |     expect(data.map).toBeDefined();
 38 |     expect(data.map).toEqual('http://w3w.co/index.home.raft');
 39 | };
 40 | 
 41 | validateGeoJSONPayload = function(data) {
 42 |     validateHTTPPropertyStatus(data);
 43 |     expect(data.crs).toBeDefined();
 44 |     expect(data.crs.type).toBeDefined();
 45 |     expect(data.crs.type).toEqual('link');
 46 |     expect(data.crs.properties.href).toBeDefined();
 47 |     expect(data.crs.properties.href).toEqual('http://spatialreference.org/ref/epsg/4326/ogcwkt/');
 48 |     expect(data.crs.properties.type).toBeDefined();
 49 |     expect(data.crs.properties.type).toEqual('ogcwkt');
 50 |     expect(data.crs.properties).toBeDefined();
 51 |     expect(data.bbox).toBeDefined();
 52 |     expect(data.bbox).toEqual([-0.203607, 51.521238, -0.203564, 51.521265]);
 53 |     expect(data.geometry).toBeDefined();
 54 |     expect(data.geometry.coordinates).toBeDefined();
 55 |     expect(data.geometry.coordinates).toEqual([-0.203586, 51.521251]);
 56 |     expect(data.geometry.type).toBeDefined();
 57 |     expect(data.geometry.type).toEqual('Point');
 58 |     expect(data.type).toBeDefined();
 59 |     expect(data.type).toEqual('Feature');
 60 |     expect(data.properties).toBeDefined();
 61 |     expect(data.properties.words).toBeDefined();
 62 |     expect(data.properties.words).toEqual('index.home.raft');
 63 |     expect(data.properties.language).toBeDefined();
 64 |     expect(data.properties.language).toEqual('en');
 65 |     expect(data.properties.map).toBeDefined();
 66 |     expect(data.properties.map).toEqual('http://w3w.co/index.home.raft');
 67 |     expect(data.properties.thanks).toBeDefined();
 68 | };
 69 | 
 70 | describe('what3words', function() {
 71 |     describe('initialisation and loading', function() {
 72 |         it('should be available as a function', function() {
 73 |             expect(typeof W3W.Geocoder).toEqual('function');
 74 |         });
 75 |     });
 76 | 
 77 |     describe('constructor exceptions', function() {
 78 |         var what3words;
 79 |         var options;
 80 | 
 81 |         missingOptions = function() {
 82 |             what3words = new W3W.Geocoder();
 83 |         };
 84 | 
 85 |         missingApiKey = function() {
 86 |             options = {};
 87 |             what3words = new W3W.Geocoder(options);
 88 |         };
 89 | 
 90 |         it('should throw Error when missing options', function() {
 91 |             expect(missingOptions).toThrowError(Error);
 92 |         });
 93 | 
 94 |         it('should throw Error when missing API key in options', function() {
 95 |             expect(missingApiKey).toThrowError(Error);
 96 |         });
 97 |     });
 98 | 
 99 |     describe('construction', function() {
100 |         var what3words;
101 | 
102 |         beforeEach(function() {
103 |             what3words = new W3W.Geocoder({
104 |                 key: W3W_API_KEY
105 |             });
106 |         });
107 | 
108 |         it('should be instance of W3W.Geocoder', function() {
109 |             // expect(what3words).to.be.an.instanceof(W3W.Geocoder);
110 |             expect(what3words).toEqual(jasmine.any(W3W.Geocoder));
111 |         });
112 |     });
113 | 
114 |     describe('#forward', function() {
115 |         var what3words;
116 | 
117 |         beforeEach(function() {
118 |             what3words = new W3W.Geocoder({
119 |                 key: W3W_API_KEY
120 |             });
121 |         });
122 | 
123 |         it('should forward geocode index.home.raft defaulting to JSON', function(done) {
124 |             var callback = {
125 |                 onSuccess: function(data) {
126 |                     validateJSONPayload(data);
127 |                     done();
128 |                 },
129 |                 onFailure: function(data) {
130 |                     validateHTTPStatus(data);
131 |                     done();
132 |                 }
133 |             };
134 | 
135 |             var params = {
136 |                 addr: 'index.home.raft'
137 |             };
138 | 
139 |             what3words.forward(params, callback);
140 |         });
141 | 
142 |         it('should forward geocode index.home.raft in JSON', function(done) {
143 |             var callback = {
144 |                 onSuccess: function(data) {
145 |                     validateJSONPayload(data);
146 |                     done();
147 |                 },
148 |                 onFailure: function(data) {
149 |                     validateHTTPStatus(data);
150 |                     done();
151 |                 }
152 |             };
153 | 
154 |             var params = {
155 |                 addr: 'index.home.raft',
156 |                 format: 'json'
157 |             };
158 | 
159 |             what3words.forward(params, callback);
160 |         });
161 | 
162 |         it('should forward geocode index.home.raft in GeoJSON ', function(done) {
163 |             var callback = {
164 |                 onSuccess: function(data) {
165 |                     validateGeoJSONPayload(data);
166 |                     done();
167 |                 },
168 |                 onFailure: function(data) {
169 |                     validateHTTPStatus(data);
170 |                     done();
171 |                 }
172 |             };
173 | 
174 |             var params = {
175 |                 addr: 'index.home.raft',
176 |                 format: 'geojson'
177 |             };
178 | 
179 |             what3words.forward(params, callback);
180 |         });
181 | 
182 |         it ('should catch an Error exception when an invalid format of type "xml" is requested', function(done) {
183 |             var callback = {
184 |                 onSuccess: function(data) {
185 |                     throw new Error('onSuccess should never be invoked');
186 |                 },
187 |                 onFailure: function(data) {
188 |                     throw new Error('onFailure should never be invoked');
189 |                 }
190 |             };
191 | 
192 |             var params = {
193 |                 addr: 'index.home.raft',
194 |                 format: 'xml'
195 |             };
196 | 
197 |             expect(function() {
198 |                 what3words.forward(params, callback);
199 |             }).toThrow(new Error('params.format must have a value of "json" or "geojson"'));
200 |             done();
201 |         });
202 |     });
203 | 
204 |     describe('#reverse', function() {
205 |         var what3words;
206 | 
207 |         beforeEach(function() {
208 |             what3words = new W3W.Geocoder({
209 |                 key: W3W_API_KEY
210 |             });
211 |         });
212 | 
213 |         it('should reverse geocode [51.521251, -0.203586] defaulting to JSON', function(done) {
214 |             var callback = {
215 |                 onSuccess: function(data) {
216 |                     validateJSONPayload(data);
217 |                     done();
218 |                 },
219 |                 onFailure: function(data) {
220 |                     expect(data.status.status).toEqual(200);
221 |                     done();
222 |                 }
223 |             };
224 | 
225 |             var params = {
226 |                 coords: [51.521251, -0.203586]
227 |             };
228 | 
229 |             what3words.reverse(params, callback);
230 |         });
231 | 
232 |         it('should reverse geocode [51.521251, -0.203586] in JSON', function(done) {
233 |             var callback = {
234 |                 onSuccess: function(data) {
235 |                     validateJSONPayload(data);
236 |                     done();
237 |                 },
238 |                 onFailure: function(data) {
239 |                     expect(data.status.status).toEqual(200);
240 |                     done();
241 |                 }
242 |             };
243 | 
244 |             var params = {
245 |                 coords: [51.521251, -0.203586],
246 |                 format: 'json'
247 |             };
248 | 
249 |             what3words.reverse(params, callback);
250 |         });
251 | 
252 |         it('should reverse geocode [51.521251, -0.203586] in GeoJSON', function(done) {
253 |             var callback = {
254 |                 onSuccess: function(data) {
255 |                     validateGeoJSONPayload(data);
256 |                     done();
257 |                 },
258 |                 onFailure: function(data) {
259 |                     expect(data.status.status).toEqual(200);
260 |                     done();
261 |                 }
262 |             };
263 | 
264 |             var params = {
265 |                 coords: [51.521251, -0.203586],
266 |                 format: 'geojson'
267 |             };
268 | 
269 |             what3words.reverse(params, callback);
270 |         });
271 | 
272 |         it ('should catch an Error exception when an invalid format of type "xml" is requested', function(done) {
273 |             var callback = {
274 |                 onSuccess: function(data) {
275 |                     throw new Error('onSuccess should never be invoked');
276 |                 },
277 |                 onFailure: function(data) {
278 |                     throw new Error('onFailure should never be invoked');
279 |                 }
280 |             };
281 | 
282 |             var params = {
283 |                 coords: [51.521251, -0.203586],
284 |                 format: 'xml'
285 |             };
286 | 
287 |             expect(function() {
288 |                 what3words.reverse(params, callback);
289 |             }).toThrow(new Error('params.format must have a value of "json" or "geojson"'));
290 |             done();
291 |         });
292 |     });
293 | 
294 |     describe('#autosuggest', function() {
295 |         var what3words;
296 | 
297 |         beforeEach(function() {
298 |             what3words = new W3W.Geocoder({
299 |                 key: W3W_API_KEY
300 |             });
301 |         });
302 | 
303 |         it('should autosuggest plan.clips.a with no focus and no clipping', function(done) {
304 |             var callback = {
305 |                 onSuccess: function(data) {
306 |                     validateHTTPStatus(data);
307 |                     expect(data.suggestions).toBeDefined();
308 |                     expect(data.suggestions.length).toEqual(3);
309 |                     expect(data.suggestions[0].words).toEqual('plan.clips.also');
310 |                     expect(data.suggestions[1].words).toEqual('plan.clips.back');
311 |                     expect(data.suggestions[2].words).toEqual('plan.clips.each');
312 |                     done();
313 |                 },
314 |                 onFailure: function(data) {
315 |                     validateHTTPStatus(data);
316 |                     done();
317 |                 }
318 |             };
319 | 
320 |             var params = {
321 |                 addr: 'plan.clips.a',
322 |                 lang: 'en',
323 |                 clip: {
324 |                     type: 'none'
325 |                 }
326 |             };
327 | 
328 |             what3words.autosuggest(params, callback);
329 |         });
330 | 
331 |         it('should autosuggest plan.clips.a with focus and no clipping', function(done) {
332 |             var callback = {
333 |                 onSuccess: function(data) {
334 |                     validateHTTPStatus(data);
335 |                     expect(data.suggestions).toBeDefined();
336 |                     expect(data.suggestions.length).toEqual(3);
337 |                     expect(data.suggestions[0].words).toEqual('plan.clips.area');
338 |                     expect(data.suggestions[1].words).toEqual('plan.clips.arts');
339 |                     expect(data.suggestions[2].words).toEqual('plan.slips.cage');
340 |                     done();
341 |                 },
342 |                 onFailure: function(data) {
343 |                     validateHTTPStatus(data);
344 |                     done();
345 |                 }
346 |             };
347 | 
348 |             var params = {
349 |                 addr: 'plan.clips.a',
350 |                 focus: [51.521251, -0.203586],
351 |                 lang: 'en',
352 |                 clip: {
353 |                     type: 'none'
354 |                 }
355 |             };
356 | 
357 |             what3words.autosuggest(params, callback);
358 |         });
359 | 
360 |         it('should autosuggest plan.clips.a with focus and clip=focus(100)', function(done) {
361 |             var callback = {
362 |                 onSuccess: function(data) {
363 |                     validateHTTPStatus(data);
364 |                     expect(data.suggestions).toBeDefined();
365 |                     expect(data.suggestions.length).toEqual(3);
366 |                     expect(data.suggestions[0].words).toEqual('plan.clips.area');
367 |                     expect(data.suggestions[1].words).toEqual('plan.clips.arts');
368 |                     expect(data.suggestions[2].words).toEqual('plan.slips.cage');
369 |                     done();
370 |                 },
371 |                 onFailure: function(data) {
372 |                     validateHTTPStatus(data);
373 |                     done();
374 |                 }
375 |             };
376 | 
377 |             var params = {
378 |                 addr: 'plan.clips.a',
379 |                 focus: [51.521251, -0.203586],
380 |                 lang: 'en',
381 |                 clip: {
382 |                     type: 'focus',
383 |                     distance: 100
384 |                 }
385 |             };
386 | 
387 |             what3words.autosuggest(params, callback);
388 |         });
389 | 
390 |         it('should autosuggest plan.clips.a with no focus and clip=radius(51.521251,-0.203586,100)', function(done) {
391 |             var callback = {
392 |                 onSuccess: function(data) {
393 |                     validateHTTPStatus(data);
394 |                     expect(data.suggestions).toBeDefined();
395 |                     expect(data.suggestions.length).toEqual(3);
396 |                     expect(data.suggestions[0].words).toEqual('plan.clips.area');
397 |                     expect(data.suggestions[1].words).toEqual('plan.clips.arts');
398 |                     expect(data.suggestions[2].words).toEqual('plan.slips.cage');
399 |                     done();
400 |                 },
401 |                 onFailure: function(data) {
402 |                     validateHTTPStatus(data);
403 |                     done();
404 |                 }
405 |             };
406 | 
407 |             var params = {
408 |                 addr: 'plan.clips.a',
409 |                 lang: 'en',
410 |                 clip: {
411 |                     type: 'radius',
412 |                     focus: [51.521251, -0.203586],
413 |                     distance: 100
414 |                 }
415 |             };
416 | 
417 |             what3words.autosuggest(params, callback);
418 |         });
419 | 
420 |         it('should autosuggest plan.clips.a with focus of 51.4243877,-0.3474524 and clip=bbox(54,2,50,-4)', function(done) {
421 |             var callback = {
422 |                 onSuccess: function(data) {
423 |                     validateHTTPStatus(data);
424 |                     expect(data.suggestions).toBeDefined();
425 |                     expect(data.suggestions.length).toEqual(3);
426 |                     expect(data.suggestions[0].words).toEqual('plan.clips.area');
427 |                     expect(data.suggestions[1].words).toEqual('plan.flips.dawn');
428 |                     expect(data.suggestions[2].words).toEqual('plan.clips.arts');
429 |                     done();
430 |                 },
431 |                 onFailure: function(data) {
432 |                     validateHTTPStatus(data);
433 |                     done();
434 |                 }
435 |             };
436 | 
437 |             var params = {
438 |                 addr: 'plan.clips.a',
439 |                 lang: 'en',
440 |                 focus: [51.4243877, -0.3474524],
441 |                 clip: {
442 |                     type: 'bbox',
443 |                     bbox: [54, 2, 50, -4]
444 |                 }
445 |             };
446 | 
447 |             what3words.autosuggest(params, callback);
448 |         });
449 |     });
450 | 
451 |     describe('#autosuggest-ml', function() {
452 |         var what3words;
453 | 
454 |         beforeEach(function() {
455 |             what3words = new W3W.Geocoder({
456 |                 key: W3W_API_KEY
457 |             });
458 |         });
459 | 
460 |         it('should autosuggest plan.clips.a with no focus and no clipping', function(done) {
461 |             var callback = {
462 |                 onSuccess: function(data) {
463 |                     validateHTTPStatus(data);
464 |                     expect(data.suggestions).toBeDefined();
465 |                     expect(data.suggestions.length).toEqual(3);
466 |                     expect(data.suggestions[0].words).toEqual('plan.clips.also');
467 |                     expect(data.suggestions[1].words).toEqual('plan.clips.back');
468 |                     expect(data.suggestions[2].words).toEqual('plan.clips.each');
469 |                     done();
470 |                 },
471 |                 onFailure: function(data) {
472 |                     validateHTTPStatus(data);
473 |                     done();
474 |                 }
475 |             };
476 | 
477 |             var params = {
478 |                 addr: 'plan.clips.a',
479 |                 lang: 'en',
480 |                 clip: {
481 |                     type: 'none'
482 |                 }
483 |             };
484 | 
485 |             what3words.autosuggest(params, callback);
486 |         });
487 |     });
488 | 
489 |     describe('#standardblend', function() {
490 |         var what3words;
491 | 
492 |         beforeEach(function() {
493 |             what3words = new W3W.Geocoder({
494 |                 key: W3W_API_KEY
495 |             });
496 |         });
497 | 
498 |         it('should return a JSON standardblend for index.home.raft with a focus of 51.4243877,-0.3474524', function(done) {
499 |             var callback = {
500 |                 onSuccess: function(data) {
501 |                     validateHTTPStatus(data);
502 | 
503 |                     expect(data.blends).toBeDefined();
504 |                     expect(data.blends).toBeArray();
505 |                     expect(data.blends.length).toEqual(3);
506 |                     expect(data.blends[0].words).toEqual('index.home.raft');
507 |                     expect(data.blends[1].words).toEqual('indexes.home.raft');
508 |                     expect(data.blends[2].words).toEqual('index.homes.raft');
509 |                     done();
510 |                 },
511 |                 onFailure: function(data) {
512 |                     validateHTTPStatus(data);
513 |                     done();
514 |                 }
515 |             };
516 | 
517 |             var params = {
518 |                 addr: 'index.home.raft',
519 |                 lang: 'en',
520 |                 focus: [51.4243877, -0.3474524]
521 |             };
522 | 
523 |             what3words.standardblend(params, callback);
524 |         });
525 |     });
526 | 
527 |     describe('#standardblend-ml', function() {
528 |         var what3words;
529 | 
530 |         beforeEach(function() {
531 |             what3words = new W3W.Geocoder({
532 |                 key: W3W_API_KEY
533 |             });
534 |         });
535 | 
536 |         it('should return a JSON standardblend-ml for index.home.raft with a focus of 51.4243877,-0.3474524', function(done) {
537 |             var callback = {
538 |                 onSuccess: function(data) {
539 |                     validateHTTPStatus(data);
540 | 
541 |                     expect(data.blends).toBeDefined();
542 |                     expect(data.blends).toBeArray();
543 |                     expect(data.blends.length).toEqual(3);
544 |                     expect(data.blends[0].words).toEqual('index.home.raft');
545 |                     expect(data.blends[1].words).toEqual('index.homes.raft');
546 |                     expect(data.blends[2].words).toEqual('indexes.home.raft');
547 |                     done();
548 |                 },
549 |                 onFailure: function(data) {
550 |                     validateHTTPStatus(data);
551 |                     done();
552 |                 }
553 |             };
554 | 
555 |             var params = {
556 |                 addr: 'index.home.raft',
557 |                 lang: 'en',
558 |                 focus: [51.4243877, -0.3474524]
559 |             };
560 | 
561 |             what3words.standardblend_ml(params, callback);
562 |         });
563 |     });
564 | 
565 |     describe('#grid', function() {
566 |         var what3words;
567 | 
568 |         beforeEach(function() {
569 |             what3words = new W3W.Geocoder({
570 |                 key: W3W_API_KEY
571 |             });
572 |         });
573 | 
574 |         it('should create a grid for bounding box 52.208867,0.117540,52.207988,0.116126 defaulting to JSON', function(done) {
575 |             var callback = {
576 |                 onSuccess: function(data) {
577 |                     validateHTTPStatus(data);
578 | 
579 |                     expect(data.lines).toBeDefined();
580 |                     expect(data.lines).toBeArray();
581 |                     expect(data.lines.length).toBeGreaterThan(4);
582 |                     expect(data.lines[0].start).toBeDefined();
583 |                     expect(data.lines[0].start.lat).toBeDefined();
584 |                     expect(data.lines[0].start.lat).toEqual(52.208009918068);
585 |                     expect(data.lines[0].start.lng).toBeDefined();
586 |                     expect(data.lines[0].start.lng).toEqual(0.11612600000001);
587 |                     expect(data.lines[0].end).toBeDefined();
588 |                     expect(data.lines[0].end.lat).toBeDefined();
589 |                     expect(data.lines[0].end.lat).toEqual(52.208009918068);
590 |                     expect(data.lines[0].end.lng).toBeDefined();
591 |                     expect(data.lines[0].end.lng).toEqual(0.11753999999999);
592 |                     done();
593 |                 },
594 |                 onFailure: function(data) {
595 |                     validateHTTPStatus(data);
596 |                     done();
597 |                 }
598 |             };
599 | 
600 |             var params = {
601 |                 bbox: [52.208867, 0.117540, 52.207988, 0.116126]
602 |             };
603 | 
604 |             what3words.grid(params, callback);
605 |         });
606 | 
607 |         it('should create a grid for bounding box 52.208867,0.117540,52.207988,0.116126 in JSON', function(done) {
608 |             var callback = {
609 |                 onSuccess: function(data) {
610 |                     validateHTTPStatus(data);
611 | 
612 |                     expect(data.lines).toBeDefined();
613 |                     expect(data.lines).toBeArray();
614 |                     expect(data.lines.length).toBeGreaterThan(4);
615 |                     expect(data.lines[0].start).toBeDefined();
616 |                     expect(data.lines[0].start.lat).toBeDefined();
617 |                     expect(data.lines[0].start.lat).toEqual(52.208009918068);
618 |                     expect(data.lines[0].start.lng).toBeDefined();
619 |                     expect(data.lines[0].start.lng).toEqual(0.11612600000001);
620 |                     expect(data.lines[0].end).toBeDefined();
621 |                     expect(data.lines[0].end.lat).toBeDefined();
622 |                     expect(data.lines[0].end.lat).toEqual(52.208009918068);
623 |                     expect(data.lines[0].end.lng).toBeDefined();
624 |                     expect(data.lines[0].end.lng).toEqual(0.11753999999999);
625 |                     done();
626 |                 },
627 |                 onFailure: function(data) {
628 |                     validateHTTPStatus(data);
629 |                     done();
630 |                 }
631 |             };
632 | 
633 |             var params = {
634 |                 bbox: [52.208867, 0.117540, 52.207988, 0.116126],
635 |                 format: 'json'
636 |             };
637 | 
638 |             what3words.grid(params, callback);
639 |         });
640 | 
641 |         it('should create a grid for bounding box 52.208867,0.117540,52.207988,0.116126 in GeoJSON', function(done) {
642 |             var callback = {
643 |                 onSuccess: function(data) {
644 |                     validateHTTPPropertyStatus(data);
645 | 
646 |                     expect(data.coordinates).toBeDefined();
647 |                     expect(data.coordinates).toBeArray();
648 |                     expect(data.coordinates[0]).toBeArray();
649 |                     expect(data.coordinates[0][0]).toEqual([0.11612600000001, 52.208009918068]);
650 |                     expect(data.coordinates[0][1]).toEqual([0.11753999999999, 52.208009918068]);
651 |                     expect(data.type).toBeDefined();
652 |                     expect(data.type).toEqual('MultiLineString');
653 |                     expect(data.properties).toBeDefined();
654 |                     expect(data.properties.thanks).toBeDefined();
655 |                     done();
656 |                 },
657 |                 onFailure: function(data) {
658 |                     validateHTTPStatus(data);
659 |                     done();
660 |                 }
661 |             };
662 | 
663 |             var params = {
664 |                 bbox: [52.208867, 0.117540, 52.207988, 0.116126],
665 |                 format: 'geojson'
666 |             };
667 | 
668 |             what3words.grid(params, callback);
669 |         });
670 | 
671 |         it ('should catch an Error exception when an invalid format of type "xml" is requested', function(done) {
672 |             var callback = {
673 |                 onSuccess: function(data) {
674 |                     throw new Error('onSuccess should never be invoked');
675 |                 },
676 |                 onFailure: function(data) {
677 |                     throw new Error('onFailure should never be invoked');
678 |                 }
679 |             };
680 | 
681 |             var params = {
682 |                 bbox: [52.208867, 0.117540, 52.207988, 0.116126],
683 |                 format: 'xml'
684 |             };
685 | 
686 |             expect(function() {
687 |                 what3words.grid(params, callback);
688 |             }).toThrow(new Error('params.format must have a value of "json" or "geojson"'));
689 |             done();
690 |         });
691 |     });
692 | 
693 |     describe('#languages', function() {
694 |         var what3words;
695 | 
696 |         beforeEach(function() {
697 |             what3words = new W3W.Geocoder({
698 |                 key: W3W_API_KEY
699 |             });
700 |         });
701 | 
702 |         it('should return valid 3 word address languages', function(done) {
703 |             callback = {
704 |                 onSuccess: function(data) {
705 |                     validateHTTPStatus(data);
706 | 
707 |                     expect(data.languages).toBeDefined();
708 |                     expect(data.languages).toBeArray();
709 |                     expect(data.languages.length).toBeGreaterThan(1);
710 |                     expect(data.languages[0].code).toBeDefined();
711 |                     expect(data.languages[0].name).toBeDefined();
712 |                     expect(data.languages[0].native_name).toBeDefined();
713 |                     done();
714 |                 },
715 |                 onFailure: function(data) {
716 |                     validateHTTPStatus(data);
717 |                     done();
718 |                 }
719 |             };
720 | 
721 |             what3words.languages(callback);
722 |         });
723 |     });
724 | });
725 | 


--------------------------------------------------------------------------------
/test/js/specs/multiple_requests.spec.js:
--------------------------------------------------------------------------------
  1 | 
  2 | mr_validateJSONPayload = function(data) {
  3 |     expect(data.words).toBeDefined();
  4 |     expect(data.words).toEqual('topping.chop.online');
  5 |     expect(data.geometry).toBeDefined();
  6 |     expect(data.geometry.lat).toBeDefined();
  7 |     expect(data.geometry.lat).toEqual(45.753248);
  8 |     expect(data.geometry.lng).toBeDefined();
  9 |     expect(data.geometry.lng).toEqual(4.855230);
 10 | };
 11 | 
 12 | mr_validateGeoJSONPayload = function(data) {
 13 |     expect(data.geometry).toBeDefined();
 14 |     expect(data.geometry.coordinates).toBeDefined();
 15 |     expect(data.geometry.coordinates).toEqual([4.855230, 45.753248]);
 16 |     expect(data.geometry.type).toBeDefined();
 17 |     expect(data.geometry.type).toEqual('Point');
 18 |     expect(data.type).toBeDefined();
 19 |     expect(data.type).toEqual('Feature');
 20 |     expect(data.properties).toBeDefined();
 21 |     expect(data.properties.words).toBeDefined();
 22 |     expect(data.properties.words).toEqual('topping.chop.online');
 23 |     expect(data.properties.language).toBeDefined();
 24 |     expect(data.properties.language).toEqual('en');
 25 |     expect(data.properties.map).toBeDefined();
 26 |     expect(data.properties.map).toEqual('http://w3w.co/topping.chop.online');
 27 | };
 28 | 
 29 | describe('what3words', function() {
 30 | 
 31 |     describe('#multiple forward', function() {
 32 |         var what3words;
 33 | 
 34 |         beforeEach(function() {
 35 |             what3words = new W3W.Geocoder({
 36 |                 key: W3W_API_KEY
 37 |             });
 38 |         });
 39 | 
 40 |         it('should reverse geocode "topping.chop.online" 3 times to JSON, GeoJSON and then JSON', function(done) {
 41 | 
 42 |             var ended = 0;
 43 |             function allDone(idx) {
 44 |                 ended += idx;
 45 |                 if(ended === 6) {
 46 |                     done();
 47 |                 }
 48 |             }
 49 | 
 50 |             var callbackJSON1 = {
 51 |                 onSuccess: function(data) {
 52 |                     mr_validateJSONPayload(data);
 53 |                     allDone(1);
 54 |                 },
 55 |                 onFailure: function(data) {
 56 |                     expect(data.status.status).toEqual(200);
 57 |                     done();
 58 |                 }
 59 |             };
 60 | 
 61 |             var callbackJSON2 = {
 62 |                 onSuccess: function(data) {
 63 |                     mr_validateJSONPayload(data);
 64 |                     allDone(2);
 65 |                 },
 66 |                 onFailure: function(data) {
 67 |                     expect(data.status.status).toEqual(200);
 68 |                     done();
 69 |                 }
 70 |             };
 71 | 
 72 |             var callbackGeoJSON = {
 73 |                 onSuccess: function(data) {
 74 |                     mr_validateGeoJSONPayload(data);
 75 |                     allDone(3);
 76 |                 },
 77 |                 onFailure: function(data) {
 78 |                     expect(data.status.status).toEqual(200);
 79 |                     done();
 80 |                 }
 81 |             };
 82 | 
 83 |             var params = {
 84 |                 addr: 'topping.chop.online',
 85 |             };
 86 | 
 87 |             what3words.forward(params, callbackJSON1);
 88 | 
 89 |             params = {
 90 |                 addr: 'topping.chop.online',
 91 |                 format: 'geojson'
 92 |             };
 93 | 
 94 |             what3words.forward(params, callbackGeoJSON);
 95 | 
 96 |             params = {
 97 |                 addr: 'topping.chop.online',
 98 |             };
 99 | 
100 |             what3words.forward(params, callbackJSON2);
101 | 
102 |         });
103 | 
104 |     });
105 | 
106 |     describe('#multiple reverse', function() {
107 |         var what3words;
108 | 
109 |         beforeEach(function() {
110 |             what3words = new W3W.Geocoder({
111 |                 key: W3W_API_KEY
112 |             });
113 |         });
114 | 
115 |         it('should reverse geocode [45.753248, 4.855230] 3 times to JSON, GeoJSON and then JSON', function(done) {
116 | 
117 |             var ended = 0;
118 |             function allDone(idx) {
119 |                 ended += idx;
120 |                 if(ended === 6) {
121 |                     done();
122 |                 } 
123 |             }
124 | 
125 |             var callbackJSON1 = {
126 |                 onSuccess: function(data) {
127 |                     mr_validateJSONPayload(data);
128 |                     allDone(1);
129 |                 },
130 |                 onFailure: function(data) {
131 |                     expect(data.status.status).toEqual(200);
132 |                     done();
133 |                 }
134 |             };
135 | 
136 |             var callbackJSON2 = {
137 |                 onSuccess: function(data) {
138 |                     mr_validateJSONPayload(data);
139 |                     allDone(2);
140 |                 },
141 |                 onFailure: function(data) {
142 |                     expect(data.status.status).toEqual(200);
143 |                     done();
144 |                 }
145 |             };
146 | 
147 |             var callbackGeoJSON = {
148 |                 onSuccess: function(data) {
149 |                     mr_validateGeoJSONPayload(data);
150 |                     allDone(3);
151 |                 },
152 |                 onFailure: function(data) {
153 |                     expect(data.status.status).toEqual(200);
154 |                     done();
155 |                 }
156 |             };
157 | 
158 |             var params = {
159 |                 coords: [45.753248, 4.855230]
160 |             };
161 | 
162 |             what3words.reverse(params, callbackJSON1);
163 | 
164 |             params = {
165 |                 coords: [45.753248, 4.855230],
166 |                 format: 'geojson'
167 |             };
168 | 
169 |             what3words.reverse(params, callbackGeoJSON);
170 | 
171 |             params = {
172 |                 coords: [45.753248, 4.855230]
173 |             };
174 | 
175 |             what3words.reverse(params, callbackJSON2);
176 | 
177 |         });
178 | 
179 |     });
180 | 
181 | 
182 | });
183 | 


--------------------------------------------------------------------------------
/test/js/templates/SpecRunner.tmpl:
--------------------------------------------------------------------------------
 1 | <!doctype html>
 2 | <html>
 3 | 
 4 | <head>
 5 |     <meta charset="utf-8">
 6 |     <title>Jasmine Spec Runner</title>
 7 |     <link rel="shortcut icon" type="image/png" href="<%= temp %>/jasmine_favicon.png">
 8 |     <% css.forEach(function(style){ %>
 9 |         <link rel="stylesheet" type="text/css" href="<%= style %>">
10 |     <% }) %>
11 |     <script type="text/javascript">
12 |     var W3W_API_KEY = '<%= options.api_key %>';
13 |     </script>
14 | </head>
15 | 
16 | <body>
17 |     <% with (scripts) { %>
18 |         <% [].concat(polyfills, jasmine, boot, vendor, helpers, src, specs,reporters).forEach(function(script){ %>
19 |         <script src="<%= script %>"></script>
20 |         <% }) %>
21 |     <% }; %>
22 | </body>
23 | 
24 | </html>
25 | 


--------------------------------------------------------------------------------