gds-api-adapters 72.1.0 → 75.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51407d1cee42f0e1fbdf73f71f91f8e2b179adb56b81a9737ce26e334084644a
-  data.tar.gz: e8d397558f602abf5989795c92a2ec62880f0919d72897fde2e8e0ce83af2cdc
+  metadata.gz: 836544dd1d7130e6ba4f035b660be34e3b108b8ed16f93882cbeb3ee48ea2e6c
+  data.tar.gz: 6052c7b0b52ad0bf354b8b97e42fc7e90c98a1ceed2253a8fc501cd4e10b0a6e
 SHA512:
-  metadata.gz: 64ea0ab0af3fd9e4f4fe99a8bd8eab5179dc8216a2c45f4e76691150eaf8421d89ba197f923e56246ed5ed1292c49c5697e0c6c56043702e0a0cf1defd0fa402
-  data.tar.gz: 5a04715d1b8711171adb7d34cafc0f5f4ac499cf5157563c9f39c4fe949fef397ddbc1eab7a40eb9e5f355154cec76ff5b892d7f238515747390a3cb8ec82b3f
+  metadata.gz: 220248bfb16db073e03b98e675278f9776eaa5965010ae737a829a352eb0baf9be23630d3eeec10288397341f6ded0bd4da53a94c70fcf53a09843d64c1bee83
+  data.tar.gz: f0be992cf2e9324bcefafcbf167f5959d6e993ba9e8530d109785c3868e0961d77b16dd57ec48ac3176688d0dde5c608b7b82d75a8b53626d0ee942ff27294ba

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
@@ -89,17 +98,6 @@ class GdsApi::AccountApi < GdsApi::Base
     patch_json("#{endpoint}/api/attributes", { attributes: attributes }, auth_headers(govuk_account_session))
   end
 
-  # Look up the names of a user's attributes
-  #
-  # @param [String] attributes Names of the attributes to check
-  # @param [String] govuk_account_session Value of the session header
-  #
-  # @return [Hash] The attribute names (if present), and a new session header
-  def get_attributes_names(attributes:, govuk_account_session:)
-    querystring = nested_query_string({ attributes: attributes }.compact)
-    get_json("#{endpoint}/api/attributes/names?#{querystring}", auth_headers(govuk_account_session))
-  end
-
   # Get the details of an account-linked email subscription.
   #
   # @param [String] name Name of the subscription
@@ -129,46 +127,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,
@@ -236,13 +256,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,184 +288,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/attributes/names
-      ###########################
-      def stub_account_api_get_attributes_names(attributes: [], **options)
-        querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
-        stub_account_api_request(
-          :get,
-          "/api/attributes/names?#{querystring}",
-          response_body: { values: attributes },
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_get_attributes_names(attributes: [], **options)
-        querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
-        stub_account_api_request(
-          :get,
-          "/api/attributes/names?#{querystring}",
-          response_status: 401,
-          **options,
-        )
-      end
-
-      def stub_account_api_forbidden_get_attributes_names(attributes: [], needed_level_of_authentication: "level1", **options)
-        querystring = Rack::Utils.build_nested_query({ attributes: attributes }.compact)
-        stub_account_api_request(
-          :get,
-          "/api/attributes/names?#{querystring}",
-          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 = "72.1.0".freeze
+  VERSION = "75.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gds-api-adapters
 version: !ruby/object:Gem::Version
-  version: 72.1.0
+  version: 75.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-27 00:00:00.000000000 Z
+date: 2021-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable