gds-api-adapters 73.0.0 → 75.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e27eb1087cbf7f61da350a3c09dc2d1c235ed5b6ee6b096ae9ca3c3f25edb2e9
-  data.tar.gz: 24af32669af502a68d4085e86be5705e8ff98f6899e50f6b01df1b3b884a2e56
+  metadata.gz: 36e41430cc8105c52489b3ba8bde38b4027a124a4a0cc3ca4ddabf120dd97de8
+  data.tar.gz: c61130dc56390e9a6ff2962589686bb232abbd506b742c14d6d77a9f6ac7500a
 SHA512:
-  metadata.gz: b4b6328db22729d14c8f4f456d8886dd2de5de9d75efd1fbb5f00124f1f067fe520ea5556d67ac32ffd36653598ee9895d029abfcd2ecc3a1ef22c8d8b618574
-  data.tar.gz: 9c78e6148f87c00c682222bf1468a32b9e70aa05b7a1163f2aabc2b7d0c050d591a43a80ccf502e6f7c01b695859effc33879ca3ced8dd7f3912eed4a2f75c39
+  metadata.gz: 2b3b29f19b7f55cff24242a9370bfc3cc7b4392de6f9fe84e4d64067bdeabf56b8d35468f2556d86648efb5f7189e3c527203d63ace5ffd6745ad513701addd6
+  data.tar.gz: 5efaa1939f0b3c8644ee3e8c19dc208419cfc6344d3b644c506e76e87965923f3f1c1c9427dc1702be32560caeea38fee900ec5a06ee09b47533324bb3c9e8e0

data/lib/gds_api/account_api.rb

@@ -11,14 +11,14 @@ class GdsApi::AccountApi < GdsApi::Base
   # Get an OAuth sign-in URL to redirect the user to
   #
   # @param [String, nil] redirect_path path on GOV.UK to send the user to after authentication
-  # @param [String, nil] level_of_authentication either "level1" (require MFA) or "level0" (do not require MFA)
+  # @param [Boolean, nil] mfa whether to authenticate the user with MFA or not
   #
   # @return [Hash] An authentication URL and the OAuth state parameter (for CSRF protection)
-  def get_sign_in_url(redirect_path: nil, level_of_authentication: nil)
+  def get_sign_in_url(redirect_path: nil, mfa: false)
     querystring = nested_query_string(
       {
         redirect_path: redirect_path,
-        level_of_authentication: level_of_authentication,
+        mfa: mfa,
       }.compact,
     )
     get_json("#{endpoint}/api/oauth2/sign-in?#{querystring}")
@@ -34,6 +34,15 @@ class GdsApi::AccountApi < GdsApi::Base
     post_json("#{endpoint}/api/oauth2/callback", code: code, state: state)
   end
 
+  # Get an OIDC end-session URL to redirect the user to
+  #
+  # @param [String, nil] govuk_account_session Value of the session header
+  #
+  # @return [Hash] An end-session URL
+  def get_end_session_url(govuk_account_session: nil)
+    get_json("#{endpoint}/api/oauth2/end-session", auth_headers(govuk_account_session))
+  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
@@ -56,13 +65,17 @@ class GdsApi::AccountApi < GdsApi::Base
   # @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
+  # @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)
@@ -118,46 +131,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)

data/lib/gds_api/test_helpers/account_api.rb

@@ -19,8 +19,8 @@ module GdsApi
       #########################
       # GET /api/oauth2/sign-in
       #########################
-      def stub_account_api_get_sign_in_url(redirect_path: nil, level_of_authentication: nil, auth_uri: "http://auth/provider", state: "state")
-        querystring = Rack::Utils.build_nested_query({ redirect_path: redirect_path, level_of_authentication: level_of_authentication }.compact)
+      def stub_account_api_get_sign_in_url(redirect_path: nil, mfa: false, auth_uri: "http://auth/provider", state: "state")
+        querystring = Rack::Utils.build_nested_query({ redirect_path: redirect_path, mfa: mfa }.compact)
         stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/sign-in?#{querystring}")
           .to_return(
             status: 200,
@@ -46,16 +46,36 @@ module GdsApi
           .to_return(status: 401)
       end
 
+      #############################
+      # GET /api/oauth2/end-session
+      #############################
+      def stub_account_api_get_end_session_url(govuk_account_session: nil, end_session_uri: "http://auth/provider")
+        if govuk_account_session
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/end-session")
+            .with(headers: { GdsApi::AccountApi::AUTH_HEADER_NAME => govuk_account_session })
+            .to_return(
+              status: 200,
+              body: { end_session_uri: end_session_uri }.to_json,
+            )
+        else
+          stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/end-session")
+            .to_return(
+              status: 200,
+              body: { end_session_uri: end_session_uri }.to_json,
+            )
+        end
+      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)
+      def stub_account_api_user_info(id: "user-id", mfa: false, 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,
+            mfa: mfa,
             email: email,
             email_verified: email_verified,
             has_unconfirmed_email: has_unconfirmed_email,
@@ -105,16 +125,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
@@ -236,13 +258,12 @@ module GdsApi
         )
       end
 
-      def stub_account_api_forbidden_has_attributes(attributes: [], needed_level_of_authentication: "level1", **options)
+      def stub_account_api_forbidden_has_attributes(attributes: [], **options)
         querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
         stub_account_api_request(
           :get,
           "/api/attributes?#{querystring}",
           response_status: 403,
-          response_body: { needed_level_of_authentication: needed_level_of_authentication },
           **options,
         )
       end
@@ -269,150 +290,12 @@ module GdsApi
         )
       end
 
-      def stub_account_api_forbidden_set_attributes(attributes: nil, needed_level_of_authentication: "level1", **options)
+      def stub_account_api_forbidden_set_attributes(attributes: nil, **options)
         stub_account_api_request(
           :patch,
           "/api/attributes",
           with: { body: hash_including({ attributes: attributes }.compact) },
           response_status: 403,
-          response_body: { needed_level_of_authentication: needed_level_of_authentication },
-          **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

data/lib/gds_api/version.rb

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

metadata

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