notifications-ruby-client 4.0.0

data/lib/notifications/client/speaker.rb

@@ -0,0 +1,171 @@
+require "base64"
+require "net/https"
+require "uri"
+require "jwt"
+require_relative "request_error"
+
+module Notifications
+  class Client
+    class Speaker
+      include ErrorHandling
+
+      attr_reader :base_url
+      attr_reader :service_id
+      attr_reader :secret_token
+
+      BASE_PATH = "/v2/notifications".freeze
+      USER_AGENT = "NOTIFY-API-RUBY-CLIENT/#{Notifications::Client::VERSION}".freeze
+
+      ##
+      # @param secret [String] your service API secret
+      # @param base_url [String] host URL. This is the address to perform the requests.
+      #                          If left nil the production url is used.
+      def initialize(secret_token = nil, base_url = nil)
+        @service_id = secret_token[secret_token.length - 73..secret_token.length - 38]
+        @secret_token = secret_token[secret_token.length - 36..secret_token.length]
+        @base_url = base_url || PRODUCTION_BASE_URL
+
+        validate_uuids!
+      end
+
+      ##
+      # @param kind [String] 'email', 'sms' or 'letter'
+      # @param form_data [Hash]
+      # @option form_data [String] :phone_number
+      #   phone number of the sms recipient
+      # @option form_data [String] :email_address
+      #   email address of the email recipent
+      # @option form_data [String] :template
+      #   template to render in notification
+      # @option form_data [Hash] :personalisation
+      #   fields to use in the template
+      # @option form_data [String] :reference
+      #   A reference specified by the service for the notification. Get all notifications can be filtered by this reference.
+      #   This reference can be unique or used used to refer to a batch of notifications.
+      #   Can be an empty string or nil, when you do not require a reference for the notifications.
+      # @option form_data [String] :email_reply_to_id
+      #   id of the email address that replies to email notifications will be sent to
+      # @option form_data [String] :sms_sender_id
+      #   id of the sender to be used for an sms notification
+      # @see #perform_request!
+      def post(kind, form_data)
+        request = Net::HTTP::Post.new(
+          "#{BASE_PATH}/#{kind}",
+          headers
+        )
+        request.body = form_data.is_a?(Hash) ? form_data.to_json : form_data
+        perform_request!(request)
+      end
+
+      ##
+      # @param id [String]
+      # @param options [Hash] query
+      # @see #perform_request!
+      def get(id = nil, options = {})
+        path = BASE_PATH.dup
+        path << "/" << id if id
+        path << "?" << URI.encode_www_form(options) if options.any?
+        request = Net::HTTP::Get.new(path, headers)
+        perform_request!(request)
+      end
+
+      ##
+      # @param url path of endpoint
+      # @param id [String]
+      # @param options [Hash] query
+      # @see #perform_request!
+      def get_with_url(url, options = {})
+        path = url
+        path << "?" << URI.encode_www_form(options) if options.any?
+        request = Net::HTTP::Get.new(path, headers)
+        perform_request!(request)
+      end
+
+      ##
+      # @param url [String] path of the endpoint
+      # @param form_data [Hash]
+      # @option form_data [String] :template_id
+      #   id of the template to render
+      # @option form_data [Hash] :personalisation
+      #   fields to use in the template
+      # @see #perform_request!
+      def post_with_url(url, form_data)
+        request = Net::HTTP::Post.new(
+          url,
+          headers
+        )
+        request.body = form_data.is_a?(Hash) ? form_data.to_json : form_data
+        perform_request!(request)
+      end
+
+      ##
+      # @param reference [String] reference of the notification
+      # @param pdf_file [File] PDF file opened for reading
+      # @see #perform_request!
+      def post_precompiled_letter(reference, pdf_file, postage = nil)
+        content = Base64.strict_encode64(pdf_file.read)
+        form_data = { reference: reference, content: content }
+
+        if postage != nil
+          form_data[:postage] = postage
+        end
+
+        request = Net::HTTP::Post.new(
+          "#{BASE_PATH}/letter",
+          headers
+        )
+        request.body = form_data.to_json
+        perform_request!(request)
+      end
+
+    private
+
+      ##
+      # @return [Hash] JSON parsed response
+      # @raise [RequestError] if request is
+      #   not successful
+      def perform_request!(request)
+        response = open(request)
+        if response.is_a?(Net::HTTPClientError) || response.is_a?(Net::HTTPServerError)
+          raise build_error(response)
+        else
+          JSON.parse(response.body)
+        end
+      end
+
+      def open(request)
+        uri = URI.parse(@base_url)
+        Net::HTTP.start(uri.host, uri.port, :ENV, use_ssl: uri.scheme == 'https') do |http|
+          http.request(request)
+        end
+      end
+
+      def headers
+        {
+          "User-agent" => USER_AGENT,
+          "Content-Type" => "application/json",
+          "Authorization" => "Bearer " + jwt_token
+        }
+      end
+
+      def jwt_token
+        payload = {
+          iss: @service_id,
+          iat: Time.now.to_i
+        }
+        JWT.encode payload, @secret_token, "HS256"
+      end
+
+      def validate_uuids!
+        contextual_message = [
+          "This error is probably caused by initializing the Notifications client with an invalid API key.",
+          "You can generate a new API key by logging into Notify and visiting the 'API integration' page:",
+          "https://www.notifications.service.gov.uk",
+        ].join("\n")
+
+        UuidValidator.validate!(@service_id, contextual_message)
+        UuidValidator.validate!(@secret_token, contextual_message)
+      end
+    end
+  end
+end

data/lib/notifications/client/template_collection.rb

@@ -0,0 +1,16 @@
+module Notifications
+  class Client
+    class TemplateCollection
+      attr_reader :collection
+      def initialize(response)
+        @collection = collection_from(response["templates"])
+      end
+
+      def collection_from(templates)
+        templates.map do |template|
+          Template.new(template)
+        end
+      end
+    end
+  end
+end

data/lib/notifications/client/template_preview.rb

@@ -0,0 +1,22 @@
+module Notifications
+  class Client
+    class TemplatePreview
+      FIELDS = %i(
+        id
+        version
+        body
+        subject
+        type
+        html
+      ).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/uuid_validator.rb

@@ -0,0 +1,25 @@
+module Notifications
+  class UuidValidator
+    HEX = /[0-9a-f]/
+    REGEX = /^#{HEX}{8}-#{HEX}{4}-#{HEX}{4}-#{HEX}{4}-#{HEX}{12}$/
+
+    attr_accessor :uuid
+
+    def initialize(uuid)
+      self.uuid = uuid
+    end
+
+    def valid?
+      !!(uuid && uuid.match(REGEX))
+    end
+
+    def self.validate!(uuid, contextual_message = nil)
+      return if new(uuid).valid?
+
+      message = "#{uuid.inspect} is not a valid uuid"
+      message += "\n#{contextual_message}" if contextual_message
+
+      raise ArgumentError, message
+    end
+  end
+end

data/lib/notifications/client/version.rb

@@ -0,0 +1,14 @@
+# Version numbering follows Semantic Versionning:
+#
+# Given a version number MAJOR.MINOR.PATCH, increment the:
+# - MAJOR version when you make incompatible API changes,
+# - MINOR version when you add functionality in a backwards-compatible manner, and
+# - PATCH version when you make backwards-compatible bug fixes.
+#
+# -- http://semver.org/
+
+module Notifications
+  class Client
+    VERSION = "4.0.0".freeze
+  end
+end

data/notifications-ruby-client.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notifications/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notifications-ruby-client"
+  spec.version       = Notifications::Client::VERSION
+  spec.authors       = [
+    "Government Digital Service"
+  ]
+
+  spec.email         = ["notify@digital.cabinet-office.gov.uk"]
+
+  spec.summary       = "Ruby client for GOV.UK Notifications API"
+  spec.homepage      = "https://github.com/alphagov/notifications-ruby-client"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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 "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"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: notifications-ruby-client
+version: !ruby/object:Gem::Version
+  version: 4.0.0
+platform: ruby
+authors:
+- Government Digital Service
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.10'
+  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'
+description: 
+email:
+- notify@digital.cabinet-office.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- DOCUMENTATION.md
+- 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/helper_methods.rb
+- lib/notifications/client/notification.rb
+- lib/notifications/client/notifications_collection.rb
+- lib/notifications/client/received_text.rb
+- lib/notifications/client/received_text_collection.rb
+- lib/notifications/client/request_error.rb
+- lib/notifications/client/response_notification.rb
+- lib/notifications/client/response_precompiled_letter.rb
+- lib/notifications/client/response_template.rb
+- lib/notifications/client/speaker.rb
+- lib/notifications/client/template_collection.rb
+- lib/notifications/client/template_preview.rb
+- lib/notifications/client/uuid_validator.rb
+- lib/notifications/client/version.rb
+- notifications-ruby-client.gemspec
+homepage: https://github.com/alphagov/notifications-ruby-client
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for GOV.UK Notifications API
+test_files: []