notifications-ruby-client 5.4.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6827c0db7ff51cabb102005e382e49fb225344a2856b11f85dc4edc799b9d9a9
-  data.tar.gz: 222318524a806a4ce707cdc3fff989b6d91f28fffa106fe9235584d14b1cd2f1
+  metadata.gz: 3bed01407fc2e19df7f65f9be76877f250bda03e9c7db644bfa86b7d83342f67
+  data.tar.gz: cf02533dcabab2d337aac521e338845d587417d25d238d5bc549feccc99b79e2
 SHA512:
-  metadata.gz: ef8a9234c0e8a4730d9ce2561d35261882903090bbaeaaad29540b36a1622c77ff0953d395ed0976093e962cae92cd304f2ace1579ce41d5b3e70553528ee1d5
-  data.tar.gz: 44f09776241452471cacea7cec73bfa4ab158ed24f5a4a631bcdf747923cd18f66f34b0e8742dcc036dd2f4dd646dbc3a095e24736cac10452d4dc555105b4f9
+  metadata.gz: a1f891ddcaf3120c3ab90f01b990178e879c0e785fe27734b017bdaa990a04fc430ed25e5d0b27ed3e6eed5b42a9022fa6dac34e3d7d2ecaae1f2112a6051838
+  data.tar.gz: ea20265635c620d5ee7873e6cce5dd8983db0a3489b4aecb9f09122a4c49d07a3a90f1a1eca1e29bb4bf5df0634e856c67c631c9fc0e416439ceb5976e769876

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -8,5 +8,7 @@
 <!--- All of the following are normally needed. Don’t worry if you haven’t done them or don’t know how – someone from the Notify team will be able to help. -->
 - [x] I’ve used the pull request template
 - [ ] I’ve written unit tests for these changes
-- [ ] I’ve updated the documentation (in `DOCUMENTATION.md`)
+- [ ] I’ve updated the documentation in
+  - [ ] [notifications-tech-docs repository](https://github.com/alphagov/notifications-tech-docs/blob/main/source/documentation/client_docs/_ruby.md)
+  - [ ] `CHANGELOG.md`
 - [ ] I’ve bumped the version number (in `lib/notifications/client/version.rb`)

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 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).
+  * `cost_in_pounds`: Cost of the notification in pounds. The cost does not take free allowance into account (Float).
+  * `cost_details.billable_sms_fragments`: Number of billable SMS fragments in your text message (SMS only) (Integer).
+  * `cost_details.international_rate_multiplier`: For international SMS rate is multiplied by this value (SMS only) (Integer).
+  * `cost_details.sms_rate`: Cost of 1 SMS fragment (SMS only) (Float).
+  * `cost_details.billable_sheets_of_paper`: Number of sheets of paper in the letter you sent, that you will be charged for (letter only) (Integer).
+  * `cost_details.postage`: Postage class of the notification sent (letter only) (String).
+
+## 6.1.0
+
+* Adds a `one_click_unsubscribe_url` parameter to `send_email` so services can allow users to easily unsubscribe from distribution lists.
+* Adds a `one_click_unsubscribe_url` attribute to `Notification` class, so responses for get_notification include the unsubscribe link.
+
+## 6.0.0
+
+* Removes the `is_csv` parameter from `prepare_upload`
+* Adds a `filename` parameter to `prepare_upload` to set the filename of the document upon download. See the documentation for more information.
+
 ## 5.4.0
 
 * Add support for new security features when sending a file by email:

data/README.md

@@ -6,5 +6,5 @@ Useful links:
 
 - [Documentation](https://docs.notifications.service.gov.uk/ruby.html)
 - [Ruby gem](https://rubygems.org/gems/notifications-ruby-client)
-- [Changelog](https://github.com/alphagov/notifications-ruby-client/blob/master/CHANGELOG.md)
-- [Contributing to this client](https://github.com/alphagov/notifications-ruby-client/blob/master/CONTRIBUTING.md)
+- [Changelog](https://github.com/alphagov/notifications-ruby-client/blob/main/CHANGELOG.md)
+- [Contributing to this client](https://github.com/alphagov/notifications-ruby-client/blob/main/CONTRIBUTING.md)

data/bin/test_client.rb

@@ -115,11 +115,14 @@ def test_template_preview(response)
 end
 
 def test_send_email_endpoint(client)
-  email_resp = client.send_email(email_address: ENV['FUNCTIONAL_TEST_EMAIL'],
-                                 template_id: ENV['EMAIL_TEMPLATE_ID'],
-                                 personalisation: { "name" => "some name" },
-                                 reference: "some reference",
-                                 email_reply_to_id: ENV['EMAIL_REPLY_TO_ID'])
+  email_resp = client.send_email(
+    email_address: ENV['FUNCTIONAL_TEST_EMAIL'],
+    template_id: ENV['EMAIL_TEMPLATE_ID'],
+    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"
+  )
   test_notification_response_data_type(email_resp, 'email')
   email_resp
 end
@@ -130,7 +133,8 @@ def test_send_email_endpoint_with_document(client)
       template_id: ENV['EMAIL_TEMPLATE_ID'],
       personalisation: { name: Notifications.prepare_upload(f) },
       reference: "some reference",
-      email_reply_to_id: ENV['EMAIL_REPLY_TO_ID'])
+      email_reply_to_id: ENV['EMAIL_REPLY_TO_ID'],
+      one_click_unsubscribe_url: "https://www.clovercouncil.gov.uk/unsubscribe?email_address=faye@example.com")
   end
 
   test_notification_response_data_type(email_resp, 'email')
@@ -319,7 +323,8 @@ end
 def expected_fields_in_email_content
   %w(from_email
      body
-     subject)
+     subject
+     one_click_unsubscribe_url)
 end
 
 def expected_fields_in_sms_content
@@ -342,7 +347,8 @@ def expected_fields_in_email_notification
      template
      body
      subject
-     created_at)
+     created_at
+     one_click_unsubscribe_url)
 end
 
 def expected_fields_in_email_notification_that_are_nil
@@ -381,7 +387,8 @@ def expected_fields_in_sms_notification_that_are_nil
      postcode
      subject
      created_by_name
-     postage)
+     postage
+     one_click_unsubscribe_url)
 end
 
 def expected_fields_in_letter_notification
@@ -410,6 +417,7 @@ def expected_fields_in_letter_notification_that_are_nil
     line_5
     line_6
     created_by_name
+    one_click_unsubscribe_url
   )
 end
 
@@ -441,6 +449,7 @@ def expected_fields_in_precompiled_letter_notification_that_are_nil
     phone_number
     postcode
     sent_at
+    one_click_unsubscribe_url
   )
 end
 

data/lib/notifications/client/helper_methods.rb

@@ -1,11 +1,12 @@
 require "base64"
 
 module Notifications
-  def self.prepare_upload(file, is_csv=false, confirm_email_before_download: nil, retention_period: nil)
+  def self.prepare_upload(file, filename: nil, confirm_email_before_download: nil, retention_period: nil)
     raise ArgumentError.new("File is larger than 2MB") if file.size > Client::MAX_FILE_UPLOAD_SIZE
 
-    data = { file: Base64.strict_encode64(file.read), is_csv: is_csv }
+    data = { file: Base64.strict_encode64(file.read) }
 
+    data[:filename] = filename
     data[:confirm_email_before_download] = confirm_email_before_download
     data[:retention_period] = retention_period
 

data/lib/notifications/client/notification.rb

@@ -25,6 +25,10 @@ module Notifications
         created_at
         completed_at
         created_by_name
+        one_click_unsubscribe_url
+        cost_in_pounds
+        is_cost_data_ready
+        cost_details
       ).freeze
 
       attr_reader(*FIELDS)

data/lib/notifications/client/speaker.rb

@@ -47,6 +47,8 @@ module Notifications
       #   id of the email address that replies to email notifications will be sent to
       # @option form_data [String] :sms_sender_id
       #   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.
       # @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 = "5.4.0".freeze
+    VERSION = "6.2.0".freeze
   end
 end

data/notifications-ruby-client.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "factory_bot", "~> 6.1", "<6.4.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 5.4.0
+  version: 6.2.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-06 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -93,6 +93,9 @@ 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
@@ -100,6 +103,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.4.5
 description: 
 email:
 - notify@digital.cabinet-office.gov.uk
@@ -114,7 +120,6 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
-- DOCUMENTATION.md
 - Dockerfile
 - Gemfile
 - LICENSE