gds-api-adapters 75.2.0 → 75.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed853f2f02ea63fdb7b79c7ef4460076b88cc32d1b3c4f6841ba5ced95d9e22e
-  data.tar.gz: 72bc43ca960d3efece046f7faac4c3369fcaf27a4e9611ef6ca4ebcac4081a9b
+  metadata.gz: 207e19a65d19c45b030d88ccc1028e781def6a120dfedcc725615628b7d2f35d
+  data.tar.gz: a838e9f19dc4e7f8b45017aacd0fae259f1cb353ee44356c8c34066054fb1ea1
 SHA512:
-  metadata.gz: 9ceb5f3b05c87b631691e4221ebdd7fdeeb349fa2b4a213c8407e3af113bbcaac47e6e0e41b8f31ee4370bc59c726d212d397a3a808d9fe0c692f750ea00c215
-  data.tar.gz: d53218eba5ead7910b50e20d8dcb33787c3056e1cdd77bc92c33cb1a60eeeb15c4101e0bf4e9828fdfa32703f99d9bef5c36a67891ed0f6bc0ef175d150cc7ad
+  metadata.gz: d95b69e442c280cf3fbe5fa84dbfc1d16e9462a1c160f0678d7cd78b8a1f0426b4a5878eac6e78a5755f5eff27b293f1832b5d4a35a0958c5aed50d86bee1736
+  data.tar.gz: c167d604668e3685b63c6d83e7a09d6332bd40b2099fa7f4d9afd29d482aa240eef8398b67a0e8aeced29fde34847fe0a3f28d980d7da571cb63efb5b3b251c8

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,7 +73,7 @@ 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
@@ -138,6 +149,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
 

data/lib/gds_api/test_helpers/account_api.rb

@@ -102,6 +102,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
       ############################################

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "75.2.0".freeze
+  VERSION = "75.3.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: 75.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable