gds-api-adapters 60.1.0 → 61.0.0

data/lib/gds_api/test_helpers/common_responses.rb

@@ -19,8 +19,8 @@ module GdsApi
       def response_base
         {
           "_response_info" => {
-            "status" => "ok"
-          }
+            "status" => "ok",
+          },
         }
       end
       alias_method :singular_response_base, :response_base
@@ -33,7 +33,7 @@ module GdsApi
           "page_size" => 100,
           "current_page" => 1,
           "pages" => 1,
-          "results" => []
+          "results" => [],
         )
       end
     end

data/lib/gds_api/test_helpers/content_item_helpers.rb

@@ -12,7 +12,7 @@ module GdsApi
           # "base_path" => base_path,
           "details" => {
             "body" => "Some content for #{base_path}",
-          }
+          },
         }
       end
 
@@ -25,7 +25,7 @@ module GdsApi
           "public_updated_at" => nil,
           "base_path" => base_path,
           "withdrawn_notice" => {},
-          "details" => {}
+          "details" => {},
         }
       end
 

data/lib/gds_api/test_helpers/content_store.rb

@@ -1,6 +1,6 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'gds_api/test_helpers/content_item_helpers'
-require 'json'
+require "gds_api/test_helpers/json_client_helper"
+require "gds_api/test_helpers/content_item_helpers"
+require "json"
 
 module GdsApi
   module TestHelpers
@@ -15,7 +15,7 @@ module GdsApi
       #             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')
+        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 = {})
@@ -29,8 +29,8 @@ module GdsApi
           body: body,
           headers: {
             cache_control: "#{visibility}, max-age=#{max_age}",
-            date: Time.now.httpdate
-          }
+            date: Time.now.httpdate,
+          },
         )
       end
 
@@ -73,7 +73,7 @@ module GdsApi
         stub_request(:get, url).to_return(
           status: 410,
           body: body,
-          headers: {}
+          headers: {},
         )
       end
 

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -1,5 +1,5 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'json'
+require "gds_api/test_helpers/json_client_helper"
+require "json"
 
 module GdsApi
   module TestHelpers
@@ -214,21 +214,21 @@ module GdsApi
       def stub_email_alert_api_creates_a_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json
+            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
         ).to_return(status: 201, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
       def stub_email_alert_api_creates_an_existing_subscription(subscriber_list_id, address, frequency, returned_subscription_id)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json
+            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
         ).to_return(status: 200, body: { subscription_id: returned_subscription_id }.to_json)
       end
 
       def stub_email_alert_api_refuses_to_create_subscription(subscriber_list_id, address, frequency)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriptions")
           .with(
-            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json
+            body: { subscriber_list_id: subscriber_list_id, address: address, frequency: frequency }.to_json,
         ).to_return(status: 422)
       end
 
@@ -236,7 +236,7 @@ module GdsApi
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
           .to_return(
             status: 201,
-            body: get_subscriber_response(subscriber_id, address).to_json
+            body: get_subscriber_response(subscriber_id, address).to_json,
           )
       end
 
@@ -249,7 +249,7 @@ module GdsApi
           JSON.parse(req.body).symbolize_keys == {
             subscriber_list_id: subscriber_list_id,
             address: address,
-            frequency: frequency
+            frequency: frequency,
           }
         end
       end
@@ -259,8 +259,8 @@ module GdsApi
           .to_return(
             status: 200,
             body: {
-              subscriber_list: returned_attributes
-            }.to_json
+              subscriber_list: returned_attributes,
+            }.to_json,
         )
       end
 
@@ -300,8 +300,8 @@ module GdsApi
         {
           "subscriber" => {
             "id" => id,
-            "address" => address
-          }
+            "address" => address,
+          },
         }
       end
 
@@ -328,8 +328,8 @@ module GdsApi
               "id" => subscriber_list_id,
               "slug" => "some-thing",
               "title" => title,
-            }
-          }
+            },
+          },
         }
       end
 
@@ -337,7 +337,7 @@ module GdsApi
         {
           "subscriber" => {
             "id" => id,
-            "address" => address
+            "address" => address,
           },
           "subscriptions" => [
             {
@@ -347,10 +347,10 @@ module GdsApi
               "id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
               "subscriber_list" => {
                 "id" => 1000,
-                "slug" => "some-thing"
-              }
-            }
-          ]
+                "slug" => "some-thing",
+              },
+            },
+          ],
         }
       end
 
@@ -360,7 +360,7 @@ module GdsApi
             "id" => "447135c3-07d6-4c3a-8a3b-efa49ef70e52",
             "title" => "Some title",
             "active_subscriptions_count" => 42,
-          }.merge(attributes)
+          }.merge(attributes),
         }
       end
 

data/lib/gds_api/test_helpers/imminence.rb

@@ -1,15 +1,15 @@
-require 'gds_api/test_helpers/json_client_helper'
+require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module Imminence
       # 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')
+      IMMINENCE_API_ENDPOINT = Plek.current.find("imminence")
 
       def stub_imminence_has_places(latitude, longitude, details)
         query_hash = { "lat" => latitude, "lng" => longitude, "limit" => "5" }
-        stub_imminence_places_request(details['slug'], query_hash, details['details'])
+        stub_imminence_places_request(details["slug"], query_hash, details["details"])
       end
 
       def stub_imminence_has_areas_for_postcode(postcode, areas)

data/lib/gds_api/test_helpers/json_client_helper.rb

@@ -1 +1 @@
-require 'gds_api/json_client'
+require "gds_api/json_client"

data/lib/gds_api/test_helpers/licence_application.rb

@@ -1,4 +1,4 @@
-require 'gds_api/test_helpers/json_client_helper'
+require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers

data/lib/gds_api/test_helpers/link_checker_api.rb

@@ -39,7 +39,7 @@ module GdsApi
 
       def stub_link_checker_api_get_batch(id:, status: :completed, links: [], totals: {}, completed_at: nil)
         body = stub_link_checker_api_batch_report_hash(
-          id: id, status: status, links: links, totals: totals, completed_at: completed_at
+          id: id, status: status, links: links, totals: totals, completed_at: completed_at,
         ).to_json
 
         stub_request(:get, "#{LINK_CHECKER_API_ENDPOINT}/batch/#{id}")
@@ -54,7 +54,7 @@ module GdsApi
           status: status,
           links: links,
           totals: totals,
-          completed_at: completed_at
+          completed_at: completed_at,
         ).to_json
 
         request_body = {
@@ -69,7 +69,7 @@ module GdsApi
           .to_return(
             body: response_body,
             status: status == :in_progress ? 202 : 201,
-            headers: { "Content-Type" => "application/json" }
+            headers: { "Content-Type" => "application/json" },
           )
       end
 
@@ -79,14 +79,14 @@ module GdsApi
         request_body = {
           links: links,
           app: app,
-          reference: reference
+          reference: reference,
         }.to_json
 
         stub_request(:post, "#{LINK_CHECKER_API_ENDPOINT}/monitor")
           .with(body: request_body)
           .to_return(
             body: response_body,
-            headers: { "Content-Type" => "application/json" }
+            headers: { "Content-Type" => "application/json" },
           )
       end
 

data/lib/gds_api/test_helpers/local_links_manager.rb

@@ -1,9 +1,9 @@
-require 'gds_api/test_helpers/json_client_helper'
+require "gds_api/test_helpers/json_client_helper"
 
 module GdsApi
   module TestHelpers
     module LocalLinksManager
-      LOCAL_LINKS_MANAGER_ENDPOINT = Plek.current.find('local-links-manager')
+      LOCAL_LINKS_MANAGER_ENDPOINT = Plek.current.find("local-links-manager")
 
       def stub_local_links_manager_has_a_link(authority_slug:, lgsl:, lgil:, url:)
         response = {
@@ -17,7 +17,7 @@ module GdsApi
             "lgsl_code" => lgsl,
             "lgil_code" => lgil,
             "url" => url,
-          }
+          },
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/link")
@@ -82,9 +82,9 @@ module GdsApi
             {
               "name" => authority_slug.capitalize,
               "homepage_url" => "http://#{authority_slug}.example.com",
-              "tier" => "unitary"
-            }
-          ]
+              "tier" => "unitary",
+            },
+          ],
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
@@ -98,14 +98,14 @@ module GdsApi
             {
               "name" => district_slug.capitalize,
               "homepage_url" => "http://#{district_slug}.example.com",
-              "tier" => "district"
+              "tier" => "district",
             },
             {
               "name" => county_slug.capitalize,
               "homepage_url" => "http://#{county_slug}.example.com",
-              "tier" => "county"
-            }
-          ]
+              "tier" => "county",
+            },
+          ],
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")
@@ -115,7 +115,7 @@ 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: '' })
+        .with(query: { authority_slug: "" })
         .to_return(body: {}.to_json, status: 400)
       end
 
@@ -131,9 +131,9 @@ module GdsApi
             {
               "name" => authority_slug.capitalize,
               "homepage_url" => "",
-              "tier" => "unitary"
-            }
-          ]
+              "tier" => "unitary",
+            },
+          ],
         }
 
         stub_request(:get, "#{LOCAL_LINKS_MANAGER_ENDPOINT}/api/local-authority")

data/lib/gds_api/test_helpers/mapit.rb

@@ -1,18 +1,18 @@
 module GdsApi
   module TestHelpers
     module Mapit
-      MAPIT_ENDPOINT = Plek.current.find('mapit')
+      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")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
           .to_return(body: response.to_json, status: 200)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(' ').first + ".json")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(" ").first + ".json")
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -20,35 +20,35 @@ 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']
+            "codes" => {
+              "ons" => area["ons"],
+              "gss" => area["gss"],
+              "govuk_slug" => area["govuk_slug"],
             },
-            'name' => area['name'],
-            'type' => area['type'],
-            'country_name' => area['country_name']
+            "name" => area["name"],
+            "type" => area["type"],
+            "country_name" => area["country_name"],
           }]
         }]
 
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
-          .to_return(body: response.merge('areas' => area_response).to_json, status: 200)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(' ').first + ".json")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
+          .to_return(body: response.merge("areas" => area_response).to_json, status: 200)
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/" + postcode.split(" ").first + ".json")
           .to_return(body: response.to_json, status: 200)
       end
 
       def stub_mapit_does_not_have_a_postcode(postcode)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
           .to_return(body: { "code" => 404, "error" => "No Postcode matches the given query." }.to_json, status: 404)
       end
 
       def stub_mapit_does_not_have_a_bad_postcode(postcode)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(' ', '+') + ".json")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".json")
           .to_return(body: { "code" => 400, "error" => "Postcode '#{postcode}' is not valid." }.to_json, status: 400)
       end
 

data/lib/gds_api/test_helpers/organisations.rb

@@ -1,7 +1,7 @@
-require 'gds_api/test_helpers/json_client_helper'
-require 'gds_api/test_helpers/common_responses'
-require 'plek'
-require 'securerandom'
+require "gds_api/test_helpers/json_client_helper"
+require "gds_api/test_helpers/common_responses"
+require "plek"
+require "securerandom"
 
 module GdsApi
   module TestHelpers
@@ -55,7 +55,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
@@ -104,13 +104,13 @@ module GdsApi
           "parent_organisations" => [
             {
               "id" => "#{WEBSITE_ROOT}/api/organisations/#{slug}-parent-1",
-              "web_url" => "#{WEBSITE_ROOT}/government/organisations/#{slug}-parent-1"
+              "web_url" => "#{WEBSITE_ROOT}/government/organisations/#{slug}-parent-1",
             },
           ],
           "child_organisations" => [
             {
               "id" => "#{WEBSITE_ROOT}/api/organisations/#{slug}-child-1",
-              "web_url" => "#{WEBSITE_ROOT}/government/organisations/#{slug}-child-1"
+              "web_url" => "#{WEBSITE_ROOT}/government/organisations/#{slug}-child-1",
             },
           ],
         }

data/lib/gds_api/test_helpers/performance_platform/data_out.rb

@@ -21,9 +21,9 @@ module GdsApi
         def stub_search_terms(slug, response_body = {})
           options = {
               slug: slug,
-              transaction: 'search-terms',
-              group_by: 'searchKeyword',
-              collect: 'searchUniques:sum'
+              transaction: "search-terms",
+              group_by: "searchKeyword",
+              collect: "searchUniques:sum",
           }
           stub_statistics(options, false, response_body)
         end
@@ -31,9 +31,9 @@ module GdsApi
         def stub_searches(slug, is_multipart, response_body = {})
           options = {
               slug: slug,
-              transaction: 'search-terms',
-              group_by: 'pagePath',
-              collect: 'searchUniques:sum'
+              transaction: "search-terms",
+              group_by: "pagePath",
+              collect: "searchUniques:sum",
           }
           stub_statistics(options, is_multipart, response_body)
         end
@@ -41,9 +41,9 @@ module GdsApi
         def stub_page_views(slug, is_multipart, response_body = {})
           options = {
               slug: slug,
-              transaction: 'page-statistics',
-              group_by: 'pagePath',
-              collect: 'uniquePageviews:sum'
+              transaction: "page-statistics",
+              group_by: "pagePath",
+              collect: "uniquePageviews:sum",
           }
           stub_statistics(options, is_multipart, response_body)
         end
@@ -51,9 +51,9 @@ module GdsApi
         def stub_problem_reports(slug, is_multipart, response_body = {})
           options = {
               slug: slug,
-              transaction: 'page-contacts',
-              group_by: 'pagePath',
-              collect: 'total:sum'
+              transaction: "page-contacts",
+              group_by: "pagePath",
+              collect: "total:sum",
           }
           stub_statistics(options, is_multipart, response_body)
         end
@@ -64,7 +64,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