mail-notify 1.2.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/linting.yml +24 -0
- data/.github/workflows/publish.yml +5 -1
- data/.github/workflows/rails-integration-tests.yml +169 -0
- data/.github/workflows/unit-tests.yml +43 -0
- data/.gitignore +5 -1
- data/.ruby-version +1 -1
- data/CHANGELOG.md +23 -1
- data/Dockerfile +61 -0
- data/README.md +181 -76
- data/Rakefile +1 -6
- data/{lib/mail/notify → app/views}/layouts/govuk_notify_layout.html.erb +23 -25
- data/bin/console +4 -9
- data/bin/rspec +27 -0
- data/bin/standardrb +27 -0
- data/docs/assets/images/view_template_in_notify.png +0 -0
- data/lib/mail/notify/delivery_method.rb +17 -26
- data/lib/mail/notify/engine.rb +13 -0
- data/lib/mail/notify/mail_notify_preview_interceptor.rb +51 -0
- data/lib/mail/notify/mail_notify_previews_controller.rb +6 -0
- data/lib/mail/notify/mailer.rb +89 -7
- data/lib/mail/notify/message.rb +1 -3
- data/lib/mail/notify/version.rb +1 -1
- data/lib/mail/notify.rb +3 -3
- data/mail-notify.gemspec +16 -15
- data/renovate.json +3 -1
- metadata +74 -61
- data/.coveralls.yml +0 -0
- data/.github/dependabot.yml +0 -10
- data/.github/workflows/build.yml +0 -27
- data/.rubocop.yml +0 -14
- data/docs/screenshot.png +0 -0
- data/lib/mail/notify/mailers_controller.rb +0 -40
- data/lib/mail/notify/personalisation.rb +0 -30
- data/lib/mail/notify/railtie.rb +0 -19
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 60127d37531f075fc9b21ffc6827798bbdfb30988e5ae340b9b482ea0ac16cc4
|
|
4
|
+
data.tar.gz: e11f5dc38d11626da357eb59e04d53936fc15fdbc94301ca84815c279aa26c80
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 74899baafc7538944dde8665b130b0b9712db0fdf3e94fd0b9ce34eb2dbbd9dcab2719706a1f2cb995a456675e5bdd9a94ea3cf60d3a52e2cd5966de76031db6
|
|
7
|
+
data.tar.gz: 5a1134adfddc2842aeb51f2f82200d4c21c0128f775c19f4c6ee7082106235e902e4f2b43a251f089addb71c61cc792b5364415b87d42404c1ea35de8a7586bc
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
name: Linting
|
|
2
|
+
|
|
3
|
+
permissions: {}
|
|
4
|
+
|
|
5
|
+
on:
|
|
6
|
+
pull_request:
|
|
7
|
+
push:
|
|
8
|
+
branches:
|
|
9
|
+
- main
|
|
10
|
+
jobs:
|
|
11
|
+
lint:
|
|
12
|
+
name: Run Standard.rb
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- name: Checkout code
|
|
16
|
+
uses: actions/checkout@v4
|
|
17
|
+
with:
|
|
18
|
+
persist-credentials: false
|
|
19
|
+
- name: Set up Ruby
|
|
20
|
+
uses: ruby/setup-ruby@v1
|
|
21
|
+
with:
|
|
22
|
+
bundler-cache: true
|
|
23
|
+
- name: Run linting
|
|
24
|
+
run: bin/standardrb
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
name: Publish to rubygems
|
|
2
2
|
|
|
3
|
+
permissions: {}
|
|
4
|
+
|
|
3
5
|
on:
|
|
4
6
|
push:
|
|
5
7
|
tags:
|
|
@@ -9,7 +11,9 @@ jobs:
|
|
|
9
11
|
build:
|
|
10
12
|
runs-on: ubuntu-latest
|
|
11
13
|
steps:
|
|
12
|
-
- uses: actions/checkout@
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
with:
|
|
16
|
+
persist-credentials: false
|
|
13
17
|
- name: Set up Ruby
|
|
14
18
|
uses: ruby/setup-ruby@v1
|
|
15
19
|
- name: Setup Rubygems
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
name: Rails integration tests
|
|
2
|
+
|
|
3
|
+
permissions: {}
|
|
4
|
+
on:
|
|
5
|
+
pull_request_target:
|
|
6
|
+
types: [opened, synchronize] # zizmor: ignore[dangerous-triggers] - we have permission checks to ensure only owners can trigger this action
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
check-user-permission:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
name: Check user permission
|
|
12
|
+
steps:
|
|
13
|
+
- name: Get User Permission
|
|
14
|
+
id: checkAccess
|
|
15
|
+
uses: actions-cool/check-user-permission@v2
|
|
16
|
+
with:
|
|
17
|
+
require: write
|
|
18
|
+
username: ${{ github.triggering_actor }}
|
|
19
|
+
- name: Check User Permission
|
|
20
|
+
if: steps.checkAccess.outputs.require-result == 'false'
|
|
21
|
+
env:
|
|
22
|
+
trigger-actor: ${{ github.triggering_actor }}
|
|
23
|
+
actor-name: ${{ github.actor }}
|
|
24
|
+
permission: ${{ steps.checkAccess.outputs.user-permission }}
|
|
25
|
+
run: |
|
|
26
|
+
echo "${ trigger-actor } does not have permissions on this repo."
|
|
27
|
+
echo "Current permission level is ${ permission }"
|
|
28
|
+
echo "Job originally triggered by ${ actor-name }"
|
|
29
|
+
exit 1
|
|
30
|
+
set-matrix:
|
|
31
|
+
runs-on: ubuntu-latest
|
|
32
|
+
name: Set Rails versions
|
|
33
|
+
needs:
|
|
34
|
+
- check-user-permission
|
|
35
|
+
outputs:
|
|
36
|
+
RAILS_VERSIONS: ${{ steps.compute-outputs.outputs.RAILS_VERSIONS }}
|
|
37
|
+
steps:
|
|
38
|
+
# Get latest Rails versions for 6.x.x and 7.x.x
|
|
39
|
+
- id: compute-outputs
|
|
40
|
+
name: Compute outputs
|
|
41
|
+
# fetches current Rails versions numbers > 6 and not 'beta'
|
|
42
|
+
run: |
|
|
43
|
+
rails_versions=$(curl https://rubygems.org/api/v1/versions/rails.json | jq '[.[] | select(.number | test("beta") | not)] | group_by(.number[:1])[] | (.[0].number) | select(.[:1]|tonumber > 6)' | jq -s -c)
|
|
44
|
+
echo "RAILS_VERSIONS=$rails_versions" >> $GITHUB_OUTPUT
|
|
45
|
+
set-ruby-version:
|
|
46
|
+
runs-on: ubuntu-latest
|
|
47
|
+
name: Set Ruby version
|
|
48
|
+
needs:
|
|
49
|
+
- check-user-permission
|
|
50
|
+
outputs:
|
|
51
|
+
RUBY_VERSION: ${{ steps.set-ruby-version.outputs.RUBY_VERSION }}
|
|
52
|
+
steps:
|
|
53
|
+
- name: Checkout
|
|
54
|
+
uses: actions/checkout@v4
|
|
55
|
+
with:
|
|
56
|
+
persist-credentials: false
|
|
57
|
+
- id: set-ruby-version
|
|
58
|
+
name: Set Ruby version
|
|
59
|
+
run: |
|
|
60
|
+
echo "RUBY_VERSION=$(cat .ruby-version)" >> $GITHUB_OUTPUT
|
|
61
|
+
build-rails:
|
|
62
|
+
strategy:
|
|
63
|
+
fail-fast: false
|
|
64
|
+
matrix:
|
|
65
|
+
# Build containers with the latest 6.x.x and 7.x.x Rails versions
|
|
66
|
+
rails: ${{ fromJSON(needs.set-matrix.outputs.RAILS_VERSIONS) }}
|
|
67
|
+
runs-on: ubuntu-latest
|
|
68
|
+
name: Build and cache Docker containers
|
|
69
|
+
needs:
|
|
70
|
+
- set-matrix
|
|
71
|
+
- set-ruby-version
|
|
72
|
+
steps:
|
|
73
|
+
- name: Checkout
|
|
74
|
+
uses: actions/checkout@v4
|
|
75
|
+
with:
|
|
76
|
+
persist-credentials: false
|
|
77
|
+
- name: Set up Docker Buildx
|
|
78
|
+
uses: docker/setup-buildx-action@v3
|
|
79
|
+
- name: Build and cache
|
|
80
|
+
uses: docker/build-push-action@v6
|
|
81
|
+
with:
|
|
82
|
+
context: .
|
|
83
|
+
file: ./Dockerfile
|
|
84
|
+
build-args: |
|
|
85
|
+
RAILS_VERSION=${{ matrix.rails }}
|
|
86
|
+
RUBY_VERSION=${{ needs.set-ruby-version.outputs.RUBY_VERSION }}
|
|
87
|
+
push: false
|
|
88
|
+
tags: mail-notify-integration-rails-${{ matrix.rails }}-${{ needs.set-ruby-version.outputs.RUBY_VERSION }}:latest
|
|
89
|
+
outputs: type=docker, dest=/tmp/rails-${{ matrix.rails }}-${{ needs.set-ruby-version.outputs.RUBY_VERSION }}-image.tar
|
|
90
|
+
cache-from: type=gha,scope=build-${{ matrix.rails }}-${{ needs.set-ruby-version.outputs.RUBY_VERSION }}
|
|
91
|
+
cache-to: type=gha,mode=min,scope=build-${{ matrix.rails }}-${{ needs.set-ruby-version.outputs.RUBY_VERSION }}
|
|
92
|
+
- name: Upload artifact
|
|
93
|
+
uses: actions/upload-artifact@v4
|
|
94
|
+
with:
|
|
95
|
+
name: rails-${{ matrix.rails }}-${{ needs.set-ruby-version.outputs.RUBY_VERSION }}-image
|
|
96
|
+
path: /tmp/rails-${{ matrix.rails }}-${{ needs.set-ruby-version.outputs.RUBY_VERSION }}-image.tar
|
|
97
|
+
mailer-previews:
|
|
98
|
+
strategy:
|
|
99
|
+
fail-fast: false
|
|
100
|
+
# Run against the latest 6.x.x and 7.x.x Rails versions
|
|
101
|
+
matrix:
|
|
102
|
+
rails: ${{ fromJSON(needs.set-matrix.outputs.RAILS_VERSIONS) }}
|
|
103
|
+
env:
|
|
104
|
+
MATRIX_RAILS: ${{ matrix.rails }}
|
|
105
|
+
RUBY_VERSION: ${{ needs.set-ruby-version.outputs.RUBY_VERSION }}
|
|
106
|
+
runs-on: ubuntu-latest
|
|
107
|
+
needs:
|
|
108
|
+
- set-matrix
|
|
109
|
+
- set-ruby-version
|
|
110
|
+
- build-rails
|
|
111
|
+
steps:
|
|
112
|
+
- name: Download image
|
|
113
|
+
uses: actions/download-artifact@v4
|
|
114
|
+
with:
|
|
115
|
+
name: rails-${{ env.MATRIX_RAILS }}-${{ env.RUBY_VERSION }}-image
|
|
116
|
+
path: /tmp
|
|
117
|
+
- name: Load image
|
|
118
|
+
run: docker load --input /tmp/rails-${MATRIX_RAILS}-${RUBY_VERSION}-image.tar
|
|
119
|
+
- name: Run integration tests
|
|
120
|
+
env:
|
|
121
|
+
NOTIFY_API_KEY: ${{ secrets.NOTIFY_API_KEY }}
|
|
122
|
+
run: |
|
|
123
|
+
docker run --rm -e "NOTIFY_API_KEY=$NOTIFY_API_KEY" \
|
|
124
|
+
mail-notify-integration-rails-${MATRIX_RAILS}-${RUBY_VERSION}:latest bin/rails test:system
|
|
125
|
+
sending:
|
|
126
|
+
strategy:
|
|
127
|
+
fail-fast: false
|
|
128
|
+
# Run against the latest 5.x.x, 6.x.x and 7.x.x Rails versions
|
|
129
|
+
matrix:
|
|
130
|
+
rails: ${{ fromJSON(needs.set-matrix.outputs.RAILS_VERSIONS) }}
|
|
131
|
+
env:
|
|
132
|
+
MATRIX_RAILS: ${{ matrix.rails }}
|
|
133
|
+
RUBY_VERSION: ${{ needs.set-ruby-version.outputs.RUBY_VERSION }}
|
|
134
|
+
runs-on: ubuntu-latest
|
|
135
|
+
needs:
|
|
136
|
+
- set-matrix
|
|
137
|
+
- set-ruby-version
|
|
138
|
+
- build-rails
|
|
139
|
+
steps:
|
|
140
|
+
- name: Download image
|
|
141
|
+
uses: actions/download-artifact@v4
|
|
142
|
+
with:
|
|
143
|
+
name: rails-${{ env.MATRIX_RAILS }}-${{ env.RUBY_VERSION }}-image
|
|
144
|
+
path: /tmp
|
|
145
|
+
- name: Load image
|
|
146
|
+
run: docker load --input /tmp/rails-${MATRIX_RAILS}-${RUBY_VERSION}-image.tar
|
|
147
|
+
- name: Run integration tests
|
|
148
|
+
env:
|
|
149
|
+
NOTIFY_API_KEY: ${{ secrets.NOTIFY_API_KEY }}
|
|
150
|
+
run: |
|
|
151
|
+
docker run --rm -e "NOTIFY_API_KEY=$NOTIFY_API_KEY" \
|
|
152
|
+
mail-notify-integration-rails-${MATRIX_RAILS}-${RUBY_VERSION}:latest bin/rails test
|
|
153
|
+
results:
|
|
154
|
+
if: ${{ always() }}
|
|
155
|
+
runs-on: ubuntu-latest
|
|
156
|
+
name: All integration tests
|
|
157
|
+
needs:
|
|
158
|
+
- mailer-previews
|
|
159
|
+
- sending
|
|
160
|
+
steps:
|
|
161
|
+
# If any of the previous actions failed, we return a non-zero exit code
|
|
162
|
+
- run: exit 1
|
|
163
|
+
if: >-
|
|
164
|
+
${{
|
|
165
|
+
contains(needs.*.result, 'failure')
|
|
166
|
+
|| contains(needs.*.result, 'cancelled')
|
|
167
|
+
|| contains(needs.*.result, 'skipped')
|
|
168
|
+
}}
|
|
169
|
+
- run: echo "integration tests passed"
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
name: Unit tests
|
|
2
|
+
permissions: {}
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
push:
|
|
6
|
+
branches:
|
|
7
|
+
- main
|
|
8
|
+
jobs:
|
|
9
|
+
unit-tests:
|
|
10
|
+
strategy:
|
|
11
|
+
fail-fast: false
|
|
12
|
+
matrix:
|
|
13
|
+
ruby: [ 3.1, 3.2, 3.3 ]
|
|
14
|
+
runs-on: ubuntu-latest
|
|
15
|
+
name: Run specs and coverage report
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v4
|
|
18
|
+
with:
|
|
19
|
+
persist-credentials: false
|
|
20
|
+
- uses: ruby/setup-ruby@v1
|
|
21
|
+
with:
|
|
22
|
+
ruby-version: ${{ matrix.ruby }}
|
|
23
|
+
bundler-cache: true
|
|
24
|
+
- name: Run specs
|
|
25
|
+
run: bin/rspec
|
|
26
|
+
- name: Run coverage report
|
|
27
|
+
uses: coverallsapp/github-action@v2
|
|
28
|
+
with:
|
|
29
|
+
fail-on-error: false
|
|
30
|
+
results:
|
|
31
|
+
if: ${{ always() }}
|
|
32
|
+
runs-on: ubuntu-latest
|
|
33
|
+
name: All unit tests
|
|
34
|
+
needs: [ unit-tests ]
|
|
35
|
+
steps:
|
|
36
|
+
# If any of the previous actions failed, we return a non-zero exit code
|
|
37
|
+
- run: exit 1
|
|
38
|
+
if: >-
|
|
39
|
+
${{
|
|
40
|
+
contains(needs.*.result, 'failure')
|
|
41
|
+
|| contains(needs.*.result, 'cancelled')
|
|
42
|
+
|| contains(needs.*.result, 'skipped')
|
|
43
|
+
}}
|
data/.gitignore
CHANGED
data/.ruby-version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
3.4.2
|
data/CHANGELOG.md
CHANGED
|
@@ -6,6 +6,25 @@ The format is based on [Keep a Changelog]
|
|
|
6
6
|
|
|
7
7
|
## [Unreleased]
|
|
8
8
|
|
|
9
|
+
## [2.1.0] - 2025-03-24
|
|
10
|
+
|
|
11
|
+
- Support one click unsubscribe - thanks to @asmega ([#168](https://github.com/dxw/mail-notify/pull/168))
|
|
12
|
+
- Fixed a bug in `view_mail` and `template_mail` that meant the options were being
|
|
13
|
+
included in the preview email headers for no reason - thanks to @inulty-dfe ([#165](https://github.com/dxw/mail-notify/pull/165))
|
|
14
|
+
- Fixed a bug in `view_mail` that meant custom headers in the preview email were
|
|
15
|
+
duplicated - thanks to @inulty-dfe ([#165](https://github.com/dxw/mail-notify/pull/165))
|
|
16
|
+
|
|
17
|
+
## [2.0.0] - 2024-04-01
|
|
18
|
+
|
|
19
|
+
- Version 2.0.0 rewrites most of the gem, without altering the API
|
|
20
|
+
- The gem no longer prepends code in ActionMailer
|
|
21
|
+
- Previews are now 100% supported in Rails, but will require a Notify API key
|
|
22
|
+
- The preview layout has been updated and uses the Tudor Crown
|
|
23
|
+
- This version fixes a bug that meant not all Rails preview functionality would
|
|
24
|
+
work
|
|
25
|
+
- This version fixes a bug that meant no Rails preview functionality would work
|
|
26
|
+
from version 7.1.0 onwards
|
|
27
|
+
|
|
9
28
|
## [1.2.0] - 2023-04-28
|
|
10
29
|
|
|
11
30
|
- Requiring Ruby 2.7.8
|
|
@@ -71,7 +90,10 @@ The format is based on [Keep a Changelog]
|
|
|
71
90
|
|
|
72
91
|
- Initial release
|
|
73
92
|
|
|
74
|
-
[unreleased]: https://github.com/
|
|
93
|
+
[unreleased]: https://github.com/dxw/mail-notify/compare/2.0.0...HEAD
|
|
94
|
+
[2.0.0]: https://github.com/dxw/mail-notify/compare/1.2.0...2.0.0
|
|
95
|
+
[1.2.0]: https://github.com/dxw/mail-notify/compare/1.1.0...1.2.0
|
|
96
|
+
[1.1.0]: https://github.com/dxw/mail-notify/compare/1.0.5...1.1.0
|
|
75
97
|
[1.0.5]: https://github.com/dxw/mail-notify/compare/1.0.4...1.0.5
|
|
76
98
|
[1.0.4]: https://github.com/dxw/mail-notify/compare/1.0.3...1.0.4
|
|
77
99
|
[1.0.3]: https://github.com/dxw/mail-notify/compare/1.0.2...1.0.3
|
data/Dockerfile
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
ARG RUBY_VERSION=3.1.6
|
|
2
|
+
FROM registry.docker.com/library/ruby:$RUBY_VERSION-slim AS base
|
|
3
|
+
|
|
4
|
+
# Rails app lives here
|
|
5
|
+
WORKDIR /rails
|
|
6
|
+
|
|
7
|
+
# Build stage
|
|
8
|
+
FROM base AS build
|
|
9
|
+
|
|
10
|
+
# Install packages needed to build gems and node modules
|
|
11
|
+
RUN apt-get update -qq && \
|
|
12
|
+
apt-get install --no-install-recommends -y build-essential curl git libyaml-dev
|
|
13
|
+
|
|
14
|
+
# Install Rails
|
|
15
|
+
ARG RAILS_VERSION=7.2.1
|
|
16
|
+
RUN gem install rails -v ${RAILS_VERSION}
|
|
17
|
+
|
|
18
|
+
# create empty Rails application, we don't need ActiveRecord or JavaScript
|
|
19
|
+
RUN rails new mail-notify-integration --skip-active-record --skip-javascript
|
|
20
|
+
|
|
21
|
+
WORKDIR mail-notify-integration
|
|
22
|
+
|
|
23
|
+
# install the gems into the bundle
|
|
24
|
+
RUN bundle install
|
|
25
|
+
|
|
26
|
+
# Final stage for app image
|
|
27
|
+
FROM base
|
|
28
|
+
|
|
29
|
+
# Install packages needed for running the tests
|
|
30
|
+
RUN apt-get update -qq && \
|
|
31
|
+
apt-get install --no-install-recommends -y curl git && \
|
|
32
|
+
rm -rf /var/lib/apt/lists /var/cache/apt/archives
|
|
33
|
+
|
|
34
|
+
# Copy built artifacts: gems, application
|
|
35
|
+
COPY --from=build /usr/local/bundle /usr/local/bundle
|
|
36
|
+
COPY --from=build /rails /rails
|
|
37
|
+
|
|
38
|
+
WORKDIR /rails/mail-notify-integration
|
|
39
|
+
|
|
40
|
+
# add Mail Notify to the Gemfile
|
|
41
|
+
COPY . ../mail-notify
|
|
42
|
+
RUN echo "gem 'mail-notify', path: '../mail-notify'" >> Gemfile
|
|
43
|
+
|
|
44
|
+
# install the mail-notify gem, we do this here to keep the last container layer small to help caching
|
|
45
|
+
RUN bundle install
|
|
46
|
+
|
|
47
|
+
# Copy over intergration test files
|
|
48
|
+
COPY test/mailers/ test/mailers/
|
|
49
|
+
COPY test/system/ test/system/
|
|
50
|
+
COPY test/integration test/integration
|
|
51
|
+
COPY test/application_system_test_case.rb /test/application_system_test_case.rb
|
|
52
|
+
COPY test/app/mailers/ app/mailers/
|
|
53
|
+
COPY test/app/views/ app/views/
|
|
54
|
+
|
|
55
|
+
# Setup the test environment
|
|
56
|
+
RUN echo "Rails.application.config.action_mailer.show_previews = true" >> config/environments/test.rb
|
|
57
|
+
RUN echo "Rails.application.config.action_mailer.delivery_method = :notify" >>config/environments/test.rb
|
|
58
|
+
RUN echo "Rails.application.config.action_mailer.notify_settings = {api_key: ENV['NOTIFY_API_KEY']}" >> config/environments/test.rb
|
|
59
|
+
|
|
60
|
+
# Run the system tests
|
|
61
|
+
CMD ["./bin/rails", "test:system"]
|