regio 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 503356adbc6069f1dfd5cc6c965aef1dcd3a85bc4cf2600551bf050d45af3900
-  data.tar.gz: 198f74020d181bbb107a00f25d933e99e54daceaa73726300f1fa76a8efb9df2
+  metadata.gz: 58f1f77fb4ff83302a5591e138bface9f60913e2649727bee81b7460067d8d44
+  data.tar.gz: 7e10c3b4eb3826aaf0865888c98507f3cdf5a97e550f3100e8f91beb89bffe41
 SHA512:
-  metadata.gz: f844a02af39777cf32a749b4b5df59a50a95a584359711535fcbf38b222b1e0a8a2f41530e2f1ee5718b5ca0868130c2da4c9bee718a1c84a1b5dab7c226c5c2
-  data.tar.gz: 709352194bbb875a6e2394fdb85c22fd6bf42c74c50cd06516cac6faa39c4ab99ae4a3c3f7d78572ca97405c6d5a0857c872949381bbd31ee256e2b9de8f4e6e
+  metadata.gz: 6702d492cb1b10ee6f6795ef16be9c1d7f8e36009d2e3667e513974b642ceed446c41a83e106b832176aa90f7eadc05d7185fb5c5f24b23f1a0e8676bb68975f
+  data.tar.gz: a9e6cf6a456cdcda8d5abb1adb718199df81295aca6bc1fe7d488276b5f6a7ba1aa6eb94f35435fb34e551b5c6bc3da9eabab1e26534918dd68bea080914f5e8

data/CHANGELOG.md

@@ -1,12 +1,18 @@
 # Change log
 
+## 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.2.0)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -11,7 +11,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'regio', '~> 0.1.1'
+gem 'regio', '~> 0.2.0'
 ```
 
 And then execute:
@@ -30,7 +30,9 @@ Get your own API key
 REGIO_API_KEY=SECRET
 ```
 
-Use geocode class in your code
+### Geocoding
+
+Use `Geocode` class in your code
 
 ```ruby
 require 'regio'
@@ -52,6 +54,35 @@ 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
+
 ## 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/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)
+      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
+      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/version.rb

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

data/lib/regio.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regio
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - tab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-09 00:00:00.000000000 Z
+date: 2022-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -162,11 +162,13 @@ 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/geocode.rb
+- lib/regio/reverse_geocode.rb
 - lib/regio/version.rb
 - regio.gemspec
 homepage: https://github.com/tab/regio