geoloco 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c53324fe06fb58786ff555b0a11d3ca0fd2bda60f489b31fd20ab4975266d2c
+  data.tar.gz: 6d6ac9d5df99653e1e2ab13fd956966cde186b6e3da50a105f62c869c96a82e0
+SHA512:
+  metadata.gz: 5165c03d95aa767769f1294b58135d29fba59e79ea88035dde945f3f95e410cf94643fcaaeeb58c0f92d897f8d46813adcc3d35ca88470ce1164b282604238ba
+  data.tar.gz: 8aaea202d406c55be223bef589a5e7c1dfcfa0d36e584cff04b68cb2c0af149647920eb2b9849beb248addf7c5a55afec0f5eab38fad3e0acbd4443f3b546493

data/.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: https://EditorConfig.org
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+trim_trailing_whitespace = true
+end_of_line = lf
+insert_final_newline = true
+
+# d space indentation
+[*.{js,jsx,rb,yml,yaml,scss,json,md}]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2
+deploy:
+  provider: rubygems
+  api_key:
+    secure: aCipdg6IqKaxQmWQXFlqI2JqGOrCAxzYlutOn6nCSk9VCzmlRjDoEp1M99ASvmF5CP3KQgfRq8bxfLql8jss8tymK0u2ExvKaUglK0zb2KoLQDGDGuHw3RxCTnaxPBuO4/2PuS+nso6IcdqUaGOzh8FA7ePKPBmxl3kyNtArEDV88Eyx6tQYs1/1w153bAeBk57nTiu8CPS+dIWg+guQADTLPZ61fH4xKjPWXnr65pFF7YtU5YdPBHFkqL60X384OZj1c7ZTGvFj70+36oo617HigSg8HCE+E0R1N4JQ8/5xo2yHBdrtgsAqYyYWRgm1C6qu+T6yKMuokdoSd0Ji3Rigz6VRrOJfjmQQkwMnno9fCY3vND62zOb9Ow+MCNuQYSgNHc+YPURKmT05wadG0FpZdmo6hstPusleuG89NxnB/s2YjR0QWQK05MW1uhFdru1S2gBd1fMH1GLoThhdfGG1UJSkKOipUJyRupFaB9zimJO3HwaTP0Q+wP8MGZDAqbyzQ3bJSZaQmJC6loC2EtxxnOQxUIxaySLtNEU2LOr9IijExj1ldXkz8X1fIWwRr6BPnIeChFnuST+L9UDYtqk1WgQTUs+tOAxUjepAWhtIUL5h3Jg2NZd9RxPXq8IngDWZJwT8yA3E9wloQx5JzTIMas5wHwCQJuwjjk5ibss=
+  gem: consent
+  on:
+    tags: true
+    repo: powerhome/consent

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in geoloco.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    geoloco (1.0.0)
+      httparty (>= 0.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    httparty (0.17.1)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    timecop (0.9.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  geoloco!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  timecop (>= 0.9)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Carlos Palhares
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Geoloco [![Build Status](https://travis-ci.org/powerhome/geoloco.svg?branch=master)](https://travis-ci.org/powerhome/geoloco)
+
+Geoloco is a multi-adpater geolocation gem, with error handling and test stubs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geoloco'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geoloco
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/powerhome/geoloco.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geoloco"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/geoloco.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geoloco/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'geoloco'
+  spec.version       = Geoloco::VERSION
+  spec.authors       = ['Carlos Palhares', 'Rafael Garcia']
+  spec.email         = ['chjunior@gmail.com']
+
+  spec.summary       = 'Multi adapter geolocation tool'
+  spec.description   = 'Multi adapter geolocation tool'
+  spec.homepage      = 'https://github.com/powerhome/geoloco'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '>= 0.14.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'timecop', '>= 0.9'
+end

data/lib/geoloco.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+require 'geoloco/geometry'
+require 'geoloco/location'
+require 'geoloco/version'
+require 'geoloco/adapters/fake'
+require 'geoloco/adapters/google'
+require 'geoloco/adapters/tomtom'
+
+# Geoloco is a multi-adpater geolocation gem, with error
+# handling and test stubs
+module Geoloco
+  # Top level Geoloco's error class
+  class Error < StandardError; end
+
+  # Error when an unknown adapter is given
+  class UnknownAdapter < Error; end
+
+  # Forbidden error class. Raised by adapters when a forbidden
+  # error is received from the providers
+  class Forbidden < Geoloco::Error
+    def initialize(response)
+      super "#{response.code} - #{response.body}"
+    end
+  end
+
+  class << self
+    attr_writer :config, :default_adapter, :http
+
+    def default_adapter
+      @default_adapter || :google
+    end
+
+    def config
+      @config || {}
+    end
+
+    def http
+      @http || HTTParty
+    end
+
+    # Geocodes a given query using the given adapter and options
+    #
+    # @param query [String] the query to geocode
+    # @param adapter [String,Symbol] the adapter to use
+    # @returns [Array<Geocode::Location>]
+    # @raise [Geoloco::Error] if an error occurs
+    # @raise [Geoloco::UnknownAdapter] if an unknown adapter is given
+    # @raise [Geoloco::Forbidden] if the geocoder API returns a 403 error
+    def geocode(query, adapter: default_adapter, **options)
+      adapter_config = config.fetch(adapter, {}).merge(options)
+      geocoder(adapter).geocode(query, **adapter_config)
+    end
+
+    private
+
+    def geocoder(adapter)
+      camelized = adapter.to_s.split('_').map(&:capitalize).join
+      Geoloco::Adapters.const_get(camelized)
+    rescue NameError
+      raise Geoloco::UnknownAdapter
+    end
+  end
+end

data/lib/geoloco/adapters/fake.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Geoloco
+  module Adapters
+    # Fake geocoding adapter
+    module Fake
+      class << self
+        DEFAULT_GEO = Geoloco::Geometry.new(lat: -19.9191248, lng: -43.9386291)
+
+        def geocode(address, **_options)
+          location = @stub || Geoloco::Location.new(
+            geometry: DEFAULT_GEO,
+            full_address: address
+          )
+          [location]
+        end
+
+        def stubbing(location)
+          @stub = location
+          yield
+          @stub = nil
+        end
+      end
+    end
+  end
+end

data/lib/geoloco/adapters/google.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'openssl'
+
+module Geoloco
+  module Adapters
+    # Google geocoding adapter
+    module Google
+      API_HOST = 'https://maps.googleapis.com'
+      GEOCODE_PATH = '/maps/api/geocode/json'
+
+      class << self
+        def geocode(address, client_id:, key:)
+          response = Geoloco.http.get(geocode_url(address, client_id, key))
+          handle_errors(response, response.parsed_response)
+          map_results(response.parsed_response)
+        end
+
+        private
+
+        def handle_errors(response, parsed)
+          raise Geoloco::Forbidden, response if response.code == 403
+
+          status = parsed&.dig('status')
+          return if status.eql?('OK')
+
+          message = parsed&.dig('error_message')
+
+          raise Geoloco::Error, [status, message].compact.join(' - ')
+        end
+
+        def map_results(parsed)
+          parsed.fetch('results', [])
+                .map(&method(:map_result))
+        end
+
+        # rubocop:disable Metrics/MethodLength, Metrics/LineLength, Metrics/AbcSize
+        def map_result(result)
+          loc = result.dig('geometry', 'location') || {}
+          geometry = Geoloco::Geometry.new(lat: loc['lat'], lng: loc['lng'])
+
+          Geoloco::Location.new(
+            geometry: geometry,
+            full_address: result.dig('formatted_address'),
+            street: get_component(result, 'route'),
+            city: get_component(result, 'locality'),
+            district: get_component(result, 'administrative_area_level_2'),
+            municipality: get_component(result, 'administrative_area_level_3'),
+            number: get_component(result, 'street_number'),
+            state: get_component(result, 'administrative_area_level_1'),
+            state_code: get_component(result, 'administrative_area_level_1', 'short_name'),
+            zipcode: get_component(result, 'postal_code'),
+            country: get_component(result, 'country'),
+            country_code: get_component(result, 'country', 'short_name')
+          )
+        end
+        # rubocop:enable Metrics/MethodLength, Metrics/LineLength, Metrics/AbcSize
+
+        def get_component(result, type, data = 'long_name')
+          result.fetch('address_components', [])
+                .find { |component| component['types'].include?(type) }
+                &.dig(data)
+        end
+
+        def geocode_url(address, client_id, key)
+          query = URI.encode_www_form(client: client_id, address: address)
+          signed_url(GEOCODE_PATH, query, key)
+        end
+
+        def signed_url(path, query, key)
+          decoded_key = Base64.decode64(key.tr('-_', '+/'))
+          path_query = "#{path}?#{query}"
+          signature = OpenSSL::HMAC.digest('sha1', decoded_key, path_query)
+          base64_signature = Base64.strict_encode64(signature).tr('+/', '-_')
+          "#{API_HOST}#{path_query}&signature=#{base64_signature}"
+        end
+      end
+    end
+  end
+end

data/lib/geoloco/adapters/tomtom.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Geoloco
+  module Adapters
+    # Tomtom geocoding adapter
+    module Tomtom
+      GEOCODE_URL = 'https://api.tomtom.com/search/2/geocode/%s.json'
+
+      class << self
+        def geocode(address, key:, qps_limit: 5)
+          wait_qps_limit_time(qps_limit) unless qps_limit&.zero?
+          response = Geoloco.http.get(geocode_url(address), query: { key: key })
+          handle_errors(response)
+          map_results(response.parsed_response)
+        end
+
+        private
+
+        def geocode_url(address)
+          escaped_address = CGI.escape(address)
+          format(GEOCODE_URL, escaped_address)
+        end
+
+        def handle_errors(response)
+          raise Geoloco::Forbidden, response if response.code == 403
+        end
+
+        def map_results(parsed)
+          parsed.fetch('results', [])
+                .map(&method(:map_result))
+        end
+
+        # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        def map_result(result)
+          address = result['address']
+          geometry = Geoloco::Geometry.new(
+            lat: result.dig('position', 'lat').to_f,
+            lng: result.dig('position', 'lon').to_f
+          )
+          Geoloco::Location.new(
+            geometry: geometry,
+            full_address: address['freeformAddress'],
+            street: address['streetName'], number: address['streetNumber'],
+            city: address['municipality'], zipcode: address['postalCode'],
+            district: address['countrySecondarySubdivision'],
+            municipality: address['countryTertiarySubdivision'],
+            state: address['countrySubdivisionName'],
+            state_code: address['countrySubdivision'],
+            country: address['country'], country_code: address['countryCode']
+          )
+        end
+        # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+        def wait_qps_limit_time(qps_limit)
+          time_since_last_call = @last_api_call ? Time.now - @last_api_call : 2
+          wait_time = 1.0 / qps_limit.to_f - time_since_last_call
+          sleep wait_time if wait_time.positive?
+          @last_api_call = Time.now
+        end
+      end
+    end
+  end
+end

data/lib/geoloco/geometry.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Geoloco
+  # Geometry data
+  #
+  # @attr [Float] lat latitude
+  # @attr [Float] lng longitude
+  Geometry = Struct.new(:lat, :lng, keyword_init: true)
+end

data/lib/geoloco/location.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Geoloco
+  Location = Struct.new(
+    :full_address, :street, :number, :zipcode,
+    :district, :city, :municipality, :geometry,
+    :state, :state_code, :country, :country_code,
+    keyword_init: true
+  )
+
+  # Location data
+  #
+  # @attr [String] full_address the fisical address
+  # @attr [String] street number on the street
+  # @attr [String] number number on the street
+  # @attr [String] zipcode the zipcode of the location
+  # @attr [String] district the district/county of the location
+  # @attr [String] city the city of the location
+  # @attr [String] state the full name of the state
+  # @attr [String] country the country
+  # @attr [String] country_code the 2-letter country code
+  # @attr [String] municipality the municipality which the location belongs
+  # @attr [Geoloco::Geometry] geometry latitude and longitude pair
+  # @attr [Float] lat latitude
+  # @attr [Float] lng longitude
+  class Location
+    extend Forwardable
+
+    def_delegators :geometry, :lat, :lng
+  end
+end

data/lib/geoloco/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Geoloco
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: geoloco
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Carlos Palhares
+- Rafael Garcia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Multi adapter geolocation tool
+email:
+- chjunior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- geoloco.gemspec
+- lib/geoloco.rb
+- lib/geoloco/adapters/fake.rb
+- lib/geoloco/adapters/google.rb
+- lib/geoloco/adapters/tomtom.rb
+- lib/geoloco/geometry.rb
+- lib/geoloco/location.rb
+- lib/geoloco/version.rb
+homepage: https://github.com/powerhome/geoloco
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/powerhome/geoloco
+  source_code_uri: https://github.com/powerhome/geoloco
+  changelog_uri: https://github.com/powerhome/geoloco
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Multi adapter geolocation tool
+test_files: []