notifications-ruby-client 2.10.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 323f2b6f8d75d806a1a9cc63d33f21432791cb3bb806db047376071f819eacc7
-  data.tar.gz: 1bd9804348d562a43370f56b1dc00461b99dc5abe21fa5a73c74c8f8fe5cd684
+  metadata.gz: 3aa0a6d3a19753534e19441bc9bd6ac3e0dc1913d1a5dee660d629367ea85dd4
+  data.tar.gz: b760674b646a232fa7a0d6e6c844fef4488cd4fd582496f6380c3eaee861e520
 SHA512:
-  metadata.gz: e6640fb0a6781b566e55951f7d1a8cddf2b9d950780467404a57895f94e8d6c504e4b8883d6e424d9b7a85269a22caf535f05281c605f32cd4aa2ab490a1845b
-  data.tar.gz: f0c5ee819a5d1868a4055d19a1af026e2338a7b2bb1ca19478814d5bf18be2b09f8943cd0b02b839a3ee85f070a7e07afd3a2ba0dbc2e3ce3398d74157d3bdca
+  metadata.gz: 10593571a7496c3669361bc56bcdab4fe2e7075ab2a743b08e860894721b288c31d042a9c8f433122385373523a948b8cd53d78fc8cf374f314868708dbfef9e
+  data.tar.gz: 10ab2c60a4f94ce96e8da05a0b1d71205051c9655005948a7cf9b4ec08e9a42e775cbb2ce3dbebd440f4c4542754dd41ffa818a50c824d5d4314777589ea69e9

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.0.0
+
+* Changed response class for `send_precompiled_letter` request from `ResponseNotification` to a new response class: `ResponsePrecompiledLetter`. This may affect users sending precompiled letters.
+* Added an optional `postage` argument to `send_precompiled_letter` method, so users can specify postage when sending
+a precompiled letter via API.
+* Added postage to `Notification` class on the client.
+
 ## 2.10.0
 
 * Added subclasses of the `RequestError` class to handle specific types of errors.

data/DOCUMENTATION.md

@@ -215,7 +215,7 @@ This is an invitation-only feature. [Contact the GOV.UK Notify team](https://www
 
 To send a document by email, add a placeholder field to the template then upload a file. The placeholder field will contain a secure link to download the document.
 
-#### Add a placeholder field to the template
+### Add a placeholder field to the template
 
 1. Sign in to [GOV.UK Notify](https://www.notifications.service.gov.uk/).
 1. Go to the __Templates__ page and select the relevant email template.
@@ -223,7 +223,7 @@ To send a document by email, add a placeholder field to the template then upload
 
 "Download your document at: ((link_to_document))"
 
-#### Upload your document
+### Upload your document
 
 The document you upload must be a PDF file smaller than 2MB.
 
@@ -401,9 +401,14 @@ File.open("path/to/pdf_file", "rb") do |pdf_file|
 end
 ```
 
+#### postage (optional)
+
+You can choose first or second class postage for your precompiled letter. Set the value to `first` for first class, or `second` for second class. If you do not pass in this argument, the postage will default to second class.
+
+
 ### Response
 
-If the request to the client is successful, the client returns a `Notifications::Client:ResponseNotification` object. In the example shown in the [Method section](/ruby.html#send-a-pre-compiled-letter-method), the object is named `precompiled_letter`.
+If the request to the client is successful, the client returns a `Notifications::Client:ResponsePrecompiledLetter` object. In the example shown in the [Method section](/ruby.html#send-a-pre-compiled-letter-method), the object is named `precompiled_letter`.
 
 You can then call different methods on this object to return the requested information.
 
@@ -411,9 +416,8 @@ You can then call different methods on this object to return the requested infor
 |:---|:---|:---|
 |`precompiled_letter.id`|Notification UUID|String|
 |`precompiled_letter.reference`|`reference` argument|String|
-|`precompiled_letter.content`|Always `nil`|nil|
-|`precompiled_letter.template`|Always `nil`|nil|
-|`precompiled_letter.uri`|Always `nil`|nil|
+|`precompiled_letter.postage`|`postage` argument|String|
+
 
 ### Error codes
 
@@ -426,6 +430,7 @@ If the request is not successful, the client returns a `Notifications::Client::R
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Letter content is not a valid PDF"`<br>`]}`|`BadRequestError`|PDF file format is required|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Cannot send letters when service is in trial mode - see https://www.notifications.service.gov.uk/trial-mode"`<br>`}]`|`BadRequestError`|Your service cannot send this notification in [trial mode](https://www.notifications.service.gov.uk/features/using-notify#trial-mode)|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "reference is a required property"`<br>`}]`|`BadRequestError`|Add a `reference` argument to the method call|
+|`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "postage invalid. It must be either first or second."`<br>`}]`|`BadRequestError`|Change the value of `postage` argument in the method call to either 'first' or 'second'|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Service is not allowed to send precompiled letters"`<br>`}]`|`BadRequestError`|Contact the GOV.UK Notify team|
 |`429`|`[{`<br>`"error": "RateLimitError",`<br>`"message": "Exceeded rate limit for key type live of 10 requests per 20 seconds"`<br>`}]`|`RateLimitError`|Use the correct API key. Refer to [API keys](#api-keys) for more information|
 |`429`|`[{`<br>`"error": "TooManyRequestsError",`<br>`"message": "Exceeded send limits (50) for today"`<br>`}]`|`RateLimitError`|Refer to [service limits](#service-limits) for the limit number|
@@ -509,6 +514,7 @@ You can then call different methods on this object to return the requested infor
 |`response.line_5`|Recipient address line 5 of the address (letter only)|String|
 |`response.line_6`|Recipient address line 6 of the address (letter only)|String|
 |`response.postcode`|Recipient postcode (letter only)|String|
+|`response.postage`|Postage class of the notification sent (letter only)|String|
 |`response.type`|Type of notification sent (sms, email or letter)|String|
 |`response.status`|Notification status (sending / delivered / permanent-failure / temporary-failure / technical-failure)|String|
 |`response.template`|Template UUID|String|
@@ -694,7 +700,7 @@ You can then call different methods on this object to return the requested infor
 If the request is not successful, the client returns a `Notifications::Client::RequestError` and an error code:
 
 |error.code|error.message|class|How to fix|
-|:---|:---|:---|
+|:---|:---|:---|:---|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "id is not a valid UUID"`<br>`}]`|`BadRequestError`|Check the notification ID|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|`AuthError`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: signature, api token not found"`<br>`}]`|`AuthError`|Use the correct API key. Refer to [API keys](/ruby.html#api-keys) for more information|
@@ -745,7 +751,7 @@ You can then call different methods on this object to return the requested infor
 If the request is not successful, the client returns a `Notifications::Client::RequestError` and an error code:
 
 |error.code|error.message|class|How to fix|
-|:---|:---|:---|
+|:---|:---|:---|:---|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "id is not a valid UUID"`<br>`}]`|`BadRequestError`|Check the notification ID|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|`AuthError`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: signature, api token not found"`<br>`}]`|`AuthError`|Use the correct API key. Refer to [API keys](/ruby.html#api-keys) for more information|
@@ -801,7 +807,7 @@ If no templates exist for a template type or there no templates for a service, t
 If the request is not successful, the client returns a `Notifications::Client::RequestError` and an error code:
 
 |error.code|error.message|class|How to fix|
-|:---|:---|:---|
+|:---|:---|:---|:---|
 |`400`|`[{`<br>`"error": "ValidationError",`<br>`"message": "Template type is not one of [sms, email, letter]"`<br>`}]`|`BadRequestError`|Contact the Notify team|
 
 ## Generate a preview template
@@ -858,7 +864,7 @@ You can then call different methods on this object to return the requested infor
 If the request is not successful, the client returns a `Notifications::Client::RequestError` and an error code:
 
 |error.code|error.message|class|How to fix|
-|:---|:---|:---|
+|:---|:---|:---|:---|
 |`400`|`[{`<br>`"error": "BadRequestError",`<br>`"message": "Missing personalisation: [PERSONALISATION FIELD]"`<br>`}]`|`BadRequestError`|Check that the personalisation arguments in the method match the placeholder fields in the template|
 |`400`|`[{`<br>`"error": "NoResultFound",`<br>`"message": "No result found"`<br>`}]`|`BadRequestError`|Check the [template ID](/ruby.html#generate-a-preview-template-arguments-id-required)|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|`AuthError`|Check your system clock|
@@ -870,6 +876,14 @@ This API call returns one page of up to 250 received text messages. You can get
 
 You can only get the status of messages that are 7 days old or newer.
 
+You can also set up [callbacks](/ruby.html#callbacks) for received text messages.
+
+## Enable received text messages
+
+Contact the GOV.UK Notify team on the [support page](https://www.notifications.service.gov.uk/support) or through the [Slack channel](https://ukgovernmentdigital.slack.com/messages/govuk-notify) to enable receiving text messages for your service.
+
+## Get a page of received text messages
+
 ### Method
 
 ```ruby
@@ -926,6 +940,6 @@ If the notification specified in the `older_than` argument is older than 7 days,
 If the request is not successful, the client returns a `Notifications::Client::RequestError` and an error code.
 
 |error.code|error.message|class|How to fix|
-|:---|:---|:---|
+|:---|:---|:---|:---|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Error: Your system clock must be accurate to within 30 seconds"`<br>`}]`|`AuthError`|Check your system clock|
 |`403`|`[{`<br>`"error": "AuthError",`<br>`"message": "Invalid token: signature, api token not found"`<br>`}]`|`AuthError`|Use the correct API key. Refer to [API keys](/ruby.html#api-keys) for more information|

data/bin/test_client.rb

@@ -139,7 +139,7 @@ end
 
 def test_send_precompiled_letter_endpoint(client)
   precompiled_letter_resp = File.open('spec/test_files/test_pdf.pdf', 'rb') do |file|
-    client.send_precompiled_letter("some reference", file)
+    client.send_precompiled_letter("some reference", file, "first")
   end
 
   test_notification_response_data_type(precompiled_letter_resp, 'precompiled_letter')
@@ -148,7 +148,7 @@ def test_send_precompiled_letter_endpoint(client)
 end
 
 def test_notification_response_data_type(notification, message_type)
-  unless notification.is_a?(Notifications::Client::ResponseNotification)
+  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
   end
@@ -159,6 +159,10 @@ def test_notification_response_data_type(notification, message_type)
 
   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
+    end
     return
   end
 
@@ -255,7 +259,8 @@ end
 
 def expected_fields_in_precompiled_letter_response
   %w(id
-     reference)
+     reference
+     postage)
 end
 
 def expected_fields_in_email_content
@@ -297,7 +302,8 @@ def expected_fields_in_email_notification_that_are_nil
      line_5
      line_6
      postcode
-     created_by_name)
+     created_by_name
+     postage)
 end
 
 def expected_fields_in_sms_notification
@@ -321,7 +327,8 @@ def expected_fields_in_sms_notification_that_are_nil
      line_6
      postcode
      subject
-     created_by_name)
+     created_by_name
+     postage)
 end
 
 def expected_fields_in_letter_notification
@@ -336,6 +343,7 @@ def expected_fields_in_letter_notification
     line_2
     postcode
     created_at
+    postage
   )
 end
 
@@ -363,6 +371,7 @@ def expected_fields_in_precompiled_letter_notification
     subject
     template
     type
+    postage
   )
 end
 

data/lib/notifications/client.rb

@@ -2,6 +2,7 @@ require_relative "client/version"
 require_relative "client/speaker"
 require_relative "client/notification"
 require_relative "client/response_notification"
+require_relative "client/response_precompiled_letter"
 require_relative "client/notifications_collection"
 require_relative "client/received_text"
 require_relative "client/received_text_collection"
@@ -59,10 +60,10 @@ module Notifications
     # @param reference [String]
     # @param pdf_file [File]
     # @see Notifications::Client::Speaker#post_precompiled_letter
-    # @return [ResponseNotification]
-    def send_precompiled_letter(reference, pdf_file)
-      ResponseNotification.new(
-        speaker.post_precompiled_letter(reference, pdf_file)
+    # @return [ResponsePrecompiledLetter]
+    def send_precompiled_letter(reference, pdf_file, postage = nil)
+      ResponsePrecompiledLetter.new(
+        speaker.post_precompiled_letter(reference, pdf_file, postage)
       )
     end
 

data/lib/notifications/client/notification.rb

@@ -15,6 +15,7 @@ module Notifications
         line_5
         line_6
         postcode
+        postage
         type
         status
         template

data/lib/notifications/client/response_precompiled_letter.rb

@@ -0,0 +1,19 @@
+module Notifications
+  class Client
+    class ResponsePrecompiledLetter
+      FIELDS = %i(
+      id
+      reference
+      postage
+    ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(notification)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", notification.fetch(field.to_s, nil))
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/speaker.rb

@@ -102,10 +102,14 @@ module Notifications
       # @param reference [String] reference of the notification
       # @param pdf_file [File] PDF file opened for reading
       # @see #perform_request!
-      def post_precompiled_letter(reference, pdf_file)
+      def post_precompiled_letter(reference, pdf_file, postage = nil)
         content = Base64.strict_encode64(pdf_file.read)
         form_data = { reference: reference, content: content }
 
+        if postage != nil
+          form_data[:postage] = postage
+        end
+
         request = Net::HTTP::Post.new(
           "#{BASE_PATH}/letter",
           headers

data/lib/notifications/client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.10.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -147,6 +147,7 @@ files:
 - lib/notifications/client/received_text_collection.rb
 - lib/notifications/client/request_error.rb
 - lib/notifications/client/response_notification.rb
+- lib/notifications/client/response_precompiled_letter.rb
 - lib/notifications/client/response_template.rb
 - lib/notifications/client/speaker.rb
 - lib/notifications/client/template_collection.rb