google-maps 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 102b89cceb3e12e754cf495744ec8044dadb0a06
-  data.tar.gz: ea3661301148cd5c9d140a5d5fa5d092d5d25717
+  metadata.gz: 8c9ea7de658231206acfde4f02867362e4b43953
+  data.tar.gz: e09e76851c8d3d2f963ade490ebcbff26b44703e
 SHA512:
-  metadata.gz: 713d16adce4b90aeb0e88e5090a5ed116c179057511d590d69204f6a8542b0943c74a5ae1e3253f152dae4ade162087415accbc5bce29918a715f29163179252
-  data.tar.gz: e490d7924df3db9ceb07163c290549f5fc89d9111201c9f40cffca7aac7a15326eb197cb50d767300e61b2a1dae3388befd08b852e1087052447426b4be479ab
+  metadata.gz: 603662cd8f896c0145d0d390feac907b909be471848cfb72674717fad7d0d39f22bc57005cb63a19106e14ec3c1f9bf29824c54381f6a269a119179d9f4231e6
+  data.tar.gz: 8fdf84b4466a49a63ce26ef28f7a77ae79ad291843942534337d869269820ee6f7d29c8e367bf0bcd6f9a7d4d42604c72a3db2d784e32c6ae0080f108bfcf189

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  Exclude:
+    - ./google-maps.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+  Max: 80
+
+Metrics/LineLength:
+  Max: 130
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/AbcSize:
+  Max: 20
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,9 @@
 language: ruby
 rvm:
-  - 2.1.5
   - 2.2.2
+  - 2.5.3
+before_install:
+  - gem install bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Gemfile

@@ -1,4 +1,6 @@
-source "http://rubygems.org"
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in google-maps.gemspec
 gemspec

data/README.md

@@ -0,0 +1,216 @@
+[![Gem Version](https://badge.fury.io/rb/google-maps.svg)](http://badge.fury.io/rb/google-maps)
+[![Build Status](https://travis-ci.org/zilverline/google-maps.svg?branch=master)](https://travis-ci.org/zilverline/google-maps)
+[![Coverage Status](https://coveralls.io/repos/zilverline/google-maps/badge.svg?branch=master)](https://coveralls.io/r/zilverline/google-maps?branch=master)
+[![Code Climate](https://codeclimate.com/repos/55671579695680044d01e0ac/badges/8f4d88f30585847e4fcf/gpa.svg)](https://codeclimate.com/repos/55671579695680044d01e0ac/feed)
+
+# Google Maps
+
+## Installation
+
+`gem install google-maps`
+
+Or add the following line to your Gemfile:
+
+`gem 'google-maps'`
+
+## Configuration
+
+You can either authenticate with an API key or a digital signature.
+
+API key:
+
+```ruby
+Google::Maps.configure do |config|
+  config.authentication_mode = Google::Maps::Authentication::API_KEY
+  config.api_key = 'xxxxxxxxxxx'
+end
+```
+
+Digital signature:
+
+```ruby
+Google::Maps.configure do |config|
+  config.authentication_mode = Google::Maps::Authentication::DIGITAL_SIGNATURE
+  config.client_id = 'xxxxxxxxxxx'
+  config.client_secret = 'xxxxxxxxxxx'
+end
+```
+
+### Default language
+
+Set the default language.
+
+```ruby
+Google::Maps.configure do |config|
+  config.default_language = :nl #dutch
+end
+```
+
+## Usage Examples
+
+### Distance
+
+```ruby
+  Google::Maps.distance("Science Park, Amsterdam", "Deventer")
+  #=> "105 km"
+  Google::Maps.distance("52.3545543,4.9519029", "Deventer")
+  #=> "105 km"
+```
+
+### Duration
+
+```ruby
+  Google::Maps.duration("Science Park, Amsterdam", "Deventer")
+  #=> "1 hour 12 mins"
+  Google::Maps.duration("52.3545543,4.9519029", "Deventer")
+  #=> "1 hour 12 mins"
+```
+
+### Route
+
+```ruby
+ route = Google::Maps.route("Science Park, Amsterdam", "Deventer")
+ route = Google::Maps.route("52.3545543,4.9519029", "Deventer")
+ route.distance.text
+ #=> "104 km"
+ route.duration.text
+ #=> "1 hour 12 mins"
+ route.distance.value
+ #=> 103712
+ route.duration.value
+ #=> 4337
+ route.steps
+ #=> [
+   {
+            "distance" => {
+      "text" => "0,1 km",
+     "value" => 125
+   },
+            "duration" => {
+      "text" => "1 min.",
+     "value" => 35
+   },
+        "end_location" => {
+     "lat" => 52.3556768,
+     "lng" => 4.9545739
+   },
+   "html_instructions" => "Rijd <b>naar het noordwesten</b>, richting het <b>Science Park</b>",
+            "polyline" => {
+     "points" => "oqp~Hqpf]?@?@?@KNOVEHA@A?s@wAQ]Q_@We@?A?ADI"
+   },
+      "start_location" => {
+     "lat" => 52.3549602,
+     "lng" => 4.9538473
+   },
+         "travel_mode" => "DRIVING"
+ },
+ {
+            "distance" => {
+      "text" => "37 m",
+      ........
+
+```
+
+### Options
+
+The distance, duration and route methods allow you to pass an options hash to the Directions API.
+All options can also be set as default_params for these services.
+
+```ruby
+Google::Maps.configure do |config|
+  ...
+  config.default_params = {
+    directions_service: {
+      mode: 'transit',
+      transit_routing_preference: 'fewer_transfers'
+    }
+  }
+  ...
+end
+
+```
+
+The following options are permitted:
+
+```ruby
+{
+  mode: 'driving', #default
+  transit_mode: 'train', #only used when mode is set to 'transit'
+  transit_routing_preference: 'fewer_transfers',
+  avoid: 'tolls',
+  arrival_time: 1545397430, # In seconds since midnight, January 1, 1970 UTC.
+  departure_time: 1545397430, # Cannot be in the past.
+}
+
+# NB! You can specify either departure_time or arrival_time, but not both.
+TRAVEL_MODES = [
+  'driving', #(Default) indicates standard driving directions using the road network.
+  'bicycling', #requests bicycling directions via bicycle paths & preferred streets.
+  'transit', #requests directions via public transit routes.
+  'walking'
+]
+
+TRANSIT_MODES = [
+  'bus',
+  'subway',
+  'train',
+  'tram',
+  'rail' # This is equivalent to transit_mode=train|tram|subway
+]
+
+TRANSIT_ROUTING_PREFERENCES = [
+  'less_walking', prefer limited amounts of walking.
+  'fewer_transfers' prefer a limited number of transfers.
+]
+
+AVOID = [
+  'tolls',
+  'highways',
+  'ferries',
+  'indoor', # Avoid indoor steps for walking and transit directions.
+]
+
+```
+
+### Places
+
+```ruby
+ places = Google::Maps.places('Amsterdam')
+ places.first.text
+ #=> "Amsterdam, Nederland"
+ places.first.place_id
+ #=> "ChIJVXealLU_xkcRja_At0z9AGY"
+
+ place = Google::Maps.place("ChIJVXealLU_xkcRja_At0z9AGY")
+
+ place.latitude
+ #=> "52.3679843"
+
+ place.longitude
+ #=> "4.9035614"
+
+ place.address
+ #=> "Amsterdam, Nederland"
+```
+
+### Geocode
+
+```ruby
+  geocodes = Google::Maps.geocode("Science Park, Amsterdam")
+  geocodes.first.address = "Science Park, 1012 WX Amsterdam, Nederland"
+  geocodes.first.latitude = 52.3545543
+  geocodes.first.longitude = 4.9540916
+```
+
+## Testing
+
+Run all tests:
+
+```
+  rspec spec/
+```
+
+## Copyright
+
+Copyright (c) 2011-2019 Zilverline.
+See [LICENSE](https://github.com/zilverline/google-maps/blob/master/LICENSE.md) for details.

data/Rakefile

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 namespace :doc do
   require 'yard'
@@ -13,7 +15,7 @@ namespace :doc do
     task.options = [
       '--protected',
       '--output-dir', 'doc/yard',
-      '--markup', 'markdown',
+      '--markup', 'markdown'
     ]
   end
-end
+end

data/google-maps.gemspec

@@ -1,34 +1,37 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "google-maps/version"
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require 'google_maps/version'
 
 Gem::Specification.new do |s|
-  s.name        = "google-maps"
+  s.name        = 'google-maps'
+  s.license     = 'MIT'
   s.version     = Google::Maps::VERSION
-  s.authors     = ["Daniel van Hoesel"]
-  s.email       = ["daniel@danielvanhoesel.nl"]
-  s.homepage    = "http://zilverline.com/"
-  s.summary     = %q{Ruby wrapper for the Google Maps API}
-  s.description = %q{This is a ruby wrapper for the Google Maps api}
+  s.authors     = ['Daniel van Hoesel']
+  s.email       = ['info@zilverline.com']
+  s.homepage    = 'http://zilverline.com/'
+  s.summary     = 'Ruby wrapper for the Google Maps API'
+  s.description = 'This is a ruby wrapper for the Google Maps api'
 
-  s.rubyforge_project = "google-maps"
+  s.rubyforge_project = 'google-maps'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
   s.add_development_dependency('bundler', '~> 1.0')
-  s.add_development_dependency('rake', '~> 0.9')
-  s.add_development_dependency('rspec', '~> 2.6')
-  s.add_development_dependency('rspec-its', '~> 1.0')
+  s.add_development_dependency('coveralls', '~> 0.8')
+  s.add_development_dependency('mocha', '~> 1.7.0')
+  s.add_development_dependency('rake', '~> 12.3.2')
+  s.add_development_dependency('rspec', '~> 3.8.0')
   s.add_development_dependency('rspec-collection_matchers', '~> 1.1')
-  s.add_development_dependency('mocha', '~> 0.10')
+  s.add_development_dependency('rspec-its', '~> 1.2')
+  s.add_development_dependency('rubocop', '~> 0.61.1')
   s.add_development_dependency('simplecov', '~> 0.5')
-  s.add_development_dependency('coveralls', '~> 0.8')
-  s.add_development_dependency('yard', '~> 0.7')
-  s.add_dependency('json', '>= 1.7.5')
-  s.add_dependency('hashie', '~> 2.0.5')
-  s.add_dependency('httpclient', '~> 2.7.1')
+  s.add_development_dependency('yard', '~> 0.9', '>= 0.9.11')
+  s.add_dependency('hashie', '~> 3.6', '>= 3.6.0')
+  s.add_dependency('httpclient', '~> 2.7', '>= 2.7.1')
+  s.add_dependency('json', '~> 2.1', '>= 2.1.0')
   s.add_dependency('ruby-hmac', '~> 0.4.0')
 end

data/lib/google_maps.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require File.expand_path('google_maps/configuration', __dir__)
+require File.expand_path('google_maps/logger', __dir__)
+require File.expand_path('google_maps/route', __dir__)
+require File.expand_path('google_maps/place', __dir__)
+require File.expand_path('google_maps/location', __dir__)
+
+module Google
+  module Maps
+    extend Configuration
+    extend Logger
+
+    def self.route(from, to, options = {})
+      Route.new(from, to, options_with_defaults(options))
+    end
+
+    def self.distance(from, to, options = {})
+      Route.new(from, to, options_with_defaults(options)).distance.text
+    end
+
+    def self.duration(from, to, options = {})
+      Route.new(from, to, options_with_defaults(options)).duration.text
+    end
+
+    def self.places(keyword, language = default_language)
+      Place.find(keyword, language)
+    end
+
+    def self.place(place_id, language = default_language)
+      PlaceDetails.find(place_id, language)
+    end
+
+    def self.geocode(address, language = default_language)
+      Location.find(address, language)
+    rescue ZeroResultsException
+      []
+    end
+
+    class << self
+      protected
+
+      def options_with_defaults(options)
+        { language: default_language }.merge(options)
+      end
+    end
+  end
+end

data/lib/google_maps/api.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# require 'net/http'
+require 'httpclient'
+require 'uri'
+require 'json'
+require 'base64'
+require 'hmac'
+require 'hmac-sha1'
+
+require_relative 'result'
+
+module Google
+  module Maps
+    class InvalidResponseException < StandardError; end
+    class InvalidPremierConfigurationException < StandardError; end
+    class ZeroResultsException < InvalidResponseException; end
+
+    class API
+      STATUS_OK = 'OK'.freeze
+      STATUS_ZERO_RESULTS = 'ZERO_RESULTS'.freeze
+
+      class << self
+        def query(service, args = {})
+          args = args.merge(Google::Maps.default_params[service]) if Google::Maps.default_params[service]
+          url = url(service, args)
+          response(url)
+        end
+
+        private
+
+        def decode_url_safe_base_64(value)
+          Base64.decode64(value.tr('-_', '+/'))
+        end
+
+        def encode_url_safe_base_64(value)
+          Base64.encode64(value).tr('+/', '-_')
+        end
+
+        def add_digital_signature(url)
+          parsed_url = url.is_a?(URI) ? url : URI.parse(url)
+          url_to_sign = parsed_url.path + '?' + parsed_url.query
+
+          # Decode the private key
+          raw_key = decode_url_safe_base_64(Google::Maps.client_secret)
+
+          # create a signature using the private key and the URL
+          sha1 = HMAC::SHA1.new(raw_key)
+          sha1 << url_to_sign
+          raw_sig = sha1.digest
+
+          # encode the signature into base64 for url use form.
+          signature = encode_url_safe_base_64(raw_sig)
+
+          # prepend the server and append the signature.
+          "#{parsed_url.scheme}://#{parsed_url.host}#{url_to_sign}&signature=#{signature}".strip
+        end
+
+        def response(url)
+          begin
+            result = Google::Maps::Result.new JSON.parse(HTTPClient.new.get_content(url))
+          rescue StandardError => error
+            Google::Maps.logger.error error.message.to_s
+            raise InvalidResponseException, "unknown error: #{error.message}"
+          end
+          handle_result_status(result.status)
+          result
+        end
+
+        def handle_result_status(status)
+          raise ZeroResultsException, "Google did not return any results: #{status}" if status == STATUS_ZERO_RESULTS
+          raise InvalidResponseException, "Google returned an error status: #{status}" if status != STATUS_OK
+        end
+
+        def url_with_api_key(service, args = {})
+          base_url(service, args.merge(api_key: Google::Maps.api_key))
+        end
+
+        def url_with_digital_signature(service, args = {})
+          url = base_url(service, args.merge(client: Google::Maps.client_id))
+          add_digital_signature(url)
+        end
+
+        def url(service, args = {})
+          if Google::Maps.authentication_mode == Google::Maps::Configuration::API_KEY
+            url_with_api_key(service, args)
+          elsif Google::Maps.authentication_mode == Google::Maps::Configuration::DIGITAL_SIGNATURE
+            url_with_digital_signature(service, args)
+          end
+        end
+
+        def base_url(service, args = {})
+          url = URI.parse("#{Google::Maps.end_point}#{Google::Maps.send(service)}/#{Google::Maps.format}#{query_string(args)}")
+          Google::Maps.logger.debug("url before possible signing: #{url}")
+          url.to_s
+        end
+
+        def query_string(args = {})
+          '?' + URI.encode_www_form(args) unless args.empty?
+        end
+      end
+    end
+  end
+end