notifications-ruby-client 5.1.0 → 5.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8273dcafdfbd624d66c297df116923b57e7dbc336403f982c605a97842b4753
-  data.tar.gz: eedca7b3d118bea2476cedebb32c6c802ffb8322612ec1c97eb0bbb0bbe21408
+  metadata.gz: fd1f49567263efcb02c79c9e90315b809db7a4e6add2c3928eea48ac9ae32c49
+  data.tar.gz: ef90da03ad2255fc6a656462a5312c979a11e5d912178bb4d1342f93b1979567
 SHA512:
-  metadata.gz: 6cc4249443eb6e24751de8b9c7ac410afabd6b1235ae9cbde437984734602ba3b5466de56afa02143278d5fcef2425f5b7243792bf5bce9a5a0a917e7bd51fbf
-  data.tar.gz: 910a3f1e534c95a7d1fc547bcd4752eb439b73d54208819f735bdf540b48473e7455e20cbd3ee281429df063ddd049c99300f3ac800fa141010d7cf0830bf5ae
+  metadata.gz: c3657fba6b6ad47e5b7714289810c3db3d2e22842d8df5bec0faf78e0fc0fc96827b326b17fa8f41e68e471b360a6339e5aa38086b4fd18ab2b23d307b0f5d46
+  data.tar.gz: c5af4c7372bc945697d773da8f573c6deccde0bf0efb2fda7c2f500551c5db68c0e762a5a59d4c89e4a44df27ec23016b5d2b30c05f5365d7f285f581cd01920

data/.gitignore

@@ -11,7 +11,5 @@
 /vendor
 environment.sh
 docker.env
-/.idea/
-/.idea/vcs.xml
-docker.env
-vendor
+.idea
+*.gem

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 5.1.1
+
+* Exceptions now return the error message when calling `#to_s` on them. This will make services like Sentry correctly display the full error description.
+
 ## 5.1.0
 
 * Added new `get_pdf_for_letter` method

data/CONTRIBUTING.md

@@ -37,3 +37,8 @@ To run the integration tests:
 ```
 make integration-test
 ```
+
+
+## Releasing (for notify developers only)
+
+To release manually, run `make publish-to-rubygems`. You will need to set the environment variable `GEM_HOST_API_KEY`, which can be found in the credentials repo under `credentials/rubygems/api_key`.

data/DOCUMENTATION.md

@@ -23,7 +23,7 @@ require 'notifications/client'
 client = Notifications::Client.new(api_key)
 ```
 
-To get an API key, [sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/) and go to the __API integration__ page. You can find more information in the [API keys](#api-keys) section of this documentation.
+To get an API key, [sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __API integration__ page. You can find more information in the [API keys](#api-keys) section of this documentation.
 
 # Send a message
 
@@ -52,7 +52,13 @@ phone_number:"+447900900123"
 
 #### template_id (required)
 
-Sign in to [GOV.UK Notify](https://www.notifications.service.gov.uk/) and go to the __Templates__ page to find the template ID. For example:
+To find the template ID:
+
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
+1. Go to the __Templates__ page and select the relevant template.
+1. Select __Copy template ID to clipboard__.
+
+For example:
 
 ```ruby
 template_id:"f33517ff-2a88-4f6e-b855-c550268ce08a"
@@ -83,12 +89,13 @@ You can leave out this argument if you do not have a reference.
 
 #### sms_sender_id (optional)
 
-A unique identifier of the sender of the text message notification. You can find this information on the __Text Message sender__ settings screen.
+A unique identifier of the sender of the text message notification.
 
-1. Sign in to your GOV.UK Notify account.
-1. Go to __Settings__.
-1. If you need to change to another service, select __Switch service__ in the top right corner of the screen and select the correct one.
-1. Go to the __Text Messages__ section and select __Manage__ on the __Text Message sender__ row.
+To find the text message sender:
+
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
+1. Go to the __Settings__ page.
+1. In the __Text Messages__ section, select __Manage__ on the __Text Message sender__ row.
 
 You can then either:
 
@@ -159,7 +166,13 @@ email_address: "sender@something.com"
 
 #### template_id (required)
 
-Sign in to [GOV.UK Notify](https://www.notifications.service.gov.uk/) and go to the __Templates__ page to find the template ID. For example:
+To find the template ID:
+
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
+1. Go to the __Templates__ page and select the relevant template.
+1. Select __Copy template ID to clipboard__.
+
+For example:
 
 ```ruby
 template_id: "f33517ff-2a88-4f6e-b855-c550268ce08a"
@@ -190,14 +203,15 @@ You can leave out this argument if you do not have a reference.
 
 #### email_reply_to_id (optional)
 
-This is an email reply-to address specified by you to receive replies from your users. Your service cannot go live until you set up at least one of these email addresses.
+This is an email address specified by you to receive replies from your users. You must add at least one reply-to email address before your service can go live.
 
-1. Sign into your GOV.UK Notify account.
-1. Go to __Settings__.
-1. If you need to change to another service, select __Switch service__ in the top right corner of the screen and select the correct one.
-1. Go to the __Email__ section and select __Manage__ on the __Email reply-to addresses__ row.
-1. Select __Change__ to specify the email address to receive replies, and select __Save__.
+To add a reply-to email address:
 
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
+1. Go to the __Settings__ page.
+1. In the __Email__ section, select __Manage__ on the __Reply-to email addresses__ row.
+1. Select __Add reply-to address__.
+1. Enter the email address you want to use, and select __Add__.
 
 For example:
 
@@ -219,15 +233,16 @@ The links are unique and unguessable. GOV.UK Notify cannot access or decrypt you
 
 ### Add a placeholder field to the template
 
-1. Sign in to [GOV.UK Notify](https://www.notifications.service.gov.uk/).
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
 1. Go to the __Templates__ page and select the relevant email template.
+1. Select __Edit__.
 1. Add a placeholder field to the email template using double brackets. For example:
 
 "Download your file at: ((link_to_document))"
 
 ### Upload your file
 
-The file you upload must be a PDF file smaller than 2MB.
+The file you upload must be a PDF or CSV file smaller than 2MB. [Contact the GOV.UK Notify team](https://www.notifications.service.gov.uk/support/ask-question-give-feedback) if you need to send other file types.
 
 1. Pass the file object as an argument to the `Notifications.prepare_upload` helper method.
 1. Pass the result into the personalisation argument.
@@ -279,11 +294,13 @@ If the request is not successful, the client returns a `Notifications::Client::R
 
 ## Send a letter
 
-When your service first signs up to GOV.UK Notify, you’ll start in trial mode. You can only send letters in live mode. You must ask GOV.UK Notify to make your service live.
+When you add a new service it will start in [trial mode](https://www.notifications.service.gov.uk/features/trial-mode). You can only send letters when your service is live.
+
+To send Notify a request to go live:
 
-1. Sign in to [GOV.UK Notify](https://www.notifications.service.gov.uk/).
-1. Select __Using Notify__.
-1. Select __requesting to go live__.
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
+1. Go to the __Settings__ page.
+1. In the __Your service is in trial mode__ section, select __request to go live__.
 
 ### Method
 
@@ -302,7 +319,13 @@ letterresponse = client.send_letter(
 
 #### template_id (required)
 
-Sign in to GOV.UK Notify and go to the __Templates__ page to find the template ID. For example:
+To find the template ID:
+
+1. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in).
+1. Go to the __Templates__ page and select the relevant template.
+1. Select __Copy template ID to clipboard__.
+
+For example:
 
 ```ruby
 template_id: "f33517ff-2a88-4f6e-b855-c550268ce08a"
@@ -310,7 +333,7 @@ template_id: "f33517ff-2a88-4f6e-b855-c550268ce08a"
 
 #### personalisation (required)
 
-The personalisation argument always contains the following parameters for the letter recipient's address:
+The personalisation argument always contains the following parameters for the letter recipient’s address:
 
 - `address_line_1`
 - `address_line_2`
@@ -331,7 +354,7 @@ personalisation: {
 
 #### personalisation (optional)
 
-The following parameters in the letter recipient's address are optional:
+The following parameters in the letter recipient’s address are optional:
 
 ```ruby
 personalisation: {
@@ -488,7 +511,7 @@ response = client.get_notification(id)
 
 The ID of the notification. You can find the notification ID in the response to the [original notification method call](#response).
 
-You can also find it by signing in to [GOV.UK Notify](https://www.notifications.service.gov.uk) and going to the __API integration__ page.
+You can also find it by [signing in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and going to the __API integration__ page.
 
 ### Response
 
@@ -671,7 +694,7 @@ pdf_file = client.get_pdf_for_letter(
 
 The ID of the notification. You can find the notification ID in the response to the [original notification method call](#get-the-status-of-one-message-response).
 
-You can also find it by signing in to [GOV.UK Notify](https://www.notifications.service.gov.uk) and going to the __API integration__ page.
+You can also find it by [signing in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and going to the __API integration__ page.
 
 ### Response
 
@@ -680,6 +703,7 @@ If the request to the client is successful, the client will return a `string` co
 ### Error codes
 
 If the request is not successful, the client throws a `Notifications::Client::RequestError` and an error code.
+
 |error.code|error.message|class|How to fix|
 |:---|:---|:---|:---|
 |`400`|`ValidationError: id is not a valid UUID`|`BadRequestError`|Check the notification ID|
@@ -708,7 +732,7 @@ response = client.get_template_by_id(id)
 
 #### id (required)
 
-The ID of the template. Sign into GOV.UK Notify and go to the __Templates__ page to find this. For example:
+The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __Templates__ page to find it. For example:
 
 ```
 'f33517ff-2a88-4f6e-b855-c550268ce08a'
@@ -755,7 +779,7 @@ response = client.get_template_version(id, version)
 
 #### id (required)
 
-The ID of the template. Sign in to GOV.UK Notify and go to the __Templates__ page to find this. For example:
+The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __Templates__ page to find it. For example:
 
 ```ruby
 'f33517ff-2a88-4f6e-b855-c550268ce08a'
@@ -863,7 +887,7 @@ The parameters in the personalisation argument must match the placeholder fields
 
 #### id (required)
 
-The ID of the template. Sign into GOV.UK Notify and go to the __Templates__ page. For example:
+The ID of the template. [Sign in to GOV.UK Notify](https://www.notifications.service.gov.uk/sign-in) and go to the __Templates__ page to find it. For example:
 
 ```ruby
 'f33517ff-2a88-4f6e-b855-c550268ce08a'
@@ -918,7 +942,7 @@ You can also set up [callbacks](#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/C0E1ADVPC) to enable receiving text messages for your service.
+Contact the GOV.UK Notify team using the [support page](https://www.notifications.service.gov.uk/support) or [chat to us on Slack](https://ukgovernmentdigital.slack.com/messages/C0E1ADVPC) to request a unique number for text message replies.
 
 ## Get a page of received text messages
 

data/Makefile

@@ -75,13 +75,23 @@ integration-test-with-docker: prepare-docker-runner-image generate-env-file ## R
 		${DOCKER_BUILDER_IMAGE_NAME} \
 		make integration-test
 
+.PHONY: get-client-version
+get-client-version: ## Retrieve client version number from source code
+	@ruby -e "require './lib/notifications/client/version'; puts Notifications::Client::VERSION"
+
+.PHONY: publish-to-rubygems
+publish-to-rubygems: ## Create gemspec file and publish to rubygems
+	$(if ${GEM_HOST_API_KEY},,$(error Must specify GEM_HOST_API_KEY))
+	gem build notifications-ruby-client.gemspec --output=release.gem
+	gem push release.gem
+
 .PHONY: clean-docker-containers
 clean-docker-containers: ## Clean up any remaining docker containers
 	docker rm -f $(shell docker ps -q -f "name=${DOCKER_CONTAINER_PREFIX}") 2> /dev/null || true
 
 .PHONY: run-govuk-lint
 run-govuk-lint: ## Runs GOVUK-lint for Ruby
-	bundle exec govuk-lint-ruby lib spec bin/test_client 
+	bundle exec govuk-lint-ruby lib spec bin/test_client
 
 clean:
 	rm -rf vendor

data/lib/notifications/client/request_error.rb

@@ -6,15 +6,18 @@ module Notifications
       def initialize(response)
         @code = response.code
         @body = parse_body(response.body)
+        super(build_message)
       end
 
+    private
+
       def parse_body(body)
         JSON.parse(body)
       rescue JSON::ParserError
         body
       end
 
-      def message
+      def build_message
         return body if body.is_a?(String)
 
         error_messages = body.fetch('errors')

data/lib/notifications/client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 5.1.0
+  version: 5.1.1
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2020-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt