social_feed 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+*.sqlite3

data/INSTALL

@@ -0,0 +1,22 @@
+Plugin setup
+
+* to create the necessary migration run:
+
+script/generate social_feed_migration
+rake db:migrate
+
+* add the following line to the top of your config/routes.rb:
+
+map.from_plugin 'social_feed' 
+
+* add the following line to the Rails::Initializer block in your environment.rb
+
+config.load_paths << RAILS_ROOT + '/app/models/events'
+
+* add the following line to your User class
+
+include SocialFeed::UserExtension
+
+* make sure you have the prototype javascript library loaded in your views, e.g. with the following line in your views/layouts/application.html.erb
+
+<%= javascript_include_tag :defaults %>

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,96 @@
+SocialFeed
+==========
+
+This plugin adds a social feed to your rails application. Users can decide what kinds of events they want to see on their social feed and also wether they want to be sent an email when an event occurs. They can also decide wether others will receive a notification on their social feed concerning their own actions.
+
+How it works
+============
+
+The plugins adds the following things to your application
+* a FeedEvent model - this represents an event on the social feed - you will subclass the SocialFeed to create your own custom events
+* a SocialFeedsController - this controller has actions for:
+  * displaying the social feed for a user (index)
+  * destroying a SocialFeed
+  * displaying a settings page where users can 
+    * subscribe to and unsubscribe from events
+    * subscirbe to and unsubscribe from receiving emails for events
+    * enable/disable the creation of events concerning their own actions in the application
+* a migration that adds 3 fields to your users table to store the event subscriptions
+
+
+Installation
+============
+
+If you are on rails >= 2.1 (which supports git) you can simply do a 
+script/plugin install git://github.com/langalex/social_feed.git
+
+If not you need to do this from your rails root:
+
+cd vendor/plugins
+git clone git://github.com/langalex/social_feed.git --depth 1
+cd social_feed
+ruby install.rb
+cd ../../..
+
+for the rest see the INSTALL file
+
+Assumptions
+===========
+
+the socialfeed plugin assumes that:
+
+* your users are represented via the User model
+* your users have an email attribute (used by the feed event mailer)
+* the controllers in your application have access to the currently logged in user via the current_user method
+
+Basic User Experience
+=====================
+
+After the plugin is installed you can direct your users to the /feed_events url which will show them their personal social feed. To customize their events the users should go to /feed_events/settings
+
+How to create custom events types
+=================================
+
+To create a custom event you should use the built-in feed_event generator:
+
+e.g.: script/generate feed_event new_friend
+
+This creates a new class NewFriendEvent in the app/models/events directory (the class representing the event) as well as a new_friend_hint.html.erb file in the app/views/feed_events directory (this gets rendered on people's social feed page). First thing you probably want to do is to customize the hint file.
+
+Secondly you should also customize the two description lines in the model, which will be used on the setting page. By commenting out either line, you can remove the corresponding line from the setings page.
+
+If you want your users to be able to receive emails for your new event, add a method deliver_new_friend(event) to the FeedEventMailer found in app/models/feed_events. You can call the convenience method create_event_message(subject, event) to send your mails. After adding the method a checkbox for this event will automatically appear on the settings page.
+
+Creating actual events
+======================
+
+In order for the social feeds of your users to get filled with events you have to create instances of your custom event classes. You have a number of choices here. I would recommend to use the rails observers, so for a NewFriendEvent you would probably create a FriendShipObserver with an after_create hook that creates the event after a new friendship has been created. As soon as you start creating lots of events for a single action (e.g. tell every user that user X and user Y are now friends) I would highly recommend using something asynchronous like the workling plugin and starling.
+
+An event requires two attributes, a user and a source. The user is the user who sees the event on her social feed, the source is the object that sort of caused the event, which in this example would be the friendship, e.g.
+
+NewFriendEvent.create :user => some_user_interested_in_the_event, :source => new_friendship
+
+If you want the enable/disable event feature to work (a.k.a. privacy settings), the source must implement a user method which returns the user who caused the event. That user's privacy settings are then check before creating the actual FeedEvent instance.
+
+Warning: Do not create events using create! but use the create method (without the bang) - when a user has not subscribed to an event, a validation in the FeedEvent class will fail so that the event won't be created. If you use the create! method you will get an exception instead.
+
+Configuration
+=============
+
+You can setup the from address used by the FeedEventMailers create_event_message method in the social_feed.yml in your config folder.
+
+Gotchas
+=======
+
+For all models of you application you use as a source for a FeedEvent, add a
+:has_many :feed_events, :dependent => :destroy
+so that the feed events are destroyed when objects are destroyed. Otherwise the social feeds of you users will get into trouble with sources of events missing.
+
+
+
+Contact
+=======
+
+Copyright (c) 2008 Alexander Lang, released under the MIT license
+
+Contact: email: alex[at]upstream-berlin.com, twitter: langalex, blog: http://upstream-berlin.com/blog, skype: langalex

data/Rakefile

@@ -0,0 +1,24 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "social_feed"
+    gemspec.summary = "a ruby on rails plugin to create and display a social feed"
+    gemspec.email = "alex@upstream-berlin.com"
+    gemspec.homepage = "http://github.com/langalex/social_feed"
+    gemspec.description = ""
+    gemspec.authors = ["Alexander Lang", "Thilo Utke"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/generators/feed_event/feed_event_generator.rb

@@ -0,0 +1,19 @@
+class FeedEventGenerator < Rails::Generator::Base 
+  
+  attr_accessor :event_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    self.event_name = runtime_args[0]
+    raise "Usage: script/generate feed_event <event_name>\ne.g. script/generate feed_event user_signed_up\n" unless event_name
+  end
+  
+  def manifest
+    record do |r|
+      r.template 'event_model.rb.erb', "app/models/events/#{event_name.underscore}_event.rb"
+      r.template 'event_hint.html.erb', "app/views/feed_events/_#{event_name.underscore}_hint.html.erb"
+      # email template and mailer method
+    end
+  end
+  
+end

data/generators/feed_event/templates/event_hint.html.erb

@@ -0,0 +1,4 @@
+<div id="<%%= dom_id(event) %>" class="feed_event">
+	A <%= event_name.humanize %> event occured.
+	<%%= link_to_remote 'Destroy', :url => feed_event_path(event), :method => :delete %>
+</div>

data/generators/feed_event/templates/event_model.rb.erb

@@ -0,0 +1,5 @@
+class <%= event_name.camelize %>Event < FeedEvent
+  subscribe_description 'A <%= event_name.humanize %> event occurs'
+  privacy_description 'I cause a <%= event_name.humanize %> event'
+
+end

data/generators/social_feed_migration/social_feed_migration_generator.rb

@@ -0,0 +1,13 @@
+class SocialFeedMigrationGenerator < Rails::Generator::Base 
+  
+  def manifest
+    record do |r|
+      r.migration_template 'migration.rb', "db/migrate"
+    end
+  end
+  
+  def file_name
+    "add_social_feed" 
+  end
+  
+end

data/generators/social_feed_migration/templates/migration.rb

@@ -0,0 +1,24 @@
+class AddSocialFeed < ActiveRecord::Migration
+  def self.up
+    add_column :users, :feed_event_subscriptions, :text
+    add_column :users, :email_subscriptions, :text
+    add_column :users, :enabled_feed_events, :text
+    
+    create_table :feed_events do |t|
+      t.column :type, :string
+      t.column :user_id, :integer
+      t.column :created_at, :datetime
+      t.column :source_id, :integer
+      t.column :source_type, :string
+      t.column :hint_body, :text
+    end
+  end
+
+  def self.down
+    remove_column :users, :feed_event_subscriptions
+    remove_column :users, :email_subscriptions
+    remove_column :users, :enabled_feed_events
+    
+    drop_table :feed_events
+  end
+end

data/init.rb

@@ -0,0 +1,10 @@
+require 'object_extensions'
+
+# configuration
+require 'ostruct'
+SocialFeed::Conf = OpenStruct.new YAML::load(File.read(RAILS_ROOT + '/config/social_feed.yml'))
+
+
+ActionController::Base.helper(SocialFeed::SocialFeedHelper) 
+
+ActionController::Routing::RouteSet::Mapper.send(:include, SocialFeed::Routing)

data/install.rb

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+__DIR__ = File.dirname(__FILE__)
+RAILS_ROOT = __DIR__ + '/../../..'
+
+# generate migration 
+# done by user
+
+# add events directory to load path
+# done by user
+
+# create events directory
+FileUtils.mkdir RAILS_ROOT + '/app/models/events'
+
+# copy mailer template
+FileUtils.cp __DIR__ + '/lib/feed_event_mailer.rb.template', RAILS_ROOT + '/app/models/feed_event_mailer.rb' 
+
+# create mailer views directory
+FileUtils.mkdir RAILS_ROOT + '/app/views/feed_event_mailer'
+
+# copy controller views, partials
+FileUtils.mkdir RAILS_ROOT + '/app/views/feed_events'
+FileUtils.cp __DIR__ + '/lib/feed_events_controller.rb.template', RAILS_ROOT + '/app/controllers/feed_events_controller.rb' 
+FileUtils.cp __DIR__ + '/views/index.html.erb', RAILS_ROOT + '/app/views/feed_events'
+FileUtils.cp __DIR__ + '/views/settings.html.erb', RAILS_ROOT + '/app/views/feed_events'
+FileUtils.cp __DIR__ + '/views/destroy.rjs', RAILS_ROOT + '/app/views/feed_events'
+FileUtils.cp __DIR__ + '/views/_user_feed.html.erb', RAILS_ROOT + '/app/views/feed_events'
+
+# copy config file
+FileUtils.cp __DIR__ + '/social_feed.yml', RAILS_ROOT + '/config'
+ 
+# add routes
+# done by user
+
+puts File.read(__DIR__ + '/INSTALL')

data/lib/feed_event.rb

@@ -0,0 +1,81 @@
+class FeedEvent < ActiveRecord::Base
+  def before_validation_on_create
+    send_email
+  end
+  
+  belongs_to :source, :polymorphic => true
+  validates_presence_of :user_id #receiver
+  validate :source_user_has_event_enabled
+  validate :user_has_subscribed_to_event
+  
+  @@event_types = []
+  
+  belongs_to :user
+
+  def allowed_to_destroy?(_user_id)
+    (user_id == _user_id)
+  end
+  
+  def self.event_types
+    load_subclasses if @@event_types.empty?
+    @@event_types
+  end
+  
+  def self.subscribable_feed_event_types
+    event_types.reject{|type| type.user_cannot_subscribe_to_event?}
+  end
+  
+  def self.enabable_feed_event_types
+    event_types.select{|type| type.user_can_enable_event?}
+  end
+  
+  def self.subscribe_description(desc = nil)
+    @@subscribe_descriptions ||= {}
+    @@subscribe_descriptions[name] = desc if desc
+    @@subscribe_descriptions[name]
+  end
+  
+  def self.privacy_description(desc = nil)
+    @@privacy_descriptions ||= {}
+    @@privacy_descriptions[name] = desc if desc
+    @@privacy_descriptions[name]
+  end
+
+  def self.can_send_email?
+    FeedEventMailer.send(:new).respond_to?(name.underscore[0..-7])
+  end
+  
+  def self.user_cannot_subscribe_to_event?
+    subscribe_description.blank?
+  end
+  
+  def self.user_can_enable_event?
+    privacy_description
+  end
+  
+  private
+  
+  def source_disabled_event?
+    self.class.user_can_enable_event? && source.respond_to?(:user) && source.user && !source.user.feed_event_enabled?(self.class)
+  end
+  def send_email
+    FeedEventMailer.send "deliver_#{self.class.name.underscore[0..-7]}", self if self.class.can_send_email? && 
+      (user.subscribed_to_email?(self.class) || self.class.user_cannot_subscribe_to_event?) && !user.try(:online?) && !source_disabled_event?
+  end
+  
+  def self.load_subclasses
+    Dir[RAILS_ROOT+'/app/models/events/*_event.rb'].each do |file|
+      @@event_types << File.basename(file, '.rb').camelize.constantize
+    end
+  end
+  
+  def user_has_subscribed_to_event
+    errors.add :user, "has not subscribed to event #{self.class}" unless user.if_not_nil?{|u| u.subscribed_to_feed_event?(self.class)} || 
+      self.class.user_cannot_subscribe_to_event?
+  end
+  
+  def source_user_has_event_enabled
+    errors.add :source, "this event is disabled by the user of #{self.source.class}" if source_disabled_event?
+  end
+  
+end

data/lib/feed_event_mailer.rb.template

@@ -0,0 +1,6 @@
+class FeedEventMailer < ActionMailer::Base
+	include SocialFeed::FeedEventMailerExtension
+
+	# add your emails here or use the generator to generate stubs
+  
+end

data/lib/feed_events_controller.rb.template

@@ -0,0 +1,6 @@
+class FeedEventsController < ApplicationController
+  include SocialFeed::FeedEventsControllerExtension
+
+	# add your custom methods here
+  
+end

data/lib/object_extensions.rb

@@ -0,0 +1,27 @@
+class Object
+  def try(method, *params)
+    send method, *params if respond_to? method
+  end
+end
+
+class Object
+  def if_nil?
+    self
+  end
+  
+  def if_not_nil?
+    yield self
+  end
+end
+
+class NilClass
+  def if_nil?
+    yield self
+    self
+  end
+  
+  def if_not_nil?
+    self
+  end
+end
+

data/lib/social_feed/feed_event_mailer_extension.rb

@@ -0,0 +1,14 @@
+module SocialFeed
+  module FeedEventMailerExtension
+    
+    private
+    def  create_event_message(subject, event) 
+      @subject    = subject
+      @body       = {:event => event}
+      @recipients = event.user.email
+      @from       = SocialFeed::Conf.sender_email
+      @sent_on    = Time.now
+    end
+  
+  end
+end

data/lib/social_feed/feed_events_controller_extension.rb

@@ -0,0 +1,48 @@
+module SocialFeed
+  module FeedEventsControllerExtension
+    
+    def destroy
+      @event = current_user.feed_events.find params[:id]
+      @event.destroy
+    end
+    
+    def index
+      @feed_events = current_user.feed_events.find :all, :limit => 20, :order => 'created_at DESC'
+    end
+    
+    def settings
+      
+    end
+    
+    def toggle_subscription
+      if current_user.subscribed_to_feed_event?(params[:event])
+        current_user.unsubscribe_from_feed_event(params[:event])
+      else
+        current_user.subscribe_to_feed_event(params[:event])
+      end
+      current_user.save
+      render :nothing => true
+    end
+    
+    def toggle_email_subscription
+      if current_user.subscribed_to_email?(params[:event])
+        current_user.unsubscribe_from_email(params[:event])
+      else
+        current_user.subscribe_to_email(params[:event])
+      end
+      current_user.save
+      render :nothing => true
+    end
+    
+    def toggle_enabled
+      if current_user.feed_event_enabled? params[:event]
+        current_user.disable_feed_event params[:event]
+      else
+        current_user.enable_feed_event params[:event]
+      end
+      current_user.save
+      render :nothing => true    
+    end
+    
+  end
+end

data/lib/social_feed/routing.rb

@@ -0,0 +1,15 @@
+module SocialFeed
+  module Routing 
+    def from_plugin(name) 
+      plugin_root = File.join(RAILS_ROOT, 
+                              'vendor', 
+                              'plugins') 
+      routes_path = File.join(plugin_root, 
+                              name.to_s, 
+                              'routes.rb') 
+      if File.file?(routes_path) 
+        eval(IO.read(routes_path), binding, routes_path) 
+      end 
+    end 
+  end 
+end 

data/lib/social_feed/social_feed_helper.rb

@@ -0,0 +1,7 @@
+module SocialFeed
+  module SocialFeedHelper
+    def feed_event_partial_name(event)
+      event.class.name.underscore.sub(/event$/, 'hint')
+    end
+  end
+end

data/lib/social_feed/user_extension.rb

@@ -0,0 +1,59 @@
+module SocialFeed
+  module UserExtension
+    
+    def self.included(base)
+      base.class_eval do
+        serialize :feed_event_subscriptions
+        serialize :email_subscriptions
+        serialize :enabled_feed_events
+        
+        has_many :feed_events, :dependent => :destroy, :order => "id DESC"
+        has_many :feed_events_as_source, :dependent => :destroy, :as => :source, :class_name => 'FeedEvent'
+      end
+      
+    end
+    
+    def subscribe_to_feed_event(event_class) 
+      self.feed_event_subscriptions ||= []
+      self.feed_event_subscriptions |= [event_class.to_s]
+    end
+    
+    def subscribed_to_feed_event?(event_class)
+      self.feed_event_subscriptions.if_not_nil?{|s| s.include?(event_class.to_s)}
+    end
+    
+    def unsubscribe_from_feed_event(event_class)
+      self.feed_event_subscriptions_will_change!
+      self.feed_event_subscriptions.delete event_class.to_s
+    end
+    
+    def subscribe_to_email(event_class) 
+      self.email_subscriptions ||= []
+      self.email_subscriptions |= [event_class.to_s]
+    end
+    
+    def subscribed_to_email?(event_class)
+      self.email_subscriptions.if_not_nil?{|s| s.include?(event_class.to_s)}
+    end
+    
+    def unsubscribe_from_email(event_class)
+      self.email_subscriptions_will_change!
+      self.email_subscriptions.delete event_class.to_s
+    end
+    
+    def enable_feed_event(event_class)
+      self.enabled_feed_events ||= []
+      self.enabled_feed_events |= [event_class.to_s]
+    end
+    
+    def disable_feed_event(event_class)
+      self.enabled_feed_events_will_change!
+      self.enabled_feed_events.delete event_class.to_s
+    end
+    
+    def feed_event_enabled?(event_class)
+      self.enabled_feed_events.if_not_nil?{|e| e.include? event_class.to_s}
+    end
+    
+  end
+end

data/routes.rb

@@ -0,0 +1,2 @@
+resources :feed_events, :collection => {:toggle_subscription => :post, :toggle_email_subscription => :post, :toggle_enabled => :post,
+  :settings => :get}

data/social_feed.yml

@@ -0,0 +1 @@
+sender_email: "<no-reply@mydomain.com>"

data/spec/controllers/feed_events_controller_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require PLUGIN_ROOT + '/lib/social_feed/feed_events_controller_extension'
+
+class FeedEventsController
+  attr_accessor :params
+  include SocialFeed::FeedEventsControllerExtension
+  
+  def render(options); end
+    
+end
+
+describe FeedEventsController do
+
+  before(:each) do
+    @controller = FeedEventsController.new
+  end
+  
+  def set_current_user(user)
+    @controller.stub!(:current_user).and_return(user)
+  end
+  
+  def post(method, options)
+    @controller.params = options
+    @controller.send method
+  end
+  
+
+describe FeedEventsController, 'toggle enabled feed events' do
+  before(:each) do
+    @user = stub 'user', :feed_event_enabled? => false, :enable_feed_event => true, :save => true
+    set_current_user @user
+  end
+  
+  it "should enable the event" do
+    @user.should_receive(:enable_feed_event).with('TestEvent')
+    post :toggle_enabled, :event => 'TestEvent'
+  end
+  
+  it "should disable an enabled event" do
+    @user.stub!(:feed_event_enabled?).with('TestEvent').and_return(true)
+    @user.should_receive(:disable_feed_event).with('TestEvent')
+    post :toggle_enabled, :event => 'TestEvent'
+  end
+  
+  it "should save the user" do
+    @user.should_receive(:save)
+    post :toggle_enabled, :event => 'TestEvent'
+  end
+  
+end
+
+describe FeedEventsController, 'toggle subscribe to feed event' do
+  before(:each) do
+    @user = stub 'user', :subscribed_to_feed_event? => true, :unsubscribe_from_feed_event => false, :save => true
+    set_current_user @user
+  end
+  
+  it "should subscribe on the event" do
+    @user.stub!(:subscribed_to_feed_event?).with('TestEvent').and_return(false)
+    @user.should_receive(:subscribe_to_feed_event).with('TestEvent')
+    post :toggle_subscription, :event => 'TestEvent'
+  end
+  
+  it "should unsubscribe from a subscribed event" do
+    @user.stub!(:subscribed_to_feed_event?).with('TestEvent').and_return(true)
+    @user.should_receive(:unsubscribe_from_feed_event).with('TestEvent')
+    post :toggle_subscription, :event => 'TestEvent'
+  end
+  
+  it "should save the user" do
+    @user.should_receive(:save)
+    post :toggle_subscription, :event => 'TestEvent'
+  end
+  
+end
+
+describe FeedEventsController, 'toggle subscribe to email event' do
+  before(:each) do
+    @user = stub 'user', :subscribed_to_email? => true, :unsubscribe_from_email => nil, :save => true
+    set_current_user @user
+  end
+  
+
+  it "should subscribe on the event" do
+    @user.stub!(:subscribed_to_email?).with('TestEvent').and_return(false)
+    @user.should_receive(:subscribe_to_email).with('TestEvent')
+    post :toggle_email_subscription, :event => 'TestEvent'
+  end
+  
+  it "should unsubscribe from a subscribed event" do
+    @user.stub!(:subscribed_to_email?).with('TestEvent').and_return(true)
+    @user.should_receive(:unsubscribe_from_email).with('TestEvent')
+    post :toggle_email_subscription, :event => 'TestEvent'
+  end
+  
+  it "should save the user" do
+    @user.should_receive(:save)
+    post :toggle_email_subscription, :event => 'TestEvent'
+  end
+  
+end
+
+end

data/spec/helpers/social_feed_helper_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require PLUGIN_ROOT + '/lib/social_feed/social_feed_helper'
+include SocialFeed::SocialFeedHelper
+class TestEvent; end
+class TestEventCreatedEvent; end
+
+describe SocialFeed::SocialFeedHelper do
+  
+  it "should derive the hint partial from the feed class" do
+    feed_event_partial_name(TestEvent.new).should == 'test_hint'
+  end
+  
+  it "should only replace event with hint at the end" do
+    feed_event_partial_name(TestEventCreatedEvent.new).should == 'test_event_created_hint'
+  end
+  
+end

data/spec/models/feed_event_spec.rb

@@ -0,0 +1,202 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require PLUGIN_ROOT + '/lib/feed_event'
+
+describe FeedEvent, 'send emails' do
+  class TestFeedEvent < FeedEvent; end
+  
+  it "should send no email if mailer does not support it" do
+    user = mock_model(User, :subscribed_to_feed_event? => true)
+    event = TestFeedEvent.new :source => user, :user => user
+    FeedEventMailer.should_receive(:deliver_test_feed_event).never
+    event.save!
+  end
+
+  it "should derive mailer method from class name" do
+    FeedEventMailer.stub!(:send).with(:new).and_return(stub('mailer', :test_feed => true))
+    user = mock_model User, :subscribed_to_feed_event? => true, :subscribed_to_email? => true, :online? => false
+    event = TestFeedEvent.new :source => user, :user => user
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', event)
+    event.save!
+  end
+  
+  it "should not be able to send mail if mailer has no mailer method" do
+    TestFeedEvent.can_send_email?.should be_false
+  end
+  
+  it "should be able to send mail if mailer has mailer method" do
+    FeedEventMailer.stub!(:new).and_return(nil) # actionmailer.new really returns nil, you have to use send(:new)
+    FeedEventMailer.stub!(:send).with(:new).and_return(stub('mailer', :test_feed => true))
+    TestFeedEvent.can_send_email?.should be_true
+  end
+end
+
+describe FeedEvent, 'check event enabled when creating' do
+  
+  class TestFeedEvent < FeedEvent
+    privacy_description 'desc'
+  end
+  class NotDisabableEvent < FeedEvent; end
+  
+  before(:each) do
+    @user = mock_model User, :feed_event_enabled? => true
+    @event  = TestFeedEvent.new :source => mock_model(FeedEvent, :user => @user)
+  end
+  
+  it "should be valid if source user has event enabled" do
+    @event.valid?
+    @event.should have(:no).errors_on(:source)
+  end
+  
+  it "should be invalid if soure user has event disabled" do
+    @user.stub!(:feed_event_enabled?).and_return(false)
+    @event.valid?
+    @event.should have(1).error_on(:source)
+  end
+  
+  it "should check wether the event is enabled" do
+    @user.should_receive(:feed_event_enabled?).with(TestFeedEvent)
+    @event.valid?
+  end
+  
+  it "should be valid if source has no user" do
+    @event.source = mock_model(FeedEvent)
+    @event.valid?
+    @event.should have(:no).errors_on(:source)
+  end
+  
+  it "should be valid if source user is nil" do
+    @event.source = mock_model(FeedEvent, :user => nil)
+    @event.valid?
+    @event.should have(:no).errors_on(:source)
+  end
+  
+  it "should be valid if source user has event disabled but event has no privacy description (user can not disabled the event)" do
+    @user.stub!(:feed_event_enabled?).and_return(false)
+    event = NotDisabableEvent.new :source => mock_model(FeedEvent, :user => @user)
+    event.valid?
+    event.should have(:no).errors_on(:source)
+  end
+  
+end
+
+describe 'check event enabled when sending email' do
+  class TestFeedEvent < FeedEvent
+    privacy_description 'desc'
+  end
+    
+  class NotDisabableEvent < FeedEvent;end
+  
+  class Source; end
+  
+  before(:each) do
+    TestFeedEvent.connection.stub!(:insert)
+    FeedEventMailer.stub!(:send).with(:new).and_return(stub('mailer', :test_feed => true, :not_disabable => true))
+    @user = mock_model(User, :subscribed_to_feed_event? => true, :subscribed_to_email? => true)
+    Source.stub!(:base_class).and_return(Source)
+    @source = mock_model(Source, :user => @user)
+    @event = TestFeedEvent.new :source => @source, :user => @user
+  end
+
+  it "should send no email if event disabled" do
+    @user.stub!(:feed_event_enabled?).and_return(false)
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', @event).never
+    @event.save
+  end
+  
+  it "should send email if event enabled" do
+    @user.stub!(:feed_event_enabled?).and_return(true)
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', @event)
+    @event.save
+  end
+  
+  it "should send email if user can't disable event" do
+    event = NotDisabableEvent.new :source => @source, :user => @user
+    FeedEventMailer.should_receive(:send).with('deliver_not_disabable', event)
+    event.save
+  end
+end
+describe FeedEvent, 'check subscriptions when creating' do
+  class TestFeedEvent < FeedEvent
+    subscribe_description 'desc'
+  end
+  class NotSubscribableEvent < FeedEvent; end
+  
+  before(:each) do
+    @user = mock_model User
+    @event = TestFeedEvent.new :user => @user
+  end
+  
+  it "should be invalid if user not subscribed to event" do
+    @user.stub!(:subscribed_to_feed_event?).and_return(false)
+    @event.valid?
+    @event.should have(1).errors_on(:user)
+  end
+  
+  it "should be valid if user not subscribed to event but event has no description (user could not unsubscribe from this event)" do
+    @user.stub!(:subscribed_to_feed_event?).and_return(false)
+    @event = NotSubscribableEvent.new :user => @user
+    @event.should have(:no).errors_on(:user)
+  end
+  
+  it "should check the subscription of the user" do
+    @user.should_receive(:subscribed_to_feed_event?).with(TestFeedEvent).and_return(true)
+    @event.valid?
+  end
+  
+  it "should be valid if user subscribed to event" do
+    @user.stub!(:subscribed_to_feed_event?).and_return(true)
+    @event.valid?
+    @event.should have(:no).errors_on(:user)
+  end
+end
+
+describe FeedEvent, 'check subscription before sending emails' do
+  class TestFeedEvent < FeedEvent
+    subscribe_description 'desc'    
+  end
+  class NotSubscribableEvent < FeedEvent; end
+  
+  before(:each) do
+    @user = mock_model User, :subscribed_to_email? => true, :subscribed_to_feed_event? => true, :online? => false
+    FeedEventMailer.stub!(:send).with(:new).and_return(stub('mailer', :respond_to? => true))
+  end
+  
+  it "should send an email if user subscribed to email" do
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', anything)
+    TestFeedEvent.create :user => @user
+  end
+  
+  it "should send no email if user subscribed to email but is online" do
+    @user.stub!(:online?).and_return(true)
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', anything).never
+    TestFeedEvent.create :user => @user
+  end
+  
+  it "should send an email user user subscribed to email and has no online method" do
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', anything)
+    TestFeedEvent.create :user => mock_model(User, :subscribed_to_email? => true, :subscribed_to_feed_event? => false)
+  end
+  
+  it "should check the subscription of the user" do
+    @user.should_receive(:subscribed_to_email?).with(TestFeedEvent).and_return(false)
+    TestFeedEvent.create :user => @user
+  end
+  
+  it "should send no email if user has not subscribed to email" do
+    @user.stub!(:subscribed_to_email?).and_return(false)
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', anything).never
+    TestFeedEvent.create :user => @user
+  end
+  
+  it "should send a email if user can't unsubscribe from email (event has no email description)" do
+    @user.stub!(:subscribed_to_email?).and_return(false)
+    FeedEventMailer.should_receive(:send).with('deliver_not_subscribable', anything)
+    NotSubscribableEvent.create :user => @user
+  end
+  
+  it "should send an email if user subscribed to email but not to feed event" do
+    @user.stub!(:subscribed_to_feed_event?).and_return(false)
+    FeedEventMailer.should_receive(:send).with('deliver_test_feed', anything)
+    TestFeedEvent.create :user => @user
+  end
+end

data/spec/models/user_spec.rb

@@ -0,0 +1,148 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe User, 'enable feed events' do
+  
+  class TestEvent; end
+  before(:each) do
+    @user = User.new
+  end
+  
+  it "should enable an event" do
+    @user.enable_feed_event TestEvent
+    @user.enabled_feed_events.should include('TestEvent')
+  end
+  
+  it "should enable an event only once" do
+    @user.enable_feed_event TestEvent
+    @user.enable_feed_event TestEvent
+    @user.enabled_feed_events.should == ['TestEvent']
+  end
+  
+  it "should disable and event" do
+    @user.enabled_feed_events = ['TestEvent']
+    @user.disable_feed_event TestEvent
+    @user.enabled_feed_events.should_not include('TestEvent')
+  end
+  
+  it "should return true if an event is enabled" do
+    @user.enabled_feed_events = ['TestEvent']
+    @user.should be_feed_event_enabled(TestEvent)
+  end
+  
+  it "should return false if an event is disabled" do
+    @user.should_not be_feed_event_enabled(TestEvent)
+  end
+  
+  it "should mark the attibute dirty when disabling" do
+    @user.enabled_feed_events = ['TestEvent']
+    @user.save!
+    @user.disable_feed_event TestEvent
+    @user.should be_enabled_feed_events_changed
+  end
+  
+  it "should mark the attibute dirty when enabling" do
+    @user.enabled_feed_events = ['TestEvent1']
+    @user.save!
+    @user.enable_feed_event TestEvent
+    @user.should be_enabled_feed_events_changed
+  end
+end
+
+describe User, 'subscribe to feed events' do
+  class TestEvent; end
+  before(:each) do
+    @user = User.new
+  end
+
+  it "should subscribe to an event" do
+    @user.subscribe_to_feed_event TestEvent
+    @user.feed_event_subscriptions.should include('TestEvent')
+  end
+  
+  it "should subscribe to an event only once" do
+    @user.subscribe_to_feed_event TestEvent
+    @user.subscribe_to_feed_event TestEvent
+    @user.feed_event_subscriptions.should == ['TestEvent']
+  end
+  
+  it "should unsubscribe from an event" do
+    @user.feed_event_subscriptions = ['TestEvent']
+    @user.unsubscribe_from_feed_event TestEvent
+    @user.feed_event_subscriptions.should be_empty 
+  end
+  
+  it "should return true if user is subscribed" do
+    @user.feed_event_subscriptions = ['TestEvent']
+    @user.should be_subscribed_to_feed_event(TestEvent)
+  end
+  
+  it "should return false if user is not subscribed" do
+    @user.should_not be_subscribed_to_feed_event(TestEvent)
+  end
+  
+  it "should mark the attibute dirty when subscribing" do
+    @user.feed_event_subscriptions = ['TestEvent1']
+    @user.save!
+    @user.subscribe_to_feed_event TestEvent
+    @user.should be_feed_event_subscriptions_changed
+  end
+  
+  it "should mark the attibute dirty when unsubscribing" do
+    @user.feed_event_subscriptions = ['TestEvent']
+    @user.save!
+    @user.unsubscribe_from_feed_event TestEvent
+    @user.should be_feed_event_subscriptions_changed
+  end
+  
+end
+
+describe User, 'subscribe to emails' do
+  class TestEvent; end
+  before(:each) do
+    @user = User.new
+  end
+
+  it "should subscribe to an email" do
+    @user.subscribe_to_email TestEvent
+    @user.email_subscriptions.should include('TestEvent')
+  end
+  
+  it "should subscribe to an email only once" do
+    @user.subscribe_to_email TestEvent
+    @user.subscribe_to_email TestEvent
+    @user.email_subscriptions.should == ['TestEvent']
+  end
+  
+  it "should unsubscribe from an email" do
+    @user.email_subscriptions = ['TestEvent']
+    @user.unsubscribe_from_email TestEvent
+    @user.email_subscriptions.should be_empty 
+  end
+  
+  it "should return true if user is subscribed" do
+    @user.email_subscriptions = ['TestEvent']
+    @user.should be_subscribed_to_email(TestEvent)
+  end
+  
+  it "should return false if user is not subscribed" do
+    @user.should_not be_subscribed_to_email(TestEvent)
+  end
+  
+  it "should mark the attibute dirty when subscribing" do
+    @user.email_subscriptions = ['TestEvent1']
+    @user.save!
+    @user.subscribe_to_email TestEvent
+    @user.should be_email_subscriptions_changed
+  end
+  
+  it "should mark the attibute dirty when unsubscribing" do
+    @user.email_subscriptions = ['TestEvent']
+    @user.save!
+    @user.unsubscribe_from_email TestEvent
+    @user.should be_email_subscriptions_changed
+  end
+end
+
+
+describe User, 'subscribed to email notification' do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+PLUGIN_ROOT = File.dirname(__FILE__) + '/..'
+
+require 'rubygems'
+gem 'activerecord'
+require 'activerecord'
+
+__DIR__ = File.dirname __FILE__
+
+FileUtils.rm_rf __DIR__ + '/../test.sqlite3'
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => File.join(File.dirname(__FILE__), '..', 'test.sqlite3')
+
+# migrate
+
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+        
+    end
+  end
+end
+CreateUsers.up
+
+require PLUGIN_ROOT + '/lib/social_feed/user_extension'
+class User < ActiveRecord::Base
+  include SocialFeed::UserExtension
+end
+class FeedEventMailer; end
+
+require File.dirname(__FILE__) + '/../generators/social_feed_migration/templates/migration'
+AddSocialFeed.up
+
+require PLUGIN_ROOT + '/lib/object_extensions'
+
+
+# rspec rails stuff
+
+module Spec
+  module Example
+    class ExampleGroup 
+      
+      @@model_id = 1000
+      
+      def mock_model(model_class, options_and_stubs = {})
+        # null = options_and_stubs.delete(:null_object)
+        # stubs = options_and_stubs
+        id = @@model_id
+        @@model_id += 1
+        options_and_stubs = {
+          :id => id,
+          :to_param => id.to_s,
+          :new_record? => false,
+          :errors => stub("errors", :count => 0)
+        }.merge(options_and_stubs)
+        m = mock("#{model_class.name}_#{id}", options_and_stubs)
+        m.send(:__mock_proxy).instance_eval <<-CODE
+          def @target.is_a?(other)
+            #{model_class}.ancestors.include?(other)
+          end
+          def @target.kind_of?(other)
+            #{model_class}.ancestors.include?(other)
+          end
+          def @target.instance_of?(other)
+            other == #{model_class}
+          end
+          def @target.class
+            #{model_class}
+          end
+        CODE
+        yield m if block_given?
+        m
+      end
+    end
+  end
+end
+
+module ActiveRecord #:nodoc:
+  class Base
+
+    def errors_on(attribute)
+      self.valid?
+      [self.errors.on(attribute)].flatten.compact
+    end
+    alias :error_on :errors_on
+
+  end
+end

data/views/_user_feed.html.erb

@@ -0,0 +1,12 @@
+<div id="user_feed">
+  <%- user_feed.each do |event| -%>
+    <%- if event.hint_body? -%>
+      <%= event.hint_body %>
+    <%- else -%>
+	    <%= hint = render :partial => feed_event_partial_name(event), :locals => {:event => event} 
+	        event.update_attribute :hint_body, hint
+          hint
+	    %>
+	  <%- end -%>
+	<% end %>
+</div>

data/views/destroy.rjs

@@ -0,0 +1 @@
+page.visual_effect :fade, dom_id(@event)

data/views/index.html.erb

@@ -0,0 +1,2 @@
+<%= link_to 'Settings', settings_feed_events_path %>
+<%= render :partial => 'feed_events/user_feed', :object => @feed_events %>

data/views/settings.html.erb

@@ -0,0 +1,36 @@
+<h2>Subscriptions</h2>
+<table>
+	<tr>
+		<th>Feed</th>
+		<th>Email</th>
+		<th>Event</th>
+	</tr>
+	<%- FeedEvent.subscribable_feed_event_types.each do |clazz| -%>
+		<tr id="<%= clazz.name + '_row' %>">
+			<td>
+				<%= check_box_tag clazz.name + '_feed', '1', current_user.subscribed_to_feed_event?(clazz) %>
+				<%= observe_field clazz.name + '_feed', :url => toggle_subscription_feed_events_path(:event => clazz.name), :success => "new Effect.Highlight('#{clazz.name + '_row'}')" %>
+			</td>
+			<td>
+				<%- if clazz.can_send_email? -%>
+					<%= check_box_tag clazz.name + '_mail', '1', current_user.subscribed_to_email?(clazz) %>
+					<%= observe_field clazz.name + '_mail', :url => toggle_email_subscription_feed_events_path(:event => clazz.name), :success => "new Effect.Highlight('#{clazz.name + '_row'}')" %>
+				<%- end -%>
+			</td>
+			<td class="blue_font"><%= clazz.subscribe_description %></td>
+		</tr>
+	<%- end -%>
+</table>
+
+<h2>Privacy Settings</h2>
+<table>
+	<%- FeedEvent.enabable_feed_event_types.each do |clazz| -%>
+		<tr id="<%= "#{clazz.name + '_privacy_row'}" %>">
+			<td>
+				<%= check_box_tag clazz.name + '_privacy', '1', current_user.feed_event_enabled?(clazz) %>
+				<%= observe_field clazz.name + '_privacy', :url => toggle_enabled_feed_events_path(:event => clazz.name), :success => "new Effect.Highlight('#{clazz.name + '_privacy_row'}')" %>
+			</td>
+			<td><%= clazz.privacy_description %></td>
+		</tr>
+	<%- end -%>
+</table>

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: social_feed
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alexander Lang
+- Thilo Utke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-07 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: ""
+email: alex@upstream-berlin.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- INSTALL
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- generators/feed_event/feed_event_generator.rb
+- generators/feed_event/templates/event_hint.html.erb
+- generators/feed_event/templates/event_model.rb.erb
+- generators/social_feed_migration/social_feed_migration_generator.rb
+- generators/social_feed_migration/templates/migration.rb
+- init.rb
+- install.rb
+- lib/feed_event.rb
+- lib/feed_event_mailer.rb.template
+- lib/feed_events_controller.rb.template
+- lib/object_extensions.rb
+- lib/social_feed/feed_event_mailer_extension.rb
+- lib/social_feed/feed_events_controller_extension.rb
+- lib/social_feed/routing.rb
+- lib/social_feed/social_feed_helper.rb
+- lib/social_feed/user_extension.rb
+- routes.rb
+- social_feed.yml
+- spec/controllers/feed_events_controller_spec.rb
+- spec/helpers/social_feed_helper_spec.rb
+- spec/models/feed_event_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb
+- views/_user_feed.html.erb
+- views/destroy.rjs
+- views/index.html.erb
+- views/settings.html.erb
+has_rdoc: true
+homepage: http://github.com/langalex/social_feed
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: a ruby on rails plugin to create and display a social feed
+test_files: 
+- spec/controllers/feed_events_controller_spec.rb
+- spec/helpers/social_feed_helper_spec.rb
+- spec/models/feed_event_spec.rb
+- spec/models/user_spec.rb
+- spec/spec_helper.rb