regio 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23fef1e0c19ace88fc09034262df4f09ab9503ffad0d5052b34901e11012356
-  data.tar.gz: 11ca77e05f124d409f53c987ea9bb47951661d48f2bd6a9a52ed9464019f85b6
+  metadata.gz: 58f1f77fb4ff83302a5591e138bface9f60913e2649727bee81b7460067d8d44
+  data.tar.gz: 7e10c3b4eb3826aaf0865888c98507f3cdf5a97e550f3100e8f91beb89bffe41
 SHA512:
-  metadata.gz: f6987b0f7e02429e1bc4d035000dce128c1492f068a97f46e12594fbc90b8a89ceb1bd87d26d66ecf54222cf195cd63e8cdf051b9733afe93cd21b86068f51c0
-  data.tar.gz: 58bad3e737e130eeba54d5e9fa14f99590e9eb0eef9f8d2b44cfe95e306830e5faeb8b0833db805904aa4ccf2f038b16ed54f3f8ada7ec49a796644bd5cecfc0
+  metadata.gz: 6702d492cb1b10ee6f6795ef16be9c1d7f8e36009d2e3667e513974b642ceed446c41a83e106b832176aa90f7eadc05d7185fb5c5f24b23f1a0e8676bb68975f
+  data.tar.gz: a9e6cf6a456cdcda8d5abb1adb718199df81295aca6bc1fe7d488276b5f6a7ba1aa6eb94f35435fb34e551b5c6bc3da9eabab1e26534918dd68bea080914f5e8

data/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Change log
 
-## v0.1.0 (8.10.2022)
+## 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 (9.10.2022)
 
 * 1 major enhancement:
     * Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    regio (0.1.0)
+    regio (0.2.0)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -1,5 +1,7 @@
 # Regio
 
+[![Gem Version](https://badge.fury.io/rb/regio.svg)](https://badge.fury.io/rb/regio)
+
 [Regio geocoding API](https://api.regio.ee/documentation/#docs/geocode) lets you search for addresses from complete Estonian address database.
 
 [Regio](https://www.regio.ee/en/)
@@ -9,7 +11,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'regio'
+gem 'regio', '~> 0.2.0'
 ```
 
 And then execute:
@@ -22,7 +24,64 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Get your own API key
+
+```shell
+REGIO_API_KEY=SECRET
+```
+
+### Geocoding
+
+Use `Geocode` class in your code
+
+```ruby
+require 'regio'
+
+class Geocoding
+
+  private
+
+  def results
+    @results ||= Regio::Geocode.new(options).results
+  end
+
+  def options
+    {
+      address: 'Tartu maantee 83',
+      country: 'ee'
+    }
+  end
+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
 

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/errors/failed.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Regio
+  class Failed < StandardError
+    def initialize(msg = 'Failed')
+      super
+    end
+
+    def http_status_code
+      400
+    end
+  end
+end

data/lib/regio/errors/forbidden.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Regio
+  class Forbidden < StandardError
+    def initialize(msg = 'Forbidden')
+      super
+    end
+
+    def http_status_code
+      403
+    end
+  end
+end

data/lib/regio/errors/not_found.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Regio
+  class NotFound < StandardError
+    def initialize(msg = 'Not found')
+      super
+    end
+
+    def http_status_code
+      403
+    end
+  end
+end

data/lib/regio/errors/unprocessable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Regio
+  class Unprocessable < StandardError
+    def initialize(msg = 'Unprocessable')
+      super
+    end
+
+    def http_status_code
+      422
+    end
+  end
+end

data/lib/regio/geocode.rb

@@ -1,32 +1,10 @@
 # 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]
+
       response.merge(
         collection: response[:data]&.map { |result| transform(result) } || []
       )
@@ -35,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
@@ -50,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.0'
+  VERSION = '0.2.0'
 end

data/lib/regio.rb

@@ -1,7 +1,13 @@
 # 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'
+require 'regio/errors/unprocessable'
 require 'regio/version'
 
 module Regio

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  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,7 +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