gistance 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be45454a9c540c04313d8a0b0c98859a193bc73e
-  data.tar.gz: 45714fb08ea043676b2b2ac69239f99095de65ee
+  metadata.gz: 0bb92df92ed4fea89666a41d5c2c2f022ffe7c38
+  data.tar.gz: d291398fbabe94d12d404dbf431a80ca4bb7070f
 SHA512:
-  metadata.gz: 3ad1aff0b8d2b1695aab6e9460512c83aea526eb298a6f1a9a2ec8ce10c65f9ba7beebb1fc4280570c86582207d3c94fa292d2a27fba16693e4146f02e088a86
-  data.tar.gz: 8af510bab65b26500fd37630cca0f145a11ff369a3f0dac7b04cfb2fe8b982b20a4f372faaca815ebab520e4fb29779feaf11366c998634d40af6e3aa942dfd5
+  metadata.gz: 45793bb6bcb381a7ef454c1173d09272c4886a6b6d59e5354d4b99814d994fc0b7ac95026c88823897cd0e6f04e51fff00b14bd06a72ed4e85d4c0548126fa1d
+  data.tar.gz: 65720f0ad44376ed8813d97d6bfbbebc65008c2db59e21b611adb997110f5360a28e511d7d95c538c7d7d561a4027e85d090f0877ba7ad36352ce47293334e28

data/README.md

@@ -14,6 +14,7 @@ Simple Ruby wrapper for the [Google Distance Matrix API](https://developers.goog
 - 1.9.3
 - 2.0.0
 - 2.1.1
+- 2.1.2
 
 ## Installation
 
@@ -53,9 +54,19 @@ The `unit`, `language` and `sensor` parameters can be set globally or can be pro
 
 ## Authentication
 
-Gistance only supports authentication via an API key.
+Gistance supports authentication via a [simple API key](https://developers.google.com/maps/documentation/business/webservices/auth) or a [Google Maps for Business signature](https://developers.google.com/maps/documentation/business/webservices/auth).
 
-You can request one following these [steps](https://developers.google.com/maps/documentation/distancematrix/#api_key).
+```ruby
+# Google Maps API for Business authentication
+Gistance.configure do |c|
+  c.api_key = 'YOUR_API_KEY'
+  c.business = {
+    client_id: 'gme-fuubar',
+    channel: 'test' # optional
+  }
+  # etc...
+end
+```
 
 ## Usage
 

data/lib/gistance/configuration.rb

@@ -7,7 +7,8 @@ module Gistance
       :api_key,
       :language,
       :unit,
-      :sensor
+      :sensor,
+      :business
     ].freeze
 
     # Default Google Distance Matrix API endpoint
@@ -37,6 +38,7 @@ module Gistance
       self.language = 'en'
       self.unit = 'metric'
       self.sensor = false
+      self.business = nil
     end
 
     # Reset configuration options to default values

data/lib/gistance/request.rb

@@ -1,3 +1,6 @@
+require 'openssl'
+require 'base64'
+
 module Gistance
   # Methods for HTTP requests
   module Request
@@ -14,16 +17,48 @@ module Gistance
 
     def request(method, options)
       response = connection.send(method) do |request|
-        request.params[:key] = self.api_key if self.api_key
-
         [:language, :unit, :sensor].each do |option|
           request.params[option] = options.delete(option) || self.public_send(option)
         end
 
         request.url(self.api_endpoint, options)
+
+        assign_api_key_to_request(request)
       end
 
       response.body
     end
+
+    def assign_api_key_to_request(request)
+      if self.business
+        request.params[:client] = business[:client_id]
+        request.params[:channel] = business[:channel] if business[:channel]
+        request.params[:signature] = generate_signature_for_request(request)
+      else
+        request.params[:key] = self.api_key if self.api_key
+      end
+    end
+
+    def generate_signature_for_request(request)
+      digest = OpenSSL::Digest.new('sha1')
+      raw_private_key = url_safe_base64_decode(self.api_key)
+      normalized_path = normalize_request_path(request)
+
+      raw_signature = OpenSSL::HMAC.digest(digest, raw_private_key, normalized_path)
+
+      url_safe_base64_encode(raw_signature)
+    end
+
+    def url_safe_base64_decode(base64_string)
+      Base64.decode64(base64_string.tr('-_', '+/'))
+    end
+
+    def url_safe_base64_encode(raw)
+      Base64.encode64(raw).tr('+/', '-_').strip
+    end
+
+    def normalize_request_path(request)
+      request.to_env(connection)[:url].to_s.gsub('https://maps.googleapis.com', '')
+    end
   end
 end

data/lib/gistance/version.rb

@@ -1,5 +1,5 @@
 module Gistance
   # Current version
   # @return [String]
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/lib/gistance/client_spec.rb

@@ -79,5 +79,19 @@ describe Gistance::Client do
         expect(client.sensor).to be_true
       end
     end
+
+    describe 'business' do
+      it 'sets businnes'  do
+        client = Gistance::Client.new
+
+        expect(client.business).to be_nil
+      end
+
+      it 'overrides module configuration' do
+        client = Gistance::Client.new(business: { client: 'gme-fuubar' })
+
+        expect(client.business[:client]).to eql('gme-fuubar')
+      end
+    end
   end
 end

data/spec/lib/gistance/request_spec.rb

@@ -8,4 +8,28 @@ describe Gistance::Request do
   it_behaves_like 'an error', 'UNKNOWN_ERROR'
   it_behaves_like 'an error', 'NOT_FOUND'
   it_behaves_like 'an error', 'ZERO_RESULTS'
+
+  context 'given a google business request' do
+    let(:business_client) do
+      Gistance.new(api_key: '4242', business: { client_id: 'gme-fuubar', channel: 'test' })
+    end
+
+    it 'generates a valid signature params' do
+      VCR.turn_off!
+
+      stub_request(:get, /.*maps.*/).to_return(body: { status: 'ok' }.to_json)
+
+      business_client.get
+
+      assert_requested :get, 'https://maps.googleapis.com/maps/api/distancematrix/json?'\
+        'language=en&'\
+        'unit=metric&'\
+        'sensor=false&'\
+        'client=gme-fuubar&'\
+        'channel=test&'\
+        'signature=wA6neJ6IkHTs6BxFt6ves7hxsZI%3D'
+
+      VCR.turn_on!
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gistance
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Aylic Petit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-02 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday