opencage-geocoder 2.1.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8be287da65d2934bc08b6eb4d698c57bd258e99f12fc20785d0581afcd6137f
-  data.tar.gz: 839691909669db6d059b0a5411b5f2a87c53d064ac100b902eee020aefb40798
+  metadata.gz: 0a45377335fbcf348c4f6028d9d0554dfb0d8558cf0274f3304b2b2614c63088
+  data.tar.gz: 67a68426b4382d5e76df2a1cd90a1be71ef7d2e9086b1874b83d7ace166530d9
 SHA512:
-  metadata.gz: ce06b91a45a853bb28912dea17b23f4ca860ac11fb904226a910c6af4bbcbb330a4d8539a554beb1c87dc32228286fa7a628674c6dbec513fe8ca9085daa8c0a
-  data.tar.gz: 1526237436579aef61667d50a7616172d30a124398b920d7b0ca72a47f9c8bcf7a3c73950becdbd6a6ecf198256131d1093f1b58f24a1f2b4c2e50583a183834
+  metadata.gz: 6ab099dc219724c8fb6768894dee3f6ebadd4d6adea2e65c0d0cf491c82d182d7cc52874018f4d8c9f1d10b0b284b09b99bc0a0ddd0e7578aa611df34ba81bad
+  data.tar.gz: 708c82535fb1decb99c9b4f81faf7093e172e466bfe6def5dfd5b9d2271bc17039bfa804b1efa7a00d8d2b3dd05cbe5c6ec80063aabad9ae688ababaed96ebde

data/lib/opencage/error.rb

@@ -0,0 +1,40 @@
+module OpenCage
+  class Error < StandardError
+    attr_reader :code
+
+    InvalidRequest = Class.new(self)
+    AuthenticationError = Class.new(self)
+    QuotaExceeded = Class.new(self)
+    Forbidden = Class.new(self)
+    InvalidEndpoint = Class.new(self)
+    NotAllowedMethod = Class.new(self)
+    Timeout = Class.new(self)
+    RequestTooLong = Class.new(self)
+    UpgradeRequired = Class.new(self)
+    TooManyRequests = Class.new(self)
+    InternalServer = Class.new(self)
+
+    def initialize(message:, code: nil)
+      super(message)
+      @code = code
+    end
+
+    ERRORS = {
+      0 => OpenCage::Error,
+      400 => OpenCage::Error::InvalidRequest,
+      401 => OpenCage::Error::AuthenticationError,
+      402 => OpenCage::Error::QuotaExceeded,
+      403 => OpenCage::Error::Forbidden,
+      404 => OpenCage::Error::InvalidEndpoint,
+      405 => OpenCage::Error::NotAllowedMethod,
+      408 => OpenCage::Error::Timeout,
+      410 => OpenCage::Error::RequestTooLong,
+      426 => OpenCage::Error::UpgradeRequired,
+      429 => OpenCage::Error::TooManyRequests,
+      500 => OpenCage::Error::InternalServer,
+      502 => OpenCage::Error::InternalServer,
+      503 => OpenCage::Error::InternalServer,
+      504 => OpenCage::Error::InternalServer
+    }.freeze
+  end
+end

data/lib/opencage/geocoder.rb

@@ -1,14 +1,13 @@
 require 'opencage/geocoder/location'
 require 'opencage/geocoder/request'
+require 'opencage/error'
 require 'open-uri'
 require 'json'
 
 module OpenCage
   class Geocoder
-    GeocodingError = Class.new(StandardError)
-
     def initialize(default_options = {})
-      @api_key = default_options.fetch(:api_key) { raise GeocodingError, 'missing API key' }
+      @api_key = default_options.fetch(:api_key) { raise_error('401 Missing API key') }
     end
 
     def geocode(location, options = {})
@@ -22,7 +21,7 @@ module OpenCage
 
     def reverse_geocode(lat, lng, options = {})
       if [lat, lng].any? { |coord| !coord.is_a?(Numeric) }
-        raise GeocodingError, "not valid numeric coordinates: #{lat.inspect}, #{lng.inspect}"
+        raise_error("400 Not valid numeric coordinates: #{lat.inspect}, #{lng.inspect}")
       end
 
       geocode("#{lat},#{lng}", options).first
@@ -33,18 +32,13 @@ module OpenCage
     def fetch(url)
       JSON.parse(URI(url).open.read)['results']
     rescue OpenURI::HTTPError => e
-      raise GeocodingError, error_message(e)
+      raise_error(e)
     end
 
-    def error_message(error)
-      case String(error)
-      when /^403/
-        'invalid API key'
-      when /^402/
-        'out of quota'
-      else
-        error
-      end
+    def raise_error(error)
+      code = String(error).slice(0, 3)
+      klass = OpenCage::Error::ERRORS[code.to_i]
+      raise klass.new(message: String(error), code: code.to_i)
     end
   end
 end

data/lib/opencage/version.rb

@@ -1,3 +1,3 @@
 module OpenCage
-  VERSION = '2.1.4'.freeze
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opencage-geocoder
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Samuel Scully
@@ -9,15 +9,16 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies: []
-description: A client for the OpenCage Data geocoding API - https://opencagedata.com/
+description: A client for the OpenCage geocoding API - https://opencagedata.com/
 email: support@opencagedata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/opencage.rb
+- lib/opencage/error.rb
 - lib/opencage/geocoder.rb
 - lib/opencage/geocoder/location.rb
 - lib/opencage/geocoder/request.rb
@@ -35,15 +36,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.3
 signing_key:
 specification_version: 4
-summary: A client for the OpenCage Data geocoder API
+summary: A client for the OpenCage geocoder API
 test_files: []