notifications-ruby-client 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c2ca0e37a78051cacf6b35de97f7a2a6e1e45e41355d2cb91a3ded84571a357
-  data.tar.gz: cf2652751ae7b86361688e18ddd6dc6487e88dfb7d7758a119720cb5b7544ecd
+  metadata.gz: 5c7ff68fddc3b2837e47a1b89476f0d391ec432cc096176733a5944ed20dd107
+  data.tar.gz: 84e59511973f65604fc0617c14871848517e23fe615d7d0c075733a435ce06e7
 SHA512:
-  metadata.gz: 037f381822efe210e32e3a4a398f946cba3923f2593826a91486ea0710544cf0c72bc0d38b88ff223705bcb984763bbb51052d0a43090223f47bf0607f82348d
-  data.tar.gz: b0980abf21fd435ad2350f256b04b4cc9ef3db892d642f753e5ba3be4d029f4359a1e37efff6b2197d74b0652c1b4ae49857f3d253a332f9b4ffad945b730afb
+  metadata.gz: 92f58edf7ea3cc8966d51e2902f0846082d6667290bdb1123e9c399354fb975dd33e297e4f30667aef275ee2482750932f160857c97459ae89200d162d459373
+  data.tar.gz: d3d5784f52bce5bc164ce10d76ef14f83a82caab0f6b3b2e540db3a9ff45d7ea10e0c145deacb8d9501fa3d3ada8770041b5ff80839701526fece51f4391dc7f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.3.0
+
+* Added `letter_contact_block` as a new attribute of the `Notifications::Client::Template` class. This affects the responses from the `get_template_by_id`, `get_template_version` and `get_all_templates` methods.
+
 ## 5.2.0
 
 * Add support for an optional `is_csv` parameter in the `prepare_upload()` function. This fixes a bug when sending a CSV file by email. This ensures that the file is downloaded as a CSV rather than a TXT file.

data/DOCUMENTATION.md

@@ -770,6 +770,7 @@ You can then call different methods on this object to return the requested infor
 |`response.version`|Template version|String|
 |`response.body`|Template content|String|
 |`response.subject`|Template subject (email and letter)|String|
+|`response.letter_contact_block`|Template letter contact block (letter)|String|
 
 ### Error codes
 
@@ -821,6 +822,7 @@ You can then call different methods on this object to return the requested infor
 |`response.version`|Template version|String|
 |`response.body`|Template content|String|
 |`response.subject`|Template subject (email and letter)|String|
+|`response.letter_contact_block`|Template letter contact block (letter)|String|
 
 ### Error codes
 
@@ -875,6 +877,7 @@ Once the client has returned a template array, you must then call the following
 |`response.version`|Template version|String|
 |`response.body`|Template content|String|
 |`response.subject`|Template subject (email and letter)|String|
+|`response.letter_contact_block`|Template letter contact block (letter)|String|
 
 If no templates exist for a template type or there no templates for a service, the templates array will be empty.
 

data/bin/test_client.rb

@@ -3,7 +3,9 @@ require './lib/notifications/client'
 
 def main
   client = Notifications::Client.new(ENV['API_KEY'], ENV['NOTIFY_API_URL'])
-  test_get_template_by_id(client, ENV['EMAIL_TEMPLATE_ID'])
+  test_get_email_template_by_id(client, ENV['EMAIL_TEMPLATE_ID'])
+  test_get_sms_template_by_id(client, ENV['SMS_TEMPLATE_ID'])
+  test_get_letter_template_by_id(client, ENV['LETTER_TEMPLATE_ID'])
   test_get_template_version(client, ENV['SMS_TEMPLATE_ID'], 1)
   test_get_all_templates(client)
   test_get_all_templates_filter_by_type(client)
@@ -25,14 +27,24 @@ def main
   exit 0
 end
 
-def test_get_template_by_id(client, id)
+def test_get_email_template_by_id(client, id)
   response = client.get_template_by_id(id)
-  test_template_response(response, 'test_get_template_by_id')
+  test_template_response(response, 'email', 'test_get_email_template_by_id')
+end
+
+def test_get_sms_template_by_id(client, id)
+  response = client.get_template_by_id(id)
+  test_template_response(response, 'sms', 'test_get_sms_template_by_id')
+end
+
+def test_get_letter_template_by_id(client, id)
+  response = client.get_template_by_id(id)
+  test_template_response(response, 'letter', 'test_get_letter_template_by_id')
 end
 
 def test_get_template_version(client, id, version)
   response = client.get_template_version(id, version)
-  test_template_response(response, 'test_get_template_version')
+  test_template_response(response, 'sms', 'test_get_template_version')
 end
 
 def test_get_all_templates(client)
@@ -45,9 +57,9 @@ def test_get_all_templates(client)
     p 'failed test_get_all_templates, expected at least 3 templates returned.'
     exit 1
   end
-  test_template_response(response.collection[0], 'test_get_all_templates')
-  test_template_response(response.collection[1], 'test_get_all_templates')
-  test_template_response(response.collection[2], 'test_get_all_templates')
+  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')
 end
 
 def test_get_all_templates_filter_by_type(client)
@@ -60,7 +72,7 @@ def test_get_all_templates_filter_by_type(client)
     p 'failed test_get_all_templates, expected at least 2 templates returned.'
     exit 1
   end
-  test_template_response(response.collection[0], 'test_get_all_templates')
+  test_template_response(response.collection[0], 'sms', 'test_get_all_templates')
 end
 
 def test_generate_template_preview(client, id)
@@ -68,7 +80,7 @@ def test_generate_template_preview(client, id)
   test_template_preview(response)
 end
 
-def test_template_response(response, test_method)
+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
@@ -77,7 +89,17 @@ def test_template_response(response, test_method)
     p 'failed template id is not a String'
     exit 1
   end
-  field_should_not_be_nil(expected_fields_in_template_response, response, test_method)
+
+  field_should_not_be_nil(
+    expected_fields_in_template_response(template_type),
+    response,
+    test_method
+  )
+  field_should_be_nil(
+    expected_nil_fields_in_template_response(template_type),
+    response,
+    test_method
+  )
 end
 
 def test_template_preview(response)
@@ -255,14 +277,21 @@ def field_should_be_nil(fields, obj, method_name)
   end
 end
 
-def expected_fields_in_template_response
-  %w(id
-     name
-     type
-     created_at
-     created_by
-     body
-     version)
+def expected_fields_in_template_response(template_type)
+  {
+    "email" => ["id", "name", "type", "created_at", "created_by", "version", "body", "subject"],
+    "sms" => ["id", "name", "type", "created_at", "created_by", "version", "body"],
+    "letter" => ["id", "name", "type", "created_at", "created_by", "version", "body", "subject",
+                 "letter_contact_block"],
+  }[template_type]
+end
+
+def expected_nil_fields_in_template_response(template_type)
+  {
+    "email" => ["letter_contact_block"],
+    "sms" => ["subject", "letter_contact_block"],
+    "letter" => [],
+  }[template_type]
 end
 
 def expected_fields_in_template_preview

data/lib/notifications/client/response_template.rb

@@ -13,6 +13,7 @@ module Notifications
         version
         body
         subject
+        letter_contact_block
       ).freeze
 
       attr_reader(*FIELDS)

data/lib/notifications/client/version.rb

@@ -9,6 +9,6 @@
 
 module Notifications
   class Client
-    VERSION = "5.2.0".freeze
+    VERSION = "5.3.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", "~> 5.2"
+  spec.add_development_dependency "factory_bot", "~> 6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
 description: 
 email:
 - notify@digital.cabinet-office.gov.uk