abstract_notifier 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f53c7d7582adccf56af7c488e41063cf5b344cbe198a548885d52b60f030772
-  data.tar.gz: d13d22f8e543f15c4bbf48bb29838746cdf0843430a1eb55e1c89cafa3c417da
+  metadata.gz: a36463d0a1ed93c6f48229bed9135f6c1ec3e301c76dc5b9edcc28f19d75cc3e
+  data.tar.gz: 7c56ec837be932967f22c592018b2210912fb2e53a40e5b8526b619dff70c4b1
 SHA512:
-  metadata.gz: 462d22226d63a1c862f089f5a4b78cac6c457ca78160510b82588129c3d914a649daf4349945a989429202fde18ac87eff4ec3c42d670240eaa90959a5d7a010
-  data.tar.gz: 86f83533acc72205f77d7c83486e4cee9f9b59b5d6efe6ab6692dac18c3fbd58959c5d96b2537eaf5f7c9b95a9810297908ea0f6366cd8dec6cc2db2eed7f1cd
+  metadata.gz: 4a191cf257f1691d8df1b395ed14610246e2ae8614bde594abd359fea8104fe3c903a9332060545563e289652b45716d76c89d2f763a8bd0c911d305641c594d
+  data.tar.gz: 888f89197efafc92cbbfffc220959c449fcd405c8fea6932ab3f1dde4ed4f1d726e2c19ce4c43e68ca2021a8cc040a53831506c05a5272ce7f43330e4b054364

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change log
+
+## master
+
+## 0.2.0 (2018-01-11)
+
+- Add class-level defaults. ([@palkan][])
+
+- Add `#notification_name`. ([@palkan][])
+
+## 0.1.0 (2018-12-21)
+
+Initial version.
+
+[@palkan]: https://github.com/palkan

data/README.md

@@ -5,7 +5,7 @@
 
 Abstract Notifier is a tool which allows you to describe/model any text-based notifications (such as Push Notifications) the same way Action Mailer does for email notifications.
 
-Abstract Notifier (as the name states) doesn't provide any specific implementaion for sending notifications. Instead if provide tools to organize your notification-specific code and make it easily testable.
+Abstract Notifier (as the name states) doesn't provide any specific implementation for sending notifications. Instead, it offers tools to organize your notification-specific code and make it easily testable.
 
 <a href="https://evilmartians.com/?utm_source=action_policy">
 <img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
@@ -31,7 +31,7 @@ $ bundle
 
 ## Usage
 
-Notifer class is very similar to Action Mailer mailer class with `notification` method instead of a `mail` method:
+Notifier class is very similar to Action Mailer mailer class with `notification` method instead of a `mail` method:
 
 ```ruby
 class EventsNotifier < ApplicationNotifier
@@ -60,7 +60,7 @@ class ApplicationNotifier < AbstractNotifier::Base
 end
 ```
 
-Driver could be any callbable Ruby object (i.e. anything that responds to `#call`).
+A driver could be any callable Ruby object (i.e., anything that responds to `#call`).
 
 That's a developer responsibility to implement the driver (we do not provide any drivers out-of-the-box; at least yet).
 
@@ -83,13 +83,47 @@ end
 EventsNotifier.with(profile: profile).canceled(event).notify_later
 ```
 
+### Defaults
+
+You can specify default notification fields at a class level:
+
+```ruby
+class EventsNotifier < ApplicationNotifier
+  # `category` field will be added to the notification
+  # if missing
+  default category: "EVENTS"
+
+  # ...
+end
+```
+
+**NOTE**: when subclassing notifiers, default parameters are merged.
+
+You can also specify a block or a method name as the default params _generator_.
+This could be useful in combination with the `#notification_name` method to generate dynamic payloads:
+
+```ruby
+class ApplicationNotifier < AbstractNofitier::Base
+  default :build_defaults_from_locale
+
+
+  private
+
+  def build_defaults_from_locale
+    {
+      subject: I18n.t(notification_name, scope: [:notifiers, self.class.name.underscore])
+    }
+  end
+end
+```
+
 ### Background jobs / async notifications
 
 To use `notify_later` you **must** configure `async_adapter`.
 
 We provide Active Job adapter out-of-the-box and use it if Active Job is present.
 
-Custom async adapter must implement `enqueue` method:
+The custom async adapter must implement `enqueue` method:
 
 ```ruby
 class MyAsyncAdapter
@@ -99,7 +133,7 @@ class MyAsyncAdapter
 
   # `enqueue` method accepts notifier class and notification
   # payload.
-  # We need to know notifier class to use it's driver.
+  # We need to know notifier class to use its driver.
   def enqueue(notifier_class, payload)
     # your implementation here
   end
@@ -159,7 +193,7 @@ expect { EventsNotifier.with(profile: profile).canceled(event).notify_later}.
 
 ### [`active_delivery`](https://github.com/palkan/active_delivery)
 
-Active Delivery is the next-level abstraction which allows to combine multiple notification channels in one place.
+Active Delivery is the next-level abstraction which allows combining multiple notification channels in one place.
 
 Abstract Notifier provides a _notifier_ line for Active Delivery:
 
@@ -169,11 +203,11 @@ class ApplicationDelivery < ActiveDelivery::Base
   register_line :notifier, ActiveDelivery::Lines::Notifier,
                 # you may provide a resolver, which infers notifier class
                 # from delivery name (resolver is a callable).
-                rsolver: ->(name) { resolve_somehow(name) }
+                resolver: ->(name) { resolve_somehow(name) }
 end
 ```
 
-**NOTE:** we automatically add `:notifier` line with `"*Delivery" -> *Notifier` resolution mechanism if `#safe_constantize` method is defined for String, i.e. you don't have to configure the default notifier line when running Rails.
+**NOTE:** we automatically add `:notifier` line with `"*Delivery" -> *Notifier` resolution mechanism if `#safe_constantize` method is defined for String, i.e., you don't have to configure the default notifier line when running Rails.
 
 ## Contributing
 

data/lib/abstract_notifier/base.rb

@@ -25,9 +25,26 @@ module AbstractNotifier
 
   # Base class for notifiers
   class Base
-    class << self
-      alias with new
+    class ParamsProxy
+      attr_reader :notifier_class, :params
+
+      def initialize(notifier_class, params)
+        @notifier_class = notifier_class
+        @params = params
+      end
+
+      # rubocop:disable Style/MethodMissingSuper
+      def method_missing(method_name, *args)
+        notifier_class.new(method_name, params).public_send(method_name, *args)
+      end
+      # rubocop:enable Style/MethodMissingSuper
+
+      def respond_to_missing?(*args)
+        notifier_class.respond_to_missing?(*args)
+      end
+    end
 
+    class << self
       attr_writer :driver
 
       def driver
@@ -58,14 +75,51 @@ module AbstractNotifier
           end
       end
 
+      def default(method_name = nil, **hargs)
+        return @defaults_generator = Proc.new if block_given?
+
+        return @defaults_generator = proc { send(method_name) } unless method_name.nil?
+
+        @default_params =
+          if superclass.respond_to?(:default_params)
+            superclass.default_params.merge(hargs).freeze
+          else
+            hargs.freeze
+          end
+      end
+
+      def defaults_generator
+        return @defaults_generator if instance_variable_defined?(:@defaults_generator)
+
+        @defaults_generator =
+          if superclass.respond_to?(:defaults_generator)
+            superclass.defaults_generator
+          end
+      end
+
+      def default_params
+        return @default_params if instance_variable_defined?(:@default_params)
+
+        @default_params =
+          if superclass.respond_to?(:default_params)
+            superclass.default_params.dup
+          else
+            {}
+          end
+      end
+
       def method_missing(method_name, *args)
         if action_methods.include?(method_name.to_s)
-          new.public_send(method_name, *args)
+          new(method_name).public_send(method_name, *args)
         else
           super
         end
       end
 
+      def with(params)
+        ParamsProxy.new(self, params)
+      end
+
       def respond_to_missing?(method_name, _include_private = false)
         action_methods.include?(method_name.to_s) || super
       end
@@ -87,16 +141,34 @@ module AbstractNotifier
       end
     end
 
-    attr_reader :params
+    attr_reader :params, :notification_name
 
-    def initialize(**params)
+    def initialize(notification_name, **params)
+      @notification_name = notification_name
       @params = params.freeze
     end
 
     def notification(**payload)
+      merge_defaults!(payload)
+
       raise ArgumentError, "Notification body must be present" if
         payload[:body].nil? || payload[:body].empty?
       Notification.new(self.class, payload)
     end
+
+    private
+
+    def merge_defaults!(payload)
+      defaults =
+        if self.class.defaults_generator
+          instance_exec(&self.class.defaults_generator)
+        else
+          self.class.default_params
+        end
+
+      defaults.each do |k, v|
+        payload[k] = v unless payload.key?(k)
+      end
+    end
   end
 end

data/lib/abstract_notifier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AbstractNotifier
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_notifier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_delivery
@@ -91,6 +91,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -128,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ActionMailer-like interface for any type of notifications