what3words 2.0.4 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55fd336afb4874c96702060ac0e07eff723e8ca8
-  data.tar.gz: 06acf5049cd02703cafc219e2ab747d3462b525e
+  metadata.gz: 8f9631e97c5f664a7205fdb297e03ec68ba80608
+  data.tar.gz: 1f45125f7dd016a8a17f75bd290b89f0f828e6fb
 SHA512:
-  metadata.gz: 01ae762ff9fc1770d9f57d207f32b1c55bdd26885bcc64adaa4e7062965b85370740234e9856b2ac96f8484b07482f3f43f88459b22b9cfe014a78f41cc2349c
-  data.tar.gz: 372592b00b3ca32b622e007bddac5dc50d248d4ea49578da2eefec0cd3adeb5a13a1dee39fff6618084bc6c38acd7ee1f00a35890e17f44e1bfc3b8b225851dc
+  metadata.gz: 6b2e3c38f9979c34acc6efb3ddde9e076bce2a50c0e82c17018ea7fef9842a6d8b9d2c805e4b2509b3785a460a314c6f8ee144cb0bc7c52f9af943a0fd502de8
+  data.tar.gz: d006eab3c400debaf673c4d6f98ca8335dc8dbe7c7081b37e7063c62d98814b7383e72989b0e59c6b869ad17181eed7214ee80624887b17c38247706ea12c5cd

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 rvm:
-- 2.2
-script: rake spec
+- 2.4
+script: rake rubocop spec
 notifications:
   slack:
     secure: DvejcrOH6RdAdrGEPLUrnia9cES8iCHVlVSFAMwx2vaR/I3T9bfUiHnb3VHfiqx4cvDL+9wT3opG0sZkUCFJGqzA3E//VObKNXjwUFCUptFG68qgR7LZ3vDatWlUqU+32gWeYaHM3FpNP2E/IARjphaiF3jRUZbronqVzJZN2MbMsUYBeGq7v0AaLkgbxVgOWtBnMVcBPOnarEJqHyJlqQ2unYnIy+GNoOFtPMPNZobYTf0zxrycldYpP937yT4CTsY3I7RxuEtnY2sPYW+eFBESGLg6EfnjeOruROY+b9cSHIh1Qzr7Oup6a+oQ3+vCvLbYsGpEO04RTeTTtOGc7aRlUylmvuFPi7qQwOTZ+4KD5aIBh4p7bQiPfvAeqDU4pVJxPHHZirgjFpUpAvofj48SvDgwX9cFyAhAlDZ9qBOctmhphW9KNkcAW4MY421AdVAjFWwc5CU8G5oPdKcyWam3ZB3nHwKgZm6LLAcZgbG0rjZT+iPeQBvTKH3kPx7E1CkxZNkEralHJ3l+bDwY3GdzsgcMpT3bWNl3pLszFzgXljDScMU8my1+xjDQINEnI3TCJA4MhKkzYkRgfrEBkgPb2SiF7qnhbyMzSFbCU4jsM1MLQZolNG9EsjsxJLuL4YTC2wKOHajViUUeaCNIcNU5UXBQuit93RyMu7RrLRM=

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 What3Words Limited
+Copyright (c) 2016, 2017 What3Words Limited
 
 MIT License
 

data/README.md

@@ -7,15 +7,21 @@ Use the what3words API in your Ruby app (see http://developer.what3words.com/api
 
 Add this line to your application's Gemfile:
 
-    gem 'what3words', '~> 2.0'
+```shell
+    gem 'what3words', '~> 2.1'
+```
 
 And then execute:
 
+```shell
     $ bundle
+```
 
 Or install it yourself as:
 
+```shell
     $ gem install what3words
+```
 
 ## Usage
 
@@ -26,24 +32,31 @@ passed to the API calls
 
 If not using Bundler, require it:
 
-    require "what3words"
+```ruby
+    require 'what3words'
+```
 
 Then:
 
+```ruby
     what3words = What3Words::API.new(:key => "YOURAPIKEY")
+```
 
 Forward Geocode : convert a 3 word address into GPS coordinates (WGS-84)
 
-    what3words.forward "prom.cape.pump"
+```ruby
+    what3words.forward 'prom.cape.pump'
     # => {:crs=>{:properties=>{:type=>"ogcwkt", :href=>"http://spatialreference.org/ref/epsg/4326/ogcwkt/"}, :type=>"link"}, :bounds=>{:southwest=>{:lng=>-0.195426, :lat=>51.484449}, :northeast=>{:lng=>-0.195383, :lat=>51.484476}}, :words=>"prom.cape.pump", :map=>"http://w3w.co/prom.cape.pump", :language=>"en", :geometry=>{:lng=>-0.195405, :lat=>51.484463}, :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+```
 
 ## API
 ### Forward Geocoding
 Convert a 3 word address into GPS coordinates and return 3 words for the same position in a different language
 
+```ruby
     what3words.forward "prom.cape.pump", :lang => "fr"
     # => {:crs=>{:properties=>{:type=>"ogcwkt", :href=>"http://spatialreference.org/ref/epsg/4326/ogcwkt/"}, :type=>"link"}, :bounds=>{:southwest=>{:lng=>-0.195426, :lat=>51.484449}, :northeast=>{:lng=>-0.195383, :lat=>51.484476}}, :words=>"concevoir.époque.amasser", :map=>"http://w3w.co/concevoir.époque.amasser", :language=>"fr", :geometry=>{:lng=>-0.195405, :lat=>51.484463}, :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
-
+```
 Supported keyword params for `forward` call:
 
 * `lang` (defaults to language of 3 words)  - optional language code (only use this if you want to return 3 words in a different language to the language submitted)
@@ -53,13 +66,17 @@ Supported keyword params for `forward` call:
 ### Reverse Geocoding
 Reverse Geocode : Convert position(latitude) information to a 3 word address
 
+```ruby
     what3words.reverse [51.484463, -0.195405]
     # => {:crs=>{:properties=>{:type=>"ogcwkt", :href=>"http://spatialreference.org/ref/epsg/4326/ogcwkt/"}, :type=>"link"}, :bounds=>{:southwest=>{:lng=>-0.195426, :lat=>51.484449}, :northeast=>{:lng=>-0.195383, :lat=>51.484476}}, :words=>"prom.cape.pump", :map=>"http://w3w.co/prom.cape.pump", :language=>"en", :geometry=>{:lng=>-0.195405, :lat=>51.484463}, :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+    ```
 
 Convert position information to a 3 word address in a specific language
 
+```ruby
     what3words.reverse [51.484463, -0.195405], :lang => :fr
     # => {:crs=>{:properties=>{:type=>"ogcwkt", :href=>"http://spatialreference.org/ref/epsg/4326/ogcwkt/"}, :type=>"link"}, :bounds=>{:southwest=>{:lng=>-0.195426, :lat=>51.484449}, :northeast=>{:lng=>-0.195383, :lat=>51.484476}}, :words=>"concevoir.époque.amasser", :map=>"http://w3w.co/concevoir.époque.amasser", :language=>"fr", :geometry=>{:lng=>-0.195405, :lat=>51.484463}, :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+```
 
 Supported keyword params for `reverse` call:
 
@@ -78,14 +95,28 @@ This resource provides corrections for the following types of input error:
 
 The autosuggest resource determines possible corrections to the supplied 3 word address string based on the probability of the input errors listed above and returns a ranked list of suggestions. This resource can also take into consideration the geographic proximity of possible corrections to a given location to further improve the suggestions returned.
 
+*Single and Multilingual Variants*
+
+AutoSuggest is provided via 2 variant resources; single language and multilingual.
+
+The single language `autosuggest` method  requires a language to be specified.
+
+The multilingual `autosuggest_ml`  method  requires a language to be specified. This will ensure that the autosuggest-ml resource will look for suggestions in this language, in addition to any other languages that yield relevant suggestions.
+
 see https://docs.what3words.com/api/v2/#autosuggest for detailed information
 
 Gets suggestions in italian for this address
 
+```ruby
     what3words.autosuggest "trovò.calore.perder", "it"
     # => {:suggestions=>[{:score=>12, :country=>"ma", :words=>"trovò.calore.perdere", :rank=>1, :geometry=>{:lng=>-6.665638, :lat=>34.318065}, :place=>"Kenitra, Gharb-Chrarda-Beni Hssen"}, {:score=>12, :country=>"ca", :words=>"trovò.calore.perderò", :rank=>2, :geometry=>{:lng=>-65.036149, :lat=>45.846472}, :place=>"Salisbury, New Brunswick"}, {:score=>17, :country=>"ve", :words=>"trovò.calore.prede", :rank=>3, :geometry=>{:lng=>-70.280645, :lat=>7.24527}, :place=>"Guasdualito, Apure"}], :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+```
+
+```ruby
+    what3words.autosuggest_ml "trovò.calore.perder", "it"
+```
 
-Supported keyword params for `autosuggest` call:
+Supported keyword params for `autosuggest` and `autosuggest_ml` call:
   * `format` Return data format type; can be one of json (the default), geojson or xml
   * `display` Return display type; can be one of full (the default) or terse
 
@@ -94,14 +125,28 @@ Returns a blend of the three most relevant 3 word address candidates for a given
 
 The specified 3 word address may either be a full 3 word address or a partial 3 word address containing the first 2 words in full and at least 1 character of the 3rd word. The standardblend resource provides the search logic that powers the search box on map.what3words.com and in the what3words mobile apps.
 
+*Single and Multilingual Variants*
+
+AutoSuggest is provided via 2 variant resources; single language and multilingual.
+
+The single language `standardblend` method  requires a language to be specified.
+
+The multilingual `standardblend_ml`  method  requires a language to be specified. This will ensure that the standardblend-ml resource will look for suggestions in this language, in addition to any other languages that yield relevant suggestions.
+
 see https://docs.what3words.com/api/v2/#standardblend for detailed information
 
 Gets blends in italian for this address
 
+```ruby
     what3words.standardblend "trovò.calore.perder", "it"
     # => {:blends=>[{:country=>"ma", :words=>"trovò.calore.perdere", :rank=>1, :language=>"it", :geometry=>{:lng=>-6.665638, :lat=>34.318065}, :place=>"Kenitra, Gharb-Chrarda-Beni Hssen"}, {:country=>"ca", :words=>"trovò.calore.perderò", :rank=>2, :language=>"it", :geometry=>{:lng=>-65.036149, :lat=>45.846472}, :place=>"Salisbury, New Brunswick"}, {:country=>"ve", :words=>"trovò.calore.prede", :rank=>3, :language=>"it", :geometry=>{:lng=>-70.280645, :lat=>7.24527}, :place=>"Guasdualito, Apure"}], :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+```
+
+```ruby
+    what3words.standardblend_ml "trovò.calore.perder", "it"
+```
 
-Supported keyword params for `standardblend` call:
+Supported keyword params for `standardblend` and `standardblend_ml` call:
   * `format` Return data format type; can be one of json (the default), geojson or xml
   * `display` Return display type; can be one of full (the default) or terse
 
@@ -112,8 +157,10 @@ see https://docs.what3words.com/api/v2/#grid for detailed information
 
 Gets grid for these bounding box northeast 52.208867,0.117540, southwest 52.207988,0.116126
 
+```ruby
     what3words.grid "52.208867,0.117540,52.207988,0.116126"
     # => {:lines=>[{:start=>{:lng=>0.11612600000001, :lat=>52.208009918068}, :end=>{:lng=>0.11753999999999, :lat=>52.208009918068}}, ___...___ , :end=>{:lng=>0.11752023935234, :lat=>52.208867}}], :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+```
 
 Supported keyword params for `grid` call:
   * `format` Return data format type; can be one of json (the default), geojson or xml
@@ -122,20 +169,14 @@ Supported keyword params for `grid` call:
 ### Get Languages
 Get list of available 3 word languages
 
+```ruby
     what3words.languages
-    # => {:languages=>[{:name=>"German", :native_name=>"Deutsch", :code=>"de"}, {:name=>"Italian", :native_name=>"Italiano", :code=>"it"}, {:name=>"Turkish", :native_name=>"Türkçe", :code=>"tr"}, {:name=>"Portuguese", :native_name=>"Português", :code=>"pt"}, {:name=>"French", :native_name=>"français, langue française", :code=>"fr"}, {:name=>"Swedish", :native_name=>"svenska", :code=>"sv"}, {:name=>"English", :native_name=>"English", :code=>"en"}, {:name=>"Russian", :native_name=>"русский язык", :code=>"ru"}, {:name=>"Spanish", :native_name=>"español", :code=>"es"}, {:name=>"Swahili", :native_name=>"Kiswahili", :code=>"sw"}], :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+    # => {{:languages=>[{:code=>"de", :name=>"German", :native_name=>"Deutsch"}, {:code=>"mn", :name=>"Mongolian", :native_name=>"Mонгол"}, {:code=>"fi", :name=>"Finnish", :native_name=>"Suomi"}, {:code=>"ru", :name=>"Russian", :native_name=>"Русский"}, {:code=>"sv", :name=>"Swedish", :native_name=>"Svenska"}, {:code=>"pt", :name=>"Portuguese", :native_name=>"Português"}, {:code=>"sw", :name=>"Swahili", :native_name=>"Kiswahili"}, {:code=>"en", :name=>"English", :native_name=>"English"}, {:code=>"it", :name=>"Italian", :native_name=>"Italiano"}, {:code=>"fr", :name=>"French", :native_name=>"Français"}, {:code=>"es", :name=>"Spanish", :native_name=>"Español"}, {:code=>"ar", :name=>"Arabic", :native_name=>"العربية"}, {:code=>"pl", :name=>"Polish", :native_name=>"Polski"}, {:code=>"tr", :name=>"Turkish", :native_name=>"Türkçe"}], :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
+```
 
 See http://developer.what3words.com for the original API call documentation
 
-## Contributing
-
-1. Fork it ( http://github.com/what3words/w3w-ruby-wrapper and click "Fork" )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-### Testing
+## Testing
 
 * Prerequisite : we are using [bundler](https://rubygems.org/gems/bundler) `$ gem install bundler`
 
@@ -147,4 +188,32 @@ $ export W3W_API_KEY=<Secret API Key>
 * on you cloned folder
 1. `$ cd w3w-ruby-wrapper`
 1. `$ bundle update`
-1. `$ rake spec`
+1. `$ rake rubocop spec`
+
+## Issues
+
+Find a bug or want to request a new feature? Please let us know by submitting an issue.
+
+## Contributing
+Anyone and everyone is welcome to contribute.
+
+1. Fork it (http://github.com/what3words/w3w-ruby-wrapper and click "Fork")
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# Revision History
+
+* `v2.1.1`  22/05/17 - Update gemspec to use rubocop 0.48.1, and fixes spec accordingly
+* `v2.1.0`  28/03/17 - Added multilingual version of `autosuggest` and `standardblend`
+* `v2.0.4`  27/03/17 - Updated README with `languages` method result updated from live result
+* `v2.0.3`  24/10/16 - Fixed `display` in `assemble_common_request_params`
+* `v2.0.2`  10/06/16 - Added travis-ci builds
+* `v2.0.0`  10/06/16 - Updated wrapper to use what3words API v2
+
+## Licensing
+
+The MIT License (MIT)
+
+A copy of the license is available in the repository's [license](LICENSE.txt) file.

data/Rakefile

@@ -1,9 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new(:rubocop) do |t|
+    t.options = ['--display-cop-names']
+  end
   require 'rspec/core/rake_task'
-
   RSpec::Core::RakeTask.new(:spec)
-rescue LoadError
-  # ignore
+rescue LoadError => e
+  print e
 end

data/lib/what3words/api.rb

@@ -1,27 +1,30 @@
 # encoding: utf-8
 
-require "rest-client"
+require 'rest-client'
 
 module What3Words
-  class API
-
+  # Document the responsibility of the class
+  #
+  class API # rubocop:disable Metrics/ClassLength
     class Error < RuntimeError; end
     class ResponseError < Error; end
     class WordError < Error; end
 
     REGEX_3_WORD_ADDRESS = /^\p{L}+\.\p{L}+\.\p{L}+$/u
-    REGEX_STRICT = /^\p{L}{4,}+\.\p{L}{4,}+\.\p{L}{4,}+$/u
+    REGEX_STRICT = /^\p{L}{3,}+\.\p{L}{3,}+\.\p{L}{3,}+$/u
 
-    BASE_URL = "https://api.what3words.com/v2/"
+    BASE_URL = 'https://api.what3words.com/v2/'.freeze
 
     ENDPOINTS = {
-      :forward => "forward",
-      :reverse => "reverse",
-      :languages => "languages",
-      :autosuggest => "autosuggest",
-      :standardblend => "standardblend",
-      :grid => "grid"
-    }
+      forward: 'forward',
+      reverse: 'reverse',
+      languages: 'languages',
+      autosuggest: 'autosuggest',
+      standardblend: 'standardblend',
+      autosuggest_ml: 'autosuggest-ml',
+      standardblend_ml: 'standardblend-ml',
+      grid: 'grid'
+    }.freeze
 
     def initialize(params)
       @key = params.fetch(:key)
@@ -48,26 +51,42 @@ module What3Words
       response
     end
 
-    def languages()
+    def languages
       request_params = assemble_common_request_params({})
       response = request! :languages, request_params
       response
     end
 
     def autosuggest(addr, lang, focus = {}, clip = {}, params = {})
-      request_params = assemble_autosuggest_request_params(addr, lang, focus, clip, params)
+      request_params = assemble_autosuggest_request_params(addr, lang, focus,
+                                                           clip, params)
       response = request! :autosuggest, request_params
       response
     end
 
+    def autosuggest_ml(addr, lang, focus = {}, clip = {}, params = {})
+      request_params = assemble_autosuggest_request_params(addr, lang, focus,
+                                                           clip, params)
+      response = request! :autosuggest_ml, request_params
+      response
+    end
+
     def standardblend(addr, lang, focus = {}, params = {})
-      request_params = assemble_standardblend_request_params(addr, lang, focus, params)
+      request_params = assemble_standardblend_request_params(addr, lang, focus,
+                                                             params)
       response = request! :standardblend, request_params
       response
     end
 
+    def standardblend_ml(addr, lang, focus = {}, params = {})
+      request_params = assemble_standardblend_request_params(addr, lang, focus,
+                                                             params)
+      response = request! :standardblend_ml, request_params
+      response
+    end
+
     def assemble_common_request_params(params)
-      h = {:key => key}
+      h = { key: key }
       h[:lang] = params[:lang] if params[:lang]
       h[:format] = params[:format] if params[:format]
       h[:display] = params[:display] if params[:display]
@@ -76,40 +95,36 @@ module What3Words
     private :assemble_common_request_params
 
     def assemble_forward_request_params(words_string, params)
-      h = {:addr => words_string}
+      h = { addr: words_string }
       h.merge(assemble_common_request_params(params))
     end
     private :assemble_forward_request_params
 
     def assemble_grid_request_params(bbox, params)
-      h = {:bbox => bbox}
+      h = { bbox: bbox }
       h.merge(assemble_common_request_params(params))
     end
     private :assemble_grid_request_params
 
     def assemble_reverse_request_params(position, params)
-      h = {:coords => position.join(",")}
+      h = { coords: position.join(',') }
       h.merge(assemble_common_request_params(params))
     end
     private :assemble_reverse_request_params
 
     def assemble_autosuggest_request_params(addr, lang, focus, clip, params)
-      h = {:addr => addr}
+      h = { addr: addr }
       h[:lang] = lang
-      if focus.respond_to? :join
-        h[:focus] = focus.join(",")
-      end
+      h[:focus] = focus.join(',') if focus.respond_to? :join
       h[:clip] = clip if clip.respond_to? :to_str
       h.merge(assemble_common_request_params(params))
     end
     private :assemble_autosuggest_request_params
 
     def assemble_standardblend_request_params(addr, lang, focus, params)
-      h = {:addr => addr}
+      h = { addr: addr }
       h[:lang] = lang
-      if focus.respond_to? :join
-        h[:focus] = focus.join(",")
-      end
+      h[:focus] = focus.join(',') if focus.respond_to? :join
       h.merge(assemble_common_request_params(params))
     end
     private :assemble_standardblend_request_params
@@ -122,11 +137,11 @@ module What3Words
       rescue => e
         response = e.response
       end
-      # puts "#{response.to_str}"
-      # puts "Response status: #{response.code}"
+      # puts '#{response.to_str}'
+      # puts 'Response status: #{response.code}'
       response = JSON.parse(response.body)
-      if response["code"].to_s.strip != ""
-        raise ResponseError, "#{response["code"]}: #{response["message"]}"
+      if response['code'].to_s.strip != ''
+        raise ResponseError, "#{response['code']}: #{response['message']}"
       end
       deep_symbolize_keys(response)
     end
@@ -136,7 +151,7 @@ module What3Words
       if words.respond_to? :to_str
         w = words
       elsif words.respond_to? :join
-        w = words.join(".")
+        w = words.join('.')
       else
         raise Error, "Cannot get words string for #{words.inspect}"
       end
@@ -148,15 +163,17 @@ module What3Words
       unless REGEX_3_WORD_ADDRESS.match(words)
         raise WordError, "#{words} is not a valid 3 word address"
       end
-      return words
+      words
     end
     private :check_words
 
     def deep_symbolize_keys(i)
-      if i.kind_of? Hash
+      if i.is_a? Hash
         ni = {}
-        i.each {|k,v| ni[k.respond_to?(:to_sym) ? k.to_sym : k] = deep_symbolize_keys(v) }
-      elsif i.kind_of? Array
+        # rubocop:disable Metrics/LineLength
+        i.each { |k, v| ni[k.respond_to?(:to_sym) ? k.to_sym : k] = deep_symbolize_keys(v) }
+        # rubocop:enable Metrics/LineLength
+      elsif i.is_a? Array
         ni = i.map(&method(:deep_symbolize_keys))
       else
         ni = i
@@ -165,14 +182,13 @@ module What3Words
       ni
     end
 
-    def base_url()
+    def base_url
       BASE_URL
     end
     private :base_url
 
     def endpoint(name)
-      return base_url() + ENDPOINTS.fetch(name)
+      base_url + ENDPOINTS.fetch(name)
     end
-
   end
 end

data/lib/what3words/version.rb

@@ -1,3 +1,3 @@
 module What3Words
-  VERSION = "2.0.4"
+  VERSION = '2.1.1'.freeze
 end

data/lib/what3words.rb

@@ -1,4 +1,4 @@
-module What3Words
+module What3Words #:nodoc: don't document this
 end
 
-require "what3words/api"
+require 'what3words/api'

data/spec/lib/what3words/what3words_api_spec.rb

@@ -1,115 +1,150 @@
 # encoding: utf-8
 
-require "spec_helper"
-
-describe What3Words::API, "integration", :integration => true do
-
+require 'spec_helper'
+# rubocop:disable Metrics/LineLength
+describe What3Words::API, 'integration', integration: true do # rubocop:disable Metrics/BlockLength
+  # rubocop:enable Metrics/LineLength
   before(:all) do
     WebMock.allow_net_connect!
   end
 
-  let(:api_key) { ENV["W3W_API_KEY"] }
+  let(:api_key) { ENV['W3W_API_KEY'] }
 
-  let(:w3w) { described_class.new(:key => api_key) }
+  let(:w3w) { described_class.new(key: api_key) }
 
-  it "returns errors from API" do
-    badw3w = described_class.new(:key => "")
-    expect { badw3w.forward ["prom", "cape", "pump"] }.
-      to raise_error described_class::ResponseError
+  it 'returns errors from API' do
+    badw3w = described_class.new(key: '')
+    expect { badw3w.forward 'prom.cape.pump' }
+      .to raise_error described_class::ResponseError
   end
 
-  describe "getting position" do
-
-    it "works with string of 3 words separated by '.'" do
-      result = w3w.forward "prom.cape.pump"
+  describe 'getting position' do
+    it 'works with string of 3 words separated by \'.\'' do
+      result = w3w.forward 'prom.cape.pump'
       expect(result).to include(
-        :words => "prom.cape.pump",
-        :language => "en"
+        words: 'prom.cape.pump',
+        language: 'en'
       )
       expect(result[:geometry]).to include(
-        :lat => 51.484463,
-        :lng => -0.195405
+        lat: 51.484463,
+        lng: -0.195405
       )
     end
 
-    it "sends lang parameter for 3 words" do
-      result = w3w.forward ["prom", "cape", "pump"], :lang => "fr"
+    it 'sends lang parameter for 3 words' do
+      result = w3w.forward 'prom.cape.pump', lang: 'fr'
       expect(result).to include(
-        :words => "concevoir.époque.amasser",
-        :language => "fr"
+        words: 'concevoir.époque.amasser',
+        language: 'fr'
       )
     end
 
-    it "checks 3 words format matches standard regex" do
-      expect { w3w.forward "1.cape.pump" }.
-        to raise_error described_class::WordError
+    it 'checks 3 words format matches standard regex' do
+      expect { w3w.forward '1.cape.pump' }
+        .to raise_error described_class::WordError
     end
-
   end
 
-  describe "gets 3 words" do
-    it "from position" do
+  describe 'gets 3 words' do
+    it 'from position' do
       result = w3w.reverse [29.567041, 106.587875]
       expect(result).to include(
-        :words => "disclose.strain.redefined",
-        :language => "en"
+        words: 'disclose.strain.redefined',
+        language: 'en'
       )
     end
 
-    it "from position in fr" do
-      result = w3w.reverse [29.567041, 106.587875], :lang => "fr"
+    it 'from position in fr' do
+      result = w3w.reverse [29.567041, 106.587875], lang: 'fr'
       expect(result).to include(
-        :words => "courgette.rabotons.infrason",
-        :language => "fr"
+        words: 'courgette.rabotons.infrason',
+        language: 'fr'
       )
     end
-
   end
-  describe "autosuggest" do
-    it "simple addr" do
+  describe 'autosuggest' do
+    it 'simple addr' do
       # result =
-      w3w.autosuggest "trop.caler.perdre", "fr"
+      w3w.autosuggest 'trop.caler.perdre', 'fr'
     end
 
-    it "with focus" do
+    it 'with focus' do
       # result =
-      w3w.autosuggest "disclose.strain.redefin", "en", [29.567041, 106.587875]
+      w3w.autosuggest 'disclose.strain.redefin', 'en', [29.567041, 106.587875]
     end
 
-    it "with clipping radius around focus" do
+    it 'with clipping radius around focus' do
       # result =
-      w3w.autosuggest "disclose.strain.redefin", "en", [29.567041, 106.587875], "focus(10)"
+      w3w.autosuggest 'disclose.strain.redefin', 'en', [29.567041, 106.587875],
+                      'focus(10)'
     end
 
+    it 'arabic addr' do
+      # result =
+      w3w.autosuggest 'مربية.الصباح.المده', 'ar'
+    end
+  end
+
+  describe 'autosuggest-ml' do
+    it '3 langs (result prefered de)' do
+      # result =
+      w3w.autosuggest_ml 'geschaft.planter.carciofi', 'de'
+    end
+    it '3 langs (result prefered fr)' do
+      # result =
+      w3w.autosuggest_ml 'geschaft.planter.carciofi', 'fr'
+    end
+    it '3 langs (result prefered it)' do
+      # result =
+      w3w.autosuggest_ml 'geschaft.planter.carciofi', 'it'
+    end
   end
-  describe "standardblend" do
-    it "simple addr" do
+
+  describe 'standardblend' do
+    it 'simple addr' do
       # result =
-      w3w.standardblend "trop.caler.perdre", "fr"
+      w3w.standardblend 'trop.caler.perdre', 'fr'
     end
 
-    it "with focus" do
+    it 'with focus' do
       # result =
-      w3w.standardblend "disclose.strain.redefin", "en", [29.567041, 106.587875]
+      w3w.standardblend 'disclose.strain.redefin', 'en', [29.567041, 106.587875]
     end
   end
-  describe "grid" do
-    it "string input" do
+
+  describe 'standardblend-ml' do
+    it '3 langs (result prefered de)' do
       # result =
-      w3w.grid "52.208867,0.117540,52.207988,0.116126"
+      w3w.standardblend_ml 'geschaft.planter.carciofi', 'de'
+    end
+    it '3 langs (result prefered fr)' do
+      # result =
+      w3w.standardblend_ml 'geschaft.planter.carciofi', 'fr'
+    end
+    it '3 langs (result prefered it)' do
+      # result =
+      w3w.standardblend_ml 'geschaft.planter.carciofi', 'it'
+    end
+  end
+
+  describe 'grid' do
+    it 'string input' do
+      # result =
+      w3w.grid '52.208867,0.117540,52.207988,0.116126'
     end
   end
-  describe "languages" do
-    it "gets all languages" do
+
+  describe 'languages' do
+    it 'gets all languages' do
       # result =
       w3w.languages
     end
   end
 
-  describe "technical" do
-    it "'s deep_symbolize_keys helper works" do
-      expect(w3w.deep_symbolize_keys("foo" => {"bar" => true})).
-        to eq(:foo => {:bar => true})
+  describe 'technical' do
+    it '\'s deep_symbolize_keys helper works' do
+      expect(w3w.deep_symbolize_keys('foo' => { 'bar' => true }))
+        .to eq(foo: { bar: true })
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
-require "bundler/setup"
+require 'bundler/setup'
 
 Bundler.setup
 
-require "webmock/rspec"
+require 'webmock/rspec'
 
-require "what3words"
+require 'what3words'

data/what3words.gemspec

@@ -2,26 +2,27 @@
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "what3words/version"
+require 'what3words/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "what3words"
+  spec.name = 'what3words'
   spec.version = What3Words::VERSION
-  spec.authors = ["what3words"]
-  spec.email = ["development@what3words.com"]
-  spec.summary = "what3words API wrapper in Ruby"
-  spec.homepage = "http://rubygems.org/gems/what3words"
-  spec.license = "MIT"
+  spec.authors = ['what3words']
+  spec.email = ['development@what3words.com']
+  spec.summary = 'what3words API wrapper in Ruby'
+  spec.homepage = 'http://rubygems.org/gems/what3words'
+  spec.license = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^spec/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "rest-client", "~> 1.8"
+  spec.add_dependency 'rest-client', '~> 1.8'
 
-  spec.add_development_dependency "bundler", ">= 1.7.9"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "rspec", "~> 3.4"
-  spec.add_development_dependency "webmock", "~> 2.0"
+  spec.add_development_dependency 'bundler', '>= 1.7.9'
+  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'webmock', '~> 2.0'
+  spec.add_development_dependency 'rubocop', '~> 0.48.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: what3words
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.1
 platform: ruby
 authors:
 - what3words
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.48.1
 description: 
 email:
 - development@what3words.com