what3words 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 071822e06272c4806cc6493be469b6bf4e03224f
-  data.tar.gz: 73bd8cb619a5afc0828b1dd2eec47cf29c031f71
+  metadata.gz: b8bb59aca6fc868de0c381fdc1985b8f3e8650fe
+  data.tar.gz: c307fad087e52b9ff5c0db79a76e6e6bccb62ee8
 SHA512:
-  metadata.gz: 2fb0661e08c8e627deb26db2653b881dd5214eb5102b613ba7545ca2c45a45d150516c5e2f772182c5c5c85cf06362b7633713ca7402bcf586359d1abef9ae17
-  data.tar.gz: d5b964fdc28f5080ea62e421d4eaec85d4fd5c367cacb6ad1b30f2155ed379cea4a7ef5633fa83048fadf1d76da5169a8c3bad2b48f54e34940a60dad00ce334
+  metadata.gz: 213c3045d96f526edd78a59b0edc82cbbaab3a5f8f6549d21d9436c8b8d311dc416f567a91dbc71f42dd69118ca3bf76bf46b56a9e0f86eda407e4800f7c52f6
+  data.tar.gz: 20b182fadf5e36dde86988a48c81eaec52b1fc1dba6e06bb521c637e40e3882479460f3ba3843f45edf0a87ccf09c1cf2c73fb03975dd24b18be0e8b50a36e65

data/README.md

@@ -84,7 +84,37 @@ 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"}
 
-Supported keyword params for `reverse` call:
+Supported keyword params for `autosuggest` 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
+
+### Standardblend
+Returns a blend of the three most relevant 3 word address candidates for a given location, based on a full or partial 3 word address.
+
+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.
+
+see https://docs.what3words.com/api/v2/#standardblend for detailed information
+
+Gets blends in italian for this address
+
+    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"}
+
+Supported keyword params for `standardblend` 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
+
+### Grid
+Returns a section of the 3m x 3m what3words grid for a given area.
+
+see https://docs.what3words.com/api/v2/#grid for detailed information
+
+Gets blends in italian for this address
+
+    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
   * `display` Return display type; can be one of full (the default) or terse
 

data/lib/what3words/api.rb

@@ -18,7 +18,9 @@ module What3Words
       :forward => "forward",
       :reverse => "reverse",
       :languages => "languages",
-      :autosuggest => "autosuggest"
+      :autosuggest => "autosuggest",
+      :standardblend => "standardblend",
+      :grid => "grid"
     }
 
     def initialize(params)
@@ -40,6 +42,12 @@ module What3Words
       response
     end
 
+    def grid(bbox, params = {})
+      request_params = assemble_grid_request_params(bbox, params)
+      response = request! :grid, request_params
+      response
+    end
+
     def languages()
       request_params = assemble_common_request_params({})
       response = request! :languages, request_params
@@ -52,6 +60,12 @@ module What3Words
       response
     end
 
+    def standardblend(addr, lang, focus = {}, params = {})
+      request_params = assemble_standardblend_request_params(addr, lang, focus, params)
+      response = request! :standardblend, request_params
+      response
+    end
+
     def assemble_common_request_params(params)
       h = {:key => key}
       h[:lang] = params[:lang] if params[:lang]
@@ -67,6 +81,12 @@ module What3Words
     end
     private :assemble_forward_request_params
 
+    def assemble_grid_request_params(bbox, params)
+      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.merge(assemble_common_request_params(params))
@@ -84,6 +104,16 @@ module What3Words
     end
     private :assemble_autosuggest_request_params
 
+    def assemble_standardblend_request_params(addr, lang, focus, params)
+      h = {:addr => addr}
+      h[:lang] = lang
+      if focus.respond_to? :join
+        h[:focus] = focus.join(",")
+      end
+      h.merge(assemble_common_request_params(params))
+    end
+    private :assemble_standardblend_request_params
+
     def request!(endpoint_name, params)
       # puts endpoint_name.inspect
       # puts params.inspect

data/lib/what3words/version.rb

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

data/spec/lib/what3words/what3words_api_spec.rb

@@ -36,8 +36,8 @@ describe What3Words::API, "integration", :integration => true do
         :language => "en"
       )
       expect(result[:geometry]).to include(
-        :lat => "51.484463",
-        :lng => "-0.195405"
+        :lat => 51.484463,
+        :lng => -0.195405
       )
     end
 
@@ -88,12 +88,23 @@ describe What3Words::API, "integration", :integration => true do
     end
 
   end
+  describe "standardblend" do
+    it "simple addr" do
+      result = w3w.standardblend "trop.caler.perdre", "fr"
+    end
+
+    it "with focus" do
+      result = w3w.standardblend "disclose.strain.redefin", "en", [29.567041, 106.587875]
+    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
       result = w3w.languages
-      # expect(result[:languages]).to include(
-      #   :code => "fr"
-      # )
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: what3words
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - what3words
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -98,7 +98,6 @@ files:
 - lib/what3words/version.rb
 - spec/config.sample.yaml
 - spec/lib/what3words/what3words_api_spec.rb
-- spec/mock/api_spec.rb
 - spec/spec_helper.rb
 - what3words.gemspec
 homepage: http://rubygems.org/gems/what3words
@@ -128,5 +127,4 @@ summary: what3words API wrapper in Ruby
 test_files:
 - spec/config.sample.yaml
 - spec/lib/what3words/what3words_api_spec.rb
-- spec/mock/api_spec.rb
 - spec/spec_helper.rb

data/spec/mock/api_spec.rb

@@ -1,120 +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(: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