google_distance_matrix 0.4.0 → 0.5.0

data/spec/lib/google_distance_matrix/url_builder_spec.rb

@@ -1,12 +1,14 @@
-require "spec_helper"
+# frozen_string_literal: true
+
+require 'spec_helper'
 
 describe GoogleDistanceMatrix::UrlBuilder do
   let(:delimiter) { described_class::DELIMITER }
-  let(:comma) { CGI.escape "," }
-  let(:colon) { CGI.escape ":" }
+  let(:comma) { CGI.escape ',' }
+  let(:colon) { CGI.escape ':' }
 
-  let(:origin_1) { GoogleDistanceMatrix::Place.new address: "address_origin_1" }
-  let(:origin_2) { GoogleDistanceMatrix::Place.new address: "address_origin_2" }
+  let(:origin_1) { GoogleDistanceMatrix::Place.new address: 'address_origin_1' }
+  let(:origin_2) { GoogleDistanceMatrix::Place.new address: 'address_origin_2' }
 
   let(:destination_1) { GoogleDistanceMatrix::Place.new lat: 1, lng: 11 }
   let(:destination_2) { GoogleDistanceMatrix::Place.new lat: 2, lng: 22 }
@@ -14,74 +16,77 @@ describe GoogleDistanceMatrix::UrlBuilder do
   let(:origins) { [origin_1, origin_2] }
   let(:destinations) { [destination_1, destination_2] }
 
+  let(:config) { GoogleDistanceMatrix::Configuration.new }
+
   let(:matrix) do
     GoogleDistanceMatrix::Matrix.new(
       origins: origins,
-      destinations: destinations
+      destinations: destinations,
+      configuration: config
     )
   end
 
   subject { described_class.new matrix }
 
-  describe "#initialize" do
-    it "has a matrix" do
+  describe '#initialize' do
+    it 'has a matrix' do
       expect(described_class.new(matrix).matrix).to eq matrix
     end
 
-    it "fails if matrix is invalid" do
-      expect {
+    it 'fails if matrix is invalid' do
+      expect do
         described_class.new GoogleDistanceMatrix::Matrix.new
-      }.to raise_error GoogleDistanceMatrix::InvalidMatrix
+      end.to raise_error GoogleDistanceMatrix::InvalidMatrix
     end
 
     it "fails if matrix's configuration is invalid" do
-      expect {
+      expect do
         matrix.configure { |c| c.mode = 'foobar' }
         described_class.new matrix
-      }.to raise_error GoogleDistanceMatrix::InvalidMatrix
+      end.to raise_error GoogleDistanceMatrix::InvalidMatrix
     end
   end
 
+  describe '#sensitive_url' do
+    it 'fails if the url is more than 2048 characters' do
+      long_string = ''.dup
+      2049.times { long_string << 'a' }
 
-  describe "#url" do
-    it "fails if the url is more than 2048 characters" do
-      long_string = ""
-      2049.times { long_string << "a" }
-
-      allow(subject).to receive(:get_params_string).and_return long_string
+      expect(subject).to receive(:query_params_string).and_return long_string
 
-      expect { subject.url }.to raise_error GoogleDistanceMatrix::MatrixUrlTooLong
+      expect { subject.sensitive_url }.to raise_error GoogleDistanceMatrix::MatrixUrlTooLong
     end
 
-    it "starts with the base URL" do
-      expect(subject.url).to start_with "https://" + described_class::BASE_URL
+    it 'starts with the base URL' do
+      expect(subject.sensitive_url).to start_with 'https://' + described_class::BASE_URL
     end
 
-    it "has a configurable protocol" do
-      matrix.configure { |c| c.protocol = "http" }
-      expect(subject.url).to start_with "http://"
+    it 'has a configurable protocol' do
+      matrix.configure { |c| c.protocol = 'http' }
+      expect(subject.sensitive_url).to start_with 'http://'
     end
 
-    it "includes origins" do
-      expect(subject.url).to include "origins=address_origin_1#{delimiter}address_origin_2"
+    it 'includes origins' do
+      expect(subject.sensitive_url)
+        .to include "origins=address_origin_1#{delimiter}address_origin_2"
     end
 
-    it "includes destinations" do
-      expect(subject.url).to include "destinations=1#{comma}11#{delimiter}2#{comma}22"
+    it 'includes destinations' do
+      expect(subject.sensitive_url).to include "destinations=1#{comma}11#{delimiter}2#{comma}22"
     end
 
-    describe "lat lng scale" do
-      let(:destination_1) { GoogleDistanceMatrix::Place.new lat: 10.123456789, lng: "10.987654321" }
+    describe 'lat lng scale' do
+      let(:destination_1) { GoogleDistanceMatrix::Place.new lat: 10.123456789, lng: '10.987654321' }
 
-      it "rounds lat and lng" do
+      it 'rounds lat and lng' do
         subject.matrix.configure { |c| c.lat_lng_scale = 5 }
 
-        expect(subject.url).to include "destinations=10.12346#{comma}10.98765"
+        expect(subject.sensitive_url).to include "destinations=10.12346#{comma}10.98765"
       end
     end
 
-    describe "use encoded polylines" do
-      let(:destination_3) { GoogleDistanceMatrix::Place.new address: "address_destination_3" }
+    describe 'use encoded polylines' do
+      let(:destination_3) { GoogleDistanceMatrix::Place.new address: 'address_destination_3' }
       let(:destination_4) { GoogleDistanceMatrix::Place.new lat: 4, lng: 44 }
       let(:destinations) { [destination_1, destination_2, destination_3, destination_4] }
 
@@ -89,12 +94,15 @@ describe GoogleDistanceMatrix::UrlBuilder do
         matrix.configure { |c| c.use_encoded_polylines = true }
       end
 
-      it "includes places with addresses as addresses" do
-        expect(subject.url).to include "origins=address_origin_1#{delimiter}address_origin_2"
+      it 'includes places with addresses as addresses' do
+        expect(subject.sensitive_url)
+          .to include "origins=address_origin_1#{delimiter}address_origin_2"
       end
 
-      it "encodes places with lat/lng values togheter, broken up by addresses to keep places order" do
-        expect(subject.url).to include(
+      it(
+        'encodes places with lat/lng values togheter, broken up by addresses to keep places order'
+      ) do
+        expect(subject.sensitive_url).to include(
           # 2 first places encoded togheter as they have lat lng values
           "destinations=enc#{colon}_ibE_mcbA_ibE_mcbA#{colon}#{delimiter}" +
           # encoded polyline broken off by a destination with address
@@ -105,7 +113,7 @@ describe GoogleDistanceMatrix::UrlBuilder do
       end
     end
 
-    describe "configuration" do
+    describe 'configuration' do
       context 'with google api key set' do
         before do
           matrix.configure do |config|
@@ -114,26 +122,67 @@ describe GoogleDistanceMatrix::UrlBuilder do
         end
 
         it 'includes the api key' do
-          expect(subject.url).to include "key=#{matrix.configuration.google_api_key}"
+          expect(subject.sensitive_url).to include "key=#{matrix.configuration.google_api_key}"
         end
       end
 
-      context "with google business client id and private key set" do
+      context 'with google business client id and private key set' do
         before do
           matrix.configure do |config|
-            config.google_business_api_client_id = "123"
-            config.google_business_api_private_key = "c2VjcmV0"
+            config.google_business_api_client_id = '123'
+            config.google_business_api_private_key = 'c2VjcmV0'
           end
         end
 
-        it "includes client" do
-          expect(subject.url).to include "client=#{matrix.configuration.google_business_api_client_id}"
+        it 'includes client' do
+          expect(subject.sensitive_url)
+            .to include "client=#{matrix.configuration.google_business_api_client_id}"
         end
 
-        it "has signature" do
-          expect(subject.url).to include "signature=DIUgkQ_BaVBJU6hwhzH3GLeMdeo="
+        it 'has signature' do
+          expect(subject.sensitive_url).to include 'signature=DIUgkQ_BaVBJU6hwhzH3GLeMdeo='
         end
       end
     end
   end
+
+  describe '#filtered_url' do
+    it 'filters nothing if config has no keys to be filtered' do
+      config.filter_parameters_in_logged_url.clear
+
+      expect(subject)
+        .to receive(:sensitive_url)
+        .and_return 'https://example.com/?foo=bar&sensitive=secret'
+
+      expect(subject.filtered_url).to eq 'https://example.com/?foo=bar&sensitive=secret'
+    end
+
+    it 'filters sensitive GET param if config has it in list of params to filter' do
+      config.filter_parameters_in_logged_url << 'sensitive'
+
+      expect(subject)
+        .to receive(:sensitive_url)
+        .and_return 'https://example.com/?foo=bar&sensitive=secret'
+
+      expect(subject.filtered_url).to eq 'https://example.com/?foo=bar&sensitive=[FILTERED]'
+    end
+
+    it 'filters key and signature as defaul from configuration' do
+      expect(subject)
+        .to receive(:sensitive_url)
+        .and_return 'https://example.com/?key=bar&signature=secret&other=foo'
+
+      expect(subject.filtered_url)
+        .to eq 'https://example.com/?key=[FILTERED]&signature=[FILTERED]&other=foo'
+    end
+
+    it 'filters all appearances of a param' do
+      expect(subject)
+        .to receive(:sensitive_url)
+        .and_return 'https://example.com/?key=bar&key=secret&other=foo'
+
+      expect(subject.filtered_url)
+        .to eq 'https://example.com/?key=[FILTERED]&key=[FILTERED]&other=foo'
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 require 'google_distance_matrix'
 
@@ -15,7 +17,7 @@ module RecordedRequestHelpers
   private
 
   def path_to(name)
-    File.join File.dirname(__FILE__), "request_recordings", name.to_s
+    File.join File.dirname(__FILE__), 'request_recordings', name.to_s
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google_distance_matrix
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Thorbjørn Hermansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2017-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,6 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.13
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.13
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.13
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +47,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.13
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: google_business_api_url_signer
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +84,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0.48'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +126,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +155,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
@@ -194,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Ruby client for The Google Distance Matrix API