google_distance_matrix 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ca9d7d93abd6340a3cb5d36d03cbadfda5e4e1c
-  data.tar.gz: 2cb7956404bd763af695eae8c10b81de5db48450
+  metadata.gz: e2a2232b164549acbd29af07935315c8859dc19c
+  data.tar.gz: 3f29dc7ef98d87e913c1372fabd660766150dc8b
 SHA512:
-  metadata.gz: 2c5364924b1a055ce8c67c1508b219a1fc187ee9ecfa95d683775c21888f1076518bd1617b6a2e5be0020f5ef862e6707341bf8c71fff60e12e011d4dad719b9
-  data.tar.gz: 59c211df2561ea00a1da7858051fb87de4a02e35642faba695852baf974e9e3d30d34c9b710e3078e05a2cf1ea1caefb6411f35a0604a90a6f01c37f9c9af715
+  metadata.gz: bead0dcdb680422cac5db6463af54580036dc6fae0f98373eec513e18a3a197ca7981d57db4ca64a27cc7461e675bd181b81a284b0cd98129e98fa916735be28
+  data.tar.gz: 0d6d9b8a96282568c647293adab6c58e9eed438e36d1e42f1f4b473a6da59c7cb5014eebc5cc56b4326211e8faa68e292651940a5f1e1d2c30b9b82ba5435710

data/.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.{diff,md}]
+trim_trailing_whitespace = false

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Metrics/LineLength:
+  Max: 100
+  
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.3.4

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 2.2.3
   - 2.3.0
   - 2.3.1
+  - 2.3.4
   - ruby-head
 matrix:
   allow_failures:

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## v.0.5.0
+
+This release contains breaking change where `url` has been renamed to
+`sensitive_url`. A `filtered_url` method is added to make it clear that
+the URL returned is filtered according to configuration while the other one
+will contain sensitive information like key and signature.
+
+The cache key is changed so it no longer uses the URL, but a digest of the URL
+as key. You may set `config.cache_key_transform` to a block passing given url
+through if you don't want this.
+
+* Fixed an issue where read/write to cache used url with sensitive data and
+  and filtered url resulting in cache miss.
+* Instrumentation payload `url` renamed `sensitive_url`.
+* Instrumentation payload added `filtered_url`.
+* Cache key is a digest of the `sensitive_url` so we don't store in cache the
+  sensitive parts of the URL.
+* Digesting cache key is configurable with `cache_key_transform`. It's a callable
+  object expected to take the url and transform it to the key you want.
+
 ## v.0.4.0
 * When mode is `driving` and `departure_time` is set all `route` objects will contain
   `duration_in_traffic_in_seconds` and `duration_in_traffic_text`.

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in google_distance_matrix.gemspec

data/Rakefile

@@ -1,9 +1,14 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  t.rspec_opts = ['-c', '-f progress', '-r ./spec/spec_helper.rb']
   t.pattern = 'spec/**/*_spec.rb'
 end
 
-task default: :spec
+task default: %i[rubocop spec]

data/google_distance_matrix.gemspec

@@ -1,30 +1,32 @@
-# coding: utf-8
+# frozen_String_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'google_distance_matrix/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "google_distance_matrix"
+  spec.name          = 'google_distance_matrix'
   spec.version       = GoogleDistanceMatrix::VERSION
-  spec.authors       = ["Thorbjørn Hermansen"]
-  spec.email         = ["thhermansen@gmail.com"]
-  spec.description   = %q{Ruby client for The Google Distance Matrix API}
-  spec.summary       = %q{Ruby client for The Google Distance Matrix API}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Thorbjørn Hermansen']
+  spec.email         = ['thhermansen@gmail.com']
+  spec.description   = %(Ruby client for The Google Distance Matrix API)
+  spec.summary       = %(Ruby client for The Google Distance Matrix API)
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($RS)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency "activesupport", ">= 3.2.13"
-  spec.add_dependency "activemodel", ">= 3.2.13"
-  spec.add_dependency "google_business_api_url_signer", "~> 0.1.3"
+  spec.add_dependency 'activesupport', '>= 3.2.13', '<= 5'
+  spec.add_dependency 'activemodel', '>= 3.2.13', '<= 5'
+  spec.add_dependency 'google_business_api_url_signer', '~> 0.1.3'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rspec", "~> 3.4.0"
-  spec.add_development_dependency "shoulda-matchers", "~> 3.1.1"
-  spec.add_development_dependency "webmock", "~> 2.0.2"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rspec', '~> 3.5.0'
+  spec.add_development_dependency 'rubocop', '~> 0.48'
+  spec.add_development_dependency 'shoulda-matchers', '~> 3.1.1'
+  spec.add_development_dependency 'webmock', '~> 3.0.1'
+  spec.add_development_dependency 'rake'
 end

data/lib/google_distance_matrix/client.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # HTTP client making request to Google's API
   class Client
     CLIENT_ERRORS = %w[
       INVALID_REQUEST
@@ -6,41 +9,52 @@ module GoogleDistanceMatrix
       OVER_QUERY_LIMIT
       REQUEST_DENIED
       UNKNOWN_ERROR
-    ]
-
-    def get(url, options = {})
+    ].freeze
+
+    # Make a GET request to given URL
+    #
+    # @param url              The URL to Google's API we'll make a request to
+    # @param instrumentation  A hash with instrumentation payload
+    # @param options          Other options we don't care about, for example we'll capture
+    #                         `configuration` option which we are not using, but the ClientCache
+    #                         is using.
+    #
+    # @return Hash with data from parsed response body
+    def get(url, instrumentation: {}, **_options)
       uri = URI.parse url
-      instrumentation = {url: url}.merge(options[:instrumentation] || {})
 
-      response = ActiveSupport::Notifications.instrument "client_request_matrix_data.google_distance_matrix", instrumentation do
+      response = ActiveSupport::Notifications.instrument(
+        'client_request_matrix_data.google_distance_matrix', instrumentation
+      ) do
         Net::HTTP.get_response uri
       end
 
+      handle response, url
+    rescue Timeout::Error => error
+      raise ServerError, error
+    end
+
+    private
+
+    def handle(response, url) # rubocop:disable Metrics/MethodLength
       case response
       when Net::HTTPSuccess
         inspect_for_client_errors! response
       when Net::HTTPRequestURITooLong
-        fail MatrixUrlTooLong.new url, UrlBuilder::MAX_URL_SIZE, response
+        raise MatrixUrlTooLong.new url, UrlBuilder::MAX_URL_SIZE, response
       when Net::HTTPClientError
-        fail ClientError.new response
+        raise ClientError, response
       when Net::HTTPServerError
-        fail ServerError.new response
+        raise ServerError, response
       else # Handle this as a request error for now. Maybe fine tune this more later.
-        fail ServerError.new response
+        raise ServerError, response
       end
-    rescue Timeout::Error => error
-      fail ServerError.new error
     end
 
-
-    private
-
     def inspect_for_client_errors!(response)
-      status = JSON.parse(response.body).fetch "status"
+      status = JSON.parse(response.body).fetch 'status'
 
-      if CLIENT_ERRORS.include? status
-        fail ClientError.new response, status
-      end
+      raise ClientError.new response, status if CLIENT_ERRORS.include? status
 
       response
     end

data/lib/google_distance_matrix/client_cache.rb

@@ -1,9 +1,15 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # Cached client, which takes care of caching data from Google API
   class ClientCache
     attr_reader :client, :cache
 
-    def self.key(url)
-      url
+    # Returns a cache key for given URL
+    #
+    # @return String
+    def self.key(url, config)
+      config.cache_key_transform.call url
     end
 
     def initialize(client, cache)
@@ -12,7 +18,7 @@ module GoogleDistanceMatrix
     end
 
     def get(url, options = {})
-      cache.fetch self.class.key(url) do
+      cache.fetch self.class.key(url, options.fetch(:configuration)) do
         client.get url, options
       end
     end

data/lib/google_distance_matrix/configuration.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'digest'
+
 module GoogleDistanceMatrix
   # Public: Configuration of matrix and it's request.
   #
@@ -15,19 +19,20 @@ module GoogleDistanceMatrix
       departure_time arrival_time
       transit_mode transit_routing_preference
       traffic_model
-    ]
+    ].freeze
 
     API_DEFAULTS = {
-      mode: "driving",
-      units: "metric",
-      traffic_model: "best_guess",
+      mode: 'driving',
+      units: 'metric',
+      traffic_model: 'best_guess',
       use_encoded_polylines: false,
       protocol: 'https',
       lat_lng_scale: 5,
-      filter_parameters_in_logged_url: ['key', 'signature'].freeze
+      filter_parameters_in_logged_url: %w[key signature].freeze,
+      cache_key_transform: ->(url) { Digest::SHA512.new.update(url).to_s }
     }.with_indifferent_access
 
-    attr_accessor *ATTRIBUTES
+    attr_accessor(*ATTRIBUTES)
 
     # The protocol to use, either http or https
     attr_accessor :protocol
@@ -50,22 +55,38 @@ module GoogleDistanceMatrix
     # When logging we filter sensitive parameters
     attr_accessor :filter_parameters_in_logged_url
 
-    validates :mode, inclusion: {in: ["driving", "walking", "bicycling", "transit"]}, allow_blank: true
-    validates :avoid, inclusion: {in: ["tolls", "highways", "ferries", "indoor"]}, allow_blank: true
-    validates :units, inclusion: {in: ["metric", "imperial"]}, allow_blank: true
+    # Callable object which transform given url to key used in cache
+    # @see ClientCache
+    attr_accessor :cache_key_transform
+
+    validates :mode, inclusion: { in: %w[driving walking bicycling transit] }, allow_blank: true
+    validates :avoid, inclusion: { in: %w[tolls highways ferries indoor] }, allow_blank: true
+    validates :units, inclusion: { in: %w[metric imperial] }, allow_blank: true
 
     validates :departure_time, format: /\A(\d+|now)\Z/, allow_blank: true
     validates :arrival_time, numericality: true, allow_blank: true
 
-    validates :transit_mode, inclusion: {in: %w[bus subway train tram rail]}, allow_blank: true
-    validates :transit_routing_preference, inclusion: {in: %w[less_walking fewer_transfers]}, allow_blank: true
-    validates :traffic_model, inclusion: {in: %w[best_guess pessimistic optimistic]}, allow_blank: true
+    validates :transit_mode,
+              inclusion: { in: %w[bus subway train tram rail] },
+              allow_blank: true
+
+    validates :transit_routing_preference,
+              inclusion: { in: %w[less_walking fewer_transfers] },
+              allow_blank: true
 
-    validates :protocol, inclusion: {in: ["http", "https"]}, allow_blank: true
+    validates :traffic_model,
+              inclusion: { in: %w[best_guess pessimistic optimistic] },
+              allow_blank: true
+
+    validates :protocol, inclusion: { in: %w[http https] }, allow_blank: true
 
     def initialize
       API_DEFAULTS.each_pair do |attr_name, value|
-        self[attr_name] = value.dup rescue value
+        self[attr_name] = begin
+                            value.dup
+                          rescue
+                            value
+                          end
       end
     end
 
@@ -77,7 +98,6 @@ module GoogleDistanceMatrix
       public_send "#{attr_name}=", value
     end
 
-
     private
 
     def array_param
@@ -89,15 +109,13 @@ module GoogleDistanceMatrix
         out << ['client', google_business_api_client_id]
       end
 
-      if google_api_key.present?
-        out << ['key', google_api_key]
-      end
+      out << ['key', google_api_key] if google_api_key.present?
 
       out
     end
 
     def param_same_as_api_default?(param)
-     API_DEFAULTS[param[0]] == param[1]
+      API_DEFAULTS[param[0]] == param[1]
     end
   end
 end

data/lib/google_distance_matrix/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
   # Public: Error class for lib.
   class Error < StandardError
@@ -67,7 +69,8 @@ module GoogleDistanceMatrix
     end
 
     def to_s
-      "GoogleDistanceMatrix::ClientError - #{[response, status_read_from_api_response].compact.join('. ')}."
+      "GoogleDistanceMatrix::ClientError - \
+        #{[response, status_read_from_api_response].compact.join('. ')}."
     end
   end
 
@@ -75,7 +78,8 @@ module GoogleDistanceMatrix
   #
   # See https://developers.google.com/maps/documentation/distancematrix/#Limits, which states:
   # "Distance Matrix API URLs are restricted to 2048 characters, before URL encoding."
-  # "As some Distance Matrix API service URLs may involve many locations, be aware of this limit when constructing your URLs."
+  # "As some Distance Matrix API service URLs may involve many locations,
+  # be aware of this limit when constructing your URLs."
   #
   class MatrixUrlTooLong < ClientError
     attr_reader :url, :max_url_size
@@ -91,5 +95,4 @@ module GoogleDistanceMatrix
       "Matrix API URL max size is: #{max_url_size}. Built URL was: #{url.length}. URL: '#{url}'."
     end
   end
-
 end

data/lib/google_distance_matrix/log_subscriber.rb

@@ -1,8 +1,17 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # LogSubscriber logs to GoogleDistanceMatrix.logger by subscribing to gem's intstrumentation.
+  #
+  # NOTE: This log subscruber uses the default_configuration as it's configuration.
+  #       This is relevant for example for the filter_parameters_in_logged_url configuration
   class LogSubscriber < ActiveSupport::LogSubscriber
     attr_reader :logger, :config
 
-    def initialize(logger: GoogleDistanceMatrix.logger, config: GoogleDistanceMatrix.default_configuration)
+    def initialize(
+      logger: GoogleDistanceMatrix.logger,
+      config: GoogleDistanceMatrix.default_configuration
+    )
       super()
 
       @logger = logger
@@ -10,20 +19,11 @@ module GoogleDistanceMatrix
     end
 
     def client_request_matrix_data(event)
-      url = filter_url! event.payload[:url]
-      logger.info "(#{event.duration}ms) (elements: #{event.payload[:elements]}) GET #{url}", tag: :client
-    end
-
-    private
-
-    def filter_url!(url)
-      config.filter_parameters_in_logged_url.each do |param|
-        url.gsub! %r{(#{param})=.*?(&|$)}, '\1=[FILTERED]\2'
-      end
-
-      url
+      url = event.payload[:filtered_url]
+      logger.info "(#{event.duration}ms) (elements: #{event.payload[:elements]}) GET #{url}",
+                  tag: :client
     end
   end
 end
 
-GoogleDistanceMatrix::LogSubscriber.attach_to "google_distance_matrix"
+GoogleDistanceMatrix::LogSubscriber.attach_to 'google_distance_matrix'

data/lib/google_distance_matrix/logger.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # Logger class for Google Distance Matrix
   class Logger
-    PREFIXES = %w[google_distance_matrix]
-    LEVELS = %w[fatal error warn info debug]
+    PREFIXES = %w[google_distance_matrix].freeze
+    LEVELS = %w[fatal error warn info debug].freeze
 
     attr_reader :backend
 
@@ -20,13 +23,12 @@ module GoogleDistanceMatrix
       end
     end
 
-
     private
 
     def tag_msg(msg, tags)
       msg_buffer = tags.map { |tag| "[#{tag}]" }
       msg_buffer << msg
-      msg_buffer.join " "
+      msg_buffer.join ' '
     end
   end
 end