notifications-ruby-client 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef674bdb3a2528e839be78d8b0cbd00ee6282e24
-  data.tar.gz: b0eebc96892290238c4630571e6486c1698683a3
+  metadata.gz: db2242bb9327b4033e27f251959d593c4983d654
+  data.tar.gz: ddde90e6a3f27e5cecaf00da9feffc7ec99ade63
 SHA512:
-  metadata.gz: 77bf1e4c948f19d5acc96acdfdff7c7b73fdb95b7fb235aa940ec5f6882579915c550d2a5fcdad8a3048e104707a7ea6dfec52bbb17a684411c3324376a69a92
-  data.tar.gz: 1c4cd55f314823d2c974f91fd0b9d1cb731cc19665f2ec7d0415476fb6bea2016e1fe76d4c7026f743f2f88e274ab1f7250356a057080fe6ee628de0377c248e
+  metadata.gz: 7628eebc40595c53bb559420b75cb3e0e0aa9a31bd1198d628e9006c1fb902edd871fe250e516bfbff1c7bdc642d1ff8a6967c22bb807bfafae9804144c62ed2
+  data.tar.gz: 74661018d45151f1375f0af65ab3659be25672808474831fb7f31641eb2533a84578541e05d5db65323929e97b5492c1daa9c2dda1600afdec5123b48f93583f

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,12 @@
+<!--Thanks for contributing to GOV.UK Notify. Using this template to write your pull request message will help get it merged as soon as possible. -->
+
+## What problem does the pull request solve?
+<!--- Describe why you’re making this change -->
+
+## Checklist
+
+<!--- 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 update the documentation (in `README.md`)
+- [ ] I’ve bumped the version number (in `lib/notifications/client/version.rb`)

data/.rspec

@@ -1,2 +1,3 @@
 --format documentation
 --color
+--require spec_helper

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.4.0
+
+### Changed
+* It is now possible to have multiple SMS senders and to specify which sender an SMS notification should come from. Added the option to specify `sms_sender_id` when using the `send_sms` method. If no `sms_sender_id` is specified, the default sms sender will be used.
+* Replaced `factory_girl` development dependency with `factory_bot`, which is the [new name for Factory girl.](https://robots.thoughtbot.com/factory_bot)
+
+
 ## 2.3.0
 
 ### Changed

data/README.md

@@ -33,9 +33,10 @@ sms = client.send_sms(
   template_id: template_id,
   personalisation: {
     name: "name",
-    year: "2016",                      
-  }
-  reference: "your_reference_string"
+    year: "2016",
+  },
+  reference: "your_reference_string",
+  sms_sender_id: sms_sender_id
 ) # => Notifications::Client::ResponseNotification
 ```
 
@@ -136,7 +137,7 @@ email = client.send_email(
     name: "name",
     year: "2016"
   },
-  reference: "your_reference_string"
+  reference: "your_reference_string",
   email_reply_to_id: email_reply_to_id
 ) # => Notifications::Client::ResponseNotification
 ```
@@ -359,6 +360,11 @@ An optional identifier you generate. The `reference` can be used as a unique ref
 
 You can omit this argument if you do not require a reference for the notification.
 
+#### `sms_sender_id`
+Optional. Specifies the identifier of the sms sender to set for the notification. The identifiers are found in your service Settings, when you 'Manage' your 'Text message sender'.
+
+If you omit this argument your default sms sender will be set for the notification.
+
 #### `personalisation`
 If the template has placeholders you need to provide their values as a Hash, for example:
 

data/bin/generate_docker_env.sh

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

data/bin/test_client.rb

@@ -99,7 +99,8 @@ 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: { "name" => "some name" },
-                             reference: "some reference")
+                             reference: "some reference",
+                             sms_sender_id: ENV['SMS_SENDER_ID'])
   test_notification_response_data_type(sms_resp, 'sms')
   sms_resp
 end

data/lib/notifications/client/speaker.rb

@@ -40,6 +40,8 @@ module 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
+      # @option form_data [String] :sms_sender_id
+      #   id of the sender to be used for an sms notification
       # @see #perform_request!
       def post(kind, form_data)
         request = Net::HTTP::Post.new(

data/lib/notifications/client/version.rb

@@ -1,5 +1,14 @@
+# Version numbering follows Semantic Versionning:
+#
+# Given a version number MAJOR.MINOR.PATCH, increment the:
+# - MAJOR version when you make incompatible API changes,
+# - MINOR version when you add functionality in a backwards-compatible manner, and
+# - PATCH version when you make backwards-compatible bug fixes.
+#
+# -- http://semver.org/
+
 module Notifications
   class Client
-    VERSION = "2.3.0".freeze
+    VERSION = "2.4.0".freeze
   end
 end

data/notifications-ruby-client.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2017-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: factory_girl
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -101,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md