gds-api-adapters 19.2.0 → 20.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d7a14cdb0314fd0e249e1d7a958e436a9423a0a
-  data.tar.gz: 6c964b35d713dd3ffb6de9d2c4e4ec680ce84e2f
+  metadata.gz: 87f540ebb20c9b25a5f646a9fe87417175da9a69
+  data.tar.gz: 1d93e60b2b6a442d30b82b8b587fadfff26c85b3
 SHA512:
-  metadata.gz: aa837106a456ce8863e297588642e1b16caf416da36cbdff0d80fce1e30922450cb49260eee9d6bb18ca889546d2566da40594232dfe1e012b5f6a3b7a7c7fcf
-  data.tar.gz: b42cbd5d65b6243174c9804fc9f3d676ca7a518a4430b0c574b3417d27420f58b9af8a1b902b0954f623bf6ce6bd01fe908295f263abff9e4d5ea06aafb9f93b
+  metadata.gz: f4b493b63635ccaac3987a6481699af88a63d95e55b42479d73b75bacda3c486f41d9bd7cded4783b59eb63239c02e9c5e3e867781dd6e99ba995e5c5b9dc254
+  data.tar.gz: a1416aa6e547c77cf7a5469494b00766878eec0d41f1038130b1f638d37c84b66ec9c4545fa969d831c64646b260754a74cc08ce692d738c2002b63f132213be

data/lib/gds_api/helpers.rb

@@ -24,10 +24,6 @@ module GdsApi
       @business_support_api ||= GdsApi::BusinessSupportApi.new(Plek.current.find("business-support-api"), options)
     end
 
-    def collections_api(options = {})
-      @collections_api ||= GdsApi::CollectionsApi.new(Plek.current.find("collections-api"), options)
-    end
-
     def content_api(options = {})
       @content_api ||= GdsApi::ContentApi.new(Plek.current.find("contentapi"), options)
     end

data/lib/gds_api/json_client.rb

@@ -212,23 +212,14 @@ module GdsApi
     # 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
+        cache_control = Rack::Cache::CacheControl.new(response.headers[:cache_control])
 
-      if response.headers[:expires]
+        if cache_control.private? || cache_control.no_cache? || cache_control.no_store?
+          Time.now.utc
+        elsif cache_control.max_age
+          Time.now.utc + cache_control.max_age
+        end
+      elsif response.headers[:expires]
         Time.httpdate response.headers[:expires]
       end
     end

data/lib/gds_api/response.rb

@@ -46,24 +46,28 @@ module GdsApi
     end
 
     def expires_at
-      if headers[:date] && cache_control_headers = headers[:cache_control]
-        max_age = Rack::Cache::CacheControl.new(cache_control_headers)['max-age']
+      if headers[:date] && cache_control.max_age
         response_date = Time.parse(headers[:date])
-
-        return response_date + max_age.to_i if max_age
+        response_date + cache_control.max_age
+      elsif headers[:expires]
+        Time.parse(headers[:expires])
       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
+
+      if cache_control.max_age
+        cache_control.max_age - age.to_i
+      elsif headers[:expires]
+        Time.parse(headers[:expires]).to_i - Time.now.utc.to_i
+      end
+    end
+
+    def cache_control
+      @cache_control ||= Rack::Cache::CacheControl.new(headers[:cache_control])
     end
 
     def to_hash

data/lib/gds_api/test_helpers/content_store.rb

@@ -9,10 +9,26 @@ module GdsApi
 
       CONTENT_STORE_ENDPOINT = Plek.current.find('content-store')
 
-      def content_store_has_item(base_path, body = content_item_for_base_path(base_path), expires_in = 900)
+      # Stubs a content item in the content store.
+      # The following options can be passed in:
+      #
+      #   :max_age  will set the max-age of the Cache-Control header in the response. Defaults to 900
+      #   :private  if true, the Cache-Control header will include the "private" directive. By default it
+      #             will include "public"
+      def content_store_has_item(base_path, body = content_item_for_base_path(base_path), options = {})
+        max_age = options.fetch(:max_age, 900)
+        visibility = options[:private] ? "private" : "public"
         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: {cache_control: "public, max-age=#{expires_in}", date: Time.now.httpdate})
+
+        stub_request(:get, url).to_return(
+          status: 200,
+          body: body,
+          headers: {
+            cache_control: "#{visibility}, max-age=#{max_age}",
+            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 = '19.2.0'
+  VERSION = '20.0.0'
 end

data/test/json_client_test.rb

@@ -247,6 +247,44 @@ class JsonClientTest < MiniTest::Spec
     end
   end
 
+  def test_does_not_cache_responses_with_cache_control_private
+    url = "http://some.endpoint/private.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => { "Cache-Control" => "max-age=600, private" }
+    )
+
+    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_does_not_cache_responses_with_cache_control_no_store
+    url = "http://some.endpoint/private.json"
+    result = {"foo" => "bar"}
+    stub_request(:get, url).to_return(
+      :body => JSON.dump(result),
+      :status => 200,
+      :headers => { "Cache-Control" => "max-age=600, no-store" }
+    )
+
+    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"}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 19.2.0
+  version: 20.0.0
 platform: ruby
 authors:
 - James Stewart
@@ -275,7 +275,6 @@ files:
 - lib/gds_api/asset_manager.rb
 - lib/gds_api/base.rb
 - lib/gds_api/business_support_api.rb
-- lib/gds_api/collections_api.rb
 - lib/gds_api/content_api.rb
 - lib/gds_api/content_register.rb
 - lib/gds_api/content_store.rb
@@ -315,7 +314,6 @@ files:
 - lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/business_support_api.rb
 - lib/gds_api/test_helpers/business_support_helper.rb
-- lib/gds_api/test_helpers/collections_api.rb
 - lib/gds_api/test_helpers/common_responses.rb
 - lib/gds_api/test_helpers/content_api.rb
 - lib/gds_api/test_helpers/content_api/artefact_stub.rb
@@ -348,7 +346,6 @@ files:
 - lib/gds_api/worldwide.rb
 - test/asset_manager_test.rb
 - test/business_support_api_test.rb
-- test/collections_api_test.rb
 - test/content_api_test.rb
 - test/content_register_test.rb
 - test/content_store_test.rb
@@ -442,7 +439,6 @@ test_files:
 - test/response_test.rb
 - test/organisations_api_test.rb
 - test/imminence_api_test.rb
-- test/collections_api_test.rb
 - test/content_store_test.rb
 - test/asset_manager_test.rb
 - test/fixtures/hello.txt

data/lib/gds_api/collections_api.rb

@@ -1,15 +0,0 @@
-require_relative 'base'
-require_relative 'exceptions'
-
-class GdsApi::CollectionsApi < GdsApi::Base
-
-  def topic(base_path, options={})
-    get_json(collections_api_url(base_path, options))
-  end
-
-private
-
-  def collections_api_url(base_path, options={})
-    "#{endpoint}/specialist-sectors#{base_path}#{query_string(options)}"
-  end
-end

data/lib/gds_api/test_helpers/collections_api.rb

@@ -1,128 +0,0 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'json'
-
-module GdsApi
-  module TestHelpers
-    module CollectionsApi
-      COLLECTIONS_API_ENDPOINT = Plek.current.find('collections-api')
-
-      def collections_api_has_content_for(base_path, options={})
-        body_options = options.delete(:return_body_options) || {}
-
-        params = options.any? ? "?#{Rack::Utils.build_nested_query(options)}" : ''
-        url = COLLECTIONS_API_ENDPOINT + "/specialist-sectors" + base_path + params
-
-        stub_request(:get, url).to_return(
-          status: 200,
-          body: body_with_options(
-            body_options.merge(base_path: base_path)
-          ).to_json,
-        )
-      end
-
-      def collections_api_has_no_content_for(base_path)
-        url = COLLECTIONS_API_ENDPOINT + "/specialist-sectors" + base_path
-
-        stub_request(:get, url).to_return(
-          status: 404
-        )
-      end
-
-      def collections_api_example_documents
-        [
-          {
-            title: "Oil rig safety requirements",
-            link: "http://example.com/documents/oil-rig-safety-requirements",
-            public_updated_at: "2014-10-27T09:35:57+00:00",
-            latest_change_note: "Updated topics"
-          },
-          {
-            title: "Undersea piping restrictions",
-            link: "http://example.com/documents/undersea-piping-restrictions",
-            public_updated_at: "2014-10-15T09:36:18+01:00",
-            latest_change_note: nil
-          },
-          {
-            title: "North sea shipping lanes",
-            link: "http://example.com/documents/north-sea-shipping-lanes",
-            public_updated_at: nil,
-            latest_change_note: "Corrected shipping lane"
-          },
-          {
-            title: "Oil rig staffing",
-            link: "http://example.com/documents/oil-rig-staffing",
-            public_updated_at: "2014-09-22T09:37:00+01:00",
-            latest_change_note: "Added annual leave allowances"
-          },
-        ]
-      end
-
-    private
-
-      def body_with_options(options)
-        {
-          base_path: options.fetch(:base_path),
-          title: 'Example title',
-          description: 'example description',
-          public_updated_at: "2014-03-04T13:58:11+00:00",
-          parent: {
-            id: "http://example.com/oil-and-gas",
-            web_url: "http://example.com/browse/oil-and-gas",
-            details: {
-              description: nil,
-              short_description: nil,
-              type: "section",
-            },
-            content_with_tag: {
-              id: "http://example.com/with_tag.json?section=oil-and-gas",
-              web_url: "http://example.com/browse/oil-and-gas"
-            },
-            parent: nil,
-            title: "Oil and gas",
-            state: "live",
-          },
-          details: {
-            groups: [
-              # Curated content excluding untagged content
-              {
-                name: "Oil rigs",
-                contents: [
-                  {
-                    web_url: "http://example.com/api/oil-rig-safety-requirements.json",
-                    title: "Oil rig safety requirements",
-                  },
-                  {
-                    web_url: "http://example.com/api/oil-rig-staffing.json",
-                    title: "Oil rig staffing",
-                  }
-                ]
-              },
-              {
-                name: "Piping",
-                contents: [
-                  {
-                    web_url: "http://example.com/api/undersea-piping-restrictions.json",
-                    title: "Undersea piping restrictions",
-                  }
-                ]
-              },
-              # Uncurated content
-              {
-                name: "Other",
-                contents: [
-                  {
-                    web_url: "http://example.com/api/north-sea-shipping-lanes.json",
-                    title: "North sea shipping lanes",
-                  }
-                ]
-              }
-            ],
-            documents: collections_api_example_documents,
-            documents_start: options.fetch(:start, 0),
-            documents_total: options.fetch(:total, collections_api_example_documents.size),
-          }
-        }
-      end
-    end
-  end
-end

data/test/collections_api_test.rb

@@ -1,30 +0,0 @@
-require 'test_helper'
-require 'gds_api/collections_api'
-require 'gds_api/test_helpers/collections_api'
-
-describe GdsApi::CollectionsApi do
-  include GdsApi::TestHelpers::CollectionsApi
-
-  before do
-    @base_api_url = Plek.current.find("collections-api")
-    @api = GdsApi::CollectionsApi.new(@base_api_url)
-  end
-
-  describe "topic" do
-    it "should return the curated lists for a given base path" do
-      base_path = "/test/base-path"
-      collections_api_has_content_for(base_path)
-      response = @api.topic(base_path)
-      assert_equal base_path, response["base_path"]
-    end
-
-    it 'accepts "start" and "count" parameters for pagination' do
-      base_path = "/test/base-path"
-
-      collections_api_has_content_for(base_path, start: '10', count: '20')
-      response = @api.topic(base_path, start: 10, count: 20)
-
-      assert_equal base_path, response['base_path']
-    end
-  end
-end