gds-api-adapters 75.1.0 → 77.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36e41430cc8105c52489b3ba8bde38b4027a124a4a0cc3ca4ddabf120dd97de8
-  data.tar.gz: c61130dc56390e9a6ff2962589686bb232abbd506b742c14d6d77a9f6ac7500a
+  metadata.gz: 2ea534ae361e87fde66ed0a9909c3920b0a58c86ad5e26b3dd4c7d13baabe15c
+  data.tar.gz: a24876d1c08767f5d934e9327feb212a6e35f33142c4c6764e85f28eca525de5
 SHA512:
-  metadata.gz: 2b3b29f19b7f55cff24242a9370bfc3cc7b4392de6f9fe84e4d64067bdeabf56b8d35468f2556d86648efb5f7189e3c527203d63ace5ffd6745ad513701addd6
-  data.tar.gz: 5efaa1939f0b3c8644ee3e8c19dc208419cfc6344d3b644c506e76e87965923f3f1c1c9427dc1702be32560caeea38fee900ec5a06ee09b47533324bb3c9e8e0
+  metadata.gz: 23a867c3eb864e2078989ac9f395d572a3679a06ad1efc20f080563d4aabd65e46e27b29118e77daa130924d00c9de4c6f7a7a4f1131d2b242099dc3a05783d6
+  data.tar.gz: 2340a2464e1971055760d1169f05e18c40e9ef50e75610b763f6c6018fcae863a8669aa77a8c9aedaa9ed3632c8e463f0147b92a80d2a811c69d2f4b1ec47a94

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
 

data/lib/gds_api/test_helpers/account_api.rb

@@ -31,12 +31,12 @@ module GdsApi
       ###########################
       # 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", cookie_consent: false)
+      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", cookie_consent: false, feedback_consent: false)
         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, cookie_consent: cookie_consent }.to_json,
+            body: { govuk_account_session: govuk_account_session, redirect_path: redirect_path, ga_client_id: ga_client_id, cookie_consent: cookie_consent, feedback_consent: feedback_consent }.to_json,
           )
       end
 
@@ -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/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "75.1.0".freeze
+  VERSION = "77.0.0".freeze
 end

metadata

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