eventifier 0.0.2 → 0.0.3

data/.gitignore

@@ -1,2 +1,3 @@
 *.gem
-tmp
+tmp
+.idea/*

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  # - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  # - jruby-18mode # JRuby in 1.8 mode
+  # - jruby-19mode # JRuby in 1.9 mode
+
+env:
+  - ORM=active_record
+  - ORM=mongoid
+
+before_script:
+  - psql -c 'create database eventifier;' -U postgres

data/Gemfile.lock

@@ -1,10 +1,12 @@
 PATH
   remote: .
   specs:
-    eventifier (0.0.1)
+    eventifier (0.0.2)
       actionmailer
       actionmailer
       activerecord
+      bson_ext
+      mongoid
 
 GEM
   remote: http://rubygems.org/
@@ -34,18 +36,28 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
+    bson (1.6.4)
+    bson_ext (1.6.3)
+      bson (~> 1.6.3)
     builder (3.0.0)
+    database_cleaner (0.7.2)
     diff-lcs (1.1.3)
     erubis (2.7.0)
+    fabrication (1.4.0)
     hike (1.2.1)
     i18n (0.6.0)
     journey (1.0.3)
-    machinist (2.0)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.18)
+    mongo (1.6.2)
+      bson (~> 1.6.2)
+    mongoid (2.4.11)
+      activemodel (~> 3.1)
+      mongo (<= 1.6.2)
+      tzinfo (~> 0.3.22)
     multi_json (1.3.6)
     pg (0.13.2)
     polyglot (0.3.3)
@@ -77,7 +89,9 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord
+  database_cleaner
   eventifier!
-  machinist
+  fabrication
+  mongoid
   pg
   rspec

data/README.textile

@@ -1,3 +1,5 @@
+!https://secure.travis-ci.org/inspire9/eventifier.png!:http://travis-ci.org/inspire9/eventifier
+
 h1. Eventifier
 
 Event tracking and notifying for active record models
@@ -9,6 +11,7 @@ Send notifications of events
 
 h2. Example
 
+<pre><code>
 class EventTracking
   include Eventifier::EventTracking
 
@@ -16,6 +19,7 @@ class EventTracking
     events_for Post do
       track_on [:create, :update, :destroy], :attributes => { :except => %w(updated_at) }
       notify :group => :members, :on => [:create, :update]
+      url -> post { [post.category, post] }
     end
 
     events_for Announcement do
@@ -24,6 +28,7 @@ class EventTracking
     end
   end
 end
+</code></pre>
 
 That's it!
 
@@ -38,9 +43,9 @@ Creating the database:
 * createdb eventifier
 
 Spec
-``
+<pre><code>
   rspec spec
-``
+</code></pre>
 
 h2. Contributors
 

data/Rakefile

@@ -1,13 +1,6 @@
 require "bundler/gem_tasks"
-
-require 'rake'
 require 'rspec/core/rake_task'
-require 'rdoc/task'
-
 
 RSpec::Core::RakeTask.new
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.rcov = true
-  spec.rcov_opts = ['--exclude', 'spec', '--exclude', '.rvm']
-end
+task :default => :spec

data/eventifier.gemspec

@@ -5,7 +5,7 @@ require "eventifier/version"
 Gem::Specification.new do |s|
   s.name        = "eventifier"
   s.version     = Eventifier::VERSION
-  s.authors     = ["Nathan Sampimon"]
+  s.authors     = ["Nathan Sampimon", "Peter Murray"]
   s.email       = ["nathan@inspire9.com"]
   s.homepage    = "http://github.com/inspire9/eventifier"
   s.summary     = "Event tracking and notifying for active record models"
@@ -15,15 +15,19 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
   s.add_development_dependency  "activerecord"
+  s.add_development_dependency  "mongoid"
   s.add_runtime_dependency      "actionmailer"
-  s.add_development_dependency  "machinist"
+  s.add_development_dependency  "fabrication"
+  s.add_development_dependency  "database_cleaner"
   s.add_development_dependency  "pg"
   s.add_development_dependency  "rspec"
 
   s.add_runtime_dependency "activerecord"
+  s.add_runtime_dependency "bson_ext"
+  s.add_runtime_dependency "mongoid"
   s.add_runtime_dependency "actionmailer"
 end

data/lib/eventifier/active_record/event.rb

@@ -0,0 +1,9 @@
+require 'eventifier/event_mixin'
+
+module Eventifier
+  class Event < ActiveRecord::Base
+    include Eventifier::EventMixin
+
+    serialize :change_data
+  end
+end

data/lib/eventifier/active_record/event_observer.rb

@@ -0,0 +1,8 @@
+require 'eventifier/event_observer_mixin'
+
+module Eventifier
+  class EventObserver < ActiveRecord::Observer
+    include Eventifier::EventObserverMixin
+
+  end
+end

data/lib/eventifier/active_record/event_tracking.rb

@@ -0,0 +1,11 @@
+module Eventifier
+  module EventTracking
+    OBSERVER_CLASS = ActiveRecord::Observer
+
+    def add_notification_association(target_klass)
+      target_klass.class_eval do
+        has_many :notifications, :through => :events, :class_name => 'Eventifier::Notification', :dependent => :destroy
+      end
+    end
+  end
+end

data/lib/eventifier/active_record/ghost.rb

@@ -0,0 +1,9 @@
+require 'eventifier/ghost_mixin'
+
+module Eventifier
+  class Ghost < ActiveRecord::Base
+    include Eventifier::GhostMixin
+
+    serialize :data_hash
+  end
+end

data/lib/eventifier/active_record/notification.rb

@@ -0,0 +1,13 @@
+require 'eventifier/notification_mixin'
+
+module Eventifier
+  class Notification < ActiveRecord::Base
+    include Eventifier::NotificationMixin
+
+    default_scope order("created_at DESC")
+    scope :for_events,  -> ids { where(event_id: ids) }
+    scope :for_user,    -> user { where(user_id: user.id) }
+    scope :since,       -> date { where("created_at > ?", date) }
+    scope :latest,      order('notifications.created_at DESC').limit(5)
+  end
+end

data/lib/eventifier/active_record_support.rb

@@ -0,0 +1,5 @@
+require 'eventifier/active_record/event_tracking'
+require 'eventifier/active_record/event'
+require 'eventifier/active_record/notification'
+require 'eventifier/active_record/event_observer'
+require 'eventifier/active_record/ghost'

data/lib/eventifier/event_mixin.rb

@@ -0,0 +1,45 @@
+require 'active_support/concern'
+
+module Eventifier
+  module EventMixin
+
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :user
+      belongs_to :eventable, :polymorphic => true
+      has_many :notifications, :class_name => 'Eventifier::Notification'
+
+      validates :user, :presence => true
+      validates :eventable, :presence => true
+      validates :verb, :presence => true
+    end
+
+    module ClassMethods
+
+      def add_notification(*arg)
+        observer_instances.each { |observer| observer.add_notification(*arg) }
+      end
+
+      def add_url(*arg)
+        observer_instances.each { |observer| observer.add_url(*arg) }
+      end
+
+      def create_event(verb, object, options = { })
+        changed_data = object.changes.stringify_keys
+        changed_data = changed_data.reject { |attribute, value| options[:except].include?(attribute) } if options[:except]
+        changed_data = changed_data.select { |attribute, value| options[:only].include?(attribute) } if options[:only]
+        self.create(
+          :user => object.user,
+          :eventable => object,
+          :verb => verb,
+          :change_data => changed_data.symbolize_keys
+        )
+      end
+
+      def find_all_by_eventable object
+        where :eventable_id => object.id, :eventable_type => object.class.name
+      end
+    end
+  end
+end

data/lib/eventifier/event_observer_mixin.rb

@@ -0,0 +1,44 @@
+require 'active_support/concern'
+
+module Eventifier
+  module EventObserverMixin
+    extend ActiveSupport::Concern
+
+    include do
+      observe Eventifier::Event
+    end
+
+    module InstanceMethods
+      def add_notification klass_name, relation, method
+        observed_classes.each do |observed_class|
+          notification_mappings[klass_name.name]         ||= { }
+          notification_mappings[klass_name.name][method] = relation
+        end
+      end
+
+      def after_create event
+        Rails.logger.info "Firing #{event.eventable_type}##{event.verb} - #{notification_mappings[event.eventable_type][event.verb]}" if notification_mappings.has_key?(event.eventable_type) and notification_mappings[event.eventable_type].has_key?(event.verb) and defined?(Rails)
+
+        method_from_relation(event.eventable, notification_mappings[event.eventable_type][event.verb]).each do |user|
+          next if user == event.user
+          Eventifier::Notification.create event: event, user: user
+        end if notification_mappings.has_key?(event.eventable_type) and notification_mappings[event.eventable_type].has_key?(event.verb)
+      end
+
+      def method_from_relation object, relation
+        if relation.kind_of?(Hash)
+          method_from_relation(proc { |object, method| object.send(method) }.call(object, relation.keys.first), relation.values.first)
+        else
+          send_to = proc { |object, method| object.send(method) }.call(object, relation)
+          send_to = send_to.kind_of?(Array) ? send_to : [send_to]
+        end
+      end
+
+      private
+
+      def notification_mappings
+        @notification_mapppings ||= { }
+      end
+    end
+  end
+end

data/lib/eventifier/event_tracking.rb

@@ -1,20 +1,20 @@
 module Eventifier
   module EventTracking
     def events_for(klass, *args, &block)
-        @klasses = klass.kind_of?(Array) ? klass : [klass]
+      @klasses = klass.kind_of?(Array) ? klass : [klass]
 
-        options = args[0] || {}
+      options = args[0] || { }
 
-        methods     = options.delete(:track_on)
-        attributes  = options.delete(:attributes)
+      methods    = options.delete(:track_on)
+      attributes = options.delete(:attributes)
 
-        create_observers
+      create_observers
 
-        if block.nil?
-          track_on methods, :attributes => attributes
-        else
-          instance_eval(&block)
-        end
+      if block.nil?
+        track_on methods, :attributes => attributes
+      else
+        instance_eval(&block)
+      end
     end
 
     def create_observers
@@ -24,24 +24,24 @@ module Eventifier
         # If the observer doesn't exist, create the class
         unless self.class.const_defined?("#{target_klass}Observer")
           constant_name = "#{target_klass}Observer"
-          klass = Class.new(ActiveRecord::Observer)
+          klass         = Class.new(OBSERVER_CLASS)
           self.class.qualified_const_set(constant_name, klass)
         end
       end
     end
 
-    def track_on methods, options = {}
-      methods = methods.kind_of?(Array) ? methods : [methods]
+    def track_on methods, options = { }
+      methods    = methods.kind_of?(Array) ? methods : [methods]
       attributes = options.delete(:attributes)
       raise 'No events defined to track' if methods.compact.empty?
-      User.class_eval { has_many :notifications, :class_name => Eventifier::Notification } unless User.respond_to?(:notifications)
+      User.class_eval { has_many :notifications, :class_name => 'Eventifier::Notification' } unless User.respond_to?(:notifications)
       Eventifier::EventObserver.instance
 
       # set up each class with an observer and relationships
       @klasses.each do |target_klass|
         # Add relations to class
-        target_klass.class_eval { has_many :events, :as => :eventable, :class_name => Eventifier::Event, :dependent => :destroy }
-        target_klass.class_eval { has_many :notifications, :through => :events, :class_name => Eventifier::Notification, :dependent => :destroy }
+        target_klass.class_eval { has_many :events, :as => :eventable, :class_name => 'Eventifier::Event', :dependent => :destroy }
+        add_notification_association(target_klass)
 
         # create an observer and have it observe the class
         klass = self.class.const_get("#{target_klass}Observer")
@@ -67,8 +67,8 @@ module Eventifier
       relation = args.delete_at(0) if args.length == 2
       args = args.first
 
-      methods = args.delete(:on)
-      methods = methods.kind_of?(Array) ? methods : [methods]
+      methods  = args.delete(:on)
+      methods  = methods.kind_of?(Array) ? methods : [methods]
       relation ||= args
 
       @klasses.each do |target_klass|
@@ -77,5 +77,16 @@ module Eventifier
         end
       end
     end
+
+    def url url_proc
+      @klasses.each do |target_klass|
+        Eventifier::EventTracking.url_mappings[target_klass.name.underscore.to_sym] = url_proc
+      end
+    end
+
+    def self.url_mappings
+      @url_mapppings ||= {}
+    end
+
   end
 end

data/lib/eventifier/ghost_mixin.rb

@@ -0,0 +1,27 @@
+module Eventifier
+  module GhostMixin
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      validates :ghost_class, :presence => true
+      validates :ghost_id,    :presence => true
+      validates :data_hash,   :presence => true
+    end
+
+    module ClassMethods
+      def create_from_object object
+        create :ghost_class => object.class.name, :ghost_id => object.id, :data_hash => object.serializable_hash
+      end
+    end
+
+    def ghost
+      klass = Object.const_get(ghost_class)
+      ghost_object = klass.new data_hash
+      ghost_object.id = ghost_id
+
+      ghost_object
+    end
+  end
+end

data/lib/eventifier/helper_methods.rb

@@ -13,6 +13,8 @@ module Eventifier
             replace_text = "<strong class='target'>#{replace_text}</strong>"
           when "{{object.title}}"
             replace_text = "<strong class='target'>#{replace_text}</strong>"
+          when "{{user.name}}"
+            replace_text = "<strong class='user'>#{replace_text}</strong>"
           else
             replace_text = "<strong>#{replace_text}</strong>"
         end

data/lib/eventifier/mongoid/event.rb

@@ -0,0 +1,16 @@
+require 'eventifier/event_mixin'
+
+module Eventifier
+  class Event
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Eventifier::EventMixin
+
+    field :change_data, :type => Hash
+    field :eventable_type, :type => String
+    field :verb, :type => Symbol
+
+    index({ user_id: 1 })
+    index({ eventable_id: 1, eventable_type: 1 })
+  end
+end

data/lib/eventifier/mongoid/event_observer.rb

@@ -0,0 +1,7 @@
+require 'eventifier/event_observer_mixin'
+
+module Eventifier
+  class EventObserver < Mongoid::Observer
+    include Eventifier::EventObserverMixin
+  end
+end

data/lib/eventifier/mongoid/event_tracking.rb

@@ -0,0 +1,13 @@
+module Eventifier
+  module EventTracking
+    OBSERVER_CLASS = Mongoid::Observer
+
+    def add_notification_association target_klass
+      target_klass.class_eval do
+        define_method :notifications do
+          events.map(&:notifications).flatten.compact
+        end
+      end
+    end
+  end
+end

data/lib/eventifier/mongoid/ghost.rb

@@ -0,0 +1,15 @@
+require 'eventifier/ghost_mixin'
+
+module Eventifier
+  class Ghost
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Eventifier::GhostMixin
+
+    field :ghost_id, :type => BSON::ObjectId
+    field :ghost_class, :type => String
+    field :data_hash, :type => Hash
+
+    index({ ghost_class: 1, ghost_id: 1 })
+  end
+end

data/lib/eventifier/mongoid/notification.rb

@@ -0,0 +1,19 @@
+require 'eventifier/notification_mixin'
+
+module Eventifier
+  class Notification
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Eventifier::NotificationMixin
+
+    default_scope order_by([:created_at, :desc])
+    scope :for_events,  ->(ids) { where(event_id: ids) }
+    scope :for_user,    ->(user) { where(user_id: user.id) }
+    scope :since,       ->(date) { where(:created_at.gt => date) }
+    scope :latest,      order_by([:created_at, :desc]).limit(5)
+
+    index({ user_id: 1 })
+    index({ event_id: 1 })
+    #index({ parent_id: 1})
+  end
+end

data/lib/eventifier/mongoid/user_patch.rb

@@ -0,0 +1,3 @@
+class User
+  field :notifications_last_read_at, :type => DateTime
+end

data/lib/eventifier/mongoid_support.rb

@@ -0,0 +1,6 @@
+require 'eventifier/mongoid/event_tracking'
+require 'eventifier/mongoid/user_patch'
+require 'eventifier/mongoid/event'
+require 'eventifier/mongoid/notification'
+require 'eventifier/mongoid/event_observer'
+require 'eventifier/mongoid/ghost'

data/lib/eventifier/notification_helper.rb

@@ -13,31 +13,22 @@ module Eventifier
     #     %li= notification_message notification.event
 
     def notification_message event
+      default = "notifications.default.#{event.verb}".to_sym
       if event.verb.to_sym == :update
         if event.change_data.keys.count == 1
-          key = "notifications.#{event.eventable_type.downcase}.#{event.verb}.single"
+          key = "notifications.#{event.eventable_type.downcase}.#{event.verb}.attributes.#{event.change_data.keys.first}"
+          default = ["notifications.#{event.eventable_type.downcase}.#{event.verb}.single".to_sym, default]
         else
           key = "notifications.#{event.eventable_type.downcase}.#{event.verb}.multiple"
         end
       else
         key = "notifications.#{event.eventable_type.downcase}.#{event.verb}"
       end
-      message = I18n.translate key, :default => :"notifications.default.#{event.verb}", "user.name" => event.user.name, :"event.type" => event.eventable_type
+      message = I18n.translate key, :default => default, "user.name" => event.user.name, :"event.type" => event.eventable_type
 
       replace_vars(message, event).html_safe
     end
 
-    # Generating where the notification should lead when clicked
-
-    def notification_url eventable
-      case eventable.class.name.downcase.to_sym
-      when :activity
-        url_for([eventable.group, eventable])
-      when :announcement
-        url_for([eventable.group, eventable.activity])
-      end
-    end
-
     def self.included(base)
       base.helper_method :notification_message, :notification_url
     end

data/lib/eventifier/notification_mailer.rb

@@ -7,7 +7,11 @@ module Eventifier
 
     def notification_email(notification)
       @notification = notification
-      @notification_url = notification_url(notification.event.eventable)
+      @notification_url = if Eventifier::EventTracking.url_mappings[notification.event.eventable_type.underscore.to_sym]
+          main_app.url_for Eventifier::EventTracking.url_mappings[notification.event.eventable_type.underscore.to_sym].call(notification.event.eventable)
+        else
+          main_app.url_for notification.event.eventable
+        end
       @notification_message = notification_message(notification.event)
 
       mail :to => notification.user.email,

data/lib/eventifier/notification_mixin.rb

@@ -0,0 +1,42 @@
+require 'active_support/concern'
+
+module Eventifier
+
+  module NotificationMixin
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :event, :class_name => 'Eventifier::Event'
+      belongs_to :user
+
+      validates :event, :presence => true
+      validates :user, :presence => true
+      validates :event_id, :uniqueness => { :scope => :user_id }
+
+      after_create :send_email
+    end
+
+    module ClassMethods
+      def expire_for_past_events!(time_limit = 1.day.ago)
+        self.for_events(Event.expired_ids(time_limit)).each &:expire!
+      end
+
+      def unread_for(user)
+        if user.notifications_last_read_at
+          for_user(user).since(user.notifications_last_read_at)
+        else
+          for_user(user)
+        end
+      end
+    end
+
+    def unread_for?(user)
+      return true if user.notifications_last_read_at.nil?
+      created_at > user.notifications_last_read_at
+    end
+
+    def send_email
+      Eventifier::NotificationMailer.notification_email(self).deliver
+    end
+  end
+end

data/lib/eventifier/version.rb

@@ -1,3 +1,3 @@
 module Eventifier
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end