gds-api-adapters 63.3.0 → 67.0.0

data/lib/gds_api/test_helpers/publishing_api.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"
@@ -7,7 +6,6 @@ module GdsApi
   module TestHelpers
     # @api documented
     module PublishingApi
-      extend AliasDeprecated
       include ContentItemHelpers
 
       PUBLISHING_API_V2_ENDPOINT = Plek.current.find("publishing-api") + "/v2"
@@ -174,20 +172,19 @@ module GdsApi
         stub_request(:post, %r{\A#{PUBLISHING_API_V2_ENDPOINT}/content/.*/discard-draft})
       end
 
-      # Stub any version 2 request to the publishing API
+      # Stub any request to the publishing API
       def stub_any_publishing_api_call
-        stub_request(:any, %r{\A#{PUBLISHING_API_V2_ENDPOINT}})
+        stub_request(:any, %r{\A#{PUBLISHING_API_ENDPOINT}})
       end
 
-      # Stub any version 2 request to the publishing API to return a 404 response
+      # Stub any request to the publishing API to return a 404 response
       def stub_any_publishing_api_call_to_return_not_found
-        stub_request(:any, %r{\A#{PUBLISHING_API_V2_ENDPOINT}})
+        stub_request(:any, %r{\A#{PUBLISHING_API_ENDPOINT}})
           .to_return(status: 404, headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
-      # Stub any version 2 request to the publishing API to return a 503 response
+      # Stub any request to the publishing API to return a 503 response
       def stub_publishing_api_isnt_available
-        stub_request(:any, /#{PUBLISHING_API_V2_ENDPOINT}\/.*/).to_return(status: 503)
         stub_request(:any, /#{PUBLISHING_API_ENDPOINT}\/.*/).to_return(status: 503)
       end
 
@@ -267,11 +264,11 @@ module GdsApi
       # @param attributes_or_matcher [Object]
       # @param times [Integer]
       def assert_publishing_api(verb, url, attributes_or_matcher = nil, times = 1)
-        if attributes_or_matcher.is_a?(Hash)
-          matcher = request_json_matches(attributes_or_matcher)
-        else
-          matcher = attributes_or_matcher
-        end
+        matcher = if attributes_or_matcher.is_a?(Hash)
+                    request_json_matches(attributes_or_matcher)
+                  else
+                    attributes_or_matcher
+                  end
 
         if matcher
           assert_requested(verb, url, times: times, &matcher)
@@ -282,16 +279,16 @@ module GdsApi
 
       # Get a request matcher that checks if a JSON request includes a set of attributes
       def request_json_includes(required_attributes)
-        ->(request) do
+        lambda do |request|
           data = JSON.parse(request.body)
-          deep_stringify_keys(required_attributes).
-            to_a.all? { |key, value| data[key] == value }
+          deep_stringify_keys(required_attributes)
+            .to_a.all? { |key, value| data[key] == value }
         end
       end
 
       # Get a request matcher that checks if a JSON request matches a hash
       def request_json_matches(required_attributes)
-        ->(request) do
+        lambda do |request|
           data = JSON.parse(request.body)
           deep_stringify_keys(required_attributes) == data
         end
@@ -346,13 +343,13 @@ module GdsApi
       # This method has been refactored into publishing_api_has_content (above)
       # publishing_api_has_content allows for flexible passing in of arguments, please use instead
       def stub_publishing_api_has_fields_for_document(document_type, items, fields)
-        body = Array(items).map { |item|
+        body = Array(items).map do |item|
           deep_stringify_keys(item).slice(*fields)
-        }
+        end
 
-        query_params = fields.map { |f|
+        query_params = fields.map do |f|
           "&fields%5B%5D=#{f}"
-        }
+        end
 
         url = PUBLISHING_API_V2_ENDPOINT + "/content?document_type=#{document_type}#{query_params.join('')}"
 
@@ -495,7 +492,7 @@ module GdsApi
       def stub_publishing_api_has_expanded_links(links, with_drafts: true, generate: false)
         links = deep_transform_keys(links, &:to_sym)
         request_params = {}
-        request_params["with_drafts"] = false if !with_drafts
+        request_params["with_drafts"] = false unless with_drafts
         request_params["generate"] = true if generate
 
         url = PUBLISHING_API_V2_ENDPOINT + "/expanded-links/" + links[:content_id]
@@ -577,7 +574,7 @@ module GdsApi
       def stub_publishing_api_has_linked_items(items, params = {})
         content_id = params.fetch(:content_id)
         link_type = params.fetch(:link_type)
-        fields = params.fetch(:fields, %w(base_path content_id document_type title))
+        fields = params.fetch(:fields, %w[base_path content_id document_type title])
 
         url = PUBLISHING_API_V2_ENDPOINT + "/linked/#{content_id}"
 
@@ -641,6 +638,10 @@ module GdsApi
         stub_publishing_api_unreserve_path_with_code(base_path, publishing_app, 422)
       end
 
+      def stub_any_publishing_api_unreserve_path
+        stub_request(:delete, %r{\A#{PUBLISHING_API_ENDPOINT}/paths/})
+      end
+
       # Stub a PUT /publish-intent/:base_path request with the given base_path
       # and request body.
       #
@@ -681,11 +682,11 @@ module GdsApi
       end
 
       def assert_publishing_api_put(url, attributes_or_matcher = {}, times = 1)
-        if attributes_or_matcher.is_a?(Hash)
-          matcher = attributes_or_matcher.empty? ? nil : request_json_matching(attributes_or_matcher)
-        else
-          matcher = attributes_or_matcher
-        end
+        matcher = if attributes_or_matcher.is_a?(Hash)
+                    attributes_or_matcher.empty? ? nil : request_json_matching(attributes_or_matcher)
+                  else
+                    attributes_or_matcher
+                  end
 
         if matcher
           assert_requested(:put, url, times: times, &matcher)
@@ -695,14 +696,14 @@ module GdsApi
       end
 
       def request_json_matching(required_attributes)
-        ->(request) do
+        lambda do |request|
           data = JSON.parse(request.body)
           required_attributes.to_a.all? { |key, value| data[key.to_s] == value }
         end
       end
 
       def request_json_including(required_attributes)
-        ->(request) do
+        lambda do |request|
           data = JSON.parse(request.body)
           values_match_recursively(required_attributes, data)
         end
@@ -736,7 +737,7 @@ module GdsApi
       # @example
       #   stub_any_publishing_api_path_reservation
       def stub_any_publishing_api_path_reservation
-        stub_request(:put, %r[\A#{PUBLISHING_API_ENDPOINT}/paths/]).to_return do |request|
+        stub_request(:put, %r{\A#{PUBLISHING_API_ENDPOINT}/paths/}).to_return do |request|
           base_path = request.uri.path.sub(%r{\A/paths}, "")
           body = JSON.parse(request.body).merge(base_path: base_path)
           {
@@ -762,16 +763,16 @@ module GdsApi
                   message: "Base path #{message}",
                   fields: { base_path: [message] } }
 
-        stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}").
-                  to_return(status: 422,
-                            headers: { content_type: "application/json" },
-                            body: { error: error }.to_json)
+        stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}")
+                  .to_return(status: 422,
+                             headers: { content_type: "application/json" },
+                             body: { error: error }.to_json)
 
-        stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}").
-          with(body: { "publishing_app" => publishing_app }).
-          to_return(status: 200,
-                    headers: { content_type: "application/json" },
-                    body: { publishing_app: publishing_app, base_path: path }.to_json)
+        stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{path}")
+          .with(body: { "publishing_app" => publishing_app })
+          .to_return(status: 200,
+                     headers: { content_type: "application/json" },
+                     body: { publishing_app: publishing_app, base_path: path }.to_json)
       end
 
       # Stub a PUT /paths/:base_path request for a particular publishing
@@ -794,30 +795,11 @@ module GdsApi
 
         error = { code: 422, message: message, fields: error_fields }
 
-        stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{base_path}").
-          to_return(status: 422,
-                    headers: { content_type: "application/json" },
-                    body: { error: error }.to_json)
-      end
-
-      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
+        stub_request(:put, "#{PUBLISHING_API_ENDPOINT}/paths#{base_path}")
+          .to_return(status: 422,
+                     headers: { content_type: "application/json" },
+                     body: { error: error }.to_json)
+      end
 
     private
 
@@ -885,7 +867,7 @@ module GdsApi
           return false unless actual_value.is_a?(Hash)
 
           expected_value.all? do |expected_sub_key, expected_sub_value|
-            actual_value.has_key?(expected_sub_key.to_s) &&
+            actual_value.key?(expected_sub_key.to_s) &&
               values_match_recursively(expected_sub_value, actual_value[expected_sub_key.to_s])
           end
         when Array

data/lib/gds_api/test_helpers/search.rb

@@ -17,11 +17,11 @@ module GdsApi
       end
 
       def assert_search_posted_item(attributes, index: nil, **options)
-        if index
-          url = SEARCH_ENDPOINT + "/#{index}/documents"
-        else
-          url = SEARCH_ENDPOINT + "/documents"
-        end
+        url = if index
+                SEARCH_ENDPOINT + "/#{index}/documents"
+              else
+                SEARCH_ENDPOINT + "/documents"
+              end
 
         assert_requested(:post, url, **options) do |req|
           data = JSON.parse(req.body)

data/lib/gds_api/test_helpers/support.rb

@@ -1,9 +1,6 @@
-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)
@@ -21,8 +18,6 @@ module GdsApi
       def stub_support_isnt_available
         stub_request(:post, /#{SUPPORT_ENDPOINT}\/.*/).to_return(status: 503)
       end
-
-      alias_deprecated :support_isnt_available, :stub_support_isnt_available
     end
   end
 end

data/lib/gds_api/test_helpers/support_api.rb

@@ -1,11 +1,9 @@
-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)
@@ -65,9 +63,9 @@ module GdsApi
       end
 
       def stub_support_api_problem_reports(params, response_body = {})
-        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports").
-          with(query: params).
-          to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports")
+          .with(query: params)
+          .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_support_api_mark_reviewed_for_spam(request_details = nil, response_body = {})
@@ -89,8 +87,8 @@ module GdsApi
       def stub_support_api_anonymous_feedback_organisation_summary(slug, ordering = nil, response_body = {})
         uri = "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/organisations/#{slug}"
         uri << "?ordering=#{ordering}" if ordering
-        stub_http_request(:get, uri).
-          to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, uri)
+          .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_support_api_organisations_list(response_body = nil)
@@ -111,8 +109,8 @@ module GdsApi
           },
         ]
 
-        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/organisations").
-          to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/organisations")
+          .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_support_api_organisation(slug = "cabinet-office", response_body = nil)
@@ -124,22 +122,22 @@ module GdsApi
           govuk_status: "live",
         }
 
-        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/organisations/#{slug}").
-          to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/organisations/#{slug}")
+          .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_support_api_document_type_list(response_body = nil)
-        response_body ||= %w(case_study detailed_guide smart_answer)
+        response_body ||= %w[case_study detailed_guide smart_answer]
 
-        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/document-types").
-            to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/document-types")
+            .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_support_api_anonymous_feedback_doc_type_summary(document_type, ordering = nil, response_body = nil)
         uri = "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/document-types/#{document_type}"
         uri << "?ordering=#{ordering}" if ordering
-        stub_http_request(:get, uri).
-            to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, uri)
+            .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_support_api_feedback_export_request(id, response_body = nil)
@@ -148,15 +146,13 @@ module GdsApi
           ready: true,
         }
 
-        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/export-requests/#{id}").
-          to_return(status: 200, body: response_body.to_json)
+        stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/export-requests/#{id}")
+          .to_return(status: 200, body: response_body.to_json)
       end
 
       def stub_any_support_api_call
         stub_request(:any, %r{\A#{SUPPORT_API_ENDPOINT}})
       end
-
-      alias_deprecated :support_api_isnt_available, :stub_support_api_isnt_available
     end
   end
 end

data/lib/gds_api/test_helpers/worldwide.rb

@@ -1,14 +1,12 @@
-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-frontend")
+      WORLDWIDE_API_ENDPOINT = Plek.new.website_root
 
       # Sets up the index endpoints for the given country slugs
       # The stubs are setup to paginate in chunks of 20
@@ -23,12 +21,14 @@ module GdsApi
         end
 
         pages.each_with_index do |page, i|
-          page_details = plural_response_base.merge("results" => page,
+          page_details = plural_response_base.merge(
+            "results" => page,
             "total" => location_slugs.size,
             "pages" => pages.size,
             "current_page" => i + 1,
             "page_size" => 20,
-            "start_index" => i * 20 + 1)
+            "start_index" => i * 20 + 1,
+          )
 
           links = { self: "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?page=#{i + 1}" }
           links[:next] = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations?page=#{i + 2}" if pages[i + 1]
@@ -40,32 +40,59 @@ module GdsApi
             link_headers << "<#{href}>; rel=\"#{rel}\""
           end
 
-          stub_request(:get, links[:self]).
-            to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
+          stub_request(:get, links[:self])
+            .to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
 
-          if i.zero?
-            # First page exists at URL with and without page param
-            stub_request(:get, links[:self].sub(/\?page=1/, "")).
-              to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
-          end
+          next unless i.zero?
+
+          # First page exists at URL with and without page param
+          stub_request(:get, links[:self].sub(/\?page=1/, ""))
+            .to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
         end
       end
 
       def stub_worldwide_api_has_selection_of_locations
-        stub_worldwide_api_has_locations %w(
-          afghanistan angola australia bahamas belarus brazil brunei cambodia chad
-          croatia denmark eritrea france ghana iceland japan laos luxembourg malta
-          micronesia mozambique nicaragua panama portugal sao-tome-and-principe singapore
-          south-korea sri-lanka uk-delegation-to-council-of-europe
+        stub_worldwide_api_has_locations %w[
+          afghanistan
+          angola
+          australia
+          bahamas
+          belarus
+          brazil
+          brunei
+          cambodia
+          chad
+          croatia
+          denmark
+          eritrea
+          france
+          ghana
+          iceland
+          japan
+          laos
+          luxembourg
+          malta
+          micronesia
+          mozambique
+          nicaragua
+          panama
+          portugal
+          sao-tome-and-principe
+          singapore
+          south-korea
+          sri-lanka
+          uk-delegation-to-council-of-europe
           uk-delegation-to-organization-for-security-and-co-operation-in-europe
-          united-kingdom venezuela vietnam
-        )
+          united-kingdom
+          venezuela
+          vietnam
+        ]
       end
 
       def stub_worldwide_api_has_location(location_slug, details = nil)
         details ||= world_location_for_slug(location_slug)
-        stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}").
-          to_return(status: 200, body: details.to_json)
+        stub_request(:get, "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}")
+          .to_return(status: 200, body: details.to_json)
       end
 
       def stub_worldwide_api_does_not_have_location(location_slug)
@@ -75,15 +102,15 @@ module GdsApi
       def stub_worldwide_api_has_organisations_for_location(location_slug, json_or_hash)
         json = json_or_hash.is_a?(Hash) ? json_or_hash.to_json : json_or_hash
         url = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}/organisations"
-        stub_request(:get, url).
-          to_return(status: 200, body: json, headers: { "Link" => "<#{url}; rel\"self\"" })
+        stub_request(:get, url)
+          .to_return(status: 200, body: json, headers: { "Link" => "<#{url}; rel\"self\"" })
       end
 
       def stub_worldwide_api_has_no_organisations_for_location(location_slug)
         details = { "results" => [], "total" => 0, "_response_info" => { "status" => "ok" } }
         url = "#{WORLDWIDE_API_ENDPOINT}/api/world-locations/#{location_slug}/organisations"
-        stub_request(:get, url).
-          to_return(status: 200, body: details.to_json, headers: { "Link" => "<#{url}; rel\"self\"" })
+        stub_request(:get, url)
+          .to_return(status: 200, body: details.to_json, headers: { "Link" => "<#{url}; rel\"self\"" })
       end
 
       def world_location_for_slug(slug)
@@ -112,13 +139,6 @@ module GdsApi
           "content_id" => "content_id_for_#{slug}",
         }
       end
-
-      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