eventifier 0.0.1

data/spec/helper_methods_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Eventifier::EventHelper do
+
+  class TestClass
+    def self.helper_method(*args); end
+    include Eventifier::HelperMethods
+  end
+
+  let!(:helper) { TestClass.new }
+
+  describe ".replace_vars" do
+    let(:event) { Eventifier::Event.make }
+
+    it "should replace {{stuff}} with awesome" do
+      message = "I'm really loving {{eventable.title}}"
+      helper.replace_vars(message, event).should == "I'm really loving <strong>#{event.eventable.title}</strong>"
+    end
+
+    it "should replace multiple {{stuff}} with multiple awesome" do
+      message = "I'm really loving {{eventable.title}} and all {{eventable.class.name}}s"
+      helper.replace_vars(message, event).should == "I'm really loving <strong>#{event.eventable.title}</strong> and all <strong>Post</strong>s"
+    end
+  end
+
+  describe ".load_event_for_template" do
+
+    it "should add some handy methods to an event instance" do
+      event = Eventifier::Event.make!
+      event = helper.load_event_for_template event
+      event.object.should == event.eventable
+      event.object_type.should == event.eventable_type
+    end
+
+  end
+end

data/spec/integration/eventifier_spec.rb

@@ -0,0 +1,67 @@
+
+describe Eventifier do
+  let(:post) { mock_model('Post', :group => group) }
+  let(:group)    { double('group', :user => owner,
+    :members => [owner, member]) }
+  let(:owner)    { User.make! }
+  let(:member)   { double('member') }
+
+  before :each do
+    Eventifier::Notification.stub :create => true
+  end
+
+  context 'a new post' do
+    let(:event) { Eventifier::Event.new :eventable => post, :verb => :create,
+      :user => owner }
+
+    it "notifies the members of the group" do
+      Eventifier::Notification.should_receive(:create).
+        with(:user => member, :event => event)
+      ActiveRecord::Observer.with_observers(Eventifier::EventObserver) do
+        event.save
+      end
+    end
+
+    it "does not notify the person initiating the event" do
+      Eventifier::Notification.should_not_receive(:create).
+        with(:user => owner, :event => event)
+
+      event.save
+    end
+  end
+
+  context 'an existing post' do
+    let(:event) { Eventifier::Event.new :eventable => post, :verb => :update,
+      :user => owner }
+    let(:guest) { double('guest') }
+
+    before :each do
+      post.group.stub :members => [owner, guest]
+    end
+
+    it "notifies the members of the post" do
+      Eventifier::Notification.should_receive(:create).
+        with(:user => guest, :event => event)
+      ActiveRecord::Observer.with_observers(Eventifier::EventObserver) do
+        event.save
+      end
+    end
+
+    it "does not notify the person initiating the event" do
+      Eventifier::Notification.should_not_receive(:create).
+        with(:user => owner, :event => event)
+
+      ActiveRecord::Observer.with_observers(Eventifier::EventObserver) do
+        event.save
+      end
+    end
+  end
+  
+  it "should create a notification for users of a post when it's changed" do
+    post = event.eventable
+    user = User.make!
+
+    lambda { post.update_attribute :date, 5.days.from_now }.should change(user.notifications, :count).by(1)
+  end
+
+end

data/spec/notification_helper_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Eventifier::NotificationHelper do
+
+  class TestClass
+    def self.helper_method(*args); end
+    include Eventifier::NotificationHelper
+  end
+
+  let!(:helper) {TestClass.new}
+
+  before do
+    @notification_strings = {
+      :post => {
+        :create => "{{user.name}} just created an Post - you should check it out",
+        :destroy => "{{user.name}} just deleted an Post",
+        :update => {
+          :single => "{{user.name}} made a change to their Post",
+          :multiple => "{{user.name}} made some changes to their Post"
+        }
+      }
+    }
+    I18n.backend.store_translations :en, :notifications => @notification_strings
+  end
+
+  describe ".notification_message" do
+    it "should return the I18n message for that event" do
+
+      event = Eventifier::Event.make! :eventable => Post.make!, :verb => :create
+      helper.notification_message(event).should == "<strong>#{event.user.name}</strong> just created an Post - you should check it out"
+    end
+
+    it "should return a message specific to a single change if only 1 change has been made" do
+      event = Eventifier::Event.make! :eventable => Post.make!, :verb => :update, :change_data => { :name => ["Fred", "Mike"] }
+      helper.notification_message(event).should == "<strong>#{event.user.name}</strong> made a change to their Post"
+    end
+
+    it "should return a message specific to multiple changes if more than 1 change has been made" do
+      event = Eventifier::Event.make! :eventable => Post.make!, :verb => :update, :change_data => { :name => ["Fred", "Mike"], :age => [55, 65] }
+      helper.notification_message(event).should == "<strong>#{event.user.name}</strong> made some changes to their Post"
+    end
+
+    it "should return the default I18n message if one doesn't exist" do
+      I18n.backend.reload!
+      @notification_strings = {
+        :default => {
+          :create => "{{user.name}} created a {{eventable_type}}",
+          :update => "{{user.name}} updated a {{eventable_type}}"
+        }
+      }
+      I18n.backend.store_translations :test, :notifications => @notification_strings
+      I18n.with_locale("test") do
+        event = Eventifier::Event.make! :eventable => Post.make!, :verb => :create
+        helper.notification_message(event).should == "<strong>#{event.user.name}</strong> created a <strong>Post</strong>"
+      end
+    end
+  end
+end

data/spec/notification_mailer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Eventifier::NotificationMailer do
+  describe "#notification_email" do
+    it "should response to notification emails" do
+      Eventifier::NotificationMailer.should respond_to(:notification_email)
+    end
+    it "should be able to send a 'notification' email" do
+      proc { Eventifier::NotificationMailer.notification_email(Eventifier::Notification.make!).deliver }.should change(ActionMailer::Base.deliveries, :count)
+    end
+  end
+end

data/spec/notification_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Eventifier::Notification do
+  let(:notification) { Eventifier::Notification.make! }
+
+  describe '.expire_for_past_events!' do
+    let(:notification) { double('notification', :expire! => true) }
+    let(:expired_event_ids) { [1, 3, 5, 7] }
+
+    before :each do
+      Eventifier::Event.stub :expired_ids => expired_event_ids
+      Eventifier::Notification.stub :for_events => [notification]
+    end
+
+    it "finds all notifications belonging to past activities" do
+      Eventifier::Notification.should_receive(:for_events).with(expired_event_ids).
+        and_return([notification])
+
+      Eventifier::Notification.expire_for_past_events!
+    end
+
+    it "expires each notification" do
+      notification.should_receive(:expire!)
+
+      Eventifier::Notification.expire_for_past_events!
+    end
+  end
+
+  describe ".unread_for" do
+    it "should return unread notifications for a user" do
+      user = notification.user
+
+      Eventifier::Notification.unread_for(user).should include notification
+    end
+
+    it "should return unread notifications for a user" do
+      user = notification.user
+
+      user.notifications_last_read_at = Time.now
+      second_notification = Eventifier::Notification.make!
+
+      Eventifier::Notification.unread_for(user).should_not include notification
+      Eventifier::Notification.unread_for(user).should_not include second_notification
+    end
+  end
+
+  describe "#create" do
+    it "sends an email to the user" do
+      ActionMailer::Base.deliveries.clear
+      notification = Eventifier::Notification.make!
+      ActionMailer::Base.deliveries.count.should > 0
+    end
+  end
+
+  # describe "#valid?" do
+  #   it_requires_a :user
+  #   it_requires_an :event
+  # end
+
+  describe "#unread_for?" do
+    let(:user)  { double(User, :notifications_last_read_at => last_read) }
+    subject     { Eventifier::Notification.make(:created_at => Time.now).unread_for?(user) }
+    context 'when the user has never read notifications' do
+      let(:last_read) { nil }
+      it 'should return true' do
+        subject.should be_true
+      end
+    end
+    context 'when the user has read notifications before' do
+
+      describe 'notificication newer than that time' do
+        let(:last_read) { Time.now - 1.day }
+
+        it { should be_true }
+      end
+      describe 'notificication older than that time' do
+        let(:last_read) { Time.now + 1.day }
+
+        it { should be_false }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+require 'rubygems'
+require 'rspec'
+require 'eventifier'

data/spec/support/action_mailer.rb

@@ -0,0 +1,3 @@
+require 'action_mailer'
+
+ActionMailer::Base.delivery_method = :test

data/spec/support/active_record_support.rb

@@ -0,0 +1,63 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "postgresql",
+  :database => "eventifier"
+)
+
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table :events, :force => true do |t|
+    t.integer :user_id
+    t.string :eventable_type
+    t.integer :eventable_id
+    t.string :verb
+    t.text :change_data
+
+    t.timestamps
+  end
+
+  create_table :notifications, :force => true do |t|
+    t.integer :event_id
+    t.integer :user_id
+    t.integer :parent_id
+
+    t.timestamps
+  end
+
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+    t.column :email, :string
+    t.column :notifications_last_read_at, :datetime
+  end
+
+  create_table :posts, :force => true do |t|
+    t.column :title, :string
+    t.column :author_id, :integer
+    t.column :body, :text
+  end
+
+  create_table :subscriptions, :force => true do |t|
+    t.column :user_id, :integer
+    t.column :post_id, :integer
+  end
+
+end
+
+class User < ActiveRecord::Base
+  has_many :subscriptions
+  validates :name, :presence => true, :uniqueness => true
+end
+
+class Subscription < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :post
+end
+
+class Post < ActiveRecord::Base
+  belongs_to :author, :class_name => "User"
+  has_many :subscriptions
+  has_many :readers, :through => :subscriptions, :source => :user
+  
+  alias_method :user, :author
+end

data/spec/support/blueprints.rb

@@ -0,0 +1,24 @@
+require 'machinist/active_record'
+require 'eventifier'
+
+Eventifier::Event.blueprint do
+  user        { object.user || User.make! }
+  eventable   { object.eventable || Post.make! }
+  verb        { :update }
+  change_data { { :date => [ 5.days.ago, 3.days.ago ] } }
+end
+
+Eventifier::Notification.blueprint do
+  event { object.event || Eventifier::Event.make! }
+  user  { object.user || User.make! }
+end
+
+Post.blueprint do
+  title { "My amazing blog post" }
+  body  { "A deep and profound analysis of life" }
+end
+
+User.blueprint do
+  name  { "Billy #{sn}" }
+  email { "billy#{sn}@email.com" }
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: eventifier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Sampimon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70095162476700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095162476700
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70095162475660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70095162475660
+- !ruby/object:Gem::Dependency
+  name: machinist
+  requirement: &70095162474080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095162474080
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: &70095162472540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095162472540
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70095162470940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70095162470940
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70095162470020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70095162470020
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: &70095162469140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70095162469140
+description: Tracks and logs events and sends notifications of events on Active Record
+  models.
+email:
+- nathan@inspire9.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.textile
+- Rakefile
+- eventifier.gemspec
+- lib/eventifier.rb
+- lib/eventifier/event.rb
+- lib/eventifier/event_helper.rb
+- lib/eventifier/event_observer.rb
+- lib/eventifier/event_tracking.rb
+- lib/eventifier/helper_methods.rb
+- lib/eventifier/matchers.rb
+- lib/eventifier/notification.rb
+- lib/eventifier/notification_helper.rb
+- lib/eventifier/notification_mailer.rb
+- lib/eventifier/version.rb
+- lib/generators/active_record/eventifier_generator.rb
+- lib/generators/eventifier/install/install_generator.rb
+- lib/generators/eventifier/install/templates/event_tracking.rb
+- lib/generators/eventifier/install/templates/events.en.yaml
+- lib/generators/eventifier/install/templates/migration.rb
+- spec/event_helper_spec.rb
+- spec/event_observer_spec.rb
+- spec/event_spec.rb
+- spec/eventifier_spec.rb
+- spec/helper_methods_spec.rb
+- spec/integration/eventifier_spec.rb
+- spec/notification_helper_spec.rb
+- spec/notification_mailer_spec.rb
+- spec/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/action_mailer.rb
+- spec/support/active_record_support.rb
+- spec/support/blueprints.rb
+homepage: http://github.com/inspire9/eventifier
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: eventifier
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Event tracking and notifying for active record models
+test_files:
+- spec/event_helper_spec.rb
+- spec/event_observer_spec.rb
+- spec/event_spec.rb
+- spec/eventifier_spec.rb
+- spec/helper_methods_spec.rb
+- spec/integration/eventifier_spec.rb
+- spec/notification_helper_spec.rb
+- spec/notification_mailer_spec.rb
+- spec/notification_spec.rb
+- spec/spec_helper.rb
+- spec/support/action_mailer.rb
+- spec/support/active_record_support.rb
+- spec/support/blueprints.rb