mail-notify 0.2.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cccef3b1098b15cd45d499ca9e14fdde795c87816386bbf87cb29620fb76576
-  data.tar.gz: 05e1dacda06543a00819af0830348ab78abaa870d25278c5e67d996bea4a5d77
+  metadata.gz: 7c7e4e16f5be488db0fadd5e7bda04b7225eed92367f509ddf34a8c5bcc34ece
+  data.tar.gz: 804d693e50559e07ae4c9dd15ba60fe5219dffb7f323f35d5021726152752021
 SHA512:
-  metadata.gz: fbb86ca94843dcd6b534a29d11d850e393ec37a72d90d58fe2b1dfead8471d4b922e6e9fede8cc59b58be6e1d3f3d3ffc0e8798c62f916edfe2a9b40f4ff7e30
-  data.tar.gz: 284a01c7f04728b4bf8dce7575b8ae00b0414cdaec1fe2bca589eb30186ab338f7efae7fb12c7f1cc3d893bc1ebd538350724cc77bb84ea7ad81ae70412b42b8
+  metadata.gz: '019defa225ca4c55a8ab208708e4635ef55777f4e8a5d0a7ce1650d2b56271df1dd1595083bb8a1c245ec1578a4fc835c39de3139ad54b249cd183a8ffd55998'
+  data.tar.gz: ff993d41bcc0b050f3a0874e7d391023dcbfb0abfee33c112334e3d8906909c466300b5f5d12fe490c7ee5d1ee70ca808de744ce46a5fc52618b337d3ad91ec8

data/.github/workflows/build.yml

@@ -13,10 +13,17 @@ jobs:
       uses: actions/setup-ruby@v1
       with:
         ruby-version: 2.6.x
+    - 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
+        bundle install --jobs 4 --retry 3 --path ./vendor/bundle
         bundle exec rake

data/.gitignore

@@ -12,3 +12,4 @@
 .DS_Store
 /Gemfile.lock
 /spec/dummy/log/test.log
+/vendor

data/CHANGELOG.md

@@ -6,6 +6,21 @@ The format is based on [Keep a Changelog]
 
 ## [Unreleased]
 
+## [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
+
+## [1.0] - 2019-10-22
+
+- Bump Notify gem to 5.1
 - Add error handling for blank variables
 
 ## [0.2.1] - 2019-10-22
@@ -33,10 +48,13 @@ The format is based on [Keep a Changelog]
 
 ## [0.0.1] - 2019-02-01
 
-- Inital release
+- Initial release
 
-[unreleased]:
-  https://github.com/DFE-Digital/dfe-teachers-payment-service/compare/0.1.0...HEAD
+[unreleased]: https://github.com/DFE-Digital/dfe-teachers-payment-service/compare/1.0.3...HEAD
+[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
 [0.2.0]: https://github.com/dxw/mail-notify/compare/0.1.0...0.2.0
 [0.1.0]: https://github.com/dxw/mail-notify/compare/0.0.3...0.1.0

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/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in mail-notify.gemspec
 gemspec

data/README.md

@@ -32,6 +32,16 @@ config.action_mailer.notify_settings = {
 }
 ```
 
+If you're using a different Notify service to GOV.UK Notify (for example [GOV.CA Notify](https://notification.alpha.canada.ca/)), you can also specify the Base URL in your setup:
+
+```ruby
+config.action_mailer.delivery_method = :notify
+config.action_mailer.notify_settings = {
+  api_key: YOUR_NOTIFY_API_KEY,
+  base_url: 'https://api.notification.alpha.canada.ca'
+}
+```
+
 ### Mailers
 
 There are two options for using `Mail::Notify`, either templating in Rails with a view, or templating in Notify. Whichever way you choose, you'll need your mailers to inherit from `Mail::Notify::Mailer` like so:
@@ -73,7 +83,7 @@ class MyMailer < Mail::Notify::Mailer
     def send_email
         template_mail('YOUR_TEMPLATE_ID_GOES_HERE',
           to: 'mail@somewhere.com',
-          personalisations: {
+          personalisation: {
               foo: 'bar'
           }
         )

data/Rakefile

@@ -1,13 +1,12 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
-require 'coveralls/rake/task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+require "coveralls/rake/task"
 
 Coveralls::RakeTask.new
-RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec)
 
-task default: %i[rubocop spec coveralls:push]
+task default: %i[standard spec coveralls:push]

data/lib/mail/notify.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'notifications/client'
+require "notifications/client"
 
-require 'mail/notify/version'
-require 'mail/notify/railtie' 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/version"
+require "mail/notify/railtie" 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"
 
 Mail::Message.include Mail::Notify::Message
 

data/lib/mail/notify/delivery_method.rb

@@ -6,7 +6,7 @@ module Mail
       attr_accessor :settings, :response
 
       def initialize(settings)
-        raise ArgumentError, 'You must specify an API key' if settings[:api_key].blank?
+        raise ArgumentError, "You must specify an API key" if settings[:api_key].blank?
 
         @settings = settings
       end
@@ -26,7 +26,7 @@ module Mail
       private
 
       def client
-        @client ||= Notifications::Client.new(@settings[:api_key])
+        @client ||= Notifications::Client.new(@settings[:api_key], @settings[:base_url])
       end
 
       def email_params

data/lib/mail/notify/mailer.rb

@@ -4,15 +4,15 @@ module Mail
   module Notify
     class Mailer < ActionMailer::Base
       def view_mail(template_id, headers)
-        raise ArgumentError, 'You must specify a template ID' if template_id.blank?
+        raise ArgumentError, "You must specify a template ID" if template_id.blank?
 
         mail(headers.merge(template_id: template_id))
       end
 
       def template_mail(template_id, headers)
-        raise ArgumentError, 'You must specify a template ID' if template_id.blank?
+        raise ArgumentError, "You must specify a template ID" if template_id.blank?
 
-        mail(headers.merge(body: '', subject: '', template_id: template_id))
+        mail(headers.merge(body: "", subject: "", template_id: template_id))
       end
     end
   end

data/lib/mail/notify/mailers_controller.rb

@@ -23,13 +23,13 @@ module Mail
         # 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'
+        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]
+        render action: "email", layout: false, formats: %i[html]
       end
 
       def notify?

data/lib/mail/notify/railtie.rb

@@ -3,11 +3,11 @@
 module Mail
   module Notify
     class Railtie < Rails::Railtie
-      initializer 'mail-notify.add_delivery_method', before: 'action_mailer.set_configs' do
+      initializer "mail-notify.add_delivery_method", before: "action_mailer.set_configs" do
         ActionMailer::Base.add_delivery_method(:notify, Mail::Notify::DeliveryMethod)
       end
 
-      initializer 'mail-notify.action_controller' do
+      initializer "mail-notify.action_controller" do
         ActiveSupport.on_load(:action_controller, run_once: true) do
           Rails::MailersController.prepend(Mail::Notify::MailersController)
         end

data/lib/mail/notify/version.rb

@@ -2,6 +2,6 @@
 
 module Mail
   module Notify
-    VERSION = '0.2.2'
+    VERSION = "1.0.3"
   end
 end

data/mail-notify.gemspec

@@ -1,37 +1,42 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mail/notify/version'
+require "mail/notify/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'mail-notify'
-  spec.version       = Mail::Notify::VERSION
-  spec.authors       = ['Stuart Harrison']
-  spec.email         = ['pezholio@gmail.com']
+  spec.name = "mail-notify"
+  spec.version = Mail::Notify::VERSION
+  spec.authors = ["Stuart Harrison"]
+  spec.email = ["pezholio@gmail.com"]
 
-  spec.summary       = 'ActionMailer support for the GOV.UK Notify API'
-  spec.homepage      = 'https://github.com/dxw/mail-notify'
-  spec.license       = 'MIT'
+  spec.summary = "ActionMailer support for the GOV.UK Notify API"
+  spec.homepage = "https://github.com/dxw/mail-notify"
+  spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  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 'rails', '~> 6.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec-rails', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.63'
-  spec.add_development_dependency 'sqlite3', '~> 1.4.1'
+  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 "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.4.7"
+  spec.add_development_dependency "sqlite3", "~> 1.4.1"
+  spec.add_development_dependency "webmock", "~> 3.7.6"
 
-  spec.add_dependency 'actionmailer', '>= 5.0', '< 6.1'
-  spec.add_dependency 'notifications-ruby-client', '~> 3.1'
+  spec.add_dependency "actionmailer", ">= 5.2.4.2", "< 6.2"
+  spec.add_dependency "activesupport", ">= 5.2.4.3"
+  spec.add_dependency "actionpack", ">= 5.2.4.3"
+  spec.add_dependency "actionview", ">= 5.2.4.3"
+  spec.add_dependency "notifications-ruby-client", "~> 5.1"
+  spec.add_dependency "rack", ">= 2.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-notify
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Stuart Harrison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.8'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.63'
+        version: 0.4.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.63'
+        version: 0.4.7
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -122,40 +122,110 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.4.1
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.6
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.4.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.4.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
 - !ruby/object:Gem::Dependency
   name: notifications-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
 description: 
 email:
 - pezholio@gmail.com
@@ -171,9 +241,9 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.7
-before_install: gem install bundler -v 2.0.1