notifications-ruby-client 6.2.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bed01407fc2e19df7f65f9be76877f250bda03e9c7db644bfa86b7d83342f67
-  data.tar.gz: cf02533dcabab2d337aac521e338845d587417d25d238d5bc549feccc99b79e2
+  metadata.gz: 0f795202efa7a08dc79833a2c1ff7aec35a7deadf495c8380e290bff1c11189f
+  data.tar.gz: 0e938bb4e2a4ed8d516766131192ef8a7acae0de5dee6d25a69cdfbfe1673456
 SHA512:
-  metadata.gz: a1f891ddcaf3120c3ab90f01b990178e879c0e785fe27734b017bdaa990a04fc430ed25e5d0b27ed3e6eed5b42a9022fa6dac34e3d7d2ecaae1f2112a6051838
-  data.tar.gz: ea20265635c620d5ee7873e6cce5dd8983db0a3489b4aecb9f09122a4c49d07a3a90f1a1eca1e29bb4bf5df0634e856c67c631c9fc0e416439ceb5976e769876
+  metadata.gz: b910c3bf6d1e115763bc4e88db202dc33a4d633439e26b5599aab48b5a5d1260cf34ebc4b4f494a911b5d039dc4b4cff2620589ee82e7d73ddfda0b9c35c7429
+  data.tar.gz: 28aef4fdb14d28c0100262fa583eaab52e9f7d949490405f13a1c5e351afa8326956f262fbe30a7a9029400f3be16e1638673dea057fff6e4746be2510eb3c4b

data/.dockerignore

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

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 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
+  * Remove the `bundler` gem dependency
+  * Allow the `factory_bot` gem to be upgraded whilst keeping the restriction in place for Ruby versions below 3
+
 ## 6.2.0
 * Added fields related to cost data in response:
   * `is_cost_data_ready`: This field is true if cost data is ready, and false if it isn't (Boolean).

data/Dockerfile

@@ -4,11 +4,13 @@ RUN \
 	echo "Install Debian packages" \
 	&& apt-get update \
 	&& apt-get install -y --no-install-recommends \
+		awscli \
 		gcc \
 		make \
 		curl \
 		git \
-    gnupg
+		gnupg \
+		jq
 
 WORKDIR /var/project
 

data/bin/test_client.rb

@@ -24,7 +24,6 @@ def main
   test_get_received_texts
   test_get_pdf_for_letter(client, letter_notification.id)
   p 'ruby client integration tests pass'
-  exit 0
 end
 
 def test_get_email_template_by_id(client, id)
@@ -50,27 +49,23 @@ end
 def test_get_all_templates(client)
   response = client.get_all_templates
   unless response.is_a?(Notifications::Client::TemplateCollection)
-    p 'failed test_get_all_templates response is not a Notifications::Client::TemplateCollection'
-    exit 1
+    raise 'failed test_get_all_templates response is not a Notifications::Client::TemplateCollection'
   end
   unless response.collection.length >= 3
-    p 'failed test_get_all_templates, expected at least 3 templates returned.'
-    exit 1
+    raise 'failed test_get_all_templates, expected at least 3 templates returned.'
   end
-  test_template_response(response.collection[0], 'letter', 'test_get_all_templates')
-  test_template_response(response.collection[1], 'email', 'test_get_all_templates')
-  test_template_response(response.collection[2], 'sms', 'test_get_all_templates')
+  test_template_response(response.collection.find { |template| template.id == ENV['LETTER_TEMPLATE_ID'] }, 'letter', 'test_get_all_templates')
+  test_template_response(response.collection.find { |template| template.id == ENV['EMAIL_TEMPLATE_ID'] }, 'email', 'test_get_all_templates')
+  test_template_response(response.collection.find { |template| template.id == ENV['SMS_TEMPLATE_ID'] }, 'sms', 'test_get_all_templates')
 end
 
 def test_get_all_templates_filter_by_type(client)
   response = client.get_all_templates('type' => 'sms')
   unless response.is_a?(Notifications::Client::TemplateCollection)
-    p 'failed test_get_all_templates response is not a Notifications::Client::TemplateCollection'
-    exit 1
+    raise 'failed test_get_all_templates response is not a Notifications::Client::TemplateCollection'
   end
   unless response.collection.length >= 1
-    p 'failed test_get_all_templates, expected at least 2 templates returned.'
-    exit 1
+    raise 'failed test_get_all_templates, expected at least 1 template to be returned.'
   end
   test_template_response(response.collection[0], 'sms', 'test_get_all_templates')
 end
@@ -82,12 +77,10 @@ end
 
 def test_template_response(response, template_type, test_method)
   unless response.is_a?(Notifications::Client::Template)
-    p 'failed test_get_template_by_id response is not a Notifications::Client::Template'
-    exit 1
+    raise 'failed test_get_template_by_id response is not a Notifications::Client::Template'
   end
   unless response.id.is_a?(String)
-    p 'failed template id is not a String'
-    exit 1
+    raise 'failed template id is not a String'
   end
 
   field_should_not_be_nil(
@@ -104,12 +97,10 @@ end
 
 def test_template_preview(response)
   unless response.is_a?(Notifications::Client::TemplatePreview)
-    p 'failed test_generate_template_preview response is not a Notifications::Client::TemplatePreview'
-    exit 1
+    raise 'failed test_generate_template_preview response is not a Notifications::Client::TemplatePreview'
   end
   unless response.id.is_a?(String)
-    p 'failed template id is not a String'
-    exit 1
+    raise 'failed template id is not a String'
   end
   field_should_not_be_nil(expected_fields_in_template_preview, response, 'generate_template_preview')
 end
@@ -121,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
@@ -176,19 +168,16 @@ end
 
 def test_notification_response_data_type(notification, message_type)
   unless notification.is_a?(Notifications::Client::ResponseNotification) || (notification.is_a?(Notifications::Client::ResponsePrecompiledLetter) && message_type == "precompiled_letter")
-    p 'failed ' + message_type + ' response is not a Notifications::Client::ResponseNotification'
-    exit 1
+    raise 'failed ' + message_type + ' response is not a Notifications::Client::ResponseNotification'
   end
   unless notification.id.is_a?(String)
-    p 'failed ' + message_type + 'id is not a String'
-    exit 1
+    raise 'failed ' + message_type + 'id is not a String'
   end
 
   if message_type == 'precompiled_letter'
     field_should_not_be_nil(expected_fields_in_precompiled_letter_response, notification, 'send_precompiled_letter')
     if notification.postage != "first"
-      p "Postage should be set to 'first' for precompiled letter sending test. Right now it is set to #{notification.postage}"
-      exit 1
+      raise "Postage should be set to 'first' for precompiled letter sending test. Right now it is set to #{notification.postage}"
     end
     return
   end
@@ -198,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'
@@ -206,68 +199,93 @@ def test_notification_response_data_type(notification, message_type)
 end
 
 def test_get_notification_by_id_endpoint(client, id, message_type)
-  get_notification_response = client.get_notification(id)
+  get_notification_response = nil
+  24.times do
+    get_notification_response = client.get_notification(id)
+    break if get_notification_response&.is_cost_data_ready
+    sleep 5
+  end
+
+  raise "cost data didn't become ready in time" unless get_notification_response&.is_cost_data_ready
 
   unless get_notification_response.is_a?(Notifications::Client::Notification)
-    p 'get notification is not a Notifications::Client::Notification for id ' + id
-    exit 1
+    raise 'get notification is not a Notifications::Client::Notification for id ' + id
   end
 
   if message_type == 'email'
     field_should_not_be_nil(expected_fields_in_email_notification, get_notification_response, 'Notifications::Client::Notification for type email')
     field_should_be_nil(expected_fields_in_email_notification_that_are_nil, get_notification_response, 'Notifications::Client::Notification for type email')
     hash_key_should_not_be_nil(expected_fields_in_template, get_notification_response.send('template'), 'Notifications::Client::Notification.template for type email')
+    hash_should_be_empty(get_notification_response.send('cost_details'), 'Notifications::Client::Notification.cost_details for type sms')
+
   elsif message_type == 'sms'
     field_should_not_be_nil(expected_fields_in_sms_notification, get_notification_response, 'Notifications::Client::Notification for type sms')
     field_should_be_nil(expected_fields_in_sms_notification_that_are_nil, get_notification_response, 'Notifications::Client::Notification for type sms')
     hash_key_should_not_be_nil(expected_fields_in_template, get_notification_response.send('template'), 'Notifications::Client::Notification.template for type sms')
+    hash_key_should_not_be_nil(expected_cost_details_fields, get_notification_response.send('cost_details'), 'Notifications::Client::Notification.cost_details for type sms')
+
   elsif message_type == 'letter'
     field_should_not_be_nil(expected_fields_in_letter_notification, get_notification_response, 'Notifications::Client::Notification for type letter')
     field_should_be_nil(expected_fields_in_letter_notification_that_are_nil, get_notification_response, 'Notifications::Client::Notification for type letter')
     hash_key_should_not_be_nil(expected_fields_in_template, get_notification_response.send('template'), 'Notifications::Client::Notification.template for type letter')
+    hash_key_should_not_be_nil(expected_cost_details_fields, get_notification_response.send('cost_details'), 'Notifications::Client::Notification.cost_details for type sms')
+
   elsif message_type == 'precompiled_letter'
     field_should_not_be_nil(expected_fields_in_precompiled_letter_notification, get_notification_response, 'Notifications::Client::Notification for type precompiled letter')
     field_should_be_nil(expected_fields_in_precompiled_letter_notification_that_are_nil, get_notification_response, 'Notifications::Client::Notification for type precompiled letter')
     hash_key_should_not_be_nil(expected_fields_in_template, get_notification_response.send('template'), 'Notifications::Client::Notification.template for type precompiled letter')
+    hash_key_should_not_be_nil(expected_cost_details_fields, get_notification_response.send('cost_details'), 'Notifications::Client::Notification.cost_details for type sms')
+
   end
 end
 
 def test_get_pdf_for_letter(client, id)
   response = nil
 
-  # try 15 times with 3 secs sleep between each attempt, to get the PDF
-  15.times do
+  24.times do
     begin
       response = client.get_pdf_for_letter(id)
-    rescue Notifications::Client::BadRequestError
-      sleep(3)
-    end
-
-    if !response.nil?
       break
+    rescue Notifications::Client::BadRequestError
+      sleep(5)
     end
   end
 
-  unless !response.nil? && response.start_with?("%PDF-")
-    p "get_pdf_for_letter response for " + id + " is not a PDF: " + response.to_s
-    exit 1
+  raise "pdf didn't become ready in time" if response.nil?
+  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}")
-      p 'contract test failed because ' + field + ' should not be nil for ' + method_name + ' response'
-      exit 1
+      raise 'contract test failed because ' + field + ' should not be nil for ' + method_name + ' response'
     end
   end
 end
 
+def hash_should_be_empty(hash, method_name)
+  if !hash.empty?
+      raise "contract test failed because #{hash} should be empty for #{method_name} response"
+  end
+end
+
 def field_should_not_be_nil(fields, obj, method_name)
   fields.each do |field|
     if obj.send(:"#{field}") == nil
-      p 'contract test failed because ' + field + ' should not be nil for ' + method_name + ' response'
-      exit 1
+      raise 'contract test failed because ' + field + ' should not be nil for ' + method_name + ' response'
     end
   end
 end
@@ -275,8 +293,7 @@ end
 def field_should_be_nil(fields, obj, method_name)
   fields.each do |field|
     if obj.send(:"#{field}") != nil
-      p 'contract test failed because ' + field + ' should be nil for ' + method_name + ' response'
-      exit 1
+      raise 'contract test failed because ' + field + ' should be nil for ' + method_name + ' response'
     end
   end
 end
@@ -348,7 +365,11 @@ def expected_fields_in_email_notification
      body
      subject
      created_at
-     one_click_unsubscribe_url)
+     one_click_unsubscribe_url
+     is_cost_data_ready
+     cost_in_pounds
+     cost_details
+     )
 end
 
 def expected_fields_in_email_notification_that_are_nil
@@ -372,7 +393,10 @@ def expected_fields_in_sms_notification
      status
      template
      body
-     created_at)
+     created_at
+     is_cost_data_ready
+     cost_in_pounds
+     cost_details)
 end
 
 def expected_fields_in_sms_notification_that_are_nil
@@ -404,6 +428,9 @@ def expected_fields_in_letter_notification
     postcode
     created_at
     postage
+    is_cost_data_ready
+    cost_in_pounds
+    cost_details
   )
 end
 
@@ -438,7 +465,6 @@ end
 
 def expected_fields_in_precompiled_letter_notification_that_are_nil
   %w(
-    completed_at
     created_by_name
     email_address
     line_2
@@ -459,6 +485,14 @@ def expected_fields_in_template
      uri)
 end
 
+def expected_cost_details_fields
+  %w(billable_sms_fragments
+     international_rate_multiplier
+     sms_rate
+     billable_sheets_of_paper
+     postage)
+end
+
 def expected_fields_in_received_text_response
   %w(id
      created_at
@@ -471,8 +505,7 @@ end
 def test_get_all_notifications(client)
   notifications = client.get_notifications
   unless notifications.is_a?(Notifications::Client::NotificationsCollection)
-    p 'get all notifications is not Notifications::Client::NotificationsCollection'
-    exit 1
+    raise 'get all notifications is not Notifications::Client::NotificationsCollection'
   end
   field_should_not_be_nil(expected_fields_for_get_all_notifications, notifications, 'get_notifications')
 end
@@ -481,26 +514,20 @@ def test_get_received_texts
   client = Notifications::Client.new(ENV['INBOUND_SMS_QUERY_KEY'], ENV['NOTIFY_API_URL'])
   response = client.get_received_texts
   unless response.is_a?(Notifications::Client::ReceivedTextCollection)
-    p 'failed test_get_received_texts response is not a Notifications::Client::ReceivedTextCollection'
-    exit 1
+    raise 'failed test_get_received_texts response is not a Notifications::Client::ReceivedTextCollection'
   end
   unless response.collection.length >= 0
-    p 'failed test_get_received_texts, expected at least 1 received text returned.'
-    exit 1
+    raise 'failed test_get_received_texts, expected at least 1 received text returned.'
   end
   test_received_text_response(response.collection[0], 'test_received_text_response')
-  test_received_text_response(response.collection[1], 'test_received_text_response')
-  test_received_text_response(response.collection[2], 'test_received_text_response')
 end
 
 def test_received_text_response(response, test_method)
   unless response.is_a?(Notifications::Client::ReceivedText)
-    p 'failed test_get_received_texts response is not a Notifications::Client::ReceivedText'
-    exit 1
+    raise 'failed test_get_received_texts response is not a Notifications::Client::ReceivedText'
   end
   unless response.id.is_a?(String)
-    p 'failed received text id is not a String'
-    exit 1
+    raise 'failed received text id is not a String'
   end
   field_should_not_be_nil(expected_fields_in_received_text_response, response, test_method)
 end

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.2.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(

data/notifications-ruby-client.gemspec

@@ -20,11 +20,14 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "jwt", ">= 1.5", "< 3"
+  spec.add_runtime_dependency "jwt", ">= 1.5", "< 4"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.7"
   spec.add_development_dependency "webmock", "~> 3.4"
-  spec.add_development_dependency "factory_bot", "~> 6.1", "<6.4.5"
+  if RUBY_VERSION < '3.0.0'
+    spec.add_development_dependency "factory_bot", "~> 6.1", "< 6.4.5"
+  else
+    spec.add_development_dependency "factory_bot", "~> 6.1"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-31 00:00:00.000000000 Z
+date: 2026-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -19,7 +19,7 @@ dependencies:
         version: '1.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,21 +29,7 @@ dependencies:
         version: '1.5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement