notification-pusher 1.2.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd7560832ef4368464860d34007181d07d670a83cd1926183adf6fa1b1143e67
-  data.tar.gz: 0774f7d730f7d22ba99111f1b2f3f78281ccd172b108fbd5de8985684740877e
+  metadata.gz: 6e7cdafa752302560ca44f108e91f0793090dd77e0d6b5c16edef26a300c14cf
+  data.tar.gz: 216538d4db48bb379512e4946e018cc08285b8dc8520fda96cd757a1b34b7db6
 SHA512:
-  metadata.gz: 273c928173e93271afe9fef5a7d84251307c5c440e0b403c2748dc5661a538f8fc29ffa811b058100f96aa3279412f1d6516da078fc204d4d7b9933cb834236b
-  data.tar.gz: 1b5c830ba48b9576da245dd71556169e909e9874c97751167bf306262360937c3de3e6c90180629752cea286fa48f6cece2b51c04bf81b85a9177c6904014237
+  metadata.gz: da25af4e364fd5361b67ed6c8350e7927a2175d90ba2cebc95a54201aa6befe2a1eb67e5197eb1120ac5f971e18f9270171b63dd2c9573286c44ad6cbce3a578
+  data.tar.gz: 7bb4f6453c5bf13d080e5194bf2235e7b9c39827d78d000d0ee6134473720410c13d0b60cc1a06d415320d5e07a8c884abacaa40e70d01c9b50ef72f0adc2d64

data/README.md

@@ -1,8 +1,8 @@
 # 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" />
+[![Gem Version](https://badge.fury.io/rb/notification-pusher.svg)](https://badge.fury.io/rb/notification-pusher) ![Travis](https://travis-ci.com/jonhue/notifications-rails.svg?branch=master)
 
-Push your notifications to various services. Including Email, ActionCable, OneSignal (cross-platform notifications).
+Deliver your notifications through various services. Including Email delivery & OneSignal (cross-platform notification delivery).
 
 ---
 
@@ -10,15 +10,13 @@ Push your notifications to various services. Including Email, ActionCable, OneSi
 
 * [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)
+  * [Delivery methods](#delivery-methods)
+    * [Defining a delivery method](#defining-a-delivery-method)
+    * [Using a delivery method](#using-a-delivery-method)
+  * [Writing a custom delivery method](#writing-a-custom-delivery-method)
 * [To Do](#to-do)
 * [Contributing](#contributing)
-    * [Contributors](#contributors)
-    * [Semantic versioning](#semantic-versioning)
-* [License](#license)
+  * [Semantic versioning](#semantic-versioning)
 
 ---
 
@@ -38,12 +36,6 @@ 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
@@ -56,81 +48,83 @@ To wrap things up, migrate the changes to your database:
 
 ## Usage
 
-### Pushers
+### Delivery methods
 
-A pusher handles the process of sending your notifications to various services for you.
+A delivery method handles the process of sending your notifications to various services for you.
 
-#### Defining a pusher
+#### Defining a delivery method
 
-You define pushers in your `NotificationPusher` configuration (`config/initializers/notification-pusher.rb`). Using:
+You register delivery methods in your `NotificationPusher` configuration (`config/initializers/notification-pusher.rb`). Using:
 
 ```ruby
 NotificationPusher.configure do |config|
-    config.define_pusher name, options
+  config.register_delivery_method name, class_name, options
 end
 ```
 
-More details about defining a specific pusher (name and available options) are available in the respective documentation of the gem.
+More details about defining a specific delivery method (name and available options) are available in the respective documentation of the gem.
 
-#### Using a pusher
+#### Using a delivery method
 
-It is super simple to initialize a push:
+It is super simple to initialize a delivery:
 
 ```ruby
-notification = Notification.create target: User.first, object: Recipe.first
-notification.push name, custom_options
+notification = Notification.create(target: User.first, object: Recipe.first)
+notification.deliver(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.
+Where `name` is the name of the defined delivery method and `custom_options` are the options that will override the default options the delivery method 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
+notification = Notification.create(target: User.first, object: Recipe.first, delivery_method: name, delivery_options: custom_options)
 ```
 
 **Note:** In this case, pass `custom_options` as a `Hash`.
 
-It is possible to use mutliple pushers at a time:
+It is possible to use mutliple delivery methods at a time:
 
 ```ruby
-notification.push [name_one, name_two], name_one: custom_options, name_two: custom_options
+notification.deliver([name_one, name_two], name_one: custom_options, name_two: custom_options)
 ```
 
-### Writing a custom pusher
+### Writing a custom delivery method
 
-Writing custom pushers is fairly simple. Just add a new subclass to `NotificationPusher`:
+Writing custom delivery methods is fairly simple. Just add a new class to the `NotificationPusher::DeliveryMethod` namespace:
 
 ```ruby
-class NotificationPusher::CustomPusher
-
-    def initialize notification, options = {}
-        # ...
+module NotificationPusher
+  module DeliveryMethod
+    class CustomPusher < NotificationPusher::DeliveryMethod::Base
+      def call
+        # `notification` and `options` are accessible here
+      end
     end
-
+  end
 end
 ```
 
-This is how to define and use your pusher:
+This is how to register and use your delivery method:
 
 ```ruby
 NotificationPusher.configure do |config|
-    config.define_pusher :CustomPusher, option_one: 'value_one'
+  config.register_delivery_method :custom, :CustomPusher, option_one: 'value_one'
 end
 ```
 
 ```ruby
-notification = Notification.create target: User.first, object: Recipe.first
-notification.push :CustomPusher, option_one: 'value_two'
+notification = Notification.create(target: User.first, object: Recipe.first)
+notification.deliver(:custom, 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.
+For further reference take a look at the default [ActionMailer](notification-pusher-actionmailer) and [OneSignal](notification-pusher-onesignal) delivery methods.
 
 ---
 
 ## To Do
 
-[Here](https://github.com/jonhue/notifications-rails/projects/3) is the full list of current projects.
+We use [GitHub projects](https://github.com/jonhue/notifications-rails/projects/3) 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).
 
@@ -142,36 +136,6 @@ We hope that you will consider contributing to NotificationPusher. Please read t
 
 [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.

data/lib/generators/notification_pusher/install_generator.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'rails/generators'
-require 'rails/generators/migration'
 
 module NotificationPusher
   class InstallGenerator < Rails::Generators::Base
@@ -9,7 +8,7 @@ module NotificationPusher
     desc 'Install NotificationPusher'
 
     def create_initializer
-      template 'initializer.rb', 'config/initializers/notification-pusher.rb'
+      template 'initializer.rb', 'config/initializers/notification_pusher.rb'
     end
   end
 end

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

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 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'
+  # A delivery method handles the process of sending your notifications to
+  # various services for you.
+  # Learn more: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher#delivery-methods
+  # config.register_delivery_method :email, :ActionMailer, email: 'my@email.com'
 end

data/lib/notification-pusher.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 module NotificationPusher
-  require 'notification_pusher/configuration'
+  require_relative 'notification_pusher/configuration'
 
-  autoload :Pusher, 'notification_pusher/pusher'
+  require_relative 'notification_pusher/delivery_method/base'
 
-  autoload :NotificationLibrary, 'notification_pusher/notification_library'
+  autoload :DeliveryMethodConfiguration,
+           'notification_pusher/delivery_method_configuration'
+  autoload :NotificationLib, 'notification_pusher/notification_lib'
 end

data/lib/notification_pusher/configuration.rb

@@ -1,24 +1,31 @@
 # frozen_string_literal: true
 
+require_relative 'delivery_method_configuration'
+
 module NotificationPusher
   class << self
-    attr_accessor :configuration
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
   end
 
   def self.configure
-    self.configuration ||= Configuration.new
     yield configuration
   end
 
   class Configuration
-    attr_accessor :pushers
+    attr_accessor :delivery_methods
 
     def initialize
-      @pushers = []
+      @delivery_methods = {}
     end
 
-    def define_pusher(name, options = {})
-      pushers << ::NotificationPusher::Pusher.new(name, options)
+    def register_delivery_method(name, class_name, options = {})
+      delivery_methods[name.to_sym] =
+        ::NotificationPusher::DeliveryMethodConfiguration
+        .new(class_name, options)
     end
   end
 end

data/lib/notification_pusher/delivery_method/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NotificationPusher
+  module DeliveryMethod
+    class Base
+      attr_reader :notification, :options
+
+      def initialize(notification, options = {})
+        @notification = notification
+        @options = options
+      end
+
+      def call
+        raise NotImplementedError,
+              'Implement a `call` method that delivers the notification.'
+      end
+    end
+  end
+end

data/lib/notification_pusher/delivery_method_configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module NotificationPusher
+  class DeliveryMethodConfiguration
+    def initialize(class_name, options = {})
+      @klass = NotificationPusher::DeliveryMethod.const_get(class_name)
+      @options = options
+    end
+
+    def call(notification, options = {})
+      options = @options.merge!(options)
+
+      @klass.new(notification, options).call
+    end
+
+    def self.find_by_name(name)
+      NotificationPusher.configuration.delivery_methods[name]
+    end
+
+    def self.find_by_name!(name)
+      find_by_name(name) ||
+        raise(ArgumentError,
+              "Could not find a registered delivery method for :#{name}. " \
+              'Make sure you register it with ' \
+              "config.register_delivery_method :#{name}, :CustomDeliveryMethod")
+    end
+  end
+end

data/lib/notification_pusher/notification_lib.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'notification-handler'
+require 'active_support'
+
+module NotificationPusher
+  module NotificationLib
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :delivery_method
+      attr_accessor :delivery_options
+
+      after_create_commit :deliver_after_create_commit
+
+      include NotificationPusher::NotificationLib::InstanceMethods
+    end
+
+    module InstanceMethods
+      def deliver(delivery_methods, delivery_options = {})
+        return false unless delivery_methods
+        unless delivery_methods.is_a?(Array)
+          return deliver!(delivery_methods, delivery_options)
+        end
+
+        delivery_methods.each do |delivery_method|
+          deliver(delivery_method,
+                  delivery_options[delivery_method.to_sym] || {})
+        end
+      end
+
+      def deliver!(name, options = {})
+        delivery_method = NotificationPusher::DeliveryMethodConfiguration
+                          .find_by_name!(name)
+        delivery_method.call(self, options)
+      end
+
+      private
+
+      # If delivery_method attribute was specified
+      # when object was built/created, deliver using that delivery method
+      def deliver_after_create_commit
+        return if delivery_method.nil?
+
+        deliver(delivery_method, delivery_options || {})
+      end
+    end
+  end
+end

metadata

@@ -1,45 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: notification-pusher
 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: activesupport
   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-handler
   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: 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: '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:
     - - ">="
@@ -67,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rails
+  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:
     - - ">="
@@ -80,8 +136,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Push your notifications to various services. Including Email, ActionCable,
-  OneSignal (cross-platform notifications).
+description: Push your notifications to various services. Including Email & OneSignal
+  (cross-platform notifications).
 email: me@jonhue.me
 executables: []
 extensions: []
@@ -93,8 +149,9 @@ files:
 - 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/notification_pusher/delivery_method/base.rb
+- lib/notification_pusher/delivery_method_configuration.rb
+- lib/notification_pusher/notification_lib.rb
 homepage: https://github.com/jonhue/notifications-rails/tree/master/notification-pusher
 licenses:
 - MIT
@@ -114,8 +171,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: Push your notifications to various services

data/lib/notification_pusher/notification_library.rb

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-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
-        initialize_pusher
-      end
-
-      private
-
-      def initialize_pusher
-        return if pusher.nil?
-
-        if pusher.is_a?(Array)
-          pusher.each do |class_name|
-            initiate_push(class_name, pusher_options[class_name.to_sym])
-          end
-        else
-          initiate_push(pusher, pusher_options)
-        end
-      end
-
-      def initiate_push(class_name, options = {})
-        pusher = NotificationPusher::Pusher.find_by_name(class_name).first
-        pusher.push(self, options)
-      end
-    end
-  end
-end

data/lib/notification_pusher/pusher.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module NotificationPusher
-  class Pusher
-    attr_reader :name
-
-    def initialize(name, options = {})
-      @instances = []
-      @name = name
-      @options = options
-    end
-
-    def push(notification, options = {})
-      options = @options.merge!(options)
-
-      return unless defined?(NotificationPusher.const_get(@name))
-      instance = NotificationPusher.const_get(@name).new(notification, options)
-      @instances << instance
-    end
-
-    def self.find_by_name(name)
-      NotificationPusher.configuration.pushers.select do |pusher|
-        pusher.name == name
-      end
-    end
-  end
-end