what3words 2.0.4 → 3.0.0

data/spec/lib/what3words/what3words_api_spec.rb

@@ -1,115 +1,297 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require "spec_helper"
+require 'spec_helper'
 
-describe What3Words::API, "integration", :integration => true do
+# to run the test type on terminal --> bundle exec rspec
 
+describe What3Words::API, 'integration', integration: true do
   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: 'BADKEY')
+    expect { badw3w.convert_to_coordinates '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
+    # @:param string words: A 3 word address as a string
+    # @:param string format: Return data format type; can be one of json (the default), geojson
+    it 'works with string of 3 words separated by \'.\'' do
+      result = w3w.convert_to_coordinates '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
+      expect(result[:coordinates]).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"
+    it 'sends language parameter for 3 words' do
+      result = w3w.convert_to_coordinates 'prom.cape.pump'
       expect(result).to include(
-        :words => "concevoir.époque.amasser",
-        :language => "fr"
+        words: 'prom.cape.pump',
+        language: 'en'
       )
     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.convert_to_coordinates '1.cape.pump' }
+        .to raise_error described_class::WordError
     end
 
+    it 'sends json parameter for 3 words' do
+      result = w3w.convert_to_coordinates 'prom.cape.pump', format: 'json'
+      expect(result).to include(
+        words: 'prom.cape.pump',
+        language: 'en',
+        country: 'GB',
+        square: {
+          'southwest': {
+            'lng': -0.195426,
+            'lat': 51.484449
+          },
+          'northeast': {
+            'lng': -0.195383,
+            'lat': 51.484476
+          }
+        },
+        nearestPlace: 'Kensington, London',
+        coordinates: {
+          'lng': -0.195405,
+          'lat': 51.484463
+        },
+        map: 'https://w3w.co/prom.cape.pump'
+      )
+    end
   end
 
-  describe "gets 3 words" do
-    it "from position" do
-      result = w3w.reverse [29.567041, 106.587875]
+  describe 'gets 3 words' do
+    # @:param coordinates: the coordinates of the location to convert to 3 word address
+    it 'from position' do
+      result = w3w.convert_to_3wa [29.567041, 106.587875], format: 'json'
       expect(result).to include(
-        :words => "disclose.strain.redefined",
-        :language => "en"
+        words: 'disclose.strain.redefined',
+        language: 'en'
+      )
+      expect(result[:coordinates]).to include(
+        lat: 29.567041,
+        lng: 106.587875
       )
     end
 
-    it "from position in fr" do
-      result = w3w.reverse [29.567041, 106.587875], :lang => "fr"
+    it 'from position in fr' do
+      result = w3w.convert_to_3wa [29.567041, 106.587875], language: 'fr', format: 'json'
       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
-      # result =
-      w3w.autosuggest "trop.caler.perdre", "fr"
+
+  describe 'autosuggest' do
+    it 'single input returns suggestions' do
+      # @:param string input: The full or partial 3 word address to obtain
+      # suggestions for. At minimum this must be the first two complete words
+      # plus at least one character from the third word.
+      result = w3w.autosuggest 'disclose.strain.redefin'
+      expect(result).not_to be_empty
     end
 
-    it "with focus" do
-      # result =
-      w3w.autosuggest "disclose.strain.redefin", "en", [29.567041, 106.587875]
+    it 'simple input will return 3 suggestions' do
+      # @:param string input: The full or partial 3 word address to obtain
+      # suggestions for. At minimum this must be the first two complete words
+      # plus at least one character from the third word.
+      result = w3w.autosuggest 'disclose.strain.redefin', language: 'en'
+      n_default_results = result[:suggestions].count
+      expect(n_default_results).to eq(3)
     end
 
-    it "with clipping radius around focus" do
-      # result =
-      w3w.autosuggest "disclose.strain.redefin", "en", [29.567041, 106.587875], "focus(10)"
+    it 'sends language parameter to an input in a different language' do
+      # @:param string language: A supported 3 word address language as an
+      # ISO 639-1 2 letter code.
+      result = w3w.autosuggest 'trop.caler.perdre', language: 'fr'
+      language = result[:suggestions]
+      language.each do |item|
+        item.each do |k, v|
+          if k == 'language'
+            expect(v).to eq('fr')
+          end
+        end
+      end
     end
 
-  end
-  describe "standardblend" do
-    it "simple addr" do
-      # result =
-      w3w.standardblend "trop.caler.perdre", "fr"
+    it 'sends arabic language as a different input' do
+      result = w3w.autosuggest 'مربية.الصباح.المده', language: 'ar'
+      expect(result).not_to be_empty
     end
 
-    it "with focus" do
-      # result =
-      w3w.standardblend "disclose.strain.redefin", "en", [29.567041, 106.587875]
+    it 'with n-results' do
+      # @:param int n_results: The number of AutoSuggest results to return.
+      # A maximum of 100 results can be specified, if a number greater than this is
+      # requested, this will be truncated to the maximum. The default is 3.
+      result = w3w.autosuggest 'disclose.strain.redefin', language: 'en', 'n-results': 10
+      # puts result[:suggestions].count
+      n_results = result[:suggestions].count
+      expect(n_results).to be >= 10
+    end
+
+    it 'with n-focus-results' do
+      # @:param int n_focus_results: Specifies the number of results (must be <= n_results)
+      # within the results set which will have a focus. Defaults to
+      # n_results. This allows you to run autosuggest with a mix of
+      # focussed and unfocussed results, to give you a "blend" of the two.
+      result = w3w.autosuggest 'disclose.strain.redefin', language: 'en', 'n-focus-results': 3
+      # puts result[:suggestions].count
+      n_focus_results = result[:suggestions].count
+      expect(n_focus_results).to be >= 3
+    end
+
+    it 'with input-type chenged to generic-voice' do
+      # @:param string input-type: For power users, used to specify voice input mode. Can be
+      # text (default), vocon-hybrid, nmdp-asr or generic-voice.
+      result = w3w.autosuggest 'fun with code', 'input-type': 'generic-voice', language: 'en'
+      suggestions = result[:suggestions]
+      output = ['fund.with.code', 'funk.with.code', 'fund.with.cove']
+      suggestions.each_with_index do |item, index|
+        # puts item[:words]
+        expect(item[:words]).to eq(output[index])
+      end
+
+      expect(result).not_to be_empty
+    end
+
+    xit 'with prefer-land' do
+      # @:param string prefer-land: Makes autosuggest prefer results on land to those in the sea.
+      # This setting is on by default. Use false to disable this setting and receive more suggestions in the sea.
+      result_sea = w3w.autosuggest 'disclose.strain.redefin', 'prefer-land': false, 'n-results': 10
+      result_sea_suggestions = result_sea[:suggestions]
+
+      result_land = w3w.autosuggest 'disclose.strain.redefin', 'prefer-land': true, 'n-results': 10
+      result_land_suggestions = result_land[:suggestions]
+
+      expect(result_sea_suggestions).not_to eq(result_land_suggestions)
+    end
+
+    it 'with clip_to_country' do
+      # @:param string clip-to-country: Restricts autosuggest to only return results inside the
+      # countries specified by comma-separated list of uppercase ISO 3166-1
+      # alpha-2 country codes (for example, to restrict to Belgium and the
+      # UK, use clip_to_country="GB,BE")
+      result = w3w.autosuggest 'disclose.strain.redefin', 'clip-to-country': 'GB,BE'
+      country = result[:suggestions]
+      country.each do |item|
+        item.each do |k, v|
+          if k == 'country'
+            if v == 'GB'
+              expect(v).to eq('GB')
+            else
+              expect(v).to eq('BE')
+            end
+          end
+        end
+      end
+    end
+
+    it 'with clip-to-bounding-box' do
+      # @:param clip-to-bounding-box: Restrict autosuggest results to a bounding
+      # box, specified by coordinates.
+      result = w3w.autosuggest 'disclose.strain.redefin', 'clip-to-bounding-box': [51.521, -0.343, 52.6, 2.3324]
+      suggestions = result[:suggestions]
+      expect(suggestions).to include(
+        country: 'GB',
+        nearestPlace: 'Saxmundham, Suffolk',
+        words: 'discloses.strain.reddish',
+        rank: 1,
+        language: 'en'
+      )
+    end
+
+    it 'with clip-to-bounding-box raise BadClipToBoundingBox error with 3 coordinates' do
+      # @:param clip-to-bounding-box: Restrict autosuggest results to a bounding
+      # box, specified by coordinates.
+      expect { w3w.autosuggest 'disclose.strain.redefin', 'clip-to-bounding-box': [51.521, -0.343, 52.6] }
+        .to raise_error described_class::ResponseError
+    end
+
+    it 'with clip-to-bounding-box raise 2nd BadClipToBoundingBox error' do
+      # @:param clip-to-bounding-box: Restrictautosuggest results to a bounding
+      # box, specified by coordinates.
+      expect { w3w.autosuggest 'disclose.strain.redefin', 'clip-to-bounding-box': [51.521, -0.343, 55.521, -5.343] }
+        .to raise_error described_class::ResponseError
+    end
+
+    it 'with clip-to-circle' do
+      # @:param clip-to-circle: Restrict autosuggest results to a circle, specified by
+      # the center of the circle, latitude and longitude, and a distance in
+      # kilometres which represents the radius. For convenience, longitude
+      # is allowed to wrap around 180 degrees. For example 181 is equivalent
+      # to -179.
+      result = w3w.autosuggest 'disclose.strain.redefin', 'clip-to-circle': [51.521, -0.343, 142]
+      suggestions = result[:suggestions]
+      expect(suggestions).to include(
+        country: 'GB',
+        nearestPlace: 'Market Harborough, Leicestershire',
+        words: 'discloses.strain.reduce',
+        rank: 1,
+        language: 'en'
+      )
+    end
+
+    it 'with clip-to-polygon' do
+      # @:param clip-to-polygon: Restrict autosuggest results to a polygon,
+      # specified by a list of coordinates. The polygon
+      # should be closed, i.e. the first element should be repeated as the
+      # last element; also the list should contain at least 4 entries.
+      # The API is currently limited to accepting up to 25 pairs.
+      result = w3w.autosuggest 'disclose.strain.redefin', 'clip-to-polygon': [51.521, -0.343, 52.6, 2.3324, 54.234, 8.343, 51.521, -0.343]
+      suggestions = result[:suggestions]
+      expect(suggestions).to include(
+        country: 'GB',
+        nearestPlace: 'Saxmundham, Suffolk',
+        words: 'discloses.strain.reddish',
+        rank: 1,
+        language: 'en'
+      )
     end
   end
-  describe "grid" do
-    it "string input" do
-      # result =
-      w3w.grid "52.208867,0.117540,52.207988,0.116126"
+
+  describe 'grid_section' do
+    # @:param bounding-box: Bounding box, specified by the northeast and
+    # southwest corner coordinates, for which the grid
+    # should be returned.
+    it 'string input not empty' do
+      result = w3w.grid_section '52.208867,0.117540,52.207988,0.116126'
+      expect(result).not_to be_empty
+    end
+    it 'bad bounding box error if the bbox is greater 4km' do
+      expect { w3w.grid_section '50.0,178,50.01,180.0005' }
+        .to raise_error described_class::ResponseError
     end
   end
-  describe "languages" do
-    it "gets all languages" do
-      # result =
-      w3w.languages
+
+  describe 'available_languages' do
+    it 'gets all available languages' do
+      result = w3w.available_languages
+      all_languages = result[:languages].count
+      expect(all_languages).to be >= 51
+    end
+    it 'it does not return an empty list' do
+      result = w3w.available_languages
+      expect(result).not_to be_empty
     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,9 @@
-require "bundler/setup"
+# frozen_string_literal: true
+
+require 'bundler/setup'
 
 Bundler.setup
 
-require "webmock/rspec"
+require 'webmock/rspec'
 
-require "what3words"
+require 'what3words'

data/what3words.gemspec

@@ -1,27 +1,31 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "what3words/version"
+require 'what3words/version'
 
 Gem::Specification.new do |spec|
-  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.name          = 'what3words'
+  spec.version       = What3Words::VERSION
+  spec.authors       = ['what3words']
+  spec.email         = ['development@what3words.com']
+  spec.description   = 'A Ruby wrapper fo the what3words API'
+  spec.summary       = 'Ruby wrapper for the what3words API'
+  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.platform      = Gem::Platform::RUBY
+  spec.required_ruby_version = '~> 2.6'
 
-  spec.add_dependency "rest-client", "~> 1.8"
+  spec.add_dependency('rest-client', '>= 1.8', '< 3.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 'bundler', '>= 1.7.9'
+  spec.add_development_dependency 'rake', '~> 11.1'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rubocop', '~> 0.48.1'
+  spec.add_development_dependency 'webmock', '~> 3.0'
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: what3words
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 3.0.0
 platform: ruby
 authors:
 - what3words
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2022-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,21 +72,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !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
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-description: 
+        version: '3.0'
+description: A Ruby wrapper fo the what3words API
 email:
 - development@what3words.com
 executables: []
@@ -111,20 +131,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: what3words API wrapper in Ruby
+summary: Ruby wrapper for the what3words API
 test_files:
 - spec/config.sample.yaml
 - spec/lib/what3words/what3words_api_spec.rb