notifications-ruby-client 6.3.0 → 6.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a8a364fe112385dd966dc7d1c694596b5c7e786cb9c88e15f44fdf077868dc
-  data.tar.gz: 4e9dab5c9f3c1162acd687f5281855e6e62b019bafdd3b80b41fd2d524dca431
+  metadata.gz: a729f4a4babb045a13f1b649025a786220afd9e72f1c919f30deaf256e1c9560
+  data.tar.gz: 5bbc31ccee18125aae5fcf9635f034c3658f3aa7aee2c6096ce2a310c824890d
 SHA512:
-  metadata.gz: d2d76d657dfaaf195cf47fc547f03cd43070e639e5aa4cb0e83c4704593e59a77af37ffdac614eb8f6167935497f8b7c3a5cc9788ee41b169817b9c8df38ff0d
-  data.tar.gz: 8c7be5c4533ce2e475bdde4db8aea698339bb6f940fa6f71825c7e28299c53c0feebd513d209239a1dae56caf4502ebc8a4cfc5ec6f0f1afe38a08205bccdf6d
+  metadata.gz: ea1ad32ca2113e6e6cd2a8760bf25543ddfb16bc6e38a3f54d4cc4b1aba71877ec5e2ec19aba6392d418c68f1f0dca5d12c3b82b93721410ed560280698de157
+  data.tar.gz: e87702a7c357460cfa659cc0c5d2a283a82e3fa8437bd385bbccf9ea0514e6bce3f80ea1066da0fd08ff3437fe52997e5d18a4a617a5ca9f4313fbefdd29cf9e

data/.dockerignore

@@ -1 +1,3 @@
+**/.git/*
 environment*.sh
+Gemfile.lock

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 6.5.1
+
+* Same contents as 6.5.0. That version was never published because the CI image failed to build after Debian 11 LTS ended.
+* Move the CI Docker image from `ruby:2.6-slim` (Debian 11) to `ruby:3.4-slim`. This does not change the gem for users.
+
+## 6.5.0
+
+* Add `personalisation` to the `Notifications::Client::Template` object returned by `get_template_by_id`, `get_template_version` and `get_all_templates`. This is a hash of placeholder names, for example `{"name" => {"required" => true}}`.
+* Not published to RubyGems. Use 6.5.1.
+
+## 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/Dockerfile

@@ -1,12 +1,11 @@
-FROM ruby:2.6-slim
+FROM ruby:3.4-slim
 
 RUN \
 	echo "Install Debian packages" \
 	&& apt-get update \
 	&& apt-get install -y --no-install-recommends \
 		awscli \
-		gcc \
-		make \
+		build-essential \
 		curl \
 		git \
 		gnupg \

data/Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source 'https://rubygems.org', cooldown: 7
 
 gemspec

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/response_template.rb

@@ -14,6 +14,7 @@ module Notifications
         body
         subject
         letter_contact_block
+        personalisation
       ).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.5.1".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,13 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.5.1
 platform: ruby
 authors:
 - Government Digital Service
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-09-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -79,9 +78,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -89,10 +85,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 6.4.5
-description: 
 email:
 - notify@digital.cabinet-office.gov.uk
 executables: []
@@ -135,7 +127,6 @@ files:
 homepage: https://github.com/alphagov/notifications-ruby-client
 licenses: []
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby client for GOV.UK Notifications API
 test_files: []