notification-pusher 1.0.0.beta6 → 1.0.0.beta7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9279ebe6e68eda1bbaac017e8b2ef6ecacf12fb39498d618efa1d9901129406
-  data.tar.gz: 2f0699404108acf6c9697cae22f13d665a2640f5f7c79668b8fb39760db6cb00
+  metadata.gz: b23540414b0c20125716ee66cd6d940f2eed78f8751911ec94c09959ff67b0f2
+  data.tar.gz: 117a4c33a58ab637464d1706155f67131ac5b611d54bcffe87706e8c533d2ca3
 SHA512:
-  metadata.gz: 555cc8686080758e1dc13f6a2102e5e10235de24b25fc8b2c455a9f4c085e4a754a7c01d5729391c346344808835332f82626874f5ab5eb5822b539bc40c2f94
-  data.tar.gz: dff48181613cdf05f32131750740c45576477102ecf0e5b325015e27ca3b989be61885d0ca2db64cee929c298c776fadde5d468b2d5b30396ed5f850a3c13587
+  metadata.gz: c03fd0209cc73ae4e32df40095eaaac29a6f10d14db3e7e0f8ceaf14497a60a9ca83ba0f4fb1500d78811bce9dcfb74f34ea474dc97dd82a28a53da92977dc75
+  data.tar.gz: 4175563440b2ce9a910236a1b01c5bd2a097ae554676dac1a96c5bdee1afc0a11a0a2decf05f1dff7761ae57600613082ff5ce2710a543874376a971fa23f27c

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+### master
+
+* nothing yet
+
+### 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.beta4 - 2017-12-27
+
+* no changes
+
+### 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/README.md

@@ -1,17 +1,19 @@
-# NotificationsRails
+# NotificationPusher
 
-[![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.svg)](https://badge.fury.io/rb/notification-pusher) <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.
+Push your notifications to various services. Including Email, ActionCable, OneSignal (cross-platform notifications).
 
 ---
 
 ## Table of Contents
 
-* [Philosophy](#philosophy)
 * [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)
@@ -20,49 +22,117 @@ It integrates with the [Native](https://github.com/NativeGap/native-rails) gem t
 
 ---
 
-## Philosophy
+## 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
 
-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.
+If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
 
-**[NotificationHandler](notification-handler):** Create and modify your notifications through a simple API.
+```ruby
+gem 'notification-pusher', github: 'jonhue/notifications-rails'
+```
 
-**[NotificationRenderer](notification-renderer):** Render your notifications on multiple platforms by specifying notification types.
+Now run the generator:
 
-**[NotificationPusher](notification-pusher):** Push your notifications to various services. Including [Email](notification-pusher-actionmailer), [ActionCable](notification-pusher-actioncable), [OneSignal](notification-pusher-onesignal).
+    $ rails g notification_pusher:install
 
-**[NotificationSettings](notification-settings):** Integrates with your authentication solution to craft a personalized user notification platform.
+To wrap things up, migrate the changes to your database:
 
-You may just add the components you actually need, or instead use this gem to bundle everything for a complete notification solution.
+    $ rails db:migrate
 
 ---
 
-## Installation
+## Usage
+
+### Pushers
 
-NotificationsRails works with Rails 5 onwards. You can add it to your `Gemfile` with:
+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
-gem 'notifications-rails'
+NotificationPusher.configure do |config|
+    config.define_pusher name, options
+end
 ```
 
-And then execute:
+More details about defining a specific pusher (name and available options) are available in the respective documentation of the gem.
 
-    $ bundle
+#### Using a pusher
 
-Or install it yourself as:
+It is super simple to initialize a push:
 
-    $ gem install notifications-rails
+```ruby
+notification = Notification.create target: User.first, object: Recipe.first
+notification.push name, custom_options
+```
 
-If you always want to be up to date fetch the latest from GitHub in your `Gemfile`:
+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, push: name, push_options: custom_options
+```
+
+**Note:** In this case, pass `custom_options` as a `Hash`.
+
+It is possible to use mutliple pushers at a time:
 
 ```ruby
-gem 'notifications-rails', github: 'jonhue/notifications-rails'
+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
+module NotificationPusher
+    class CustomPusher
+
+        def initialize notification, options = {}
+            # ...
+        end
+
+    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) is the full list of current projects.
+[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).
 
@@ -70,9 +140,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. 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 +152,7 @@ https://github.com/jonhue/notifications-rails/graphs/contributors
 
 ### Semantic Versioning
 
-NotificationsRails follows Semantic Versioning 2.0 as defined at http://semver.org.
+NotificationPusher follows Semantic Versioning 2.0 as defined at http://semver.org.
 
 ## License
 

data/lib/generators/notification_pusher/install_generator.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,7 @@
+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/configuration.rb

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

data/lib/notification_pusher/notification_library.rb

@@ -0,0 +1,38 @@
+module NotificationPusher
+    module NotificationLibrary
+
+        attr_accessor :push
+        attr_accessor :push_options
+
+        after_create_commit :initialize_pusher
+
+        def push name, options = {}
+            self.push = class_name
+            self.push_options = options
+            self.initialize_pusher
+        end
+
+        private
+
+        def initialize_pusher
+            unless self.push.nil?
+                if self.push.kind_of(Array)
+                    self.push.each do |class_name|
+                        pusher = NotificationPusher::Pusher.find_by_name(class_name).last
+                        if defined?(NotificationPusher.const_get(pusher.name))
+                            options = pusher.options.merge! self.push_options[class_name.to_sym]
+                            pusher.instances << NotificationPusher.const_get(pusher.name).new options
+                        end
+                    end
+                else
+                    pusher = NotificationPusher::Pusher.find_by_name(self.push).last
+                    if defined?(NotificationPusher.const_get(pusher.name))
+                        options = pusher.options.merge! self.push_options
+                        pusher.instances << NotificationPusher.const_get(pusher.name).new self, options
+                    end
+                end
+            end
+        end
+
+    end
+end

data/lib/notification_pusher/pusher.rb

@@ -0,0 +1,19 @@
+module NotificationPusher
+    class Pusher
+
+        attr_accessor :name
+        attr_accessor :options
+        attr_accessor :instances
+
+        def initialize name, options = {}
+            @instances = []
+            @name = name
+            @options = options
+        end
+
+        def find_by_name name
+            ObjectSpace.each_object(NotificationPusher::Pusher).select { |pusher| pusher.name == name }
+        end
+
+    end
+end

data/lib/notification_pusher.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta6
+  version: 1.0.0.beta7
 platform: ruby
 authors:
 - Jonas Hübotter
@@ -16,14 +16,14 @@ 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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -59,8 +59,15 @@ 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
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher
 licenses:
 - MIT
@@ -68,7 +75,7 @@ metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
-- lib/notification_pusher.rb
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="