notification-pusher-actionmailer 1.2.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8712a4c61c9fbc50771a3a8b4b8df266df08a9bc157b8ff8f4417e679a925504
-  data.tar.gz: eb81367f4f3f529ef51dc90db4037bd83f57b395c0192281ad788923a41e6e29
+  metadata.gz: 1ace410bc0d4d02cffc46b368f7ac26ea7c05f23993e0db166cba968825c3788
+  data.tar.gz: b9ab6323df47db214da68071743b788c092614c053daefa8093995e46b96a0ed
 SHA512:
-  metadata.gz: 9e7fab7423b084d66edb15968f662ba7bfce4f278632a5a9cbdc2a7f492a7114c39cff9a78e655a4d21b8f170c6d5a0ab3337aed8f02a420104b6610060bc130
-  data.tar.gz: cd01d224c4813cb8732ab18648d9960232b19a378ddd1c6d2dc8f6d9f60c40ec8a86c378e960bffa962901590cc582b43db309a4c952384c4b02f0ef925c737a
+  metadata.gz: '068fc97838b7ef080a2aab91cdaa369639ebb135c4963e66c6e49bd28f19b69cab489147b05c24f70d4c581dd100f254a4fe0dfb8eb6a8297b2fa01492bc9d09'
+  data.tar.gz: d0b3ed2a689975105498d757834b594d8bc32228ec451fcc53c4a45732e830c47edb4b327d6dadad4fa2eb8fed063eba0495f5d7662013a83cde5f5d1d414b79

data/README.md

@@ -1,6 +1,6 @@
 # NotificationPusher for ActionMailer
 
-[![Gem Version](https://badge.fury.io/rb/notification-pusher-actionmailer.svg)](https://badge.fury.io/rb/notification-pusher-actionmailer) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
+[![Gem Version](https://badge.fury.io/rb/notification-pusher-actionmailer.svg)](https://badge.fury.io/rb/notification-pusher-actionmailer) ![Travis](https://travis-ci.com/jonhue/notifications-rails.svg?branch=master)
 
 A pusher to send your notifications via email utilizing ActionMailer.
 
@@ -10,12 +10,10 @@ A pusher to send your notifications via email utilizing ActionMailer.
 
 * [Installation](#installation)
 * [Usage](#usage)
-    * [Options](#options)
+  * [Options](#options)
 * [To Do](#to-do)
 * [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
+  * [Semantic versioning](#semantic-versioning)
 
 ---
 
@@ -35,60 +33,73 @@ Or install it yourself as:
 
     $ gem install notification-pusher-actionmailer
 
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
-
-```ruby
-gem 'notification-pusher-actionmailer', github: 'jonhue/notifications-rails'
-```
-
 ---
 
 ## Usage
 
-Define this pusher in your `NotificationPusher` configuration:
+Register this pusher in your `NotificationPusher` configuration:
 
 ```ruby
 NotificationPusher.configure do |config|
-    config.define_pusher :ActionMailer
+  config.register_delivery_method :email, :ActionMailer
 end
 ```
 
-You can pass a `from` parameter, which will override the default email address specified in `ApplicationMailer`:
+You can pass a `from` parameter, which will be used if you don't provide a `from` address when delivering:
 
 ```ruby
 NotificationPusher.configure do |config|
-    config.define_pusher :ActionMailer, from: 'my@email.com'
+  config.register_delivery_method :email, :ActionMailer, from: 'my@email.com'
 end
 ```
 
 Then add a renderer called `_actionmailer.html.erb` to every notification type you aim to support. Learn more [here](https://github.com/jonhue/notifications-rails/tree/master/notification-renderer).
 
-Now you can push your notifications:
+Now you can deliver your notifications:
 
 ```ruby
-notification = Notification.create target: User.first, object: Recipe.first
-notification.push :ActionMailer, to: 'another@email.com'
+require 'notification-renderer'
+
+notification = Notification.create(target: User.first, object: Recipe.first)
+notification.deliver(:email, to: 'another@email.com')
 ```
 
-**Note:** If the email address, you want to push to, is the same as `notification.target.email` you can omit the `to` parameter.
+**Note:** If the email address, you want to deliver to, is the same as `notification.target.email` you can omit the `to` parameter.
 
 It is also possible to override the email address sending this notification, by passing a `from` parameter.
 
+If you don't want to use [NotificationRenderer](https://github.com/jonhue/notifications-rails/tree/master/notification-renderer):
+
+```ruby
+notification = Notification.create(target: User.first, object: Recipe.first)
+notification.deliver(:email, to: 'another@email.com', mailer: MyCustomMailer, action: :deliver_notification)
+```
+
+`MyCustomMailer.deliver_notification` is then called with a `notification` as first argument and an options hash as second argument.
+
 ### Options
 
 **`to`** Receiver email address. Takes a string.
 
-**`from`** Sender email address. Takes a string. Defaults to email specified in `ApplicationMailer`.
+**`from`** Sender email address. Takes a string.
 
 **`renderer`** Specify a renderer. Takes a string. Defaults to `'actionmailer'`.
 
 **`layout`** Layout used for template rendering. Takes a string. Defaults to layout specified in `ApplicationMailer`.
 
+**`mail_options`** A hash that is passed to `mail` (e.g. including `:subject`). Takes a hash. Defaults to `{}`.
+
+**`mailer`** ActionMailer class. Takes a constant. Defaults to `NotificationPusher::ActionMailer::NotificationMailer`.
+
+**`action`** ActionMailer action. Takes a symbol. Defaults to `:push`.
+
+**`deliver_method`** ActionMailer deliver_method (e.g. `:deliver_later`). Takes a symbol. Defaults to `:deliver`.
+
 ---
 
 ## To Do
 
-[Here](https://github.com/jonhue/notifications-rails/projects/6) is the full list of current projects.
+We use [GitHub projects](https://github.com/jonhue/notifications-rails/projects/6) to coordinate the work on this project.
 
 To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
 
@@ -100,36 +111,6 @@ We hope that you will consider contributing to NotificationPusher for ActionMail
 
 [Learn more about contributing to this repository](https://github.com/jonhue/notifications-rails/blob/master/CONTRIBUTING.md), [Code of Conduct](https://github.com/jonhue/notifications-rails/blob/master/CODE_OF_CONDUCT.md)
 
-### Contributors
-
-Give the people some :heart: who are working on this project. See them all at:
-
-https://github.com/jonhue/notifications-rails/graphs/contributors
-
 ### Semantic Versioning
 
 NotificationPusher for ActionMailer follows Semantic Versioning 2.0 as defined at http://semver.org.
-
-## License
-
-MIT License
-
-Copyright (c) 2017 Jonas Hübotter
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/app/mailers/notification_pusher/action_mailer/notification_mailer.rb

@@ -3,13 +3,21 @@
 module NotificationPusher
   class ActionMailer
     class NotificationMailer < ApplicationMailer
+      # rubocop:disable Metrics/ParameterLists
       def push(notification,
-               from:, to: nil, renderer: 'actionmailer', layout: nil)
+               from:, to: nil, renderer: 'actionmailer', layout: nil,
+               mail_options: {})
         render(layout: layout) unless layout.nil?
+
         @notification = notification
         @renderer = renderer
-        mail(to: to || notification.target.email, from: from)
+
+        mail({
+          to: to || notification.target.email,
+          from: from
+        }.merge(mail_options))
       end
+      # rubocop:enable Metrics/ParameterLists
     end
   end
 end

data/lib/notification-pusher-actionmailer.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 require 'notification-pusher'
-require 'notification_pusher/action_mailer'
+require_relative 'notification_pusher/delivery_method/action_mailer'

data/lib/notification_pusher/delivery_method/action_mailer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module NotificationPusher
+  module DeliveryMethod
+    class ActionMailer < NotificationPusher::DeliveryMethod::Base
+      require_relative 'action_mailer/engine'
+
+      DEFAULT_MAILER_ACTION = :push
+      DEFAULT_DELIVER_METHOD = :deliver
+
+      def call
+        mailer_class.send(mailer_action, notification, options)
+                    .send(deliver_method)
+      end
+
+      private
+
+      def mailer_class
+        return options[:mailer] if options.key?(:mailer)
+        if defined?(NotificationRenderer)
+          return ::NotificationPusher::ActionMailer::NotificationMailer
+        end
+
+        raise(ArgumentError,
+              'You have to pass the :mailer option explicitly or require ' \
+              "'notification-renderer'")
+      end
+
+      def mailer_action
+        options[:action] || DEFAULT_MAILER_ACTION
+      end
+
+      def deliver_method
+        options[:deliver_method] || DEFAULT_DELIVER_METHOD
+      end
+    end
+  end
+end

data/lib/notification_pusher/{action_mailer → delivery_method/action_mailer}/engine.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'rails/railtie'
+require 'rails/engine'
 require 'action_mailer'
 
 module NotificationPusher

metadata

@@ -1,73 +1,101 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher-actionmailer
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-22 00:00:00.000000000 Z
+date: 2019-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: notification-pusher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: notification-renderer
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.6
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: rspec
+  name: rails
+  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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
 description: A pusher to send your notifications via email utilizing ActionMailer.
 email: me@jonhue.me
 executables: []
@@ -119,8 +161,8 @@ files:
 - app/mailers/notification_pusher/action_mailer/notification_mailer.rb
 - app/views/notification_pusher/action_mailer/notification_mailer/push.html.erb
 - lib/notification-pusher-actionmailer.rb
-- lib/notification_pusher/action_mailer.rb
-- lib/notification_pusher/action_mailer/engine.rb
+- lib/notification_pusher/delivery_method/action_mailer.rb
+- lib/notification_pusher/delivery_method/action_mailer/engine.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-actionmailer
 licenses:
 - MIT
@@ -140,8 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A pusher to send your notifications via email utilizing ActionMailer

data/lib/notification_pusher/action_mailer.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require 'notification-renderer'
-
-module NotificationPusher
-  class ActionMailer
-    require 'notification_pusher/action_mailer/engine'
-
-    def initialize(notification, options = {})
-      ::NotificationPusher::ActionMailer::NotificationMailer.push(
-        notification, options
-      )
-    end
-  end
-end