gds-api-adapters 71.2.0 → 71.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0860ace845fe7016ae87832f88f46cbf9d27a660432f3314ad4b52cf4774f9
-  data.tar.gz: e3ad07862f196e9e65f16a1d3ff231133c45d293cc8ac4a998c126f5d08aa680
+  metadata.gz: a1177b1955f1d71f876486faf8932550ff11330dbc69bfcf4b3e04eea88ce2fa
+  data.tar.gz: ca001da8d98cab308f0ce695aa46700c3c07d2fd2cd63e3ceea51868013ef4ed
 SHA512:
-  metadata.gz: 8356685a336b23b4c0cb7f8abafd697cafd065be17f5508097e00d7503b6ae7aaaff5efa14a5430ed0f74121661d5df4d1614185717136a1b9e49d78e57ea369
-  data.tar.gz: 232183a69a8985bd6963c475ef852e2d4d28e481d9c09232bd8dbcc9f9db102d16f22df09cd99c4abef7072e1524be76d34230be9cdf99867de08f7e0cf5a4a2
+  metadata.gz: 75a3f20f1364ecf6d0e76f02622b95337b2ec4a8dbb2bc77e4a46a99787c855063454fe92835dee4b105b03ab066c2b0d85c16b98bb57bce0e34009aadbf9a4b
+  data.tar.gz: 282abe1e9269b6fa087f1a6e7205f49eef22f12670d3d7592f3a56acce50a97fab79c68a227be7d2b7a4a1e8e29cd1805738769d2a41e5399199a8c117352ee9

data/lib/gds_api/account_api.rb

@@ -45,6 +45,33 @@ class GdsApi::AccountApi < GdsApi::Base
     post_json("#{endpoint}/api/oauth2/state", attributes: attributes)
   end
 
+  # Get all the information about a user needed to render the account home page
+  #
+  # @param [String] govuk_account_session Value of the session header
+  #
+  # @return [Hash] Information about the user and the services they've used, and a new session header
+  def get_user(govuk_account_session:)
+    get_json("#{endpoint}/api/user", auth_headers(govuk_account_session))
+  end
+
+  # Update the user record with privileged information from the auth service.  Only the auth service will call this.
+  #
+  # @param [String] subject_identifier The identifier of the user, shared between the auth service and GOV.UK.
+  # @param [String, nil] email The user's current
+  # @param [Boolean, nil] email_verified Whether the user's current email address is verified
+  # @param [Boolean, nil] has_unconfirmed_email Whether the user has a new, pending, email address
+  #
+  # @return [Hash] The user's subject identifier and email attributes
+  def update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil, has_unconfirmed_email: nil)
+    params = {
+      email: email,
+      email_verified: email_verified,
+      has_unconfirmed_email: has_unconfirmed_email,
+    }.compact
+
+    patch_json("#{endpoint}/api/oidc-users/#{subject_identifier}", params)
+  end
+
   # Check if a user has an email subscription for the Transition Checker
   #
   # @param [String] govuk_account_session Value of the session header
@@ -96,13 +123,42 @@ class GdsApi::AccountApi < GdsApi::Base
     get_json("#{endpoint}/api/attributes/names?#{querystring}", auth_headers(govuk_account_session))
   end
 
+  # Get the details of an account-linked email subscription.
+  #
+  # @param [String] name Name of the subscription
+  # @param [String] govuk_account_session Value of the session header
+  #
+  # @return [Hash] Details of the subscription, if it exists.
+  def get_email_subscription(name:, govuk_account_session:)
+    get_json("#{endpoint}/api/email-subscriptions/#{CGI.escape(name)}", auth_headers(govuk_account_session))
+  end
+
+  # Create or update an account-linked email subscription.
+  #
+  # @param [String] name Name of the subscription
+  # @param [String] topic_slug The email-alert-api topic slug to subscribe to
+  # @param [String] govuk_account_session Value of the session header
+  #
+  # @return [Hash] Details of the newly created subscription.
+  def put_email_subscription(name:, topic_slug:, govuk_account_session:)
+    put_json("#{endpoint}/api/email-subscriptions/#{CGI.escape(name)}", { topic_slug: topic_slug }, auth_headers(govuk_account_session))
+  end
+
+  # Unsubscribe and delete an account-linked email subscription.
+  #
+  # @param [String] name Name of the subscription
+  # @param [String] govuk_account_session Value of the session header
+  def delete_email_subscription(name:, govuk_account_session:)
+    delete_json("#{endpoint}/api/email-subscriptions/#{CGI.escape(name)}", {}, auth_headers(govuk_account_session))
+  end
+
   # Look up all pages saved by a user in their Account
   #
   # @param [String] govuk_account_session Value of the session header
   #
-  # @return [Hash] containing :saved_pages, an array of single saved page hashes  def get_saved_pages(govuk_account_session:)
+  # @return [Hash] containing :saved_pages, an array of single saved page hashes
   def get_saved_pages(govuk_account_session:)
-    get_json("#{endpoint}/api/saved_pages", auth_headers(govuk_account_session))
+    get_json("#{endpoint}/api/saved-pages", auth_headers(govuk_account_session))
   end
 
   # Return a single page by unique URL
@@ -112,7 +168,7 @@ class GdsApi::AccountApi < GdsApi::Base
   #
   # @return [Hash] containing :saved_page, a hash of a single saved page value
   def get_saved_page(page_path:, govuk_account_session:)
-    get_json("#{endpoint}/api/saved_pages/#{CGI.escape(page_path)}", auth_headers(govuk_account_session))
+    get_json("#{endpoint}/api/saved-pages/#{CGI.escape(page_path)}", auth_headers(govuk_account_session))
   end
 
   # Upsert a single saved page entry in a users account
@@ -122,7 +178,7 @@ class GdsApi::AccountApi < GdsApi::Base
   #
   # @return [Hash] A single saved page value (if sucessful)
   def save_page(page_path:, govuk_account_session:)
-    put_json("#{endpoint}/api/saved_pages/#{CGI.escape(page_path)}", {}, auth_headers(govuk_account_session))
+    put_json("#{endpoint}/api/saved-pages/#{CGI.escape(page_path)}", {}, auth_headers(govuk_account_session))
   end
 
   # Delete a single saved page entry from a users account
@@ -133,7 +189,7 @@ class GdsApi::AccountApi < GdsApi::Base
   # @return [GdsApi::Response] A status code of 204 indicates the saved page has been successfully deleted.
   #                            A status code of 404 indicates there is no saved page with this path.
   def delete_saved_page(page_path:, govuk_account_session:)
-    delete_json("#{endpoint}/api/saved_pages/#{CGI.escape(page_path)}", {}, auth_headers(govuk_account_session))
+    delete_json("#{endpoint}/api/saved-pages/#{CGI.escape(page_path)}", {}, auth_headers(govuk_account_session))
   end
 
 private

data/lib/gds_api/email_alert_api.rb

@@ -176,6 +176,44 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     )
   end
 
+  # Verify a GOV.UK Account-holder has a corresponding subscriber
+  #
+  # @param [string] govuk_account_session The request's session identifier
+  #
+  # @return [Hash] subscriber
+  def authenticate_subscriber_by_govuk_account(govuk_account_session:)
+    post_json(
+      "#{endpoint}/subscribers/govuk-account",
+      govuk_account_session: govuk_account_session,
+    )
+  end
+
+  # Mark a subscriber as "linked" to its corresponding GOV.UK Account.
+  # In practice "linking" will mean that email-alert-frontend and
+  # account-api will treat the subscriber specially (eg, only allowing
+  # address changes via the account).
+  #
+  # @param [string] govuk_account_session The request's session identifier
+  #
+  # @return [Hash] subscriber
+  def link_subscriber_to_govuk_account(govuk_account_session:)
+    post_json(
+      "#{endpoint}/subscribers/govuk-account/link",
+      govuk_account_session: govuk_account_session,
+    )
+  end
+
+  # Find a subscriber which has been "linked" to a GOV.UK Account.
+  #
+  # @param [String] govuk_account_id An ID for the account.
+  #
+  # @return [Hash] subscriber
+  def find_subscriber_by_govuk_account(govuk_account_id:)
+    get_json(
+      "#{endpoint}/subscribers/govuk-account/#{govuk_account_id}",
+    )
+  end
+
   # Verify a subscriber has control of a provided email
   #
   # @param [string]       address       Address to send verification email to

data/lib/gds_api/json_client.rb

@@ -180,10 +180,10 @@ module GdsApi
       raise GdsApi::EndpointNotFound, "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
-      raise GdsApi::TimedOutException
+      raise GdsApi::TimedOutException, e.message
     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
-      raise GdsApi::InvalidUrl
+      raise GdsApi::InvalidUrl, e.message
     rescue RestClient::Exception => e
       # Log the error here, since we have access to loggable, but raise the
       # exception up to the calling method to deal with
@@ -192,10 +192,10 @@ module GdsApi
       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
-      raise GdsApi::TimedOutException
+      raise GdsApi::TimedOutException, e.message
     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
-      raise GdsApi::SocketErrorException
+      raise GdsApi::SocketErrorException, e.message
     end
   end
 end

data/lib/gds_api/test_helpers/account_api.rb

@@ -5,6 +5,20 @@ module GdsApi
     module AccountApi
       ACCOUNT_API_ENDPOINT = Plek.find("account-api")
 
+      def stub_account_api_request(method, path, with: {}, response_status: 200, response_body: {}, govuk_account_session: nil, new_govuk_account_session: nil)
+        with.merge!(headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session }) if govuk_account_session
+        new_govuk_account_session = nil if response_status >= 400
+        to_return = { status: response_status, body: response_body.merge(govuk_account_session: new_govuk_account_session).compact.to_json }
+        if with.empty?
+          stub_request(method, "#{ACCOUNT_API_ENDPOINT}#{path}").to_return(**to_return)
+        else
+          stub_request(method, "#{ACCOUNT_API_ENDPOINT}#{path}").with(**with).to_return(**to_return)
+        end
+      end
+
+      #########################
+      # GET /api/oauth2/sign-in
+      #########################
       def stub_account_api_get_sign_in_url(redirect_path: nil, state_id: nil, level_of_authentication: nil, auth_uri: "http://auth/provider", state: "state")
         querystring = Rack::Utils.build_nested_query({ redirect_path: redirect_path, state_id: state_id, level_of_authentication: level_of_authentication }.compact)
         stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/sign-in?#{querystring}")
@@ -14,6 +28,9 @@ module GdsApi
           )
       end
 
+      ###########################
+      # POST /api/oauth2/callback
+      ###########################
       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))
@@ -29,6 +46,9 @@ module GdsApi
           .to_return(status: 401)
       end
 
+      ########################
+      # POST /api/oauth2/state
+      ########################
       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))
@@ -38,6 +58,156 @@ module GdsApi
           )
       end
 
+      ###############
+      # GET /api/user
+      ###############
+      def stub_account_api_user_info(id: "user-id", level_of_authentication: "level0", email: "email@example.com", email_verified: true, has_unconfirmed_email: false, services: {}, **options)
+        stub_account_api_request(
+          :get,
+          "/api/user",
+          response_body: {
+            id: id,
+            level_of_authentication: level_of_authentication,
+            email: email,
+            email_verified: email_verified,
+            has_unconfirmed_email: has_unconfirmed_email,
+            services: services,
+          },
+          **options,
+        )
+      end
+
+      def stub_account_api_user_info_service_state(service:, service_state: "yes", **options)
+        stub_account_api_user_info(
+          **options.merge(
+            services: options.fetch(:services, {}).merge(service => service_state),
+          ),
+        )
+      end
+
+      def stub_account_api_unauthorized_user_info(**options)
+        stub_account_api_request(
+          :get,
+          "/api/user",
+          response_status: 401,
+          **options,
+        )
+      end
+
+      ###########################################
+      # PATCH /api/oidc-users/:subject_identifier
+      ###########################################
+      def stub_update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil, has_unconfirmed_email: nil, old_email: nil, old_email_verified: nil, old_has_unconfirmed_email: nil)
+        stub_account_api_request(
+          :patch,
+          "/api/oidc-users/#{subject_identifier}",
+          with: { body: hash_including({ email: email, email_verified: email_verified, has_unconfirmed_email: has_unconfirmed_email }.compact) },
+          response_body: {
+            sub: subject_identifier,
+            email: email || old_email,
+            email_verified: email_verified || old_email_verified,
+            has_unconfirmed_email: has_unconfirmed_email || old_has_unconfirmed_email,
+          },
+        )
+      end
+
+      ####################################
+      # GET /api/email-subscriptions/:name
+      ####################################
+      def stub_account_api_get_email_subscription(name:, topic_slug: "slug", email_alert_api_subscription_id: "12345", **options)
+        stub_account_api_request(
+          :get,
+          "/api/email-subscriptions/#{name}",
+          response_body: {
+            email_subscription: {
+              name: name,
+              topic_slug: topic_slug,
+              email_alert_api_subscription_id: email_alert_api_subscription_id,
+            },
+          },
+          **options,
+        )
+      end
+
+      def stub_account_api_get_email_subscription_does_not_exist(name:, **options)
+        stub_account_api_request(
+          :get,
+          "/api/email-subscriptions/#{name}",
+          response_status: 404,
+          **options,
+        )
+      end
+
+      def stub_account_api_get_email_subscription_unauthorized(name:, **options)
+        stub_account_api_request(
+          :get,
+          "/api/email-subscriptions/#{name}",
+          response_status: 401,
+          **options,
+        )
+      end
+
+      ####################################
+      # PUT /api/email-subscriptions/:name
+      ####################################
+      def stub_account_api_put_email_subscription(name:, topic_slug: nil, **options)
+        stub_account_api_request(
+          :put,
+          "/api/email-subscriptions/#{name}",
+          with: { body: hash_including({ topic_slug: topic_slug }.compact) },
+          response_body: {
+            email_subscription: {
+              name: name,
+              topic_slug: topic_slug || "slug",
+            },
+          },
+          **options,
+        )
+      end
+
+      def stub_account_api_unauthorized_put_email_subscription(name:, topic_slug: nil, **options)
+        stub_account_api_request(
+          :put,
+          "/api/email-subscriptions/#{name}",
+          with: { body: hash_including({ topic_slug: topic_slug }.compact) },
+          response_status: 401,
+          **options,
+        )
+      end
+
+      #######################################
+      # DELETE /api/email-subscriptions/:name
+      #######################################
+      def stub_account_api_delete_email_subscription(name:, **options)
+        stub_account_api_request(
+          :delete,
+          "/api/email-subscriptions/#{name}",
+          response_status: 204,
+          **options,
+        )
+      end
+
+      def stub_account_api_delete_email_subscription_does_not_exist(name:, **options)
+        stub_account_api_request(
+          :delete,
+          "/api/email-subscriptions/#{name}",
+          response_status: 404,
+          **options,
+        )
+      end
+
+      def stub_account_api_unauthorized_delete_email_subscription(name:, **options)
+        stub_account_api_request(
+          :delete,
+          "/api/email-subscriptions/#{name}",
+          response_status: 401,
+          **options,
+        )
+      end
+
+      ################################################
+      # GET /api/transition-checker-email-subscription
+      ################################################
       def stub_account_api_has_email_subscription(**options)
         stub_account_api_request(
           :get,
@@ -75,6 +245,9 @@ module GdsApi
         )
       end
 
+      #################################################
+      # POST /api/transition-checker-email-subscription
+      #################################################
       def stub_account_api_set_email_subscription(slug: nil, **options)
         stub_account_api_request(
           :post,
@@ -105,6 +278,9 @@ module GdsApi
         )
       end
 
+      #####################
+      # GET /api/attributes
+      #####################
       def stub_account_api_has_attributes(attributes: [], values: {}, **options)
         querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
         stub_account_api_request(
@@ -136,6 +312,9 @@ module GdsApi
         )
       end
 
+      #######################
+      # PATCH /api/attributes
+      #######################
       def stub_account_api_set_attributes(attributes: nil, **options)
         stub_account_api_request(
           :patch,
@@ -166,6 +345,9 @@ module GdsApi
         )
       end
 
+      ###########################
+      # GET /api/attributes/names
+      ###########################
       def stub_account_api_get_attributes_names(attributes: [], **options)
         querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
         stub_account_api_request(
@@ -197,24 +379,13 @@ module GdsApi
         )
       end
 
-      def stub_account_api_request(method, path, with: {}, response_status: 200, response_body: {}, govuk_account_session: nil, new_govuk_account_session: nil)
-        with.merge!(headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session }) if govuk_account_session
-        new_govuk_account_session = nil if response_status >= 400
-        to_return = { status: response_status, body: response_body.merge(govuk_account_session: new_govuk_account_session).compact.to_json }
-        if with.empty?
-          stub_request(method, "#{ACCOUNT_API_ENDPOINT}#{path}").to_return(**to_return)
-        else
-          stub_request(method, "#{ACCOUNT_API_ENDPOINT}#{path}").with(**with).to_return(**to_return)
-        end
-      end
-
       ######################
-      # GET /api/saved_pages
+      # GET /api/saved-pages
       ######################
       def stub_account_api_returning_saved_pages(saved_pages: [], **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages",
+          "/api/saved-pages",
           response_body: { saved_pages: saved_pages },
           **options,
         )
@@ -223,7 +394,7 @@ module GdsApi
       def stub_account_api_unauthorized_get_saved_pages(**options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages",
+          "/api/saved-pages",
           response_status: 401,
           **options,
         )
@@ -232,11 +403,17 @@ module GdsApi
       #################################
       # GET /api/saved_pages/:page_path
       #################################
-      def stub_account_api_get_saved_page(page_path:, **options)
+      def stub_account_api_get_saved_page(page_path:, content_id: "46163ed2-1777-4ee6-bdd4-6a2007e49d8f", title: "Ministry of Magic", **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
-          response_body: { saved_page: { page_path: page_path } },
+          "/api/saved-pages/#{CGI.escape(page_path)}",
+          response_body: {
+            saved_page: {
+              page_path: page_path,
+              content_id: content_id,
+              title: title,
+            },
+          },
           **options,
         )
       end
@@ -244,7 +421,7 @@ module GdsApi
       def stub_account_api_does_not_have_saved_page(page_path:, **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 404,
           **options,
         )
@@ -253,20 +430,26 @@ module GdsApi
       def stub_account_api_unauthorized_get_saved_page(page_path:, **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 401,
           **options,
         )
       end
 
       #################################
-      # PUT /api/saved_pages/:page_path
+      # PUT /api/saved-pages/:page_path
       #################################
-      def stub_account_api_save_page(page_path:, **options)
+      def stub_account_api_save_page(page_path:, content_id: "c840bfa2-011a-42cc-ac7a-a6da990aff0b", title: "Ministry of Magic", **options)
         stub_account_api_request(
           :put,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
-          response_body: { saved_page: { page_path: page_path } },
+          "/api/saved-pages/#{CGI.escape(page_path)}",
+          response_body: {
+            saved_page: {
+              page_path: page_path,
+              content_id: content_id,
+              title: title,
+            },
+          },
           **options,
         )
       end
@@ -278,9 +461,9 @@ module GdsApi
       def stub_account_api_save_page_cannot_save_page(page_path:, **options)
         stub_account_api_request(
           :put,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 422,
-          response_body: { **cannot_save_page_problem_detail({ page_path: page_path }) },
+          response_body: cannot_save_page_problem_detail({ page_path: page_path }),
           **options,
         )
       end
@@ -288,7 +471,7 @@ module GdsApi
       def stub_account_api_unauthorized_save_page(page_path:, **options)
         stub_account_api_request(
           :put,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 401,
           **options,
         )
@@ -309,7 +492,7 @@ module GdsApi
       def stub_account_api_delete_saved_page(page_path:, **options)
         stub_account_api_request(
           :delete,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 204,
           **options,
         )
@@ -318,7 +501,7 @@ module GdsApi
       def stub_account_api_delete_saved_page_does_not_exist(page_path:, **options)
         stub_account_api_request(
           :delete,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 404,
           **options,
         )
@@ -327,7 +510,7 @@ module GdsApi
       def stub_account_api_delete_saved_page_unauthorised(page_path:, **options)
         stub_account_api_request(
           :delete,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 401,
           **options,
         )

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -6,11 +6,11 @@ module GdsApi
     module EmailAlertApi
       EMAIL_ALERT_API_ENDPOINT = Plek.find("email-alert-api")
 
-      def stub_email_alert_api_has_updated_subscriber(id, new_address)
+      def stub_email_alert_api_has_updated_subscriber(id, new_address, govuk_account_id: nil)
         stub_request(:patch, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/#{id}")
           .to_return(
             status: 200,
-            body: get_subscriber_response(id, new_address).to_json,
+            body: get_subscriber_response(id, new_address, govuk_account_id).to_json,
           )
       end
 
@@ -265,11 +265,11 @@ module GdsApi
           ).to_return(status: 422)
       end
 
-      def stub_email_alert_api_sends_subscriber_verification_email(subscriber_id, address)
+      def stub_email_alert_api_sends_subscriber_verification_email(subscriber_id, address, govuk_account_id: nil)
         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, govuk_account_id).to_json,
           )
       end
 
@@ -283,6 +283,97 @@ module GdsApi
           .to_return(status: 404)
       end
 
+      def stub_email_alert_api_authenticate_subscriber_by_govuk_account(govuk_account_session, subscriber_id, address, govuk_account_id: "user-id", new_govuk_account_session: nil)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 200,
+            body: {
+              govuk_account_session: new_govuk_account_session,
+            }.compact.merge(get_subscriber_response(subscriber_id, address, govuk_account_id)).to_json,
+          )
+      end
+
+      def stub_email_alert_api_authenticate_subscriber_by_govuk_account_session_invalid(govuk_account_session)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 401,
+          )
+      end
+
+      def stub_email_alert_api_authenticate_subscriber_by_govuk_account_email_unverified(govuk_account_session, new_govuk_account_session: nil)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 403,
+            body: {
+              govuk_account_session: new_govuk_account_session,
+            }.compact.to_json,
+          )
+      end
+
+      def stub_email_alert_api_authenticate_subscriber_by_govuk_account_no_subscriber(govuk_account_session, new_govuk_account_session: nil)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 404,
+            body: {
+              govuk_account_session: new_govuk_account_session,
+            }.compact.to_json,
+          )
+      end
+
+      def stub_email_alert_api_link_subscriber_to_govuk_account(govuk_account_session, subscriber_id, address, govuk_account_id: "user-id", new_govuk_account_session: nil)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account/link")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 200,
+            body: {
+              govuk_account_session: new_govuk_account_session,
+            }.compact.merge(get_subscriber_response(subscriber_id, address, govuk_account_id)).to_json,
+          )
+      end
+
+      def stub_email_alert_api_link_subscriber_to_govuk_account_session_invalid(govuk_account_session)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account/link")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 401,
+          )
+      end
+
+      def stub_email_alert_api_link_subscriber_to_govuk_account_email_unverified(govuk_account_session, new_govuk_account_session: nil)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account/link")
+          .with(
+            body: { govuk_account_session: govuk_account_session }.to_json,
+          ).to_return(
+            status: 403,
+            body: {
+              govuk_account_session: new_govuk_account_session,
+            }.compact.to_json,
+          )
+      end
+
+      def stub_email_alert_api_find_subscriber_by_govuk_account(govuk_account_id, subscriber_id, address)
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account/#{govuk_account_id}")
+          .to_return(
+            status: 200,
+            body: get_subscriber_response(subscriber_id, address, govuk_account_id).to_json,
+          )
+      end
+
+      def stub_email_alert_api_find_subscriber_by_govuk_account_no_subscriber(govuk_account_id)
+        stub_request(:get, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account/#{govuk_account_id}")
+          .to_return(status: 404)
+      end
+
       def assert_unsubscribed(uuid)
         assert_requested(:post, "#{EMAIL_ALERT_API_ENDPOINT}/unsubscribe/#{uuid}", times: 1)
       end
@@ -314,11 +405,12 @@ module GdsApi
 
     private
 
-      def get_subscriber_response(id, address)
+      def get_subscriber_response(id, address, govuk_account_id)
         {
           "subscriber" => {
             "id" => id,
             "address" => address,
+            "govuk_account_id" => govuk_account_id,
           },
         }
       end

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "71.2.0".freeze
+  VERSION = "71.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 71.2.0
+  version: 71.7.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -445,7 +445,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Adapters to work with GDS APIs