notifications-ruby-client 4.0.0

data/docker/Dockerfile

@@ -0,0 +1,26 @@
+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

data/docker/Makefile

@@ -0,0 +1,16 @@
+.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 pull `grep "FROM " Dockerfile | cut -d ' ' -f 2` || true
+	docker build \
+		--build-arg HTTP_PROXY="${HTTP_PROXY}" \
+		--build-arg HTTPS_PROXY="${HTTP_PROXY}" \
+		--build-arg NO_PROXY="${NO_PROXY}" \
+		-t govuk/notify-ruby-client-builder \
+		.

data/lib/notifications/client.rb

@@ -0,0 +1,153 @@
+require_relative "client/version"
+require_relative "client/speaker"
+require_relative "client/notification"
+require_relative "client/response_notification"
+require_relative "client/response_precompiled_letter"
+require_relative "client/notifications_collection"
+require_relative "client/received_text"
+require_relative "client/received_text_collection"
+require_relative "client/response_template"
+require_relative "client/template_collection"
+require_relative "client/template_preview"
+require_relative "client/uuid_validator"
+require_relative "client/helper_methods"
+require "forwardable"
+
+module Notifications
+  class Client
+    attr_reader :speaker
+
+    PRODUCTION_BASE_URL = "https://api.notifications.service.gov.uk".freeze
+    MAX_FILE_UPLOAD_SIZE = 2 * 1024 * 1024 # 2MB limit on uploaded documents
+
+    extend Forwardable
+    def_delegators :speaker, :service_id, :secret_token, :base_url, :base_url=
+
+    ##
+    # @see Notifications::Client::Speaker#initialize
+    def initialize(*args)
+      @speaker = Speaker.new(*args)
+    end
+
+    ##
+    # @see Notifications::Client::Speaker#post
+    # @return [ResponseNotification]
+    def send_email(args)
+      ResponseNotification.new(
+        speaker.post("email", args)
+      )
+    end
+
+    ##
+    # @see Notifications::Client::Speaker#post
+    # @return [ResponseNotification]
+    def send_sms(args)
+      ResponseNotification.new(
+        speaker.post("sms", args)
+      )
+    end
+
+    ##
+    # @see Notifications::Client::Speaker#post
+    # @return [ResponseNotification]
+    def send_letter(args)
+      ResponseNotification.new(
+        speaker.post("letter", args)
+      )
+    end
+
+    ##
+    # @param reference [String]
+    # @param pdf_file [File]
+    # @see Notifications::Client::Speaker#post_precompiled_letter
+    # @return [ResponsePrecompiledLetter]
+    def send_precompiled_letter(reference, pdf_file, postage = nil)
+      ResponsePrecompiledLetter.new(
+        speaker.post_precompiled_letter(reference, pdf_file, postage)
+      )
+    end
+
+    ##
+    # @param id [String]
+    # @see Notifications::Client::Speaker#get
+    # @return [Notification]
+    def get_notification(id)
+      Notification.new(
+        speaker.get(id)
+      )
+    end
+
+    ##
+    # @param options [Hash]
+    # @option options [String] :template_type
+    #   sms or email
+    # @option options [String] :status
+    #   sending, delivered, permanently failed,
+    #   temporarily failed, or technical failure
+    # @option options [String] :reference
+    #   your reference for the notification
+    # @option options [String] :older_than
+    #   notification id to return notificaitons that are older than this id.
+    # @see Notifications::Client::Speaker#get
+    # @return [NotificationsCollection]
+    def get_notifications(options = {})
+      NotificationsCollection.new(
+        speaker.get(nil, options)
+      )
+    end
+
+    ##
+    # @param id [String]
+    # @return [Template]
+    def get_template_by_id(id, options = {})
+      path = "/v2/template/" << id
+      Template.new(
+        speaker.get_with_url(path, options)
+      )
+    end
+
+    ##
+    # @param id [String]
+    # @param version [int]
+    # @return [Template]
+    def get_template_version(id, version, options = {})
+      path = "/v2/template/" << id << "/version/" << version.to_s
+      Template.new(
+        speaker.get_with_url(path, options)
+      )
+    end
+
+    ##
+    # @option options [String] :type
+    #   email, sms, letter
+    # @return [TemplateCollection]
+    def get_all_templates(options = {})
+      path = "/v2/templates"
+      TemplateCollection.new(
+        speaker.get_with_url(path, options)
+      )
+    end
+
+    ##
+    # @param options [String]
+    # @option personalisation [Hash]
+    # @return [TemplatePreview]
+    def generate_template_preview(id, options = {})
+      path = "/v2/template/" << id << "/preview"
+      TemplatePreview.new(
+        speaker.post_with_url(path, options)
+      )
+    end
+
+    ##
+    # @option options [String] :older_than
+    #   received text id to return received texts that are older than this id.
+    # @return [ReceivedTextCollection]
+    def get_received_texts(options = {})
+      path = "/v2/received-text-messages"
+      ReceivedTextCollection.new(
+        speaker.get_with_url(path, options)
+      )
+    end
+  end
+end

data/lib/notifications/client/helper_methods.rb

@@ -0,0 +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
+
+    { file: Base64.strict_encode64(file.read) }
+  end
+end

data/lib/notifications/client/notification.rb

@@ -0,0 +1,54 @@
+require 'time'
+
+module Notifications
+  class Client
+    class Notification
+      FIELDS = %i(
+        id
+        reference
+        email_address
+        phone_number
+        line_1
+        line_2
+        line_3
+        line_4
+        line_5
+        line_6
+        postcode
+        postage
+        type
+        status
+        template
+        body
+        subject
+        sent_at
+        created_at
+        completed_at
+        created_by_name
+      ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(notification)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", notification.fetch(field.to_s, nil))
+        end
+      end
+
+      %i(
+        sent_at
+        created_at
+        completed_at
+      ).each do |field|
+        define_method field do
+          begin
+            value = instance_variable_get(:"@#{field}")
+            Time.parse value
+          rescue StandardError
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/notifications_collection.rb

@@ -0,0 +1,19 @@
+module Notifications
+  class Client
+    class NotificationsCollection
+      attr_reader :links,
+                  :collection
+
+      def initialize(response)
+        @links = response["links"]
+        @collection = collection_from(response["notifications"])
+      end
+
+      def collection_from(notifications)
+        notifications.map do |notification|
+          Notification.new(notification)
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/received_text.rb

@@ -0,0 +1,31 @@
+require 'time'
+
+module Notifications
+  class Client
+    class ReceivedText
+      FIELDS = %i(
+        id
+        created_at
+        content
+        notify_number
+        service_id
+        user_number
+      ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(received_text)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", received_text.fetch(field.to_s, nil))
+        end
+      end
+
+      def created_at
+        value = instance_variable_get(:@created_at)
+        Time.parse(value)
+      rescue StandardError
+        value
+      end
+    end
+  end
+end

data/lib/notifications/client/received_text_collection.rb

@@ -0,0 +1,18 @@
+module Notifications
+  class Client
+    class ReceivedTextCollection
+      attr_reader :links, :collection
+
+      def initialize(response)
+        @links = response["links"]
+        @collection = collection_from(response["received_text_messages"])
+      end
+
+      def collection_from(received_texts)
+        received_texts.map do |received_text|
+          ReceivedText.new(received_text)
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/request_error.rb

@@ -0,0 +1,59 @@
+module Notifications
+  class Client
+    class RequestError < StandardError
+      attr_reader :code, :body
+
+      def initialize(response)
+        @code = response.code
+        @body = parse_body(response.body)
+      end
+
+      def parse_body(body)
+        JSON.parse(body)
+      rescue JSON::ParserError
+        body
+      end
+
+      def message
+        return body if body.is_a?(String)
+
+        error_messages = body.fetch('errors')
+                             .map { |e| "#{e.fetch('error')}: #{e.fetch('message')}" }
+        error_messages.join(", ")
+      end
+    end
+
+    class ClientError < RequestError; end
+    class BadRequestError < ClientError; end
+    class AuthError < ClientError; end
+    class NotFoundError < ClientError; end
+    class RateLimitError < ClientError; end
+
+    class ServerError < RequestError; end
+
+    module ErrorHandling
+      def build_error(response)
+        error_class_for_code(response.code.to_i).new(response)
+      end
+
+      def error_class_for_code(code)
+        case code
+        when 400
+          BadRequestError
+        when 403
+          AuthError
+        when 404
+          NotFoundError
+        when 429
+          RateLimitError
+        when (400..499)
+          ClientError
+        when (500..599)
+          ServerError
+        else
+          RequestError
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/response_notification.rb

@@ -0,0 +1,21 @@
+module Notifications
+  class Client
+    class ResponseNotification
+      FIELDS = %i(
+      id
+      reference
+      content
+      template
+      uri
+    ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(notification)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", notification.fetch(field.to_s, nil))
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/response_precompiled_letter.rb

@@ -0,0 +1,19 @@
+module Notifications
+  class Client
+    class ResponsePrecompiledLetter
+      FIELDS = %i(
+      id
+      reference
+      postage
+    ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(notification)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", notification.fetch(field.to_s, nil))
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/response_template.rb

@@ -0,0 +1,41 @@
+require 'time'
+
+module Notifications
+  class Client
+    class Template
+      FIELDS = %i(
+        id
+        type
+        name
+        created_at
+        updated_at
+        created_by
+        version
+        body
+        subject
+      ).freeze
+
+      attr_reader(*FIELDS)
+
+      def initialize(notification)
+        FIELDS.each do |field|
+          instance_variable_set(:"@#{field}", notification.fetch(field.to_s, nil))
+        end
+      end
+
+      %i(
+        created_at
+        updated_at
+      ).each do |field|
+        define_method field do
+          begin
+            value = instance_variable_get(:"@#{field}")
+            Time.parse value
+          rescue StandardError
+            value
+          end
+        end
+      end
+    end
+  end
+end