opencage-geocoder 3.2.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 659ab4a287039329a5825182e274109e9a29518c9e1f628eed8456dfa1dc2e2a
-  data.tar.gz: 59b641324b8245f20232c0f28e0ae3aadcb964621501e5380ac64590212c5229
+  metadata.gz: f11d2a8240c73511334898f87d7b72387197388e7671ee8b79c8f73a548f1c3d
+  data.tar.gz: 77f7af9c4383c989cafe6b543bb58b5c55b068e1c761d514af5fa162e257f32d
 SHA512:
-  metadata.gz: d043d2eb8b6a799c67b974346324656253fefda7f23b623a9e181ce0ebaaffbfcfd0d92ede87cf5a19e4f9d6746b64c8f2f36f1ce675f9ad5da2ba89488afbfa
-  data.tar.gz: 0fedba1f65b1f18761981f5f73c21315f17401fab233de11fe1def6ee97b95ce2cd9cd01bb9a4096eedb47552d76c843d447031440697437c91cce6ceaeb72e0
+  metadata.gz: d43fc84a8bb9beba2cc2b093e30916d18f6f130db7d46ac515c96c9dd8a9d4c4976a9eababb984501fde644916f23ef380f0075648b3ace946787e03984abb68
+  data.tar.gz: 3a0940493d1a0a2c3407749d01efe14340e1c9f88b09cf20dca1811d279d739a6085ed9c2a955a82a205194dcfe754ec3d32c338b255a21d3391bb01d8b23e50

data/lib/opencage/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenCage
   class Error < StandardError
     attr_reader :code

data/lib/opencage/geocoder/location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenCage
   class Geocoder
     class Location
@@ -18,13 +20,13 @@ module OpenCage
       end
 
       def lat
-        @result['geometry']['lat'].to_f
+        @result.dig('geometry', 'lat')&.to_f
       end
 
       alias latitude lat
 
       def lng
-        @result['geometry']['lng'].to_f
+        @result.dig('geometry', 'lng')&.to_f
       end
 
       alias longitude lng

data/lib/opencage/geocoder/request.rb

@@ -1,11 +1,28 @@
+# frozen_string_literal: true
+
 module OpenCage
   class Geocoder
     class Request
+      LOCALHOST_HOSTS = %w[localhost 127.0.0.1 0.0.0.0 ::1 [::1]].freeze
+
       def initialize(api_key, query, options = {})
         @host = options.fetch(:host, 'api.opencagedata.com')
+        validate_host!(@host)
         @params = options.merge(key: api_key, q: query)
       end
 
+      private
+
+      def validate_host!(host)
+        hostname = host.to_s.downcase.gsub(/(?<=\w):\d+\z/, '')
+        return if hostname.end_with?('.opencagedata.com')
+        return if LOCALHOST_HOSTS.include?(hostname)
+
+        raise ArgumentError, "Invalid host: #{host}. Must be a subdomain of opencagedata.com or localhost."
+      end
+
+      public
+
       def url
         uri = URI::HTTPS.build(host: @host, path: '/geocode/v1/json')
         uri.query = URI.encode_www_form(@params)

data/lib/opencage/geocoder.rb

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
+
 require 'opencage/geocoder/location'
 require 'opencage/geocoder/request'
 require 'opencage/error'
 require 'opencage/version'
 require 'open-uri'
+require 'net/http'
 require 'json'
 
 module OpenCage
@@ -13,17 +16,19 @@ module OpenCage
     end
 
     def geocode(location, options = {})
+      raise_error("400 Not a valid location: `#{location.inspect}`") unless location.is_a?(String)
+
       request = Request.new(@api_key, location, options)
 
       begin
         results = fetch(request.to_s)
       rescue Errno::ECONNREFUSED
-        raise_error("408 Failed to open TCP connection to API #{request}")
+        raise_error("408 Failed to open TCP connection to API #{redact_url(request)}")
       rescue Errno::ECONNRESET
         # Connection reset by peer - SSL_connect
-        raise_error("408 Failed to open SSL connection to API #{request}")
+        raise_error("408 Failed to open SSL connection to API #{redact_url(request)}")
       rescue Net::OpenTimeout
-        raise_error("408 Timeout connecting to API #{request}")
+        raise_error("408 Timeout connecting to API #{redact_url(request)}")
       end
 
       return [] unless results
@@ -32,8 +37,12 @@ module OpenCage
     end
 
     def reverse_geocode(lat, lng, options = {})
-      lat = to_float(lat)
-      lng = to_float(lng)
+      begin
+        lat = to_float(lat)
+        lng = to_float(lng)
+      rescue TypeError
+        raise_error("400 Not valid numeric coordinates: #{lat.inspect}, #{lng.inspect}")
+      end
 
       if [lat, lng].any? { |coord| !coord.is_a?(Numeric) }
         raise_error("400 Not valid numeric coordinates: #{lat.inspect}, #{lng.inspect}")
@@ -47,7 +56,7 @@ module OpenCage
     def fetch(url)
       JSON.parse(URI(url).open(headers).read)['results']
     rescue OpenURI::HTTPError => e
-      raise_error(e)
+      raise_error(e.io.status.join(' '))
     end
 
     def headers
@@ -60,6 +69,10 @@ module OpenCage
       raise klass.new(message: String(error), code: code.to_i)
     end
 
+    def redact_url(request)
+      request.to_s.gsub(/key=([^&]{6})[^&]*/, 'key=\1...[REDACTED]')
+    end
+
     def to_float(coord)
       Float(coord)
     rescue ArgumentError

data/lib/opencage/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OpenCage
-  VERSION = '3.2.4'.freeze
+  VERSION = '3.4.0'
 end

data/lib/opencage.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'opencage/version'
 require 'opencage/geocoder'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opencage-geocoder
 version: !ruby/object:Gem::Version
-  version: 3.2.4
+  version: 3.4.0
 platform: ruby
 authors:
 - Samuel Scully
 - Marc Tobias
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-02 00:00:00.000000000 Z
+date: 2026-03-29 00:00:00.000000000 Z
 dependencies: []
 description: A client for the OpenCage geocoding API - https://opencagedata.com/
 email: support@opencagedata.com
@@ -28,7 +27,10 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/opencagedata/ruby-opencage-geocoder
-post_install_message:
+  changelog_uri: https://github.com/opencagedata/ruby-opencage-geocoder/blob/master/CHANGES.txt
+  bug_tracker_uri: https://github.com/opencagedata/ruby-opencage-geocoder/issues
+  homepage_uri: https://opencagedata.com/tutorials/geocode-in-ruby
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -36,15 +38,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A client for the OpenCage geocoder API
 test_files: []