gds-api-adapters 69.3.0 → 70.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36d53c764d0ec5abb1685e55ff91057da30c9ce250dd46c4d5ae350b7684f66c
-  data.tar.gz: 50687996dcb29b5ca7d8e0ec5cc3fca4ef40228ea2700d901528b9b2f98b30c4
+  metadata.gz: 632391e17f65b54797ea177945c0993fc71545d61a10975b244cf45355723ca1
+  data.tar.gz: dc7b387e7d2038c54541d4dd5382a75d316bbe383870326e89c6c31e8fdbb229
 SHA512:
-  metadata.gz: 1c5cb0ce0c5bd0147374a6abff9a1e121ce811775b5120c73fc319df47aebd8c4acdbe264f3507be9e91b19e0a01e55e0711e9538237c940ad96f9de9ce9b08e
-  data.tar.gz: 6584391dac6990ab4adeedc04491a1a9dec7f7ced21e8adc0da65e7c7fcea2bb242ac56e194e8b6572039a9917b9c7b78601899e822b101ba89f294fbb3a7d34
+  metadata.gz: e1a99f505078d1b27dba69a7b53b1945fdc83c2eb25fb0a6627090d6b77b67b43f324f8ff1ae76c447608e0265749083b78f74d28ec5c7703be4600aebf15174
+  data.tar.gz: a02640e69fb8a4d0292bdd97dee1061c5c498c5412812d74b40733bd7e10a06077631b93f74e8687b763362e1b4776221e60e201d287cbccf3b6d6d1868795c4

data/Rakefile

@@ -30,5 +30,5 @@ end
 
 desc "Run the linter against changed files"
 task :lint do
-  sh "bundle exec rubocop --format clang"
+  sh "bundle exec rubocop"
 end

data/lib/gds_api.rb

@@ -1,6 +1,7 @@
 require "addressable"
 require "plek"
 require "time"
+require "gds_api/account_api"
 require "gds_api/asset_manager"
 require "gds_api/calendars"
 require "gds_api/content_store"
@@ -21,6 +22,19 @@ require "gds_api/worldwide"
 
 # @api documented
 module GdsApi
+  # Creates a GdsApi::AccountApi adapter
+  #
+  # This will set a bearer token if a ACCOUNT_API_BEARER_TOKEN environment
+  # variable is set
+  #
+  # @return [GdsApi::AccountApi]
+  def self.account_api(options = {})
+    GdsApi::AccountApi.new(
+      Plek.find("account-api"),
+      { bearer_token: ENV["ACCOUNT_API_BEARER_TOKEN"] }.merge(options),
+    )
+  end
+
   # Creates a GdsApi::AssetManager adapter
   #
   # This will set a bearer token if a ASSET_MANAGER_BEARER_TOKEN environment

data/lib/gds_api/account_api.rb

@@ -0,0 +1,90 @@
+require_relative "base"
+require_relative "exceptions"
+
+# Adapter for the Account API
+#
+# @see https://github.com/alphagov/account-api
+# @api documented
+class GdsApi::AccountApi < GdsApi::Base
+  AUTH_HEADER_NAME = "GOVUK-Account-Session".freeze
+
+  # Get an OAuth sign-in URL to redirect the user to
+  #
+  # @param [String, nil] redirect_path path on GOV.UK to send the user to after authentication
+  # @param [String, nil] state_id identifier originally returned by #create_registration_state
+  #
+  # @return [Hash] An authentication URL and the OAuth state parameter (for CSRF protection)
+  def get_sign_in_url(redirect_path: nil, state_id: nil)
+    querystring = nested_query_string({ redirect_path: redirect_path, state_id: state_id }.compact)
+    get_json("#{endpoint}/api/oauth2/sign-in?#{querystring}")
+  end
+
+  # Validate an OAuth authentication response
+  #
+  # @param [String] code The OAuth code parameter, from the auth server.
+  # @param [String] state The OAuth state parameter, from the auth server.
+  #
+  # @return [Hash] The value for the govuk_account_session header, the path to redirect the user to, and the GA client ID (if there is one)
+  def validate_auth_response(code:, state:)
+    post_json("#{endpoint}/api/oauth2/callback", code: code, state: state)
+  end
+
+  # Register some initial state, to pass to get_sign_in_url, which is used to initialise the account if the user signs up
+  #
+  # @param [Hash, nil] attributes Initial attributes to store
+  #
+  # @return [Hash] The state ID to pass to get_sign_in_url
+  def create_registration_state(attributes:)
+    post_json("#{endpoint}/api/oauth2/state", attributes: attributes)
+  end
+
+  # Check if a user has an email subscription for the Transition Checker
+  #
+  # @param [String] govuk_account_session Value of the session header
+  #
+  # @return [Hash] Whether the user has a subscription, and a new session header
+  def check_for_email_subscription(govuk_account_session:)
+    get_json("#{endpoint}/api/transition-checker-email-subscription", auth_headers(govuk_account_session))
+  end
+
+  # Create or update a user's email subscription for the Transition Checker
+  #
+  # @param [String] govuk_account_session Value of the session header
+  # @param [String] slug The email topic slug
+  #
+  # @return [Hash] Whether the user has a subscription, and a new session header
+  def set_email_subscription(govuk_account_session:, slug:)
+    post_json("#{endpoint}/api/transition-checker-email-subscription", { slug: slug }, auth_headers(govuk_account_session))
+  end
+
+  # Look up the values of a user's attributes
+  #
+  # @param [String] attributes Names of the attributes to check
+  # @param [String] govuk_account_session Value of the session header
+  #
+  # @return [Hash] The attribute values (if present), and a new session header
+  def get_attributes(attributes:, govuk_account_session:)
+    querystring = nested_query_string({ attributes: attributes }.compact)
+    get_json("#{endpoint}/api/attributes?#{querystring}", auth_headers(govuk_account_session))
+  end
+
+  # Create or update attributes for a user
+  #
+  # @param [String] attributes Hash of new attribute values
+  # @param [String] govuk_account_session Value of the session header
+  #
+  # @return [Hash] A new session header
+  def set_attributes(attributes:, govuk_account_session:)
+    patch_json("#{endpoint}/api/attributes", { attributes: attributes.transform_values(&:to_json) }, auth_headers(govuk_account_session))
+  end
+
+private
+
+  def nested_query_string(params)
+    Rack::Utils.build_nested_query(params)
+  end
+
+  def auth_headers(govuk_account_session)
+    { AUTH_HEADER_NAME => govuk_account_session }
+  end
+end

data/lib/gds_api/base.rb

@@ -71,7 +71,7 @@ private
       case value
       when Array
         value.map do |v|
-          "#{CGI.escape(key.to_s + '[]')}=#{CGI.escape(v.to_s)}"
+          "#{CGI.escape("#{key}[]")}=#{CGI.escape(v.to_s)}"
         end
       else
         "#{CGI.escape(key.to_s)}=#{CGI.escape(value.to_s)}"

data/lib/gds_api/content_store.rb

@@ -93,7 +93,7 @@ private
     def prefix_destination(redirect, path, query)
       uri = URI.parse(redirect["destination"])
       start_char = redirect["path"].length
-      suffix = path[start_char..-1]
+      suffix = path[start_char..]
 
       if uri.path == "" && suffix[0] != "/"
         uri.path = "/#{suffix}"

data/lib/gds_api/exceptions.rb

@@ -14,8 +14,11 @@ module GdsApi
   end
 
   class EndpointNotFound < BaseError; end
+
   class TimedOutException < BaseError; end
+
   class InvalidUrl < BaseError; end
+
   class SocketErrorException < BaseError; end
 
   # Superclass for all 4XX and 5XX errors
@@ -31,25 +34,38 @@ module GdsApi
 
   # Superclass & fallback for all 4XX errors
   class HTTPClientError < HTTPErrorResponse; end
+
   class HTTPIntermittentClientError < HTTPClientError; end
 
   class HTTPNotFound < HTTPClientError; end
+
   class HTTPGone < HTTPClientError; end
+
   class HTTPPayloadTooLarge < HTTPClientError; end
+
   class HTTPUnauthorized < HTTPClientError; end
+
   class HTTPForbidden < HTTPClientError; end
+
   class HTTPConflict < HTTPClientError; end
+
   class HTTPUnprocessableEntity < HTTPClientError; end
+
   class HTTPBadRequest < HTTPClientError; end
+
   class HTTPTooManyRequests < HTTPIntermittentClientError; end
 
   # Superclass & fallback for all 5XX errors
   class HTTPServerError < HTTPErrorResponse; end
+
   class HTTPIntermittentServerError < HTTPServerError; end
 
   class HTTPInternalServerError < HTTPServerError; end
+
   class HTTPBadGateway < HTTPIntermittentServerError; end
+
   class HTTPUnavailable < HTTPIntermittentServerError; end
+
   class HTTPGatewayTimeout < HTTPIntermittentServerError; end
 
   module ExceptionHandling

data/lib/gds_api/json_client.rb

@@ -101,10 +101,10 @@ module GdsApi
       rescue RestClient::Exception => e
         # Attempt to parse the body as JSON if possible
         error_details = begin
-                          e.http_body ? JSON.parse(e.http_body) : nil
-                        rescue JSON::ParserError
-                          nil
-                        end
+          e.http_body ? JSON.parse(e.http_body) : nil
+        rescue JSON::ParserError
+          nil
+        end
         raise build_specific_http_error(e, url, error_details)
       end
 

data/lib/gds_api/performance_platform/data_out.rb

@@ -112,7 +112,7 @@ module GdsApi
       # The performance platform uses Backdrop and its query language for
       # storing and querying data.
       # Backdrop can be found here: https://github.com/alphagov/backdrop
-      def statistics(options, is_multipart = false)
+      def statistics(options, is_multipart = false) # rubocop:disable Style/OptionalBooleanParameter
         params = {
           group_by: options[:group_by],
           collect: options[:collect],
@@ -122,7 +122,7 @@ module GdsApi
         }
 
         filter_param = is_multipart ? :filter_by_prefix : :filter_by
-        params[filter_param] = "pagePath:" + options[:slug]
+        params[filter_param] = "pagePath:#{options[:slug]}"
 
         get_json("#{endpoint}/data/govuk-info/#{options[:transaction]}#{query_string(params)}")
       end

data/lib/gds_api/response.rb

@@ -24,6 +24,7 @@ module GdsApi
       PATTERN = /([-a-z]+)(?:\s*=\s*([^,\s]+))?,?+/i.freeze
 
       def initialize(value = nil)
+        super()
         parse(value)
       end
 

data/lib/gds_api/search.rb

@@ -67,7 +67,7 @@ module GdsApi
     #
     # @param args [Hash] A valid search query. See search-api documentation for options.
     #
-    # @see https://github.com/alphagov/search-api/blob/master/doc/search-api.md
+    # @see https://github.com/alphagov/search-api/blob/master/docs/search-api.md
     def search(args, additional_headers = {})
       request_url = "#{base_url}/search.json?#{Rack::Utils.build_nested_query(args)}"
       get_json(request_url, additional_headers)
@@ -77,7 +77,7 @@ module GdsApi
     #
     # @param searches [Array] An array valid search queries. Maximum of 6. See search-api documentation for options.
     #
-    # # @see https://github.com/alphagov/search-api/blob/master/doc/search-api.md
+    # # @see https://github.com/alphagov/search-api/blob/master/docs/search-api.md
     def batch_search(searches, additional_headers = {})
       url_friendly_searches = searches.each_with_index.map do |search, index|
         { index => search }
@@ -95,7 +95,7 @@ module GdsApi
     # @param args [Hash] A valid search query. See search-api documentation for options.
     # @param page_size [Integer] Number of results in each page.
     #
-    # @see https://github.com/alphagov/search-api/blob/master/doc/search-api.md
+    # @see https://github.com/alphagov/search-api/blob/master/docs/search-api.md
     def search_enum(args, page_size: 100, additional_headers: {})
       Enumerator.new do |yielder|
         (0..Float::INFINITY).step(page_size).each do |index|
@@ -120,7 +120,7 @@ module GdsApi
     #   GOV.UK - we only allow deletion from metasearch
     # @return [GdsApi::Response] A status code of 202 indicates the document has been successfully queued.
     #
-    # @see https://github.com/alphagov/search-api/blob/master/doc/documents.md
+    # @see https://github.com/alphagov/search-api/blob/master/docs/documents.md
     def add_document(*args)
       @api.add_document(*args)
     end
@@ -132,7 +132,7 @@ module GdsApi
     # and contacts, which may be deleted with `delete_document`.
     #
     # @param base_path Base path of the page on GOV.UK.
-    # @see https://github.com/alphagov/search-api/blob/master/doc/content-api.md
+    # @see https://github.com/alphagov/search-api/blob/master/docs/content-api.md
     def delete_content(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
       delete_json(request_url)
@@ -145,7 +145,7 @@ module GdsApi
     # and contacts.
     #
     # @param base_path [String] Base path of the page on GOV.UK.
-    # @see https://github.com/alphagov/search-api/blob/master/doc/content-api.md
+    # @see https://github.com/alphagov/search-api/blob/master/docs/content-api.md
     def get_content(base_path)
       request_url = "#{base_url}/content?link=#{base_path}"
       get_json(request_url)

data/lib/gds_api/test_helpers/account_api.rb

@@ -0,0 +1,100 @@
+require "json"
+
+module GdsApi
+  module TestHelpers
+    module AccountApi
+      ACCOUNT_API_ENDPOINT = Plek.find("account-api")
+
+      def stub_account_api_get_sign_in_url(redirect_path: nil, state_id: nil, auth_uri: "http://auth/provider", state: "state")
+        querystring = Rack::Utils.build_nested_query({ redirect_path: redirect_path, state_id: state_id }.compact)
+        stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/sign-in?#{querystring}")
+          .to_return(
+            status: 200,
+            body: { auth_uri: auth_uri, state: state }.to_json,
+          )
+      end
+
+      def stub_account_api_validates_auth_response(code: nil, state: nil, govuk_account_session: "govuk-account-session", redirect_path: "/", ga_client_id: "ga-client-id")
+        stub_request(:post, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/callback")
+          .with(body: hash_including({ code: code, state: state }.compact))
+          .to_return(
+            status: 200,
+            body: { govuk_account_session: govuk_account_session, redirect_path: redirect_path, ga_client_id: ga_client_id }.to_json,
+          )
+      end
+
+      def stub_account_api_rejects_auth_response(code: nil, state: nil)
+        stub_request(:post, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/callback")
+          .with(body: hash_including({ code: code, state: state }.compact))
+          .to_return(status: 401)
+      end
+
+      def stub_account_api_create_registration_state(attributes: nil, state_id: "state-id")
+        stub_request(:post, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/state")
+          .with(body: hash_including({ attributes: attributes }.compact))
+          .to_return(
+            status: 200,
+            body: { state_id: state_id }.to_json,
+          )
+      end
+
+      def stub_account_api_has_email_subscription(govuk_account_session: nil, new_govuk_account_session: nil)
+        if govuk_account_session
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/transition-checker-email-subscription")
+            .with(headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session })
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session, has_subscription: true }.compact.to_json)
+        else
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/transition-checker-email-subscription")
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session, has_subscription: true }.compact.to_json)
+        end
+      end
+
+      def stub_account_api_does_not_have_email_subscription(govuk_account_session: nil, new_govuk_account_session: nil)
+        if govuk_account_session
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/transition-checker-email-subscription")
+            .with(headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session })
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session, has_subscription: false }.compact.to_json)
+        else
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/transition-checker-email-subscription")
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session, has_subscription: false }.compact.to_json)
+        end
+      end
+
+      def stub_account_api_set_email_subscription(govuk_account_session: nil, slug: "slug", new_govuk_account_session: nil)
+        if govuk_account_session
+          stub_request(:post, "#{ACCOUNT_API_ENDPOINT}/api/transition-checker-email-subscription")
+            .with(body: hash_including({ slug: slug }.compact), headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session })
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session }.compact.to_json)
+        else
+          stub_request(:post, "#{ACCOUNT_API_ENDPOINT}/api/transition-checker-email-subscription")
+            .with(body: hash_including({ slug: slug }.compact))
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session }.compact.to_json)
+        end
+      end
+
+      def stub_account_api_has_attributes(govuk_account_session: nil, attributes: [], values: {}, new_govuk_account_session: nil)
+        querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
+        if govuk_account_session
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/attributes?#{querystring}")
+            .with(headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session })
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session, values: values }.compact.to_json)
+        else
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/attributes?#{querystring}")
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session, values: values }.compact.to_json)
+        end
+      end
+
+      def stub_account_api_set_attributes(govuk_account_session: nil, attributes: nil, new_govuk_account_session: nil)
+        if govuk_account_session
+          stub_request(:patch, "#{ACCOUNT_API_ENDPOINT}/api/attributes")
+            .with(body: hash_including({ attributes: attributes&.transform_values(&:to_json) }.compact), headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session })
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session }.compact.to_json)
+        else
+          stub_request(:patch, "#{ACCOUNT_API_ENDPOINT}/api/attributes")
+            .with(body: hash_including({ attributes: attributes&.transform_values(&:to_json) }.compact))
+            .to_return(status: 200, body: { govuk_account_session: new_govuk_account_session }.compact.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/gds_api/test_helpers/calendars.rb

@@ -4,7 +4,7 @@ module GdsApi
       def 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)

data/lib/gds_api/test_helpers/content_store.rb

@@ -7,7 +7,7 @@ module GdsApi
     module ContentStore
       include ContentItemHelpers
 
-      def content_store_endpoint(draft = false)
+      def content_store_endpoint(draft: false)
         draft ? Plek.current.find("draft-content-store") : Plek.current.find("content-store")
       end
 
@@ -21,10 +21,10 @@ module GdsApi
       def stub_content_store_has_item(base_path, body = content_item_for_base_path(base_path), options = {})
         max_age = options.fetch(:max_age, 900)
         visibility = options[:private] ? "private" : "public"
-        url = content_store_endpoint(options[:draft]) + "/content" + base_path
         body = body.to_json unless body.is_a?(String)
 
-        stub_request(:get, url).to_return(
+        endpoint = content_store_endpoint(draft: options[:draft])
+        stub_request(:get, "#{endpoint}/content#{base_path}").to_return(
           status: 200,
           body: body,
           headers: {
@@ -35,11 +35,9 @@ module GdsApi
       end
 
       def stub_content_store_does_not_have_item(base_path, options = {})
-        url = content_store_endpoint(options[:draft]) + "/content" + base_path
-        stub_request(:get, url).to_return(status: 404, headers: {})
-
-        url = content_store_endpoint(options[:draft]) + "/incoming-links" + base_path
-        stub_request(:get, url).to_return(status: 404, headers: {})
+        endpoint = content_store_endpoint(draft: options[:draft])
+        stub_request(:get, "#{endpoint}/content#{base_path}").to_return(status: 404, headers: {})
+        stub_request(:get, "#{endpoint}/incoming-links#{base_path}").to_return(status: 404, headers: {})
       end
 
       # Content store has gone item
@@ -67,10 +65,9 @@ module GdsApi
       #     "details" => {}
       #   }
       def stub_content_store_has_gone_item(base_path, body = gone_content_item_for_base_path(base_path), options = {})
-        url = content_store_endpoint(options[:draft]) + "/content" + base_path
         body = body.to_json unless body.is_a?(String)
-
-        stub_request(:get, url).to_return(
+        endpoint = content_store_endpoint(draft: options[:draft])
+        stub_request(:get, "#{endpoint}/content#{base_path}").to_return(
           status: 410,
           body: body,
           headers: {},
@@ -86,7 +83,7 @@ module GdsApi
       end
 
       def stub_content_store_has_incoming_links(base_path, links)
-        url = content_store_endpoint + "/incoming-links" + base_path
+        url = "#{content_store_endpoint}/incoming-links#{base_path}"
         body = links.to_json
 
         stub_request(:get, url).to_return(body: body)

data/lib/gds_api/test_helpers/mapit.rb

@@ -10,9 +10,9 @@ module GdsApi
           "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
 
@@ -37,9 +37,9 @@ module GdsApi
            }]
         end]
 
-        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/" + postcode.tr(" ", "+") + ".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")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/postcode/partial/#{postcode.split(' ').first}.json")
           .to_return(body: response.to_json, status: 200)
       end
 
@@ -51,29 +51,29 @@ module GdsApi
           "country_name" => country_name,
         }
 
-        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
 
       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
 
       def stub_mapit_has_areas(area_type, areas)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/areas/" + area_type + ".json")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/areas/#{area_type}.json")
           .to_return(body: areas.to_json, status: 200)
       end
 
       def stub_mapit_does_not_have_areas(area_type)
-        stub_request(:get, "#{MAPIT_ENDPOINT}/areas/" + area_type + ".json")
+        stub_request(:get, "#{MAPIT_ENDPOINT}/areas/#{area_type}.json")
           .to_return(body: [].to_json, status: 200)
       end
 

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

@@ -68,7 +68,7 @@ module GdsApi
           }
 
           filter_param = is_multipart ? :filter_by_prefix : :filter_by
-          params[filter_param] = "pagePath:" + options[:slug]
+          params[filter_param] = "pagePath:#{options[:slug]}"
 
           stub_http_request(:get, "#{PP_DATA_OUT_ENDPOINT}/data/govuk-info/#{options[:transaction]}")
               .with(query: params)

data/lib/gds_api/test_helpers/publishing_api.rb

@@ -8,7 +8,7 @@ module GdsApi
     module PublishingApi
       include ContentItemHelpers
 
-      PUBLISHING_API_V2_ENDPOINT = Plek.current.find("publishing-api") + "/v2"
+      PUBLISHING_API_V2_ENDPOINT = "#{Plek.current.find('publishing-api')}/v2".freeze
       PUBLISHING_API_ENDPOINT = Plek.current.find("publishing-api")
 
       # Stub a PUT /v2/content/:content_id request with the given content id and request body.
@@ -213,7 +213,7 @@ module GdsApi
       # @param attributes_or_matcher [Object]
       # @param times [Integer]
       def assert_publishing_api_put_content(content_id, attributes_or_matcher = nil, times = 1)
-        url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}"
         assert_publishing_api(:put, url, attributes_or_matcher, times)
       end
 
@@ -243,7 +243,7 @@ module GdsApi
       # @param attributes_or_matcher [Object]
       # @param times [Integer]
       def assert_publishing_api_patch_links(content_id, attributes_or_matcher = nil, times = 1)
-        url = PUBLISHING_API_V2_ENDPOINT + "/links/" + content_id
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/links/#{content_id}"
         assert_publishing_api(:patch, url, attributes_or_matcher, times)
       end
 
@@ -308,7 +308,7 @@ module GdsApi
       # @param items [Array]
       # @param params [Hash]
       def stub_publishing_api_has_content(items, params = {})
-        url = PUBLISHING_API_V2_ENDPOINT + "/content"
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/content"
 
         if params.respond_to? :fetch
           per_page = params.fetch(:per_page, 50)
@@ -369,7 +369,7 @@ module GdsApi
       # @param item [Hash]
       def stub_publishing_api_has_item(item, params = {})
         item = deep_transform_keys(item, &:to_sym)
-        url = PUBLISHING_API_V2_ENDPOINT + "/content/" + item[:content_id]
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/content/#{item[:content_id]}"
         stub_request(:get, url)
           .with(query: hash_including(params))
           .to_return(status: 200, body: item.to_json, headers: {})
@@ -380,7 +380,7 @@ module GdsApi
       # @param items [Array]
       def stub_publishing_api_has_item_in_sequence(content_id, items)
         items = items.each { |item| deep_transform_keys(item, &:to_sym) }
-        url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}"
         calls = -1
 
         stub_request(:get, url).to_return do |_request|
@@ -395,7 +395,7 @@ module GdsApi
       #
       # @param content_id [UUID]
       def stub_publishing_api_does_not_have_item(content_id, params = {})
-        url = PUBLISHING_API_V2_ENDPOINT + "/content/" + content_id
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/content/#{content_id}"
         stub_request(:get, url)
           .with(query: hash_including(params))
           .to_return(status: 404, body: resource_not_found(content_id, "content item").to_json, headers: {})
@@ -433,7 +433,7 @@ module GdsApi
       #      }
       def stub_publishing_api_has_links(links)
         links = deep_transform_keys(links, &:to_sym)
-        url = PUBLISHING_API_V2_ENDPOINT + "/links/" + links[:content_id]
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/links/#{links[:content_id]}"
         stub_request(:get, url).to_return(status: 200, body: links.to_json, headers: {})
       end
 
@@ -497,7 +497,7 @@ module GdsApi
         request_params["with_drafts"] = false unless with_drafts
         request_params["generate"] = true if generate
 
-        url = PUBLISHING_API_V2_ENDPOINT + "/expanded-links/" + links[:content_id]
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/expanded-links/#{links[:content_id]}"
         stub_request(:get, url)
           .with(query: request_params)
           .to_return(status: 200, body: links.to_json, headers: {})
@@ -528,7 +528,7 @@ module GdsApi
       #         }
       #       }
       def stub_publishing_api_has_links_for_content_ids(links)
-        url = PUBLISHING_API_V2_ENDPOINT + "/links/by-content-id"
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/links/by-content-id"
         stub_request(:post, url).with(body: { content_ids: links.keys }).to_return(status: 200, body: links.to_json, headers: {})
       end
 
@@ -536,7 +536,7 @@ module GdsApi
       #
       # @param content_id [UUID]
       def stub_publishing_api_does_not_have_links(content_id)
-        url = PUBLISHING_API_V2_ENDPOINT + "/links/" + content_id
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/links/#{content_id}"
         stub_request(:get, url).to_return(status: 404, body: resource_not_found(content_id, "link set").to_json, headers: {})
       end
 
@@ -552,7 +552,7 @@ module GdsApi
       #   })
       #
       def stub_publishing_api_has_lookups(lookup_hash)
-        url = PUBLISHING_API_ENDPOINT + "/lookup-by-base-path"
+        url = "#{PUBLISHING_API_ENDPOINT}/lookup-by-base-path"
         stub_request(:post, url).to_return(body: lookup_hash.to_json)
       end
 
@@ -605,7 +605,7 @@ module GdsApi
       # @param items [Array]
       # @param params [Hash]
       def stub_publishing_api_get_editions(editions, params = {})
-        url = PUBLISHING_API_V2_ENDPOINT + "/editions"
+        url = "#{PUBLISHING_API_V2_ENDPOINT}/editions"
 
         results = editions.map do |edition|
           next edition unless params[:fields]
@@ -670,7 +670,7 @@ module GdsApi
       end
 
       def stub_publishing_api_destroy_intent(base_path)
-        url = PUBLISHING_API_ENDPOINT + "/publish-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" })
       end
 
@@ -679,7 +679,7 @@ module GdsApi
       end
 
       def assert_publishing_api_put_intent(base_path, attributes_or_matcher = {}, times = 1)
-        url = PUBLISHING_API_ENDPOINT + "/publish-intent" + base_path
+        url = "#{PUBLISHING_API_ENDPOINT}/publish-intent#{base_path}"
         assert_publishing_api_put(url, attributes_or_matcher, times)
       end
 
@@ -792,8 +792,7 @@ module GdsApi
       def stub_publishing_api_returns_path_reservation_validation_error_for(base_path, error_fields = {})
         error_fields = { "base_path" => ["Computer says no"] } if error_fields.empty?
 
-        message = error_fields.keys.first.to_s.capitalize.gsub(/_/, " ") + " " +
-          error_fields.values.flatten.first
+        message = "#{error_fields.keys.first.to_s.capitalize.gsub(/_/, ' ')} #{error_fields.values.flatten.first}"
 
         error = { code: 422, message: message, fields: error_fields }
 
@@ -817,7 +816,7 @@ module GdsApi
         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
+        url = "#{PUBLISHING_API_V2_ENDPOINT}#{resource_path}/#{content_id}"
         stub_request(method, url).with(body: body).to_return(response_hash)
       end
 
@@ -858,7 +857,7 @@ module GdsApi
       end
 
       def stub_publishing_api_unreserve_path_with_code(base_path, publishing_app, code)
-        url = PUBLISHING_API_ENDPOINT + "/paths" + base_path
+        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" })
       end

data/lib/gds_api/test_helpers/search.rb

@@ -20,7 +20,7 @@ module GdsApi
         url = if index
                 SEARCH_ENDPOINT + "/#{index}/documents"
               else
-                SEARCH_ENDPOINT + "/documents"
+                "#{SEARCH_ENDPOINT}/documents"
               end
 
         assert_requested(:post, url, **options) do |req|

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "69.3.0".freeze
+  VERSION = "70.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 69.3.0
+  version: 70.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -266,16 +266,16 @@ dependencies:
   name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.pre.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0.pre.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -371,6 +371,7 @@ files:
 - Rakefile
 - lib/gds-api-adapters.rb
 - lib/gds_api.rb
+- lib/gds_api/account_api.rb
 - lib/gds_api/asset_manager.rb
 - lib/gds_api/base.rb
 - lib/gds_api/calendars.rb
@@ -398,6 +399,7 @@ files:
 - lib/gds_api/search.rb
 - lib/gds_api/support.rb
 - lib/gds_api/support_api.rb
+- lib/gds_api/test_helpers/account_api.rb
 - lib/gds_api/test_helpers/asset_manager.rb
 - lib/gds_api/test_helpers/calendars.rb
 - lib/gds_api/test_helpers/common_responses.rb
@@ -440,7 +442,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="