notification-pusher-actionmailer 1.0.0.beta6 → 1.0.0.beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ba1406ee16d66a05cdf5be59e296e4c20830b5fee8bfade516fc2572707780
-  data.tar.gz: a3a78fc78bccc38237732d3395d6bea8a638264343372c9b71a14ad469dde027
+  metadata.gz: 0d58e52ac6626844bdc8c506db5b0736f6948c98cc1c6c1f0151d9a9f0f0f6ef
+  data.tar.gz: ff0ca32ac607d598c7985ee37f9ef60ff4212b61605db923693ecdbcd0c3d800
 SHA512:
-  metadata.gz: d29ca7bc4f056ee3af26c85f36dde40dce6096978a2d2c3b64b918929a648edfd3bd91db66e5081db70943ad7b5bb8c77b028164467997beeae88b4f02cbbb2b
-  data.tar.gz: 3e00c7699487f1a4eb490517705e3899e50b2bd9b281c428b8c89014426e4991eac8b6b714230800d9b9c9c9ecbd13427ed8881d000311d5ba87130ebaaad3bd
+  metadata.gz: 485631804bbd14d20a6502f96177ba7e852129ef51ab923cd03bfc9a2adbc422b4b0e6f0b0e1f55a7fae6e60678ec2184706d3883a9984c001a7fd985ae625f8
+  data.tar.gz: 29f3b6c1572bcfb26c0045c1537d478665071f646445e24da75088bd4b58f368fa97393a87d05685de3fd775bf98ebc7e8894836a6f8f78a030a6e0e4e21346f

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 1.0.0.beta6 - 2017-12-28
+
+* bugfixes
+    * fix lib loading problems
+
+### 1.0.0.beta5 - 2017-12-28
+
+* no changes
+
+### 1.0.0.beta4 - 2017-12-27
+
+* features
+    * add functionality
+
+### 1.0.0.beta3 - 2017-12-25
+
+* no changes
+
+### 1.0.0.beta2 - 2017-12-23
+
+* no changes
+
+### 1.0.0.beta1 - 2017-12-22
+
+* initial release

data/README.md

@@ -1,17 +1,16 @@
-# NotificationsRails
+# NotificationPusher for ActionMailer
 
-[![Gem Version](https://badge.fury.io/rb/notifications-rails.svg)](https://badge.fury.io/rb/notifications-rails) <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) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
 
-The most powerful notification solution for Rails. NotificationsRails simplifies the handling, rendering, user-integration and cross-platform pushing of notifications through its simple API.
-
-It integrates with the [Native](https://github.com/NativeGap/native-rails) gem to allow you to create a cross platform Rails app.
+A pusher to send your notifications via email utilizing ActionMailer.
 
 ---
 
 ## Table of Contents
 
-* [Philosophy](#philosophy)
 * [Installation](#installation)
+* [Usage](#usage)
+    * [Options](#options)
 * [To Do](#to-do)
 * [Contributing](#contributing)
     * [Contributors](#contributors)
@@ -20,49 +19,74 @@ It integrates with the [Native](https://github.com/NativeGap/native-rails) gem t
 
 ---
 
-## Philosophy
+## Installation
 
-NotificationsRails has been built with modularity in mind. It currently consists of four components each of which bringing one essential functionality to the notification-integration in your Rails app.
+NotificationPusher for ActionMailer works with Rails 5 onwards. You can add it to your `Gemfile` with:
 
-**[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
+```ruby
+gem 'notification-pusher-actionmailer'
+```
 
-**[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
+And then execute:
 
-**[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher-actionmailer), [ActionCable](notification-pusher-actioncable), [OneSignal](notification-pusher-onesignal).
+    $ bundle
 
-**[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+Or install it yourself as:
 
-You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
+    $ 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'
+```
 
 ---
 
-## Installation
+## Usage
 
-NotificationsRails works with Rails 5 onwards. You can add it to your `Gemfile` with:
+Define this pusher in your `NotificationPusher` configuration:
 
 ```ruby
-gem 'notifications-rails'
+NotificationPusher.configure do |config|
+    config.define_pusher :ActionMailer
+end
 ```
 
-And then execute:
-
-    $ bundle
+You can pass a `from` parameter, which will override the default email address specified in `ApplicationMailer`:
 
-Or install it yourself as:
+```ruby
+NotificationPusher.configure do |config|
+    config.define_pusher :ActionMailer, from: 'my@email.com'
+end
+```
 
-    $ gem install notifications-rails
+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).
 
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+Now you can push your notifications:
 
 ```ruby
-gem 'notifications-rails', github: 'jonhue/notifications-rails'
+notification = Notification.create target: User.first, object: Recipe.first
+notification.push :ActionMailer, 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.
+
+It is also possible to override the email address sending this notification, by passing a `from` parameter.
+
+### Options
+
+**`to`** Receiver email address. Takes a string.
+
+**`from`** Sender email address. Takes a string. Defaults to email specified in `ApplicationMailer`.
+
+**`renderer`** Specify a renderer. Takes a string. Defaults to `'actionmailer'`.
+
 ---
 
 ## To Do
 
-[Here](https://github.com/jonhue/notifications-rails/projects) is the full list of current projects.
+[Here](https://github.com/jonhue/notifications-rails/projects/6) is the full list of current projects.
 
 To propose your ideas, initiate the discussion by adding a [new issue](https://github.com/jonhue/notifications-rails/issues/new).
 
@@ -70,9 +94,9 @@ To propose your ideas, initiate the discussion by adding a [new issue](https://g
 
 ## Contributing
 
-We hope that you will consider contributing to NotificationsRails. Please read this short overview for some information about how to get started:
+We hope that you will consider contributing to NotificationPusher for ActionMailer. Please read this short overview for some information about how to get started:
 
-[Learn more about contributing to this repository](CONTRIBUTING.md), [Code of Conduct](CODE_OF_CONDUCT.md)
+[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
 
@@ -82,7 +106,7 @@ https://github.com/jonhue/notifications-rails/graphs/contributors
 
 ### Semantic Versioning
 
-NotificationsRails follows Semantic Versioning 2.0 as defined at http://semver.org.
+NotificationPusher for ActionMailer follows Semantic Versioning 2.0 as defined at http://semver.org.
 
 ## License
 

data/lib/notification_pusher/action_mailer/engine.rb

@@ -0,0 +1,8 @@
+require 'railties'
+
+module NotificationPusher
+    module ActionMailer
+        class Engine < ::Rails::Engine
+        end
+    end
+end

data/lib/notification_pusher/action_mailer.rb

@@ -0,0 +1,11 @@
+module NotificationPusher
+    class ActionMailer
+
+        require 'action_mailer/engine'
+
+        def initialize notification, options = {}
+            NotificationPusherActionmailerMailer.push notification, options
+        end
+
+    end
+end

data/lib/notification_pusher.rb

@@ -0,0 +1,5 @@
+module NotificationPusher
+
+    require 'notification_pusher/action_mailer'
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher-actionmailer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta6
+  version: 1.0.0.beta7
 platform: ruby
 authors:
 - Jonas Hübotter
@@ -44,28 +44,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta6
+        version: 1.0.0.beta7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta6
+        version: 1.0.0.beta7
 - !ruby/object:Gem::Dependency
   name: notification-renderer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta6
+        version: 1.0.0.beta7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.beta6
+        version: 1.0.0.beta7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -100,8 +100,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
+- lib/notification_pusher.rb
+- lib/notification_pusher/action_mailer.rb
+- lib/notification_pusher/action_mailer/engine.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-actionmailer
 licenses:
 - MIT
@@ -109,7 +113,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- lib/notification_pusher.rb
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="