gds-api-adapters 60.1.0 → 61.0.0

data/lib/gds_api/local_links_manager.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::LocalLinksManager < GdsApi::Base
   def local_link(authority_slug, lgsl, lgil)

data/lib/gds_api/mapit.rb

@@ -1,5 +1,5 @@
-require_relative 'base'
-require_relative 'exceptions'
+require_relative "base"
+require_relative "exceptions"
 
 class GdsApi::Mapit < GdsApi::Base
   def location_for_postcode(postcode)
@@ -23,19 +23,19 @@ class GdsApi::Mapit < GdsApi::Base
     end
 
     def lat
-      @response['wgs84_lat']
+      @response["wgs84_lat"]
     end
 
     def lon
-      @response['wgs84_lon']
+      @response["wgs84_lon"]
     end
 
     def areas
-      @response['areas'].map { |_i, area| OpenStruct.new(area) }
+      @response["areas"].map { |_i, area| OpenStruct.new(area) }
     end
 
     def postcode
-      @response['postcode']
+      @response["postcode"]
     end
   end
 

data/lib/gds_api/middleware/govuk_header_sniffer.rb

@@ -1,4 +1,4 @@
-require_relative '../govuk_headers'
+require_relative "../govuk_headers"
 
 module GdsApi
   class GovukHeaderSniffer

data/lib/gds_api/organisations.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::Organisations < GdsApi::Base
   def organisations

data/lib/gds_api/performance_platform/data_in.rb

@@ -1,4 +1,4 @@
-require_relative '../base'
+require_relative "../base"
 
 module GdsApi
   class PerformancePlatformDatasetNotConfigured < BaseError; end

data/lib/gds_api/performance_platform/data_out.rb

@@ -1,4 +1,4 @@
-require_relative '../base'
+require_relative "../base"
 
 module GdsApi
   module PerformancePlatform
@@ -71,9 +71,9 @@ module GdsApi
       def search_terms(slug)
         options = {
             slug: slug,
-            transaction: 'search-terms',
-            group_by: 'searchKeyword',
-            collect: 'searchUniques:sum'
+            transaction: "search-terms",
+            group_by: "searchKeyword",
+            collect: "searchUniques:sum",
         }
         statistics(options)
       end
@@ -81,9 +81,9 @@ module GdsApi
       def searches(slug, is_multipart)
         options = {
             slug: slug,
-            transaction: 'search-terms',
-            group_by: 'pagePath',
-            collect: 'searchUniques:sum'
+            transaction: "search-terms",
+            group_by: "pagePath",
+            collect: "searchUniques:sum",
         }
         statistics(options, is_multipart)
       end
@@ -91,9 +91,9 @@ module GdsApi
       def page_views(slug, is_multipart)
         options = {
             slug: slug,
-            transaction: 'page-statistics',
-            group_by: 'pagePath',
-            collect: 'uniquePageviews:sum'
+            transaction: "page-statistics",
+            group_by: "pagePath",
+            collect: "uniquePageviews:sum",
         }
         statistics(options, is_multipart)
       end
@@ -101,9 +101,9 @@ module GdsApi
       def problem_reports(slug, is_multipart)
         options = {
             slug: slug,
-            transaction: 'page-contacts',
-            group_by: 'pagePath',
-            collect: 'total:sum'
+            transaction: "page-contacts",
+            group_by: "pagePath",
+            collect: "total:sum",
         }
         statistics(options, is_multipart)
       end
@@ -118,7 +118,7 @@ module GdsApi
             collect: options[:collect],
             duration: 42,
             period: "day",
-            end_at: Date.today.to_time.getutc.iso8601
+            end_at: Date.today.to_time.getutc.iso8601,
         }
 
         filter_param = is_multipart ? :filter_by_prefix : :filter_by

data/lib/gds_api/publishing_api.rb

@@ -1,5 +1,5 @@
-require_relative 'base'
-require_relative 'exceptions'
+require_relative "base"
+require_relative "exceptions"
 
 class GdsApi::PublishingApi < GdsApi::Base
   # Create a publishing intent for a base_path.

data/lib/gds_api/publishing_api/special_route_publisher.rb

@@ -25,12 +25,12 @@ module GdsApi
             {
               path: options.fetch(:base_path),
               type: options.fetch(:type),
-            }
+            },
           ],
           publishing_app: options.fetch(:publishing_app),
           rendering_app: options.fetch(:rendering_app),
           public_updated_at: time.now.iso8601,
-          update_type: options.fetch(:update_type, "major")
+          update_type: options.fetch(:update_type, "major"),
         )
 
         publishing_api.patch_links(options.fetch(:content_id), links: options[:links]) if options[:links]

data/lib/gds_api/publishing_api_v2.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 # Adapter for the Publishing API.
 #
@@ -96,7 +96,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_idpublish
   def publish(content_id, update_type = nil, options = {})
     params = {
-      update_type: update_type
+      update_type: update_type,
     }
 
     optional_keys = %i[locale previous_version]
@@ -159,7 +159,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#post-v2contentcontent_idunpublish
   def unpublish(content_id, type:, explanation: nil, alternative_path: nil, discard_drafts: false, allow_draft: false, previous_version: nil, locale: nil, unpublished_at: nil, redirects: nil)
     params = {
-      type: type
+      type: type,
     }
 
     params[:explanation] = explanation if explanation
@@ -295,7 +295,7 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
   # @see https://github.com/alphagov/publishing-api/blob/master/doc/api.md#patch-v2linkscontent_id
   def patch_links(content_id, params)
     payload = {
-      links: params.fetch(:links)
+      links: params.fetch(:links),
     }
 
     payload = merge_optional_keys(payload, params, %i[previous_version bulk_publishing])
@@ -341,11 +341,11 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
       (1..Float::INFINITY).each do |index|
         merged_params = params.merge(page: index)
         page = get_content_items(merged_params).to_h
-        results = page.fetch('results', [])
+        results = page.fetch("results", [])
         results.each do |result|
           yielder << result
         end
-        break if page.fetch('pages') <= index
+        break if page.fetch("pages") <= index
       end
     end
   end
@@ -397,8 +397,8 @@ class GdsApi::PublishingApiV2 < GdsApi::Base
         yielder.yield begin
           response = get_json(next_link)
         end
-        next_link_info = response['links'].select { |link| link['rel'] == 'next' }.first
-        next_link = next_link_info && next_link_info['href']
+        next_link_info = response["links"].select { |link| link["rel"] == "next" }.first
+        next_link = next_link_info && next_link_info["href"]
       end
     end
   end

data/lib/gds_api/railtie.rb

@@ -1,30 +1,30 @@
-require_relative 'middleware/govuk_header_sniffer'
+require_relative "middleware/govuk_header_sniffer"
 
 module GdsApi
   class Railtie < Rails::Railtie
     initializer "gds_api.initialize_govuk_request_id_sniffer" do |app|
       Rails.logger.debug "Using middleware GdsApi::GovukHeaderSniffer to sniff for Govuk-Request-Id header"
-      app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_REQUEST_ID'
+      app.middleware.use GdsApi::GovukHeaderSniffer, "HTTP_GOVUK_REQUEST_ID"
     end
 
     initializer "gds_api.initialize_govuk_original_url_sniffer" do |app|
       Rails.logger.debug "Using middleware GdsApi::GovukHeaderSniffer to sniff for Govuk-Original-Url header"
-      app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_ORIGINAL_URL'
+      app.middleware.use GdsApi::GovukHeaderSniffer, "HTTP_GOVUK_ORIGINAL_URL"
     end
 
     initializer "gds_api.initialize_govuk_authenticated_user_sniffer" do |app|
       Rails.logger.debug "Using middleware GdsApi::GovukHeaderSniffer to sniff for X-Govuk-Authenticated-User header"
-      app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_X_GOVUK_AUTHENTICATED_USER'
+      app.middleware.use GdsApi::GovukHeaderSniffer, "HTTP_X_GOVUK_AUTHENTICATED_USER"
     end
 
     initializer "gds_api.initialize_govuk_authenticated_user_organisation_sniffer" do |app|
       Rails.logger.debug "Using middleware GdsApi::GovukHeaderSniffer to sniff for X-Govuk-Authenticated-User-Organisation header"
-      app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_X_GOVUK_AUTHENTICATED_USER_ORGANISATION'
+      app.middleware.use GdsApi::GovukHeaderSniffer, "HTTP_X_GOVUK_AUTHENTICATED_USER_ORGANISATION"
     end
 
     initializer "gds_api.initialize_govuk_content_id_sniffer" do |app|
       Rails.logger.debug "Using middleware GdsApi::GovukHeaderSniffer to sniff for Govuk-Auth-Bypass-Id header"
-      app.middleware.use GdsApi::GovukHeaderSniffer, 'HTTP_GOVUK_AUTH_BYPASS_ID'
+      app.middleware.use GdsApi::GovukHeaderSniffer, "HTTP_GOVUK_AUTH_BYPASS_ID"
     end
   end
 end

data/lib/gds_api/response.rb

@@ -1,6 +1,6 @@
-require 'json'
-require 'forwardable'
-require 'rack/cache'
+require "json"
+require "forwardable"
+require "rack/cache"
 
 module GdsApi
   # This wraps an HTTP response with a JSON body.
@@ -87,7 +87,7 @@ module GdsApi
       when Hash
         Hash[value.map { |k, v|
           # NOTE: Don't bother transforming if the value is nil
-          if k == 'web_url' && v
+          if k == "web_url" && v
             # Use relative URLs to route when the web_url value is on the
             # same domain as the site root. Note that we can't just use the
             # `route_to` method, as this would give us technically correct

data/lib/gds_api/router.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::Router < GdsApi::Base
   ### Backends
@@ -36,8 +36,8 @@ class GdsApi::Router < GdsApi::Base
         handler: "redirect",
         redirect_to: destination,
         redirect_type: redirect_type,
-        segments_mode: options[:segments_mode]
-      }
+        segments_mode: options[:segments_mode],
+      },
     )
 
     commit_routes if options[:commit]

data/lib/gds_api/rummager.rb

@@ -1,4 +1,4 @@
-require 'gds_api/search'
+require "gds_api/search"
 
 module GdsApi
   class Rummager < Search

data/lib/gds_api/search.rb

@@ -1,5 +1,5 @@
-require 'gds_api/base'
-require 'rack/utils'
+require "gds_api/base"
+require "rack/utils"
 
 module GdsApi
   # @api documented
@@ -12,7 +12,7 @@ module GdsApi
           document.merge(
             _type: type,
             _id: id,
-          )
+          ),
         )
       end
 
@@ -30,27 +30,27 @@ module GdsApi
       class InvalidIndex < StandardError; end
 
       def add_document(id, document, index_name)
-        raise(InvalidIndex, index_name) unless index_name == 'metasearch'
+        raise(InvalidIndex, index_name) unless index_name == "metasearch"
 
         post_json(
           "#{base_url}/v2/metasearch/documents",
           document.merge(
             _id: id,
-          )
+          ),
         )
       end
 
       def delete_document(id, index_name)
-        raise(InvalidIndex, index_name) unless index_name == 'metasearch'
+        raise(InvalidIndex, index_name) unless index_name == "metasearch"
 
         delete_json("#{base_url}/v2/metasearch/documents/#{id}")
       end
     end
 
-    DEFAULT_API_VERSION = 'V1'.freeze
+    DEFAULT_API_VERSION = "V1".freeze
     API_VERSIONS = {
-      'V1' => GdsApi::Search::V1,
-      'V2' => GdsApi::Search::V2,
+      "V1" => GdsApi::Search::V1,
+      "V2" => GdsApi::Search::V2,
     }.freeze
     class UnknownAPIVersion < StandardError; end
 
@@ -100,7 +100,7 @@ module GdsApi
       Enumerator.new do |yielder|
         (0..Float::INFINITY).step(page_size).each do |index|
           search_params = args.merge(start: index.to_i, count: page_size)
-          results = search(search_params, additional_headers).to_h.fetch('results', [])
+          results = search(search_params, additional_headers).to_h.fetch("results", [])
           results.each do |result|
             yielder << result
           end
@@ -111,16 +111,6 @@ module GdsApi
       end
     end
 
-    # Advanced search.
-    #
-    # @deprecated Only in use by Whitehall. Use the `#search` method.
-    def advanced_search(args)
-      raise ArgumentError.new("Args cannot be blank") if args.nil? || args.empty?
-
-      request_path = "#{base_url}/advanced_search?#{Rack::Utils.build_nested_query(args)}"
-      get_json(request_path)
-    end
-
     # Add a document to the search index.
     #
     # @param type [String] The search-api document type.

data/lib/gds_api/support.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::Support < GdsApi::Base
   def create_foi_request(request_details)

data/lib/gds_api/support_api.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 # @api documented
 class GdsApi::SupportApi < GdsApi::Base

data/lib/gds_api/test_helpers/asset_manager.rb

@@ -1,7 +1,7 @@
 module GdsApi
   module TestHelpers
     module AssetManager
-      ASSET_MANAGER_ENDPOINT = Plek.current.find('asset-manager')
+      ASSET_MANAGER_ENDPOINT = Plek.current.find("asset-manager")
 
       def stub_any_asset_manager_call
         stub_request(:any, %r{\A#{ASSET_MANAGER_ENDPOINT}}).to_return(status: 200)
@@ -37,7 +37,7 @@ module GdsApi
 
       def stub_asset_manager_does_not_have_an_asset(id)
         response = {
-          "_response_info" => { "status" => "not found" }
+          "_response_info" => { "status" => "not found" },
         }
 
         stub_request(:any, "#{ASSET_MANAGER_ENDPOINT}/assets/#{id}")
@@ -46,7 +46,7 @@ module GdsApi
 
       def stub_asset_manager_does_not_have_a_whitehall_asset(legacy_url_path)
         response = {
-          "_response_info" => { "status" => "not found" }
+          "_response_info" => { "status" => "not found" },
         }
 
         stub_request(:get, "#{ASSET_MANAGER_ENDPOINT}/whitehall_assets/#{legacy_url_path}")
@@ -73,7 +73,7 @@ module GdsApi
           else
             options = {
               id: SecureRandom.uuid,
-              filename: SecureRandom.hex(8)
+              filename: SecureRandom.hex(8),
             }.merge(response_url)
 
             file_url = "#{ASSET_MANAGER_ENDPOINT}/media/#{options[:id]}/#{options[:filename]}"

data/lib/gds_api/test_helpers/calendars.rb

@@ -4,7 +4,7 @@ module GdsApi
       def stub_calendars_endpoint(in_division: nil)
         endpoint = "#{Plek.new.website_root}/bank-holidays"
         endpoint += "/#{in_division}" unless in_division.nil?
-        endpoint + '.json'
+        endpoint + ".json"
       end
 
       def stub_calendars_has_no_bank_holidays(in_division: nil)
@@ -17,30 +17,30 @@ module GdsApi
             title: "Caturday #{idx}!",
             date: date.to_date.iso8601,
             notes: "Y'know, for cats!",
-            bunting: true
+            bunting: true,
           }
         end
 
         response =
           if in_division.nil?
             {
-              'england-and-wales' => {
-                division: 'england-and-wales',
-                events: events
+              "england-and-wales" => {
+                division: "england-and-wales",
+                events: events,
               },
-              'scotland' => {
-                division: 'scotland',
-                events: events
+              "scotland" => {
+                division: "scotland",
+                events: events,
+              },
+              "northern-ireland" => {
+                division: "northern-ireland",
+                events: events,
               },
-              'northern-ireland' => {
-                division: 'northern-ireland',
-                events: events
-              }
             }
           else
             {
               division: in_division,
-              events: events
+              events: events,
             }
           end