opencage-geocoder 0.1.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bb44eb7c577cea9176bf884e83a94160c8068f12
-  data.tar.gz: 3918ebe495c93729197ccad7d6eee5f8451a74c2
+SHA256:
+  metadata.gz: b8be287da65d2934bc08b6eb4d698c57bd258e99f12fc20785d0581afcd6137f
+  data.tar.gz: 839691909669db6d059b0a5411b5f2a87c53d064ac100b902eee020aefb40798
 SHA512:
-  metadata.gz: 7b838c50be09b64555f86e365ed03337e3ec2a1017af020f0fd4dc6877daeb765dbb8e60b1ae42255b356e4bc8ea7f61114c931561974d1fe61525b95fbafee4
-  data.tar.gz: d9d5e5d5ae02e553880a98829bec8048f5ce7eb77b6a86338b2accdd62d66c9ca5e2d2b653078a6c0df0cc5526d44717b49a5abd9b683c6c385ec0f51ad8a41f
+  metadata.gz: ce06b91a45a853bb28912dea17b23f4ca860ac11fb904226a910c6af4bbcbb330a4d8539a554beb1c87dc32228286fa7a628674c6dbec513fe8ca9085daa8c0a
+  data.tar.gz: 1526237436579aef61667d50a7616172d30a124398b920d7b0ca72a47f9c8bcf7a3c73950becdbd6a6ecf198256131d1093f1b58f24a1f2b4c2e50583a183834

data/lib/opencage/geocoder.rb

@@ -1,31 +1,50 @@
 require 'opencage/geocoder/location'
+require 'opencage/geocoder/request'
+require 'open-uri'
+require 'json'
 
 module OpenCage
   class Geocoder
     GeocodingError = Class.new(StandardError)
 
-    BASE_URL = "http://api.opencagedata.com/geocode/v1/json"
+    def initialize(default_options = {})
+      @api_key = default_options.fetch(:api_key) { raise GeocodingError, 'missing API key' }
+    end
+
+    def geocode(location, options = {})
+      request = Request.new(@api_key, location, options)
 
-    attr_reader :api_key
+      results = fetch(request.to_s)
+      return [] unless results
 
-    def initialize(options={})
-      @api_key = options.fetch(:api_key) { raise GeocodingError.new('missing API key') }
+      results.map { |r| Location.new(r) }
     end
 
-    def geocode(location)
-      Location.new(self, name: location).coordinates
+    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}"
+      end
+
+      geocode("#{lat},#{lng}", options).first
     end
 
-    def reverse_geocode(*coordinates)
-      # Accept input as numbers, strings or an array. Raise an error
-      # for anything that cannot be interpreted as a pair of floats.
-      lat, lng = coordinates.flatten.compact.map { |coord| Float(coord) }
+    private
 
-      Location.new(self, lat: lat, lng: lng).name
+    def fetch(url)
+      JSON.parse(URI(url).open.read)['results']
+    rescue OpenURI::HTTPError => e
+      raise GeocodingError, error_message(e)
     end
 
-    def url
-      "#{BASE_URL}?key=#{api_key}"
+    def error_message(error)
+      case String(error)
+      when /^403/
+        'invalid API key'
+      when /^402/
+        'out of quota'
+      else
+        error
+      end
     end
   end
 end

data/lib/opencage/geocoder/location.rb

@@ -1,64 +1,44 @@
-require 'open-uri'
-require 'json'
-
 module OpenCage
   class Geocoder
     class Location
-      attr_reader :geo, :name
-
-      def initialize(geo, options={})
-        @geo  = geo
-        @lat  = options[:lat]
-        @lng  = options[:lng]
-        @name = options[:name]
+      def initialize(result, _options = {})
+        @result = result
       end
 
-      def lat
-        @lat ||= results.first['geometry']['lat'].to_f
+      def raw
+        @result
       end
 
-      def lng
-        @lng ||= results.first['geometry']['lng'].to_f
-      end
-
-      def name
-        @name ||= results.first['formatted']
+      def address
+        @result['formatted']
       end
 
       def coordinates
-        [ lat, lng ]
+        [lat, lng]
       end
 
-      private
+      def lat
+        @result['geometry']['lat'].to_f
+      end
 
-      def results
-        @results ||= Array(fetch).tap do |results|
-          raise GeocodingError.new('location not found') if results.empty?
-        end
+      def lng
+        @result['geometry']['lng'].to_f
       end
 
-      def fetch
-        JSON.parse(open(url).read)['results']
-      rescue OpenURI::HTTPError => error
-        raise GeocodingError.new(error_message(error))
+      def components
+        @result['components']
       end
 
-      def url
-        uri = URI.parse(geo.url)
-        uri.query = [uri.query, "q=#{query}"].join('&')
-        uri
+      def annotations
+        @result['annotations']
       end
 
-      def query
-        if @lat && @lng && !@name
-          "#{lat},#{lng}"
-        elsif @name
-          URI::encode(@name)
-        end
+      def confidence
+        @result['confidence']
       end
 
-      def error_message(error)
-        (String(error) =~ /\A403/) ? 'invalid API key' : error
+      def bounds
+        @result['bounds']
       end
     end
   end

data/lib/opencage/geocoder/request.rb

@@ -0,0 +1,20 @@
+module OpenCage
+  class Geocoder
+    class Request
+      def initialize(api_key, query, options = {})
+        @host = options.fetch(:host, 'api.opencagedata.com')
+        @params = options.merge(key: api_key, q: query)
+      end
+
+      def url
+        uri = URI::HTTPS.build(host: @host, path: '/geocode/v1/json')
+        uri.query = URI.encode_www_form(@params)
+        uri
+      end
+
+      def to_s
+        url.to_s
+      end
+    end
+  end
+end

data/lib/opencage/version.rb

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

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: opencage-geocoder
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Samuel Scully
-autorequire: 
+- Marc Tobias
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-27 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies: []
-description: A client for the OpenCage Data geocoder API - http://geocoder.opencagedata.com/
-email: dev@lokku.com
+description: A client for the OpenCage Data geocoding API - https://opencagedata.com/
+email: support@opencagedata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -19,12 +20,14 @@ files:
 - lib/opencage.rb
 - lib/opencage/geocoder.rb
 - lib/opencage/geocoder/location.rb
+- lib/opencage/geocoder/request.rb
 - lib/opencage/version.rb
-homepage: https://github.com/lokku/ruby-opencage-geocoder
+homepage: https://opencagedata.com/tutorials/geocode-in-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/opencagedata/ruby-opencage-geocoder
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -32,16 +35,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: A client for the OpenCage Data geocoder API
 test_files: []