gds-api-adapters 71.9.0 → 73.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8670645ff0ca90d1b259b0607aca69f3164d91330b33f3d05f2e741fbbd334e6
-  data.tar.gz: 7ac9e476e7ab01e1ad992bb9fd6dcb0fc4e494fcf05400e0df5cdc3a6b201a2e
+  metadata.gz: d35a5a4781f1983405b899ebeba4aecbf9d91728a9f82e7ac0a2b75b6c937181
+  data.tar.gz: 33c37300639794ce84a6afbf35d142afc572b1e17a67e60e1204c7b8d51b8b6a
 SHA512:
-  metadata.gz: fb5bdf29581b987c5be58ffc9ccba0e5f950194a3e8f26d2ec9eb83b87db370a618716fb1d9a9cfd7db6049309e7d136ae2815cdc365205392a6634603583f5d
-  data.tar.gz: 7f37ede40200371ead2740f89d44c4a588a0b488c0ae3516232370d6d65234b99e30a31c7fe36524b20ce19ebdcd222f81d72549627cb7182673389c030443eb
+  metadata.gz: 86c6188ed9f79fa7b5d8d0426e49453c864b9f4f1c8260f2e25291ad6266de37c869a22ec5298a9c57913f8d4a7141aac8c184cf6b2a1c5eed5ac040b895b608
+  data.tar.gz: 6361bff544285f8b60dfa099120b0e6b0ffea107dcf592c5ef151d337bd48458354ccfa52528d231cebd6a52211e4cdc0168135ff4e2d41819520e338367368e

data/lib/gds_api/account_api.rb

@@ -11,15 +11,13 @@ 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] state_id identifier originally returned by #create_registration_state
   # @param [String, nil] level_of_authentication either "level1" (require MFA) or "level0" (do not require MFA)
   #
   # @return [Hash] An authentication URL and the OAuth state parameter (for CSRF protection)
-  def get_sign_in_url(redirect_path: nil, state_id: nil, level_of_authentication: nil)
+  def get_sign_in_url(redirect_path: nil, level_of_authentication: nil)
     querystring = nested_query_string(
       {
         redirect_path: redirect_path,
-        state_id: state_id,
         level_of_authentication: level_of_authentication,
       }.compact,
     )
@@ -36,13 +34,13 @@ class GdsApi::AccountApi < GdsApi::Base
     post_json("#{endpoint}/api/oauth2/callback", code: code, state: state)
   end
 
-  # Register some initial state, to pass to get_sign_in_url, which is used to initialise the account if the user signs up
+  # Get an OIDC end-session URL to redirect the user to
   #
-  # @param [Hash, nil] attributes Initial attributes to store
+  # @param [String, nil] govuk_account_session Value of the session header
   #
-  # @return [Hash] The state ID to pass to get_sign_in_url
-  def create_registration_state(attributes:)
-    post_json("#{endpoint}/api/oauth2/state", attributes: attributes)
+  # @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
@@ -54,6 +52,13 @@ class GdsApi::AccountApi < GdsApi::Base
     get_json("#{endpoint}/api/user", 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.
+  def delete_user_by_subject_identifier(subject_identifier:)
+    delete_json("#{endpoint}/api/oidc-users/#{subject_identifier}")
+  end
+
   # 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.
@@ -72,25 +77,6 @@ class GdsApi::AccountApi < GdsApi::Base
     patch_json("#{endpoint}/api/oidc-users/#{subject_identifier}", params)
   end
 
-  # Check if a user has an email subscription for the Transition Checker
-  #
-  # @param [String] govuk_account_session Value of the session header
-  #
-  # @return [Hash] Whether the user has a subscription, and a new session header
-  def check_for_email_subscription(govuk_account_session:)
-    get_json("#{endpoint}/api/transition-checker-email-subscription", auth_headers(govuk_account_session))
-  end
-
-  # Create or update a user's email subscription for the Transition Checker
-  #
-  # @param [String] govuk_account_session Value of the session header
-  # @param [String] slug The email topic slug
-  #
-  # @return [Hash] Whether the user has a subscription, and a new session header
-  def set_email_subscription(govuk_account_session:, slug:)
-    post_json("#{endpoint}/api/transition-checker-email-subscription", { slug: slug }, auth_headers(govuk_account_session))
-  end
-
   # Look up the values of a user's attributes
   #
   # @param [String] attributes Names of the attributes to check
@@ -112,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

data/lib/gds_api/exceptions.rb

@@ -3,7 +3,7 @@ module GdsApi
   class BaseError < StandardError
     # Give Sentry extra context about this event
     # https://docs.sentry.io/clients/ruby/context/
-    def raven_context
+    def sentry_context
       {
         # Make Sentry group exceptions by type instead of message, so all
         # exceptions like `GdsApi::TimedOutException` will get grouped as one

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, state_id: nil, level_of_authentication: nil, auth_uri: "http://auth/provider", state: "state")
-        querystring = Rack::Utils.build_nested_query({ redirect_path: redirect_path, state_id: state_id, level_of_authentication: level_of_authentication }.compact)
+      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)
         stub_request(:get, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/sign-in?#{querystring}")
           .to_return(
             status: 200,
@@ -46,16 +46,24 @@ module GdsApi
           .to_return(status: 401)
       end
 
-      ########################
-      # POST /api/oauth2/state
-      ########################
-      def stub_account_api_create_registration_state(attributes: nil, state_id: "state-id")
-        stub_request(:post, "#{ACCOUNT_API_ENDPOINT}/api/oauth2/state")
-          .with(body: hash_including({ attributes: attributes }.compact))
-          .to_return(
-            status: 200,
-            body: { state_id: state_id }.to_json,
-          )
+      #############################
+      # 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
 
       ###############
@@ -94,6 +102,26 @@ module GdsApi
         )
       end
 
+      ############################################
+      # DELETE /api/oidc-users/:subject_identifier
+      ############################################
+
+      def stub_account_api_delete_user_by_subject_identifier(subject_identifier:)
+        stub_account_api_request(
+          :delete,
+          "/api/oidc-users/#{subject_identifier}",
+          response_status: 204,
+        )
+      end
+
+      def stub_account_api_delete_user_by_subject_identifier_does_not_exist(subject_identifier:)
+        stub_account_api_request(
+          :delete,
+          "/api/oidc-users/#{subject_identifier}",
+          response_status: 404,
+        )
+      end
+
       ###########################################
       # PATCH /api/oidc-users/:subject_identifier
       ###########################################
@@ -138,7 +166,7 @@ module GdsApi
         )
       end
 
-      def stub_account_api_get_email_subscription_unauthorized(name:, **options)
+      def stub_account_api_unauthorized_get_email_subscription(name:, **options)
         stub_account_api_request(
           :get,
           "/api/email-subscriptions/#{name}",
@@ -205,79 +233,6 @@ module GdsApi
         )
       end
 
-      ################################################
-      # GET /api/transition-checker-email-subscription
-      ################################################
-      def stub_account_api_has_email_subscription(**options)
-        stub_account_api_request(
-          :get,
-          "/api/transition-checker-email-subscription",
-          response_body: { has_subscription: true },
-          **options,
-        )
-      end
-
-      def stub_account_api_does_not_have_email_subscription(**options)
-        stub_account_api_request(
-          :get,
-          "/api/transition-checker-email-subscription",
-          response_body: { has_subscription: false },
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_get_email_subscription(**options)
-        stub_account_api_request(
-          :get,
-          "/api/transition-checker-email-subscription",
-          response_status: 401,
-          **options,
-        )
-      end
-
-      def stub_account_api_forbidden_get_email_subscription(needed_level_of_authentication: "level1", **options)
-        stub_account_api_request(
-          :get,
-          "/api/transition-checker-email-subscription",
-          response_status: 403,
-          response_body: { needed_level_of_authentication: needed_level_of_authentication },
-          **options,
-        )
-      end
-
-      #################################################
-      # POST /api/transition-checker-email-subscription
-      #################################################
-      def stub_account_api_set_email_subscription(slug: nil, **options)
-        stub_account_api_request(
-          :post,
-          "/api/transition-checker-email-subscription",
-          with: { body: hash_including({ slug: slug }.compact) },
-          **options,
-        )
-      end
-
-      def stub_account_api_unauthorized_set_email_subscription(slug: nil, **options)
-        stub_account_api_request(
-          :post,
-          "/api/transition-checker-email-subscription",
-          with: { body: hash_including({ slug: slug }.compact) },
-          response_status: 401,
-          **options,
-        )
-      end
-
-      def stub_account_api_forbidden_set_email_subscription(slug: nil, needed_level_of_authentication: "level1", **options)
-        stub_account_api_request(
-          :post,
-          "/api/transition-checker-email-subscription",
-          with: { body: hash_including({ slug: slug }.compact) },
-          response_status: 403,
-          response_body: { needed_level_of_authentication: needed_level_of_authentication },
-          **options,
-        )
-      end
-
       #####################
       # GET /api/attributes
       #####################
@@ -345,40 +300,6 @@ module GdsApi
         )
       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
       ######################
@@ -507,7 +428,7 @@ module GdsApi
         )
       end
 
-      def stub_account_api_delete_saved_page_unauthorised(page_path:, **options)
+      def stub_account_api_unauthorized_delete_saved_page(page_path:, **options)
         stub_account_api_request(
           :delete,
           "/api/saved-pages/#{CGI.escape(page_path)}",

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "71.9.0".freeze
+  VERSION = "73.1.0".freeze
 end

metadata

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