notably 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd247eba7aa38faf56a73e9eb6bb8734d22e4358
-  data.tar.gz: 739b8d7bb0d16402b478e2c79d3c30e1d3822813
+  metadata.gz: ad6fa368dc10673bccb89da94dfd1a7f1c09e8ec
+  data.tar.gz: 75a53e5bfdb71b388b918f0145bcc9584e83e7aa
 SHA512:
-  metadata.gz: cc524ed6ef36a6fe5f56ded1cc91b58011603426af5e9876ec6dc0fd33d35dcea1945d4d86bf6321b3a7cc61a6c8b55c03857823b892913209513b57fd8e8a4e
-  data.tar.gz: fcb35392ccaf761b3a6a666a1752668e5114621539fc578c7dfe64ea34b40e0ea8a684c8b1248d8c5809d66eae2ce1dd6efa8c8fb418cc280a17f9d8c5c9e8d4
+  metadata.gz: 1b73b5376a05129b1672d78d7ade3e2d0e556ab05e608e4ef2108df9e1672c9619e818241219645e3cd532f723f4075f4236732acaeb93d22e3a6d01375e3962
+  data.tar.gz: f64cfcb07b6533fc0fab1f4d2028c5ed9ee022e8fb04f5fc786e60ef3970d807914c36ab1b4e2b142e710b85294b20512cf6e2388aa32f127448183435df0b4d

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.1.0
+
+* Callbacks - `before_notify` and `after_notify`
+
+# 0.0.1
+
+Initial Release

data/README.md

@@ -1,6 +1,8 @@
 # Notably
 
-Notably is a redis-backed notification system.
+![a pretty aggressive slogan](notably-slogan.png)
+
+Notably is a redis-backed notification system that _won't_ make you sick and kill you.
 
 ## Installation
 
@@ -241,6 +243,29 @@ Or
 
 (Just a warning, even if you're setting it to something that doesn't need the receiver passed in to calculate it, you need to specify it as an argument if you're going to use lambdas. They don't like it when arguments get ignored.)
 
+## Callbacks
+
+You can use the `before_notify` and `after_notify` class methods to specify callbacks.  They work pretty much as expected taking a lambda, Proc, block, or symbol representing a method.  All of these need to accept an argument for the receiver:
+
+```ruby
+class CommentNotification
+  include Notably::Notification
+  required_attributes :comment_id, :commentable_type, :commentable_id, :author_id
+  group_by :commentable_type, :commentable_id
+  after_notify ->(receiver) { Rails.logger.info "Sent a comment notification to #{receiver.class} #{receiver.id}" }
+  after_notify do |receiver|
+    UserMailer.delay.new_comment(receiver.id, comment_id)
+  end
+  after_notify :foo
+
+  def foo(receiver)
+    Rails.logger.info "Foo"
+  end
+end
+```
+
+They're useful for sending email notifications, and probably a lot of other things, but email notifications was what we built this for.  As a side note, if you are using it to send emails, you'll want to have those emails go through some kind of worker queue so you don't massivly slow down notifications.  We recommend [sidekiq](https://github.com/mperham/sidekiq), because it runs on Redis, has a nice dashboard, and has a clean API.
+
 
 ## Contributing
 

data/lib/notably/configuration.rb

@@ -1,12 +1,10 @@
 module Notably
   class Configuration
-    attr_writer :redis
+    attr_accessor :redis, :touch_receivers
 
     def initialize
-    end
-
-    def redis
-      @redis ||= Redis.current
+      @redis = Redis.current
+      @touch_receivers = true
     end
   end
 end

data/lib/notably/notification.rb

@@ -50,20 +50,26 @@ module Notably
     def save
       receivers.each do |receiver|
         # look for groupable messages within group_within
-        # group_within = self.class.group_within.arity == 1 ? self.class.group_within.call(user) : self.class.group_within.call
-        group_within = self.class.group_within.call(receiver)
-        groupable_notifications = receiver.notifications_since(group_within)
-        groupable_notifications.select! { |notification| notification[:data].slice(*self.class.group_by) == data.slice(*self.class.group_by) }
-        groupable_notifications.each do |notification|
-          @groups += notification[:groups]
+        if self.class.group?
+          group_within = self.class.group_within.call(receiver)
+          groupable_notifications = receiver.notifications_since(group_within)
+          groupable_notifications.select! { |notification| notification[:data].slice(*self.class.group_by) == data.slice(*self.class.group_by) }
+          groupable_notifications.each do |notification|
+            @groups += notification[:groups]
+          end
         end
+        run_callbacks(:before_notify, receiver)
         Notably.config.redis.pipelined do
           Notably.config.redis.zadd(receiver.send(:notification_key), created_at.to_i, marshal)
-          groupable_notifications.each do |notification|
-            Notably.config.redis.zrem(receiver.send(:notification_key), Marshal.dump(notification))
-            @groups -= notification[:groups]
+          receiver.touch if Notably.config.touch_receivers
+          if self.class.group?
+            groupable_notifications.each do |notification|
+              Notably.config.redis.zrem(receiver.send(:notification_key), Marshal.dump(notification))
+              @groups -= notification[:groups]
+            end
           end
         end
+        run_callbacks(:after_notify, receiver)
       end
     end
 
@@ -100,36 +106,71 @@ module Notably
       end
     end
 
+    private
+
+    def run_callbacks(type, *args)
+      self.class.callbacks[type].each do |callback|
+        if callback.is_a? Symbol
+          # callback.to_proc.call(self, *args)
+          self.send(callback, *args)
+        else
+          self.instance_exec(*args, &callback)
+        end
+      end
+    end
+
     module ClassMethods
+      attr_reader :callbacks
+
+      def self.extended(base)
+        base.class_eval do
+          @callbacks = {after_notify: [], before_notify: []}
+          @group_by = []
+          @group_within = ->(receiver) { receiver.last_notification_read_at }
+          @required_attributes = []
+        end
+      end
+
       def create(attributes={})
         new(attributes).save
       end
 
       def required_attributes(*args)
         if args.any?
-          @required_attributes ||= []
           @required_attributes += args
         else
-          @required_attributes ||= []
+          @required_attributes
         end
       end
 
       def group_by(*args)
         if args.any?
-          @group_by ||= []
           @group_by += args
         else
-          @group_by ||= []
+          @group_by
         end
       end
 
+      def group?
+        @group_by.any?
+      end
+
       def group_within(block=nil)
         if block
           @group_within = block
         else
-          @group_within ||= ->(receiver) { receiver.last_notification_read_at }
+          @group_within
         end
       end
+
+      def before_notify(method=nil, &block)
+        @callbacks[:before_notify] << (block || method)
+      end
+
+      def after_notify(method=nil, &block)
+        @callbacks[:after_notify] << (block || method)
+      end
+
     end
 
   end

data/lib/notably/version.rb

@@ -1,3 +1,3 @@
 module Notably
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notably
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Will Cosgrove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +56,7 @@ files:
 - lib/notably/notifiable.rb
 - lib/notably/notification.rb
 - lib/notably/version.rb
+- notably-slogan.png
 - notably.gemspec
 homepage: ''
 licenses: