google_distance_matrix 0.0.1 → 0.0.2

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## v.0.0.2
+
+* Renamed RequestError to ServerError.
+* Added ability to cache API responses using an ActiveSupport::Cache::Store. Simply using URL as cache key.
+* Explicit instrumentation and logging how many elements requested from the API.
+
+
+## v.0.0.1
+
+* First release.

data/README.md

@@ -96,6 +96,25 @@ Or install it yourself as:
 
 
 
+## Configuration
+
+    Configuration is done directly on a matrix or via GoogleDistanceMatrix.default_configuration.
+    Apart from configuration on requests it is also possible to provide your own logger class and
+    set a cache.
+
+### Request cache
+
+    Given Google's limit to the service you may have the need to cache requests. This is done by simply
+    using URL as cache keys. Cache we'll accept should provide a default ActiveSupport::Chache::Store interface.
+
+    GoogleDistanceMatrix.default_configuration do |config|
+        config.cache = ActiveSupport::Cache.lookup_store :your_store, {
+            expires_in: 12.hours
+            # ..or other options you like for your store
+        }
+    end
+
+
 
 ## Contributing
 

data/lib/google_distance_matrix.rb

@@ -11,6 +11,7 @@ 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"

data/lib/google_distance_matrix/client.rb

@@ -8,10 +8,11 @@ module GoogleDistanceMatrix
       UNKNOWN_ERROR
     ]
 
-    def get(url)
+    def get(url, options = {})
       uri = URI.parse url
+      instrumentation = {url: url}.merge(options[:instrumentation] || {})
 
-      response = ActiveSupport::Notifications.instrument "client_request_matrix_data.google_distance_matrix", url: url do
+      response = ActiveSupport::Notifications.instrument "client_request_matrix_data.google_distance_matrix", instrumentation do
         Net::HTTP.get_response uri
       end
 
@@ -23,12 +24,12 @@ module GoogleDistanceMatrix
       when Net::HTTPClientError
         fail ClientError.new response
       when Net::HTTPServerError
-        fail RequestError.new response
+        fail ServerError.new response
       else # Handle this as a request error for now. Maybe fine tune this more later.
-        fail RequestError.new response
+        fail ServerError.new response
       end
     rescue Timeout::Error => error
-      fail RequestError.new error
+      fail ServerError.new error
     end
 
 

data/lib/google_distance_matrix/client_cache.rb

@@ -0,0 +1,20 @@
+module GoogleDistanceMatrix
+  class ClientCache
+    attr_reader :client, :cache
+
+    def self.key(url)
+      url
+    end
+
+    def initialize(client, cache)
+      @client = client
+      @cache = cache
+    end
+
+    def get(url, options = {})
+      cache.fetch self.class.key(url) do
+        client.get url, options
+      end
+    end
+  end
+end

data/lib/google_distance_matrix/configuration.rb

@@ -18,6 +18,7 @@ module GoogleDistanceMatrix
 
     attr_accessor *ATTRIBUTES, :protocol, :logger, :lat_lng_scale
     attr_accessor :google_business_api_client_id, :google_business_api_private_key
+    attr_accessor :cache
 
 
     validates :sensor, inclusion: {in: [true, false]}

data/lib/google_distance_matrix/errors.rb

@@ -34,7 +34,7 @@ module GoogleDistanceMatrix
   # This includes wire errors like timeouts etc, and server errors
   # like 5xx. Inspect error_or_response for more information.
   #
-  class RequestError < Error
+  class ServerError < Error
     attr_reader :error_or_response
 
     def initialize(error_or_response)
@@ -42,7 +42,7 @@ module GoogleDistanceMatrix
     end
 
     def to_s
-      "GoogleDistanceMatrix::RequestError - #{error_or_response.inspect}."
+      "GoogleDistanceMatrix::ServerError - #{error_or_response.inspect}."
     end
   end
 

data/lib/google_distance_matrix/log_subscriber.rb

@@ -5,7 +5,7 @@ module GoogleDistanceMatrix
     end
 
     def client_request_matrix_data(event)
-      logger.info "(#{event.duration}ms) GET #{event.payload[:url]}", tag: :client
+      logger.info "(#{event.duration}ms) (elements: #{event.payload[:elements]}) GET #{event.payload[:url]}", tag: :client
     end
   end
 end

data/lib/google_distance_matrix/matrix.rb

@@ -68,10 +68,15 @@ module GoogleDistanceMatrix
     end
 
     def reload
+      clear_from_cache!
       @data = load_matrix
       self
     end
 
+    def reset!
+      @data = nil
+    end
+
     def loaded?
       @data.present?
     end
@@ -103,7 +108,7 @@ module GoogleDistanceMatrix
     end
 
     def load_matrix
-      parsed = JSON.parse client.get(url).body
+      parsed = JSON.parse client.get(url, instrumentation: {elements: origins.length * destinations.length}).body
 
       parsed["rows"].each_with_index.map do |row, origin_index|
         origin = origins[origin_index]
@@ -116,7 +121,19 @@ module GoogleDistanceMatrix
     end
 
     def client
-      @client ||= Client.new
+      client = Client.new
+
+      if configuration.cache
+        ClientCache.new client, configuration.cache
+      else
+        client
+      end
+    end
+
+    def clear_from_cache!
+      if configuration.cache
+        configuration.cache.delete ClientCache.key(url)
+      end
     end
   end
 end

data/lib/google_distance_matrix/routes_finder.rb

@@ -72,20 +72,40 @@ module GoogleDistanceMatrix
     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
+    #
+    # 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
     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
+    #
+    # 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
     end
 
+    # Public: Finds shortes route by duration to a place.
+    #
+    # place - The place, or object place was built from, you want the shortest route to
+    #
+    # 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
     end
 
+    # Public: Finds shortes route by duration to a place.
+    #
+    # place - The place, or object place was built from, you want the shortest route to
+    #
+    # 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
     end

data/lib/google_distance_matrix/version.rb

@@ -1,3 +1,3 @@
 module GoogleDistanceMatrix
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/google_distance_matrix/client_cache_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper"
+
+describe GoogleDistanceMatrix::ClientCache do
+  let(:url) { "http://www.example.com" }
+  let(:options) { {hello: :options} }
+
+  let(:client) { mock get: "data" }
+  let(:cache) { mock }
+
+  subject { described_class.new client, cache }
+
+  describe "#get" do
+    it "returns from cache if it hits" do
+      cache.should_receive(:fetch).with(url).and_return "cached-data"
+      expect(subject.get(url, options)).to eq "cached-data"
+    end
+
+    it "asks client when cache miss" do
+      client.should_receive(:get).with(url, options).and_return "api-data"
+      cache.should_receive(:fetch) { |&block| block.call }
+
+      expect(subject.get(url, options)).to eq "api-data"
+    end
+  end
+end

data/spec/lib/google_distance_matrix/client_spec.rb

@@ -44,7 +44,7 @@ describe GoogleDistanceMatrix::Client, :request_recordings 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::RequestError
+        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::ServerError
       end
     end
 
@@ -52,7 +52,7 @@ describe GoogleDistanceMatrix::Client, :request_recordings 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::RequestError
+        expect { subject.get(url_builder.url).body }.to raise_error GoogleDistanceMatrix::ServerError
       end
     end
 
@@ -60,7 +60,7 @@ describe GoogleDistanceMatrix::Client, :request_recordings 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::RequestError
+        expect { subject.get(url_builder.url) }.to raise_error GoogleDistanceMatrix::ServerError
       end
     end
   end

data/spec/lib/google_distance_matrix/configuration_spec.rb

@@ -31,6 +31,7 @@ describe GoogleDistanceMatrix::Configuration do
     its(:google_business_api_private_key) { should be_nil }
 
     its(:logger) { should be_nil }
+    its(:cache) { should be_nil }
   end
 
 

data/spec/lib/google_distance_matrix/matrix_spec.rb

@@ -93,6 +93,50 @@ describe GoogleDistanceMatrix::Matrix do
     end
   end
 
+  describe "making API requests", :request_recordings do
+    it "loads correctly" do
+      stub_request(:get, url).to_return body: recorded_request_for(:success)
+      expect(subject.data[0][0].distance_in_meters).to eq 2032
+    end
+
+    context "no cache" do
+      it "makes multiple requests to same url" do
+        stub = stub_request(:get, url).to_return body: recorded_request_for(:success)
+        subject.data
+        subject.reset!
+        subject.data
+
+        stub.should have_been_requested.twice
+      end
+    end
+
+    context "with cache" do
+      before do
+        subject.configure do |config|
+          config.cache = ActiveSupport::Cache.lookup_store :memory_store
+        end
+      end
+
+      it "makes one requests to same url" do
+        stub = stub_request(:get, url).to_return body: recorded_request_for(:success)
+        subject.data
+        subject.reset!
+        subject.data
+
+        stub.should have_been_requested.once
+      end
+
+      it "clears the cache key on reload" do
+        stub = stub_request(:get, url).to_return body: recorded_request_for(:success)
+        subject.data
+        subject.reload
+        subject.data
+
+        stub.should have_been_requested.twice
+      end
+    end
+  end
+
   describe "#data", :request_recordings do
     context "success" do
       let!(:api_request_stub) { stub_request(:get, url).to_return body: recorded_request_for(:success) }

metadata

@@ -2,25 +2,25 @@
 name: google_distance_matrix
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Thorbjørn Hermansen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-16 00:00:00.000000000 Z
+date: 2013-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: activesupport
-  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.13
     none: false
+  name: activesupport
+  type: :runtime
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -28,15 +28,15 @@ dependencies:
         version: 3.2.13
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: activemodel
-  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.2.13
     none: false
+  name: activemodel
+  type: :runtime
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -44,15 +44,15 @@ dependencies:
         version: 3.2.13
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: google_business_api_url_signer
-  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.1
     none: false
+  name: google_business_api_url_signer
+  type: :runtime
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -60,15 +60,15 @@ dependencies:
         version: 0.0.1
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: bundler
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
     none: false
+  name: bundler
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -76,15 +76,15 @@ dependencies:
         version: '1.3'
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: rspec
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.13'
     none: false
+  name: rspec
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -92,15 +92,15 @@ dependencies:
         version: '2.13'
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: shoulda-matchers
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 2.0.0
     none: false
+  name: shoulda-matchers
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -108,15 +108,15 @@ dependencies:
         version: 2.0.0
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: webmock
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.11'
     none: false
+  name: webmock
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
@@ -124,15 +124,15 @@ dependencies:
         version: '1.11'
     none: false
 - !ruby/object:Gem::Dependency
-  prerelease: false
-  name: rake
-  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
     none: false
+  name: rake
+  type: :development
+  prerelease: false
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -148,6 +148,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rbenv-version
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -155,6 +156,7 @@ files:
 - google_distance_matrix.gemspec
 - lib/google_distance_matrix.rb
 - lib/google_distance_matrix/client.rb
+- lib/google_distance_matrix/client_cache.rb
 - lib/google_distance_matrix/configuration.rb
 - lib/google_distance_matrix/errors.rb
 - lib/google_distance_matrix/log_subscriber.rb
@@ -167,6 +169,7 @@ files:
 - lib/google_distance_matrix/routes_finder.rb
 - lib/google_distance_matrix/url_builder.rb
 - lib/google_distance_matrix/version.rb
+- spec/lib/google_distance_matrix/client_cache_spec.rb
 - spec/lib/google_distance_matrix/client_spec.rb
 - spec/lib/google_distance_matrix/configuration_spec.rb
 - spec/lib/google_distance_matrix/logger_spec.rb
@@ -190,18 +193,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -254032637546983924
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -254032637546983924
       version: '0'
   none: false
 requirements: []
@@ -211,6 +208,7 @@ signing_key:
 specification_version: 3
 summary: Ruby client for The Google Distance Matrix API
 test_files:
+- spec/lib/google_distance_matrix/client_cache_spec.rb
 - spec/lib/google_distance_matrix/client_spec.rb
 - spec/lib/google_distance_matrix/configuration_spec.rb
 - spec/lib/google_distance_matrix/logger_spec.rb