webhook_system 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d120e25bddd3b90b7f79a51f5ee17aaf9e161336
-  data.tar.gz: e872d6ca6dad0879a5c71b9ca0ace3c129bc33c1
+  metadata.gz: 90f58d18463b764007411f0afe4d73c5bb57355b
+  data.tar.gz: cceb480b7c982ec3cf245583be982d6f774bd25c
 SHA512:
-  metadata.gz: 793b9a205d0244f79aad3fad61ffd2aadbde2f65b16545acebb7c9192859a85d1f6aec764371905baf373eeaa8950e1cd31c8906f9a47a4a27370b550e672733
-  data.tar.gz: fb7a2493ef2d3a666162c9eb3b4d1ce1b9cc8b1b58261869ec11a672514eb83b06458a874701dd602bdedf696df3cecdb87e5e2f510038884b578faddffaff3b
+  metadata.gz: f923b7323b1b3eef8a4d9ed1db3315c66e1ee96daaf6397a37d52fe171aef8696a73224a3f9edc2e6215223a5cea1b78156a39cc59eab379003e41c29a71702f
+  data.tar.gz: 97de701df22a41e2d5d3ec80204be6422c2a9a07c04f6a0c61f0bfe3237266c4de9310e754c43459e60336618b1347ed33a208ee22c28b183051666b966d9938

data/README.md

@@ -203,12 +203,46 @@ more suitable for the actual notification payload.
 The general API for this is via:
 
 ```ruby
-WebhookSystem.dispatch(event_object)
+WebhookSystem::Subscription.dispatch(event_object)
 ```
 
 This is meant to be fairly fire and forget. Internally this will create an ActiveJob for each subscription
 interested in the event.
 
+### Dispatching to Selected Subscriptions
+
+There may be scenarios where you extended the Subscription model, and may need to only dispatch to a subset of subs.
+For example, if you attached a relation to say Account. The `dispatch` method is actually defined to work with any
+subscription relation. eg:
+
+```ruby
+account = Account.find(1) # assume we have some model called Account
+subs = account.webhook_subscriptions # and we added a column to webhook_subscriptions to accomodate this extra relation
+subs.dispatch(some_event) # you can dispatch to just those subscriptions (it will filter for the specific ones)
+                          # that are actually interested in the event
+```
+
+### Checking if any sub is interested
+
+There may scenarios, where you really don't want to do some additional work unless you really have an event to dispatch.
+You can check pretty quickly if there is any topics interested liks so:
+
+```ruby
+if WebhookSystem::Subscription.interested_in_topic('some_topic').present?
+  # do some stuff
+end
+```
+
+This also works with selected subscriptions like in the example above:
+
+```ruby
+account = Account.find(1) # assume we have some model called Account
+subs = account.webhook_subscriptions # and we added a column to webhook_subscriptions to accomodate this extra relation
+if subs.interested_in_topic('some_topic').present?
+  subs.dispatch(SomeEvent.build(some_expensive_function()))
+end
+```
+
 # Payload Format
 
 Payloads can either be plain json or encrypted. On top of that, they're also signed. The format for the signature

data/lib/webhook_system/base_event.rb

@@ -13,12 +13,12 @@ module WebhookSystem
 
     def event_name
       mesg = "class #{self.class.name} must implement abstract method `#{self.class.name}#event_name()'."
-      raise RuntimeError.new(mesg).tap { |err| err.backtrace = caller }
+      raise with_caller_backtrace(RuntimeError.new(mesg), 2)
     end
 
     def payload_attributes
       mesg = "class #{self.class.name} must implement abstract method `#{self.class.name}#payload_attributes()'."
-      raise RuntimeError.new(mesg).tap { |err| err.backtrace = caller }
+      raise with_caller_backtrace(RuntimeError.new(mesg), 2)
     end
 
     def as_json
@@ -39,6 +39,11 @@ module WebhookSystem
 
     private
 
+    def with_caller_backtrace(exception, backtrack=2)
+      exception.set_backtrace(caller[backtrack..-1])
+      exception
+    end
+
     def validate_attribute_name(key)
       if self.class.key_is_reserved?(key)
         message = "#{self.class.name} should not be defining an attribute named #{key} since its reserved"

data/lib/webhook_system/subscription.rb

@@ -19,6 +19,16 @@ module WebhookSystem
 
     scope :interested_in_topic, -> (topic) { active.for_topic(topic) }
 
+    # Main invocation point for dispatching events, can either be called on the class
+    # or on a relation (ie a scoped down list of subs), will find applicable subs and dispatch to them
+    #
+    # @param [WebhookSystem::BaseEvent] event The Event Object
+    def self.dispatch(event)
+      interested_in_topic(event.event_name).each do |subscription|
+        WebhookSystem::Job.perform_later subscription, event.as_json
+      end
+    end
+
     # Just a helper to get a nice representation of the subscription
     def url_domain
       URI.parse(url).host

data/lib/webhook_system/version.rb

@@ -1,3 +1,3 @@
 module WebhookSystem
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/webhook_system.rb

@@ -20,8 +20,4 @@ module WebhookSystem
   # Error raised when there is an issue with decoding the payload
   class DecodingError < RuntimeError
   end
-
-  class << self
-    delegate :dispatch, to: :'WebhookSystem::Dispatcher'
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webhook_system
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Piotr Banasik
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -286,7 +286,6 @@ files:
 - Rakefile
 - lib/webhook_system.rb
 - lib/webhook_system/base_event.rb
-- lib/webhook_system/dispatcher.rb
 - lib/webhook_system/encoder.rb
 - lib/webhook_system/event_log.rb
 - lib/webhook_system/job.rb

data/lib/webhook_system/dispatcher.rb

@@ -1,16 +0,0 @@
-module WebhookSystem
-
-  # Main code that handles dispatching of events out to subscribers
-  class Dispatcher
-    class << self
-
-      # @param [WebhookSystem::BaseEvent] event The Event Object
-      def dispatch(event)
-        WebhookSystem::Subscription.interested_in_topic(event.event_name).each do |subscription|
-          WebhookSystem::Job.perform_later subscription, event.as_json
-        end
-      end
-
-    end
-  end
-end