notification-pusher 1.2.4 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e1d6d66c37f3e0f0c2513aad94db692b1e3f7b694dc4c70bda2a78abb1529fc
-  data.tar.gz: 6870383f90c6bdf53e2faac3566df84999de248210989806e32936578d884f4a
+  metadata.gz: f3842033c487c47b11953e242d24ab55acd82c280898073090a5d468a9a2118e
+  data.tar.gz: 779daa39294bee3fb49a7601bcba73177f6c9d6374c49b0ae8a4e1c9f72eab63
 SHA512:
-  metadata.gz: 79092a9671e99300723f0031703c9123d3138c693d19dad6fb85370d10f0714016713bf5b0f995579ca1572e36f7a72896d761abdd599f2a1281874747973deb
-  data.tar.gz: f5a5e2d440eba20d0a4a7e765fa1ed051750bebb6da7ee18f09276b5ed5f68257cc4a6e5a11bbb22b3754eea00e476d5fddcf3ffb9532a3e44347b4d07211851
+  metadata.gz: 1b875353d7805d0e4ae050f169ce5c65903e14828037c0779616722cfe7e362f68fa234f59e39c4f6490c12dc50bad058fa3815e5c78a5980240a6016ea2d874
+  data.tar.gz: 22641a2181d63da3a2b2747025d290b65ba74adfcef002a57102e0df9ecea320efbb9dd8fdfb769a2060a9e122f5315a0987803d889d25cee4ef589778d31ca0

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,177 +1,84 @@
-# NotificationPusher
-
-[![Gem Version](https://badge.fury.io/rb/notification-pusher.svg)](https://badge.fury.io/rb/notification-pusher) <img src="https://travis-ci.org/jonhue/notifications-rails.svg?branch=master" />
-
-Push your notifications to various services. Including Email, ActionCable, OneSignal (cross-platform notifications).
-
----
-
-## Table of Contents
-
-* [Installation](#installation)
-* [Usage](#usage)
-    * [Pushers](#pushers)
-        * [Defining a pusher](#defining-a-pusher)
-        * [Using a pusher](#using-a-pusher)
-    * [Writing a custom pusher](#writing-a-custom-pusher)
-* [To Do](#to-do)
-* [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
-
----
-
-## Installation
-
-NotificationPusher works with Rails 5 onwards. You can add it to your `Gemfile` with:
-
-```ruby
-gem 'notification-pusher'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install notification-pusher
-
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
-
-```ruby
-gem 'notification-pusher', github: 'jonhue/notifications-rails'
-```
-
-Now run the generator:
-
-    $ rails g notification_pusher:install
-
-To wrap things up, migrate the changes to your database:
-
-    $ rails db:migrate
-
----
-
-## Usage
-
-### Pushers
-
-A pusher handles the process of sending your notifications to various services for you.
-
-#### Defining a pusher
-
-You define pushers in your `NotificationPusher` configuration (`config/initializers/notification-pusher.rb`). Using:
-
-```ruby
-NotificationPusher.configure do |config|
-    config.define_pusher name, options
-end
-```
-
-More details about defining a specific pusher (name and available options) are available in the respective documentation of the gem.
-
-#### Using a pusher
-
-It is super simple to initialize a push:
-
-```ruby
-notification = Notification.create target: User.first, object: Recipe.first
-notification.push name, custom_options
-```
-
-Where `name` is the name of the defined pusher and `custom_options` are the options that will override the default options the pusher has been defined with.
-
-You are also able to do the exact same in just one line of code:
-
-```ruby
-notification = Notification.create target: User.first, object: Recipe.first, pusher: name, pusher_options: custom_options
-```
-
-**Note:** In this case, pass `custom_options` as a `Hash`.
-
-It is possible to use mutliple pushers at a time:
-
-```ruby
-notification.push [name_one, name_two], name_one: custom_options, name_two: custom_options
-```
-
-### Writing a custom pusher
-
-Writing custom pushers is fairly simple. Just add a new subclass to `NotificationPusher`:
-
-```ruby
-class NotificationPusher::CustomPusher
-
-    def initialize notification, options = {}
-        # ...
-    end
-
-end
-```
-
-This is how to define and use your pusher:
-
-```ruby
-NotificationPusher.configure do |config|
-    config.define_pusher :CustomPusher, option_one: 'value_one'
-end
-```
-
-```ruby
-notification = Notification.create target: User.first, object: Recipe.first
-notification.push :CustomPusher, option_one: 'value_two'
-```
-
-For further reference take a look at the default [ActionMailer](notification-pusher-actionmailer), [ActionCable](notification-pusher-actioncable) and [OneSignal](notification-pusher-onesignal) pusher.
-
----
-
-## To Do
-
-[Here](https://github.com/jonhue/notifications-rails/projects/3) 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. 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 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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher
 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: activesupport
@@ -30,62 +30,126 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 3.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.4
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: factory_bot
   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: 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: 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: rspec-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: 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: Push your notifications to various services. Including Email, ActionCable,
-  OneSignal (cross-platform notifications).
-email: me@jonhue.me
+        version: '0'
+description: Deliver your notifications to various services.
+email: jonas.huebotter@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - LICENSE
 - README.md
-- lib/generators/notification_pusher/install_generator.rb
-- lib/generators/templates/install/initializer.rb
-- lib/notification-pusher.rb
-- lib/notification_pusher/configuration.rb
-- lib/notification_pusher/notification_library.rb
-- lib/notification_pusher/pusher.rb
+- lib/notifications-rails.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher
 licenses:
 - MIT
-metadata: {}
+metadata:
+  github_repo: ssh://github.com/jonhue/notifications-rails
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -94,17 +158,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: Push your notifications to various services. Including Email, ActionCable,
-  OneSignal (cross-platform notifications)
+summary: Deliver your notifications to various services
 test_files: []

data/CHANGELOG.md

@@ -1,36 +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.beta5 - 2017/12/28
-
-* bugfixes
-    * fix generators
-    * fix lib loading problems
-    * fix syntax errors
-
-### 1.0.0.beta3 - 2017/12/25
-
-* features
-    * add `Pusher` class and allow definition in configuration
-
-### 1.0.0.beta2 - 2017/12/23
-
-* enhancements
-    * add `NotificationPusher::NotificationLibrary` module to extend `NotificationHandler::Notification` model
-    * drop Rails dependency
-
-### 1.0.0.beta1 - 2017/12/22
-
-* initial release

data/lib/generators/notification_pusher/install_generator.rb

@@ -1,17 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/migration'
-
-module NotificationPusher
-
-    class InstallGenerator < Rails::Generators::Base
-
-        source_root File.join File.dirname(__FILE__), '../templates/install'
-        desc 'Install NotificationPusher'
-
-        def create_initializer
-            template 'initializer.rb', 'config/initializers/notification-pusher.rb'
-        end
-
-    end
-
-end

data/lib/generators/templates/install/initializer.rb

@@ -1,7 +0,0 @@
-NotificationPusher.configure do |config|
-
-    # A pusher handles the process of sending your notifications to various services for you.
-    # Learn more: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher#pushers
-    # config.define_pusher :ActionMailer, email: 'my@email.com'
-
-end

data/lib/notification-pusher.rb

@@ -1,9 +0,0 @@
-module NotificationPusher
-
-    require 'notification_pusher/configuration'
-
-    autoload :Pusher, 'notification_pusher/pusher'
-
-    autoload :NotificationLibrary, 'notification_pusher/notification_library'
-
-end

data/lib/notification_pusher/configuration.rb

@@ -1,26 +0,0 @@
-module NotificationPusher
-
-    class << self
-        attr_accessor :configuration
-    end
-
-    def self.configure
-        self.configuration ||= Configuration.new
-        yield configuration
-    end
-
-    class Configuration
-
-        attr_accessor :pushers
-
-        def initialize
-            @pushers = []
-        end
-
-        def define_pusher name, options = {}
-            self.pushers << ::NotificationPusher::Pusher.new(name, options)
-        end
-
-    end
-
-end

data/lib/notification_pusher/notification_library.rb

@@ -1,45 +0,0 @@
-require 'notification-handler'
-require 'active_support'
-
-module NotificationPusher
-    module NotificationLibrary
-
-        extend ActiveSupport::Concern
-
-        included do
-            attr_accessor :pusher
-            attr_accessor :pusher_options
-
-            after_create_commit :initialize_pusher
-
-            include NotificationPusher::NotificationLibrary::InstanceMethods
-        end
-
-        module InstanceMethods
-
-            def push name, options = {}
-                self.pusher = name
-                self.pusher_options = options
-                self.initialize_pusher
-            end
-
-            protected
-
-            def initialize_pusher
-                unless self.pusher.nil?
-                    if self.pusher.kind_of?(Array)
-                        self.pusher.each do |class_name|
-                            pusher = NotificationPusher::Pusher.find_by_name(class_name).first
-                            pusher.push(self, self.pusher_options[class_name.to_sym])
-                        end
-                    else
-                        pusher = NotificationPusher::Pusher.find_by_name(self.pusher).first
-                        pusher.push(self, self.pusher_options)
-                    end
-                end
-            end
-
-        end
-
-    end
-end

data/lib/notification_pusher/pusher.rb

@@ -1,28 +0,0 @@
-module NotificationPusher
-    class Pusher
-
-        attr_accessor :name
-        attr_accessor :options
-        attr_accessor :instances
-
-        def initialize name, options = {}
-            @instances = []
-            @name = name
-            @options = options
-        end
-
-        def push notification, options = {}
-            default_options = self.options
-            options = options.nil? ? default_options : default_options.merge!(options)
-            if defined?(NotificationPusher.const_get(self.name))
-                instance = NotificationPusher.const_get(self.name).new notification, options
-                self.instances << instance
-            end
-        end
-
-        def self.find_by_name name
-            NotificationPusher.configuration.pushers.select { |pusher| pusher.name == name }
-        end
-
-    end
-end