gds-api-adapters 63.5.0 → 67.1.0

data/lib/gds_api/publishing_api.rb

@@ -381,7 +381,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2linkables
   def get_linkables(document_type: nil)
     if document_type.nil?
-      raise ArgumentError.new("Please provide a `document_type`")
+      raise ArgumentError, "Please provide a `document_type`"
     end
 
     get_json("#{endpoint}/v2/linkables?document_type=#{document_type}")
@@ -486,7 +486,7 @@ class GdsApi::PublishingApi < GdsApi::Base
   #     publishing_app: 'content-publisher',
   #     rendering_app: 'government-frontend',
   #   }
-  #)
+  # )
   #
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#put-publish-intentbase_path
   def put_intent(base_path, payload)

data/lib/gds_api/response.rb

@@ -1,6 +1,5 @@
 require "json"
 require "forwardable"
-require "rack/cache"
 
 module GdsApi
   # This wraps an HTTP response with a JSON body.
@@ -21,6 +20,77 @@ module GdsApi
     extend Forwardable
     include Enumerable
 
+    class CacheControl < Hash
+      PATTERN = /([-a-z]+)(?:\s*=\s*([^,\s]+))?,?+/i.freeze
+
+      def initialize(value = nil)
+        parse(value)
+      end
+
+      def public?
+        self["public"]
+      end
+
+      def private?
+        self["private"]
+      end
+
+      def no_cache?
+        self["no-cache"]
+      end
+
+      def no_store?
+        self["no-store"]
+      end
+
+      def must_revalidate?
+        self["must-revalidate"]
+      end
+
+      def proxy_revalidate?
+        self["proxy-revalidate"]
+      end
+
+      def max_age
+        self["max-age"].to_i if key?("max-age")
+      end
+
+      def reverse_max_age
+        self["r-maxage"].to_i if key?("r-maxage")
+      end
+      alias_method :r_maxage, :reverse_max_age
+
+      def shared_max_age
+        self["s-maxage"].to_i if key?("r-maxage")
+      end
+      alias_method :s_maxage, :shared_max_age
+
+      def to_s
+        directives = []
+        values = []
+
+        each do |key, value|
+          if value == true
+            directives << key
+          elsif value
+            values << "#{key}=#{value}"
+          end
+        end
+
+        (directives.sort + values.sort).join(", ")
+      end
+
+    private
+
+      def parse(header)
+        return if header.nil? || header.empty?
+
+        header.scan(PATTERN).each do |name, value|
+          self[name.downcase] = value || true
+        end
+      end
+    end
+
     def_delegators :to_hash, :[], :"<=>", :each, :dig
 
     def initialize(http_response, options = {})
@@ -63,7 +133,7 @@ module GdsApi
     end
 
     def cache_control
-      @cache_control ||= Rack::Cache::CacheControl.new(headers[:cache_control])
+      @cache_control ||= CacheControl.new(headers[:cache_control])
     end
 
     def to_hash
@@ -74,9 +144,13 @@ module GdsApi
       @parsed_content ||= transform_parsed(JSON.parse(@http_response.body))
     end
 
-    def present?; true; end
+    def present?
+      true
+    end
 
-    def blank?; false; end
+    def blank?
+      false
+    end
 
   private
 
@@ -85,7 +159,7 @@ module GdsApi
 
       case value
       when Hash
-        Hash[value.map { |k, v|
+        Hash[value.map do |k, v|
           # NOTE: Don't bother transforming if the value is nil
           if k == "web_url" && v
             # Use relative URLs to route when the web_url value is on the
@@ -98,7 +172,7 @@ module GdsApi
           else
             [k, transform_parsed(v)]
           end
-        }]
+        end]
       when Array
         value.map { |v| transform_parsed(v) }
       else

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -1,10 +1,6 @@
-require "gds_api/test_helpers/alias_deprecated"
-
 module GdsApi
   module TestHelpers
     module AssetManager
-      extend AliasDeprecated
-
       ASSET_MANAGER_ENDPOINT = Plek.current.find("asset-manager")
 
       def stub_any_asset_manager_call
@@ -107,19 +103,6 @@ module GdsApi
       def stub_asset_manager_delete_asset_failure(asset_id)
         stub_request(:delete, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}").to_return(status: 500)
       end
-
-      alias_deprecated :asset_manager_updates_any_asset, :stub_asset_manager_updates_any_asset
-      alias_deprecated :asset_manager_deletes_any_asset, :stub_asset_manager_deletes_any_asset
-      alias_deprecated :asset_manager_has_an_asset, :stub_asset_manager_has_an_asset
-      alias_deprecated :asset_manager_has_a_whitehall_asset, :stub_asset_manager_has_a_whitehall_asset
-      alias_deprecated :asset_manager_does_not_have_an_asset, :stub_asset_manager_does_not_have_an_asset
-      alias_deprecated :asset_manager_does_not_have_a_whitehall_asset, :stub_asset_manager_does_not_have_a_whitehall_asset
-      alias_deprecated :asset_manager_receives_an_asset, :stub_asset_manager_receives_an_asset
-      alias_deprecated :asset_manager_upload_failure, :stub_asset_manager_upload_failure
-      alias_deprecated :asset_manager_update_asset, :stub_asset_manager_update_asset
-      alias_deprecated :asset_manager_update_failure, :stub_asset_manager_update_asset_failure
-      alias_deprecated :asset_manager_delete_asset, :stub_asset_manager_delete_asset
-      alias_deprecated :asset_manager_delete_failure, :stub_asset_manager_delete_asset_failure
     end
   end
 end

data/lib/gds_api/test_helpers/calendars.rb

@@ -1,10 +1,6 @@
-require "gds_api/test_helpers/alias_deprecated"
-
 module GdsApi
   module TestHelpers
     module Calendars
-      extend AliasDeprecated
-
       def calendars_endpoint(in_division: nil)
         endpoint = "#{Plek.new.website_root}/bank-holidays"
         endpoint += "/#{in_division}" unless in_division.nil?
@@ -55,11 +51,6 @@ module GdsApi
       def stub_calendars_has_a_bank_holiday_on(date, in_division: nil)
         stub_calendars_has_bank_holidays_on([date], in_division: in_division)
       end
-
-      # Aliases for DEPRECATED methods
-      alias_deprecated :calendars_has_no_bank_holidays, :stub_calendars_has_no_bank_holidays
-      alias_deprecated :calendars_has_bank_holidays_on, :stub_calendars_has_bank_holidays_on
-      alias_deprecated :calendars_has_a_bank_holiday_on, :stub_calendars_has_a_bank_holiday_on
     end
   end
 end

data/lib/gds_api/test_helpers/content_store.rb

@@ -1,4 +1,3 @@
-require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 require "gds_api/test_helpers/content_item_helpers"
 require "json"
@@ -6,7 +5,6 @@ require "json"
 module GdsApi
   module TestHelpers
     module ContentStore
-      extend AliasDeprecated
       include ContentItemHelpers
 
       def content_store_endpoint(draft = false)
@@ -93,13 +91,6 @@ module GdsApi
 
         stub_request(:get, url).to_return(body: body)
       end
-
-      # Aliases for DEPRECATED methods
-      alias_deprecated :content_store_has_item, :stub_content_store_has_item
-      alias_deprecated :content_store_does_not_have_item, :stub_content_store_does_not_have_item
-      alias_deprecated :content_store_has_gone_item, :stub_content_store_has_gone_item
-      alias_deprecated :content_store_isnt_available, :stub_content_store_isnt_available
-      alias_deprecated :content_store_has_incoming_links, :stub_content_store_has_incoming_links
     end
   end
 end

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -83,12 +83,12 @@ module GdsApi
       #  stub_email_alert_api_has_subscriptions([
       #    {
       #      id: 'id-of-my-subscriber-list',
-      #      frequency: 'weekly',
+      #      frequency: 'weekly',
       #      ended: true,
       #    },
       #    {
       #      id: 'id-of-my-subscriber-list',
-      #      frequency: 'daily',
+      #      frequency: 'daily',
       #    },
       #  ])
       #
@@ -98,9 +98,9 @@ module GdsApi
         subscriptions.each do |id, params|
           latest_id, latest_params = get_latest_matching(params, subscriptions)
           stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}")
-            .to_return(status: 200, body: get_subscription_response(id, params).to_json)
+            .to_return(status: 200, body: get_subscription_response(id, **params).to_json)
           stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions/#{id}/latest")
-            .to_return(status: 200, body: get_subscription_response(latest_id, latest_params).to_json)
+            .to_return(status: 200, body: get_subscription_response(latest_id, **latest_params).to_json)
         end
       end
 
@@ -176,7 +176,7 @@ module GdsApi
 
       def assert_email_alert_api_content_change_created(attributes = nil)
         if attributes
-          matcher = ->(request) do
+          matcher = lambda do |request|
             payload = JSON.parse(request.body)
             payload.select { |k, _| attributes.key?(k) } == attributes
           end
@@ -187,7 +187,7 @@ module GdsApi
 
       def assert_email_alert_api_message_created(attributes = nil)
         if attributes
-          matcher = ->(request) do
+          matcher = lambda do |request|
             payload = JSON.parse(request.body)
             payload.select { |k, _| attributes.key?(k) } == attributes
           end
@@ -222,21 +222,21 @@ module GdsApi
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
             body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
-        ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json)
+          ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
       def stub_email_alert_api_creates_an_existing_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
             body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
-        ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json)
+          ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
       def stub_email_alert_api_refuses_to_create_subscription(subscriber_list_id, address, frequency)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
             body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
-        ).to_return(status: 422)
+          ).to_return(status: 422)
       end
 
       def stub_email_alert_api_sends_subscription_verification_email(address, frequency, topic_id)
@@ -292,7 +292,7 @@ module GdsApi
             body: {
               subscriber_list: returned_attributes,
             }.to_json,
-        )
+          )
       end
 
       def stub_email_alert_api_does_not_have_subscriber_list_by_slug(slug:)
@@ -300,30 +300,6 @@ module GdsApi
           .to_return(status: 404)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :email_alert_api_has_updated_subscriber, :stub_email_alert_api_has_updated_subscriber
-      alias_method :email_alert_api_does_not_have_updated_subscriber, :stub_email_alert_api_does_not_have_updated_subscriber
-      alias_method :email_alert_api_has_updated_subscription, :stub_email_alert_api_has_updated_subscription
-      alias_method :email_alert_api_does_not_have_updated_subscription, :stub_email_alert_api_does_not_have_updated_subscription
-      alias_method :email_alert_api_has_subscriber_subscriptions, :stub_email_alert_api_has_subscriber_subscriptions
-      alias_method :email_alert_api_does_not_have_subscriber_subscriptions, :stub_email_alert_api_does_not_have_subscriber_subscriptions
-      alias_method :email_alert_api_has_subscription, :stub_email_alert_api_has_subscription
-      alias_method :email_alert_api_has_subscriptions, :stub_email_alert_api_has_subscriptions
-      alias_method :email_alert_api_has_subscriber_list, :stub_email_alert_api_has_subscriber_list
-      alias_method :email_alert_api_does_not_have_subscriber_list, :stub_email_alert_api_does_not_have_subscriber_list
-      alias_method :email_alert_api_creates_subscriber_list, :stub_email_alert_api_creates_subscriber_list
-      alias_method :email_alert_api_refuses_to_create_subscriber_list, :stub_email_alert_api_refuses_to_create_subscriber_list
-      alias_method :email_alert_api_accepts_unpublishing_message, :stub_email_alert_api_accepts_unpublishing_message
-      alias_method :email_alert_api_unsubscribes_a_subscription, :stub_email_alert_api_unsubscribes_a_subscription
-      alias_method :email_alert_api_has_no_subscription_for_uuid, :stub_email_alert_api_has_no_subscription_for_uuid
-      alias_method :email_alert_api_unsubscribes_a_subscriber, :stub_email_alert_api_unsubscribes_a_subscriber
-      alias_method :email_alert_api_has_no_subscriber, :stub_email_alert_api_has_no_subscriber
-      alias_method :email_alert_api_creates_a_subscription, :stub_email_alert_api_creates_a_subscription
-      alias_method :email_alert_api_creates_an_existing_subscription, :stub_email_alert_api_creates_an_existing_subscription
-      alias_method :email_alert_api_refuses_to_create_subscription, :stub_email_alert_api_refuses_to_create_subscription
-      alias_method :email_alert_api_has_subscriber_list_by_slug, :stub_email_alert_api_has_subscriber_list_by_slug
-      alias_method :email_alert_api_does_not_have_subscriber_list_by_slug, :stub_email_alert_api_does_not_have_subscriber_list_by_slug
-
     private
 
       def get_subscriber_response(id, address)
@@ -348,7 +324,7 @@ module GdsApi
             "id" => id,
             "frequency" => frequency,
             "source" => "user_signed_up",
-            "ended_at" => ended ? Time.now.to_datetime.rfc3339 : nil,
+            "ended_at" => ended ? Time.now.iso8601 : nil,
             "ended_reason" => ended ? "unsubscribed" : nil,
             "subscriber" => {
               "id" => subscriber_id,

data/lib/gds_api/test_helpers/imminence.rb

@@ -1,11 +1,8 @@
-require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module Imminence
-      extend AliasDeprecated
-
       # Generally true. If you are initializing the client differently,
       # you could redefine/override the constant or stub directly.
       IMMINENCE_API_ENDPOINT = Plek.current.find("imminence")
@@ -18,12 +15,16 @@ module GdsApi
       def stub_imminence_has_areas_for_postcode(postcode, areas)
         results = {
           "_response_info" => { "status" => "ok" },
-          "total" => areas.size, "startIndex" => 1, "pageSize" => areas.size,
-          "currentPage" => 1, "pages" => 1, "results" => areas
+          "total" => areas.size,
+          "startIndex" => 1,
+          "pageSize" => areas.size,
+          "currentPage" => 1,
+          "pages" => 1,
+          "results" => areas,
         }
 
-        stub_request(:get, %r{\A#{IMMINENCE_API_ENDPOINT}/areas/#{postcode}\.json}).
-          to_return(body: results.to_json)
+        stub_request(:get, %r{\A#{IMMINENCE_API_ENDPOINT}/areas/#{postcode}\.json})
+          .to_return(body: results.to_json)
       end
 
       def stub_imminence_has_places_for_postcode(places, slug, postcode, limit)
@@ -32,14 +33,10 @@ module GdsApi
       end
 
       def stub_imminence_places_request(slug, query_hash, return_data, status_code = 200)
-        stub_request(:get, "#{IMMINENCE_API_ENDPOINT}/places/#{slug}.json").
-        with(query: query_hash).
-        to_return(status: status_code, body: return_data.to_json, headers: {})
+        stub_request(:get, "#{IMMINENCE_API_ENDPOINT}/places/#{slug}.json")
+        .with(query: query_hash)
+        .to_return(status: status_code, body: return_data.to_json, headers: {})
       end
-
-      alias_deprecated :imminence_has_places, :stub_imminence_has_places
-      alias_deprecated :imminence_has_areas_for_postcode, :stub_imminence_has_areas_for_postcode
-      alias_deprecated :imminence_has_places_for_postcode, :stub_imminence_has_places_for_postcode
     end
   end
 end

data/lib/gds_api/test_helpers/licence_application.rb

@@ -1,28 +1,25 @@
-require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module LicenceApplication
-      extend AliasDeprecated
-
       # Generally true. If you are initializing the client differently,
       # you could redefine/override the constant or stub directly.
       LICENCE_APPLICATION_ENDPOINT = Plek.current.find("licensify")
 
       def stub_licence_exists(identifier, licence)
         licence = licence.to_json unless licence.is_a?(String)
-        stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}").
-          with(headers: GdsApi::JsonClient.default_request_headers).
-          to_return(status: 200,
-            body: licence)
+        stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}")
+          .with(headers: GdsApi::JsonClient.default_request_headers)
+          .to_return(status: 200,
+                     body: licence)
       end
 
       def stub_licence_does_not_exist(identifier)
-        stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}").
-          with(headers: GdsApi::JsonClient.default_request_headers).
-          to_return(status: 404,
-            body: "{\"error\": [\"Unrecognised Licence Id: #{identifier}\"]}")
+        stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}")
+          .with(headers: GdsApi::JsonClient.default_request_headers)
+          .to_return(status: 404,
+                     body: "{\"error\": [\"Unrecognised Licence Id: #{identifier}\"]}")
       end
 
       def stub_licence_times_out(identifier)
@@ -32,11 +29,6 @@ module GdsApi
       def stub_licence_returns_error(identifier)
         stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}").to_return(status: 500)
       end
-
-      alias_deprecated :licence_exists, :stub_licence_exists
-      alias_deprecated :licence_does_not_exist, :stub_licence_does_not_exist
-      alias_deprecated :licence_times_out, :stub_licence_times_out
-      alias_deprecated :licence_returns_error, :stub_licence_returns_error
     end
   end
 end

data/lib/gds_api/test_helpers/link_checker_api.rb

@@ -1,10 +1,8 @@
-require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module LinkCheckerApi
-      extend AliasDeprecated
       LINK_CHECKER_API_ENDPOINT = Plek.current.find("link-checker-api")
 
       def link_checker_api_link_report_hash(uri:, status: :ok, checked: nil, errors: [], warnings: [], problem_summary: nil, suggested_fix: nil)
@@ -91,12 +89,6 @@ module GdsApi
             headers: { "Content-Type" => "application/json" },
           )
       end
-
-      # Aliases for DEPRECATED methods
-      alias_deprecated :link_checker_api_check, :stub_link_checker_api_check
-      alias_deprecated :link_checker_api_get_batch, :stub_link_checker_api_get_batch
-      alias_deprecated :link_checker_api_create_batch, :stub_link_checker_api_create_batch
-      alias_deprecated :link_checker_api_upsert_resource_monitor, :stub_link_checker_api_upsert_resource_monitor
     end
   end
 end