notifications-ruby-client 5.2.0 → 5.4.0

data/Dockerfile

@@ -11,3 +11,6 @@ RUN \
     gnupg
 
 WORKDIR /var/project
+
+COPY . .
+RUN make bootstrap

data/Makefile

@@ -1,22 +1,16 @@
 .DEFAULT_GOAL := help
 SHELL := /bin/bash
 
-DOCKER_BUILDER_IMAGE_NAME = govuk/notify-ruby-client-builder
-
-BUILD_TAG ?= notifications-ruby-client-manual
-
-DOCKER_CONTAINER_PREFIX = ${USER}-${BUILD_TAG}
-
 .PHONY: help
 help:
 	@cat $(MAKEFILE_LIST) | grep -E '^[a-zA-Z_-]+:.*?## .*$$' | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
-.PHONY: dependencies
-dependencies: ## Install build dependencies
-	bundle install --path=vendor/bundle --binstubs=vendor/bin
+.PHONY: bootstrap
+bootstrap: ## Install build dependencies
+	bundle install
 
 .PHONY: build
-build: dependencies ## Build project
+build: bootstrap ## Build project (dummy task for CI)
 
 .PHONY: test
 test: ## Run tests
@@ -26,40 +20,17 @@ test: ## Run tests
 integration-test: ## Run integration tests
 	bundle exec bin/test_client.rb
 
-.PHONY: generate-env-file
-generate-env-file: ## Generate the environment file for running the tests inside a Docker container
-	bin/generate_docker_env.sh
-
-.PHONY: prepare-docker-runner-image
-prepare-docker-runner-image: ## Prepare the Docker builder image
-	docker pull `grep "FROM " Dockerfile | cut -d ' ' -f 2` || true
-	docker build -t ${DOCKER_BUILDER_IMAGE_NAME} .
-
-.PHONY: build-with-docker
-build-with-docker: prepare-docker-runner-image ## Build inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-build" \
-		-v "`pwd`:/var/project" \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make build
+.PHONY: bootstrap-with-docker
+bootstrap-with-docker: ## Prepare the Docker builder image
+	docker build -t notifications-ruby-client .
 
 .PHONY: test-with-docker
-test-with-docker: prepare-docker-runner-image generate-env-file ## Run tests inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-test" \
-		-v "`pwd`:/var/project" \
-		--env-file docker.env \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make build test
+test-with-docker: ## Run tests inside a Docker container
+	./scripts/run_with_docker.sh make test
 
 .PHONY: integration-test-with-docker
-integration-test-with-docker: prepare-docker-runner-image generate-env-file ## Run integration tests inside a Docker container
-	docker run -i --rm \
-		--name "${DOCKER_CONTAINER_PREFIX}-integration-test" \
-		-v "`pwd`:/var/project" \
-		--env-file docker.env \
-		${DOCKER_BUILDER_IMAGE_NAME} \
-		make build integration-test
+integration-test-with-docker: ## Run integration tests inside a Docker container
+	./scripts/run_with_docker.sh make integration-test
 
 .PHONY: get-client-version
 get-client-version: ## Retrieve client version number from source code
@@ -71,9 +42,5 @@ publish-to-rubygems: ## Create gemspec file and publish to rubygems
 	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
-
 clean:
 	rm -rf vendor

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/helper_methods.rb

@@ -1,9 +1,14 @@
 require "base64"
 
 module Notifications
-  def self.prepare_upload(file, is_csv=false)
+  def self.prepare_upload(file, is_csv=false, confirm_email_before_download: nil, retention_period: nil)
     raise ArgumentError.new("File is larger than 2MB") if file.size > Client::MAX_FILE_UPLOAD_SIZE
 
-    { file: Base64.strict_encode64(file.read), is_csv: is_csv }
+    data = { file: Base64.strict_encode64(file.read), is_csv: is_csv }
+
+    data[:confirm_email_before_download] = confirm_email_before_download
+    data[:retention_period] = retention_period
+
+    data
   end
 end

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.4.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

data/scripts/run_with_docker.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+DOCKER_IMAGE_NAME=notifications-ruby-client
+
+source environment.sh
+
+docker run \
+  --rm \
+  -v "`pwd`:/var/project" \
+  -e NOTIFY_API_URL=${NOTIFY_API_URL} \
+  -e API_KEY=${API_KEY} \
+  -e FUNCTIONAL_TEST_NUMBER=${FUNCTIONAL_TEST_NUMBER} \
+  -e FUNCTIONAL_TEST_EMAIL=${FUNCTIONAL_TEST_EMAIL} \
+  -e EMAIL_TEMPLATE_ID=${EMAIL_TEMPLATE_ID} \
+  -e SMS_TEMPLATE_ID=${SMS_TEMPLATE_ID} \
+  -e LETTER_TEMPLATE_ID=${LETTER_TEMPLATE_ID} \
+  -e EMAIL_REPLY_TO_ID=${EMAIL_REPLY_TO_ID} \
+  -e SMS_SENDER_ID=${SMS_SENDER_ID} \
+  -e API_SENDING_KEY=${API_SENDING_KEY} \
+  -e INBOUND_SMS_QUERY_KEY=${INBOUND_SMS_QUERY_KEY} \
+  -it \
+  ${DOCKER_IMAGE_NAME} \
+  ${@}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2022-10-06 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
@@ -107,6 +107,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
@@ -121,7 +122,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/generate_docker_env.sh
 - bin/setup
 - bin/test_client.rb
 - lib/notifications/client.rb
@@ -140,6 +140,7 @@ files:
 - lib/notifications/client/uuid_validator.rb
 - lib/notifications/client/version.rb
 - notifications-ruby-client.gemspec
+- scripts/run_with_docker.sh
 homepage: https://github.com/alphagov/notifications-ruby-client
 licenses: []
 metadata: {}
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for GOV.UK Notifications API

data/bin/generate_docker_env.sh

@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-
-set -eo pipefail
-
-function exit_with_msg {
-    echo $1
-    exit $2
-}
-
-echo -n "" > docker.env
-
-env_vars=(
-    NOTIFY_API_URL
-    SERVICE_ID
-    API_KEY
-    FUNCTIONAL_TEST_EMAIL
-    FUNCTIONAL_TEST_NUMBER
-    EMAIL_TEMPLATE_ID
-    SMS_TEMPLATE_ID
-    LETTER_TEMPLATE_ID
-    EMAIL_REPLY_TO_ID
-    SMS_SENDER_ID
-    API_SENDING_KEY
-    INBOUND_SMS_QUERY_KEY
-)
-
-for env_var in "${env_vars[@]}"; do
-    echo "${env_var}=${!env_var}" >> docker.env
-done