active_delivery 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba024e906a6a7bdf0dafd6a4e83ecefc7121b475ec9f9e7dfdadaacf4a2e04c0
-  data.tar.gz: 1045c894dc23a4d90282fac45a158af962839d9cd026ff8d5331371141c5c120
+  metadata.gz: fab4f00d6e9540f490e987b355133449d9213d2a1f9cb683aced62e16ae36a84
+  data.tar.gz: e9728da5a0a19ba23e7412a2ed678cabb28e7c1c6ac16ae89246302a80b8f2dc
 SHA512:
-  metadata.gz: 0f54fd937683e8e70871ece3900d2f75026e0674e316cc8969ad5066e5757b4982697f3e2c5e59d9969497c54874b6c9ea107ee08eae502d1ef87f7013234943
-  data.tar.gz: 4af2720f68788f2cc35d4acbdfc2ed6870a809d075b08a16663ddbd459ebc734939eab1208a4acfc6fd46dc1ac2a19603d1de5ccfbfbeb1d5ff1a11ae749ff45
+  metadata.gz: c3be343f6a4151bcd434105b22c0e4a028dcc0bc4a22ea1e70e13de1213a3469d4cc6ef942959df8005784eab0d41b2bcf42858aa3d7915743a4b8b337e13f0e
+  data.tar.gz: ef751694baca35139d81ef11a277adde948e63b59528d040ef08390c36952a6ff35da49174b80070cf5df6d836c054d1d6d30ee23cbd7103ab0c73c32b723b83

data/.rubocop.yml

@@ -16,6 +16,9 @@ AllCops:
 Standard/SemanticBlocks:
   Enabled: false
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: no_comma
 

data/CHANGELOG.md

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

data/README.md

@@ -3,7 +3,7 @@
 
 # Active Delivery
 
-Framework providing an entrypoint (single _interface_) for all types of notifications: mailers, push notifications, whatever you want.
+Framework providing an entry point (single _interface_) for all types of notifications: mailers, push notifications, whatever you want.
 
 <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>
@@ -17,13 +17,13 @@ Requirements:
 
 We need a way to handle different notifications _channel_ (mail, push) in one place.
 
-From the business-logic point of view we want to _notify_ a user, hence we need a _separate abstraction layer_ as an entrypoint to different types of notifications.
+From the business-logic point of view we want to _notify_ a user, hence we need a _separate abstraction layer_ as an entry point to different types of notifications.
 
 ## The solution
 
-Here comes the _Active Delivery_.
+Here comes _Active Delivery_.
 
-In the simplest case when we have only mailers Active Delivery is just a wrapper for Mailer with (possibly) some additional logic provided (e.g. preventing emails to unsubscribed users).
+In the simplest case when we have only mailers Active Delivery is just a wrapper for Mailer with (possibly) some additional logic provided (e.g., preventing emails to unsubscribed users).
 
 Motivations behind Active Delivery:
 - organize notifications related logic:
@@ -59,7 +59,7 @@ $ bundle
 
 ## Usage
 
-_Delivery_ class is used to trigger notifications. It describes how to notify a user (e.g. via email or via push notification or both):
+The _Delivery_ class is used to trigger notifications. It describes how to notify a user (e.g., via email or push notification or both):
 
 ```ruby
 class PostsDelivery < ActiveDelivery::Base
@@ -68,7 +68,7 @@ class PostsDelivery < ActiveDelivery::Base
 end
 ```
 
-It acts like a proxy in front of the different delivery channels (i.e. mailers, notifiers). That means that calling a method on delivery class invokes the same method on the corresponding _sender_ class, e.g.:
+It acts as a proxy in front of the different delivery channels (i.e., mailers, notifiers). That means that calling a method on delivery class invokes the same method on the corresponding _sender_ class, e.g.:
 
 ```ruby
 PostsDelivery.notify(:published, user, post)
@@ -88,7 +88,7 @@ Delivery also supports _parameterized_ calling:
    PostsDelivery.with(user: user).notify(:published, post)
 ```
 
-The parameters could be accessed through `params` instance method (e.g. to implement guard-like logic).
+The parameters could be accessed through the `params` instance method (e.g., to implement guard-like logic).
 
 **NOTE**: When params are presents the parametrized mailer is used, i.e.:
 
@@ -100,11 +100,11 @@ See [Rails docs](https://api.rubyonrails.org/classes/ActionMailer/Parameterized.
 
 ## Callbacks support
 
-**NOTE:** callbacks are only available if ActiveSupport is present in the app's env.
+**NOTE:** callbacks are only available if ActiveSupport is present in the app's runtime.
 
 ```ruby
 # Run method before delivering notification
-# NOTE: when `false` is returned the executation is halted
+# NOTE: when `false` is returned the execution is halted
 before_notify :do_something
 
 # You can specify a notification method (to run callback only for that method)
@@ -116,11 +116,26 @@ after_notify :cleanup
 around_notify :set_context
 ```
 
+Example:
+
+```ruby
+# Let's log notifications
+class MyDelivery < ActiveDelivery::Base
+  after_notify do
+    # You can access the notificaion name within the instance
+    MyLogger.info "Delivery triggered: #{notification_name}"
+  end
+end
+
+MyDeliver.notify(:something_wicked_this_way_comes)
+#=> Delivery triggered: something_wicked_this_way_comes
+```
+
 ## Testing
 
 **NOTE:** RSpec only for the time being.
 
-Active Delivery provides an elegant way to test deliveries in your code (i.e. when you want to test whether a notification has been sent) through a `have_delivered_to` matcher:
+Active Delivery provides an elegant way to test deliveries in your code (i.e., when you want to check whether a notification has been sent) through a `have_delivered_to` matcher:
 
 ```ruby
 it "delivers notification" do
@@ -131,7 +146,7 @@ it "delivers notification" do
 You can also use such RSpec features as [compound expectations](https://relishapp.com/rspec/rspec-expectations/docs/compound-expectations) and [composed matchers](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/composing-matchers):
 
 ```ruby
-it "delivers to rsvped members via .notify" do
+it "delivers to RSVPed members via .notify" do
   expect { subject }.
     to have_delivered_to(Community::EventsDelivery, :canceled, an_instance_of(event)).with(
       a_hash_including(profile: another_profile)
@@ -141,7 +156,7 @@ it "delivers to rsvped members via .notify" do
 end
 ```
 
-If you want to test that no notification is deliver you can use negation:
+If you want to test that no notification is delivered you can use negation:
 
 ```ruby
 specify "when event is not found" do
@@ -155,11 +170,11 @@ end
 
 ## Custom "lines"
 
-_Line_ class describes the way you want to _transfer_ your deliveries.
+The _Line_ class describes the way you want to _transfer_ your deliveries.
 
-Out-of-the box we provide only Action Mailer _line_.
+We only provide only Action Mailer _line_ out-of-the-box.
 
-Line connects _delivery_ to the _sender_ class responsible for sending notifications.
+A line connects _delivery_ to the _sender_ class responsible for sending notifications.
 
 If you want to use parameterized deliveries, your _sender_ class must respond to `.with(params)` method.
 
@@ -168,10 +183,10 @@ Assume that we want to send messages via _pigeons_ and we have the following sen
 ```ruby
 class EventPigeon
   class << self
-    # Add `.with` method as an alias
+    # Add `.with`  method as an alias
     alias with new
 
-    # delegate delivery action to instance
+    # delegate delivery action to the instance
     def message_arrived(*args)
       new.message_arrived(*arsg)
     end
@@ -182,13 +197,13 @@ class EventPigeon
   end
 
   def message_arrived(msg)
-    # send pigeon with the message
+    # send a pigeon with the message
   end
 end
 ```
 
-Now we want to add a _pigeon_ line to our `EventDelivery`, that is we want to send pigeons when 
-we call `EventDelivery.notify(:message_arrived, "ping-ping!")`.
+Now we want to add a _pigeon_ line to our `EventDelivery,` that is we want to send pigeons when 
+we call `EventDelivery.notify(:message_arrived, "ping-pong!")`.
 
 Line class has the following API:
 
@@ -201,7 +216,7 @@ class PigeonLine < ActiveDelivery::Lines::Base
     name.gsub(/Delivery$/, "Pigeon").safe_constantize
   end
 
-  # This method should return true if sender recognizes the delivery action
+  # This method should return true if the sender recognizes the delivery action
   def notify?(delivery_action)
     # `handler_class` is available within the line instance 
     sender_class.respond_to?(delivery_action)
@@ -217,8 +232,8 @@ class PigeonLine < ActiveDelivery::Lines::Base
     PigeonService.launch pigeon
   end
 
-  # Called when we want to send message asynchronously.
-  # For example, you can use background job here.
+  # Called when we want to send a message asynchronously.
+  # For example, you can use a background job here.
   def notify_later(sender, delivery_action, *args)
     pigeon = sender.public_send(delivery_action, *args)
     # PigeonLaunchService do all the sending job
@@ -231,13 +246,13 @@ end
 You can disable automatic inference of sender classes by marking delivery as _abstract_:
 
 ```ruby
-# we don't not want to use ApplicationMailer by default, don't we?
+# we don't want to use ApplicationMailer by default, don't we?
 class ApplicationDelivery < ActiveDelivery::Base
   self.abstract_class = true
 end
 ```
 
-Final step is to register the line within your delivery class:
+The final step is to register the line within your delivery class:
 
 ```ruby
 class EventDelivery < ActiveDelivery::Base

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"

data/gemfiles/rails42.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gem "activesupport", "~> 4.2"

data/gemfiles/railsmaster.gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gem "rails", github: "rails/rails"

data/lib/active_delivery.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_delivery/version"
 require "active_delivery/base"
 require "active_delivery/callbacks" if defined?(ActiveSupport)

data/lib/active_delivery/base.rb

@@ -78,7 +78,7 @@ module ActiveDelivery
       end
     end
 
-    attr_reader :params
+    attr_reader :params, :notification_name
 
     def initialize(**params)
       @params = params
@@ -86,13 +86,9 @@ module ActiveDelivery
     end
 
     # Enqueues delivery (i.e. uses #deliver_later for mailers)
-    def notify(mid, *args, sync: false)
-      delivery_lines.each do |type, line|
-        next if line.handler_class.nil?
-        next unless line.notify?(mid)
-
-        notify_line(type, mid, *args, params: params, sync: sync)
-      end
+    def notify(mid, *args)
+      @notification_name = mid
+      do_notify(*args)
     end
 
     # The same as .notify but delivers synchronously
@@ -103,8 +99,17 @@ module ActiveDelivery
 
     private
 
-    def notify_line(type, mid, *args)
-      delivery_lines[type].notify(mid, *args)
+    def do_notify(*args, sync: false)
+      delivery_lines.each do |type, line|
+        next if line.handler_class.nil?
+        next unless line.notify?(notification_name)
+
+        notify_line(type, *args, params: params, sync: sync)
+      end
+    end
+
+    def notify_line(type, *args)
+      delivery_lines[type].notify(notification_name, *args)
     end
 
     def delivery_lines

data/lib/active_delivery/callbacks.rb

@@ -41,7 +41,7 @@ module ActiveDelivery
     end
 
     module InstanceExt
-      def notify(*)
+      def do_notify(*)
         run_callbacks(:notify) { super }
       end
 
@@ -64,16 +64,19 @@ module ActiveDelivery
                          skip_after_callbacks_if_terminated: true
       end
 
-      def before_notify(method_name, on: :notify)
-        set_callback on, :before, method_name
+      def before_notify(method_or_block = nil, on: :notify)
+        method_or_block ||= Proc.new
+        set_callback on, :before, method_or_block
       end
 
-      def after_notify(method_name, on: :notify)
-        set_callback on, :after, method_name
+      def after_notify(method_or_block = nil, on: :notify)
+        method_or_block ||= Proc.new
+        set_callback on, :after, method_or_block
       end
 
-      def around_notify(method_name, on: :notify)
-        set_callback on, :around, method_name
+      def around_notify(method_or_block = nil, on: :notify)
+        method_or_block ||= Proc.new
+        set_callback on, :around, method_or_block
       end
     end
   end

data/lib/active_delivery/lines/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveDelivery
   module Lines
     class Base

data/lib/active_delivery/lines/mailer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveDelivery
   module Lines
     class Mailer < Base

data/lib/active_delivery/testing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveDelivery
   module TestDelivery
     class << self

data/lib/active_delivery/testing/rspec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActiveDelivery
   class HaveDeliveredTo < RSpec::Matchers::BuiltIn::BaseMatcher
     attr_reader :delivery_class, :event, :args, :params, :sync_value

data/lib/active_delivery/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_delivery
 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-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -114,7 +115,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: Rails framework for managing all types of notifications in one place