gds-api-adapters 12.1.0 → 12.2.0

data/README.md

@@ -83,10 +83,6 @@ At time of writing, these are:
 
 * [WebMock](https://github.com/bblimke/webmock)
 
-## To Do
-
-* Make timeout handling work
-
 ## Licence
 
 Released under the MIT Licence, a copy of which can be found in the file

data/lib/gds_api/response.rb

@@ -1,6 +1,7 @@
 require 'json'
 require 'ostruct'
 require 'forwardable'
+require 'rack/cache'
 require_relative 'core-ext/openstruct'
 
 module GdsApi
@@ -44,6 +45,27 @@ module GdsApi
       @http_response.headers
     end
 
+    def expires_at
+      if headers[:date] && cache_control_headers = headers[:cache_control]
+        max_age = Rack::Cache::CacheControl.new(cache_control_headers)['max-age']
+        response_date = Time.parse(headers[:date])
+
+        return response_date + max_age.to_i if max_age
+      end
+      Time.parse(headers[:expires]) if headers[:expires]
+    end
+
+    def expires_in
+      return unless headers[:date]
+
+      max_age = Rack::Cache::CacheControl.new(headers[:cache_control])['max-age'] if headers[:cache_control]
+      max_age ||= Time.parse(headers[:expires]) - Time.parse(headers[:date]) if headers[:expires]
+      return unless max_age
+
+      age = Time.now.utc - Time.parse(headers[:date])
+      max_age.to_i - age.to_i
+    end
+
     def to_hash
       @parsed ||= transform_parsed(JSON.parse(@http_response.body))
     end

data/lib/gds_api/test_helpers/content_store.rb

@@ -9,10 +9,10 @@ module GdsApi
 
       CONTENT_STORE_ENDPOINT = Plek.current.find('content-store')
 
-      def content_store_has_item(base_path, body = item_for_base_path(base_path))
+      def content_store_has_item(base_path, body = item_for_base_path(base_path), expires_in = 900)
         url = CONTENT_STORE_ENDPOINT + "/content" + base_path
         body = body.to_json unless body.is_a?(String)
-        stub_request(:get, url).to_return(status: 200, body: body, headers: {})
+        stub_request(:get, url).to_return(status: 200, body: body, headers: {cache_control: "public, max-age=#{expires_in}", date: Time.now.httpdate})
       end
 
       def content_store_does_not_have_item(base_path)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '12.1.0'
+  VERSION = '12.2.0'
 end

data/test/json_client_test.rb

@@ -208,7 +208,7 @@ class JsonClientTest < MiniTest::Spec
     stub_request(:get, url).to_return(
       :body => JSON.dump(result),
       :status => 200,
-      :headers => { "Cache-Control" => "max-age=420, public" } # 6 minutes
+      :headers => { "Cache-Control" => "max-age=420, public" } # 7 minutes
     )
 
     response_a = GdsApi::JsonClient.new.get_json(url)

data/test/response_test.rb

@@ -5,7 +5,7 @@ describe GdsApi::Response do
 
   describe "accessing HTTP response details" do
     before :each do
-      @mock_http_response = stub(:body => "A Response body", :code => 200, :headers => {'cache-control' => 'public'})
+      @mock_http_response = stub(:body => "A Response body", :code => 200, :headers => {:cache_control => 'public'})
       @response = GdsApi::Response.new(@mock_http_response)
     end
 
@@ -18,7 +18,86 @@ describe GdsApi::Response do
     end
 
     it "should pass-on the response headers" do
-      assert_equal({'cache-control' => 'public'}, @response.headers)
+      assert_equal({:cache_control => 'public'}, @response.headers)
+    end
+  end
+
+  describe ".expires_at" do
+    it "should be calculated from cache-control max-age" do
+      Timecop.freeze(Time.parse("15:00")) do
+        cache_control_headers = { :cache_control => 'public, max-age=900' }
+        headers = cache_control_headers.merge(date: Time.now.httpdate)
+
+        mock_http_response = stub(:body => "A Response body", :code => 200, :headers => headers)
+        response = GdsApi::Response.new(mock_http_response)
+
+        assert_equal Time.parse("15:15"), response.expires_at
+      end
+    end
+
+    it "should be same as the value of Expires header in absence of max-age" do
+      Timecop.freeze(Time.parse("15:00")) do
+        cache_headers = { :cache_control => 'public', :expires => (Time.now + 900).httpdate }
+        headers = cache_headers.merge(date: Time.now.httpdate)
+
+        mock_http_response = stub(:body => "A Response body", :code => 200, :headers => headers)
+        response = GdsApi::Response.new(mock_http_response)
+
+        assert_equal Time.parse("15:15"), response.expires_at
+      end
+    end
+
+    it "should be nil in absence of Expires header and max-age" do
+      mock_http_response = stub(:body => "A Response body", :code => 200, :headers => { :date => Time.now.httpdate })
+      response = GdsApi::Response.new(mock_http_response)
+
+      assert_nil response.expires_at
+    end
+
+    it "should be nil in absence of Date header and max-age" do
+      mock_http_response = stub(:body => "A Response body", :code => 200, :headers => {})
+      response = GdsApi::Response.new(mock_http_response)
+
+      assert_nil response.expires_at
+    end
+  end
+
+  describe ".expires_in" do
+    it "should be seconds remaining from expiration time inferred from max-age" do
+      cache_control_headers = { :cache_control => 'public, max-age=900' }
+      headers = cache_control_headers.merge(date: Time.now.httpdate)
+      mock_http_response = stub(:body => "A Response body", :code => 200, :headers => headers)
+
+      Timecop.travel(12 * 60) do
+        response = GdsApi::Response.new(mock_http_response)
+        assert_equal 180, response.expires_in
+      end
+    end
+
+    it "should be seconds remaining from expiration time inferred from Expires header" do
+      cache_headers = { :cache_control => 'public', :expires => (Time.now + 900).httpdate }
+      headers = cache_headers.merge(date: Time.now.httpdate)
+      mock_http_response = stub(:body => "A Response body", :code => 200, :headers => headers)
+
+      Timecop.travel(12 * 60) do
+        response = GdsApi::Response.new(mock_http_response)
+        assert_equal 180, response.expires_in
+      end
+    end
+
+    it "should be nil in absence of Expires header and max-age" do
+      mock_http_response = stub(:body => "A Response body", :code => 200, :headers => { :date => Time.now.httpdate })
+      response = GdsApi::Response.new(mock_http_response)
+
+      assert_nil response.expires_in
+    end
+
+    it "should be nil in absence of Date header" do
+      cache_control_headers = { :cache_control => 'public, max-age=900' }
+      mock_http_response = stub(:body => "A Response body", :code => 200, :headers => cache_control_headers)
+      response = GdsApi::Response.new(mock_http_response)
+
+      assert_nil response.expires_in
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 12.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -91,6 +91,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.6.3
+- !ruby/object:Gem::Dependency
+  name: rack-cache
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -388,7 +404,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2356146172275700055
+      hash: -2448133198351219130
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -397,7 +413,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2356146172275700055
+      hash: -2448133198351219130
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23