gds-api-adapters 71.3.0 → 71.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea739e39026f239c010c4810ba88c6c0f8f77a0fb2375e24c9026cd2a388465e
-  data.tar.gz: c18db19adc96aab183ab99edfc30db4691d7ab5d055def3fbcfc406f6b16c1a8
+  metadata.gz: d1bcd6f2192952444f80e49762cc4d1e2820c767162d194de9ce6c0f1b78ad2c
+  data.tar.gz: cc96d6dc6f18b3ec2a58187977147b8be0bf6025e7a47c4b55671f2ab900c78f
 SHA512:
-  metadata.gz: 1b03304634769b69d8549664720619081836366bacb76948e19275751b0f4d2482f0adf14977b82569e4e265b081e590c338f9a2167e78170bab9af0f8c27a68
-  data.tar.gz: b5dfc1690a1e783e67bf350d2d5fb8d66c9aa0eaaa758bdbb7be381cd34a76780de465c9bfc78b539c9712ba3e6b586788f7139edab07aa8fab7ea2d6ae974f9
+  metadata.gz: 2b0911632959b5c61c22ca3c5f208bd69d8cd6db5984fe83c4912251d38f1e895f8a90eda372de721a9f85a59af4931517eb468c3a23d554d9d3a9e4ecd24734
+  data.tar.gz: 1ed0f2a61ed3833a05283684a443ae148324ae22e92daa49e14982af4e908ea5e4f96cda2f74ad20bedae96fdad3d4641fee09c01b958fd63e53190e319b7357

data/lib/gds_api/account_api.rb

@@ -54,6 +54,17 @@ class GdsApi::AccountApi < GdsApi::Base
     get_json("#{endpoint}/api/user", auth_headers(govuk_account_session))
   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.
+  # @param [String, nil] email The new email address
+  # @param [Boolean, nil] email_verified Whether the new email address is verified
+  #
+  # @return [Hash] The user's subject identifier and email attributes
+  def update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil)
+    patch_json("#{endpoint}/api/oidc-users/#{subject_identifier}", { email: email, email_verified: email_verified }.compact)
+  end
+
   # Check if a user has an email subscription for the Transition Checker
   #
   # @param [String] govuk_account_session Value of the session header
@@ -111,7 +122,7 @@ class GdsApi::AccountApi < GdsApi::Base
   #
   # @return [Hash] containing :saved_pages, an array of single saved page hashes  def get_saved_pages(govuk_account_session:)
   def get_saved_pages(govuk_account_session:)
-    get_json("#{endpoint}/api/saved_pages", auth_headers(govuk_account_session))
+    get_json("#{endpoint}/api/saved-pages", auth_headers(govuk_account_session))
   end
 
   # Return a single page by unique URL
@@ -121,7 +132,7 @@ class GdsApi::AccountApi < GdsApi::Base
   #
   # @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))
+    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
@@ -131,7 +142,7 @@ class GdsApi::AccountApi < GdsApi::Base
   #
   # @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))
+    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
@@ -142,7 +153,7 @@ class GdsApi::AccountApi < GdsApi::Base
   # @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))
+    delete_json("#{endpoint}/api/saved-pages/#{CGI.escape(page_path)}", {}, auth_headers(govuk_account_session))
   end
 
 private

data/lib/gds_api/test_helpers/account_api.rb

@@ -69,6 +69,19 @@ module GdsApi
         )
       end
 
+      def stub_update_user_by_subject_identifier(subject_identifier:, email: nil, email_verified: nil, old_email: nil, old_email_verified: nil)
+        stub_account_api_request(
+          :patch,
+          "/api/oidc-users/#{subject_identifier}",
+          with: { body: hash_including({ email: email, email_verified: email_verified }.compact) },
+          response_body: {
+            sub: subject_identifier,
+            email: email || old_email,
+            email_verified: email_verified || old_email_verified,
+          },
+        )
+      end
+
       def stub_account_api_has_email_subscription(**options)
         stub_account_api_request(
           :get,
@@ -240,12 +253,12 @@ module GdsApi
       end
 
       ######################
-      # GET /api/saved_pages
+      # GET /api/saved-pages
       ######################
       def stub_account_api_returning_saved_pages(saved_pages: [], **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages",
+          "/api/saved-pages",
           response_body: { saved_pages: saved_pages },
           **options,
         )
@@ -254,7 +267,7 @@ module GdsApi
       def stub_account_api_unauthorized_get_saved_pages(**options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages",
+          "/api/saved-pages",
           response_status: 401,
           **options,
         )
@@ -266,7 +279,7 @@ module GdsApi
       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)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_body: {
             saved_page: {
               page_path: page_path,
@@ -281,7 +294,7 @@ module GdsApi
       def stub_account_api_does_not_have_saved_page(page_path:, **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 404,
           **options,
         )
@@ -290,19 +303,19 @@ module GdsApi
       def stub_account_api_unauthorized_get_saved_page(page_path:, **options)
         stub_account_api_request(
           :get,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 401,
           **options,
         )
       end
 
       #################################
-      # PUT /api/saved_pages/:page_path
+      # 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)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_body: {
             saved_page: {
               page_path: page_path,
@@ -321,7 +334,7 @@ module GdsApi
       def stub_account_api_save_page_cannot_save_page(page_path:, **options)
         stub_account_api_request(
           :put,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 422,
           response_body: cannot_save_page_problem_detail({ page_path: page_path }),
           **options,
@@ -331,7 +344,7 @@ module GdsApi
       def stub_account_api_unauthorized_save_page(page_path:, **options)
         stub_account_api_request(
           :put,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 401,
           **options,
         )
@@ -352,7 +365,7 @@ module GdsApi
       def stub_account_api_delete_saved_page(page_path:, **options)
         stub_account_api_request(
           :delete,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 204,
           **options,
         )
@@ -361,7 +374,7 @@ module GdsApi
       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)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 404,
           **options,
         )
@@ -370,7 +383,7 @@ module GdsApi
       def stub_account_api_delete_saved_page_unauthorised(page_path:, **options)
         stub_account_api_request(
           :delete,
-          "/api/saved_pages/#{CGI.escape(page_path)}",
+          "/api/saved-pages/#{CGI.escape(page_path)}",
           response_status: 401,
           **options,
         )

data/lib/gds_api/version.rb

@@ -1,3 +1,3 @@
 module GdsApi
-  VERSION = "71.3.0".freeze
+  VERSION = "71.4.0".freeze
 end

metadata

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