gds-api-adapters 71.7.0 → 72.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1177b1955f1d71f876486faf8932550ff11330dbc69bfcf4b3e04eea88ce2fa
-  data.tar.gz: ca001da8d98cab308f0ce695aa46700c3c07d2fd2cd63e3ceea51868013ef4ed
+  metadata.gz: 51407d1cee42f0e1fbdf73f71f91f8e2b179adb56b81a9737ce26e334084644a
+  data.tar.gz: e8d397558f602abf5989795c92a2ec62880f0919d72897fde2e8e0ce83af2cdc
 SHA512:
-  metadata.gz: 75a3f20f1364ecf6d0e76f02622b95337b2ec4a8dbb2bc77e4a46a99787c855063454fe92835dee4b105b03ab066c2b0d85c16b98bb57bce0e34009aadbf9a4b
-  data.tar.gz: 282abe1e9269b6fa087f1a6e7205f49eef22f12670d3d7592f3a56acce50a97fab79c68a227be7d2b7a4a1e8e29cd1805738769d2a41e5399199a8c117352ee9
+  metadata.gz: 64ea0ab0af3fd9e4f4fe99a8bd8eab5179dc8216a2c45f4e76691150eaf8421d89ba197f923e56246ed5ed1292c49c5697e0c6c56043702e0a0cf1defd0fa402
+  data.tar.gz: 5a04715d1b8711171adb7d34cafc0f5f4ac499cf5157563c9f39c4fe949fef397ddbc1eab7a40eb9e5f355154cec76ff5b892d7f238515747390a3cb8ec82b3f

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,15 +34,6 @@ 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
-  #
-  # @param [Hash, nil] attributes Initial attributes to store
-  #
-  # @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)
-  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
@@ -54,6 +43,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 +68,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

data/lib/gds_api/email_alert_api.rb

@@ -156,10 +156,10 @@ class GdsApi::EmailAlertApi < GdsApi::Base
   # @param [string] Subscriber new_address
   #
   # @return [Hash] subscriber
-  def change_subscriber(id:, new_address:)
+  def change_subscriber(id:, new_address:, on_conflict: nil)
     patch_json(
       "#{endpoint}/subscribers/#{uri_encode(id)}",
-      new_address: new_address,
+      { new_address: new_address, on_conflict: on_conflict }.compact,
     )
   end
 

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,
@@ -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")
+      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)
         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 }.to_json,
+            body: { govuk_account_session: govuk_account_session, redirect_path: redirect_path, ga_client_id: ga_client_id, cookie_consent: cookie_consent }.to_json,
           )
       end
 
@@ -46,18 +46,6 @@ 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,
-          )
-      end
-
       ###############
       # GET /api/user
       ###############
@@ -94,6 +82,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 +146,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 +213,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
       #####################
@@ -507,7 +442,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/test_helpers/email_alert_api.rb

@@ -283,6 +283,11 @@ module GdsApi
           .to_return(status: 404)
       end
 
+      def stub_email_alert_api_subscriber_verification_email_linked_to_govuk_account
+        stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/auth-token")
+          .to_return(status: 403)
+      end
+
       def stub_email_alert_api_authenticate_subscriber_by_govuk_account(govuk_account_session, subscriber_id, address, govuk_account_id: "user-id", new_govuk_account_session: nil)
         stub_request(:post, "#{EMAIL_ALERT_API_ENDPOINT}/subscribers/govuk-account")
           .with(

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "71.7.0".freeze
+  VERSION = "72.1.0".freeze
 end

metadata

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