defra_ruby_email 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60ee4255b7585ffeb1bf0627b25297617890bc0a
+  data.tar.gz: 979836d5d4392fc967b698a97a83290f69681662
+SHA512:
+  metadata.gz: 48f158c118f2c523ede07ac3e6182cf4871cedb45461ec63bc8e72794712b029cc92cad20650e6aea80ba67af23c031517bebbf2e37186668d0e74f00b0084fa
+  data.tar.gz: 4030b982847e303196cdea3e55df38ae57843d54ac7e78c8968c83f4f76a5577f2069540e20f797a7a97ae205476e39655a5cc172a5c294f94f49b0b9e05c1ce

data/LICENSE

@@ -0,0 +1,8 @@
+The Open Government Licence (OGL) Version 3
+
+Copyright (c) 2020 Defra
+
+This source code is licensed under the Open Government Licence v3.0. To view this
+licence, visit www.nationalarchives.gov.uk/doc/open-government-licence/version/3
+or write to the Information Policy Team, The National Archives, Kew, Richmond,
+Surrey, TW9 4DU.

data/README.md

@@ -0,0 +1,66 @@
+# Defra Ruby Email
+
+[![Build Status](https://travis-ci.com/DEFRA/defra-ruby-email.svg?branch=master)](https://travis-ci.com/DEFRA/defra-ruby-email)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0eb068e0b0ec99debf88/maintainability)](https://codeclimate.com/github/DEFRA/defra-ruby-email/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0eb068e0b0ec99debf88/test_coverage)](https://codeclimate.com/github/DEFRA/defra-ruby-email/test_coverage)
+[![security](https://hakiri.io/github/DEFRA/defra-ruby-email/master.svg)](https://hakiri.io/github/DEFRA/defra-ruby-email/master)
+[![Licence](https://img.shields.io/badge/Licence-OGLv3-blue.svg)](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
+
+> Work in progress. This project is not yet complete!
+
+A Rails Engine used by the [Ruby services team](https://github.com/DEFRA/ruby-services-team) in their digital services.
+
+We use it to allow us to access the content of the last email sent by an app. This information is used by our [acceptance tests](https://github.com/DEFRA/waste-carriers-acceptance-tests) to confirm emails are being sent with the expected content.
+
+When mounted in an app, it will add a new route which when called, will return details of the last email as JSON.
+
+## Prerequisites
+
+Make sure you already have:
+
+- Ruby 2.4.2
+- [Bundler](http://bundler.io/) – for installing Ruby gems
+
+## Installation
+
+You don't need to do this if you're just mounting the engine without making any changes.
+
+However, if you want to edit the engine, you'll have to install it locally.
+
+Clone the repo and drop into the project:
+
+```bash
+git clone https://github.com/DEFRA/defra-ruby-email.git && cd defra-ruby-email
+```
+
+Then install the dependencies with `bundle install`.
+
+## Testing the engine
+
+The engine is mounted in a dummy Rails 4 app (in /spec/dummy) so we can properly test its behaviour.
+
+The test suite is written in RSpec.
+
+To run all the tests, use `bundle exec rspec`.
+
+## Contributing to this project
+
+If you have an idea you'd like to contribute please log an issue.
+
+All contributions should be submitted via a pull request.
+
+## License
+
+THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
+
+<http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3>
+
+The following attribution statement MUST be cited in your products and applications when using this information.
+
+> Contains public sector information licensed under the Open Government license v3
+
+### About the license
+
+The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
+
+It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.

data/Rakefile

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "DefraRubyEmail"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+load "rails/tasks/statistics.rake"
+
+Dir[File.join(File.dirname(__FILE__), "lib/tasks/**/*.rake")].each { |f| load f }
+
+Bundler::GemHelper.install_tasks
+
+# This is wrapped to prevent an error when rake is called in environments where
+# rspec may not be available, e.g. production. As such we don't need to handle
+# the error.
+# rubocop:disable Lint/SuppressedException
+begin
+  require "rspec/core/rake_task"
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end
+# rubocop:enable Lint/SuppressedException

data/app/controllers/defra_ruby_email/application_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/defra_ruby_email/last_email_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  class LastEmailController < ApplicationController
+    def show
+      render json: LastEmailCache.instance.last_email_json
+    end
+  end
+end

data/app/mailers/defra_ruby_email/test_mailer.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  class TestMailer < ActionMailer::Base
+
+    FROM_ADDRESS = "defra-ruby-email@example.com"
+
+    def multipart_email(recipient, add_logo = false)
+      add_logo_attachment if add_logo
+
+      mail(
+        to: recipient,
+        from: FROM_ADDRESS,
+        subject: "Multi-part email"
+      ) do |format|
+        format.html { render html: "<h1>This is the html version of an email</h1>".html_safe }
+        format.text { render plain: "This is the text version of an email" }
+      end
+    end
+
+    def html_email(recipient, add_logo = false)
+      add_logo_attachment if add_logo
+
+      mail(
+        to: recipient,
+        from: FROM_ADDRESS,
+        subject: "HTML email"
+      ) do |format|
+        format.html { render html: "<h1>This is the html version of an email</h1>".html_safe }
+      end
+    end
+
+    def text_email(recipient, add_logo = false)
+      add_logo_attachment if add_logo
+
+      mail(
+        to: recipient,
+        from: FROM_ADDRESS,
+        subject: "Text email"
+      ) do |format|
+        format.text { render plain: "This is the text version of an email" }
+      end
+    end
+
+    private
+
+    def add_logo_attachment
+      path = "/app/assets/images/defra_ruby_email/govuk_logotype_email.png"
+
+      full_path = File.join(Rails.root, path)
+
+      full_path = "#{Gem.loaded_specs['defra_ruby_email'].full_gem_path}#{path}" unless File.exist?(full_path)
+
+      attachments["govuk_logotype_email.png"] = {
+        data: File.read(full_path),
+        mime_type: "image/png"
+      }
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+DefraRubyEmail::Engine.routes.draw do
+  get "/last-email",
+      to: "last_email#show",
+      as: "last_email",
+      constraints: ->(_request) { DefraRubyEmail.configuration.enabled? }
+end

data/lib/defra_ruby_email.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "defra_ruby_email/engine"
+
+module DefraRubyEmail
+  # Enable the ability to configure the gem from its host app, rather than
+  # reading directly from env vars. Derived from
+  # https://robots.thoughtbot.com/mygem-configure-block
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Added for testing. Without we cannot test both a config object with and
+    # with set values in the same rspec session
+    def reset_configuration
+      @configuration = nil
+    end
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/defra_ruby_email/configuration.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  class Configuration
+
+    def initialize
+      @enable = false
+    end
+
+    # Controls whether the mocks are enabled. Only if set to true will the mock
+    # pages be accessible
+    def enable=(arg)
+      # We implement our own setter to handle values being passed in as strings
+      # rather than booleans
+      parsed = arg.to_s.downcase
+
+      @enable = parsed == "true"
+    end
+
+    def enabled?
+      @enable
+    end
+  end
+end

data/lib/defra_ruby_email/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "configuration"
+require_relative "last_email_cache"
+require_relative "last_email_observer"
+
+module DefraRubyEmail
+  class Engine < ::Rails::Engine
+    isolate_namespace DefraRubyEmail
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/defra_ruby_email/last_email_cache.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  class LastEmailCache
+    include Singleton
+
+    EMAIL_ATTRIBUTES = %i[date from to bcc cc reply_to subject].freeze
+
+    attr_accessor :last_email
+
+    # This is necessary to properly test the service functionality
+    def reset
+      @last_email = nil
+    end
+
+    def last_email_json
+      return JSON.generate(error: "No emails sent.") unless last_email.present?
+
+      message_hash = {}
+      EMAIL_ATTRIBUTES.each do |attribute|
+        message_hash[attribute] = last_email.public_send(attribute)
+      end
+      message_hash[:body] = email_body
+      message_hash[:attachments] = last_email.attachments.map(&:filename)
+
+      JSON.generate(last_email: message_hash)
+    end
+
+    # If you've set multipart emails then you'll have both a text and a html
+    # version (determined by adding the relevant erb views). If you do so then
+    # `my_mail.parts.length` will at least equal 2. If you only have one of them
+    # e.g. just a text version then parts doesn't get populated.
+    #
+    # However any attachments will cause ActionMailer to use parts. So for example
+    # if we have a text only email with an attached image, then parts will be of
+    # length 2; one being the content and the other being the attachment.
+    #
+    # To cater for all possibilities we have this method to grab the body content
+    # https://guides.rubyonrails.org/action_mailer_basics.html#sending-multipart-emails
+    # https://stackoverflow.com/a/15818886
+    def email_body
+      part_to_use = last_email.text_part || last_email.html_part || last_email
+
+      # return the message body without the header information
+      part_to_use.body.decoded
+    end
+  end
+end

data/lib/defra_ruby_email/last_email_observer.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  class LastEmailObserver
+
+    def self.delivered_email(message)
+      LastEmailCache.instance.last_email = message
+    end
+
+  end
+end
+
+ActionMailer::Base.register_observer(DefraRubyEmail::LastEmailObserver)

data/lib/defra_ruby_email/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DefraRubyEmail
+  VERSION = "0.1.0"
+end

data/lib/tasks/changelog.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "github_changelog_generator/task"
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.user = "DEFRA"
+  config.project = "defra-ruby-email"
+end

data/lib/tasks/defra_ruby_email_tasks.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# namespace :defra_ruby_email do
+#   desc "Explaining what the task does"
+#   task :test do
+#     # Task goes here
+#   end
+# end

data/spec/defra_ruby_email_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+
+RSpec.describe DefraRubyEmail do
+  describe "VERSION" do
+    it "is a version string in the correct format" do
+      expect(DefraRubyEmail::VERSION).to be_a(String)
+      expect(DefraRubyEmail::VERSION).to match(/\d+\.\d+\.\d+/)
+    end
+  end
+
+  describe "#configuration" do
+    before(:each) { Helpers::Configuration.reset_for_tests }
+
+    context "when the host app has not provided configuration" do
+      let(:enabled) { false }
+
+      it "returns a DefraRubyEmail::Configuration instance with default values" do
+        expect(described_class.configuration).to be_an_instance_of(DefraRubyEmail::Configuration)
+
+        expect(described_class.configuration.enabled?).to eq(enabled)
+      end
+    end
+
+    context "when the host app has provided configuration" do
+      let(:enabled) { true }
+
+      it "returns a DefraRubyEmail::Configuration instance with matching values" do
+        described_class.configure do |config|
+          config.enable = enabled
+        end
+
+        expect(described_class.configuration).to be_an_instance_of(DefraRubyEmail::Configuration)
+        expect(described_class.configuration.enabled?).to eq(enabled)
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.