gds-api-adapters 60.1.0 → 61.0.0

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -1,7 +1,7 @@
-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'
+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
@@ -9,7 +9,7 @@ module GdsApi
       include ContentItemHelpers
       include IntentHelpers
 
-      PUBLISHING_API_ENDPOINT = Plek.current.find('publishing-api')
+      PUBLISHING_API_ENDPOINT = Plek.current.find("publishing-api")
 
       def stub_publishing_api_unreserve_path(base_path, publishing_app = /.*/)
         stub_publishing_api_unreserve_path_with_code(base_path, publishing_app, 200)
@@ -26,12 +26,12 @@ module GdsApi
       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_request(:put, url).with(body: body).to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
       def stub_publishing_api_destroy_intent(base_path)
         url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
-        stub_request(:delete, url).to_return(status: 200, body: '{}', headers: { "Content-Type" => "application/json; charset=utf-8" })
+        stub_request(:delete, url).to_return(status: 200, body: "{}", headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
       def stub_default_publishing_api_put_intent
@@ -116,7 +116,7 @@ module GdsApi
       def stub_publishing_api_unreserve_path_with_code(base_path, publishing_app, code)
         url = PUBLISHING_API_ENDPOINT + "/paths" + base_path
         body = { publishing_app: publishing_app }
-        stub_request(:delete, url).with(body: body).to_return(status: code, body: '{}', headers: { "Content-Type" => "application/json; charset=utf-8" })
+        stub_request(:delete, url).with(body: body).to_return(status: code, body: "{}", headers: { "Content-Type" => "application/json; charset=utf-8" })
       end
 
       def values_match_recursively(expected_value, actual_value)

data/lib/gds_api/test_helpers/publishing_api_v2.rb

@@ -1,7 +1,7 @@
-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'
+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
@@ -9,8 +9,8 @@ module GdsApi
     module PublishingApiV2
       include ContentItemHelpers
 
-      PUBLISHING_API_V2_ENDPOINT = Plek.current.find('publishing-api') + '/v2'
-      PUBLISHING_API_ENDPOINT = Plek.current.find('publishing-api')
+      PUBLISHING_API_V2_ENDPOINT = Plek.current.find("publishing-api") + "/v2"
+      PUBLISHING_API_ENDPOINT = Plek.current.find("publishing-api")
 
       # Stub a PUT /v2/content/:content_id request with the given content id and request body.
       # if no response_hash is given, a default response as follows is created:
@@ -30,7 +30,7 @@ module GdsApi
       # @param body  [String]
       # @param response_hash [Hash]
       def stub_publishing_api_put_content(content_id, body, response_hash = {})
-        stub_publishing_api_put(content_id, body, '/content', response_hash)
+        stub_publishing_api_put(content_id, body, "/content", response_hash)
       end
 
       # Stub a PATCH /v2/links/:content_id request
@@ -47,7 +47,7 @@ module GdsApi
       # @param content_id [UUID]
       # @param body  [String]
       def stub_publishing_api_patch_links(content_id, body)
-        stub_publishing_api_patch(content_id, body, '/links')
+        stub_publishing_api_patch(content_id, body, "/links")
       end
 
       # Stub a PATCH /v2/links/:content_id request to return a 409 response
@@ -66,7 +66,7 @@ module GdsApi
       def stub_publishing_api_patch_links_conflict(content_id, body)
         previous_version = JSON.parse(body.to_json)["previous_version"]
         override_response_hash = { status: 409, body: version_conflict(previous_version) }
-        stub_publishing_api_patch(content_id, body, '/links', override_response_hash)
+        stub_publishing_api_patch(content_id, body, "/links", override_response_hash)
       end
 
       # Stub a POST /v2/content/:content_id/publish request
@@ -78,8 +78,8 @@ module GdsApi
         url = PUBLISHING_API_V2_ENDPOINT + "/content/#{content_id}/publish"
         response = {
           status: 200,
-          body: '{}',
-          headers: { "Content-Type" => "application/json; charset=utf-8" }
+          body: "{}",
+          headers: { "Content-Type" => "application/json; charset=utf-8" },
         }.merge(response_hash)
         stub_request(:post, url).with(body: body).to_return(response)
       end
@@ -93,8 +93,8 @@ module GdsApi
         url = PUBLISHING_API_V2_ENDPOINT + "/content/#{content_id}/republish"
         response = {
           status: 200,
-          body: '{}',
-          headers: { "Content-Type" => "application/json; charset=utf-8" }
+          body: "{}",
+          headers: { "Content-Type" => "application/json; charset=utf-8" },
         }.merge(response_hash)
         stub_request(:post, url).with(body: body).to_return(response)
       end
@@ -108,8 +108,8 @@ module GdsApi
         url = PUBLISHING_API_V2_ENDPOINT + "/content/#{content_id}/unpublish"
         response = {
           status: 200,
-          body: '{}',
-          headers: { "Content-Type" => "application/json; charset=utf-8" }
+          body: "{}",
+          headers: { "Content-Type" => "application/json; charset=utf-8" },
         }.merge(response_hash)
         stub_request(:post, url).with(params).to_return(response)
       end
@@ -334,7 +334,7 @@ module GdsApi
           results: page_items,
           total: items.count,
           pages: number_of_pages,
-          current_page: page
+          current_page: page,
         }
 
         stub_request(:get, url)
@@ -494,8 +494,8 @@ 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['generate'] = true if generate
+        request_params["with_drafts"] = false if !with_drafts
+        request_params["generate"] = true if generate
 
         url = PUBLISHING_API_V2_ENDPOINT + "/expanded-links/" + links[:content_id]
         stub_request(:get, url)
@@ -552,7 +552,7 @@ module GdsApi
       #   })
       #
       def stub_publishing_api_has_lookups(lookup_hash)
-        url = Plek.current.find('publishing-api') + '/lookup-by-base-path'
+        url = Plek.current.find("publishing-api") + "/lookup-by-base-path"
         stub_request(:post, url).to_return(body: lookup_hash.to_json)
       end
 
@@ -578,7 +578,7 @@ module GdsApi
         link_type = params.fetch(:link_type)
         fields = params.fetch(:fields, %w(base_path content_id document_type title))
 
-        url = Plek.current.find('publishing-api') + "/v2/linked/#{content_id}"
+        url = Plek.current.find("publishing-api") + "/v2/linked/#{content_id}"
 
         request_parmeters = {
           "fields" => fields,
@@ -589,7 +589,7 @@ module GdsApi
           .with(query: request_parmeters)
           .and_return(
             body: items.to_json,
-            status: 200
+            status: 200,
           )
       end
 
@@ -655,7 +655,7 @@ module GdsApi
       end
 
       def stub_publishing_api_postlike_call(method, content_id, body, resource_path, override_response_hash = {})
-        response_hash = { status: 200, body: '{}', headers: { "Content-Type" => "application/json; charset=utf-8" } }
+        response_hash = { status: 200, body: "{}", headers: { "Content-Type" => "application/json; charset=utf-8" } }
         response_hash.merge!(override_response_hash)
         response_hash[:body] = response_hash[:body].to_json if response_hash[:body].is_a?(Hash)
         url = PUBLISHING_API_V2_ENDPOINT + resource_path + "/" + content_id
@@ -684,7 +684,7 @@ module GdsApi
           error: {
             code: 404,
             message: "Could not find #{type} with content_id: #{content_id}",
-          }
+          },
         }
       end
 
@@ -694,7 +694,7 @@ module GdsApi
             code: 409,
             message: "A lock-version conflict occurred. The `previous_version` you've sent (#{expected_version}) is not the same as the current lock version of the edition (#{actual_version}).",
             fields: { previous_version: ["does not match"] },
-          }
+          },
         }
       end
     end

data/lib/gds_api/test_helpers/router.rb

@@ -1,19 +1,19 @@
-require 'gds_api/test_helpers/json_client_helper'
+require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module Router
-      ROUTER_API_ENDPOINT = Plek.current.find('router-api')
+      ROUTER_API_ENDPOINT = Plek.current.find("router-api")
 
-      def stub_router_has_route(path, route, bearer_token = ENV['ROUTER_API_BEARER_TOKEN'])
+      def stub_router_has_route(path, route, bearer_token = ENV["ROUTER_API_BEARER_TOKEN"])
         stub_get_route(path, bearer_token).to_return(
           status: 200,
           body: route.to_json,
-          headers: { "Content-Type" => "application/json" }
+          headers: { "Content-Type" => "application/json" },
         )
       end
 
-      def stub_router_doesnt_have_route(path, bearer_token = ENV['ROUTER_API_BEARER_TOKEN'])
+      def stub_router_doesnt_have_route(path, bearer_token = ENV["ROUTER_API_BEARER_TOKEN"])
         stub_get_route(path, bearer_token).to_return(status: 404)
       end
 
@@ -47,9 +47,9 @@ module GdsApi
           route: {
             incoming_path: path,
             route_type: type,
-            handler: 'backend',
-            backend_id: backend_id
-          }
+            handler: "backend",
+            backend_id: backend_id,
+          },
         }
 
         register_stub = stub_route_put(route)
@@ -62,11 +62,11 @@ module GdsApi
           route: {
             incoming_path: path,
             route_type: type,
-            handler: 'redirect',
+            handler: "redirect",
             redirect_to: destination,
             redirect_type: redirect_type,
             segments_mode: segments_mode,
-          }
+          },
         }
 
         register_stub = stub_route_put(redirect)
@@ -79,8 +79,8 @@ module GdsApi
           route: {
             incoming_path: path,
             route_type: type,
-            handler: 'gone',
-          }
+            handler: "gone",
+          },
         }
 
         register_stub = stub_route_put(route)

data/lib/gds_api/test_helpers/rummager.rb

@@ -1,6 +1,6 @@
-require 'json'
-require 'gds_api/test_helpers/json_client_helper'
-require 'gds_api/test_helpers/search'
+require "json"
+require "gds_api/test_helpers/json_client_helper"
+require "gds_api/test_helpers/search"
 
 module GdsApi
   module TestHelpers

data/lib/gds_api/test_helpers/search.rb

@@ -1,10 +1,10 @@
-require 'json'
-require 'gds_api/test_helpers/json_client_helper'
+require "json"
+require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module Search
-      SEARCH_ENDPOINT = Plek.current.find('search')
+      SEARCH_ENDPOINT = Plek.current.find("search")
 
       def stub_any_search_post(index: nil)
         if index
@@ -58,20 +58,20 @@ module GdsApi
 
       def assert_search_deleted_item(id, index: nil, **options)
         if id =~ %r{^/}
-          raise ArgumentError, 'Search id must not start with a slash'
+          raise ArgumentError, "Search id must not start with a slash"
         end
 
         if index
           assert_requested(
             :delete,
             %r{#{SEARCH_ENDPOINT}/#{index}/documents/#{id}},
-            **options
+            **options,
           )
         else
           assert_requested(
             :delete,
             %r{#{SEARCH_ENDPOINT}/documents/#{id}},
-            **options
+            **options,
           )
         end
       end
@@ -80,7 +80,7 @@ module GdsApi
         assert_requested(
           :delete,
           %r{#{SEARCH_ENDPOINT}/content.*#{base_path}},
-          **options
+          **options,
         )
       end
 
@@ -128,8 +128,8 @@ module GdsApi
         File.read(
           File.expand_path(
             "../../../test/fixtures/services_and_info_fixture.json",
-            __dir__
-          )
+            __dir__,
+          ),
         )
       end
 
@@ -137,8 +137,8 @@ module GdsApi
         File.read(
           File.expand_path(
             "../../../test/fixtures/no_services_and_info_data_found_fixture.json",
-            __dir__
-          )
+            __dir__,
+          ),
         )
       end
 
@@ -146,8 +146,8 @@ module GdsApi
         File.read(
           File.expand_path(
             "../../../test/fixtures/sub_sector_organisations.json",
-            __dir__
-          )
+            __dir__,
+          ),
         )
       end
 
@@ -155,8 +155,8 @@ module GdsApi
         File.read(
           File.expand_path(
             "../../../test/fixtures/new_policies_for_dwp.json",
-            __dir__
-          )
+            __dir__,
+          ),
         )
       end
 
@@ -164,8 +164,8 @@ module GdsApi
         File.read(
           File.expand_path(
             "../../../test/fixtures/old_policies_for_dwp.json",
-            __dir__
-          )
+            __dir__,
+          ),
         )
       end
 
@@ -184,7 +184,7 @@ module GdsApi
       def example_query
         {
           filter_organisations: %w[an-organisation-slug],
-          facet_specialist_sectors: "1000,examples:4,example_scope:global,order:value.title"
+          facet_specialist_sectors: "1000,examples:4,example_scope:global,order:value.title",
         }
       end
     end

data/lib/gds_api/test_helpers/support.rb

@@ -1,7 +1,7 @@
 module GdsApi
   module TestHelpers
     module Support
-      SUPPORT_ENDPOINT = Plek.current.find('support')
+      SUPPORT_ENDPOINT = Plek.current.find("support")
 
       def stub_support_foi_request_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_ENDPOINT}/foi_requests")

data/lib/gds_api/test_helpers/support_api.rb

@@ -1,10 +1,10 @@
-require 'cgi'
-require 'plek'
+require "cgi"
+require "plek"
 
 module GdsApi
   module TestHelpers
     module SupportApi
-      SUPPORT_API_ENDPOINT = Plek.current.find('support-api')
+      SUPPORT_API_ENDPOINT = Plek.current.find("support-api")
 
       def stub_support_api_problem_report_creation(request_details = nil)
         post_stub = stub_http_request(:post, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/problem-reports")
@@ -98,15 +98,15 @@ module GdsApi
             web_url: "https://www.gov.uk/government/organisations/cabinet-office",
             title: "Cabinet Office",
             acronym: "CO",
-            govuk_status: "live"
+            govuk_status: "live",
           },
           {
             slug: "gds",
             web_url: "https://www.gov.uk/government/organisations/gds",
             title: "Government Digital Service",
             acronym: "GDS",
-            govuk_status: "live"
-          }
+            govuk_status: "live",
+          },
         ]
 
         stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/organisations").
@@ -119,7 +119,7 @@ module GdsApi
           web_url: "https://www.gov.uk/government/organisations/#{slug}",
           title: "Cabinet Office",
           acronym: "CO",
-          govuk_status: "live"
+          govuk_status: "live",
         }
 
         stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/organisations/#{slug}").
@@ -143,7 +143,7 @@ module GdsApi
       def stub_support_api_feedback_export_request(id, response_body = nil)
         response_body ||= {
           filename: "feedex_0000-00-00_2015-01-01.csv",
-          ready: true
+          ready: true,
         }
 
         stub_http_request(:get, "#{SUPPORT_API_ENDPOINT}/anonymous-feedback/export-requests/#{id}").

data/lib/gds_api/test_helpers/worldwide.rb

@@ -1,12 +1,12 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'gds_api/test_helpers/common_responses'
+require "gds_api/test_helpers/json_client_helper"
+require "gds_api/test_helpers/common_responses"
 
 module GdsApi
   module TestHelpers
     module Worldwide
       include GdsApi::TestHelpers::CommonResponses
 
-      WORLDWIDE_API_ENDPOINT = Plek.current.find('whitehall-admin')
+      WORLDWIDE_API_ENDPOINT = Plek.current.find("whitehall-admin")
 
       # Sets up the index endpoints for the given country slugs
       # The stubs are setup to paginate in chunks of 20
@@ -43,7 +43,7 @@ module GdsApi
 
           if i.zero?
             # First page exists at URL with and without page param
-            stub_request(:get, links[:self].sub(/\?page=1/, '')).
+            stub_request(:get, links[:self].sub(/\?page=1/, "")).
               to_return(status: 200, body: page_details.to_json, headers: { "Link" => link_headers.join(", ") })
           end
         end
@@ -105,9 +105,9 @@ module GdsApi
           },
           "organisations" => {
             "id" => "https://www.gov.uk/api/world-locations/#{slug}/organisations",
-            "web_url" => "https://www.gov.uk/government/world/#{slug}#organisations"
+            "web_url" => "https://www.gov.uk/government/world/#{slug}#organisations",
           },
-          "content_id" => "content_id_for_#{slug}"
+          "content_id" => "content_id_for_#{slug}",
         }
       end