regio 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23fef1e0c19ace88fc09034262df4f09ab9503ffad0d5052b34901e11012356
-  data.tar.gz: 11ca77e05f124d409f53c987ea9bb47951661d48f2bd6a9a52ed9464019f85b6
+  metadata.gz: 503356adbc6069f1dfd5cc6c965aef1dcd3a85bc4cf2600551bf050d45af3900
+  data.tar.gz: 198f74020d181bbb107a00f25d933e99e54daceaa73726300f1fa76a8efb9df2
 SHA512:
-  metadata.gz: f6987b0f7e02429e1bc4d035000dce128c1492f068a97f46e12594fbc90b8a89ceb1bd87d26d66ecf54222cf195cd63e8cdf051b9733afe93cd21b86068f51c0
-  data.tar.gz: 58bad3e737e130eeba54d5e9fa14f99590e9eb0eef9f8d2b44cfe95e306830e5faeb8b0833db805904aa4ccf2f038b16ed54f3f8ada7ec49a796644bd5cecfc0
+  metadata.gz: f844a02af39777cf32a749b4b5df59a50a95a584359711535fcbf38b222b1e0a8a2f41530e2f1ee5718b5ca0868130c2da4c9bee718a1c84a1b5dab7c226c5c2
+  data.tar.gz: 709352194bbb875a6e2394fdb85c22fd6bf42c74c50cd06516cac6faa39c4ab99ae4a3c3f7d78572ca97405c6d5a0857c872949381bbd31ee256e2b9de8f4e6e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change log
 
+## 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)
 
 * 1 major enhancement:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    regio (0.1.0)
+    regio (0.1.1)
       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.1.1'
 ```
 
 And then execute:
@@ -22,7 +24,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Get your own API key
+
+```shell
+REGIO_API_KEY=SECRET
+```
+
+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
+```
 
 ## Development
 

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

@@ -27,6 +27,8 @@ module Regio
     end
 
     def results
+      raise Unprocessable, response[:message] if response[:message]
+
       response.merge(
         collection: response[:data]&.map { |result| transform(result) } || []
       )

data/lib/regio/version.rb

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

data/lib/regio.rb

@@ -2,6 +2,10 @@
 
 require 'regio/configuration'
 require 'regio/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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: regio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - tab
@@ -162,6 +162,10 @@ files:
 - bin/setup
 - lib/regio.rb
 - lib/regio/configuration.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/version.rb
 - regio.gemspec