gds-api-adapters 3.3.1 → 3.4.0

data/lib/gds_api/json_client.rb

@@ -9,8 +9,8 @@ module GdsApi
 
     include GdsApi::ExceptionHandling
 
-    def self.cache(size=DEFAULT_CACHE_SIZE)
-      @cache ||= LRUCache.new(max_size: size)
+    def self.cache(size=DEFAULT_CACHE_SIZE, ttl=DEFAULT_CACHE_TTL)
+      @cache ||= LRUCache.new(max_size: size, ttl: ttl)
     end
 
     def self.cache=(c)
@@ -22,7 +22,8 @@ module GdsApi
     def initialize(options = {})
       @logger = options[:logger] || GdsApi::Base.logger
       cache_size = options[:cache_size] || DEFAULT_CACHE_SIZE
-      @cache = JsonClient.cache(cache_size)
+      cache_ttl = options[:cache_ttl] || DEFAULT_CACHE_TTL
+      @cache = JsonClient.cache(cache_size, cache_ttl)
       @options = options
     end
 
@@ -33,6 +34,7 @@ module GdsApi
     }
     DEFAULT_TIMEOUT_IN_SECONDS = 4
     DEFAULT_CACHE_SIZE = 10
+    DEFAULT_CACHE_TTL = 15 * 60 # 15 minutes
 
     def get_raw(url)
       do_raw_request(Net::HTTP::Get, url)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '3.3.1'
+  VERSION = '3.4.0'
 end

data/test/json_client_test.rb

@@ -11,6 +11,7 @@ class JsonClientTest < MiniTest::Spec
   end
 
   def teardown
+    super
     GdsApi::JsonClient.cache = @json_client_cache
   end
 
@@ -57,12 +58,112 @@ class JsonClientTest < MiniTest::Spec
   end
 
   def test_should_cache_multiple_requests_to_same_url_across_instances
+    GdsApi::JsonClient.cache = nil # clear the stubbed cache instance
+
     url = "http://some.endpoint/some.json"
     result = {"foo" => "bar"}
-    stub_request(:get, url).to_return(:body => JSON.dump(result), :status => 200).times(1)
+    stub_request(:get, url).to_return(:body => JSON.dump(result), :status => 200)
     response_a = GdsApi::JsonClient.new.get_json(url)
     response_b = GdsApi::JsonClient.new.get_json(url)
     assert_equal response_a.object_id, response_b.object_id
+    assert_requested :get, url, times: 1
+  end
+
+  def test_should_cache_up_to_10_items_by_default
+    GdsApi::JsonClient.cache = nil # clear the stubbed cache instance
+
+    url = "http://some.endpoint/"
+    result = {"foo" => "bar"}
+    stub_request(:get, %r{\A#{url}}).to_return do |request|
+      {:body => {"url" => request.uri}.to_json, :status => 200}
+    end
+
+    response_a = GdsApi::JsonClient.new.get_json("#{url}/first.json")
+    response_b = GdsApi::JsonClient.new.get_json("#{url}/second.json")
+    9.times { |n| GdsApi::JsonClient.new.get_json("#{url}/#{n}.json") }
+
+    response_c = GdsApi::JsonClient.new.get_json("#{url}/second.json")
+    response_d = GdsApi::JsonClient.new.get_json("#{url}/first.json")
+
+    assert_requested :get, "#{url}/second.json", times: 1
+    assert_requested :get, "#{url}/first.json", times: 2
+    assert_equal response_b.to_hash, response_c.to_hash
+    assert_equal response_a.to_hash, response_d.to_hash
+  end
+
+  def test_allow_overriding_the_number_of_cached_items
+    GdsApi::JsonClient.cache = nil # clear the stubbed cache instance
+
+    url = "http://some.endpoint/"
+    result = {"foo" => "bar"}
+    stub_request(:get, %r{\A#{url}}).to_return do |request|
+      {:body => {"url" => request.uri}.to_json, :status => 200}
+    end
+
+    response_a = GdsApi::JsonClient.new(:cache_size => 5).get_json("#{url}/first.json")
+    response_b = GdsApi::JsonClient.new.get_json("#{url}/second.json")
+    4.times { |n| GdsApi::JsonClient.new.get_json("#{url}/#{n}.json") }
+
+    response_c = GdsApi::JsonClient.new.get_json("#{url}/second.json")
+    response_d = GdsApi::JsonClient.new.get_json("#{url}/first.json")
+
+    assert_requested :get, "#{url}/second.json", times: 1
+    assert_requested :get, "#{url}/first.json", times: 2
+    assert_equal response_b.to_hash, response_c.to_hash
+    assert_equal response_a.to_hash, response_d.to_hash
+  end
+  def test_should_cache_requests_for_15_mins_by_default
+    GdsApi::JsonClient.cache = nil # cause it to contruct a new cache instance.
+
+    url = "http://some.endpoint/some.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(:body => JSON.dump(result), :status => 200)#.times(1)
+    response_a = GdsApi::JsonClient.new.get_json(url)
+    response_b = GdsApi::JsonClient.new.get_json(url)
+
+    assert_requested :get, url, times: 1
+    assert_equal response_a.object_id, response_b.object_id
+
+    Timecop.travel( 15 * 60 - 30) do # now + 14 mins 30 secs
+      response_c = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 1
+      assert_same response_a, response_c
+    end
+
+    Timecop.travel( 15 * 60 + 30) do # now + 15 mins 30 secs
+      response_d = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 2
+      assert_equal response_a.to_hash, response_d.to_hash
+    end
+  end
+
+  def test_should_allow_overriding_cache_ttl
+    GdsApi::JsonClient.cache = nil # cause it to contruct a new cache instance.
+
+    url = "http://some.endpoint/some.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(:body => JSON.dump(result), :status => 200)#.times(1)
+    response_a = GdsApi::JsonClient.new(:cache_ttl => 5 * 60).get_json(url)
+    response_b = GdsApi::JsonClient.new.get_json(url)
+
+    assert_requested :get, url, times: 1
+    assert_equal response_a.object_id, response_b.object_id
+
+    Timecop.travel( 5 * 60 - 30) do # now + 4 mins 30 secs
+      response_c = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 1
+      assert_same response_a, response_c
+    end
+
+    Timecop.travel( 5 * 60 + 30) do # now + 5 mins 30 secs
+      response_d = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 2
+      assert_equal response_a.to_hash, response_d.to_hash
+    end
   end
 
   def test_should_raise_http_not_found_if_404_returned_from_endpoint

data/test/test_helper.rb

@@ -2,11 +2,11 @@ require 'bundler'
 Bundler.setup :default, :development, :test
 
 require 'minitest/autorun'
-require 'webmock/minitest'
 require 'rack/utils'
 require 'simplecov'
 require 'simplecov-rcov'
 require 'mocha'
+require 'timecop'
 
 SimpleCov.start do
   add_filter "/test/"
@@ -14,4 +14,11 @@ SimpleCov.start do
   formatter SimpleCov::Formatter::RcovFormatter
 end
 
+class MiniTest::Unit::TestCase
+  def teardown
+    Timecop.return
+  end
+end
+
+require 'webmock/minitest'
 WebMock.disable_net_connect!

metadata

@@ -2,7 +2,7 @@
 name: gds-api-adapters
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.3.1
+  version: 3.4.0
 platform: ruby
 authors: 
 - James Stewart
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-11 00:00:00 Z
+date: 2012-10-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: plek
@@ -144,6 +144,17 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: *id013
 description: A set of adapters providing easy access to the GDS gov.uk APIs
 email: 
 - jystewart@gmail.com
@@ -155,43 +166,43 @@ extra_rdoc_files: []
 
 files: 
 - lib/gds_api/version.rb
-- lib/gds_api/publisher.rb
-- lib/gds_api/panopticon/registerer.rb
 - lib/gds_api/typhoeus_client.rb
-- lib/gds_api/content_api.rb
-- lib/gds_api/imminence.rb
+- lib/gds_api/base.rb
+- lib/gds_api/licence_application.rb
 - lib/gds_api/contactotron.rb
-- lib/gds_api/test_helpers/publisher.rb
-- lib/gds_api/test_helpers/content_api.rb
-- lib/gds_api/test_helpers/imminence.rb
-- lib/gds_api/test_helpers/contactotron.rb
+- lib/gds_api/panopticon/registerer.rb
+- lib/gds_api/needotron.rb
+- lib/gds_api/imminence.rb
+- lib/gds_api/rummager.rb
+- lib/gds_api/content_api.rb
+- lib/gds_api/exceptions.rb
+- lib/gds_api/json_client.rb
+- lib/gds_api/core-ext/openstruct.rb
+- lib/gds_api/response.rb
+- lib/gds_api/publisher.rb
 - lib/gds_api/test_helpers/licence_application.rb
+- lib/gds_api/test_helpers/contactotron.rb
+- lib/gds_api/test_helpers/imminence.rb
+- lib/gds_api/test_helpers/content_api.rb
+- lib/gds_api/test_helpers/publisher.rb
 - lib/gds_api/test_helpers/panopticon.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
-- lib/gds_api/licence_application.rb
-- lib/gds_api/base.rb
-- lib/gds_api/json_client.rb
-- lib/gds_api/response.rb
-- lib/gds_api/rummager.rb
-- lib/gds_api/panopticon.rb
-- lib/gds_api/core-ext/openstruct.rb
 - lib/gds_api/part_methods.rb
-- lib/gds_api/needotron.rb
-- lib/gds_api/exceptions.rb
+- lib/gds_api/panopticon.rb
 - lib/gds_api/helpers.rb
 - README.md
 - Rakefile
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
 - test/rummager_test.rb
+- test/publisher_api_test.rb
+- test/licence_application_api_test.rb
+- test/panopticon_api_test.rb
 - test/imminence_api_test.rb
-- test/panopticon_registerer_test.rb
-- test/content_api_test.rb
 - test/json_client_test.rb
-- test/gds_api_base_test.rb
-- test/licence_application_api_test.rb
 - test/test_helper.rb
+- test/gds_api_base_test.rb
+- test/content_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/contactotron_api_test.rb
 homepage: http://github.com/alphagov/gds-api-adapters
 licenses: []
 
@@ -205,7 +216,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 259809380172045694
+      hash: 1331475186711709986
       segments: 
       - 0
       version: "0"
@@ -214,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 259809380172045694
+      hash: 1331475186711709986
       segments: 
       - 0
       version: "0"
@@ -226,14 +237,14 @@ signing_key:
 specification_version: 3
 summary: Adapters to work with GDS APIs
 test_files: 
-- test/contactotron_api_test.rb
-- test/panopticon_api_test.rb
-- test/publisher_api_test.rb
 - test/rummager_test.rb
+- test/publisher_api_test.rb
+- test/licence_application_api_test.rb
+- test/panopticon_api_test.rb
 - test/imminence_api_test.rb
-- test/panopticon_registerer_test.rb
-- test/content_api_test.rb
 - test/json_client_test.rb
-- test/gds_api_base_test.rb
-- test/licence_application_api_test.rb
 - test/test_helper.rb
+- test/gds_api_base_test.rb
+- test/content_api_test.rb
+- test/panopticon_registerer_test.rb
+- test/contactotron_api_test.rb