google_distance_matrix 0.4.0 → 0.6.3

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
 
@@ -16,17 +19,16 @@ module GoogleDistanceMatrix
         msg = args.first
         tags = PREFIXES.dup.concat Array.wrap(options[:tag])
 
-        backend.public_send level, tag_msg(msg, tags) if backend
+        backend&.public_send level, tag_msg(msg, tags)
       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

data/lib/google_distance_matrix/matrix.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
   # Public: Represents a distance matrix.
   #
@@ -25,23 +27,25 @@ module GoogleDistanceMatrix
   #     config.mode = "walking"
   #   end
   #
-  # You can set default configuration by doing: GoogleDistanceMatrix.configure_defaults { |c| c.sensor = true }
+  # You can set default configuration by doing:
+  # GoogleDistanceMatrix.configure_defaults { |c| c.sensor = true }
   #
   #
   # Query API and get the matrix back
   #
   #   matrix.data   # Returns a two dimensional array.
   #                 # Rows are ordered according to the values in the origins.
-  #                 # Each row corresponds to an origin, and each element within that row corresponds to
+  #                 # Each row corresponds to an origin, and each element
+  #                 # within that row corresponds to
   #                 # a pairing of the origin with a destination.
   #
   #
   class Matrix
     include ActiveModel::Validations
 
-    validates :origins, length: {minimum: 1, too_short: "must have at least one origin"}
-    validates :destinations, length: {minimum: 1, too_short: "must have at least one destination"}
-    validate { errors.add(:configuration, "is invalid") if configuration.invalid? }
+    validates :origins, length: { minimum: 1, too_short: 'must have at least one origin' }
+    validates :destinations, length: { minimum: 1, too_short: 'must have at least one destination' }
+    validate { errors.add(:configuration, 'is invalid') if configuration.invalid? }
 
     attr_reader :origins, :destinations, :configuration
 
@@ -53,6 +57,7 @@ module GoogleDistanceMatrix
       @configuration = attributes[:configuration] || GoogleDistanceMatrix.default_configuration.dup
     end
 
+    delegate :sensitive_url, :filtered_url, to: :url_builder
 
     delegate :route_for,  :routes_for,  to: :routes_finder
     delegate :route_for!, :routes_for!, to: :routes_finder
@@ -61,7 +66,6 @@ module GoogleDistanceMatrix
     delegate :shortest_route_by_duration_in_traffic_to,  to: :routes_finder
     delegate :shortest_route_by_duration_in_traffic_to!, to: :routes_finder
 
-
     # Public: The data for this matrix.
     #
     # Returns a two dimensional array, the matrix's data
@@ -83,40 +87,59 @@ module GoogleDistanceMatrix
       @data.present?
     end
 
-
-
     def configure
       yield configuration
     end
 
-    def url
-      UrlBuilder.new(self).url
-    end
-
-
     def inspect
       attributes = %w[origins destinations]
-      attributes << "data" if loaded?
+      attributes << 'data' if loaded?
       inspection = attributes.map { |a| "#{a}: #{public_send(a).inspect}" }.join ', '
 
       "#<#{self.class} #{inspection}>"
     end
 
-
     private
 
+    def url_builder
+      # We do not keep url builder as an instance variable as origins and destinations
+      # may be added after URL is being built for the first time. We should either
+      # make our matrix immutable or reset if origins/destinations are added after data (and
+      # the url) first being built and data fetched.
+      UrlBuilder.new self
+    end
+
     def routes_finder
       @routes_finder ||= RoutesFinder.new self
     end
 
     def load_matrix
-      parsed = JSON.parse client.get(url, instrumentation: {elements: origins.length * destinations.length}).body
+      body = client.get(
+        sensitive_url,
+        instrumentation: instrumentation_for_api_request,
+        configuration: configuration
+      ).body
+
+      parsed = JSON.parse(body)
+      create_route_objects_for_parsed_data parsed
+    end
+
+    def instrumentation_for_api_request
+      {
+        elements: origins.length * destinations.length,
+        sensitive_url: sensitive_url,
+        filtered_url: filtered_url
+      }
+    end
 
-      parsed["rows"].each_with_index.map do |row, origin_index|
+    def create_route_objects_for_parsed_data(parsed)
+      parsed['rows'].each_with_index.map do |row, origin_index|
         origin = origins[origin_index]
 
-        row["elements"].each_with_index.map do |element, destination_index|
-          route_attributes = element.merge(origin: origin, destination: destinations[destination_index])
+        row['elements'].each_with_index.map do |element, destination_index|
+          route_attributes = element.merge(
+            origin: origin, destination: destinations[destination_index]
+          )
           Route.new route_attributes
         end
       end
@@ -133,9 +156,9 @@ module GoogleDistanceMatrix
     end
 
     def clear_from_cache!
-      if configuration.cache
-        configuration.cache.delete ClientCache.key(url)
-      end
+      return if configuration.cache.nil?
+
+      configuration.cache.delete ClientCache.key(sensitive_url, configuration)
     end
   end
 end

data/lib/google_distance_matrix/place.rb

@@ -1,28 +1,31 @@
-# Public: Represents a place and knows how to convert it to param.
-#
-# Examples
-#
-#   GoogleDistanceMatrix::Place.new address: "My address"
-#   GoogleDistanceMatrix::Place.new lat: 1, lng: 3
-#
-#   You may also build places by other objects responding to lat and lng or address.
-#   If your object responds to all of the attributes we'll use lat and lng as data
-#   for the Place.
-#
-#   GoogleDistanceMatrix::Place.new object
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # Public: Represents a place and knows how to convert it to param.
+  #
+  # Examples
+  #
+  #   GoogleDistanceMatrix::Place.new address: "My address"
+  #   GoogleDistanceMatrix::Place.new lat: 1, lng: 3
+  #
+  #   You may also build places by other objects responding to lat and lng or address.
+  #   If your object responds to all of the attributes we'll use lat and lng as data
+  #   for the Place.
+  #
+  #   GoogleDistanceMatrix::Place.new object
   class Place
-    ATTRIBUTES = %w[address lat lng]
+    ATTRIBUTES = %w[address lat lng].freeze
 
-    attr_reader *ATTRIBUTES, :extracted_attributes_from
+    attr_reader(*ATTRIBUTES, :extracted_attributes_from)
 
     def initialize(attributes_or_object)
       if respond_to_needed_attributes? attributes_or_object
         extract_and_assign_attributes_from_object attributes_or_object
       elsif attributes_or_object.is_a? Hash
+        @extracted_attributes_from = attributes_or_object.with_indifferent_access
         assign_attributes attributes_or_object
       else
-        fail ArgumentError, "Must be either hash or object responding to lat, lng or address. "
+        raise ArgumentError, 'Must be either hash or object responding to lat, lng or address. '
       end
 
       validate_attributes
@@ -33,14 +36,16 @@ module GoogleDistanceMatrix
       address.present? ? address : lat_lng(options[:lat_lng_scale]).join(',')
     end
 
-
     def eql?(other)
+      return false unless other.is_a? self.class
+
       if address.present?
         address == other.address
       else
         lat_lng == other.lat_lng
       end
     end
+    alias == eql?
 
     def lat_lng?
       lat.present? && lng.present?
@@ -58,7 +63,9 @@ module GoogleDistanceMatrix
     end
 
     def inspect
-      inspection = (ATTRIBUTES | [:extracted_attributes_from]).reject { |a| public_send(a).blank? }.map { |a| "#{a}: #{public_send(a).inspect}" }.join ', '
+      inspection =  (ATTRIBUTES | [:extracted_attributes_from])
+                    .reject { |a| public_send(a).blank? }
+                    .map { |a| "#{a}: #{public_send(a).inspect}" }.join ', '
 
       "#<#{self.class} #{inspection}>"
     end
@@ -66,19 +73,15 @@ module GoogleDistanceMatrix
     private
 
     def respond_to_needed_attributes?(object)
-      (object.respond_to?(:lat) &&  object.respond_to?(:lng)) || object.respond_to?(:address)
+      (object.respond_to?(:lat) && object.respond_to?(:lng)) || object.respond_to?(:address)
     end
 
     def extract_and_assign_attributes_from_object(object)
-      attrs =  Hash[ATTRIBUTES.map do |attr_name|
-        if object.respond_to? attr_name
-          [attr_name, object.public_send(attr_name)]
-        end
+      attrs = Hash[ATTRIBUTES.map do |attr_name|
+        [attr_name, object.public_send(attr_name)] if object.respond_to? attr_name
       end.compact]
 
-      if attrs.has_key?('lat') || attrs.has_key?('lng')
-        attrs.delete 'address'
-      end
+      attrs.delete 'address' if attrs.key?('lat') || attrs.key?('lng')
 
       @extracted_attributes_from = object
       assign_attributes attrs
@@ -92,14 +95,20 @@ module GoogleDistanceMatrix
       @lng = attributes[:lng]
     end
 
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Style/GuardClause
     def validate_attributes
-     unless address.present? || (lat.present? && lng.present?)
-        fail ArgumentError, "Must provide an address, or lat and lng."
+      unless address.present? || (lat.present? && lng.present?)
+        raise ArgumentError, 'Must provide an address, or lat and lng.'
       end
 
       if address.present? && lat.present? && lng.present?
-        fail ArgumentError, "Cannot provide address, lat and lng."
+        raise ArgumentError, 'Cannot provide address, lat and lng.'
       end
     end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Style/GuardClause
   end
 end

data/lib/google_distance_matrix/places.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
+  # Represents a collection of places
   class Places
     include Enumerable
 
@@ -7,10 +10,9 @@ module GoogleDistanceMatrix
       concat Array.wrap(places)
     end
 
-
     delegate :each, :[], :length, :index, :pop, :shift, :delete_at, :compact, :inspect, to: :places
 
-    [:<<, :push, :unshift].each do |method|
+    %i[<< push unshift].each do |method|
       define_method method do |*args|
         args = ensure_args_are_places args
 
@@ -22,10 +24,9 @@ module GoogleDistanceMatrix
     end
 
     def concat(other)
-      push *other
+      push(*other)
     end
 
-
     private
 
     attr_reader :places

data/lib/google_distance_matrix/polyline_encoder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'polyline_encoder/delta'
 require_relative 'polyline_encoder/value_encoder'
 
@@ -7,7 +9,6 @@ module GoogleDistanceMatrix
   #
   # See https://developers.google.com/maps/documentation/utilities/polylinealgorithm
   class PolylineEncoder
-
     # Encodes a set of lat/lng pairs
     #
     # Example
@@ -16,7 +17,6 @@ module GoogleDistanceMatrix
       new(array_of_lat_lng_pairs).encode
     end
 
-
     # Initialize a new encoder
     #
     # Arguments

data/lib/google_distance_matrix/polyline_encoder/delta.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GoogleDistanceMatrix
   class PolylineEncoder
     # Calculates deltas between lat_lng values, internal helper class for PolylineEncoder.
@@ -20,7 +22,6 @@ module GoogleDistanceMatrix
         calculate_deltas rounded
       end
 
-
       private
 
       def round_to_precision(array_of_lat_lng_pairs)
@@ -42,7 +43,8 @@ module GoogleDistanceMatrix
           deltas << lat - delta_lat
           deltas << lng - delta_lng
 
-          delta_lat, delta_lng = lat, lng
+          delta_lat = lat
+          delta_lng = lng
         end
 
         deltas

data/lib/google_distance_matrix/polyline_encoder/value_encoder.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/NumericPredicate
 module GoogleDistanceMatrix
   class PolylineEncoder
     # Encodes a single value, like 17998321, in to encoded polyline value,
@@ -9,6 +12,8 @@ module GoogleDistanceMatrix
     #
     # @see GoogleDistanceMatrix::PolylineEncoder
     class ValueEncoder
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
       def encode(value)
         negative = value < 0
         value = value.abs
@@ -27,7 +32,7 @@ module GoogleDistanceMatrix
         # Right shift bits to get rid of the ones we just put on the array.
         # Bits will end up in reverse order.
         chunks_of_5_bits = []
-        while value > 0 do
+        while value > 0
           chunks_of_5_bits.push(value & 0x1f)
           value >>= 5
         end
@@ -44,6 +49,8 @@ module GoogleDistanceMatrix
         # step 11: Convert to ASCII
         chunks_of_5_bits.map(&:chr)
       end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
 
       private
 
@@ -51,11 +58,12 @@ module GoogleDistanceMatrix
       #
       # Example of usage
       #   p d 17998321 # => "00000001 00010010 10100001 11110001"
-      def d(v, bits = 32, chunk_size = 8)
-        (bits - 1).downto(0).
-          map { |n| v[n] }.
-          each_slice(chunk_size).map { |chunk| chunk.join }.join ' '
+      def d(val, bits = 32, chunk_size = 8)
+        (bits - 1).downto(0)
+                  .map { |n| val[n] }
+                  .each_slice(chunk_size).map(&:join).join ' '
       end
     end
   end
 end
+# rubocop:enable Style/NumericPredicate