notifications-ruby-client 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a8a364fe112385dd966dc7d1c694596b5c7e786cb9c88e15f44fdf077868dc
-  data.tar.gz: 4e9dab5c9f3c1162acd687f5281855e6e62b019bafdd3b80b41fd2d524dca431
+  metadata.gz: 0f795202efa7a08dc79833a2c1ff7aec35a7deadf495c8380e290bff1c11189f
+  data.tar.gz: 0e938bb4e2a4ed8d516766131192ef8a7acae0de5dee6d25a69cdfbfe1673456
 SHA512:
-  metadata.gz: d2d76d657dfaaf195cf47fc547f03cd43070e639e5aa4cb0e83c4704593e59a77af37ffdac614eb8f6167935497f8b7c3a5cc9788ee41b169817b9c8df38ff0d
-  data.tar.gz: 8c7be5c4533ce2e475bdde4db8aea698339bb6f940fa6f71825c7e28299c53c0feebd513d209239a1dae56caf4502ebc8a4cfc5ec6f0f1afe38a08205bccdf6d
+  metadata.gz: b910c3bf6d1e115763bc4e88db202dc33a4d633439e26b5599aab48b5a5d1260cf34ebc4b4f494a911b5d039dc4b4cff2620589ee82e7d73ddfda0b9c35c7429
+  data.tar.gz: 28aef4fdb14d28c0100262fa583eaab52e9f7d949490405f13a1c5e351afa8326956f262fbe30a7a9029400f3be16e1638673dea057fff6e4746be2510eb3c4b

data/.dockerignore

@@ -1 +1,2 @@
+**/.git/*
 environment*.sh

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 6.4.0
+
+* Add support for the optional `sanitise_content_for` parameter when sending email (list of personalisation placeholder keys to sanitise for Markdown). Documented on `Notifications::Client::Speaker#post`.
+* Add `sanitised_content` to the send-email response object (`Notifications::Client::ResponseNotification`). The API returns a JSON object (Ruby `Hash`): keys are personalisation placeholder names, and each value is another object with `unsanitised` and `sanitised` for placeholders that were rewritten; the object is empty when nothing changed. If the key is absent from the JSON, the client exposes `nil`.
+
 ## 6.3.0
 * Update dependencies
   * Permit the `jwt` gem to be upgraded to version 3

data/bin/test_client.rb

@@ -112,7 +112,8 @@ def test_send_email_endpoint(client)
     personalisation: { "name" => "some name" },
     reference: "some reference",
     email_reply_to_id: ENV['EMAIL_REPLY_TO_ID'],
-    one_click_unsubscribe_url: "https://www.clovercouncil.gov.uk/unsubscribe?email_address=faye@example.com"
+    one_click_unsubscribe_url: "https://www.clovercouncil.gov.uk/unsubscribe?email_address=faye@example.com",
+    sanitise_content_for: ["name"]
   )
   test_notification_response_data_type(email_resp, 'email')
   email_resp
@@ -186,6 +187,10 @@ def test_notification_response_data_type(notification, message_type)
 
   if message_type == 'email'
     hash_key_should_not_be_nil(expected_fields_in_email_content, notification.send('content'), 'send_' + message_type + '.content')
+    unless sanitised_content_matches_email_send_api_response?(notification.sanitised_content)
+      raise 'contract test failed: sanitised_content should be a JSON object whose keys are placeholder names ' \
+            'and whose values are objects with unsanitised and sanitised (see notifications-api post v2/email response)'
+    end
   elsif message_type == 'sms'
     hash_key_should_not_be_nil(expected_fields_in_sms_content, notification.send('content'), 'send_' + message_type + '.content')
   elsif message_type == 'letter'
@@ -250,6 +255,19 @@ def test_get_pdf_for_letter(client, id)
   raise "get_pdf_for_letter response for #{id} is not a PDF: #{response}" unless response.start_with?('%PDF-')
 end
 
+# POST /v2/notifications/email merges sanitised_content from the API: a JSON object mapping each changed
+# placeholder to { "unsanitised" => ..., "sanitised" => ... }. It is {} when no placeholders differ.
+def sanitised_content_matches_email_send_api_response?(sanitised_content)
+  return false unless sanitised_content.is_a?(Hash)
+
+  sanitised_content.all? do |placeholder_key, entry|
+    placeholder_key.is_a?(String) &&
+      entry.is_a?(Hash) &&
+      entry.key?('unsanitised') &&
+      entry.key?('sanitised')
+  end
+end
+
 def hash_key_should_not_be_nil(fields, obj, method_name)
   fields.each do |field|
     if obj.has_value?(:"#{field}")

data/lib/notifications/client/response_notification.rb

@@ -7,6 +7,7 @@ module Notifications
       content
       template
       uri
+      sanitised_content
     ).freeze
 
       attr_reader(*FIELDS)

data/lib/notifications/client/speaker.rb

@@ -49,6 +49,8 @@ module Notifications
       #   id of the sender to be used for an sms notification
       # @option form_data [String] :one_click_unsubscribe_url
       #   link that end user can click to unsubscribe from the distribution list. We will pass this link in the email headers.
+      # @option form_data [Array<String>] :sanitise_content_for
+      #   email only: optional list of personalisation placeholder keys to sanitise for Markdown before the template is rendered.
       # @see #perform_request!
       def post(kind, form_data)
         request = Net::HTTP::Post.new(

data/lib/notifications/client/version.rb

@@ -9,6 +9,6 @@
 
 module Notifications
   class Client
-    VERSION = "6.3.0".freeze
+    VERSION = "6.4.0".freeze
   end
 end

data/lib/notifications/client.rb

@@ -30,7 +30,8 @@ module Notifications
     end
 
     ##
-    # @see Notifications::Client::Speaker#post
+    # @see Notifications::Client::Speaker#post
+    # Optional email-only keys are documented on {Notifications::Client::Speaker#post}.
     # @return [ResponseNotification]
     def send_email(args)
       ResponseNotification.new(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-09-25 00:00:00.000000000 Z
+date: 2026-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt