google_maps_service 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03d75b9918a795abfabe46f98659846b37979be9
-  data.tar.gz: 7a501e622f0d8898ad38b65b30e9957fce151aad
+  metadata.gz: dc96e3ee965d73c64abc9bb90649c0d328c6c372
+  data.tar.gz: f4da7866e12df9d983e8b93e4572f6094dfc42b8
 SHA512:
-  metadata.gz: b67c6aac29d022afc1fb48106c436cfcec7f3370d1de7e7a5eb63f339ebe52ef198cd4f7e6797a2865ff7ea1566165ad40f6c413e92de58ccd27bc82140e965b
-  data.tar.gz: 972a7298efc5729bf9a1cba1f617a9dfdee1096fcc3056dcad1b705d792df8230e5fd48caed3009aeee552594a26c1ad00f2df3a362feee2898d5232fa40cf37
+  metadata.gz: 08a82eb2e0d70161128a3045bb329d351ded380709626420c89a99d7b949ba3c5a0eb31d2f17206cc40123f7566a776c57cbd2b86652ef347c3beccb9120008e
+  data.tar.gz: 6e28ceff3bbada51ae762ea0d1875c644dec83250199e39815a1695cfe1c0cb382f9bcdd7ced9a3b205144eae10b9f20c5015d2bb0fd69c3fdfe3f3d609b66f8

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/google_maps_service.svg)](http://badge.fury.io/rb/google_maps_service) [![Build Status](https://travis-ci.org/edwardsamuel/google-maps-services-ruby.svg?branch=master)](https://travis-ci.org/edwardsamuel/google-maps-services-ruby) [![Dependency Status](https://gemnasium.com/edwardsamuel/google-maps-services-ruby.svg)](https://gemnasium.com/edwardsamuel/google-maps-services-ruby) [![Code Climate](https://codeclimate.com/github/edwardsamuel/google-maps-services-ruby/badges/gpa.svg)](https://codeclimate.com/github/edwardsamuel/google-maps-services-ruby) [![Coverage Status](https://coveralls.io/repos/edwardsamuel/google-maps-services-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/edwardsamuel/google-maps-services-ruby?branch=master)
 
-*This is porting of [Python Client for Google Maps Services](https://github.com/googlemaps/google-maps-services-python). All Google Maps Service APIs are supported, but some features (e.g: rate limiting) are not supported right now.*
+*This is porting of [Python Client for Google Maps Services](https://github.com/googlemaps/google-maps-services-python).*
 
 ## Description
 

data/google_maps_service.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'multi_json', '~> 1.11'
   spec.add_runtime_dependency 'hurley', '~> 0.1'
-  spec.add_runtime_dependency 'retriable', '~> 2.0.2'
+  spec.add_runtime_dependency 'retriable', '~> 2.0', '>= 2.0.2'
   spec.add_runtime_dependency 'ruby-hmac', '~> 0.4.0'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'

data/lib/google_maps_service.rb

@@ -1,6 +1,6 @@
 module GoogleMapsService
   class << self
-    attr_accessor :key, :client_id, :client_secret, :connect_timeout, :read_timeout, :retry_timeout
+    attr_accessor :key, :client_id, :client_secret, :connect_timeout, :read_timeout, :retry_timeout, :queries_per_second
 
     def configure
       yield self

data/lib/google_maps_service/client.rb

@@ -2,6 +2,7 @@ require 'uri'
 require 'hurley'
 require 'multi_json'
 require 'retriable'
+require 'thread'
 
 module GoogleMapsService
   class Client
@@ -43,6 +44,12 @@ module GoogleMapsService
     # @return [Integer]
     attr_reader :retry_timeout
 
+    # Number of queries per second permitted.
+    # If the rate limit is reached, the client will sleep for
+    # the appropriate amount of time before it runs the current query.
+    # @return [Integer]
+    attr_reader :queries_per_second
+
     def initialize(options={})
       @key = options[:key] || GoogleMapsService.key
       @client_id = options[:client_id] || GoogleMapsService.client_id
@@ -50,6 +57,15 @@ module GoogleMapsService
       @connect_timeout = options[:connect_timeout] || GoogleMapsService.connect_timeout
       @read_timeout = options[:read_timeout] || GoogleMapsService.read_timeout
       @retry_timeout = options[:retry_timeout] || GoogleMapsService.retry_timeout || 60
+      @queries_per_second = options[:queries_per_second] || GoogleMapsService.queries_per_second
+
+      # Prepare "tickets" for calling API
+      if @queries_per_second
+        @sent_times = SizedQueue.new @queries_per_second
+        @queries_per_second.times do
+          @sent_times << 0
+        end
+      end
     end
 
     # Get the current HTTP client
@@ -74,13 +90,21 @@ module GoogleMapsService
     def get(path, params, base_url: DEFAULT_BASE_URL, accepts_client_id: true, custom_response_decoder: nil)
       url = base_url + generate_auth_url(path, params, accepts_client_id)
 
-      Retriable.retriable timeout: @retry_timeout,
-                          on: RETRIABLE_ERRORS do |try|
-        response = client.get url
-        if custom_response_decoder
-          return custom_response_decoder.call(response)
+      Retriable.retriable timeout: @retry_timeout, on: RETRIABLE_ERRORS do |try|
+        # Get/wait the request "ticket" if QPS is configured
+        # Check for previous request time, it must be more than a second ago before calling new request
+        if @sent_times
+          elapsed_since_earliest = Time.now - @sent_times.pop
+          sleep(1 - elapsed_since_earliest) if elapsed_since_earliest.to_f < 1
         end
-        return decode_response_body(response)
+
+        response = client.get url
+
+        # Release request "ticket"
+        @sent_times << Time.now if @sent_times
+
+        return custom_response_decoder.call(response) if custom_response_decoder
+        decode_response_body(response)
       end
     end
 
@@ -102,27 +126,17 @@ module GoogleMapsService
 
       body = MultiJson.load(response.body, :symbolize_keys => true)
 
-      api_status = body[:status]
-      if api_status == "OK" or api_status == "ZERO_RESULTS"
+      case body[:status]
+      when 'OK', 'ZERO_RESULTS'
         return body
-      end
-
-      if api_status == "OVER_QUERY_LIMIT"
+      when 'OVER_QUERY_LIMIT'
         raise GoogleMapsService::Error::RateLimitError.new(response), body[:error_message]
-      end
-
-      if api_status == "REQUEST_DENIED"
+      when 'REQUEST_DENIED'
         raise GoogleMapsService::Error::RequestDeniedError.new(response), body[:error_message]
-      end
-
-      if api_status == "INVALID_REQUEST"
+      when 'INVALID_REQUEST'
         raise GoogleMapsService::Error::InvalidRequestError.new(response), body[:error_message]
-      end
-
-      if body[:error_message]
-        raise GoogleMapsService::Error::ApiError.new(response), body[:error_message]
       else
-        raise GoogleMapsService::Error::ApiError.new(response)
+        raise GoogleMapsService::Error::ApiError.new(response), body[:error_message]
       end
     end
 
@@ -131,20 +145,20 @@ module GoogleMapsService
       when 200..300
         # Do-nothing
       when 301, 302, 303, 307
-        message ||= sprintf('Redirect to %s', response.header[:location])
+        message = sprintf('Redirect to %s', response.header[:location])
         raise GoogleMapsService::Error::RedirectError.new(response), message
       when 401
-        message ||= 'Unauthorized'
-        raise GoogleMapsService::Error::ClientError.new(response)
+        message = 'Unauthorized'
+        raise GoogleMapsService::Error::ClientError.new(response), message
       when 304, 400, 402...500
-        message ||= 'Invalid request'
-        raise GoogleMapsService::Error::ClientError.new(response)
+        message = 'Invalid request'
+        raise GoogleMapsService::Error::ClientError.new(response), message
       when 500..600
-        message ||= 'Server error'
-        raise GoogleMapsService::Error::ServerError.new(response)
+        message = 'Server error'
+        raise GoogleMapsService::Error::ServerError.new(response), message
       else
-        message ||= 'Unknown error'
-        raise GoogleMapsService::Error::TransmissionError.new(response)
+        message = 'Unknown error'
+        raise GoogleMapsService::Error::Error.new(response), message
       end
     end
 

data/lib/google_maps_service/roads.rb

@@ -95,25 +95,18 @@ module GoogleMapsService
           error = body[:error]
           status = error[:status]
 
-          if status == 'INVALID_ARGUMENT'
-            if error[:message] == 'The provided API key is invalid.'
+          case status
+            when 'INVALID_ARGUMENT'
+              if error[:message] == 'The provided API key is invalid.'
+                raise GoogleMapsService::Error::RequestDeniedError.new(response), error[:message]
+              end
+              raise GoogleMapsService::Error::InvalidRequestError.new(response), error[:message]
+            when 'PERMISSION_DENIED'
               raise GoogleMapsService::Error::RequestDeniedError.new(response), error[:message]
-            end
-            raise GoogleMapsService::Error::InvalidRequestError.new(response), error[:message]
-          end
-
-          if status == 'PERMISSION_DENIED'
-            raise GoogleMapsService::Error::RequestDeniedError.new(response), error[:message]
-          end
-
-          if status == 'RESOURCE_EXHAUSTED'
-            raise GoogleMapsService::Error::RateLimitError.new(response), error[:message]
-          end
-
-          if error.has_key?(:message)
-            raise GoogleMapsService::Error::ApiError.new(response), error[:message]
-          else
-            raise GoogleMapsService::Error::ApiError.new(response)
+            when 'RESOURCE_EXHAUSTED'
+              raise GoogleMapsService::Error::RateLimitError.new(response), error[:message]
+            else
+              raise GoogleMapsService::Error::ApiError.new(response), error[:message]
           end
         end
 

data/lib/google_maps_service/version.rb

@@ -1,3 +1,3 @@
 module GoogleMapsService
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_maps_service
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Edward Samuel Pasaribu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-17 00:00:00.000000000 Z
+date: 2015-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -43,6 +43,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
@@ -50,6 +53,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency