notifications-ruby-client 4.0.0 → 5.3.0

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:2.6-slim
+
+RUN \
+	echo "Install Debian packages" \
+	&& apt-get update \
+	&& apt-get install -y --no-install-recommends \
+		gcc \
+		make \
+		curl \
+		git \
+    gnupg
+
+WORKDIR /var/project

data/Makefile

@@ -32,18 +32,14 @@ generate-env-file: ## Generate the environment file for running the tests inside
 
 .PHONY: prepare-docker-runner-image
 prepare-docker-runner-image: ## Prepare the Docker builder image
-	make -C docker build
+	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" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
 		${DOCKER_BUILDER_IMAGE_NAME} \
 		make build
 
@@ -52,36 +48,32 @@ test-with-docker: prepare-docker-runner-image generate-env-file ## Run tests ins
 	docker run -i --rm \
 		--name "${DOCKER_CONTAINER_PREFIX}-test" \
 		-v "`pwd`:/var/project" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
 		--env-file docker.env \
 		${DOCKER_BUILDER_IMAGE_NAME} \
-		make test
+		make build 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" \
-		-e http_proxy="${HTTP_PROXY}" \
-		-e HTTP_PROXY="${HTTP_PROXY}" \
-		-e https_proxy="${HTTPS_PROXY}" \
-		-e HTTPS_PROXY="${HTTPS_PROXY}" \
-		-e NO_PROXY="${NO_PROXY}" \
 		--env-file docker.env \
 		${DOCKER_BUILDER_IMAGE_NAME} \
-		make integration-test
+		make build 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 
-
 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)
@@ -20,18 +22,29 @@ def main
   test_get_notification_by_id_endpoint(client, precompiled_letter_notification.id, 'precompiled_letter')
   test_get_all_notifications(client)
   test_get_received_texts
+  test_get_pdf_for_letter(client, letter_notification.id)
   p 'ruby client integration tests pass'
   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)
@@ -44,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)
@@ -59,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)
@@ -67,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
@@ -76,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)
@@ -205,6 +228,28 @@ def test_get_notification_by_id_endpoint(client, id, message_type)
   end
 end
 
+def test_get_pdf_for_letter(client, id)
+  response = nil
+
+  # try 15 times with 3 secs sleep between each attempt, to get the PDF
+  15.times do
+    begin
+      response = client.get_pdf_for_letter(id)
+    rescue Notifications::Client::BadRequestError
+      sleep(3)
+    end
+
+    if !response.nil?
+      break
+    end
+  end
+
+  unless !response.nil? && response.start_with?("%PDF-")
+    p "get_pdf_for_letter response for " + id + " is not a PDF: " + response.to_s
+    exit 1
+  end
+end
+
 def hash_key_should_not_be_nil(fields, obj, method_name)
   fields.each do |field|
     if obj.has_value?(:"#{field}")
@@ -232,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.rb

@@ -67,6 +67,14 @@ module Notifications
       )
     end
 
+    ##
+    # @param id [String]
+    # @see Notifications::Client::Speaker#get
+    # @return [String]
+    def get_pdf_for_letter(id)
+      speaker.get_pdf_for_letter(id)
+    end
+
     ##
     # @param id [String]
     # @see Notifications::Client::Speaker#get

data/lib/notifications/client/helper_methods.rb

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

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

@@ -13,6 +13,7 @@ module Notifications
         version
         body
         subject
+        letter_contact_block
       ).freeze
 
       attr_reader(*FIELDS)

data/lib/notifications/client/speaker.rb

@@ -118,6 +118,19 @@ module Notifications
         perform_request!(request)
       end
 
+      def get_pdf_for_letter(id)
+        path = "/v2/notifications/" << id << "/pdf"
+        request = Net::HTTP::Get.new(path, headers)
+
+        # can't use `perform_request!` because we're just returning raw binary data
+        response = open(request)
+        if response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
+          raise build_error(response)
+        else
+          response.body
+        end
+      end
+
     private
 
       ##

data/lib/notifications/client/version.rb

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

data/notifications-ruby-client.gemspec

@@ -22,10 +22,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "jwt", ">= 1.5", "< 3"
 
-  spec.add_development_dependency "bundler", "~> 1.13"
-  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  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", "~> 4.10"
-  spec.add_development_dependency "govuk-lint", "~> 3.8"
+  spec.add_development_dependency "factory_bot", "~> 6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-02 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -36,28 +36,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,28 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.10'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.10'
-- !ruby/object:Gem::Dependency
-  name: govuk-lint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '6.1'
 description: 
 email:
 - notify@digital.cabinet-office.gov.uk
@@ -128,6 +114,7 @@ files:
 - CHANGELOG.md
 - CONTRIBUTING.md
 - DOCUMENTATION.md
+- Dockerfile
 - Gemfile
 - LICENSE
 - Makefile
@@ -137,8 +124,6 @@ files:
 - bin/generate_docker_env.sh
 - bin/setup
 - bin/test_client.rb
-- docker/Dockerfile
-- docker/Makefile
 - lib/notifications/client.rb
 - lib/notifications/client/helper_methods.rb
 - lib/notifications/client/notification.rb
@@ -173,8 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby client for GOV.UK Notifications API

data/docker/Dockerfile

@@ -1,26 +0,0 @@
-FROM ruby:2.3.1-slim
-
-ARG HTTP_PROXY
-ARG HTTPS_PROXY
-ARG NO_PROXY
-
-RUN \
-	echo "Install Debian packages" \
-	&& ([ -z "$HTTP_PROXY" ] || echo "Acquire::http::Proxy \"${HTTP_PROXY}\";" > /etc/apt/apt.conf.d/99HttpProxy) \
-	&& apt-get update \
-	&& apt-get install -y --no-install-recommends \
-		gcc \
-		make \
-		curl \
-		git \
-
-	&& echo "Clean up" \
-	&& rm -rf /var/lib/apt/lists/* /tmp/*
-
-ENV PATH=/var/project/vendor/bin:$PATH \
-    BUNDLE_PATH="/var/project/vendor/bundle" \
-    BUNDLE_BIN="/var/project/vendor/bin" \
-    BUNDLE_APP_CONFIG="/var/project/.bundle"
-
-
-WORKDIR /var/project