google_distance_matrix 0.4.0 → 0.6.3

data/lib/google_distance_matrix/railtie.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # Class integrating with rails
   class Railtie < Rails::Railtie
-    initializer "google_distance_matrix.logger_setup" do
+    initializer 'google_distance_matrix.logger_setup' do
       GoogleDistanceMatrix.configure_defaults do |config|
         config.logger = Rails.logger
       end

data/lib/google_distance_matrix/route.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
   # Public: Thin wrapper class for an element in the matrix.
   #
@@ -15,10 +17,9 @@ module GoogleDistanceMatrix
       duration_in_traffic_text duration_in_traffic_in_seconds
     ].freeze
 
-    attr_reader *ATTRIBUTES
-
-    delegate *(STATUSES.map { |s| s + '?' }), to: :status, allow_nil: true
+    attr_reader(*ATTRIBUTES)
 
+    delegate(*(STATUSES.map { |s| s + '?' }), to: :status, allow_nil: true)
 
     def initialize(attributes = {})
       attributes = attributes.with_indifferent_access
@@ -28,25 +29,31 @@ module GoogleDistanceMatrix
 
       @status = ActiveSupport::StringInquirer.new attributes[:status].downcase
 
-      if ok?
-        @distance_text = attributes[:distance][:text]
-        @distance_in_meters = attributes[:distance][:value]
-        @duration_text = attributes[:duration][:text]
-        @duration_in_seconds = attributes[:duration][:value]
+      assign attributes if ok?
+    end
 
-        if attributes.key? :duration_in_traffic
-          @duration_in_traffic_text = attributes[:duration_in_traffic][:text]
-          @duration_in_traffic_in_seconds = attributes[:duration_in_traffic][:value]
-        end
+    def inspect
+      attrs = ATTRIBUTES.reject do |a|
+        public_send(a).blank?
       end
+
+      inspection = attrs.map { |a| "#{a}: #{public_send(a).inspect}" }.join ', '
+
+      "#<#{self.class} #{inspection}>"
     end
 
+    private
 
+    def assign(attributes)
+      @distance_text = attributes[:distance][:text]
+      @distance_in_meters = attributes[:distance][:value]
+      @duration_text = attributes[:duration][:text]
+      @duration_in_seconds = attributes[:duration][:value]
 
-    def inspect
-      inspection = ATTRIBUTES.reject { |a| public_send(a).blank? }.map { |a| "#{a}: #{public_send(a).inspect}" }.join ', '
+      return unless  attributes.key? :duration_in_traffic
 
-      "#<#{self.class} #{inspection}>"
+      @duration_in_traffic_text = attributes[:duration_in_traffic][:text]
+      @duration_in_traffic_in_seconds = attributes[:duration_in_traffic][:value]
     end
   end
 end

data/lib/google_distance_matrix/routes_finder.rb

@@ -1,17 +1,17 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
   # Public: Has logic for doing finder operations on a matrix.
+  #
+  # rubocop:disable Metrics/ClassLength
   class RoutesFinder
-
     attr_reader :matrix
     delegate :data, :origins, :destinations, :configuration, to: :matrix
 
-
     def initialize(matrix)
       @matrix = matrix
     end
 
-
-
     # Public: Finds routes for given place.
     #
     # place   -  Either an origin or destination, or an object which you built the place from
@@ -25,7 +25,7 @@ module GoogleDistanceMatrix
       elsif destinations.include? place
         routes_for_destination place
       else
-        fail ArgumentError, "Given place not an origin nor destination."
+        raise ArgumentError, 'Given place not an origin nor destination.'
       end
     end
 
@@ -41,11 +41,11 @@ module GoogleDistanceMatrix
       end
     end
 
-
     # Public: Finds a route for you based on one origin and destination
     #
     # origin        - A place representing the origin, or an object which you built the origin from
-    # destination   - A place representing the destination, or an object which you built the destination from
+    # destination   - A place representing the destination, or an object which you built the
+    #                   destination from
     #
     # A Route for given origin and destination
     def route_for(options = {})
@@ -54,9 +54,7 @@ module GoogleDistanceMatrix
       origin = ensure_place options[:origin]
       destination = ensure_place options[:destination]
 
-      if origin.nil? || destination.nil?
-        fail ArgumentError, "Must provide origin and destination"
-      end
+      raise ArgumentError, 'Must provide origin and destination' if origin.nil? || destination.nil?
 
       routes_for(origin).detect { |route| route.destination == destination }
     end
@@ -71,7 +69,6 @@ module GoogleDistanceMatrix
       end
     end
 
-
     # Public: Finds shortes route by distance to a place.
     #
     # place - The place, or object place was built from, you want the shortest route to
@@ -79,7 +76,7 @@ module GoogleDistanceMatrix
     # Returns shortest route, or nil if no routes had status ok
     def shortest_route_by_distance_to(place_or_object_place_was_built_from)
       routes = routes_for place_or_object_place_was_built_from
-      select_ok_routes(routes).min_by &:distance_in_meters
+      select_ok_routes(routes).min_by(&:distance_in_meters)
     end
 
     # Public: Finds shortes route by distance to a place.
@@ -88,7 +85,7 @@ module GoogleDistanceMatrix
     #
     # Returns shortest route, fails if any of the routes are not ok
     def shortest_route_by_distance_to!(place_or_object_place_was_built_from)
-      routes_for!(place_or_object_place_was_built_from).min_by &:distance_in_meters
+      routes_for!(place_or_object_place_was_built_from).min_by(&:distance_in_meters)
     end
 
     # Public: Finds shortes route by duration to a place.
@@ -98,7 +95,7 @@ module GoogleDistanceMatrix
     # Returns shortest route, or nil if no routes had status ok
     def shortest_route_by_duration_to(place_or_object_place_was_built_from)
       routes = routes_for place_or_object_place_was_built_from
-      select_ok_routes(routes).min_by &:duration_in_seconds
+      select_ok_routes(routes).min_by(&:duration_in_seconds)
     end
 
     # Public: Finds shortes route by duration to a place.
@@ -107,7 +104,7 @@ module GoogleDistanceMatrix
     #
     # Returns shortest route, fails if any of the routes are not ok
     def shortest_route_by_duration_to!(place_or_object_place_was_built_from)
-      routes_for!(place_or_object_place_was_built_from).min_by &:duration_in_seconds
+      routes_for!(place_or_object_place_was_built_from).min_by(&:duration_in_seconds)
     end
 
     # Public: Finds shortes route by duration in traffic to a place.
@@ -122,7 +119,7 @@ module GoogleDistanceMatrix
       ensure_driving_and_departure_time_or_fail!
 
       routes = routes_for place_or_object_place_was_built_from
-      select_ok_routes(routes).min_by &:duration_in_traffic_in_seconds
+      select_ok_routes(routes).min_by(&:duration_in_traffic_in_seconds)
     end
 
     # Public: Finds shortes route by duration in traffic to a place.
@@ -136,39 +133,39 @@ module GoogleDistanceMatrix
     def shortest_route_by_duration_in_traffic_to!(place_or_object_place_was_built_from)
       ensure_driving_and_departure_time_or_fail!
 
-      routes_for!(place_or_object_place_was_built_from).min_by &:duration_in_traffic_in_seconds
+      routes_for!(place_or_object_place_was_built_from).min_by(&:duration_in_traffic_in_seconds)
     end
 
-
-
     private
 
     def ensure_place(object)
       if object.is_a? Place
         object
       else
+        object = object.with_indifferent_access if object.is_a? Hash
+
         find_place_for_object(origins, object) ||
-        find_place_for_object(destinations, object)
+          find_place_for_object(destinations, object)
       end
     end
 
     def find_place_for_object(collection, object)
       collection.detect do |place|
         place.extracted_attributes_from.present? &&
-        place.extracted_attributes_from == object
+          place.extracted_attributes_from == object
       end
     end
 
     def routes_for_origin(origin)
       index = origins.index origin
-      fail ArgumentError, "Given origin is not i matrix."if index.nil?
+      raise ArgumentError, 'Given origin is not i matrix.' if index.nil?
 
       data[index]
     end
 
     def routes_for_destination(destination)
       index = destinations.index destination
-      fail ArgumentError, "Given destination is not i matrix." if index.nil?
+      raise ArgumentError, 'Given destination is not i matrix.' if index.nil?
 
       [].tap do |routes|
         data.each { |row| routes << row[index] }
@@ -180,24 +177,25 @@ module GoogleDistanceMatrix
       destination_index = destinations.index destination
 
       if origin_index.nil? || destination_index.nil?
-        fail ArgumentError, "Given origin or destination is not i matrix."
+        raise ArgumentError, 'Given origin or destination is not i matrix.'
       end
 
       [data[origin_index][destination_index]]
     end
 
     def fail_unless_route_is_ok(route)
-      fail InvalidRoute.new route unless route.ok?
+      raise InvalidRoute, route unless route.ok?
     end
 
     def select_ok_routes(routes)
-      routes.select &:ok?
+      routes.select(&:ok?)
     end
 
     def ensure_driving_and_departure_time_or_fail!
-      if configuration.mode != 'driving' || configuration.departure_time.nil?
-        fail InvalidQuery, "Matrix must be in mode driving and a departure_time must be set"
-      end
+      return if configuration.mode == 'driving' && configuration.departure_time.present?
+
+      raise InvalidQuery, 'Matrix must be in mode driving and a departure_time must be set'
     end
   end
+  # rubocop:enable Metrics/ClassLength
 end

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/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/version.rb

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

data/spec/lib/google_distance_matrix/client_cache_spec.rb

@@ -1,25 +1,41 @@
-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
+    # rubocop:enable Metrics/LineLength
 
-    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