regio 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 503356adbc6069f1dfd5cc6c965aef1dcd3a85bc4cf2600551bf050d45af3900
-  data.tar.gz: 198f74020d181bbb107a00f25d933e99e54daceaa73726300f1fa76a8efb9df2
+  metadata.gz: 86ff1a4469844d4dac8bb93c443ea9fe502f6ccc9c797527b084632b07ea1782
+  data.tar.gz: 927ccf0892657b996638c674626891d52e3fb7150e2c3958745eefcab2fccc41
 SHA512:
-  metadata.gz: f844a02af39777cf32a749b4b5df59a50a95a584359711535fcbf38b222b1e0a8a2f41530e2f1ee5718b5ca0868130c2da4c9bee718a1c84a1b5dab7c226c5c2
-  data.tar.gz: 709352194bbb875a6e2394fdb85c22fd6bf42c74c50cd06516cac6faa39c4ab99ae4a3c3f7d78572ca97405c6d5a0857c872949381bbd31ee256e2b9de8f4e6e
+  metadata.gz: 4e303ab24fb83061ab0356d4aae680513c60ffd61e5160132865b562d75918b2835b506c1d63adf2ce0db914cfab84ea4160065650c22d477b747881bb949ee1
+  data.tar.gz: '048f9e3a8a809f4faed5e312900231f4d94ecf343eac3be83188db7ce0f76b48a38ce6a8d2b39b806fed7d7c3d993baf65b22afe1d8f5d8c6c4feb13acd006bf'

data/.github/workflows/checks.yml

@@ -7,13 +7,17 @@ concurrency:
   cancel-in-progress: true
 jobs:
   rspec:
-    name: RSpec
+    name: RSpec with ruby ${{matrix.ruby}}
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1', head]
     steps:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1.2
+          ruby-version: ${{matrix.ruby}}
           bundler-cache: true
       - name: Test with RSpec
         run: COVERAGE=true bundle exec rspec

data/CHANGELOG.md

@@ -1,12 +1,25 @@
 # Change log
 
+## v0.3.0 (02.01.2023)
+
+* 2 major enhancements:
+  * Regio [routing](https://api.regio.ee/documentation/#docs/routing_and_directions)
+  * Regio [gazetteer](https://api.regio.ee/documentation/#docs/gazetteer)
+  * Minor refactoring
+
+## v0.2.0 (15.10.2022)
+
+* 1 major enhancement:
+  * Regio [reverse geocode](https://api.regio.ee/documentation/#docs/reverse_geocode)
+  * Minor refactoring
+
 ## v0.1.1 (9.10.2022)
 
 * 1 major enhancement:
   * Regio [geocode](https://api.regio.ee/documentation/#docs/geocode)
   * Minor improvements
 
-## v0.1.0 (8.10.2022)
+## v0.1.0 (9.10.2022)
 
 * 1 major enhancement:
     * Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    regio (0.1.1)
+    regio (0.3.0)
       httparty (~> 0.20.0)
 
 GEM
@@ -18,51 +18,51 @@ GEM
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    json (2.6.2)
+    json (2.6.3)
     mime-types (3.4.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
     public_suffix (5.0.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.6.0)
+    regexp_parser (2.6.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
-    rubocop-performance (1.15.0)
+    rubocop-performance (1.15.2)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (2.13.2)
+    rubocop-rspec (2.16.0)
       rubocop (~> 1.33)
     ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
@@ -84,11 +84,11 @@ DEPENDENCIES
   bundler (~> 2.3.0)
   rake (~> 13.0.6)
   regio!
-  rspec (~> 3.11.0)
+  rspec (~> 3.12.0)
   rubocop (~> 1.36)
   rubocop-performance (~> 1.15)
-  rubocop-rspec (~> 2.13.2)
-  simplecov (~> 0.21.2)
+  rubocop-rspec (~> 2.16.0)
+  simplecov (~> 0.22.0)
   webmock (~> 3.18.1)
 
 BUNDLED WITH

data/README.md

@@ -11,7 +11,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'regio', '~> 0.1.1'
+gem 'regio', '~> 0.3.0'
 ```
 
 And then execute:
@@ -30,7 +30,18 @@ Get your own API key
 REGIO_API_KEY=SECRET
 ```
 
-Use geocode class in your code
+```
+export REGIO_API_KEY=SECRET && irb -I lib
+
+irb(main):001:0> require 'regio'
+=> true
+
+...
+```
+
+### Geocoding
+
+Use `Geocode` class in your code
 
 ```ruby
 require 'regio'
@@ -52,6 +63,87 @@ class Geocoding
 end
 ```
 
+Check Regio [geocode](https://api.regio.ee/documentation/#docs/geocode) documentation
+
+### Reverse geocoding
+
+Use `ReverseGeocode` class in your code
+
+```ruby
+require 'regio'
+
+class Geocoding
+
+  private
+
+  def results
+    @results ||= Regio::ReverseGeocode.new(options).results
+  end
+
+  def options
+    {
+      lat: 59.4276340999273,
+      lng: 24.7790924770962
+    }
+  end
+end
+```
+
+Check Regio [reverse geocode](https://api.regio.ee/documentation/#docs/reverse_geocode) documentation
+
+### Gazetteer
+
+Use `Gazetteer` class in your code
+
+```ruby
+require 'regio'
+
+class Geocoding
+
+  private
+
+  def results
+    @results ||= Regio::Gazetteer.new(options).results
+  end
+
+  def options
+    {
+      id: 16004253,
+      query: 'address_children'
+    }
+  end
+end
+```
+
+Check Regio [Gazetteer](https://api.regio.ee/documentation/#docs/gazetteer) documentation
+
+### Routing and directions
+
+Use `Routing` class in your code
+
+```ruby
+require 'regio'
+
+class Routing
+
+  private
+
+  def results
+    @results ||= Regio::Routing.new(options).results
+  end
+
+  def options
+    {
+      coordinates: [[24.649138022268, 59.14048887149], [25.853136227622, 59.00678681919]],
+      service: 'optimize',
+      overview: 'full'
+    }
+  end
+end
+```
+
+Check Regio [routing and directions](https://api.regio.ee/documentation/#docs/routing_and_directions) documentation
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/regio/core.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'httparty'
+require 'json'
+
+module Regio
+  class Core
+    include HTTParty
+    base_uri 'https://api.regio.ee'
+
+    attr_accessor :options
+
+    def initialize(options = {})
+      @options = default_options.merge(options)
+    end
+
+    COMPONENTS = [
+      { name: :country, type: 'A0' },
+      { name: :county, type: 'A1' },
+      { name: :municipality, type: 'A2' },
+      { name: :settlement, type: 'A3' },
+      { name: :small_place, type: 'A4' },
+      { name: :street, type: 'A5' },
+      { name: :farmstead, type: 'A6' },
+      { name: :house, type: 'A7' },
+      { name: :apartment, type: 'A8' }
+    ].freeze
+
+    def run(path, params = {})
+      JSON.parse(self.class.get(path, query: params).body, symbolize_names: true)
+    end
+
+    private
+
+    def transform(result)
+      hash = default_hash_for(result)
+
+      COMPONENTS.each do |component|
+        item = result[:components].detect { |o| o[:type] == component[:type] }
+        hash[component[:name]] = item.nil? ? nil : item[:name]
+      end
+
+      hash
+    end
+
+    def default_hash_for(result)
+      {
+        regio_id: result[:id],
+        title: result[:address],
+        valid: result[:is_valid],
+        complete: result[:is_complete],
+        zipcode: result[:postcode],
+        lat: result[:geometry].last,
+        lon: result[:geometry].first
+      }
+    end
+  end
+end

data/lib/regio/gazetteer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Regio
+  class Gazetteer < Core
+    def results
+      raise Unprocessable, response[:message] if response[:message]
+
+      response.merge(
+        collection: response[:data]&.map { |result| transform(result) } || []
+      )
+    end
+
+    private
+
+    def response
+      @response ||= run('/gazetteer', options)
+    end
+
+    # NOTE: all options described in the documentation
+    # https://api.regio.ee/documentation/#docs/gazetteer
+    def default_options
+      {
+        apikey: Configuration.api_key,
+        address_format: 'long_address',
+        output_format: 'json'
+      }
+    end
+  end
+end

data/lib/regio/geocode.rb

@@ -1,31 +1,7 @@
 # frozen_string_literal: true
 
-require 'httparty'
-require 'json'
-
 module Regio
-  class Geocode
-    include HTTParty
-    base_uri 'https://api.regio.ee'
-
-    COMPONENTS = [
-      { name: :country, type: 'A0' },
-      { name: :county, type: 'A1' },
-      { name: :municipality, type: 'A2' },
-      { name: :settlement, type: 'A3' },
-      { name: :small_place, type: 'A4' },
-      { name: :street, type: 'A5' },
-      { name: :farmstead, type: 'A6' },
-      { name: :house, type: 'A7' },
-      { name: :apartment, type: 'A8' }
-    ].freeze
-
-    attr_accessor :options
-
-    def initialize(options = {})
-      @options = default_options.merge(options)
-    end
-
+  class Geocode < Core
     def results
       raise Unprocessable, response[:message] if response[:message]
 
@@ -37,7 +13,7 @@ module Regio
     private
 
     def response
-      JSON.parse(self.class.get('/geocode', query: options).body, symbolize_names: true)
+      @response ||= run('/geocode', options)
     end
 
     # NOTE: all options described in the documentation
@@ -52,28 +28,5 @@ module Regio
         limit: 25
       }
     end
-
-    def transform(result)
-      hash = default_hash_for(result)
-
-      COMPONENTS.each do |component|
-        item = result[:components].detect { |o| o[:type] == component[:type] }
-        hash[component[:name]] = item.nil? ? nil : item[:name]
-      end
-
-      hash
-    end
-
-    def default_hash_for(result)
-      {
-        regio_id: result[:id],
-        title: result[:address],
-        valid: result[:is_valid],
-        complete: result[:is_complete],
-        zipcode: result[:postcode],
-        lat: result[:geometry].last,
-        lon: result[:geometry].first
-      }
-    end
   end
 end

data/lib/regio/reverse_geocode.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Regio
+  class ReverseGeocode < Core
+    def results
+      raise Unprocessable, response[:message] if response[:message]
+
+      response.merge(
+        collection: response[:data]&.map { |result| transform(result) } || []
+      )
+    end
+
+    private
+
+    def response
+      @response ||= run('/revgeocode', options)
+    end
+
+    # NOTE: all options described in the documentation
+    # https://api.regio.ee/documentation/#docs/reverse_geocode
+    def default_options
+      {
+        apikey: Configuration.api_key,
+        address_format: 'long_address',
+        details: 'id,address,postcode,type,components,geometry,is_valid,is_complete',
+        output_format: 'json',
+        limit: 25
+      }
+    end
+  end
+end

data/lib/regio/routing.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Regio
+  class Routing < Core
+    def results
+      response.tap do |response|
+        raise Unprocessable, response[:message] if response[:message]
+      end
+    end
+
+    private
+
+    def response
+      options[:coordinates]&.map { |lnglat| lnglat.join(',') }&.join(';')
+
+      @response ||= run('/routing', options)
+    end
+
+    # NOTE: all options described in the documentation
+    # https://api.regio.ee/documentation/#docs/routing_and_directions
+    def default_options
+      {
+        apikey: Configuration.api_key,
+        output_format: 'json',
+        limit: 25
+      }
+    end
+  end
+end

data/lib/regio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Regio
-  VERSION = '0.1.1'
+  VERSION = '0.3.0'
 end

data/lib/regio.rb

@@ -1,7 +1,11 @@
 # frozen_string_literal: true
 
 require 'regio/configuration'
+require 'regio/core'
+require 'regio/gazetteer'
 require 'regio/geocode'
+require 'regio/reverse_geocode'
+require 'regio/routing'
 require 'regio/errors/failed'
 require 'regio/errors/forbidden'
 require 'regio/errors/not_found'

data/regio.gemspec

@@ -41,11 +41,11 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.3.0'
   spec.add_development_dependency 'rake', '~> 13.0.6'
-  spec.add_development_dependency 'rspec', '~> 3.11.0'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
   spec.add_development_dependency 'rubocop', '~> 1.36'
   spec.add_development_dependency 'rubocop-performance', '~> 1.15'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.13.2'
-  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.16.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
   spec.add_development_dependency 'webmock', '~> 3.18.1'
 
   spec.metadata['rubygems_mfa_required'] = 'true'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regio
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - tab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2023-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -100,28 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.2
+        version: 2.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.13.2
+        version: 2.16.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -162,11 +162,15 @@ files:
 - bin/setup
 - lib/regio.rb
 - lib/regio/configuration.rb
+- lib/regio/core.rb
 - lib/regio/errors/failed.rb
 - lib/regio/errors/forbidden.rb
 - lib/regio/errors/not_found.rb
 - lib/regio/errors/unprocessable.rb
+- lib/regio/gazetteer.rb
 - lib/regio/geocode.rb
+- lib/regio/reverse_geocode.rb
+- lib/regio/routing.rb
 - lib/regio/version.rb
 - regio.gemspec
 homepage: https://github.com/tab/regio