gds-api-adapters 63.5.0 → 67.1.0

data/lib/gds_api/test_helpers/local_links_manager.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 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:)
@@ -142,17 +140,6 @@ module GdsApi
           .with(query: { authority_slug: authority_slug })
           .to_return(body: response.to_json, status: 200)
       end
-
-      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,16 +1,13 @@
-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)
         response = {
           "wgs84_lat" => coords.first,
           "wgs84_lon" => coords.last,
-          "postcode"  => postcode,
+          "postcode" => postcode,
         }
 
         stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
@@ -23,21 +20,22 @@ module GdsApi
         response = {
           "wgs84_lat" => coords.first,
           "wgs84_lon" => coords.last,
-          "postcode"  => postcode,
+          "postcode" => postcode,
         }
 
-        area_response = Hash[areas.map.with_index { |area, i|
-          [i, {
-            "codes" => {
-              "ons" => area["ons"],
-              "gss" => area["gss"],
-              "govuk_slug" => area["govuk_slug"],
-            },
-            "name" => area["name"],
-            "type" => area["type"],
-            "country_name" => area["country_name"],
-          }]
-        }]
+        area_response = Hash[areas.map.with_index do |area, i|
+          [i,
+           {
+             "codes" => {
+               "ons" => area["ons"],
+               "gss" => area["gss"],
+               "govuk_slug" => area["govuk_slug"],
+             },
+             "name" => area["name"],
+             "type" => area["type"],
+             "country_name" => area["country_name"],
+           }]
+        end]
 
         stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
           .to_return(body: response.merge("areas" => area_response).to_json, status: 200)
@@ -74,15 +72,6 @@ module GdsApi
         stub_request(:get, "#{MAPIT_ENDPOINT}/code/#{code_type}/#{code}.json")
         .to_return(body: { "code" => 404, "error" => "No areas were found that matched code #{code_type} = #{code}." }.to_json, status: 404)
       end
-
-      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,4 +1,3 @@
-require "gds_api/test_helpers/alias_deprecated"
 require "gds_api/test_helpers/json_client_helper"
 require "gds_api/test_helpers/common_responses"
 require "plek"
@@ -7,7 +6,6 @@ require "securerandom"
 module GdsApi
   module TestHelpers
     module Organisations
-      extend AliasDeprecated
       include GdsApi::TestHelpers::CommonResponses
 
       WEBSITE_ROOT = Plek.new.website_root
@@ -35,12 +33,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" => organisation_bodies.size,
             "pages" => pages.size,
             "current_page" => i + 1,
             "page_size" => 20,
-            "start_index" => i * 20 + 1)
+            "start_index" => i * 20 + 1,
+          )
 
           links = { self: "#{WEBSITE_ROOT}/api/organisations?page=#{i + 1}" }
           links[:next] = "#{WEBSITE_ROOT}/api/organisations?page=#{i + 2}" if pages[i + 1]
@@ -52,14 +52,14 @@ 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
 
         if pages.empty?
@@ -70,8 +70,8 @@ module GdsApi
 
       def stub_organisations_api_has_organisation(organisation_slug, details = nil)
         details ||= organisation_for_slug(organisation_slug)
-        stub_request(:get, "#{WEBSITE_ROOT}/api/organisations/#{organisation_slug}").
-          to_return(status: 200, body: details.to_json)
+        stub_request(:get, "#{WEBSITE_ROOT}/api/organisations/#{organisation_slug}")
+          .to_return(status: 200, body: details.to_json)
       end
 
       def stub_organisations_api_does_not_have_organisation(organisation_slug)
@@ -117,11 +117,6 @@ module GdsApi
           ],
         }
       end
-
-      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/performance_platform/data_out.rb

@@ -5,13 +5,13 @@ module GdsApi
         PP_DATA_OUT_ENDPOINT = "https://www.performance.service.gov.uk".freeze
 
         def stub_service_feedback(slug, response_body = {})
-          stub_http_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/#{slug}/customer-satisfaction").
-            to_return(status: 200, body: response_body.to_json)
+          stub_http_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/#{slug}/customer-satisfaction")
+            .to_return(status: 200, body: response_body.to_json)
         end
 
         def stub_data_set_not_available(slug)
-          stub_http_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/#{slug}/customer-satisfaction").
-            to_return(status: 404)
+          stub_http_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/#{slug}/customer-satisfaction")
+            .to_return(status: 404)
         end
 
         def stub_service_not_available
@@ -20,51 +20,51 @@ module GdsApi
 
         def stub_search_terms(slug, response_body = {})
           options = {
-              slug: slug,
-              transaction: "search-terms",
-              group_by: "searchKeyword",
-              collect: "searchUniques:sum",
+            slug: slug,
+            transaction: "search-terms",
+            group_by: "searchKeyword",
+            collect: "searchUniques:sum",
           }
           stub_statistics(options, false, response_body)
         end
 
         def stub_searches(slug, is_multipart, response_body = {})
           options = {
-              slug: slug,
-              transaction: "search-terms",
-              group_by: "pagePath",
-              collect: "searchUniques:sum",
+            slug: slug,
+            transaction: "search-terms",
+            group_by: "pagePath",
+            collect: "searchUniques:sum",
           }
           stub_statistics(options, is_multipart, response_body)
         end
 
         def stub_page_views(slug, is_multipart, response_body = {})
           options = {
-              slug: slug,
-              transaction: "page-statistics",
-              group_by: "pagePath",
-              collect: "uniquePageviews:sum",
+            slug: slug,
+            transaction: "page-statistics",
+            group_by: "pagePath",
+            collect: "uniquePageviews:sum",
           }
           stub_statistics(options, is_multipart, response_body)
         end
 
         def stub_problem_reports(slug, is_multipart, response_body = {})
           options = {
-              slug: slug,
-              transaction: "page-contacts",
-              group_by: "pagePath",
-              collect: "total:sum",
+            slug: slug,
+            transaction: "page-contacts",
+            group_by: "pagePath",
+            collect: "total:sum",
           }
           stub_statistics(options, is_multipart, response_body)
         end
 
         def stub_statistics(options, is_multipart, response_body = {})
           params = {
-              group_by: options[:group_by],
-              collect: options[:collect],
-              duration: 42,
-              period: "day",
-              end_at: Date.today.to_time.getutc.iso8601,
+            group_by: options[:group_by],
+            collect: options[:collect],
+            duration: 42,
+            period: "day",
+            end_at: Date.today.to_time.getutc.iso8601,
           }
 
           filter_param = is_multipart ? :filter_by_prefix : :filter_by
@@ -76,21 +76,21 @@ module GdsApi
         end
 
         def stub_search_404(slug)
-          stub_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/search-terms").
-              with(query: hash_including(filter_by: slug)).
-              to_return(status: 404, headers: { content_type: "application/json" })
+          stub_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/search-terms")
+              .with(query: hash_including(filter_by: slug))
+              .to_return(status: 404, headers: { content_type: "application/json" })
         end
 
         def stub_page_views_404(slug)
-          stub_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/page-statistics").
-              with(query: hash_including(filter_by: slug)).
-              to_return(status: 404, headers: { content_type: "application/json" })
+          stub_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/page-statistics")
+              .with(query: hash_including(filter_by: slug))
+              .to_return(status: 404, headers: { content_type: "application/json" })
         end
 
         def stub_problem_reports_404(slug)
-          stub_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/page-contacts").
-              with(query: hash_including(filter_by: slug)).
-              to_return(status: 404, headers: { content_type: "application/json" })
+          stub_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/page-contacts")
+              .with(query: hash_including(filter_by: slug))
+              .to_return(status: 404, headers: { content_type: "application/json" })
         end
       end
     end

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"
@@ -266,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)
@@ -281,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
@@ -345,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('')}"
 
@@ -396,9 +394,11 @@ module GdsApi
       # Stub GET /v2/content/:content_id to return a 404 response
       #
       # @param content_id [UUID]
-      def stub_publishing_api_does_not_have_item(content_id)
+      def stub_publishing_api_does_not_have_item(content_id, params = {})
         url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
-        stub_request(:get, url).to_return(status: 404, body: resource_not_found(content_id, "content item").to_json, headers: {})
+        stub_request(:get, url)
+          .with(query: hash_including(params))
+          .to_return(status: 404, body: resource_not_found(content_id, "content item").to_json, headers: {})
       end
 
       # Stub a request to links endpoint
@@ -494,7 +494,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]
@@ -576,7 +576,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}"
 
@@ -684,11 +684,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)
@@ -698,14 +698,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
@@ -739,7 +739,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)
           {
@@ -765,16 +765,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
@@ -797,30 +797,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
 
@@ -888,7 +869,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