notification-pusher-actionmailer 1.2.4 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d4246805750b0660b82b02d1992a6d836cc7fc32db06bf8d84553431ad622fe
-  data.tar.gz: 712ccd09a736f4aed4420d4ffce27a989f94db0687a76bd3817f46c9d27828c5
+  metadata.gz: 216fcf578fa6d6f23e905e5b93f4d8f445292774769846f41abed3433305d174
+  data.tar.gz: 1d45e2ad34ab053ef7100a7ad0720d6910a8bfff263ec74f69dc50eb22516ce2
 SHA512:
-  metadata.gz: 616d5635d74337fa9d954b1361a45b52f51ceaa96675bccf62399675a80d9d37f239310038c2e40a68f02e5444c2db185b041feb178e9bdb38881ef054f3a019
-  data.tar.gz: bc69aa5053062c82da104e41aca9fde456d7890e660c9bc23961af01ef91a1051e6fb92a39f90aa55da506c6e4bffd90a7824721682f795867dd73b25d98bd5b
+  metadata.gz: 6010c7096d7485ce0959e9c30bb382db9317e94000414bb423999ddf5d824db723a6b65773d2bb32ec20c192782e3f5ccd56e903edfa660f8b89feed3d647570
+  data.tar.gz: 8799c90c313cb7057b62d29564e61f1322e9e2193981edf9206cf77c9c43846b6d776da37cdc4d8ce6fb4382d4b4d3ea1c17651abfb0887d5e1cb41d34dbf520

data/LICENSE

@@ -1,21 +1,21 @@
-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.
+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/README.md

@@ -1,135 +1,84 @@
-# 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" />
-
-A pusher to send your notifications via email utilizing ActionMailer.
-
----
-
-## Table of Contents
-
-* [Installation](#installation)
-* [Usage](#usage)
-    * [Options](#options)
-* [To Do](#to-do)
-* [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
-
----
-
-## Installation
-
-NotificationPusher for ActionMailer works with Rails 5 onwards. You can add it to your `Gemfile` with:
-
-```ruby
-gem 'notification-pusher-actionmailer'
-```
-
-And then execute:
-
-    $ bundle
-
-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:
-
-```ruby
-NotificationPusher.configure do |config|
-    config.define_pusher :ActionMailer
-end
-```
-
-You can pass a `from` parameter, which will override the default email address specified in `ApplicationMailer`:
-
-```ruby
-NotificationPusher.configure do |config|
-    config.define_pusher :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:
-
-```ruby
-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'`.
-
-**`layout`** Layout used for template rendering. Takes a string. Defaults to layout specified in `ApplicationMailer`.
-
----
-
-## To Do
-
-[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).
-
----
-
-## Contributing
-
-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](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.
+# notifications-rails
+
+notifications-rails is the most powerful notification library for Rails. It offers not only simple APIs to create and render notifications but also supports user-integration and cross-platform delivery of notifications.
+
+## Philosophy
+
+notifications-rails has been built with modularity in mind. It currently consists of four components each of which bringing one essential functionality to the integration of notifications in your Rails app.
+
+**[notification-handler](notification-handler):** Create and modify your notifications through a simple API.
+
+**[notification-renderer](notification-renderer):** Render your notifications in various contexts.
+
+**[notification-pusher](notification-pusher):** Deliver your notifications to various services, including [Email](notification-pusher/notification-pusher-actionmailer) and [OneSignal](notification-pusher/notification-pusher-onesignal).
+
+**[notification-settings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+
+You may just use the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
+
+## Installation
+
+You can add notifications-rails to your `Gemfile` with:
+
+```ruby
+gem 'notifications-rails'
+```
+
+And then run:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install notifications-rails
+
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+
+```ruby
+gem 'notifications-rails', github: 'jonhue/notifications-rails'
+```
+
+## Usage
+
+Details on usage are provided in the [documentation](#philosophy) of the specific modules.
+
+## Development
+
+To start development you first have to fork this repository and locally clone your fork.
+
+Install the projects dependencies by running:
+
+    $ bundle install
+
+### Testing
+
+Tests are written with RSpec. Integration tests are located in `/spec`, unit tests can be found in `<module>/spec`.
+
+To run all tests:
+
+    $ ./rspec
+
+To run RuboCop:
+
+    $ bundle exec rubocop
+
+You can find all commands run by the CI workflow in `.github/workflows/ci.yml`.
+
+## Contributing
+
+We warmly welcome everyone who is intersted in contributing. Please reference our [contributing guidelines](CONTRIBUTING.md) and our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Releases
+
+[Here](https://github.com/jonhue/notifications-rails/releases) you can find details on all past releases. Unreleased breaking changes that are on the current master can be found [here](CHANGELOG.md).
+
+notifications-rails follows Semantic Versioning 2.0 as defined at http://semver.org. Reference our [security policy](SECURITY.md).
+
+### Publishing
+
+1. Review breaking changes and deprecations in `CHANGELOG.md`.
+1. Change the gem version in `VERSION`.
+1. Reset `CHANGELOG.md`.
+1. Create a pull request to merge the changes into `master`.
+1. After the pull request was merged, create a new release listing the breaking changes and commits on `master` since the last release.
+1. The release workflow will publish the gems to RubyGems.

data/lib/notifications-rails.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'notification-handler'
+require 'notification-renderer'
+require 'notification-pusher'
+require 'notification-settings'

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher-actionmailer
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 3.0.3
 platform: ruby
 authors:
 - Jonas Hübotter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-17 00:00:00.000000000 Z
+date: 2020-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: actionmailer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: actionmailer
+  name: notification-pusher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,79 +53,117 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: notification-pusher
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: notification-renderer
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        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: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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: 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.52'
-description: A pusher to send your notifications via email utilizing ActionMailer.
-email: me@jonhue.me
+        version: '0'
+description: A delivery method to send your notifications via email using ActionMailer.
+email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
-- 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/notifications-rails.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher/notification-pusher-actionmailer
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/jonhue/notifications-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -120,16 +172,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: A pusher to send your notifications via email utilizing ActionMailer
+summary: A delivery method to send your notifications via email using ActionMailer
 test_files: []

data/CHANGELOG.md

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

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

@@ -1,10 +0,0 @@
-class NotificationPusher::ActionMailer::NotificationMailer < ApplicationMailer
-
-    def push notification, options = {}
-        render(layout: options[:layout]) if options.has_key?(:layout)
-        @notification = notification
-        @renderer = options[:renderer] || 'actionmailer'
-        mail to: options[:to] || notification.target.email, from: options[:from]
-    end
-
-end

data/app/views/notification_pusher/action_mailer/notification_mailer/push.html.erb

@@ -1 +0,0 @@
-<%= render_notification @notification, @renderer %>

data/lib/notification-pusher-actionmailer.rb

@@ -1,2 +0,0 @@
-require 'notification-pusher'
-require 'notification_pusher/action_mailer'

data/lib/notification_pusher/action_mailer.rb

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

data/lib/notification_pusher/action_mailer/engine.rb

@@ -1,9 +0,0 @@
-require 'rails/railtie'
-require 'action_mailer'
-
-module NotificationPusher
-    class ActionMailer
-        class Engine < ::Rails::Engine
-        end
-    end
-end