google_distance_matrix 0.4.0 → 0.5.0

data/lib/google_distance_matrix/url_builder/polyline_encoder_buffer.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
   class UrlBuilder
+    # A buffer to contain Polyline Encoder
     class PolylineEncoderBuffer
       def initialize
         @buffer = []

data/lib/google_distance_matrix/url_builder.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 require_relative 'url_builder/polyline_encoder_buffer'
 
 module GoogleDistanceMatrix
+  # Takes care of building the url for given matrix
   class UrlBuilder
-    BASE_URL = "maps.googleapis.com/maps/api/distancematrix/json"
-    DELIMITER = CGI.escape("|")
+    BASE_URL = 'maps.googleapis.com/maps/api/distancematrix/json'
+    DELIMITER = CGI.escape('|')
     MAX_URL_SIZE = 2048
 
     attr_reader :matrix
@@ -12,41 +15,62 @@ module GoogleDistanceMatrix
     def initialize(matrix)
       @matrix = matrix
 
-      fail InvalidMatrix.new matrix if matrix.invalid?
+      raise InvalidMatrix, matrix if matrix.invalid?
     end
 
-    def url
-      @url ||= build_url
+    # Returns the URL we'll call Google API with
+    #
+    # This URL contains key and signature and is therefor
+    # sensitive.
+    #
+    # @return String
+    # @see filtered_url
+    def sensitive_url
+      @sensitive_url ||= build_url
     end
 
+    # Returns the URL filtered as the configuration of the matrix dictates
+    #
+    # @return String
+    def filtered_url
+      filter_url sensitive_url
+    end
 
     private
 
     def build_url
-      url = [protocol, BASE_URL, "?", get_params_string].join
+      url = [protocol, BASE_URL, '?', query_params_string].join
 
       if sign_url?
-        url = GoogleBusinessApiUrlSigner.add_signature(url, configuration.google_business_api_private_key)
+        url = GoogleBusinessApiUrlSigner.add_signature(
+          url, configuration.google_business_api_private_key
+        )
       end
 
-      if url.length > MAX_URL_SIZE
-        fail MatrixUrlTooLong.new url, MAX_URL_SIZE
+      raise MatrixUrlTooLong.new url, MAX_URL_SIZE if url.length > MAX_URL_SIZE
+
+      url
+    end
+
+    def filter_url(url)
+      configuration.filter_parameters_in_logged_url.each do |param|
+        url = url.gsub(/(#{param})=.*?(&|$)/, '\1=[FILTERED]\2')
       end
 
       url
     end
 
     def sign_url?
-      configuration.google_business_api_client_id.present? and
-      configuration.google_business_api_private_key.present?
+      configuration.google_business_api_client_id.present? &&
+        configuration.google_business_api_private_key.present?
     end
 
     def include_api_key?
       configuration.google_api_key.present?
     end
 
-    def get_params_string
-      params.to_a.map { |key_value| key_value.join("=") }.join("&")
+    def query_params_string
+      params.to_a.map { |key_value| key_value.join('=') }.join('&')
     end
 
     def params
@@ -56,8 +80,10 @@ module GoogleDistanceMatrix
       )
     end
 
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/AbcSize
     def places_to_param(places)
-      places_to_param_config = {lat_lng_scale: configuration.lat_lng_scale}
+      places_to_param_config = { lat_lng_scale: configuration.lat_lng_scale }
 
       out = []
       polyline_encode_buffer = PolylineEncoderBuffer.new
@@ -67,7 +93,7 @@ module GoogleDistanceMatrix
           polyline_encode_buffer << place.lat_lng
         else
           polyline_encode_buffer.flush to: out
-          out << escape(place.to_param places_to_param_config)
+          out << escape(place.to_param(places_to_param_config))
         end
       end
 
@@ -75,9 +101,11 @@ module GoogleDistanceMatrix
 
       out.join(DELIMITER)
     end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/AbcSize
 
     def protocol
-      configuration.protocol + "://"
+      configuration.protocol + '://'
     end
 
     def escape(string)

data/lib/google_distance_matrix/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
-  VERSION = "0.4.0"
+  VERSION = '0.5.0'
 end

data/lib/google_distance_matrix.rb

@@ -1,29 +1,31 @@
-require "google_distance_matrix/version"
-
-require "cgi"
-require "json"
-require "active_model"
-require "active_support/core_ext/hash"
-require "google_business_api_url_signer"
-
-require "google_distance_matrix/logger"
-require "google_distance_matrix/errors"
-require "google_distance_matrix/configuration"
-require "google_distance_matrix/url_builder"
-require "google_distance_matrix/client"
-require "google_distance_matrix/client_cache"
-require "google_distance_matrix/routes_finder"
-require "google_distance_matrix/matrix"
-require "google_distance_matrix/places"
-require "google_distance_matrix/place"
-require "google_distance_matrix/route"
-require "google_distance_matrix/polyline_encoder"
+# frozen_string_literal: true
+
+require 'google_distance_matrix/version'
+
+require 'cgi'
+require 'json'
+require 'active_model'
+require 'active_support/core_ext/hash'
+require 'google_business_api_url_signer'
+
+require 'google_distance_matrix/logger'
+require 'google_distance_matrix/errors'
+require 'google_distance_matrix/configuration'
+require 'google_distance_matrix/url_builder'
+require 'google_distance_matrix/client'
+require 'google_distance_matrix/client_cache'
+require 'google_distance_matrix/routes_finder'
+require 'google_distance_matrix/matrix'
+require 'google_distance_matrix/places'
+require 'google_distance_matrix/place'
+require 'google_distance_matrix/route'
+require 'google_distance_matrix/polyline_encoder'
 
 require 'google_distance_matrix/railtie' if defined? Rails
 
-
+# Main module for the GoogleDistanceMatrix
 module GoogleDistanceMatrix
-  extend self
+  module_function
 
   def default_configuration
     @default_configuration ||= Configuration.new
@@ -38,4 +40,4 @@ module GoogleDistanceMatrix
   end
 end
 
-require "google_distance_matrix/log_subscriber"
+require 'google_distance_matrix/log_subscriber'

data/spec/lib/google_distance_matrix/client_cache_spec.rb

@@ -1,25 +1,40 @@
-require "spec_helper"
+# frozen_string_literal: true
+
+require 'spec_helper'
 
 describe GoogleDistanceMatrix::ClientCache do
-  let(:url) { "http://www.example.com" }
-  let(:options) { {hello: :options} }
+  let(:config) { GoogleDistanceMatrix::Configuration.new }
+  let(:url) { 'http://www.example.com' }
+  let(:options) { { hello: :options, configuration: config } }
 
-  let(:client) { double get: "data" }
+  let(:client) { double get: 'data' }
   let(:cache) { double }
 
   subject { described_class.new client, cache }
 
-  describe "#get" do
-    it "returns from cache if it hits" do
-      expect(cache).to receive(:fetch).with(url).and_return "cached-data"
-      expect(subject.get(url, options)).to eq "cached-data"
+  # rubocop:disable Metrics/LineLength
+  describe '::key' do
+    it 'returns a digest of given URL' do
+      key = described_class.key 'some url with secret parts', config
+      expect(key).to eq 'e90595434d4e321da6b01d2b99d77419ddaa8861d83c5971c4a119ee76bb80a7003915cc16e6966615f205b4a1d5411bb5d4a0d907f611b3fe4cc8d9049f4f9c'
+    end
+  end
+
+  describe '#get' do
+    it 'returns from cache if it hits' do
+      expect(cache)
+        .to receive(:fetch)
+        .with('2f7d4c4d8a51afd0f9efb9edfda07591591cccc3704130328ad323d3cb5bf7ff19df5e895b402c99217d27d5f4547618094d47069c9ba58370ed8e26cc1de114')
+        .and_return 'cached-data'
+
+      expect(subject.get(url, options)).to eq 'cached-data'
     end
 
-    it "asks client when cache miss" do
-      expect(client).to receive(:get).with(url, options).and_return "api-data"
+    it 'asks client when cache miss' do
+      expect(client).to receive(:get).with(url, options).and_return 'api-data'
       expect(cache).to receive(:fetch) { |&block| block.call }
 
-      expect(subject.get(url, options)).to eq "api-data"
+      expect(subject.get(url, options)).to eq 'api-data'
     end
   end
 end

data/spec/lib/google_distance_matrix/client_spec.rb

@@ -1,66 +1,76 @@
-require "spec_helper"
+# frozen_string_literal: true
+
+require 'spec_helper'
 
 describe GoogleDistanceMatrix::Client, :request_recordings do
-  let(:origin_1) { GoogleDistanceMatrix::Place.new address: "Karl Johans gate, Oslo" }
-  let(:destination_1) { GoogleDistanceMatrix::Place.new address: "Drammensveien 1, Oslo" }
-  let(:matrix) { GoogleDistanceMatrix::Matrix.new(origins: [origin_1], destinations: [destination_1]) }
+  let(:origin_1) { GoogleDistanceMatrix::Place.new address: 'Karl Johans gate, Oslo' }
+  let(:destination_1) { GoogleDistanceMatrix::Place.new address: 'Drammensveien 1, Oslo' }
+  let(:matrix) do
+    GoogleDistanceMatrix::Matrix.new(origins: [origin_1], destinations: [destination_1])
+  end
 
   let(:url_builder) { GoogleDistanceMatrix::UrlBuilder.new matrix }
-  let(:url) { url_builder.url }
+  let(:url) { url_builder.sensitive_url }
 
   subject { GoogleDistanceMatrix::Client.new }
 
-  describe "success" do
+  describe 'success' do
     before { stub_request(:get, url).to_return body: recorded_request_for(:success) }
 
-    it "makes the request" do
-      expect(subject.get(url_builder.url).body).to eq recorded_request_for(:success).read
+    it 'makes the request' do
+      expect(subject.get(url_builder.sensitive_url).body).to eq recorded_request_for(:success).read
     end
   end
 
-  describe "client errors" do
-    describe "server issues 4xx client error" do
-      it "wraps the error http response" do
-        stub_request(:get, url).to_return status: [400, "Client error"]
-        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::ClientError
+  describe 'client errors' do
+    describe 'server issues 4xx client error' do
+      it 'wraps the error http response' do
+        stub_request(:get, url).to_return status: [400, 'Client error']
+        expect { subject.get(url_builder.sensitive_url) }
+          .to raise_error GoogleDistanceMatrix::ClientError
       end
 
-      it "wraps uri too long error" do
-        stub_request(:get, url).to_return status: [414, "Client error"]
-        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::MatrixUrlTooLong
+      it 'wraps uri too long error' do
+        stub_request(:get, url).to_return status: [414, 'Client error']
+        expect { subject.get(url_builder.sensitive_url) }
+          .to raise_error GoogleDistanceMatrix::MatrixUrlTooLong
       end
     end
 
     described_class::CLIENT_ERRORS.each do |error|
       it "wraps '#{error}' client error" do
-        stub_request(:get, url).to_return body: JSON.generate({status: error})
-        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::ClientError
+        stub_request(:get, url).to_return body: JSON.generate(status: error)
+        expect { subject.get(url_builder.sensitive_url) }
+          .to raise_error GoogleDistanceMatrix::ClientError
       end
     end
   end
 
-  describe "request errors" do
-    describe "server error" do
-      before { stub_request(:get, url).to_return status: [500, "Internal Server Error"] }
+  describe 'request errors' do
+    describe 'server error' do
+      before { stub_request(:get, url).to_return status: [500, 'Internal Server Error'] }
 
-      it "wraps the error http response" do
-        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::ServerError
+      it 'wraps the error http response' do
+        expect { subject.get(url_builder.sensitive_url) }
+          .to raise_error GoogleDistanceMatrix::ServerError
       end
     end
 
-    describe "timeout" do
+    describe 'timeout' do
       before { stub_request(:get, url).to_timeout }
 
-      it "wraps the error from Net::HTTP" do
-        expect { subject.get(url_builder.url).body }.to raise_error GoogleDistanceMatrix::ServerError
+      it 'wraps the error from Net::HTTP' do
+        expect { subject.get(url_builder.sensitive_url).body }
+          .to raise_error GoogleDistanceMatrix::ServerError
       end
     end
 
-    describe "server error" do
-      before { stub_request(:get, url).to_return status: [999, "Unknown"] }
+    describe 'server error' do
+      before { stub_request(:get, url).to_return status: [999, 'Unknown'] }
 
-      it "wraps the error http response" do
-        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::ServerError
+      it 'wraps the error http response' do
+        expect { subject.get(url_builder.sensitive_url) }
+          .to raise_error GoogleDistanceMatrix::ServerError
       end
     end
   end

data/spec/lib/google_distance_matrix/configuration_spec.rb

@@ -1,11 +1,13 @@
-require "spec_helper"
+# frozen_string_literal: true
+
+require 'spec_helper'
 
 describe GoogleDistanceMatrix::Configuration do
   include Shoulda::Matchers::ActiveModel
 
   subject { described_class.new }
 
-  describe "Validations" do
+  describe 'Validations' do
     describe 'departure_time' do
       it 'is valid with a timestamp' do
         subject.departure_time = Time.now.to_i
@@ -46,28 +48,32 @@ describe GoogleDistanceMatrix::Configuration do
       end
     end
 
-    it { should validate_inclusion_of(:mode).in_array(["driving", "walking", "bicycling", "transit"]) }
+    it { should validate_inclusion_of(:mode).in_array(%w[driving walking bicycling transit]) }
     it { should allow_value(nil).for(:mode) }
 
-    it { should validate_inclusion_of(:avoid).in_array(["tolls", "highways", "ferries", "indoor"]) }
+    it { should validate_inclusion_of(:avoid).in_array(%w[tolls highways ferries indoor]) }
     it { should allow_value(nil).for(:avoid) }
 
-    it { should validate_inclusion_of(:units).in_array(["metric", "imperial"]) }
+    it { should validate_inclusion_of(:units).in_array(%w[metric imperial]) }
     it { should allow_value(nil).for(:units) }
 
-
-    it { should validate_inclusion_of(:protocol).in_array(["http", "https"]) }
-
-    it { should validate_inclusion_of(:transit_mode).in_array(["bus", "subway", "train", "tram", "rail"])}
-    it { should validate_inclusion_of(:transit_routing_preference).in_array(["less_walking",  "fewer_transfers"])}
-    it { should validate_inclusion_of(:traffic_model).in_array(["best_guess", "pessimistic", "optimistic"])}
+    it { should validate_inclusion_of(:protocol).in_array(%w[http https]) }
+
+    it { should validate_inclusion_of(:transit_mode).in_array(%w[bus subway train tram rail]) }
+    it {
+      should validate_inclusion_of(
+        :transit_routing_preference
+      ).in_array(%w[less_walking fewer_transfers])
+    }
+    it {
+      should validate_inclusion_of(:traffic_model).in_array(%w[best_guess pessimistic optimistic])
+    }
   end
 
-
-  describe "defaults" do
-    it { expect(subject.mode).to eq "driving" }
+  describe 'defaults' do
+    it { expect(subject.mode).to eq 'driving' }
     it { expect(subject.avoid).to be_nil }
-    it { expect(subject.units).to eq "metric" }
+    it { expect(subject.units).to eq 'metric' }
     it { expect(subject.lat_lng_scale).to eq 5 }
     it { expect(subject.use_encoded_polylines).to eq false }
     it { expect(subject.protocol).to eq 'https' }
@@ -84,13 +90,19 @@ describe GoogleDistanceMatrix::Configuration do
 
     it { expect(subject.logger).to be_nil }
     it { expect(subject.cache).to be_nil }
-  end
 
+    # rubocop:disable Metrics/LineLength
+    it 'has a default expected cache_key_transform' do
+      key = subject.cache_key_transform.call('foo')
+      expect(key).to eq 'f7fbba6e0636f890e56fbbf3283e524c6fa3204ae298382d624741d0dc6638326e282c41be5e4254d8820772c5518a2c5a8c0c7f7eda19594a7eb539453e1ed7'
+    end
+    # rubocop:enable Metrics/LineLength
+  end
 
-  describe "#to_param" do
+  describe '#to_param' do
     described_class::ATTRIBUTES.each do |attr|
       it "includes #{attr}" do
-        subject[attr] = "foo"
+        subject[attr] = 'foo'
         expect(subject.to_param[attr]).to eq subject.public_send(attr)
       end
 
@@ -108,14 +120,14 @@ describe GoogleDistanceMatrix::Configuration do
       end
     end
 
-    it "includes client if google_business_api_client_id has been set" do
-      subject.google_business_api_client_id = "123"
-      expect(subject.to_param['client']).to eq "123"
+    it 'includes client if google_business_api_client_id has been set' do
+      subject.google_business_api_client_id = '123'
+      expect(subject.to_param['client']).to eq '123'
     end
 
-    it "includes key if google_api_key has been set" do
-      subject.google_api_key = "12345"
-      expect(subject.to_param['key']).to eq("12345")
+    it 'includes key if google_api_key has been set' do
+      subject.google_api_key = '12345'
+      expect(subject.to_param['key']).to eq('12345')
     end
   end
 end