mail-notify 1.0.2 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e655bdd3f3a316396b7df35d23a86f0f4a860aa5fc25612d52b1f765cb762f9
-  data.tar.gz: 29521a3f973c0f7dff6ffa51024653b0896e9bdb672693cde040e57cbe95cf64
+  metadata.gz: 51dc46116d659f7d269b55bed4d05a6389cffb71c0da50e87610e7c491a35927
+  data.tar.gz: 853e9293faa4f7e9a913ad53922db154260b616a5fe1485c9e5ee0f65ca8f9f3
 SHA512:
-  metadata.gz: 640be6724ce67e82499573090eff2d66121d4a8f4814a160d4ce8bd62d0a9390595f02b10b7cdecfb10cc7d47e4f62a5f1c8d3ebbfb9be3b951026a20bff3d72
-  data.tar.gz: 95aee1774859003130cf27841d6bf3d31ed883e56864378ee4f6fe5a6a52adf19d347375c58b5ba8c0f2c646a3e57c8486eb52e7774e287666fb0f36d4b0c58d
+  metadata.gz: ddd4d70cd5779b20791014b66987179081070a5b8e5d709da816f4d883e111cf45f5da0235eab06a1ebdd5e8f5092c3269d64fee720e9847d675d49def12dbfa
+  data.tar.gz: 851594ef11849f363c241106508f1cb939911ac9cc8fd57fcd88588f0ca72ace91c859fa02b6ddb5297143002956880070164226b305325b1710281ab9561b47

data/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/setup-rubygems.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 set -e
 
-mkdir ~/.gem
+mkdir -p ~/.gem
 echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials
 chmod 0600 ~/.gem/credentials

data/.github/workflows/build.yml

@@ -8,11 +8,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
     - name: Set up cache
       uses: actions/cache@preview
       with:

data/.github/workflows/publish.yml

@@ -9,11 +9,9 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
     - name: Setup Rubygems
       env:
         RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

data/.ruby-version

@@ -1 +1 @@
-2.6.0
+2.7.6

data/CHANGELOG.md

@@ -6,6 +6,24 @@ The format is based on [Keep a Changelog]
 
 ## [Unreleased]
 
+## [1.0.5] - 2022-08-31
+
+- Allow explicitly blank personalisations (https://github.com/dxw/mail-notify/pull/30)
+- Fix Zeitwerk compatibility issue (https://github.com/dxw/mail-notify/pull/58)
+- Dependency updates
+
+## [1.0.4] - 2021-01-28
+
+- Remove pessimistic constraint on Rails version
+
+## [1.0.3] - 2020-12-14
+
+- Add support for ActionMailer 6.1
+
+## [1.0.2] - 2020-03-24
+
+- Add support for ActionMailer 6.0
+
 ## [1.0.1] - 2020-03-06
 
 - Support additional Notify services
@@ -42,8 +60,11 @@ The format is based on [Keep a Changelog]
 
 - Initial release
 
-[unreleased]:
-  https://github.com/DFE-Digital/dfe-teachers-payment-service/compare/1.0...HEAD
+[unreleased]: https://github.com/DFE-Digital/dfe-teachers-payment-service/compare/1.0.3...HEAD
+[1.0.5]: https://github.com/dxw/mail-notify/compare/1.0.4...1.0.5
+[1.0.4]: https://github.com/dxw/mail-notify/compare/1.0.3...1.0.4
+[1.0.3]: https://github.com/dxw/mail-notify/compare/1.0.2...1.0.3
+[1.0.2]: https://github.com/dxw/mail-notify/compare/1.0.1...1.0.2
 [1.0.1]: https://github.com/dxw/mail-notify/compare/1.0...1.0.1
 [1.0]: https://github.com/dxw/mail-notify/compare/0.2.1...1.0
 [0.2.1]: https://github.com/dxw/mail-notify/compare/0.2.0...0.2.1

data/CONTRIBUTING.md

@@ -0,0 +1 @@
+The [dxw standard contributing guide](https://github.com/dxw/.github/blob/main/CONTRIBUTING.md) applies for this repository.

data/README.md

@@ -91,6 +91,23 @@ class MyMailer < Mail::Notify::Mailer
 end
 ```
 
+By default, any blank personalisation are removed from the request, which will trigger mail template validation. This is to avoid accidental blanks in the email. If you want to send a blank value, you need to explicitly state that the personalization can be blank:  
+
+```ruby
+class MyMailer < Mail::Notify::Mailer
+  def send_email
+    template_mail('YOUR_TEMPLATE_ID_GOES_HERE',
+                  to: 'mail@somewhere.com',
+                  personalisation: {
+                    foo: foo.name, # This will trigger template validation error when blank
+                    bar: blank_allowed(bar.name) # This will inject empty string in the template when blank
+                  }
+    )
+  end
+end
+```
+
+
 #### With optional Notify arguments
 
 It's possible to pass two optional arguments to Notify:
@@ -113,13 +130,34 @@ class MyMailer < Mail::Notify::Mailer
 end
 ```
 
+#### With Devise
+
+If you're using [Devise](https://github.com/heartcombo/devise), you can overwrite your Devise mailer to use mail-notify for password reset emails etc.
+
+In `config/initializers/devise.rb`:
+
+```ruby
+config.mailer = 'DeviseMailer'
+```
+
+in `app/mailers/devise_mailer.rb`:
+
+```ruby
+class DeviseMailer < Devise::Mailer
+  def devise_mail(record, action, opts = {}, &block)
+    initialize_from_record(record)
+    view_mail(ENV['NOTIFY_TEMPLATE_ID'], headers_for(action, opts))
+  end
+end
+```
+
 ## Previews
 
 If you're using ActionMailer with Rails, [previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails) are supported too, and work in the same way as standard previews. Currently they're shown without any branding, but this may change in future.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/mail/notify/mailer.rb

@@ -14,6 +14,10 @@ module Mail
 
         mail(headers.merge(body: "", subject: "", template_id: template_id))
       end
+
+      def blank_allowed(value)
+        value.presence || Personalisation::BLANK
+      end
     end
   end
 end

data/lib/mail/notify/personalisation.rb

@@ -3,6 +3,8 @@
 module Mail
   module Notify
     class Personalisation
+      BLANK = Object.new
+
       def initialize(mail)
         @body = mail.body.raw_source
         @subject = mail.subject
@@ -10,7 +12,9 @@ module Mail
       end
 
       def to_h
-        merged_options.reject { |_k, v| v.blank? }
+        merged_options
+          .reject { |_k, v| v.blank? }
+          .transform_values { |value| value == BLANK ? "" : value }
       end
 
       private

data/lib/mail/notify/version.rb

@@ -2,6 +2,6 @@
 
 module Mail
   module Notify
-    VERSION = "1.0.2"
+    VERSION = "1.0.5"
   end
 end

data/mail-notify.gemspec

@@ -25,14 +25,18 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "coveralls", "~> 0.8.22"
-  spec.add_development_dependency "pry", "~> 0.12.0"
+  spec.add_development_dependency "pry", "~> 0.14.1"
   spec.add_development_dependency "rails", "~> 6.0"
-  spec.add_development_dependency "rake", "~> 12.3.3"
-  spec.add_development_dependency "rspec-rails", "~> 3.8"
-  spec.add_development_dependency "standard", "~> 0.2"
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "rspec-rails", "~> 5.1"
+  spec.add_development_dependency "standard", "0.4.7"
   spec.add_development_dependency "sqlite3", "~> 1.4.1"
-  spec.add_development_dependency "webmock", "~> 3.7.6"
+  spec.add_development_dependency "webmock", "~> 3.16.0"
 
-  spec.add_dependency "actionmailer", ">= 5.2.4.2", "< 6.1"
+  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"
 end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-notify
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.5
 platform: ruby
 authors:
 - Stuart Harrison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-24 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.4.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -128,34 +128,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 3.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.6
+        version: 3.16.0
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
-    - - "<"
+        version: 5.2.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.6
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 5.2.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.2
-    - - "<"
+        version: 5.2.7.1
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 5.2.7.1
 - !ruby/object:Gem::Dependency
   name: notifications-ruby-client
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +206,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4.1
 description: 
 email:
 - pezholio@gmail.com
@@ -178,6 +228,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/dependabot.yml"
 - ".github/setup-rubygems.sh"
 - ".github/workflows/build.yml"
 - ".github/workflows/publish.yml"
@@ -187,6 +238,7 @@ files:
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -194,7 +246,6 @@ files:
 - bin/console
 - bin/setup
 - 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/mailer.rb
@@ -203,7 +254,9 @@ files:
 - lib/mail/notify/personalisation.rb
 - lib/mail/notify/railtie.rb
 - lib/mail/notify/version.rb
+- lib/notify.rb
 - mail-notify.gemspec
+- renovate.json
 homepage: https://github.com/dxw/mail-notify
 licenses:
 - MIT
@@ -223,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: ActionMailer support for the GOV.UK Notify API