google-directions 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e19eb410507ff5019a50d5a49df9aeba361bbdee
-  data.tar.gz: 3a71fbdb9363aee2db70b8fef3811af691c9618a
+  metadata.gz: 18eefda36b4175718d1978a0fe2e8da85ae7e2d3
+  data.tar.gz: c8cd1c3f39ac23a0e1df27166481538288a887c4
 SHA512:
-  metadata.gz: 13f9e555b93df9cc2b621600facf2eb8c711d7b89ad14603e4280fb0d8084a4531db04d6cefb2c4065bcf41cf694d166830b43f31050c09726becac734874062
-  data.tar.gz: c418df9bf808f37818d77da127334d901d17d970aecae6138ae5fa3cbae2c4314bc56edd234b93bdef70b9e450dd71998cb3ad534b14441d62510ac1aa15c931
+  metadata.gz: 38936c2b87b7c041f1166b42685ef48544d443e2aa855c29e4c23a2a509a2c1de9ad70861961784a3b4f1f63f0a88313ead5b4a6b8cd149185777d1d291fde48
+  data.tar.gz: 0bf13f927f97ea077b349b4e6233b1abd96a96236ee752c77b963b7dc6e54ce98ba95ca580fa89a7df4190e7ba751e8f3a52fbeccc2b561c79f0df9a6fa3f47c

data/lib/google/directions.rb

@@ -16,6 +16,7 @@ module Google
 
     autoload :Config  , 'google/directions/config'
     autoload :Error   , 'google/directions/error'
+    autoload :Encoder , 'google/directions/encoder'
     autoload :Request , 'google/directions/request'
     autoload :Version , 'google/directions/version'
   end

data/lib/google/directions/config.rb

@@ -3,7 +3,8 @@ module Google
     class Config
       include Singleton
 
-      attr_accessor :client_id, :private_key, :timeout, :connect_timeout
+      attr_accessor :client_id, :private_key, :sign,
+                    :timeout, :connect_timeout
 
       def timeout
         @timeout || 10
@@ -12,6 +13,10 @@ module Google
       def connect_timeout
         @connect_timeout || 5
       end
+
+      def sign
+        @sign || false
+      end
     end
   end
 end

data/lib/google/directions/encoder.rb

@@ -0,0 +1,24 @@
+require 'base64'
+require 'digest/sha1'
+
+module Google
+  module Directions
+    class Encoder
+      attr_reader :uri_with_params, :private_key
+
+      def initialize(uri_with_params, private_key)
+        @uri_with_params = uri_with_params
+        @private_key = private_key
+      end
+
+      def encode
+        binary_key = Base64.decode64(private_key.tr('-_','+/'))
+        digest = OpenSSL::Digest.new('sha1')
+        signature  = OpenSSL::HMAC.digest(digest, binary_key, uri_with_params)
+        signature = Base64.encode64(signature.tr('+/','-_')).tr("\n", '')
+
+        "#{uri_with_params}&signature=#{signature}"
+      end
+    end
+  end
+end

data/lib/google/directions/request.rb

@@ -1,7 +1,7 @@
 module Google
   module Directions
     class Request
-      BASE_URL = 'http://maps.googleapis.com'
+      BASE_URL = 'maps.googleapis.com'
       GET_PATH = '/maps/api/directions/json'
 
       DRIVING_MODE = 'driving'
@@ -9,16 +9,18 @@ module Google
       attr_reader :params, :response
 
       def initialize
-        session.base_url        = BASE_URL
+        session.base_url        = ((sign? || private_key) ? 'https://' : 'http://') + BASE_URL
         session.timeout         = Google::Directions.config.timeout
         session.connect_timeout = Google::Directions.config.connect_timeout
       end
 
       def get(params)
         @params   = params.with_indifferent_access
-        @response = session.get GET_PATH + '?' + parse_params.to_query
 
-        ::JSON.parse response.body
+        url = sign_url_if_needed(GET_PATH + '?' + parse_params.to_query)
+        @response = session.get url
+
+        response ? ::JSON.parse(response.body) : nil
       end
 
       private
@@ -33,9 +35,15 @@ module Google
         parsed_params[:waypoints] = parse_waypoints if params[:waypoints]
         parsed_params[:mode] = params[:mode] || DRIVING_MODE
 
+        set_auth_params!(parsed_params)
+
         parsed_params
       end
 
+      def sign_url_if_needed(uri_with_params)
+        sign? ? Encoder.new(uri_with_params, private_key).encode : uri_with_params
+      end
+
       def parse_waypoints
         optimize = !!params[:optimize] || false
         waypoints = params[:waypoints].join('|')
@@ -43,6 +51,17 @@ module Google
         "optimize:#{optimize}|#{waypoints}"
       end
 
+      def set_auth_params!(parsed_params)
+        if sign?
+          missing('client_id') unless client_id
+          missing('private_key') unless private_key
+
+          parsed_params[:client] = client_id
+        elsif private_key
+          parsed_params[:key] = private_key
+        end
+      end
+
       def session
         @session ||= Patron::Session.new
       end
@@ -50,6 +69,18 @@ module Google
       def missing(name)
         raise Error, "Missing parameter: #{name}"
       end
+
+      def private_key
+        Google::Directions.config.private_key
+      end
+
+      def client_id
+        Google::Directions.config.client_id
+      end
+
+      def sign?
+        Google::Directions.config.sign
+      end
     end
   end
 end

data/lib/google/directions/version.rb

@@ -1,5 +1,5 @@
 module Google
   module Directions
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/spec/google/directions/encoder_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Google::Directions::Encoder do
+  describe '#encode' do
+    let(:uri_with_params) { '/maps/api/geocode/json?address=Florianopolis&client=123' }
+    let(:private_key) { 'vNIXE0xscrmjlyV-12Nj_BvUPaw=' }
+
+    subject { described_class.new(uri_with_params, private_key).encode }
+
+    it 'creates signature from path and query' do
+      expect(subject).to eq("#{uri_with_params}&signature=VqUOoDBw//HLG5g76wWQLSg0/mw=")
+    end
+  end
+end

data/spec/google/directions/request_spec.rb

@@ -17,6 +17,61 @@ describe Google::Directions::Request do
       end
     end
 
+    context 'when private key is set' do
+      let(:url_with_key) { /^\S+key=\S+$/ }
+
+      before do
+        allow(Google::Directions.config).to receive(:private_key).and_return('MY_PRIVATE_KEY')
+      end
+
+      it 'should use key over HTTPS in request' do
+        expect_any_instance_of(Patron::Session).to receive(:base_url=).with(/https/)
+        expect_any_instance_of(Patron::Session).to receive(:get).with(url_with_key).once
+
+        subject.get(params)
+      end
+    end
+
+    context 'when is set to sign request' do
+      let(:client_id) { 'my_client_id' }
+      let(:private_key) { 'vNIXE0xscrmjlyV-12Nj_BvUPaw=' }
+      let(:url_with_key) { /^\S+client=\S+\&signature=\S+$/ }
+
+      before do
+        allow(Google::Directions.config).to receive(:sign).and_return(true)
+      end
+
+      context 'when client_id and private_key are present' do
+        before do
+          allow(Google::Directions.config).to receive(:client_id).and_return(client_id)
+          allow(Google::Directions.config).to receive(:private_key).and_return(private_key)
+        end
+
+        it 'should add signature to query string over HTTPS' do
+          expect_any_instance_of(Patron::Session).to receive(:base_url=).with(/https/)
+          expect_any_instance_of(Patron::Session).to receive(:get).with(url_with_key).once
+
+          subject.get(params)
+        end
+      end
+
+      context 'when client_id is missing' do
+        it 'should raise an exception' do
+          expect{subject.get(params)}.to raise_error Google::Directions::Error, 'Missing parameter: client_id'
+        end
+      end
+
+      context 'when private_key is missing' do
+        before do
+          allow(Google::Directions.config).to receive(:client_id).and_return(client_id)
+        end
+
+        it 'should raise an exception' do
+          expect{subject.get(params)}.to raise_error Google::Directions::Error, 'Missing parameter: private_key'
+        end
+      end
+    end
+
     context 'when origin is missing' do
       let(:params) { { destination: 'Rua Frei Galvão, 69, São Paulo' } }
 

data/wercker.yml

@@ -1,13 +1,21 @@
-box: nafu/ubuntu12.04-ruby2.1.1@1.0.1
+box: wercker/rvm
 build:
   steps:
+    - script:
+        name: install ruby
+        code: |
+          rvm get latest
+          rvm reload
+          rvm install ruby-2.2.5
+          rvm --default use 2.2.5
+          gem install bundler
     - bundle-install
     - script:
         name: echo ruby information
         code: |
           echo "RUBY version $(ruby --version) running"
           echo "FROM location $(which ruby)"
-        echo -p "Gem list: $(gem list)"
+          echo -p "Gem list: $(gem list)"
     - script:
         name: rspec
         code: bundle exec rspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-directions
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Parafuzo Core Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-29 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,12 +115,14 @@ files:
 - google-directions.gemspec
 - lib/google/directions.rb
 - lib/google/directions/config.rb
+- lib/google/directions/encoder.rb
 - lib/google/directions/error.rb
 - lib/google/directions/request.rb
 - lib/google/directions/version.rb
 - spec/fixtures/vcr_cassettes/get_directions_simple.yml
 - spec/fixtures/vcr_cassettes/get_directions_with_waypoints.yml
 - spec/fixtures/vcr_cassettes/get_geocoded_directions_with_waypoints.yml
+- spec/google/directions/encoder_spec.rb
 - spec/google/directions/request_spec.rb
 - spec/spec_helper.rb
 - wercker.yml
@@ -152,5 +154,6 @@ test_files:
 - spec/fixtures/vcr_cassettes/get_directions_simple.yml
 - spec/fixtures/vcr_cassettes/get_directions_with_waypoints.yml
 - spec/fixtures/vcr_cassettes/get_geocoded_directions_with_waypoints.yml
+- spec/google/directions/encoder_spec.rb
 - spec/google/directions/request_spec.rb
 - spec/spec_helper.rb