notifications-ruby-client 5.3.0 → 6.0.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/README.md

@@ -6,5 +6,5 @@ Useful links:
 
 - [Documentation](https://docs.notifications.service.gov.uk/ruby.html)
 - [Ruby gem](https://rubygems.org/gems/notifications-ruby-client)
-- [Changelog](https://github.com/alphagov/notifications-ruby-client/blob/master/CHANGELOG.md)
-- [Contributing to this client](https://github.com/alphagov/notifications-ruby-client/blob/master/CONTRIBUTING.md)
+- [Changelog](https://github.com/alphagov/notifications-ruby-client/blob/main/CHANGELOG.md)
+- [Contributing to this client](https://github.com/alphagov/notifications-ruby-client/blob/main/CONTRIBUTING.md)

data/lib/notifications/client/helper_methods.rb

@@ -1,9 +1,15 @@
 require "base64"
 
 module Notifications
-  def self.prepare_upload(file, is_csv=false)
+  def self.prepare_upload(file, filename: nil, 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) }
+
+    data[:filename] = filename
+    data[:confirm_email_before_download] = confirm_email_before_download
+    data[:retention_period] = retention_period
+
+    data
   end
 end

data/lib/notifications/client/version.rb

@@ -9,6 +9,6 @@
 
 module Notifications
   class Client
-    VERSION = "5.3.0".freeze
+    VERSION = "6.0.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", "~> 6.1"
+  spec.add_development_dependency "factory_bot", "~> 6.1", "<6.4.5"
 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.3.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2024-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -93,6 +93,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.4.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -100,6 +103,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 6.4.5
 description: 
 email:
 - notify@digital.cabinet-office.gov.uk
@@ -107,6 +113,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".gitignore"
 - ".rspec"
@@ -121,7 +128,6 @@ files:
 - README.md
 - Rakefile
 - bin/console
-- bin/generate_docker_env.sh
 - bin/setup
 - bin/test_client.rb
 - lib/notifications/client.rb
@@ -140,6 +146,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 +165,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