mail-notify 1.2.0 → 2.0.0

data/lib/mail/notify/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mail
+  module Notify
+    class Engine < Rails::Engine
+      initializer "mail-notify.add_delivery_method", before: "action_mailer.set_configs" do
+        ActionMailer::Base.add_delivery_method(:notify, Mail::Notify::DeliveryMethod)
+
+        config.action_mailer.preview_interceptors = [:mail_notify_preview_interceptor]
+      end
+    end
+  end
+end

data/lib/mail/notify/mail_notify_preview_interceptor.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+##
+# This is a ActionMailer interceptor class for previews from the Notifications API
+#
+# See ActionMailer::Base:
+#
+# https://github.com/rails/rails/blob/v5.2.8.1/actionmailer/lib/action_mailer/base.rb#L367
+
+class MailNotifyPreviewInterceptor
+  ##
+  # ActionMailer call back when a preview is being generated.
+  #
+  # Transforms the content of the passed in message.
+
+  def self.previewing_email(message)
+    new(message).transform!
+  end
+
+  ##
+  # Creates a new MailNotifyPreviewInterceptor ready for use.
+
+  def initialize(message)
+    @message = message
+  end
+
+  ##
+  # Transforms the content of the message to that from the Notifications API preview.
+  #
+  # The html is wrapped in a layout and rendered by the MailNotifyPreviewsControllers renderer.
+
+  def transform!
+    # the messages delivery method will be our Mail::Notify::DeliveryMethod and have the `preview` method.
+    preview = @message.delivery_method.preview(@message)
+
+    @message.subject = preview.subject
+    @message.html_part.body = renderer.render html: preview.html.html_safe, layout: "govuk_notify_layout"
+    @message.text_part.body = preview.body
+
+    @message
+  end
+
+  private
+
+  def renderer
+    # rendering in Rails without a controller gets far too complicated, instead
+    # we rely on this empty controller to do it for us.
+
+    MailNotifyPreviewsController.renderer
+  end
+end

data/lib/mail/notify/mail_notify_previews_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+##
+# Empty controller used by MailNotifyPreviewInterceptor to render html.
+
+class MailNotifyPreviewsController < ActionController::Base; end

data/lib/mail/notify/mailer.rb

@@ -2,21 +2,99 @@
 
 module Mail
   module Notify
+    ##
+    # The Mail Notify base Mailer class, overridden in Rails applications to provide the additional
+    # Notify behaviour along with the application behaviour.
+
     class Mailer < ActionMailer::Base
-      def view_mail(template_id, headers)
-        raise ArgumentError, "You must specify a template ID" if template_id.blank?
+      ##
+      # Set a default from address, will only be used in previews if a from address is not supplied
+      # by subclasses
+
+      default from: "preview@notifications.service.gov.uk"
+
+      ##
+      # Send an email where the content is managed in the Notify template.
+      #
+      # The required arguments are:
+      #
+      # - template_id
+      # - to address
+      #
+      # Can include personalisation.
+      #
+      # Add any additional headers in the options hash.
+      #
+      # A default subject is supplied as ActionMailer requires one, however it will never be used as
+      # the subject is assumed to be managed in the Notify template.
+
+      def template_mail(template_id, options)
+        raise ArgumentError, "You must specify a Notify template ID" if template_id.blank?
+        raise ArgumentError, "You must specify a to address" if options[:to].nil? || options[:to].blank?
+
+        message.template_id = template_id
+        message.reply_to_id = options[:reply_to_id]
+        message.reference = options[:reference]
+
+        message.personalisation = options[:personalisation] || {}
+
+        headers = options.except([:personalisation, :reply_to_id, :reference])
 
-        mail(headers.merge(template_id: template_id))
+        headers[:subject] = "Subject managed in Notify" unless options[:subject]
+
+        # We have to set the html and the plain text content to nil to prevent Rails from looking
+        # for the content in the views. We replace nil with the content returned from Notify before
+        # sending or previewing
+        mail(headers) do |format|
+          format.text { nil }
+          format.html { nil }
+        end
       end
 
-      def template_mail(template_id, headers)
-        raise ArgumentError, "You must specify a template ID" if template_id.blank?
+      ##
+      # Send an email where the content is managed in the Rails application.
+      #
+      # The required arguments are:
+      #
+      # - template_id
+      # - to address
+      # - subject
+      #
+      # Personalisation will dropped as all content comes from the view provided by Rails.
+      #
+      # Add any additional headers in the options hash.
+
+      def view_mail(template_id, options)
+        raise ArgumentError, "You must specify a Notify template ID" if template_id.blank?
+        raise ArgumentError, "You must supply a to address" if options[:to].blank?
+        raise ArgumentError, "You must specify a subject" if options[:subject].blank?
+
+        message.template_id = template_id
+        message.reply_to_id = options[:reply_to_id]
+        message.reference = options[:reference]
+
+        subject = options[:subject]
+        headers = options.except([:personalisation, :reply_to_id, :reference])
 
-        mail(headers.merge(body: "", subject: "", template_id: template_id))
+        # we have to render the view for the message and grab the raw source, then we set that as the
+        # body in the personalisation for sending to the Notify API.
+        body = mail(headers).body.raw_source
+
+        # The 'view mail' works by sending a subject and body as personalisation options, these are
+        # then used in the Notify template to provide content.
+        message.personalisation = {subject: subject, body: body}
+
+        mail(headers) do |format|
+          format.text { nil }
+          format.html { nil }
+        end
       end
 
+      ##
+      # allows blank personalisation options
+
       def blank_allowed(value)
-        value.presence || Personalisation::BLANK
+        value.to_s
       end
     end
   end

data/lib/mail/notify/message.rb

@@ -3,9 +3,7 @@
 module Mail
   module Notify
     module Message
-      def preview
-        delivery_method.preview(self) if delivery_method.respond_to?(:preview)
-      end
+      attr_accessor :template_id, :personalisation, :reply_to_id, :reference
     end
   end
 end

data/lib/mail/notify/version.rb

@@ -2,6 +2,6 @@
 
 module Mail
   module Notify
-    VERSION = "1.2.0"
+    VERSION = "2.0.0"
   end
 end

data/lib/mail/notify.rb

@@ -3,12 +3,12 @@
 require "notifications/client"
 
 require "mail/notify/version"
-require "mail/notify/railtie" if defined? Rails
+require "mail/notify/engine" if defined? Rails
 require "mail/notify/delivery_method"
-require "mail/notify/personalisation"
 require "mail/notify/mailer"
 require "mail/notify/message"
-require "mail/notify/mailers_controller"
+require "mail/notify/mail_notify_previews_controller"
+require "mail/notify/mail_notify_preview_interceptor"
 
 Mail::Message.include Mail::Notify::Message
 

data/mail-notify.gemspec

@@ -7,10 +7,10 @@ require "mail/notify/version"
 Gem::Specification.new do |spec|
   spec.name = "mail-notify"
   spec.version = Mail::Notify::VERSION
-  spec.authors = ["Stuart Harrison"]
+  spec.authors = ["Stuart Harrison", "Meyric Rawlings"]
   spec.email = ["pezholio@gmail.com"]
 
-  spec.summary = "ActionMailer support for the GOV.UK Notify API"
+  spec.summary = "Rails plugin, send and preview email with GOV.UK Notify"
   spec.homepage = "https://github.com/dxw/mail-notify"
   spec.license = "MIT"
 
@@ -26,20 +26,21 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "coveralls", "~> 0.8.22"
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "simplecov-lcov"
   spec.add_development_dependency "pry", "~> 0.14.1"
-  spec.add_development_dependency "rails", "~> 7"
-  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rails", "7.0.8"
+  spec.add_development_dependency "rake", "~> 13.2.1"
   spec.add_development_dependency "rspec-rails", "~> 5.1"
   spec.add_development_dependency "standard", "~> 1"
-  spec.add_development_dependency "sqlite3", "~> 1.6.2"
-  spec.add_development_dependency "webmock", "~> 3.16.0"
-  spec.add_development_dependency "rspec-mocks", "~> 3.11.0"
+  spec.add_development_dependency "sqlite3", "~> 1.7.2"
+  spec.add_development_dependency "webmock", "~> 3.23.0"
+  spec.add_development_dependency "rspec-mocks", "~> 3.13.0"
 
-  spec.add_dependency "actionmailer", ">= 5.2.4.6"
-  spec.add_dependency "activesupport", ">= 5.2.4.6"
-  spec.add_dependency "actionpack", ">= 5.2.7.1"
-  spec.add_dependency "actionview", ">= 5.2.7.1"
-  spec.add_dependency "notifications-ruby-client", "~> 5.1"
   spec.add_dependency "rack", ">= 2.1.4.1"
+  spec.add_dependency "actionmailer", ">= 5.2.8.1"
+  spec.add_dependency "activesupport", ">= 5.2.8.1"
+  spec.add_dependency "actionpack", ">= 5.2.8.1"
+  spec.add_dependency "actionview", ">= 5.2.8.1"
+  spec.add_dependency "notifications-ruby-client", "~> 6.0"
 end

data/renovate.json

@@ -2,5 +2,7 @@
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "extends": [
     "config:base"
-  ]
+  ],
+  "dependencyDashboard": false,
+  "ignoreDeps": ["ruby-version"]
 }

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mail-notify
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Stuart Harrison
+- Meyric Rawlings
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-25 00:00:00.000000000 Z
+date: 2024-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +26,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.22
+        version: '0.21'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.22
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -56,30 +71,30 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.0.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 7.0.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.6
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -114,126 +129,126 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 1.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.2
+        version: 1.7.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.16.0
+        version: 3.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.16.0
+        version: 3.23.0
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.11.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.6
+        version: 2.1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.6
+        version: 2.1.4.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.6
+        version: 5.2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.6
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.7.1
+        version: 5.2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.7.1
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
-  name: actionview
+  name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.7.1
+        version: 5.2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.7.1
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
-  name: notifications-ruby-client
+  name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 5.2.8.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 5.2.8.1
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: notifications-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4.1
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4.1
+        version: '6.0'
 description: 
 email:
 - pezholio@gmail.com
@@ -241,11 +256,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
 - ".github/dependabot.yml"
 - ".github/setup-rubygems.sh"
-- ".github/workflows/build.yml"
+- ".github/workflows/ci.yml"
 - ".github/workflows/publish.yml"
+- ".github/workflows/rails-integration-tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -253,21 +268,24 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/views/layouts/govuk_notify_layout.html.erb
 - bin/console
+- bin/rspec
 - bin/setup
+- bin/standardrb
 - docs/screenshot.png
 - lib/mail/notify.rb
 - lib/mail/notify/delivery_method.rb
-- lib/mail/notify/layouts/govuk_notify_layout.html.erb
+- lib/mail/notify/engine.rb
+- lib/mail/notify/mail_notify_preview_interceptor.rb
+- lib/mail/notify/mail_notify_previews_controller.rb
 - lib/mail/notify/mailer.rb
-- lib/mail/notify/mailers_controller.rb
 - lib/mail/notify/message.rb
-- lib/mail/notify/personalisation.rb
-- lib/mail/notify/railtie.rb
 - lib/mail/notify/version.rb
 - mail-notify.gemspec
 - renovate.json
@@ -293,5 +311,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: ActionMailer support for the GOV.UK Notify API
+summary: Rails plugin, send and preview email with GOV.UK Notify
 test_files: []

data/.github/workflows/build.yml

@@ -1,27 +0,0 @@
-name: Build
-
-on: [push, pull_request]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-    - name: Set up cache
-      uses: actions/cache@preview
-      with:
-        path: vendor/bundle
-        key: ${{ runner.os }}-gem-${{ hashFiles('**/mail-notify.gemspec') }}
-        restore-keys: |
-          ${{ runner.os }}-gem-
-    - name: Build and test with Rake
-      run: |
-        sudo apt-get update
-        sudo apt-get install sqlite3 libsqlite3-dev
-        gem install bundler
-        bundle install --jobs 4 --retry 3 --path ./vendor/bundle
-        bundle exec rake

data/lib/mail/notify/mailers_controller.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Mail
-  module Notify
-    module MailersController
-      def preview
-        @email_action = File.basename(params[:path])
-        return super unless @preview.email_exists?(@email_action)
-
-        @email = @preview.call(@email_action, params)
-
-        return super unless notify?
-
-        return render_part if params[:part]
-
-        render_preview_wrapper
-      end
-
-      private
-
-      def render_part
-        # Add the current directory to the view path so that Rails can find
-        # the `govuk_notify_layout` layout
-        append_view_path(__dir__)
-
-        response.content_type = "text/html"
-        render html: @email.preview.html.html_safe, layout: "govuk_notify_layout"
-      end
-
-      def render_preview_wrapper
-        @part = @email
-        render action: "email", layout: false, formats: %i[html]
-      end
-
-      def notify?
-        @email.delivery_method.instance_of?(Mail::Notify::DeliveryMethod)
-      end
-    end
-  end
-end

data/lib/mail/notify/personalisation.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Mail
-  module Notify
-    class Personalisation
-      BLANK = Object.new
-
-      def initialize(mail)
-        @body = mail.body.raw_source
-        @subject = mail.subject
-        @personalisation = mail[:personalisation]&.unparsed_value || {}
-      end
-
-      def to_h
-        merged_options
-          .reject { |_k, v| v.blank? }
-          .transform_values { |value| (value == BLANK) ? "" : value }
-      end
-
-      private
-
-      def merged_options
-        {
-          body: @body,
-          subject: @subject
-        }.merge(@personalisation)
-      end
-    end
-  end
-end