opencage-geocoder 2.1.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a6a598a219823445df392dd72c8170cd52f68c84
-  data.tar.gz: 9eab3f4123c2b7cce317e1d4626166c27fd4ba11
+SHA256:
+  metadata.gz: '082f17ef74c65a95d5be53745bf7e7eabca63bfdb0626298d3d94aee90d6b137'
+  data.tar.gz: 1d32135b1afe9ff62f94b51bf4482fd977d6d2ce66ed94a801c2007892b87e23
 SHA512:
-  metadata.gz: 4218ec2294524d282e4e41adab2db257ee0ff24ab9706ae2c065c1554d832ef38f72176d0498551df60ece36b9d72afb9e8992c80804f303ca3fdfda2ab5ead4
-  data.tar.gz: 51e6eede32ece544efa1b95e3a7e592dde5fbdfeca537609a296439c88db61b4c324117be17965ebc18b8f1ac7d843a889009a68d2c21e6ff49d0b337b34aed2
+  metadata.gz: 10e91e1565f255b6bda63b03c92f445b5725008b817d83dee0238a487621409d55c2451f805fb20321412cfe7a8e04fee46f57afe979b6b89dd89718e16963b7
+  data.tar.gz: 9d43d9e52e6cd40fd57826528ae59bb06e7a35e7dcdaf8aea256d1d9c80f8abebd37acf54655672a88b4f2509491d0c39b290c53da03c84ed4a95293feba04d9

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/location.rb

@@ -36,6 +36,10 @@ module OpenCage
       def confidence
         @result['confidence']
       end
+
+      def bounds
+        @result['bounds']
+      end
     end
   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.2'.freeze
+  VERSION = '3.0.0'.freeze
 end

metadata

@@ -1,23 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: opencage-geocoder
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Samuel Scully
 - Marc Tobias
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-29 00:00:00.000000000 Z
+date: 2022-11-01 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
@@ -27,7 +28,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/opencagedata/ruby-opencage-geocoder
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -35,16 +36,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
-summary: A client for the OpenCage Data geocoder API
+summary: A client for the OpenCage geocoder API
 test_files: []