gov_fake_notify 1.1.1

data/lib/gov_fake_notify/commands/fetch_all_messages_status_command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'mail'
+require 'erb'
+require 'tilt'
+require 'gov_fake_notify/store'
+
+module GovFakeNotify
+  # A service used to fetch all message statuses
+  class FetchAllMessagesStatusCommand
+
+    attr_reader :errors
+
+    def self.call(params, **kwargs)
+      new(params, **kwargs).call
+    end
+
+    def initialize(params, store: Store.instance)
+      @params = params
+      @store = store
+      @errors = []
+      @messages = []
+    end
+
+    def call
+      message_keys = store.transaction { store.roots.select { |k| k =~ /^message-/ } }
+      @messages = store.transaction { message_keys.map { |key| store.fetch(key) } }
+
+      self
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def to_json
+      # We do not support links yet
+      JSON.pretty_generate(notifications: messages, links: [])
+    end
+
+    private
+
+    attr_reader :params, :store, :messages
+  end
+end

data/lib/gov_fake_notify/commands/fetch_file_command.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'mail'
+require 'erb'
+require 'tilt'
+require 'gov_fake_notify/store'
+require 'gov_fake_notify/attachment_store'
+
+module GovFakeNotify
+  # A service used to fetch an attached file
+  class FetchFileCommand
+
+    attr_reader :filename, :errors
+
+    def self.call(id, **kwargs)
+      new(id, **kwargs).call
+    end
+
+    def initialize(id, attachment_store: AttachmentStore.instance)
+      @id = id
+      @attachment_store = attachment_store
+      @errors = []
+    end
+
+    def call
+      file_data = attachment_store.fetch(id)
+      errors << 'File not found' and return if file_data.nil?
+
+      @filename = file_data['file']
+      self
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    private
+
+    attr_reader :id, :attachment_store
+  end
+end

data/lib/gov_fake_notify/commands/fetch_message_status_command.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'mail'
+require 'erb'
+require 'tilt'
+require 'gov_fake_notify/store'
+
+module GovFakeNotify
+  # A service used to fetch a message status
+  class FetchMessageStatusCommand
+
+    attr_reader :errors
+
+    def self.call(id, **kwargs)
+      new(id, **kwargs).call
+    end
+
+    def initialize(id, store: Store.instance)
+      @id = id
+      @store = store
+      @errors = []
+      @message = nil
+    end
+
+    def call
+      @message = store.transaction { store.fetch("message-#{id}") }
+      errors << 'Message not found' and return if message.nil?
+
+      self
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def to_json
+      JSON.pretty_generate(message)
+    end
+
+    private
+
+    attr_reader :id, :store, :message
+  end
+end

data/lib/gov_fake_notify/commands/fetch_templates_command.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'mail'
+require 'erb'
+require 'tilt'
+require 'gov_fake_notify/store'
+
+module GovFakeNotify
+  # A service used to fetch all templates
+  class FetchTemplatesCommand
+    attr_reader :errors
+
+    def self.call(params, **kwargs)
+      new(params, **kwargs).call
+    end
+
+    def initialize(params, store: Store.instance)
+      @params = params
+      @store = store
+      @errors = []
+      @results = []
+    end
+
+    def call
+      @results = store.transaction { store.roots.select { |k| k =~ /^template-/ } }.map do |key|
+        store.transaction { store.fetch(key).slice('id', 'name', 'subject') }
+      end
+      self
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def to_json
+      JSON.pretty_generate(templates: results)
+    end
+
+    private
+
+    attr_reader :params, :store, :results
+  end
+end

data/lib/gov_fake_notify/commands/send_email_command.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'mail'
+require 'erb'
+require 'tilt'
+require 'gov_fake_notify/store'
+require 'gov_fake_notify/attachment_store'
+
+module GovFakeNotify
+  # A service used when the sending of an email is requested
+  class SendEmailCommand # rubocop:disable Metrics/ClassLength
+    def self.call(params, **kwargs)
+      # do nothing yet
+      new(params, **kwargs).call
+    end
+
+    def initialize(params, base_url:, service:, store: Store.instance, attachment_store: AttachmentStore.instance)
+      @params = params.dup
+      @store = store
+      @attachment_store = attachment_store
+      @base_url = base_url
+      @service = service
+    end
+
+    def call
+      template_data = store.transaction { store["template-#{params['template_id']}"] }
+      send_email_from_template(template_data)
+      persist_status(template_data)
+      self
+    end
+
+    def success?
+      true
+    end
+
+    def to_json(*_args) # rubocop:disable Metrics/MethodLength
+      ::JSON.generate({
+                        "id": id,
+                        "reference": 'STRING',
+                        "content": {
+                          "body": message_body,
+                          "from_number": 'govfakenotify@email.com'
+                        },
+                        "uri": "#{base_url}/v2/notifications/#{id}",
+                        "template": {
+                          "id": 'f33517ff-2a88-4f6e-b855-c550268ce08a',
+                          "version": 1,
+                          "uri": "#{base_url}/v2/template/ceb50d92-100d-4b8b-b559-14fa3b091cd"
+                        }
+                      })
+    end
+
+    private
+
+    attr_reader :params, :store, :attachment_store, :base_url, :message_body, :id, :service
+
+    def send_email_from_template(template_data) # rubocop:disable Metrics/MethodLength
+      pre_process_files
+      our_params = params
+      our_body = mail_message(template_data)
+      our_service = service
+      @message_body = our_body
+      mail = Mail.new do
+        from    our_service['service_email']
+        to      our_params['email_address']
+        subject template_data['subject']
+        html_part do
+          content_type 'text/html; charset=UTF-8'
+          body our_body
+        end
+        text_part do
+          body 'text part to go here'
+        end
+      end
+      mail.deliver
+      @id = SecureRandom.uuid
+    end
+
+    def persist_status(template_data) # rubocop:disable Metrics/MethodLength
+      store.transaction do
+        store["message-#{id}"] = { id: id,
+                                   email_address: params['email_address'],
+                                   type: 'email',
+                                   status: 'delivered',
+                                   template: {
+                                     Version: 1,
+                                     id: 'f33517ff-2a88-4f6e-b855-c550268ce08a',
+                                     uri: "#{base_url}/v2/template/ceb50d92-100d-4b8b-b559-14fa3b091cd"
+                                   },
+                                   body: message_body,
+                                   subject: template_data['subject'],
+                                   created_at: Time.now.to_s }
+      end
+    end
+
+    def pre_process_files
+      params['personalisation'].each_pair do |key, value|
+        next unless value.is_a?(Hash) && value.keys.include?('file')
+
+        params['personalisation'][key] = attachment_store.store(value)
+      end
+    end
+
+    def mail_message(template_data)
+      layout = Tilt.new(File.absolute_path('../../views/layouts/govuk.html.erb', __dir__))
+      layout.render do
+        template_content(template_data)
+      end
+    end
+
+    def template_content(template_data)
+      template = template_data['message']
+      buffer = ''.dup
+      template.each_line do |line|
+        buffer << format_line(line)
+      end
+      buffer
+    end
+
+    def format_line(line)
+      replaced = line.gsub(/\(\(([^)]*)\)\)/) do
+        post_process_value params['personalisation'][Regexp.last_match[1]]
+      end
+      wrap_line(replaced)
+    end
+
+    def post_process_value(value)
+      return value unless value.is_a?(Hash) && value.keys.include?('file')
+
+      render_file(value)
+    end
+
+    def wrap_line(line)
+      case line
+      when /^---/ then render_horizontal_line
+      else render_paragraph(line)
+      end
+    end
+
+    def render_horizontal_line
+      Tilt.new(File.absolute_path('../../views/govuk/horizontal_line.html.erb', __dir__)).render
+    end
+
+    def render_paragraph(line)
+      Tilt.new(File.absolute_path('../../views/govuk/paragraph.html.erb', __dir__)).render(nil, content: line)
+    end
+
+    def render_file(file_data)
+      Tilt.new(File.absolute_path('../../views/govuk/file.html.erb', __dir__)).render(nil, file_data: file_data,
+                                                                                           base_url: base_url)
+    end
+  end
+end

data/lib/gov_fake_notify/config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'fileutils'
+require 'yaml'
+
+# GovFakeNotify module
+module GovFakeNotify
+  # Central configuration singleton
+  class Config
+    include Singleton
+
+    attr_accessor :smtp_address, :smtp_port, :smtp_user_name, :smtp_password,
+                  :smtp_authentication, :smtp_enable_starttls_auto,
+                  :base_url, :database_file, :attachments_path, :include_templates,
+                  :include_api_keys, :delivery_method, :port
+
+    def from(hash)
+      hash.each_pair do |key, value|
+        next unless respond_to?(:"#{key}=")
+
+        send(:"#{key}=", value)
+      end
+    end
+  end
+
+  Config.instance.tap do |c| # rubocop:disable Metrics/BlockLength
+    c.smtp_address = ENV.fetch('GOV_FAKE_NOTIFY_SMTP_HOSTNAME', 'localhost')
+    c.smtp_port = ENV.fetch('GOV_FAKE_NOTIFY_SMTP_PORT', '1025').to_i
+    c.smtp_user_name = ENV['GOV_FAKE_NOTIFY_SMTP_USERNAME']
+    c.smtp_password = ENV['GOV_FAKE_NOTIFY_SMTP_PASSWORD']
+    c.base_url = ENV.fetch('GOV_FAKE_NOTIFY_BASE_URL', 'http://localhost:8080')
+    c.smtp_authentication = nil
+    c.smtp_enable_starttls_auto = false
+    c.database_file = "#{ENV['HOME']}/.gov_fake_notify/store"
+    c.attachments_path = "#{ENV['HOME']}/.gov_fake_notify/attachments"
+    c.include_templates = []
+    c.include_api_keys = []
+    c.delivery_method = 'smtp'
+    c.port = 8080
+  end
+end

data/lib/gov_fake_notify/control_app.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'json'
+require 'gov_fake_notify/commands/create_template_command'
+module GovFakeNotify
+  # A group of endpoints dedicated to controlling the app from the command line or API - for development and test only
+  class ControlApp < Roda
+    plugin :request_headers
+    plugin :halt
+    plugin :sinatra_helpers
+    plugin :json_parser
+    route do |r|
+      r.is 'reset' do
+        r.post do
+          GovFakeNotify.reset!
+        end
+      end
+      r.is 'templates' do
+        r.post do
+          result = CreateTemplateCommand.call(request.params)
+          if result.success?
+            result.to_json
+          else
+            r.halt 422, { message: 'Command failed' }.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gov_fake_notify/current_service.rb

@@ -0,0 +1,22 @@
+module GovFakeNotify
+  module CurrentService
+    def current_service(store: Store.instance)
+      header = request.headers['Authorization'].gsub(/^Bearer /, '')
+      store.transaction do
+        store.roots.each do |root|
+          next unless root.start_with?('apikey')
+
+          return store[root].dup if validate_jwt(header, store[root]['secret_token'])
+        end
+      end
+      nil
+    end
+
+    def validate_jwt(token, secret)
+      JWT.decode token, secret, 'HS256'
+      true
+    rescue JWT::DecodeError
+      false
+    end
+  end
+end

data/lib/gov_fake_notify/files_app.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'json'
+require 'gov_fake_notify/commands/send_email_command'
+require 'gov_fake_notify/commands/fetch_file_command'
+require 'tilt'
+module GovFakeNotify
+  # Serves all attachment files
+  class FilesApp < Roda
+    plugin :request_headers
+    plugin :halt
+    plugin :sinatra_helpers
+    route do |r|
+      unless (service = current_service)
+        r.halt 403, { 'Content-Type' => 'application/json' }, { message: 'Invalid or missing token' }.to_json
+      end
+      r.is 'download', String do |id|
+        Tilt.new(File.absolute_path('../views/files/download.html.erb', __dir__)).render(nil, service_name: 'Employment Tribunals', service_email: 'et@test.com', id: id)
+      end
+      r.is 'confirm', String do |id|
+        Tilt.new(File.absolute_path('../views/files/confirm.html.erb', __dir__)).render(nil, service_name: 'Employment Tribunals', service_email: 'et@test.com', id: id)
+      end
+      r.is String do |id|
+        r.get do
+          result = FetchFileCommand.call(id)
+          if result.success?
+            attachment result.filename
+            send_file result.filename
+          else
+            r.halt 422, { message: 'Email failed to send' }.to_json
+          end
+        end
+      end
+    end
+
+    def base_url
+      request.url.gsub(%r{/v\d+/.*}, '')
+    end
+  end
+end

data/lib/gov_fake_notify/iodine.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'iodine'
+# Iodine setup - use conditional setup to allow command-line arguments to override these:
+if defined?(Iodine)
+  Iodine.threads = ENV.fetch('RAILS_MAX_THREADS', 1).to_i if Iodine.threads.zero?
+  Iodine.workers = ENV.fetch('WEB_CONCURRENCY', 1).to_i if Iodine.workers.zero?
+  Iodine::DEFAULT_SETTINGS[:port] = ENV.fetch('PORT') if ENV.key?('PORT')
+end

data/lib/gov_fake_notify/notifications_app.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'json'
+require 'jwt'
+require 'gov_fake_notify/commands/send_email_command'
+require 'gov_fake_notify/commands/fetch_message_status_command'
+require 'gov_fake_notify/commands/fetch_all_messages_status_command'
+require 'gov_fake_notify/current_service'
+module GovFakeNotify
+  # Serves all notifications resources
+  class NotificationsApp < Roda
+    include CurrentService
+    plugin :request_headers
+    plugin :halt
+    plugin :sinatra_helpers
+    plugin :json_parser
+    route do |r| # rubocop:disable Metrics:BlockLength
+      unless (service = current_service)
+        r.halt 403, { 'Content-Type' => 'application/json' }, { message: 'Invalid or missing token' }.to_json
+      end
+      r.is 'email' do
+        r.post do
+          result = SendEmailCommand.call(request.params, base_url: base_url, service: service)
+          if result.success?
+            result.to_json
+          else
+            r.halt 422, { message: 'Email failed to send' }.to_json
+          end
+        end
+      end
+      r.is String do |id|
+        r.get do
+          result = FetchMessageStatusCommand.call(id)
+          if result.success?
+            result.to_json
+          else
+            r.halt 404, { message: result.errors.join(', ') }.to_json
+          end
+        end
+      end
+      r.is do
+        r.get do
+          result = FetchAllMessagesStatusCommand.call(request.params)
+          if result.success?
+            result.to_json
+          else
+            r.halt 404, { message: result.errors.join(', ') }.to_json
+          end
+        end
+      end
+    end
+
+    def base_url
+      request.url.gsub(%r{/v\d+/.*}, '')
+    end
+  end
+end

data/lib/gov_fake_notify/root_app.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'gov_fake_notify/notifications_app'
+require 'gov_fake_notify/files_app'
+require 'gov_fake_notify/control_app'
+require 'gov_fake_notify/templates_app'
+require 'gov_fake_notify/current_service'
+
+module GovFakeNotify
+  # The root application
+  class RootApp < Roda
+    include CurrentService
+    plugin :multi_run
+    plugin :common_logger
+    run 'v2/notifications', NotificationsApp
+    run 'v2/templates', TemplatesApp
+    run 'files', FilesApp
+    run 'control', ControlApp
+
+    route(&:multi_run)
+  end
+end

data/lib/gov_fake_notify/store.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'pstore'
+module GovFakeNotify
+  # A central store for storing all state in the app - uses a basic PStore
+  class Store
+    def self.instance
+      Thread.current[:gov_fake_notify_store] ||= ::PStore.new(GovFakeNotify.config.database_file)
+    end
+
+    def self.clear_messages!
+      instance.transaction do
+        instance.roots.each do |key|
+          next unless key =~ /^message-/
+
+          instance.delete(key)
+        end
+      end
+      clear_attachments!
+    end
+
+    def self.clear_attachments!(config: Config.instance)
+      FileUtils.rm_rf File.join(config.attachments_path, '.')
+    end
+  end
+end

data/lib/gov_fake_notify/templates_app.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'json'
+require 'gov_fake_notify/commands/fetch_templates_command'
+require 'gov_fake_notify/current_service'
+
+module GovFakeNotify
+  # A group of endpoints for the templates
+  class TemplatesApp < Roda
+    include CurrentService
+    plugin :request_headers
+    plugin :halt
+    plugin :sinatra_helpers
+    plugin :json_parser
+    route do |r|
+      unless current_service
+        r.halt 403, { 'Content-Type' => 'application/json' }, { message: 'Invalid or missing token' }.to_json
+      end
+      r.is do
+        r.get do
+          result = FetchTemplatesCommand.call(request.params)
+          if result.success?
+            result.to_json
+          else
+            r.halt 404, { message: result.errors.join(', ') }.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gov_fake_notify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GovFakeNotify
+  VERSION = '1.1.1'
+end