eventifier 0.0.14 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ddc5253dc949cf041ed9ff68c7225b234750fd4
-  data.tar.gz: 81a0e4e9121a62a2de35453c7a301450e28d1ce7
+  metadata.gz: 86d60265a4396c1ceb7dbf3a127244ccd8dd2544
+  data.tar.gz: 64b679101dc154bd27a9dae71e152c20ed469446
 SHA512:
-  metadata.gz: 6bf60d92b16aed0434bcfec3b9ab981eeec35b1b1c8c9d16595025f44124f41dc7c32ff061ac454fe768761fa5dfe27c31a5547199d80edcd3c017760c0a10e9
-  data.tar.gz: a025c89c3fb8f3f07a8d778de602d030bda0cb3d7f86f13261dbf06bc281418528bea49d4f6d7c4ecd1538bdbf6afd6e34c2275c9d9a395b3572dd216a78c5dd
+  metadata.gz: 8e90e8779758969401a869fdd588de7647c9be752534e3ffcbe028c7d36401f7db1816dd8742392440e6ad291192ca1260d16b5b2f10fafeb632c68270382eb4
+  data.tar.gz: b2c9601e599c49d40808265111d2226b13379f5ebd3d465f40aed21235d041614471cc049fb3563f176745c19c439624661a15b252dfa3c430021946f9fd3d38

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in eventifier.gemspec
-gemspec
+gemspec

data/README.textile

@@ -17,13 +17,14 @@ class EventTracking
 
   def initialize
     events_for Post do
-      track_on [:create, :update, :destroy], :attributes => { :except => %w(updated_at) }
-      notify :group => :members, :on => [:create, :update]
+      track_on [:create, :update, :destroy], attributes: { except: %w(updated_at) }
+      notify group: :members, on: :create
+      notify group: :commenters, on: :update, unless: ->post,author { post.age > 1.week }
     end
 
     events_for Announcement do
-      track_on :create, :attributes => { :except => %w(updated_at) }
-      notify :group => :members, :on => :create
+      track_on :create
+      notify group: :members, on: :create, if: ->announcement,admin { announcement.is_important? }
     end
   end
 end
@@ -90,6 +91,21 @@ h4. Customise views
     #{object.user.username} commented on your post
 </code></pre>
 
+You can create a custom view for each context
+
+Dropdown notification:  app/views/eventifier/dropdown/_comment.haml
+Email notification:  app/views/eventifier/email/_comment.haml
+
+Helpers made available to these views are:
+
+*notification*: The notification object
+Eventifier::Notification(event: event, user: user_being_notified, parent: parent_notification, sent: email_sent_flag)
+
+*event*: The event object
+Eventifier::Event(user: event_owner, eventable: object_for_event, verb: [:create, :update, :destroy], change_data: {"name" => ["Bill", "Bob"]}, groupable: grouped_object)
+
+*object*: The object the event was created for
+
 h2. Sending of emails
 
 Firstly, you'll need to set the FROM address for the Eventifier mailer
@@ -106,6 +122,18 @@ You want to add a scheduled task to run the following task every x minutes
   rake eventifier:email:deliver
 </code></pre>
 
+h4. Customise email settings descriptions
+
+<pre><code>
+  # config/locales/events.en.yml
+  en:
+    events:
+      labels:
+        preferences:
+          default: "All notifications"
+          create_relationships_notify_followed: "When you get a new follower"
+</code></pre>
+
 h2. Requirements
 
 * ActiveRecord

data/app/assets/javascripts/eventifier/notifications.coffee

@@ -9,9 +9,10 @@ class window.NotificationDropdown
   settingsTemplate: JST['eventifier/templates/settings']
 
   constructor: (options) ->
-    {@el, @limit, @pollTime} = options
+    {@el, @limit, @pollTime, @push} = options
     @limit =    @limit || 5
     @pollTime = @pollTime || 15
+    @push = @push || false
 
 
     [@notifications, @renderedNotifications, @unreadCount, @lastReadAt] = [[], [], 0, new Date()]
@@ -23,6 +24,7 @@ class window.NotificationDropdown
     @el.html(@template(@)).attr('tabindex', 0)
 
     # @checkVisibility()
+
     @setEvents()
     @poll()
 
@@ -48,11 +50,22 @@ class window.NotificationDropdown
     @el.on 'addNotifications', @renderNotifications
     @el.on 'addNotifications', @setUnreadCount
     @el.on 'poll', @poll
-    @el.on 'scroll', 'ol', @scrolling
+    @el.find('ol.notifications_dropdown_list').on 'scroll', @scrolling
     $(window).on 'click', @blurNotifications
+    if @push
+      @el.on 'click', '#notification_dropdown ol a', @pushUrl
 
     @
 
+  pushUrl: (e)=>
+    location = $(e.currentTarget).attr('href')
+    location = $('<a />').attr(href: location).get(0).pathname if location.match /^https?\:\/\//
+
+    Backbone?.history.navigate(location, true) || history.pushState({trigger: true}, '', location)
+    @hide()
+
+    false
+
   renderNotifications: =>
     @el.find(".none").remove() if @notifications.length > 0
     $.each @notifications, (index, notification)=>
@@ -150,6 +163,17 @@ class window.NotificationDropdown
       @el.addClass('alerting')
 
     @el.find(".notification_alert").html(displayCount)
+    $('title').html (index, old_html) ->
+      if old_html.match /^\(\d+\).*/
+        if displayCount > 0
+          old_html.replace(/^\(\d+\)/, "(#{displayCount})");
+        else
+          old_html.replace(/^(\(\d+\))\s/, "");
+      else
+        if displayCount > 0
+          "(#{displayCount}) #{old_html}"
+        else
+          old_html
 
   setUnreadCount: =>
     @unreadCount = $.grep(@notifications, (notification)=>
@@ -187,13 +211,13 @@ class window.NotificationDropdown
       0
 
   lastLookTime: =>
-    Math.max(@lastReadAt.getTime()/1000, @newestNotificationTime())
+    Math.max(@lastReadAt.getTime()/1000, @newestNotificationTime()/1000)
 
   scrolling: =>
-    scrollWindow = @$el.find('ol')
+    scrollWindow = @el.find('ol')
 
     if (scrollWindow.scrollTop() + scrollWindow.innerHeight() >= scrollWindow[0].scrollHeight - 50)
-      @loadMore(after: @oldestNotificationTime())
+      @loadMore(after: @oldestNotificationTime()/1000)
 
   arrayFromObject: (collection)->
     serializedObject = {}

data/app/assets/javascripts/eventifier/templates/dropdown.hamlc

@@ -5,6 +5,6 @@
   %header
     %a.toggle_settings{ href: '#' } Settings
     %h4 Notifications
-  %ol
+  %ol.notifications_dropdown_list
     %li.none You have no notifications
   #settings_pane

data/app/assets/stylesheets/eventifier/notifications.scss

@@ -149,7 +149,7 @@
         &.unread { background-color: #d3d3d3; }
         a {
           display: block;
-          overflow: auto;
+          overflow: visible;
           padding-left: 38px;
         }
         img.avatar {

data/app/controllers/eventifier/preferences_controller.rb

@@ -1,19 +1,17 @@
 class Eventifier::PreferencesController < Eventifier::ApplicationController
   def show
-    render :json => Eventifier::Preferences.new(current_user).to_hashes
+    render :json => preferences.to_hashes
   end
 
   def update
-    settings = Eventifier::NotificationSetting.for_user current_user
-    settings.preferences['email'] ||= {}
-    params[:preferences]          ||= {}
+    preferences.update params[:preferences] || {}
 
-    Eventifier::Preferences.new(current_user).to_hashes.each do |hash|
-      settings.preferences['email'][hash[:key]] = !params[:preferences][hash[:key]].nil?
-    end
+    render :json => {'status' => 'OK'}
+  end
 
-    settings.save
+  private
 
-    render :json => {'status' => 'OK'}
+  def preferences
+    Eventifier::Preferences.new(current_user)
   end
 end

data/app/helpers/eventifier/notification_helper.rb

@@ -37,7 +37,7 @@ module Eventifier
       else
         key = "events.#{event.eventable_type.downcase}.#{event.verb}"
       end
-      message = I18n.translate key, :default => :"events.default.#{event.verb}", "user.name" => event.user.name, :"event.type" => event.eventable_type
+      message = I18n.translate key, :default => :"events.default.#{event.verb}", "user.name" => event.user.try(:name), :"event.type" => event.eventable_type
 
       replace_vars(message, event).html_safe
     end

data/app/helpers/eventifier/path_helper.rb

@@ -5,11 +5,11 @@ module Eventifier
     end
 
     def partial_path notification, context = nil
-      if lookup_context.exists?(notification.event.eventable_type.underscore, [:eventifier, context].compact.join("/"), true)
+      if lookup_context.exists?(notification.event.eventable_type.underscore, [[:eventifier, context].compact.join("/")], true)
         [:eventifier, context, notification.event.eventable_type.underscore].compact.join("/")
       else
         [:eventifier, context, 'notification'].compact.join("/")
       end
     end
   end
-end
+end

data/app/models/eventifier/event.rb

@@ -2,15 +2,13 @@ module Eventifier
   class Event < ActiveRecord::Base
     self.table_name = 'eventifier_events'
 
-    attr_accessible :user, :eventable, :verb, :change_data, :groupable
-
     belongs_to  :user,          class_name: Eventifier.user_model_name
     belongs_to  :eventable,     polymorphic: true
     belongs_to  :groupable,     polymorphic: true
     has_many    :notifications, class_name: 'Eventifier::Notification',
       dependent: :destroy
 
-    validates :user,      presence: true
+    validates :user,      presence: true, unless: :system?
     validates :eventable, presence: true
     validates :verb,      presence: true
     validates :groupable, presence: true

data/app/models/eventifier/notification.rb

@@ -2,8 +2,6 @@ module Eventifier
   class Notification < ActiveRecord::Base
     self.table_name = 'eventifier_notifications'
 
-    attr_accessible :event, :user, :relations, :event_id, :user_id
-
     belongs_to :event, :class_name => 'Eventifier::Event'
     belongs_to :user
 

data/app/models/eventifier/notification_setting.rb

@@ -5,8 +5,6 @@ class Eventifier::NotificationSetting < ActiveRecord::Base
 
   serialize :preferences, MultiJson
 
-  attr_accessible :user
-
   validates :user,    :presence   => true
   validates :user_id, :uniqueness => true
 

data/app/views/eventifier/notifications/index.jbuilder

@@ -1,6 +1,6 @@
-json.last_read_at current_user.notifications_last_read_at.to_i
+json.last_read_at current_user.notifications_last_read_at.to_i*1000
 json.notifications @notifications do |notification|
   json.(notification, :id)
-  json.created_at notification.created_at.to_i
+  json.created_at notification.created_at.to_i*1000
   json.html render_partial_view(notification, :dropdown)
 end

data/db/migrate/5_system_events.rb

@@ -0,0 +1,9 @@
+class SystemEvents < ActiveRecord::Migration
+  def up
+    add_column :eventifier_events, :system, :boolean
+  end
+
+  def down
+    remove_column :eventifier_events, :system
+  end
+end

data/eventifier.gemspec

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "eventifier"
-  s.version     = '0.0.14'
+  s.version     = '0.1.0'
   s.authors     = ["Nathan Sampimon", "Peter Murray", "Pat Allan"]
   s.email       = ["nathan@inspire9.com"]
   s.homepage    = "http://github.com/inspire9/eventifier"
   s.summary     = "Event tracking and notifying for active record models"
   s.description = "Tracks and logs events and sends notifications of events on Active Record models."
+  s.license     = 'MIT'
 
   s.rubyforge_project = "eventifier"
 
@@ -15,17 +16,18 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'rails',           '~> 3.2.0'
+  s.add_runtime_dependency 'rails',           '~> 4.0.3'
   s.add_runtime_dependency "bson_ext"
   s.add_runtime_dependency 'haml-rails',      '~> 0.4'
   s.add_runtime_dependency 'haml_coffee_assets'
-  s.add_runtime_dependency 'coffee-rails',    '~> 3.2.1'
+  s.add_runtime_dependency 'coffee-rails',    '~> 4.0.0'
   s.add_runtime_dependency 'compass-rails'
   s.add_runtime_dependency 'multi_json',      '~> 1.7.4'
   s.add_runtime_dependency 'jbuilder',        '~> 1.4.2'
+  s.add_runtime_dependency 'rails-observers', '~> 0.1.2'
 
   s.add_development_dependency 'combustion',  '~> 0.5.0'
-  s.add_development_dependency 'fabrication', '~> 2.7.1'
+  s.add_development_dependency 'fabrication', '~> 2.11.0'
   s.add_development_dependency "pg"
-  s.add_development_dependency 'rspec-rails', '~> 2.13.2'
+  s.add_development_dependency 'rspec-rails', '~> 3.0.0.beta2'
 end

data/lib/eventifier.rb

@@ -9,6 +9,8 @@
 #
 # end
 
+require "rails/observers/activerecord/active_record"
+
 require 'multi_json'
 require 'action_mailer'
 

data/lib/eventifier/event_builder.rb

@@ -10,7 +10,8 @@ class Eventifier::EventBuilder
 
   def store
     Eventifier::Event.create user: user, eventable: object,
-      groupable: groupable, verb: verb, change_data: change_data
+      groupable: groupable, verb: verb, change_data: change_data,
+      system: options[:system]
   end
 
   private
@@ -18,6 +19,8 @@ class Eventifier::EventBuilder
   attr_reader :object, :user, :verb, :groupable, :options
 
   def change_data
+    return options[:change_data] unless options[:change_data].nil?
+
     changes = object.changes.stringify_keys
 
     changes.reject! { |attribute, value|

data/lib/eventifier/notification_translator.rb

@@ -1,23 +1,45 @@
 class Eventifier::NotificationTranslator
-  def initialize(prefix, delivery, *args)
-    @prefix, @delivery = prefix, delivery
+  def initialize(prefix, options, *args)
+    @prefix, @options = prefix, options
     @event  = ActiveSupport::Notifications::Event.new(*args).payload[:event]
   end
 
   def translate
+    return if skip?
     users_and_relations do |user, relations|
-      next if user == event.user
+      next if user == event.user && !options[:notify_self]
+      next if skip?(user)
 
       Eventifier::Notification.create event: event, user: user,
         relations: relations
 
-      Eventifier::Delivery.deliver_for user if delivery == :immediate
+      Eventifier::Delivery.deliver_for user if options[:email] == :immediate
     end
   end
 
   private
 
-  attr_reader :event, :prefix, :delivery
+  attr_reader :event, :prefix, :options
+
+  def skip?(user = nil)
+    if conditional
+      !conditional_call *[event.eventable, user][0..conditional.arity-1]
+    else
+      false
+    end
+  end
+
+  def conditional
+    options[:if] || options[:unless]
+  end
+
+  def conditional_call(*args)
+    if options[:if]
+      conditional.call(*args)
+    else
+      !conditional.call(*args)
+    end
+  end
 
   def users_and_relations(&block)
     Eventifier::NotificationMapping.users_and_relations event, prefix, &block

data/lib/eventifier/notifier/notification_subscriber.rb

@@ -1,23 +1,23 @@
 class Eventifier::NotificationSubscriber
-  def self.subscribe_to_method(klass, method_name, delivery)
-    new(klass, method_name, delivery).subscribe_to_method
+  def self.subscribe_to_method(klass, method_name, options)
+    new(klass, method_name, options).subscribe_to_method
   end
 
-  def initialize(klass, method_name, delivery)
-    @klass, @method_name, @delivery = klass, method_name, delivery
+  def initialize(klass, method_name, options)
+    @klass, @method_name, @options = klass, method_name, options
   end
 
   def subscribe_to_method
     return if notifications.notifier.listening?(name)
 
     notifications.subscribe(name) do |*args|
-      Eventifier::NotificationTranslator.new(prefix, delivery, *args).translate
+      Eventifier::NotificationTranslator.new(prefix, options, *args).translate
     end
   end
 
   private
 
-  attr_reader :klass, :method_name, :delivery
+  attr_reader :klass, :method_name, :options
 
   def name
     "#{prefix}.notification.eventifier"

data/lib/eventifier/notifier/notifier.rb

@@ -1,21 +1,21 @@
 class Eventifier::Notifier
+  OPTION_KEYS = [:email, :if, :unless, :notify_self]
   # arguments will either be [:relation, {:on => :create}] or
   # [{:relation => :second_relation, :on => :create}]
   # If it's the first one, relation is the first in the array, otherwise treat
   # the whole thing like a hash
   def initialize(klasses, *arguments)
-    relation   = arguments.shift if arguments.length == 2
+    relation   = arguments.shift if arguments.length >= 2
     arguments  = arguments.first || {}
 
     methods    = Array arguments.delete(:on)
-    delivery   = arguments.delete(:email) || :delayed
-
-    relation ||= arguments
+    options    = arguments.slice *OPTION_KEYS
+    relation ||= arguments.except *OPTION_KEYS
 
     klasses.each do |target_klass|
       methods.each do |method_name|
         Eventifier::NotificationMapping.add "#{method_name}.#{target_klass.name.tableize}", relation
-        Eventifier::NotificationSubscriber.subscribe_to_method target_klass, method_name, delivery
+        Eventifier::NotificationSubscriber.subscribe_to_method target_klass, method_name, options
       end
     end
   end