notifications-ruby-client 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfd87a0ae55ca5a8d843a19bd9ffc99959ca646f
-  data.tar.gz: 48c8ed194a9364549035cdfe410103c22aa3988f
+  metadata.gz: 526cd293f41883133d625d11f5ec463e437cd7a5
+  data.tar.gz: a1cfba8086a71c42f4ad27830e713005d1e667d9
 SHA512:
-  metadata.gz: 048a94ca3bd1fe8d9c16fe91a24f8fe509e23119d4f4a86fd9fca38293cc5a829f5c40cef58d3c3630084984b7274f997cc416db0a0056e79d2a50f414493058
-  data.tar.gz: 04c883580688bd5a6e66ccb14d4abfb266e72f77880776c8ea1c435ae61e873c90b6228e2a9b0ec7b4e0a6f542a4e894156b31c4bba7b7d816928a2218155e3a
+  metadata.gz: 0dc3d6e520d552d4bbf162258783308f7040db46304bd493563d09e6387638a334feac1930edaa6b8d91786e3619d12dc86cc0d4ee1e2756c509c69908fcf23a
+  data.tar.gz: 5222d707f9cb24b316466976ca2c447eeac5a4a1ee65bdc2cf105862c6d2d8fb0a03aec533f9f86e9af9897882f1210a7eebbf50cb4410e091c2bb17a3bc2de3

data/.gitignore

@@ -10,5 +10,8 @@
 .DS_Store
 /vendor
 environment.sh
+docker.env
 /.idea/
-/.idea/vcs.xml
+/.idea/vcs.xml
+docker.env
+vendor

data/Makefile

@@ -0,0 +1,68 @@
+.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: build
+build: dependencies ## Build project
+
+.PHONY: test
+test: ## Run tests
+	bundle exec rake spec
+
+.PHONY: integration-test
+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
+	make -C docker build
+
+.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: 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 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 integration-test
+
+.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

@@ -2,7 +2,7 @@
 
 API client for GOV.UK Notify written in Ruby.
 
-[![Build Status](https://travis-ci.org/alphagov/notifications-ruby-client.svg?branch=master)](https://travis-ci.org/alphagov/notifications-ruby-client)
+[![Gem Version](https://badge.fury.io/rb/notifications-ruby-client.svg)](https://badge.fury.io/rb/notifications-ruby-client)
 
 ## Installation
 
@@ -17,20 +17,11 @@ gem install 'notifications-ruby-client'
 ## Getting started
 
 ```ruby
-require 'notifications-ruby-client'
-client = Notifications::Client.new(service_id, secret_id)
+require 'notifications/client'
+client = Notifications::Client.new(api_key)
 ```
 
-you can also override api endpoint
-
-```ruby
-client = Notifications::Client.new(service_id, secret_id, base_url)
-client.base_url # => Notifications::Client::PRODUCTION_BASE_URL
-```
-
-Generate an API key by logging in to GOV.UK Notify [GOV.UK Notify](https://www.notifications.service.gov.uk) and going to the API integration page.
-
-You will find your service ID on the API integration page.
+Generate an API key by logging in to GOV.UK Notify [GOV.UK Notify](https://www.notifications.service.gov.uk) and going to the **API integration** page.
 
 ### Send a message
 
@@ -156,4 +147,4 @@ e.message # => Invalid credentials
     </td>
   </tr>
   </tbody>
-</table>
+</table>

data/bin/generate_docker_env.sh

@@ -0,0 +1,24 @@
+#!/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
+)
+
+for env_var in "${env_vars[@]}"; do
+    echo "${env_var}=${!env_var}" >> docker.env
+done

data/bin/test_client.rb

@@ -11,18 +11,20 @@ def main
   test_get_notification_by_id_endpoint(client, email_notification.id, 'email')
   test_get_notification_by_id_endpoint(client, sms_notification.id, 'sms')
   test_get_all_notifications(client, sms_notification.id, email_notification.id)
-  p 'ruby client functional tests pass'
+  p 'ruby client integration tests pass'
   exit 0
 end
 
 def test_send_email_endpoint(client)
-  email_resp = client.send_email(to: ENV['FUNCTIONAL_TEST_EMAIL'], template: ENV['EMAIL_TEMPLATE_ID'])
+  email_resp = client.send_email(to: ENV['FUNCTIONAL_TEST_EMAIL'], template: ENV['EMAIL_TEMPLATE_ID'],
+                                 personalisation:Hash["name", "some name"])
   test_notification_response_data_type(email_resp, 'email')
   email_resp
 end
 
 def test_send_sms_endpoint(client)
-  sms_resp = client.send_sms(to: ENV['FUNCTIONAL_TEST_NUMBER'], template: ENV['SMS_TEMPLATE_ID'])
+  sms_resp = client.send_sms(to: ENV['FUNCTIONAL_TEST_NUMBER'], template: ENV['SMS_TEMPLATE_ID'],
+                             personalisation:Hash["name", "some name"])
   test_notification_response_data_type(sms_resp, 'sms')
   sms_resp
 end

data/docker/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.3.1-slim
+
+RUN \
+	echo "Install Debian packages" \
+	&& apt-get update \
+	&& apt-get install -y --no-install-recommends \
+		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

data/docker/Makefile

@@ -0,0 +1,10 @@
+.DEFAULT_GOAL := help
+SHELL := /bin/bash
+
+.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: build
+build:
+	docker build --pull -t govuk/notify-ruby-client-builder .

data/lib/notifications/client.rb

@@ -3,7 +3,7 @@ require "notifications/client/speaker"
 require "notifications/client/notification"
 require "notifications/client/response_notification"
 require "notifications/client/notifications_collection"
-require 'active_support/core_ext/module/delegation'
+require "forwardable"
 
 module Notifications
   class Client
@@ -11,9 +11,8 @@ module Notifications
 
     PRODUCTION_BASE_URL = "https://api.notifications.service.gov.uk".freeze
 
-    delegate :base_url,
-             :base_url=,
-             to: :speaker
+    extend Forwardable
+    def_delegators :speaker, :service_id, :secret_token, :base_url, :base_url=
 
     ##
     # @see Notifications::Client::Speaker#initialize

data/lib/notifications/client/speaker.rb

@@ -7,6 +7,8 @@ module Notifications
   class Client
     class Speaker
       attr_reader :base_url
+      attr_reader :service_id
+      attr_reader :secret_token
 
       BASE_PATH = "/notifications".freeze
       USER_AGENT = "NOTIFY-API-RUBY-CLIENT/#{Notifications::Client::VERSION}".freeze
@@ -18,10 +20,20 @@ module Notifications
       #   secret
       # @param base_url [String] host URL. This is
       #   the address to perform the requests
-      def initialize(service_id, secret_token, base_url = nil)
-        @service_id = service_id
-        @secret_token = secret_token
-        @base_url = base_url || PRODUCTION_BASE_URL
+      def initialize(service_id, secret_token = nil, base_url = nil)
+        if secret_token == nil and base_url == nil
+          @service_id = service_id[service_id.length - 73..service_id.length - 38]
+          @secret_token = service_id[service_id.length - 36..service_id.length]
+          @base_url = PRODUCTION_BASE_URL
+        elsif secret_token.start_with?("http") and base_url == nil
+          @service_id = service_id[service_id.length - 73..service_id.length - 38]
+          @secret_token = service_id[service_id.length - 36..service_id.length]
+          @base_url = secret_token
+        else
+          @service_id = service_id
+          @secret_token = secret_token[secret_token.length - 36..secret_token.length]
+          @base_url = base_url || PRODUCTION_BASE_URL
+        end
       end
 
       ##

data/lib/notifications/client/version.rb

@@ -1,5 +1,5 @@
 module Notifications
   class Client
-    VERSION = "1.0.0".freeze
+    VERSION = "1.1.1".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notifications-ruby-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - bitzesty
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-31 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -119,14 +119,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
+- Makefile
 - README.md
 - Rakefile
 - bin/console
+- bin/generate_docker_env.sh
 - bin/setup
 - bin/test_client.rb
+- docker/Dockerfile
+- docker/Makefile
 - lib/notifications/client.rb
 - lib/notifications/client/notification.rb
 - lib/notifications/client/notifications_collection.rb
@@ -154,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Ruby client for GOV.UK Notifications API

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
- - 2.2.2