gds-api-adapters 7.11.0 → 7.12.0

data/lib/gds_api/json_client.rb

@@ -203,6 +203,23 @@ module GdsApi
     # Return either a Time object representing the expiry time of the response
     # or nil if no cache information is provided
     def response_cache_time(response)
+      if response.headers[:cache_control]
+        # The Cache-control header is composed of a comma-separated string
+        # so split this apart before we look for particular values
+        cache_parts = response.headers[:cache_control].split(',').map(&:strip)
+
+        # If no-cache is present, this takes precedent over any other value
+        # in this header
+        return Time.now.utc if cache_parts.include?("no-cache")
+
+        # Otherwise, look for a 'max-age=123' value, which is the number of
+        # seconds for which to cache the response.
+        max_age = cache_parts.map {|x| x.match(/max-age=(\d+)/) }.compact.first
+        if max_age
+          return Time.now.utc + max_age[1].to_i
+        end
+      end
+
       if response.headers[:expires]
         Time.httpdate response.headers[:expires]
       end

data/lib/gds_api/list_response.rb

@@ -20,7 +20,7 @@ module GdsApi
 
     # Pass calls to `self.each` to the `results` sub-object, so we can iterate
     # over the response directly
-    def_delegator :results, :each
+    def_delegators :results, :each, :to_ary
 
     def has_next_page?
       ! page_link("next").nil?

data/lib/gds_api/need_api.rb

@@ -2,6 +2,10 @@ require_relative 'base'
 
 class GdsApi::NeedApi < GdsApi::Base
 
+  def needs
+    get_list!("#{endpoint}/needs")
+  end
+
   def create_need(need)
     post_json!("#{endpoint}/needs", need)
   end

data/lib/gds_api/test_helpers/need_api.rb

@@ -21,6 +21,15 @@ module GdsApi
         )
         stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
       end
+
+      def need_api_has_needs(needs)
+        url = NEED_API_ENDPOINT + "/needs"
+
+        body = response_base.merge(
+          "results" => needs
+        )
+        stub_request(:get, url).to_return(status: 200, body: body.to_json, headers: {})
+      end
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = '7.11.0'
+  VERSION = '7.12.0'
 end

data/test/json_client_test.rb

@@ -202,6 +202,114 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
+  def test_should_respect_cache_control_headers_with_max_age
+    url = "http://some.endpoint/max_age.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => { "Cache-Control" => "max-age=420, public" } # 6 minutes
+    )
+
+    response_a = GdsApi::JsonClient.new.get_json(url)
+
+    Timecop.travel( 7 * 60 - 30) do # now + 6 mins 30 secs
+      response_b = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 1
+      assert_equal response_a.to_hash, response_b.to_hash
+    end
+
+    Timecop.travel( 7 * 60 + 30) do # now + 7 mins 30 secs
+      response_c = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 2
+      assert_equal response_a.to_hash, response_c.to_hash
+    end
+  end
+
+  def test_should_respect_cache_control_headers_with_no_cache
+    url = "http://some.endpoint/no_cache.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => { "Cache-Control" => "no-cache, public" }
+    )
+
+    response_a = GdsApi::JsonClient.new.get_json(url)
+
+    Timecop.travel( 7 * 60 - 30) do # now + 6 mins 30 secs
+      response_b = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 2
+      assert_equal response_a.to_hash, response_b.to_hash
+    end
+  end
+
+  def test_should_respect_cache_control_headers_with_no_cache_and_max_age
+    url = "http://some.endpoint/no_cache_and_max_age.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => { "Cache-Control" => "max-age=600, no-cache, public" }
+    )
+
+    response_a = GdsApi::JsonClient.new.get_json(url)
+
+    Timecop.travel( 7 * 60 - 30) do # now + 6 mins 30 secs
+      response_b = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 2
+      assert_equal response_a.to_hash, response_b.to_hash
+    end
+  end
+
+  def test_should_use_cache_control_headers_over_expires_headers
+    url = "http://some.endpoint/url.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => {
+        "Cache-Control" => "no-cache",
+        "Expires" => (Time.now + 7 * 60).utc.httpdate
+      }
+    )
+
+    response_a = GdsApi::JsonClient.new.get_json(url)
+
+    Timecop.travel( 7 * 60 - 30) do # now + 6 mins 30 secs
+      response_b = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 2
+      assert_equal response_a.to_hash, response_b.to_hash
+    end
+  end
+
+  def test_should_fallback_to_expires_headers_if_cache_control_is_malformed
+    url = "http://some.endpoint/url.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => {
+        "Cache-Control" => "foo, bar, baz",
+        "Expires" => (Time.now + 7 * 60).utc.httpdate
+      }
+    )
+
+    response_a = GdsApi::JsonClient.new.get_json(url)
+
+    Timecop.travel( 7 * 60 - 30) do # now + 6 mins 30 secs
+      response_b = GdsApi::JsonClient.new.get_json(url)
+
+      assert_requested :get, url, times: 1
+      assert_equal response_a.to_hash, response_b.to_hash
+    end
+  end
+
   def test_should_raise_http_not_found_if_404_returned_from_endpoint
     url = "http://some.endpoint/some.json"
     stub_request(:get, url).to_return(:body => "{}", :status => 404)

data/test/need_api_test.rb

@@ -10,6 +10,65 @@ describe GdsApi::NeedApi do
     @api = GdsApi::NeedApi.new(@base_api_url)
   end
 
+  describe "requesting needs" do
+    it "should return a list of all needs" do
+      req = need_api_has_needs([
+        {
+          "role" => "parent",
+          "goal" => "apply for a primary school place",
+          "benefit" => "my child can start school",
+          "organisation_ids" => ["department-for-education"],
+          "organisations" => [
+            {
+              "id" => "department-for-education",
+              "name" => "Department for Education",
+            }
+          ],
+          "justifications" => [
+            "it's something only government does",
+            "the government is legally obliged to provide it"
+          ],
+          "impact" => "Has serious consequences for the day-to-day lives of your users",
+          "met_when" => [
+            "The user applies for a school place"
+          ]
+        },
+        {
+          "role" => "user",
+          "goal" => "find out about becoming a British citizen",
+          "benefit" => "i can take the correct steps to apply for citizenship",
+          "organisation_ids" => ["home-office"],
+          "organisations" => [
+            {
+              "id" => "home-office",
+              "name" => "Home Office",
+            }
+          ],
+          "justifications" => [
+            "it's something only government does",
+            "the government is legally obliged to provide it"
+          ],
+          "impact" => "Has serious consequences for the day-to-day lives of your users",
+          "met_when" => [
+            "The user finds information about the citizenship test and the next steps"
+          ]
+        }
+      ])
+
+      needs = @api.needs
+
+      assert_requested(req)
+      assert_equal 2, needs.count
+
+      assert_equal ["parent", "user"], needs.map(&:role)
+      assert_equal ["apply for a primary school place", "find out about becoming a British citizen"], needs.map(&:goal)
+      assert_equal ["my child can start school", "i can take the correct steps to apply for citizenship"], needs.map(&:benefit)
+
+      assert_equal "department-for-education", needs.first.organisations.first.id
+      assert_equal "Department for Education", needs.first.organisations.first.name
+    end
+  end
+
   describe "creating needs" do
     it "should post to the right endpoint" do
       request_stub = stub_request(:post, @base_api_url + "/needs").with(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 7.11.0
+  version: 7.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-15 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: plek
@@ -338,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 759002302188755468
+      hash: -2562720960350177720
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -347,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 759002302188755468
+      hash: -2562720960350177720
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23