gds-api-adapters 75.2.0 → 77.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed853f2f02ea63fdb7b79c7ef4460076b88cc32d1b3c4f6841ba5ced95d9e22e
-  data.tar.gz: 72bc43ca960d3efece046f7faac4c3369fcaf27a4e9611ef6ca4ebcac4081a9b
+  metadata.gz: 4ae9935a6f00ed43737c077e942ba2fb89deff13e02bac93917b1db6215162d2
+  data.tar.gz: 0c7da0e74c80afc296468a98cd79f11f357957b12ba9ed90247c2d2ac0b0aff0
 SHA512:
-  metadata.gz: 9ceb5f3b05c87b631691e4221ebdd7fdeeb349fa2b4a213c8407e3af113bbcaac47e6e0e41b8f31ee4370bc59c726d212d397a3a808d9fe0c692f750ea00c215
-  data.tar.gz: d53218eba5ead7910b50e20d8dcb33787c3056e1cdd77bc92c33cb1a60eeeb15c4101e0bf4e9828fdfa32703f99d9bef5c36a67891ed0f6bc0ef175d150cc7ad
+  metadata.gz: '0279189027b025193a9340b849a3fea6c682563af8affbf73ebdae40a83f4aecbaa878b039d6d23311bda729c7ab7fb94f1fa6b9739e867ac44136830f145c0e'
+  data.tar.gz: dc55f3c73fb2c1e45ac97dcd74581f3c52701186ca7f96171abbea8178d6721629f1c6deee08e7dce3d68bcf5277544f2bced1189fa9bbeb49f2b179d0da14af

data/lib/gds_api/account_api.rb

@@ -52,6 +52,17 @@ class GdsApi::AccountApi < GdsApi::Base
     get_json("#{endpoint}/api/user", auth_headers(govuk_account_session))
   end
 
+  # Find a user by email address, returning whether they match the given session (if any)
+  #
+  # @param [String] email The email address to search for
+  # @param [String, nil] govuk_account_session Value of the session header, if not given just checks if the given email address exists.
+  #
+  # @return [Hash] One field, "match", indicating whether the session matches the given email address
+  def match_user_by_email(email:, govuk_account_session: nil)
+    querystring = nested_query_string({ email: email })
+    get_json("#{endpoint}/api/user/match-by-email?#{querystring}", auth_headers(govuk_account_session))
+  end
+
   # Delete a users account
   #
   # @param [String] subject_identifier The identifier of the user, shared between the auth service and GOV.UK.
@@ -62,20 +73,14 @@ class GdsApi::AccountApi < GdsApi::Base
   # 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 [String, nil] email The user's current email address
   # @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
-  # @param [Boolean, nil] cookie_consent Whether the user has consented to analytics cookies
-  # @param [Boolean, nil] feedback_consent Whether the user has consented to being contacted for feedback
   #
   # @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, cookie_consent: nil, feedback_consent: nil)
+  def update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil)
     params = {
       email: email,
       email_verified: email_verified,
-      has_unconfirmed_email: has_unconfirmed_email,
-      cookie_consent: cookie_consent,
-      feedback_consent: feedback_consent,
     }.compact
 
     patch_json("#{endpoint}/api/oidc-users/#{subject_identifier}", params)
@@ -138,6 +143,6 @@ private
   end
 
   def auth_headers(govuk_account_session)
-    { AUTH_HEADER_NAME => govuk_account_session }
+    { AUTH_HEADER_NAME => govuk_account_session }.compact
   end
 end

data/lib/gds_api/email_alert_api.rb

@@ -10,8 +10,9 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   #
   # @param attributes [Hash] document_type, links, tags used to search existing subscriber lists
   def find_or_create_subscriber_list(attributes)
-    if attributes["tags"] && attributes["links"]
-      message = "please provide either tags or links (or neither), but not both"
+    present_fields = [attributes["content_id"], attributes["links"], attributes["tags"]].compact.count
+    if present_fields > 1
+      message = "please provide content_id, tags, or links (or none), but not more than one of them"
       raise ArgumentError, message
     end
 
@@ -246,6 +247,22 @@ class GdsApi::EmailAlertApi < GdsApi::Base
     )
   end
 
+  # Unsubscribe all users for a subscription list
+  # optionally send a notification email explaining the reason
+  #
+  # @param [string]               subscriber_list_id    Identifier for the subscription list
+  # @param [string] (optional)    body                  Optional email body to send to alert users they are being unsubscribed
+  # @param [string] (optional)    sender_message_id     A UUID to prevent multiple emails for the same event
+  def bulk_unsubscribe(subscriber_list_id:, body: nil, sender_message_id: nil)
+    post_json(
+      "#{endpoint}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe",
+      {
+        body: body,
+        sender_message_id: sender_message_id,
+      }.compact,
+    )
+  end
+
 private
 
   def nested_query_string(params)

data/lib/gds_api/test_helpers/account_api.rb

@@ -69,7 +69,7 @@ module GdsApi
       ###############
       # GET /api/user
       ###############
-      def stub_account_api_user_info(id: "user-id", mfa: false, email: "email@example.com", email_verified: true, has_unconfirmed_email: false, services: {}, **options)
+      def stub_account_api_user_info(id: "user-id", mfa: false, email: "email@example.com", email_verified: true, services: {}, **options)
         stub_account_api_request(
           :get,
           "/api/user",
@@ -78,7 +78,6 @@ module GdsApi
             mfa: mfa,
             email: email,
             email_verified: email_verified,
-            has_unconfirmed_email: has_unconfirmed_email,
             services: services,
           },
           **options,
@@ -102,6 +101,41 @@ module GdsApi
         )
       end
 
+      ##############################
+      # GET /api/user/match-by-email
+      ##############################
+
+      def stub_account_api_match_user_by_email_matches(email:, **options)
+        stub_account_api_request(
+          :get,
+          "/api/user/match-by-email?#{Rack::Utils.build_nested_query({ email: email })}",
+          response_body: {
+            match: true,
+          },
+          **options,
+        )
+      end
+
+      def stub_account_api_match_user_by_email_does_not_match(email:, **options)
+        stub_account_api_request(
+          :get,
+          "/api/user/match-by-email?#{Rack::Utils.build_nested_query({ email: email })}",
+          response_body: {
+            match: false,
+          },
+          **options,
+        )
+      end
+
+      def stub_account_api_match_user_by_email_does_not_exist(email:, **options)
+        stub_account_api_request(
+          :get,
+          "/api/user/match-by-email?#{Rack::Utils.build_nested_query({ email: email })}",
+          response_status: 404,
+          **options,
+        )
+      end
+
       ############################################
       # DELETE /api/oidc-users/:subject_identifier
       ############################################
@@ -125,18 +159,15 @@ module GdsApi
       ###########################################
       # PATCH /api/oidc-users/:subject_identifier
       ###########################################
-      def stub_update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil, has_unconfirmed_email: nil, cookie_consent: nil, feedback_consent: nil, old_email: nil, old_email_verified: nil, old_has_unconfirmed_email: nil, old_cookie_consent: nil, old_feedback_consent: nil)
+      def stub_update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil, old_email: nil, old_email_verified: 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, cookie_consent: cookie_consent, feedback_consent: feedback_consent }.compact) },
+          with: { body: hash_including({ email: email, email_verified: email_verified }.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,
-            cookie_consent: cookie_consent || old_cookie_consent,
-            feedback_consent: feedback_consent || old_feedback_consent,
           },
         )
       end

data/lib/gds_api/test_helpers/email_alert_api.rb

@@ -408,6 +408,53 @@ module GdsApi
           .to_return(status: 404)
       end
 
+      def stub_email_alert_api_bulk_unsubscribe(subscriber_list_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+          .to_return(status: 202)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_with_message(subscriber_list_id:, body:, sender_message_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+        ).to_return(status: 202)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_not_found(subscriber_list_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+          .to_return(status: 404)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_not_found_with_message(subscriber_list_id:, body:, sender_message_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+        ).to_return(status: 404)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_conflict_with_message(subscriber_list_id:, body:, sender_message_id:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: {
+            body: body,
+            sender_message_id: sender_message_id,
+          }.to_json,
+        ).to_return(status: 409)
+      end
+
+      def stub_email_alert_api_bulk_unsubscribe_bad_request(subscriber_list_id:, body:)
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscriber-lists/#{subscriber_list_id}/bulk-unsubscribe")
+        .with(
+          body: { body: body }.to_json,
+        ).to_return(status: 422)
+      end
+
     private
 
       def get_subscriber_response(id, address, govuk_account_id)

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "75.2.0".freeze
+  VERSION = "77.1.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 75.2.0
+  version: 77.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2022-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable