notifications-ruby-client 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cacbc8bf726eac5dfde61a8b0f9bad26ece23e6
-  data.tar.gz: 62f6050ebcab00e662124c17bb5f5b32c7b25505
+  metadata.gz: ef674bdb3a2528e839be78d8b0cbd00ee6282e24
+  data.tar.gz: b0eebc96892290238c4630571e6486c1698683a3
 SHA512:
-  metadata.gz: 01ccf7949dc273065b7a5324f72b0080879d89c7136e5d10fdd13e4e51c92a88e4346378527216e1c7a624666853df1f745895b1d7db3ed03d1c0d3e59c73f3a
-  data.tar.gz: 449bcdb891547ec90f0f026036ad801b213e60288c22ef8a65ab53f76721a2403a3f35dc83a6a1b4c73bd2a401ac7d3bf4dc3aed395dd199b1b7754d4565868c
+  metadata.gz: 77bf1e4c948f19d5acc96acdfdff7c7b73fdb95b7fb235aa940ec5f6882579915c550d2a5fcdad8a3048e104707a7ea6dfec52bbb17a684411c3324376a69a92
+  data.tar.gz: 1c4cd55f314823d2c974f91fd0b9d1cb731cc19665f2ec7d0415476fb6bea2016e1fe76d4c7026f743f2f88e274ab1f7250356a057080fe6ee628de0377c248e

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.3.0
+
+### Changed
+* It is now possible to have multiple email to reply to addresses. Added the option to specify an `email_reply_to_id`
+when using the `send_email` method. If no `email_reply_to_id` is specified, the default email reply to address will be
+used.
+* Upgraded all dependencies
+* Minor code style changes and fixes for the tests
+
 ## 2.2.0
 
 ### Changed

data/README.md

@@ -137,6 +137,7 @@ email = client.send_email(
     year: "2016"
   },
   reference: "your_reference_string"
+  email_reply_to_id: email_reply_to_id
 ) # => Notifications::Client::ResponseNotification
 ```
 
@@ -387,6 +388,12 @@ personalisation: {
 
 The fields `address_line_1`, `address_line_2` and `postcode` are required.
 
+#### `email_reply_to_id`
+
+Optional. Specifies the identifier of the email reply-to address to set for the notification. The identifiers are found in your service Settings, when you 'Manage' your 'Email reply to addresses'. 
+
+If you omit this argument your default email reply-to address will be set for the notification.
+
 ### Get the status of one message
 
 ```ruby
@@ -727,7 +734,7 @@ You can omit this argument to ignore this filter.
 ## Generate a preview template
 This will return the contents of a template with the placeholders replaced with the given personalisation.
 ```ruby
-templatePreview = client.generate_template_preview(template_id: template_id,
+templatePreview = client.generate_template_preview(template_id,
                                                   personalisation: {
                                                       name: "name",
                                                       year: "2016",                      

data/bin/generate_docker_env.sh

@@ -18,6 +18,7 @@ env_vars=(
     EMAIL_TEMPLATE_ID
     SMS_TEMPLATE_ID
     LETTER_TEMPLATE_ID
+    EMAIL_REPLY_TO_ID
 )
 
 for env_var in "${env_vars[@]}"; do

data/bin/test_client.rb

@@ -1,10 +1,5 @@
 #!/usr/bin/env ruby
-require 'notifications/client'
-require 'notifications/client/notification'
-require 'notifications/client/response_notification'
-require 'notifications/client/notification'
-require 'notifications/client/response_template'
-require 'notifications/client/template_collection'
+require './lib/notifications/client'
 
 def main
   client = Notifications::Client.new(ENV['API_KEY'], ENV['NOTIFY_API_URL'])
@@ -35,7 +30,7 @@ def test_get_template_version(client, id, version)
 end
 
 def test_get_all_templates(client)
-  response = client.get_all_templates()
+  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
@@ -50,7 +45,7 @@ def test_get_all_templates(client)
 end
 
 def test_get_all_templates_filter_by_type(client)
-  response = client.get_all_templates({'type' => 'sms'})
+  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
@@ -63,8 +58,7 @@ def test_get_all_templates_filter_by_type(client)
 end
 
 def test_generate_template_preview(client, id)
-
-  response = client.generate_template_preview(id, personalisation:Hash["name", "some name"])
+  response = client.generate_template_preview(id, personalisation: { "name" => "some name" })
   test_template_preview(response)
 end
 
@@ -93,16 +87,18 @@ 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:Hash["name", "some name"],
-                                 reference: "some reference")
+  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'])
   test_notification_response_data_type(email_resp, 'email')
   email_resp
 end
 
 def test_send_sms_endpoint(client)
   sms_resp = client.send_sms(phone_number: ENV['FUNCTIONAL_TEST_NUMBER'], template_id: ENV['SMS_TEMPLATE_ID'],
-                             personalisation:Hash["name", "some name"],
+                             personalisation: { "name" => "some name" },
                              reference: "some reference")
   test_notification_response_data_type(sms_resp, 'sms')
   sms_resp
@@ -124,22 +120,22 @@ end
 
 def test_notification_response_data_type(notification, message_type)
   unless notification.is_a?(Notifications::Client::ResponseNotification)
-    p 'failed ' + message_type +' response is not a Notifications::Client::ResponseNotification'
+    p 'failed ' + message_type + ' response is not a Notifications::Client::ResponseNotification'
     exit 1
   end
   unless notification.id.is_a?(String)
-    p 'failed '+ message_type + 'id is not a String'
+    p 'failed ' + message_type + 'id is not a String'
     exit 1
   end
-  field_should_not_be_nil(expected_fields_in_notification_response, notification, 'send_'+message_type)
-  hash_key_should_not_be_nil(expected_fields_in_template, notification.send('template'), 'send_'+message_type+'.template')
+  field_should_not_be_nil(expected_fields_in_notification_response, notification, 'send_' + message_type)
+  hash_key_should_not_be_nil(expected_fields_in_template, notification.send('template'), 'send_' + message_type + '.template')
 
   if message_type == 'email'
-    hash_key_should_not_be_nil(expected_fields_in_email_content, notification.send('content'), 'send_'+message_type+'.content')
+    hash_key_should_not_be_nil(expected_fields_in_email_content, notification.send('content'), 'send_' + message_type + '.content')
   elsif message_type == 'sms'
-    hash_key_should_not_be_nil(expected_fields_in_sms_content, notification.send('content'),'send_'+message_type+'.content')
+    hash_key_should_not_be_nil(expected_fields_in_sms_content, notification.send('content'), 'send_' + message_type + '.content')
   elsif message_type == 'letter'
-    hash_key_should_not_be_nil(expected_fields_in_letter_content, notification.send('content'),'send_'+message_type+'.content')
+    hash_key_should_not_be_nil(expected_fields_in_letter_content, notification.send('content'), 'send_' + message_type + '.content')
   end
 end
 
@@ -199,16 +195,14 @@ def expected_fields_in_template_response
      created_at
      created_by
      body
-     version
-)
+     version)
 end
 
 def expected_fields_in_template_preview
   %w(id
      body
      version
-     type
-)
+     type)
 end
 
 def expected_fields_in_notification_response
@@ -216,20 +210,17 @@ def expected_fields_in_notification_response
      reference
      content
      template
-     uri
-)
+     uri)
 end
 
 def expected_fields_in_email_content
   %w(from_email
      body
-     subject
-)
+     subject)
 end
 
 def expected_fields_in_sms_content
-  %w(body
-     )
+  %w(body)
 end
 
 def expected_fields_in_letter_content
@@ -247,8 +238,7 @@ def expected_fields_in_email_notification
      template
      body
      subject
-     created_at
-)
+     created_at)
 end
 
 def expected_fields_in_email_notification_that_are_nil
@@ -260,8 +250,7 @@ def expected_fields_in_email_notification_that_are_nil
      line_5
      line_5
      line_6
-     postcode
-     )
+     postcode)
 end
 
 def expected_fields_in_sms_notification
@@ -271,8 +260,7 @@ def expected_fields_in_sms_notification
      status
      template
      body
-     created_at
-   )
+     created_at)
 end
 
 def expected_fields_in_sms_notification_that_are_nil
@@ -322,7 +310,7 @@ def expected_fields_in_template
 end
 
 def test_get_all_notifications(client)
-  notifications = client.get_notifications()
+  notifications = client.get_notifications
   unless notifications.is_a?(Notifications::Client::NotificationsCollection)
     p 'get all notifications is not Notifications::Client::NotificationsCollection'
     exit 1
@@ -332,8 +320,7 @@ end
 
 def expected_fields_for_get_all_notifications
   %W(links
-	collection
-	)
+     collection)
 end
 
 if __FILE__ == $PROGRAM_NAME

data/lib/notifications/client/speaker.rb

@@ -1,7 +1,7 @@
 require "net/https"
 require "uri"
 require "jwt"
-require "notifications/client/request_error"
+require_relative "request_error"
 
 module Notifications
   class Client
@@ -38,6 +38,8 @@ module Notifications
       #   A reference specified by the service for the notification. Get all notifications can be filtered by this reference.
       #   This reference can be unique or used used to refer to a batch of notifications.
       #   Can be an empty string or nil, when you do not require a reference for the notifications.
+      # @option form_data [String] :email_reply_to_id
+      #   id of the email address that replies to email notifications will be sent to
       # @see #perform_request!
       def post(kind, form_data)
         request = Net::HTTP::Post.new(

data/lib/notifications/client/version.rb

@@ -1,5 +1,5 @@
 module Notifications
   class Client
-    VERSION = "2.2.0".freeze
+    VERSION = "2.3.0".freeze
   end
 end

data/lib/notifications/client.rb

@@ -1,11 +1,11 @@
-require "notifications/client/version"
-require "notifications/client/speaker"
-require "notifications/client/notification"
-require "notifications/client/response_notification"
-require "notifications/client/notifications_collection"
-require "notifications/client/response_template"
-require "notifications/client/template_collection"
-require "notifications/client/template_preview"
+require_relative "client/version"
+require_relative "client/speaker"
+require_relative "client/notification"
+require_relative "client/response_notification"
+require_relative "client/notifications_collection"
+require_relative "client/response_template"
+require_relative "client/template_collection"
+require_relative "client/template_preview"
 require "forwardable"
 
 module Notifications

data/notifications-ruby-client.gemspec

@@ -20,11 +20,11 @@ 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"
+  spec.add_runtime_dependency "jwt", "~> 2.1"
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 2.0"
-  spec.add_development_dependency "factory_girl", "~> 4.7"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 12.1"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_development_dependency "webmock", "~> 3.1"
+  spec.add_development_dependency "factory_girl", "~> 4.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-24 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -16,84 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4.8'
 description: 
 email:
 - notify@digital.cabinet-office.gov.uk
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby client for GOV.UK Notifications API