gds-api-adapters 74.0.0 → 75.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0fc1bf1088a309b3cea4d2db1528092df0b5c0e87014f268333076cb1536766
-  data.tar.gz: 92932cee9d379fa3dff38449a43544a3b0a38165e34c382a38b8494ec39876bd
+  metadata.gz: 207e19a65d19c45b030d88ccc1028e781def6a120dfedcc725615628b7d2f35d
+  data.tar.gz: a838e9f19dc4e7f8b45017aacd0fae259f1cb353ee44356c8c34066054fb1ea1
 SHA512:
-  metadata.gz: 8c812eed0e923623c4225ba3a88a414c2b08b012656fd43f9bcf35b928c1a76a5874c03cf0f5debc6b170d5fdd35db7ab653d549e67236a52a0effdad0e61e3c
-  data.tar.gz: ce7406f091e64ca710e505b00134397b3769e1a51c038d197d643c32307cf993646e01be1a8eb8f8b7f6a942fe490bda586ffc1aab0fcf2af6e958f7c46d429c
+  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,16 +73,20 @@ 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)
+  def update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil, has_unconfirmed_email: nil, cookie_consent: nil, feedback_consent: 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)
@@ -127,46 +142,6 @@ class GdsApi::AccountApi < GdsApi::Base
     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:)
-    get_json("#{endpoint}/api/saved-pages", auth_headers(govuk_account_session))
-  end
-
-  # Return a single page by unique URL
-  #
-  # @param [String] the path of a page to check
-  # @param [String] govuk_account_session Value of the session header
-  #
-  # @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))
-  end
-
-  # Upsert a single saved page entry in a users account
-  #
-  # @param [String] the path of a page to check
-  # @param [String] govuk_account_session Value of the session header
-  #
-  # @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))
-  end
-
-  # Delete a single saved page entry from a users account
-  #
-  # @param [String] the path of a page to check
-  # @param [String] govuk_account_session Value of the session header
-  #
-  # @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))
-  end
-
 private
 
   def nested_query_string(params)
@@ -174,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

@@ -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
 
@@ -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
       ############################################
@@ -125,16 +160,18 @@ 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, old_email: nil, old_email_verified: nil, old_has_unconfirmed_email: nil)
+      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)
         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) },
+          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) },
           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
@@ -297,143 +334,6 @@ module GdsApi
           **options,
         )
       end
-
-      ######################
-      # GET /api/saved-pages
-      ######################
-      def stub_account_api_returning_saved_pages(saved_pages: [], **options)
-        stub_account_api_request(
-          :get,
-          "/api/saved-pages",
-          response_body: { saved_pages: saved_pages },
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_get_saved_pages(**options)
-        stub_account_api_request(
-          :get,
-          "/api/saved-pages",
-          response_status: 401,
-          **options,
-        )
-      end
-
-      #################################
-      # GET /api/saved_pages/:page_path
-      #################################
-      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,
-              content_id: content_id,
-              title: title,
-            },
-          },
-          **options,
-        )
-      end
-
-      def stub_account_api_does_not_have_saved_page(page_path:, **options)
-        stub_account_api_request(
-          :get,
-          "/api/saved-pages/#{CGI.escape(page_path)}",
-          response_status: 404,
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_get_saved_page(page_path:, **options)
-        stub_account_api_request(
-          :get,
-          "/api/saved-pages/#{CGI.escape(page_path)}",
-          response_status: 401,
-          **options,
-        )
-      end
-
-      #################################
-      # PUT /api/saved-pages/:page_path
-      #################################
-      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,
-              content_id: content_id,
-              title: title,
-            },
-          },
-          **options,
-        )
-      end
-
-      def stub_account_api_save_page_already_exists(page_path:, **options)
-        stub_account_api_save_page(page_path: page_path, **options)
-      end
-
-      def stub_account_api_save_page_cannot_save_page(page_path:, **options)
-        stub_account_api_request(
-          :put,
-          "/api/saved-pages/#{CGI.escape(page_path)}",
-          response_status: 422,
-          response_body: cannot_save_page_problem_detail({ page_path: page_path }),
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_save_page(page_path:, **options)
-        stub_account_api_request(
-          :put,
-          "/api/saved-pages/#{CGI.escape(page_path)}",
-          response_status: 401,
-          **options,
-        )
-      end
-
-      def cannot_save_page_problem_detail(option = {})
-        {
-          title: "Cannot save page",
-          detail: "Cannot save page with path #{option['page_path']}, check it is not blank, and is a well formatted url path.",
-          type: "https://github.com/alphagov/account-api/blob/main/docs/api.md#cannot-save-page",
-          **option,
-        }
-      end
-
-      ####################################
-      # DELETE /api/saved-pages/:page_path
-      ####################################
-      def stub_account_api_delete_saved_page(page_path:, **options)
-        stub_account_api_request(
-          :delete,
-          "/api/saved-pages/#{CGI.escape(page_path)}",
-          response_status: 204,
-          **options,
-        )
-      end
-
-      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)}",
-          response_status: 404,
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_delete_saved_page(page_path:, **options)
-        stub_account_api_request(
-          :delete,
-          "/api/saved-pages/#{CGI.escape(page_path)}",
-          response_status: 401,
-          **options,
-        )
-      end
     end
   end
 end

data/lib/gds_api/version.rb

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