what3words 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 601e19657a0d9c09dc4af619041bf3ed0d87669b
-  data.tar.gz: 2df177b0de101ba2928888306db815bcaaa8e9c0
+  metadata.gz: 071822e06272c4806cc6493be469b6bf4e03224f
+  data.tar.gz: 73bd8cb619a5afc0828b1dd2eec47cf29c031f71
 SHA512:
-  metadata.gz: ed00c76a40d5b5675f6caacef0ccd3271d55dd462c1204e0f368c0fc5c1aa8834d99f476656f8cfc6522839ca4dd73184bb33635f5ea6284cc10f4fe80f2a127
-  data.tar.gz: 4f4b1ca2734b3a50332bc359ba4ae2586a45f6b77a48db52c8164c736e77b87cd6cf1ba82711f6d030e3a4ee71f11bf5dfb7580d768680f36e145c8fda07c52a
+  metadata.gz: 2fb0661e08c8e627deb26db2653b881dd5214eb5102b613ba7545ca2c45a45d150516c5e2f772182c5c5c85cf06362b7633713ca7402bcf586359d1abef9ae17
+  data.tar.gz: d5b964fdc28f5080ea62e421d4eaec85d4fd5c367cacb6ad1b30f2155ed379cea4a7ef5633fa83048fadf1d76da5169a8c3bad2b48f54e34940a60dad00ce334

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+# Set default charset
+charset = utf-8
+
+# Indentation
+indent_style = space
+indent_size = 2

data/LICENSE.txt

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

data/README.md

@@ -1,11 +1,12 @@
-# What3Words
+# ![what3words](https://map.what3words.com/images/map/marker-border.png)what3words Ruby wrapper
 
-Use the What3Words API in your Ruby app (see http://what3words.com/api/reference)
+Use the what3words API in your Ruby app (see http://developer.what3words.com/api)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
+    gem 'what3words', '~> 2.0'
 
 And then execute:
 
@@ -17,9 +18,9 @@ Or install it yourself as:
 
 ## Usage
 
-Sign up for an API key at http://what3words.com/api/signup
+Sign up for an API key at http://developer.what3words.com
 
-See http://what3words.com/api/reference for all parameters that can be
+See https://docs.what3words.com/api/v2/ for all parameters that can be
 passed to the API calls
 
 If not using Bundler, require it:
@@ -28,64 +29,76 @@ If not using Bundler, require it:
 
 Then:
 
-    what3words = What3Words::API.new(:key => "<your-api-key>")
+    what3words = What3Words::API.new(:key => "YOURAPIKEY")
 
-Convert 3 words into GPS coordinates
+Forward Geocode : convert a 3 word address into GPS coordinates (WGS-84)
 
-    what3words.words_to_position ["prom", "cape", "pump"]
-    # => [51.484463, -0.195405]
+    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"}
 
-Convert OneWord to GPS coordinates
+## API
+### Forward Geocoding
+Convert a 3 word address into GPS coordinates and return 3 words for the same position in a different language
 
-    what3words.words_to_position "LibertyTech"
-    # => [51.512573,-0.144879]
+    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"}
 
-Convert 3 words into GPS coordinates and return 3 words for the same position in a different language
+Supported keyword params for `forward` call:
 
-    what3words.words_to_position ["prom", "cape", "pump"], :full_response => true, :lang => "fr"
-    # => { :type => "3 words", :words => ["concevoir", "époque", "amasser"],
-           :position => [51.484463, -0.195405], :language: "fr" }
+* `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)
+* `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
 
-Supported keyword params for `words_to_position` call:
+### Reverse Geocoding
+Reverse Geocode : Convert position(latitude) information to a 3 word address
 
-* `full_response` (default false) - return the original response from the API
-* `language` (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)
-* `oneword_password` (default nil) - password for OneWord, if private
-* `corners` (default false) - "true" or "false" to return the coordinates of the w3w square. Will return an array with the southwest coordinates of the square and then the northeast coordinate
-* `email` (default nil) - user email if required for private OneWord
-* `password` (default nil) - user password if required for private OneWord
+    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 3 words
+Convert position information to a 3 word address in a specific language
 
-    what3words.position_to_words [51.484463, -0.195405]
-    # => ["prom", "cape", "pump"]
+    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"}
 
-Convert position information to 3 words in a different language
+Supported keyword params for `reverse` call:
 
-    what3words.position_to_words [51.484463, -0.195405], :lang => :fr
-    # => ["concevoir", "époque", "amasser"]
+* `lang` (defaults to en)  - optional language code
+* `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
 
-Supported keyword params for `position_to_words` call:
+### Autosuggest
+Returns a list of 3 word addresses based on user input and other parameters.
 
-    * `full_response` (default false) - return the original response from the API
-    * `language` (defaults to en)  - optional language code
-    * `corners` (default false) - "true" or "false" to return the coordinates of the w3w square. Will return an array with the southwest coordinates of the square and then the northeast coordinate
+This resource provides corrections for the following types of input error:
+- typing errors
+- spelling errors
+- misremembered words (e.g. singular vs. plural)
+- words in the wrong order
 
-Get list of available 3 word languages
+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.
 
-    what3words.languages
-    # => [ "en", "fr" ]
+see https://docs.what3words.com/api/v2/#autosuggest for detailed information
+
+Gets suggestions in italian for this address
+
+    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"}
 
-The `get_languages` call also returns the full response from the API
+Supported keyword params for `reverse` 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
 
-    what3words.languages :full_response => true
-    # => {:languages=>[{:code=>"de", :name_display=>"Deutsch"}, {:code=>"en", :name_display=>"English"}, ... ]}
+### Get Languages
+Get list of available 3 word languages
+
+    what3words.languages
+    # => {:languages=>[{:name=>"German", :native_name=>"Deutsch  (beta)", :code=>"de"}, {:name=>"Italian", :native_name=>"Italiano  (beta)", :code=>"it"}, {:name=>"Turkish", :native_name=>"Türkçe  (beta)", :code=>"tr"}, {:name=>"Portuguese", :native_name=>"Português  (beta)", :code=>"pt"}, {:name=>"French", :native_name=>"français, langue française  (beta)", :code=>"fr"}, {:name=>"Swedish", :native_name=>"svenska  (beta)", :code=>"sv"}, {:name=>"English", :native_name=>"English", :code=>"en"}, {:name=>"Russian", :native_name=>"русский язык  (beta)", :code=>"ru"}, {:name=>"Spanish; Castilian", :native_name=>"español, castellano  (beta)", :code=>"es"}, {:name=>"Swahili", :native_name=>"Kiswahili  (beta)", :code=>"sw"}], :status=>{:status=>200, :reason=>"OK"}, :thanks=>"Thanks from all of us at index.home.raft for using a what3words API"}
 
-See http://what3words.com/api/reference for the original API call documentation
+See http://developer.what3words.com for the original API call documentation
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/what3words and click "Fork" )
+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`)
@@ -93,5 +106,11 @@ See http://what3words.com/api/reference for the original API call documentation
 
 ### Testing
 
-1. Unit specs require no set up. Look in `spec/what3words`
-2. Integration specs that hit the API directly are in spec/integration, and need the file spec/config.yaml to be filled in (using spec/config.sample.yaml as a template) with valid details. It is only needed for testing private OneWord functionality
+ Prerequisite : we are using [bundler](https://rubygems.org/gems/bundler)
+    `$ gem install bundler`
+
+1. `$ cd w3w-ruby-wrapper`
+1. `$ bundle update`
+1. `$ rake spec`
+1. Mock Unit specs require no set up. Look in `spec/mock/`
+1. Integration specs that hit the API directly are in `spec/what3words`, and need the file `spec/config.yaml` to be filled in (using `spec/config.sample.yaml` as a template) with valid details.

data/lib/what3words/api.rb

@@ -9,13 +9,16 @@ module What3Words
     class ResponseError < Error; end
     class WordError < Error; end
 
-    REGEX_3_WORDS = /^\p{L}+\.\p{L}+\.\p{L}+$/u
-    REGEX_ONE_WORD = /^\*[\p{L}\-0-9]{6,31}$/u
+    REGEX_3_WORD_ADDRESS = /^\p{L}+\.\p{L}+\.\p{L}+$/u
+    REGEX_STRICT = /^\p{L}{4,}+\.\p{L}{4,}+\.\p{L}{4,}+$/u
+
+    BASE_URL = "https://api.what3words.com/v2/"
 
     ENDPOINTS = {
-      :words_to_position => "w3w",
-      :position_to_words => "position",
-      :languages => "get-languages"
+      :forward => "forward",
+      :reverse => "reverse",
+      :languages => "languages",
+      :autosuggest => "autosuggest"
     }
 
     def initialize(params)
@@ -24,67 +27,76 @@ module What3Words
 
     attr_reader :key
 
-    def words_to_position(words, params = {})
+    def forward(words, params = {})
       words_string = get_words_string words
-      request_params = assemble_w2p_request_params(words_string, params)
-      needs_ssl = needs_ssl?(request_params)
-      response = request! :words_to_position, request_params, needs_ssl
-      make_response(response, :position, params[:full_response])
+      request_params = assemble_forward_request_params(words_string, params)
+      response = request! :forward, request_params
+      response
     end
 
-    def position_to_words(position, params = {})
-      request_params = assemble_p2w_request_params(position, params)
-      response = request! :position_to_words, request_params
-      make_response(response, :words, params[:full_response])
+    def reverse(position, params = {})
+      request_params = assemble_reverse_request_params(position, params)
+      response = request! :reverse, request_params
+      response
     end
 
-    def languages(params = {})
-      request_params = assemble_common_request_params(params)
+    def languages()
+      request_params = assemble_common_request_params({})
       response = request! :languages, request_params
-      if params[:full_response]
-        response
-      else
-        response[:languages].map {|i| i[:code]}
-      end
+      response
+    end
+
+    def autosuggest(addr, lang, focus = {}, clip = {}, params = {})
+      request_params = assemble_autosuggest_request_params(addr, lang, focus, clip, params)
+      response = request! :autosuggest, request_params
+      response
     end
 
     def assemble_common_request_params(params)
       h = {:key => key}
-      h[:lang] = params[:language] if params[:language]
-      h[:corners] = true if params[:corners]
+      h[:lang] = params[:lang] if params[:lang]
+      h[:format] = params[:format] if params[:format]
+      h[:display] = params[:format] if params[:format]
       h
     end
     private :assemble_common_request_params
 
-    def assemble_w2p_request_params(words_string, params)
-      h = {:string => words_string}
-      h[:"oneword-password"] = params[:oneword_password] if params[:oneword_password]
-      h[:email] = params[:email] if params[:email]
-      h[:password] = params[:password] if params[:password]
+    def assemble_forward_request_params(words_string, params)
+      h = {:addr => words_string}
       h.merge(assemble_common_request_params(params))
     end
-    private :assemble_w2p_request_params
+    private :assemble_forward_request_params
 
-    def assemble_p2w_request_params(position, params)
-      h = {:position => position.join(",")}
+    def assemble_reverse_request_params(position, params)
+      h = {:coords => position.join(",")}
       h.merge(assemble_common_request_params(params))
     end
-    private :assemble_p2w_request_params
+    private :assemble_reverse_request_params
 
-    def make_response(response, part_response_key, need_full_response)
-      if need_full_response
-        response
-      else
-        response[part_response_key]
+    def assemble_autosuggest_request_params(addr, lang, focus, clip, params)
+      h = {:addr => addr}
+      h[:lang] = lang
+      if focus.respond_to? :join
+        h[:focus] = focus.join(",")
       end
+      h[:clip] = clip if clip.respond_to? :to_str
+      h.merge(assemble_common_request_params(params))
     end
-    private :make_response
-
-    def request!(endpoint_name, params, needs_ssl = false)
-      response = RestClient.post endpoint(endpoint_name, needs_ssl), params
+    private :assemble_autosuggest_request_params
+
+    def request!(endpoint_name, params)
+      # puts endpoint_name.inspect
+      # puts params.inspect
+      begin
+        response = RestClient.get endpoint(endpoint_name), params: params
+      rescue => e
+        response = e.response
+      end
+      # puts "#{response.to_str}"
+      # puts "Response status: #{response.code}"
       response = JSON.parse(response.body)
-      if response["error"].to_s.strip != ""
-        raise ResponseError, "#{response["error"]}: #{response["message"]}"
+      if response["code"].to_s.strip != ""
+        raise ResponseError, "#{response["code"]}: #{response["message"]}"
       end
       deep_symbolize_keys(response)
     end
@@ -103,8 +115,8 @@ module What3Words
     private :get_words_string
 
     def check_words(words)
-      unless REGEX_3_WORDS.match(words) or REGEX_ONE_WORD.match(words)
-        raise WordError, "#{words} is not valid 3 words or OneWord"
+      unless REGEX_3_WORD_ADDRESS.match(words)
+        raise WordError, "#{words} is not a valid 3 word address"
       end
       return words
     end
@@ -123,21 +135,14 @@ module What3Words
       ni
     end
 
-    def base_url(needs_ssl = false)
-      protocol = needs_ssl ? "https" : "http"
-      "#{protocol}://api.what3words.com/"
+    def base_url()
+      BASE_URL
     end
     private :base_url
 
-    def endpoint(name, needs_ssl)
-      return base_url(needs_ssl) + ENDPOINTS.fetch(name)
-    end
-
-    def needs_ssl?(params)
-      (params.has_key?(:email) and params.has_key?(:password)) or
-        params.has_key?(:"oneword-password")
+    def endpoint(name)
+      return base_url() + ENDPOINTS.fetch(name)
     end
-    private :needs_ssl?
 
   end
 end

data/lib/what3words/version.rb

@@ -1,3 +1,3 @@
 module What3Words
-  VERSION = "1.0.0"
+  VERSION = "2.0.0"
 end

data/spec/config.sample.yaml

@@ -1,4 +1,2 @@
 ---
 api_key: APIKEY
-private_one_word: "*PRIVATEWORD"
-private_one_word_password: PASSWORD

data/spec/lib/what3words/what3words_api_spec.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require "spec_helper"
+require "yaml"
+
+describe What3Words::API, "integration", :integration => true do
+
+  before(:all) do
+    WebMock.allow_net_connect!
+  end
+
+  let!(:config) do
+    file = "spec/config.yaml"
+    if ! File.exist? file
+      raise "Add a file #{file} (use spec/config.sample.yaml as a template) with correct values to run integration specs"
+    end
+    YAML.load_file file
+  end
+
+  let(:api_key) { config["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
+  end
+
+  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"
+      )
+      expect(result[:geometry]).to include(
+        :lat => "51.484463",
+        :lng => "-0.195405"
+      )
+    end
+
+    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"
+      )
+    end
+
+    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
+      result = w3w.reverse [29.567041, 106.587875]
+      expect(result).to include(
+        :words => "disclose.strain.redefined",
+        :language => "en"
+      )
+    end
+
+    it "from position in fr" do
+      result = w3w.reverse [29.567041, 106.587875], :lang => "fr"
+      expect(result).to include(
+        :words => "courgette.spécieuse.infrason",
+        :language => "fr"
+      )
+    end
+
+  end
+  describe "autosuggest" do
+    it "simple addr" do
+      result = w3w.autosuggest "trop.caler.perdre", "fr"
+    end
+
+    it "with focus" do
+      result = w3w.autosuggest "disclose.strain.redefin", "en", [29.567041, 106.587875]
+    end
+
+    it "with clipping radius around focus" do
+      result = w3w.autosuggest "disclose.strain.redefin", "en", [29.567041, 106.587875], "focus(10)"
+    end
+
+  end
+  describe "languages" do
+    it "gets all languages" do
+      result = w3w.languages
+      # expect(result[:languages]).to include(
+      #   :code => "fr"
+      # )
+    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})
+    end
+  end
+end

data/spec/mock/api_spec.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe What3Words::API do
+
+  before(:all) do
+    WebMock.disable_net_connect!
+  end
+
+  let(:api_key) { "APIkey" }
+
+  let(:w3w) { described_class.new(:key => api_key) }
+
+  # it "returns errors from API" do
+  #   stub_request(:get, "https://api.what3words.com/v2/forward").
+  #     to_return(:status => 200, :body => '{"code": "300", "message": "Invalid or non-existent 3 word address"}')
+  #
+  #   expect { w3w.forward "a.b.c" }.
+  #     to raise_error described_class::ResponseError
+  # end
+
+  describe "getting position" do
+
+    # def stub!(query_params, response_body = {})
+    #   stub_request(:get, "https://api.what3words.com/v2/forward").
+    #     with(:query => query_params).
+    #     to_return(:status => 200, :body => response_body.to_json)
+    # end
+
+    # it "sends 3 words given as string" do
+    #     # stub_request(:get, "https://api.what3words.com/v2/forward?addr=a.b.c&key=APIkey").
+    #     #     with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate', 'User-Agent'=>'Ruby'}).
+    #     #     to_return(:status => 200, :body => '{"words" :"a.b.c"}', :headers => {})
+    #     stub_request(:get, "https://api.what3words.com/v2/forward" ).
+    #         # with(query: hash_including({"addr" => "a.b.c"}, {"key" => :api_key})).
+    #         with(query: hash_including(:add => "abc", :key => :api_key)).
+    #         to_return(:status => 200, :body => '{"words" :"a.b.c"}')
+    # # stub! hash_including(:addr => "a.b.c")
+    #   result = w3w.forward "a.b.c"
+    #   puts result
+    # end
+
+    # it "extracts position from response" do
+    #   stub!(hash_including(:addr => "prom.cape.pump"), {"position" => [1, 2]})
+    #   result = w3w.forward "prom.cape.pump"
+    #   expect(result).to eq [1, 2]
+    # end
+
+    # it "returns full response instead of just coords" do
+    #   stub!(hash_including(:addr => "prom.cape.pump"),
+    #     {"thanks" => "Thanks from all of us at index.home.raft for using a what3words API"})
+    #   result = w3w.forward "prom.cape.pump", :full_response => true
+    #   expect(result).to eq :thanks => "Thanks from all of us at index.home.raft for using a what3words API"
+    # end
+
+    # it "sends lang option" do
+    #   stub!(hash_including(:addr => "prom.cape.pump", :lang => "fr"))
+    #   w3w.forward "prom.cape.pump", :language => "fr"
+    # end
+
+    # it "parses response errors" do
+    #   stub! hash_including(:addr => "prom.cape.pump"), {:error => "xx", :message => "msg"}
+    #   expect { w3w.forward "prom.cape.pump" }.
+    #     to raise_error described_class::ResponseError, "xx: msg"
+    # end
+
+    # it "checks 3 words as string matches standard regex" do
+    #   stub! anything
+    #   expect { w3w.words_to_position "1.cape.pump" }.
+    #     to raise_error described_class::WordError
+    # end
+
+  end
+
+  # describe "gets 3 words" do
+  #
+  #   def stub!(request_body, response_body = {})
+  #     stub_request(:get, "https://api.what3words.com/v2/reverse").
+  #       with(:body => request_body).
+  #       to_return(:status => 200, :body => response_body.to_json)
+  #   end
+  #
+  #   it "extracts 3 words from response" do
+  #     stub! hash_including(:position => "1,2"), {:words => "prom.cape.pump"}
+  #     expect(w3w.reverse([1, 2])).to eq "prom.cape.pump"
+  #   end
+  #
+  #   it "sends lang option" do
+  #     stub!(hash_including(:position => "1,2", :lang => "fr"))
+  #     w3w.position_to_words([1, 2], :language => "fr")
+  #   end
+  #
+  # end
+  #
+  # describe "getting available languages" do
+  #
+  #   def stub!(request_body, response_body = {})
+  #     stub_request(:get, "http://api.what3words.com/get-languages").
+  #       with(:body => request_body).
+  #       to_return(:status => 200, :body => response_body.to_json)
+  #   end
+  #
+  #   it "gets list of codes" do
+  #     stub! anything, {:languages => [{:code => "l1"}, {:code => "l2"}]}
+  #     expect(w3w.languages). to eq ["l1", "l2"]
+  #   end
+  #
+  #   it "gets full response" do
+  #     stub! anything, {:languages => [{:code => "l1"}, {:code => "l2"}]}
+  #     expect(w3w.languages :full_response => true).
+  #       to eq(:languages => [{:code => "l1"}, {:code => "l2"}])
+  #   end
+  # end
+
+  it "'s deep_symbolize_keys helper works" do
+    expect(w3w.deep_symbolize_keys("foo" => {"bar" => 1, "baz" => [{"quux" => "www"}]})).
+      to eq(:foo => {:bar => 1, :baz => [{:quux => "www"}]})
+  end
+end

data/spec/spec_helper.rb

@@ -6,10 +6,10 @@ require "webmock/rspec"
 
 require "what3words"
 
-RSpec.configure do |config|
-  config.filter_run_excluding :integration => true
-
-  config.before(:all) do
-    WebMock.disable_net_connect!
-  end
-end
+# RSpec.configure do |config|
+#   # config.filter_run_excluding :integration => true
+#
+#   config.before(:all) do
+#     WebMock.disable_net_connect!
+#   end
+# end

data/what3words.gemspec

@@ -7,9 +7,9 @@ require "what3words/version"
 Gem::Specification.new do |spec|
   spec.name = "what3words"
   spec.version = What3Words::VERSION
-  spec.authors = ["Asfand Yar Qazi"]
-  spec.email = ["ayqazi@gmail.com"]
-  spec.summary = "Query the what3words API in Ruby"
+  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"
 
@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rest-client"
+  spec.add_dependency "rest-client", "~> 1.8"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 11.1"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "webmock", "~> 2.0"
 end

metadata

@@ -1,92 +1,93 @@
 --- !ruby/object:Gem::Specification
 name: what3words
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- Asfand Yar Qazi
+- what3words
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: 
 email:
-- ayqazi@gmail.com
+- development@what3words.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
@@ -96,9 +97,8 @@ files:
 - lib/what3words/api.rb
 - lib/what3words/version.rb
 - spec/config.sample.yaml
-- spec/fixtures/LibertyTech.yaml
-- spec/integration/what3words_api_integration_spec.rb
-- spec/lib/what3words/api_spec.rb
+- spec/lib/what3words/what3words_api_spec.rb
+- spec/mock/api_spec.rb
 - spec/spec_helper.rb
 - what3words.gemspec
 homepage: http://rubygems.org/gems/what3words
@@ -121,14 +121,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Query the what3words API in Ruby
+summary: what3words API wrapper in Ruby
 test_files:
 - spec/config.sample.yaml
-- spec/fixtures/LibertyTech.yaml
-- spec/integration/what3words_api_integration_spec.rb
-- spec/lib/what3words/api_spec.rb
+- spec/lib/what3words/what3words_api_spec.rb
+- spec/mock/api_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/spec/fixtures/LibertyTech.yaml

@@ -1,30 +0,0 @@
----
-:type: OneWord
-:oneword: "*LibertyTech"
-:position:
-- 51.512573
-- -0.144879
-:info:
-  :name: Liberty Tech office
-  :address1: 124 New Bond Street
-  :address2: ''
-  :address3: ''
-  :city: London
-  :county: ''
-  :postcode: W1S 1DX
-  :country_id: '0'
-  :website: http://libertytech.com
-  :email: enquiries@libertytech.com
-  :telephone: 0207 493 8140
-  :delivery_notes: Ring bell number 7, we're on the top floor.
-  :notes: Top floor, lots of stairs!
-  :social_facebook: http://www.facebook.com/libertytech
-  :social_twitter: http://www.twitter.com/libertytech
-  :social_google: ''
-  :social_linkedin: ''
-  :social_instagram: ''
-:words:
-- boxer
-- overnight
-- crate
-:language: en

data/spec/integration/what3words_api_integration_spec.rb

@@ -1,106 +0,0 @@
-# encoding: utf-8
-
-require "spec_helper"
-require "yaml"
-
-describe What3Words::API, "integration", :integration => true do
-
-  before(:all) do
-    WebMock.allow_net_connect!
-  end
-
-  let!(:config) do
-    file = "spec/config.yaml"
-    if ! File.exist? file
-      raise "Add a file #{file} (use spec/config.sample.yaml as a template) with correct values to run integration specs"
-    end
-    YAML.load_file file
-  end
-
-  let(:api_key) { config["api_key"] }
-  let(:private_one_word) { config["private_one_word"] }
-  let(:private_one_word_password) { config["private_one_word_password"] }
-
-  let(:w3w) { described_class.new(:key => api_key) }
-
-  it "returns errors from API" do
-    badw3w = described_class.new(:key => "")
-    expect { badw3w.words_to_position ["prom", "cape", "pump"] }.
-      to raise_error described_class::ResponseError
-  end
-
-  describe "getting position" do
-
-    it "works with 3 words in array" do
-      result = w3w.words_to_position ["prom", "cape", "pump"]
-      expect(result).to eq [51.484463, -0.195405]
-    end
-
-    it "works with string of 3 words separated by '.'" do
-      result = w3w.words_to_position "prom.cape.pump"
-      expect(result).to eq [51.484463, -0.195405]
-    end
-
-    it "gets full response from API" do
-      result = w3w.words_to_position ["prom", "cape", "pump"], :full_response => true
-      expect(result).to eq( :type => "3 words", :words => ["prom", "cape", "pump"],
-       :position => [51.484463, -0.195405], :language => "en" )
-    end
-
-    it "sends all possible parameters for 3 words" do
-      result = w3w.words_to_position ["prom", "cape", "pump"], :full_response => true,
-        :language => "fr", :corners => true
-      expect(result).to eq(
-        :type => "3 words", :words => ["concevoir", "époque", "amasser"],
-        :position => [51.484463, -0.195405], :language => "fr",
-        :corners => [[51.484449, -0.195426], [51.484476, -0.195383]])
-    end
-
-    it "checks 3 words format matches standard regex" do
-      expect { w3w.words_to_position ["1", "cape", "pump"] }.
-        to raise_error described_class::WordError
-
-      expect { w3w.words_to_position "1.cape.pump" }.
-        to raise_error described_class::WordError
-    end
-
-    it "checks OneWord format matches standard regex" do
-      expect { w3w.words_to_position "123foo" }.
-        to raise_error described_class::WordError
-    end
-
-    it "works with a OneWord" do
-      result = w3w.words_to_position "*LibertyTech"
-      expect(result).to eq [51.512573, -0.144879]
-    end
-
-    it "disallows access to protected OneWord" do
-      expect { w3w.words_to_position private_one_word }.
-        to raise_error described_class::ResponseError
-    end
-
-    it "accesses OneWord protected by oneword password" do
-      expect(w3w.words_to_position private_one_word,
-        :oneword_password => private_one_word_password).
-        to eq [29.567043, 106.587865]
-    end
-
-    xit "accesses OneWord protected by user credentials (username & password)"
-  end
-
-  describe "gets 3 words" do
-    it "from position" do
-      expect(w3w.position_to_words [29.567041, 106.587875], :language => "fr").
-        to eq ["courgette", "approbateur", "infrason"]
-    end
-  end
-
-  it "gets languages" do
-    expect(w3w.languages).to include "en"
-  end
-
-  it "'s deep_symbolize_keys helper works" do
-    expect(w3w.deep_symbolize_keys("foo" => {"bar" => true})).
-      to eq(:foo => {:bar => true})
-  end
-end

data/spec/lib/what3words/api_spec.rb

@@ -1,155 +0,0 @@
-# encoding: utf-8
-
-require "spec_helper"
-
-describe What3Words::API do
-
-  before(:all) do
-    WebMock.disable_net_connect!
-  end
-
-  let(:api_key) { "APIkey" }
-
-  let(:w3w) { described_class.new(:key => api_key) }
-
-  it "returns errors from API" do
-    stub_request(:post, "http://api.what3words.com/w3w").
-      to_return(:status => 200, :body => '{"error": "XX", "message": "msg"}')
-
-    expect { w3w.words_to_position ["prom", "cape", "pump"] }.
-      to raise_error described_class::ResponseError
-  end
-
-  describe "getting position" do
-
-    def stub!(request_body, response_body = {}, protocol = "http")
-      r = stub_request(:post, "#{protocol}://api.what3words.com/w3w").
-        with(:body => request_body).
-        to_return(:status => 200, :body => response_body.to_json)
-    end
-
-    it "sends 3 words given as array" do
-      stub! hash_including(:string => "a.b.c")
-      result = w3w.words_to_position ["a", "b", "c"]
-    end
-
-    it "sends 3 words given as string" do
-      stub! hash_including(:string => "a.b.c")
-      result = w3w.words_to_position "a.b.c"
-    end
-
-    it "extracts position from response" do
-      stub! hash_including(:string => "a.b.c"), {"position" => [1, 2]}
-      result = w3w.words_to_position "a.b.c"
-      expect(result).to eq [1, 2]
-    end
-
-    it "returns full response instead of just coords" do
-      stub!(hash_including(:string => "a.b.c"),
-        {"full" => true})
-      result = w3w.words_to_position "a.b.c", :full_response => true
-      expect(result).to eq :full => true
-    end
-
-    it "sends lang option" do
-      stub!(hash_including(:string => "a.b.c", :lang => "fr"))
-      w3w.words_to_position "a.b.c", :language => "fr"
-    end
-
-    it "sends corners option" do
-      stub!(hash_including(:string => "a.b.c", :corners => "true"))
-      w3w.words_to_position "a.b.c", :corners => true
-    end
-
-    it "uses https for private OneWord with oneword-password" do
-      stub!(hash_including(:string => "a.b.c", :"oneword-password" => "oopw"),
-        {}, "https")
-      w3w.words_to_position "a.b.c", :oneword_password => "oopw"
-    end
-
-    it "uses https for private OneWord with email / password" do
-      stub!(hash_including(:string => "a.b.c", :email => "em", :password => "pw"),
-        {}, "https")
-      w3w.words_to_position "a.b.c", :email => "em", :password => "pw"
-    end
-
-    it "parses response errors" do
-      stub! hash_including(:string => "a.b.c"), {:error => "xx", :message => "msg"}
-      expect { w3w.words_to_position "a.b.c" }.
-        to raise_error described_class::ResponseError, "xx: msg"
-    end
-
-    it "checks 3 words as array matches standard regex" do
-      stub! anything
-      expect { w3w.words_to_position ["1", "cape", "pump"] }.
-        to raise_error described_class::WordError
-    end
-
-    it "checks 3 words as string matches standard regex" do
-      stub! anything
-      expect { w3w.words_to_position "1.cape.pump" }.
-        to raise_error described_class::WordError
-    end
-
-    it "checks OneWord format matches standard regex" do
-      stub! anything
-      expect { w3w.words_to_position "123foo" }.
-        to raise_error described_class::WordError
-    end
-  end
-
-  describe "gets 3 words" do
-
-    def stub!(request_body, response_body = {})
-      r = stub_request(:post, "http://api.what3words.com/position").
-        with(:body => request_body).
-        to_return(:status => 200, :body => response_body.to_json)
-    end
-
-    it "extracts 3 words from response" do
-      stub! hash_including(:position => "1,2"), {:words => ["a", "b", "c"]}
-      expect(w3w.position_to_words([1, 2])).to eq ["a", "b", "c"]
-    end
-
-    it "returns full response if asked" do
-      stub! hash_including(:position => "1,2"), {:full => "1"}
-      expect(w3w.position_to_words([1, 2], :full_response => true)).to eq(:full => "1")
-    end
-
-    it "sends lang option" do
-      stub!(hash_including(:position => "1,2", :lang => "fr"))
-      w3w.position_to_words([1, 2], :language => "fr")
-    end
-
-    it "sends corners option" do
-      stub!(hash_including(:position => "1,2", :corners => "true"))
-      w3w.position_to_words([1, 2], :corners => true)
-    end
-
-  end
-
-  describe "getting available languages" do
-
-    def stub!(request_body, response_body = {})
-      r = stub_request(:post, "http://api.what3words.com/get-languages").
-        with(:body => request_body).
-        to_return(:status => 200, :body => response_body.to_json)
-    end
-
-    it "gets list of codes" do
-      stub! anything, {:languages => [{:code => "l1"}, {:code => "l2"}]}
-      expect(w3w.languages). to eq ["l1", "l2"]
-    end
-
-    it "gets full response" do
-      stub! anything, {:languages => [{:code => "l1"}, {:code => "l2"}]}
-      expect(w3w.languages :full_response => true).
-        to eq(:languages => [{:code => "l1"}, {:code => "l2"}])
-    end
-  end
-
-  it "'s deep_symbolize_keys helper works" do
-    expect(w3w.deep_symbolize_keys("foo" => {"bar" => 1, "baz" => [{"quux" => "www"}]})).
-      to eq(:foo => {:bar => 1, :baz => [{:quux => "www"}]})
-  end
-end