gds-api-adapters 60.1.0 → 61.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f6e86134fcd469124f73b675186a67d2c0fc7a231579e9c9ce5f0d5de21fb5d
-  data.tar.gz: a5d21c8c4872e3ad3e2d6db819373297e754cdbc6f223e0c05b49ab122fc7cf4
+  metadata.gz: 03633d3f73a43534c9a5bf7f4dd962440da1e00413b8cb68eb26ccabf9a852fd
+  data.tar.gz: 601382725376e9209d8e03898edffdf5d1cafe3e1afd7a7c42609c6a480d08fd
 SHA512:
-  metadata.gz: 0ca67d3c42622f1ebdbf593308bed09e15b1f0cf5ccdd4d8578ad0a41d1cb988a9768e5d66c89a46c6456edeb57ca0dc53363031d366636cc8a8033971b8941d
-  data.tar.gz: 231dc67bf3244e8b3ebdaffea3e7460a57b8b8fa2fe17c69886a6b04f7cade3399c2d5b60bd296995b91d8a5debcb1897f1a53ce9ffdd18bfcfc516bc3f80337
+  metadata.gz: ce83aa7cc12f0fa50c45e082c1085dfb125eb20cc0060f7e4b3412c7f016d776aed2bb499def860d4d34d955bca43528c96d0a4fbd56017d92647c61577a6415
+  data.tar.gz: 33690cb1426e6d63b5faa7f52b3521f80d046a1cc72a0c308ae8054e4b32f691c607770366ae4586042bf7aa808dc7cb91b2e8c8e5f5ad9bd0b8a43e92d1a751

data/Rakefile

@@ -29,12 +29,6 @@ PactBroker::Client::PublicationTask.new("branch") do |task|
   configure_pact_broker_location(task)
 end
 
-PactBroker::Client::PublicationTask.new("released_version") do |task|
-  require 'gds_api/version'
-  task.consumer_version = GdsApi::VERSION
-  configure_pact_broker_location(task)
-end
-
 desc "Run the linter against changed files"
 task :lint do
   sh "bundle exec govuk-lint-ruby --format clang lib test"

data/lib/gds-api-adapters.rb

@@ -1,3 +1,3 @@
-require 'gds_api/railtie' if defined?(Rails)
-require 'gds_api/exceptions'
-require 'gds_api'
+require "gds_api/railtie" if defined?(Rails)
+require "gds_api/exceptions"
+require "gds_api"

data/lib/gds_api.rb

@@ -1,23 +1,23 @@
-require 'plek'
-require 'gds_api/asset_manager'
-require 'gds_api/calendars'
-require 'gds_api/content_store'
-require 'gds_api/email_alert_api'
-require 'gds_api/imminence'
-require 'gds_api/licence_application'
-require 'gds_api/link_checker_api'
-require 'gds_api/local_links_manager'
-require 'gds_api/mapit'
-require 'gds_api/maslow'
-require 'gds_api/organisations'
-require 'gds_api/publishing_api'
-require 'gds_api/publishing_api_v2'
-require 'gds_api/router'
-require 'gds_api/rummager'
-require 'gds_api/search'
-require 'gds_api/support'
-require 'gds_api/support_api'
-require 'gds_api/worldwide'
+require "plek"
+require "gds_api/asset_manager"
+require "gds_api/calendars"
+require "gds_api/content_store"
+require "gds_api/email_alert_api"
+require "gds_api/imminence"
+require "gds_api/licence_application"
+require "gds_api/link_checker_api"
+require "gds_api/local_links_manager"
+require "gds_api/mapit"
+require "gds_api/maslow"
+require "gds_api/organisations"
+require "gds_api/publishing_api"
+require "gds_api/publishing_api_v2"
+require "gds_api/router"
+require "gds_api/rummager"
+require "gds_api/search"
+require "gds_api/support"
+require "gds_api/support_api"
+require "gds_api/worldwide"
 
 # @api documented
 module GdsApi
@@ -29,8 +29,8 @@ module GdsApi
   # @return [GdsApi::AssetManager]
   def self.asset_manager(options = {})
     GdsApi::AssetManager.new(
-      Plek.find('asset-manager'),
-      { bearer_token: ENV['ASSET_MANAGER_BEARER_TOKEN'] }.merge(options)
+      Plek.find("asset-manager"),
+      { bearer_token: ENV["ASSET_MANAGER_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -49,8 +49,8 @@ module GdsApi
   # @return [GdsApi::ContentStore]
   def self.content_store(options = {})
     GdsApi::ContentStore.new(
-      Plek.find('content-store'),
-      { bearer_token: ENV['CONTENT_STORE_BEARER_TOKEN'] }.merge(options),
+      Plek.find("content-store"),
+      { bearer_token: ENV["CONTENT_STORE_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -62,8 +62,8 @@ module GdsApi
   # @return [GdsApi::EmailAlertApi]
   def self.email_alert_api(options = {})
     GdsApi::EmailAlertApi.new(
-      Plek.find('email-alert-api'),
-      { bearer_token: ENV['EMAIL_ALERT_API_BEARER_TOKEN'] }.merge(options)
+      Plek.find("email-alert-api"),
+      { bearer_token: ENV["EMAIL_ALERT_API_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -71,14 +71,14 @@ module GdsApi
   #
   # @return [GdsApi::Imminence]
   def self.imminence(options = {})
-    GdsApi::Imminence.new(Plek.find('imminence'), options)
+    GdsApi::Imminence.new(Plek.find("imminence"), options)
   end
 
   # Creates a GdsApi::LicenceApplication
   #
   # @return [GdsApi::LicenceApplication]
   def self.licence_application(options = {})
-    GdsApi::LicenceApplication.new(Plek.find('licensify'), options)
+    GdsApi::LicenceApplication.new(Plek.find("licensify"), options)
   end
 
   # Creates a GdsApi::LinkCheckerApi adapter
@@ -89,8 +89,8 @@ module GdsApi
   # @return [GdsApi::LinkCheckerApi]
   def self.link_checker_api(options = {})
     GdsApi::LinkCheckerApi.new(
-      Plek.find('link-checker-api'),
-      { bearer_token: ENV['LINK_CHECKER_API_BEARER_TOKEN'] }.merge(options)
+      Plek.find("link-checker-api"),
+      { bearer_token: ENV["LINK_CHECKER_API_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -98,14 +98,14 @@ module GdsApi
   #
   # @return [GdsApi::LocalLinksManager]
   def self.local_links_manager(options = {})
-    GdsApi::LocalLinksManager.new(Plek.find('local-links-manager'), options)
+    GdsApi::LocalLinksManager.new(Plek.find("local-links-manager"), options)
   end
 
   # Creates a GdsApi::Mapit adapter
   #
   # @return [GdsApi::Mapit]
   def self.mapit(options = {})
-    GdsApi::Mapit.new(Plek.find('mapit'), options)
+    GdsApi::Mapit.new(Plek.find("mapit"), options)
   end
 
   # Creates a GdsApi::Maslow adapter
@@ -115,7 +115,7 @@ module GdsApi
   #
   # @return [GdsApi::Maslow]
   def self.maslow(options = {})
-    GdsApi::Maslow.new(Plek.new.external_url_for('maslow'), options)
+    GdsApi::Maslow.new(Plek.new.external_url_for("maslow"), options)
   end
 
   # Creates a GdsApi::Organisations adapter for accessing Whitehall APIs on a
@@ -134,8 +134,8 @@ module GdsApi
   # @return [GdsApi::PublishingApi]
   def self.publishing_api(options = {})
     GdsApi::PublishingApi.new(
-      Plek.find('publishing-api'),
-      { bearer_token: ENV['PUBLISHING_API_BEARER_TOKEN'] }.merge(options)
+      Plek.find("publishing-api"),
+      { bearer_token: ENV["PUBLISHING_API_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -147,8 +147,8 @@ module GdsApi
   # @return [GdsApi::PublishingApiV2]
   def self.publishing_api_v2(options = {})
     GdsApi::PublishingApiV2.new(
-      Plek.find('publishing-api'),
-      { bearer_token: ENV['PUBLISHING_API_BEARER_TOKEN'] }.merge(options)
+      Plek.find("publishing-api"),
+      { bearer_token: ENV["PUBLISHING_API_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -160,8 +160,8 @@ module GdsApi
   # @return [GdsApi::Router]
   def self.router(options = {})
     GdsApi::Router.new(
-      Plek.find('router-api'),
-      { bearer_token: ENV['ROUTER_API_BEARER_TOKEN'] }.merge(options),
+      Plek.find("router-api"),
+      { bearer_token: ENV["ROUTER_API_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -169,21 +169,21 @@ module GdsApi
   #
   # @return [GdsApi::Rummager]
   def self.rummager(options = {})
-    GdsApi::Rummager.new(Plek.find('search'), options)
+    GdsApi::Rummager.new(Plek.find("search"), options)
   end
 
   # Creates a GdsApi::Search adapter to access via a search.* hostname
   #
   # @return [GdsApi::Search]
   def self.search(options = {})
-    GdsApi::Search.new(Plek.find('search'), options)
+    GdsApi::Search.new(Plek.find("search"), options)
   end
 
   # Creates a GdsApi::Support adapter
   #
   # @return [GdsApi::Support]
   def self.support(options = {})
-    GdsApi::Support.new(Plek.find('support'), options)
+    GdsApi::Support.new(Plek.find("support"), options)
   end
 
   # Creates a GdsApi::SupportApi adapter
@@ -194,8 +194,8 @@ module GdsApi
   # @return [GdsApi::SupportApi]
   def self.support_api(options = {})
     GdsApi::SupportApi.new(
-      Plek.find('support-api'),
-      { bearer_token: ENV['SUPPORT_API_BEARER_TOKEN'] }.merge(options),
+      Plek.find("support-api"),
+      { bearer_token: ENV["SUPPORT_API_BEARER_TOKEN"] }.merge(options),
     )
   end
 
@@ -204,6 +204,6 @@ module GdsApi
   #
   # @return [GdsApi::Worldwide]
   def self.worldwide(options = {})
-    GdsApi::Worldwide.new(Plek.find('whitehall-admin'), options)
+    GdsApi::Worldwide.new(Plek.find("whitehall-admin"), options)
   end
 end

data/lib/gds_api/asset_manager.rb

@@ -1,5 +1,5 @@
-require_relative 'base'
-require_relative 'exceptions'
+require_relative "base"
+require_relative "exceptions"
 
 # @api documented
 class GdsApi::AssetManager < GdsApi::Base

data/lib/gds_api/base.rb

@@ -1,8 +1,8 @@
-require_relative 'json_client'
-require 'cgi'
-require 'null_logger'
-require 'plek'
-require_relative 'list_response'
+require_relative "json_client"
+require "cgi"
+require "null_logger"
+require "plek"
+require_relative "list_response"
 
 class GdsApi::Base
   class InvalidAPIURL < StandardError

data/lib/gds_api/calendars.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::Calendars < GdsApi::Base
   def bank_holidays(division = nil)

data/lib/gds_api/content_store.rb

@@ -1,7 +1,7 @@
 require "plek"
 
-require_relative 'base'
-require_relative 'exceptions'
+require_relative "base"
+require_relative "exceptions"
 
 class GdsApi::ContentStore < GdsApi::Base
   class ItemNotFound < GdsApi::HTTPNotFound
@@ -44,7 +44,7 @@ private
       raise UnresolvedRedirect, "Could not find a matching redirect" unless redirect
 
       destination_uri = URI.parse(
-        resolve_destination(redirect, request_path, request_query)
+        resolve_destination(redirect, request_path, request_query),
       )
 
       url = if destination_uri.absolute?

data/lib/gds_api/email_alert_api.rb

@@ -1,5 +1,5 @@
-require_relative 'base'
-require_relative 'exceptions'
+require_relative "base"
+require_relative "exceptions"
 
 # Adapter for the Email Alert API
 #
@@ -203,7 +203,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   def change_subscriber(id:, new_address:)
     patch_json(
       "#{endpoint}/subscribers/#{id}",
-      new_address: new_address
+      new_address: new_address,
     )
   end
 
@@ -216,7 +216,7 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   def change_subscription(id:, frequency:)
     patch_json(
       "#{endpoint}/subscriptions/#{id}",
-      frequency: frequency
+      frequency: frequency,
     )
   end
 

data/lib/gds_api/imminence.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::Imminence < GdsApi::Base
   def api_url(type, params)
@@ -59,7 +59,7 @@ class GdsApi::Imminence < GdsApi::Base
   def self.extract_address_hash(place_hash)
     address_fields = [
       place_hash["address1"],
-      place_hash["address2"]
+      place_hash["address2"],
     ].reject { |a| a.nil? || a == "" }
     { "address" => address_fields.map(&:strip).join(", ") }
   end

data/lib/gds_api/json_client.rb

@@ -1,9 +1,9 @@
-require_relative 'response'
-require_relative 'exceptions'
-require_relative 'version'
-require_relative 'govuk_headers'
-require 'rest-client'
-require 'null_logger'
+require_relative "response"
+require_relative "exceptions"
+require_relative "version"
+require_relative "govuk_headers"
+require "rest-client"
+require "null_logger"
 
 module GdsApi
   class JsonClient
@@ -22,9 +22,9 @@ module GdsApi
 
     def self.default_request_headers
       {
-        'Accept' => 'application/json',
+        "Accept" => "application/json",
         # GOVUK_APP_NAME is set for all apps by Puppet
-        'User-Agent' => "gds-api-adapters/#{GdsApi::VERSION} (#{ENV['GOVUK_APP_NAME']})"
+        "User-Agent" => "gds-api-adapters/#{GdsApi::VERSION} (#{ENV['GOVUK_APP_NAME']})",
       }
     end
 
@@ -34,7 +34,7 @@ module GdsApi
 
     def self.json_body_headers
       {
-        'Content-Type' => 'application/json',
+        "Content-Type" => "application/json",
       }
     end
 
@@ -119,12 +119,12 @@ module GdsApi
       if @options[:bearer_token]
         headers = method_params[:headers] || {}
         method_params.merge(headers: headers.merge(
-          "Authorization" => "Bearer #{@options[:bearer_token]}"
+          "Authorization" => "Bearer #{@options[:bearer_token]}",
         ))
       elsif @options[:basic_auth]
         method_params.merge(
           user: @options[:basic_auth][:user],
-          password: @options[:basic_auth][:password]
+          password: @options[:basic_auth][:password],
         )
       else
         method_params
@@ -145,20 +145,20 @@ module GdsApi
         headers: default_headers
           .merge(method_params[:headers] || {})
           .merge(GdsApi::GovukHeaders.headers)
-          .merge(additional_headers)
+          .merge(additional_headers),
       )
     end
 
     def with_ssl_options(method_params)
       method_params.merge(
         # This is the default value anyway, but we should probably be explicit
-        verify_ssl: OpenSSL::SSL::VERIFY_NONE
+        verify_ssl: OpenSSL::SSL::VERIFY_NONE,
       )
     end
 
     def do_request(method, url, params = nil, additional_headers = {})
       loggable = { request_uri: url, start_time: Time.now.to_f }
-      start_logging = loggable.merge(action: 'start')
+      start_logging = loggable.merge(action: "start")
       logger.debug start_logging.to_json
 
       method_params = {
@@ -176,13 +176,13 @@ module GdsApi
 
       ::RestClient::Request.execute(method_params)
     rescue Errno::ECONNREFUSED => e
-      logger.error loggable.merge(status: 'refused', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
+      logger.error loggable.merge(status: "refused", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
       raise GdsApi::EndpointNotFound.new("Could not connect to #{url}")
     rescue RestClient::Exceptions::Timeout => e
-      logger.error loggable.merge(status: 'timeout', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
+      logger.error loggable.merge(status: "timeout", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
       raise GdsApi::TimedOutException.new
     rescue URI::InvalidURIError => e
-      logger.error loggable.merge(status: 'invalid_uri', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
+      logger.error loggable.merge(status: "invalid_uri", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
       raise GdsApi::InvalidUrl
     rescue RestClient::Exception => e
       # Log the error here, since we have access to loggable, but raise the
@@ -191,10 +191,10 @@ module GdsApi
       logger.warn loggable.to_json
       raise
     rescue Errno::ECONNRESET => e
-      logger.error loggable.merge(status: 'connection_reset', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
+      logger.error loggable.merge(status: "connection_reset", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
       raise GdsApi::TimedOutException.new
     rescue SocketError => e
-      logger.error loggable.merge(status: 'socket_error', error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
+      logger.error loggable.merge(status: "socket_error", error_message: e.message, error_class: e.class.name, end_time: Time.now.to_f).to_json
       raise GdsApi::SocketErrorException.new
     end
   end

data/lib/gds_api/link_checker_api.rb

@@ -1,4 +1,4 @@
-require_relative 'base'
+require_relative "base"
 
 class GdsApi::LinkCheckerApi < GdsApi::Base
   # Checks whether a link is broken.
@@ -24,11 +24,11 @@ class GdsApi::LinkCheckerApi < GdsApi::Base
     params = {
       uri: uri,
       synchronous: synchronous,
-      checked_within: checked_within
+      checked_within: checked_within,
     }
 
     response = get_json(
-      "#{endpoint}/check" + query_string(params.delete_if { |_, v| v.nil? })
+      "#{endpoint}/check" + query_string(params.delete_if { |_, v| v.nil? }),
     )
 
     LinkReport.new(response.to_hash)
@@ -84,8 +84,8 @@ class GdsApi::LinkCheckerApi < GdsApi::Base
   def get_batch(id)
     BatchReport.new(
       get_json(
-        "#{endpoint}/batch/#{id}"
-      ).to_hash
+        "#{endpoint}/batch/#{id}",
+      ).to_hash,
     )
   end
 
@@ -106,7 +106,7 @@ class GdsApi::LinkCheckerApi < GdsApi::Base
     payload = {
       links: links,
       app: app,
-      reference: reference
+      reference: reference,
     }
 
     response = post_json("#{endpoint}/monitor", payload)