gds-api-adapters 63.1.1 → 63.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f01a6b60b867bcd614338616006fbbf13690f758329163ea9f17a184ba14f57
-  data.tar.gz: 3c8e3370a84684dac3b71111519eb307a23efe99d59594ed731491f23978d7c5
+  metadata.gz: 6be83d400c0df3de1819b715246ae6436c5172bd871bdcb7a4e897acd5064739
+  data.tar.gz: b414936cc16230ad7522f1971679dc2f560823f2f3083970f11b5463f11ae316
 SHA512:
-  metadata.gz: 65da05dda6a15ea79b6fb0e20d9af73819e26fb74f3a4ff4a4614f050e2f1037a340929933165668b7164df9180125da56742bafb5156dc3750c5fd5c9f6736b
-  data.tar.gz: 9a50289c99fabff521bd9b81375efa56111a287fed2e33c1fc8eb8492fa7fc0bf6dde2e18b737a8bbfb7c095e5546cc1cb3a0af4a9e04902c5ece577d6fea543
+  metadata.gz: bc52a03e4ee75813e8d7d393660ca62d5e27bd7a4e9ac9accc3eeca71fdb68796fc14cdad6d532460df8a2666a75ea35de62b4612043981751f7f97b32239cdf
+  data.tar.gz: 04cab17475d2ca057813740f59f5e7ac59409d59406c74aa4762ef227dcccd91083df8b7b9ab5361df0e72b1a0013d6375f7ae168794dee91930b6e7715ab621

data/lib/gds_api/publishing_api.rb

@@ -8,6 +8,8 @@ require_relative "exceptions"
 # @see https://github.com/alphagov/publishing-api/blob/master/doc/model.md
 # @api documented
 class GdsApi::PublishingApi < GdsApi::Base
+  class NoLiveVersion < GdsApi::BaseError; end
+
   # Put a content item
   #
   # @param content_id [UUID]
@@ -34,6 +36,29 @@ class GdsApi::PublishingApi < GdsApi::Base
     get_json(content_url(content_id, params))
   end
 
+  # Return a live content item, i.e. content that has a state of "published" or "unpublished"
+  #
+  # Raises exception if the item doesn't exist.
+  #
+  # @param content_id [UUID]
+  # @option locale [String] locale The language, defaults to 'en' in publishing-api.
+  #
+  # @return [GdsApi::Response] a content item
+  #
+  # @raise [NoLiveVersion] when the content item is not found
+  # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#get-v2contentcontent_id
+  def get_live_content(content_id, locale = "en")
+    content_item = get_content(content_id, locale: locale)
+
+    live_states = %w[published unpublished]
+    return content_item if live_states.include?(content_item.to_h["publication_state"])
+
+    live_version_number = content_item["state_history"].find { |_, v| live_states.include?(v) }&.first
+    raise NoLiveVersion, "No live version exists for content_id: #{content_id}" unless live_version_number
+
+    get_content(content_id, locale: locale, version: live_version_number)
+  end
+
   # Find the content_ids for a list of base_paths.
   #
   # @param base_paths [Array]

data/lib/gds_api/test_helpers/alias_deprecated.rb

@@ -0,0 +1,13 @@
+module GdsApi
+  module TestHelpers
+    module AliasDeprecated
+      def alias_deprecated(deprecated_method, replacement_method)
+        class_name = self.name
+        define_method(deprecated_method) do |*args, &block|
+          warn "##{deprecated_method} is deprecated on #{class_name} and will be removed in a future version. Use ##{replacement_method} instead"
+          public_send(replacement_method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -1,6 +1,10 @@
+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
@@ -104,19 +108,18 @@ module GdsApi
         stub_request(:delete, "#{ASSET_MANAGER_ENDPOINT}/assets/#{asset_id}").to_return(status: 500)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :asset_manager_updates_any_asset, :stub_asset_manager_updates_any_asset
-      alias_method :asset_manager_deletes_any_asset, :stub_asset_manager_deletes_any_asset
-      alias_method :asset_manager_has_an_asset, :stub_asset_manager_has_an_asset
-      alias_method :asset_manager_has_a_whitehall_asset, :stub_asset_manager_has_a_whitehall_asset
-      alias_method :asset_manager_does_not_have_an_asset, :stub_asset_manager_does_not_have_an_asset
-      alias_method :asset_manager_does_not_have_a_whitehall_asset, :stub_asset_manager_does_not_have_a_whitehall_asset
-      alias_method :asset_manager_receives_an_asset, :stub_asset_manager_receives_an_asset
-      alias_method :asset_manager_upload_failure, :stub_asset_manager_upload_failure
-      alias_method :asset_manager_update_asset, :stub_asset_manager_update_asset
-      alias_method :asset_manager_update_failure, :stub_asset_manager_update_asset_failure
-      alias_method :asset_manager_delete_asset, :stub_asset_manager_delete_asset
-      alias_method :asset_manager_delete_failure, :stub_asset_manager_delete_asset_failure
+      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,14 +1,18 @@
+require "gds_api/test_helpers/alias_deprecated"
+
 module GdsApi
   module TestHelpers
     module Calendars
-      def stub_calendars_endpoint(in_division: nil)
+      extend AliasDeprecated
+
+      def calendars_endpoint(in_division: nil)
         endpoint = "#{Plek.new.website_root}/bank-holidays"
         endpoint += "/#{in_division}" unless in_division.nil?
         endpoint + ".json"
       end
 
       def stub_calendars_has_no_bank_holidays(in_division: nil)
-        calendars_has_bank_holidays_on([], in_division: in_division)
+        stub_calendars_has_bank_holidays_on([], in_division: in_division)
       end
 
       def stub_calendars_has_bank_holidays_on(dates, in_division: nil)
@@ -49,14 +53,13 @@ module GdsApi
       end
 
       def stub_calendars_has_a_bank_holiday_on(date, in_division: nil)
-        calendars_has_bank_holidays_on([date], in_division: in_division)
+        stub_calendars_has_bank_holidays_on([date], in_division: in_division)
       end
 
       # Aliases for DEPRECATED methods
-      alias_method :calendars_endpoint, :stub_calendars_endpoint
-      alias_method :calendars_has_no_bank_holidays, :stub_calendars_has_no_bank_holidays
-      alias_method :calendars_has_bank_holidays_on, :stub_calendars_has_bank_holidays_on
-      alias_method :calendars_has_a_bank_holiday_on, :stub_calendars_has_a_bank_holiday_on
+      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,3 +1,4 @@
+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"
@@ -5,8 +6,13 @@ require "json"
 module GdsApi
   module TestHelpers
     module ContentStore
+      extend AliasDeprecated
       include ContentItemHelpers
 
+      def content_store_endpoint(draft = false)
+        draft ? Plek.current.find("draft-content-store") : Plek.current.find("content-store")
+      end
+
       # Stubs a content item in the content store.
       # The following options can be passed in:
       #
@@ -14,14 +20,10 @@ module GdsApi
       #   :private  if true, the Cache-Control header will include the "private" directive. By default it
       #             will include "public"
       #   :draft    will point to the draft content store if set to true
-      def stub_content_store_endpoint(draft = false)
-        draft ? Plek.current.find("draft-content-store") : Plek.current.find("content-store")
-      end
-
       def stub_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 = stub_content_store_endpoint(options[:draft]) + "/content" + base_path
+        url = content_store_endpoint(options[:draft]) + "/content" + base_path
         body = body.to_json unless body.is_a?(String)
 
         stub_request(:get, url).to_return(
@@ -35,10 +37,10 @@ module GdsApi
       end
 
       def stub_content_store_does_not_have_item(base_path, options = {})
-        url = stub_content_store_endpoint(options[:draft]) + "/content" + base_path
+        url = content_store_endpoint(options[:draft]) + "/content" + base_path
         stub_request(:get, url).to_return(status: 404, headers: {})
 
-        url = stub_content_store_endpoint(options[:draft]) + "/incoming-links" + base_path
+        url = content_store_endpoint(options[:draft]) + "/incoming-links" + base_path
         stub_request(:get, url).to_return(status: 404, headers: {})
       end
 
@@ -67,7 +69,7 @@ module GdsApi
       #     "details" => {}
       #   }
       def stub_content_store_has_gone_item(base_path, body = gone_content_item_for_base_path(base_path), options = {})
-        url = stub_content_store_endpoint(options[:draft]) + "/content" + base_path
+        url = content_store_endpoint(options[:draft]) + "/content" + base_path
         body = body.to_json unless body.is_a?(String)
 
         stub_request(:get, url).to_return(
@@ -78,7 +80,7 @@ module GdsApi
       end
 
       def stub_content_store_isnt_available
-        stub_request(:any, /#{stub_content_store_endpoint}\/.*/).to_return(status: 503)
+        stub_request(:any, /#{content_store_endpoint}\/.*/).to_return(status: 503)
       end
 
       def content_item_for_base_path(base_path)
@@ -86,19 +88,18 @@ module GdsApi
       end
 
       def stub_content_store_has_incoming_links(base_path, links)
-        url = stub_content_store_endpoint + "/incoming-links" + base_path
+        url = content_store_endpoint + "/incoming-links" + base_path
         body = links.to_json
 
         stub_request(:get, url).to_return(body: body)
       end
 
       # Aliases for DEPRECATED methods
-      alias_method :content_store_endpoint, :stub_content_store_endpoint
-      alias_method :content_store_has_item, :stub_content_store_has_item
-      alias_method :content_store_does_not_have_item, :stub_content_store_does_not_have_item
-      alias_method :content_store_has_gone_item, :stub_content_store_has_gone_item
-      alias_method :content_store_isnt_available, :stub_content_store_isnt_available
-      alias_method :content_store_has_incoming_links, :stub_content_store_has_incoming_links
+      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/imminence.rb

@@ -1,8 +1,11 @@
+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")
@@ -34,10 +37,9 @@ module GdsApi
         to_return(status: status_code, body: return_data.to_json, headers: {})
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :imminence_has_places, :stub_imminence_has_places
-      alias_method :imminence_has_areas_for_postcode, :stub_imminence_has_areas_for_postcode
-      alias_method :imminence_has_places_for_postcode, :stub_imminence_has_places_for_postcode
+      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,8 +1,11 @@
+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")
@@ -30,11 +33,10 @@ module GdsApi
         stub_request(:get, "#{LICENCE_APPLICATION_ENDPOINT}/api/licence/#{identifier}").to_return(status: 500)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :licence_exists, :stub_licence_exists
-      alias_method :licence_does_not_exist, :stub_licence_does_not_exist
-      alias_method :licence_times_out, :stub_licence_times_out
-      alias_method :licence_returns_error, :stub_licence_returns_error
+      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,11 +1,13 @@
+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 stub_link_checker_api_link_report_hash(uri:, status: :ok, checked: nil, errors: [], warnings: [], problem_summary: nil, suggested_fix: nil)
+      def link_checker_api_link_report_hash(uri:, status: :ok, checked: nil, errors: [], warnings: [], problem_summary: nil, suggested_fix: nil)
         {
           uri: uri,
           status: status,
@@ -17,18 +19,18 @@ module GdsApi
         }
       end
 
-      def stub_link_checker_api_batch_report_hash(id:, status: :completed, links: [], totals: {}, completed_at: nil)
+      def link_checker_api_batch_report_hash(id:, status: :completed, links: [], totals: {}, completed_at: nil)
         {
           id: id,
           status: status,
-          links: links.map { |hash| stub_link_checker_api_link_report_hash(**hash) },
+          links: links.map { |hash| link_checker_api_link_report_hash(**hash) },
           totals: totals,
           completed_at: completed_at || Time.now.iso8601,
         }
       end
 
       def stub_link_checker_api_check(uri:, status: :ok, checked: nil, errors: [], warnings: [], problem_summary: nil, suggested_fix: nil)
-        body = stub_link_checker_api_link_report_hash(
+        body = link_checker_api_link_report_hash(
           uri: uri, status: status, checked: checked, errors: errors, warnings: warnings, problem_summary: problem_summary, suggested_fix: suggested_fix,
         ).to_json
 
@@ -38,7 +40,7 @@ module GdsApi
       end
 
       def stub_link_checker_api_get_batch(id:, status: :completed, links: [], totals: {}, completed_at: nil)
-        body = stub_link_checker_api_batch_report_hash(
+        body = link_checker_api_batch_report_hash(
           id: id, status: status, links: links, totals: totals, completed_at: completed_at,
         ).to_json
 
@@ -49,7 +51,7 @@ module GdsApi
       def stub_link_checker_api_create_batch(uris:, checked_within: nil, webhook_uri: nil, webhook_secret_token: nil, id: 0, status: :in_progress, links: nil, totals: {}, completed_at: nil)
         links = uris.map { |uri| { uri: uri } } if links.nil?
 
-        response_body = stub_link_checker_api_batch_report_hash(
+        response_body = link_checker_api_batch_report_hash(
           id: id,
           status: status,
           links: links,
@@ -91,12 +93,10 @@ module GdsApi
       end
 
       # Aliases for DEPRECATED methods
-      alias_method :link_checker_api_link_report_hash, :stub_link_checker_api_link_report_hash
-      alias_method :link_checker_api_batch_report_hash, :stub_link_checker_api_batch_report_hash
-      alias_method :link_checker_api_check, :stub_link_checker_api_check
-      alias_method :link_checker_api_get_batch, :stub_link_checker_api_get_batch
-      alias_method :link_checker_api_create_batch, :stub_link_checker_api_create_batch
-      alias_method :link_checker_api_upsert_resource_monitor, :stub_link_checker_api_upsert_resource_monitor
+      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

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -1,8 +1,10 @@
+require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module LocalLinksManager
+      extend AliasDeprecated
       LOCAL_LINKS_MANAGER_ENDPOINT = Plek.current.find("local-links-manager")
 
       def stub_local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:)
@@ -115,14 +117,14 @@ module GdsApi
 
       def stub_local_links_manager_request_without_local_authority_slug
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-        .with(query: { authority_slug: "" })
-        .to_return(body: {}.to_json, status: 400)
+          .with(query: { authority_slug: "" })
+          .to_return(body: {}.to_json, status: 400)
       end
 
       def stub_local_links_manager_does_not_have_an_authority(authority_slug)
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
-        .with(query: { authority_slug: authority_slug })
-        .to_return(body: {}.to_json, status: 404)
+          .with(query: { authority_slug: authority_slug })
+          .to_return(body: {}.to_json, status: 404)
       end
 
       def stub_local_links_manager_has_a_local_authority_without_homepage(authority_slug)
@@ -141,17 +143,16 @@ module GdsApi
           .to_return(body: response.to_json, status: 200)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :local_links_manager_has_a_link, :stub_local_links_manager_has_a_link
-      alias_method :local_links_manager_has_no_link, :stub_local_links_manager_has_no_link
-      alias_method :local_links_manager_has_no_link_and_no_homepage_url, :stub_local_links_manager_has_no_link_and_no_homepage_url
-      alias_method :local_links_manager_request_with_missing_parameters, :stub_local_links_manager_request_with_missing_parameters
-      alias_method :local_links_manager_does_not_have_required_objects, :stub_local_links_manager_does_not_have_required_objects
-      alias_method :local_links_manager_has_a_local_authority, :stub_local_links_manager_has_a_local_authority
-      alias_method :local_links_manager_has_a_district_and_county_local_authority, :stub_local_links_manager_has_a_district_and_county_local_authority
-      alias_method :local_links_manager_request_without_local_authority_slug, :stub_local_links_manager_request_without_local_authority_slug
-      alias_method :local_links_manager_does_not_have_an_authority, :stub_local_links_manager_does_not_have_an_authority
-      alias_method :local_links_manager_has_a_local_authority_without_homepage, :stub_local_links_manager_has_a_local_authority_without_homepage
+      alias_deprecated :local_links_manager_has_a_link, :stub_local_links_manager_has_a_link
+      alias_deprecated :local_links_manager_has_no_link, :stub_local_links_manager_has_no_link
+      alias_deprecated :local_links_manager_has_no_link_and_no_homepage_url, :stub_local_links_manager_has_no_link_and_no_homepage_url
+      alias_deprecated :local_links_manager_request_with_missing_parameters, :stub_local_links_manager_request_with_missing_parameters
+      alias_deprecated :local_links_manager_does_not_have_required_objects, :stub_local_links_manager_does_not_have_required_objects
+      alias_deprecated :local_links_manager_has_a_local_authority, :stub_local_links_manager_has_a_local_authority
+      alias_deprecated :local_links_manager_has_a_district_and_county_local_authority, :stub_local_links_manager_has_a_district_and_county_local_authority
+      alias_deprecated :local_links_manager_request_without_local_authority_slug, :stub_local_links_manager_request_without_local_authority_slug
+      alias_deprecated :local_links_manager_does_not_have_an_authority, :stub_local_links_manager_does_not_have_an_authority
+      alias_deprecated :local_links_manager_has_a_local_authority_without_homepage, :stub_local_links_manager_has_a_local_authority_without_homepage
     end
   end
 end

data/lib/gds_api/test_helpers/mapit.rb

@@ -1,6 +1,9 @@
+require "gds_api/test_helpers/alias_deprecated"
+
 module GdsApi
   module TestHelpers
     module Mapit
+      extend AliasDeprecated
       MAPIT_ENDPOINT = Plek.current.find("mapit")
 
       def stub_mapit_has_a_postcode(postcode, coords)
@@ -72,15 +75,14 @@ module GdsApi
         .to_return(body: { "code" => 404, "error" => "No areas were found that matched code #{code_type} = #{code}." }.to_json, status: 404)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :mapit_has_a_postcode, :stub_mapit_has_a_postcode
-      alias_method :mapit_has_a_postcode_and_areas, :stub_mapit_has_a_postcode_and_areas
-      alias_method :mapit_does_not_have_a_postcode, :stub_mapit_does_not_have_a_postcode
-      alias_method :mapit_does_not_have_a_bad_postcode, :stub_mapit_does_not_have_a_bad_postcode
-      alias_method :mapit_has_areas, :stub_mapit_has_areas
-      alias_method :mapit_does_not_have_areas, :stub_mapit_does_not_have_areas
-      alias_method :mapit_has_area_for_code, :stub_mapit_has_area_for_code
-      alias_method :mapit_does_not_have_area_for_code, :stub_mapit_does_not_have_area_for_code
+      alias_deprecated :mapit_has_a_postcode, :stub_mapit_has_a_postcode
+      alias_deprecated :mapit_has_a_postcode_and_areas, :stub_mapit_has_a_postcode_and_areas
+      alias_deprecated :mapit_does_not_have_a_postcode, :stub_mapit_does_not_have_a_postcode
+      alias_deprecated :mapit_does_not_have_a_bad_postcode, :stub_mapit_does_not_have_a_bad_postcode
+      alias_deprecated :mapit_has_areas, :stub_mapit_has_areas
+      alias_deprecated :mapit_does_not_have_areas, :stub_mapit_does_not_have_areas
+      alias_deprecated :mapit_has_area_for_code, :stub_mapit_has_area_for_code
+      alias_deprecated :mapit_does_not_have_area_for_code, :stub_mapit_does_not_have_area_for_code
     end
   end
 end

data/lib/gds_api/test_helpers/organisations.rb

@@ -1,3 +1,4 @@
+require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 require "gds_api/test_helpers/common_responses"
 require "plek"
@@ -6,13 +7,14 @@ require "securerandom"
 module GdsApi
   module TestHelpers
     module Organisations
+      extend AliasDeprecated
       include GdsApi::TestHelpers::CommonResponses
 
       WEBSITE_ROOT = Plek.new.website_root
 
       def stub_organisations_api_has_organisations(organisation_slugs)
         bodies = organisation_slugs.map { |slug| organisation_for_slug(slug) }
-        organisations_api_has_organisations_with_bodies(bodies)
+        stub_organisations_api_has_organisations_with_bodies(bodies)
       end
 
       # Sets up the index endpoints for the given organisation slugs
@@ -24,7 +26,7 @@ module GdsApi
         # Stub API call to the endpoint for an individual organisation
         organisation_bodies.each do |body|
           slug = body["details"]["slug"]
-          organisations_api_has_organisation(slug, body)
+          stub_organisations_api_has_organisation(slug, body)
         end
 
         pages = []
@@ -116,11 +118,10 @@ module GdsApi
         }
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :organisations_api_has_organisations, :stub_organisations_api_has_organisations
-      alias_method :organisations_api_has_organisations_with_bodies, :stub_organisations_api_has_organisations_with_bodies
-      alias_method :organisations_api_has_organisation, :stub_organisations_api_has_organisation
-      alias_method :organisations_api_does_not_have_organisation, :stub_organisations_api_does_not_have_organisation
+      alias_deprecated :organisations_api_has_organisations, :stub_organisations_api_has_organisations
+      alias_deprecated :organisations_api_has_organisations_with_bodies, :stub_organisations_api_has_organisations_with_bodies
+      alias_deprecated :organisations_api_has_organisation, :stub_organisations_api_has_organisation
+      alias_deprecated :organisations_api_does_not_have_organisation, :stub_organisations_api_does_not_have_organisation
     end
   end
 end

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -1,14 +1,14 @@
+require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 require "gds_api/test_helpers/content_item_helpers"
-require "gds_api/test_helpers/intent_helpers"
 require "json"
 
 module GdsApi
   module TestHelpers
     # @api documented
     module PublishingApi
+      extend AliasDeprecated
       include ContentItemHelpers
-      include IntentHelpers
 
       PUBLISHING_API_V2_ENDPOINT = Plek.current.find("publishing-api") + "/v2"
       PUBLISHING_API_ENDPOINT = Plek.current.find("publishing-api")
@@ -641,10 +641,29 @@ module GdsApi
         stub_publishing_api_unreserve_path_with_code(base_path, publishing_app, 422)
       end
 
-      def stub_publishing_api_put_intent(base_path, body = intent_for_publishing_api(base_path))
-        url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
-        body = body.to_json unless body.is_a?(String)
-        stub_request(:put, url).with(body: body).to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/json; charset=utf-8" })
+      # Stub a PUT /publish-intent/:base_path request with the given base_path
+      # and request body.
+      #
+      # @example
+      #   stub_publishing_api_put_intent(
+      #     "/path/to/content",
+      #     publishing_app: "publisher",
+      #     rendering_app: "frontend",
+      #     publish_time: "2019-11-11T17:56:17+00:00",
+      #   )
+      #
+      # @param base_path [String]
+      # @param params [Hash]
+      def stub_publishing_api_put_intent(base_path, params = {})
+        url = PUBLISHING_API_ENDPOINT + "/publish-intent#{base_path}"
+        body = params.is_a?(String) ? params : params.to_json
+
+        response = {
+          status: 200,
+          headers: { content_type: "application/json" },
+          body: body,
+        }
+        stub_request(:put, url).with(body: params).to_return(response)
       end
 
       def stub_publishing_api_destroy_intent(base_path)
@@ -689,11 +708,12 @@ module GdsApi
         end
       end
 
-      # Stub a PUT /paths/:base_path request with the given content id and request body.
+      # Stub a PUT /paths/:base_path request with the given base_path and
+      # request body.
       #
       # @example
       #   stub_publishing_api_path_reservation(
-      #     my_content_id,
+      #     "/path/to",
       #     publishing_app: "content-publisher",
       #     override_existing: true,
       #   )
@@ -780,25 +800,24 @@ module GdsApi
                     body: { error: error }.to_json)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :publishing_api_isnt_available, :stub_publishing_api_isnt_available
-      alias_method :publishing_api_has_content, :stub_publishing_api_has_content
-      alias_method :publishing_api_has_fields_for_document, :stub_publishing_api_has_fields_for_document
-      alias_method :publishing_api_has_linkables, :stub_publishing_api_has_linkables
-      alias_method :publishing_api_has_item, :stub_publishing_api_has_item
-      alias_method :publishing_api_has_item_in_sequence, :stub_publishing_api_has_item_in_sequence
-      alias_method :publishing_api_does_not_have_item, :stub_publishing_api_does_not_have_item
-      alias_method :publishing_api_has_links, :stub_publishing_api_has_links
-      alias_method :publishing_api_has_expanded_links, :stub_publishing_api_has_expanded_links
-      alias_method :publishing_api_has_links_for_content_ids, :stub_publishing_api_has_links_for_content_ids
-      alias_method :publishing_api_does_not_have_links, :stub_publishing_api_does_not_have_links
-      alias_method :publishing_api_has_lookups, :stub_publishing_api_has_lookups
-      alias_method :publishing_api_has_linked_items, :stub_publishing_api_has_linked_items
-      alias_method :publishing_api_get_editions, :stub_publishing_api_get_editions
-      alias_method :publishing_api_has_path_reservation_for, :stub_publishing_api_has_path_reservation_for
-      alias_method :publishing_api_returns_path_reservation_validation_error_for, :stub_publishing_api_returns_path_reservation_validation_error_for
-      alias_method :stub_default_publishing_api_path_reservation, :stub_any_publishing_api_path_reservation
-      alias_method :stub_default_publishing_api_put_intent, :stub_any_publishing_api_put_intent
+      alias_deprecated :publishing_api_isnt_available, :stub_publishing_api_isnt_available
+      alias_deprecated :publishing_api_has_content, :stub_publishing_api_has_content
+      alias_deprecated :publishing_api_has_fields_for_document, :stub_publishing_api_has_fields_for_document
+      alias_deprecated :publishing_api_has_linkables, :stub_publishing_api_has_linkables
+      alias_deprecated :publishing_api_has_item, :stub_publishing_api_has_item
+      alias_deprecated :publishing_api_has_item_in_sequence, :stub_publishing_api_has_item_in_sequence
+      alias_deprecated :publishing_api_does_not_have_item, :stub_publishing_api_does_not_have_item
+      alias_deprecated :publishing_api_has_links, :stub_publishing_api_has_links
+      alias_deprecated :publishing_api_has_expanded_links, :stub_publishing_api_has_expanded_links
+      alias_deprecated :publishing_api_has_links_for_content_ids, :stub_publishing_api_has_links_for_content_ids
+      alias_deprecated :publishing_api_does_not_have_links, :stub_publishing_api_does_not_have_links
+      alias_deprecated :publishing_api_has_lookups, :stub_publishing_api_has_lookups
+      alias_deprecated :publishing_api_has_linked_items, :stub_publishing_api_has_linked_items
+      alias_deprecated :publishing_api_get_editions, :stub_publishing_api_get_editions
+      alias_deprecated :publishing_api_has_path_reservation_for, :stub_publishing_api_has_path_reservation_for
+      alias_deprecated :publishing_api_returns_path_reservation_validation_error_for, :stub_publishing_api_returns_path_reservation_validation_error_for
+      alias_deprecated :stub_default_publishing_api_path_reservation, :stub_any_publishing_api_path_reservation
+      alias_deprecated :stub_default_publishing_api_put_intent, :stub_any_publishing_api_put_intent
 
     private
 
@@ -884,10 +903,6 @@ module GdsApi
       def content_item_for_publishing_api(base_path, publishing_app = "publisher")
         content_item_for_base_path(base_path).merge("publishing_app" => publishing_app)
       end
-
-      def intent_for_publishing_api(base_path, publishing_app = "publisher")
-        intent_for_base_path(base_path).merge("publishing_app" => publishing_app)
-      end
     end
   end
 end

data/lib/gds_api/test_helpers/support.rb

@@ -1,6 +1,9 @@
+require "gds_api/test_helpers/alias_deprecated"
+
 module GdsApi
   module TestHelpers
     module Support
+      extend AliasDeprecated
       SUPPORT_ENDPOINT = Plek.current.find("support")
 
       def stub_support_foi_request_creation(request_details = nil)
@@ -19,8 +22,7 @@ module GdsApi
         stub_request(:post, /#{SUPPORT_ENDPOINT}\/.*/).to_return(status: 503)
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :support_isnt_available, :stub_support_isnt_available
+      alias_deprecated :support_isnt_available, :stub_support_isnt_available
     end
   end
 end

data/lib/gds_api/test_helpers/support_api.rb

@@ -1,9 +1,11 @@
+require "gds_api/test_helpers/alias_deprecated"
 require "cgi"
 require "plek"
 
 module GdsApi
   module TestHelpers
     module SupportApi
+      extend AliasDeprecated
       SUPPORT_API_ENDPOINT = Plek.current.find("support-api")
 
       def stub_support_api_problem_report_creation(request_details = nil)
@@ -154,8 +156,7 @@ module GdsApi
         stub_request(:any, %r{\A#{SUPPORT_API_ENDPOINT}})
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :support_api_isnt_available, :stub_support_api_isnt_available
+      alias_deprecated :support_api_isnt_available, :stub_support_api_isnt_available
     end
   end
 end

data/lib/gds_api/test_helpers/worldwide.rb

@@ -1,9 +1,11 @@
+require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 require "gds_api/test_helpers/common_responses"
 
 module GdsApi
   module TestHelpers
     module Worldwide
+      extend AliasDeprecated
       include GdsApi::TestHelpers::CommonResponses
 
       WORLDWIDE_API_ENDPOINT = Plek.current.find("whitehall-admin")
@@ -111,13 +113,12 @@ module GdsApi
         }
       end
 
-      # Aliases for DEPRECATED methods
-      alias_method :worldwide_api_has_locations, :stub_worldwide_api_has_locations
-      alias_method :worldwide_api_has_selection_of_locations, :stub_worldwide_api_has_selection_of_locations
-      alias_method :worldwide_api_has_location, :stub_worldwide_api_has_location
-      alias_method :worldwide_api_has_does_not_have_location, :stub_worldwide_api_does_not_have_location
-      alias_method :worldwide_api_has_organisations_for_location, :stub_worldwide_api_has_organisations_for_location
-      alias_method :worldwide_api_has_no_organisations_for_location, :stub_worldwide_api_has_no_organisations_for_location
+      alias_deprecated :worldwide_api_has_locations, :stub_worldwide_api_has_locations
+      alias_deprecated :worldwide_api_has_selection_of_locations, :stub_worldwide_api_has_selection_of_locations
+      alias_deprecated :worldwide_api_has_location, :stub_worldwide_api_has_location
+      alias_deprecated :worldwide_api_has_does_not_have_location, :stub_worldwide_api_does_not_have_location
+      alias_deprecated :worldwide_api_has_organisations_for_location, :stub_worldwide_api_has_organisations_for_location
+      alias_deprecated :worldwide_api_has_no_organisations_for_location, :stub_worldwide_api_has_no_organisations_for_location
     end
   end
 end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "63.1.1".freeze
+  VERSION = "63.2.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 63.1.1
+  version: 63.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-20 00:00:00.000000000 Z
+date: 2020-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -413,6 +413,7 @@ files:
 - lib/gds_api/search.rb
 - lib/gds_api/support.rb
 - lib/gds_api/support_api.rb
+- lib/gds_api/test_helpers/alias_deprecated.rb
 - lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/calendars.rb
 - lib/gds_api/test_helpers/common_responses.rb
@@ -420,7 +421,6 @@ files:
 - lib/gds_api/test_helpers/content_store.rb
 - lib/gds_api/test_helpers/email_alert_api.rb
 - lib/gds_api/test_helpers/imminence.rb
-- lib/gds_api/test_helpers/intent_helpers.rb
 - lib/gds_api/test_helpers/json_client_helper.rb
 - lib/gds_api/test_helpers/licence_application.rb
 - lib/gds_api/test_helpers/link_checker_api.rb

data/lib/gds_api/test_helpers/intent_helpers.rb

@@ -1,12 +0,0 @@
-module GdsApi
-  module TestHelpers
-    module IntentHelpers
-      def intent_for_base_path(base_path)
-        {
-          "base_path" => base_path,
-          "publish_time" => "2014-05-06T12:01:00+00:00",
-        }
-      end
-    end
-  end
-end