social_stream-base 0.5.0

data/lib/social_stream/models/supertype.rb

@@ -0,0 +1,44 @@
+require 'active_support/concern'
+
+module SocialStream #:nodoc:
+  module Models
+    # Common methods for models that have subtypes. Currently, there are two supertypes:
+    # * Actor: participates in the social network and has ties with other actors. Its subtypes are subjects, like user or group
+    # * ActivityObject: created and managed by actors in activities. Its subtypes are objects, like post or comment
+    module Supertype
+      extend ActiveSupport::Concern
+
+      included do
+        subtypes.each do |s|
+          has_one s, :dependent => :destroy
+        end
+      end
+
+      module ClassMethods
+        def subtypes
+          SocialStream.__send__ @subtypes_name.to_s.tableize # SocialStream.subjects # in Actor
+        end
+
+        def load_subtype_features
+          features = "SocialStream::Models::#{ @subtypes_name.to_s.classify }".constantize
+
+          subtypes.each do |s|
+            s = s.to_s.classify.constantize
+            s.__send__(:include, features) unless s.ancestors.include?(features)
+          end
+        end
+      end 
+
+      module InstanceMethods
+        def subtype_instance
+          self.class.subtypes.each do |s|
+            i = __send__(s)
+            return i if i.present?
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/social_stream/populate.rb

@@ -0,0 +1,26 @@
+module SocialStream
+  module Populate
+
+    class << self
+      # Yields each element of array y times given by 
+      # {power law distribution}[http://en.wikipedia.org/wiki/Power_law]
+      # y = ax**k + e
+      # 
+      # Options: Each constant in the function
+      #
+      def power_law(array, options = {})
+        options[:a] ||= array.size
+        options[:k] ||= -2.5
+        options[:e] ||= 1
+
+        array.each do |i|
+          value = options[:a] * (array.index(i) + 1) ** options[:k] + options[:e]
+
+          value.round.times do
+            yield i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/social_stream/test_helpers/controllers.rb

@@ -0,0 +1,119 @@
+module SocialStream
+  module TestHelpers
+    module Controllers
+      # Post for PostsController
+      def model_class
+        @model_class ||=
+          described_class.to_s.sub!("Controller", "").singularize.constantize
+      end
+
+      # :post for PostsController
+      def model_sym
+        @model_sym ||=
+          model_class.to_s.underscore.to_sym
+      end
+
+      # Factory.attributes_for(:post) for PostsController
+      def model_attributes
+        @model_attributes ||=
+          Factory.attributes_for(model_sym)
+      end
+
+      def attributes
+        { model_sym => model_attributes }
+      end
+
+      def updating_attributes
+        attributes.merge({ :id => @current_model.to_param })
+      end
+
+      # Post.count
+      def model_count
+        model_class.count
+      end
+
+      def model_assigned_to tie
+        model_attributes[:_activity_tie_id] = tie.id
+      end
+
+      shared_examples_for "Allow Creating" do
+        it "should create" do
+          count = model_count
+          post :create, attributes
+
+          resource = assigns(model_sym)
+
+          model_count.should eq(count + 1)
+          resource.should be_valid
+          response.should redirect_to(resource)
+        end
+      end
+
+      shared_examples_for "Deny Creating" do
+        it "should not create" do
+          count = model_count
+          begin
+            post :create, attributes
+          rescue CanCan::AccessDenied
+          end
+
+          resource = assigns(model_sym)
+
+          model_count.should eq(count)
+          resource.should be_new_record
+        end
+      end
+
+      shared_examples_for "Allow Updating" do
+        it "should update" do
+          put :update, updating_attributes
+
+          resource = assigns(model_sym)
+
+          resource.should_receive(:update_attributes).with(attributes)
+          assert resource.valid?
+          response.should redirect_to(resource)
+        end
+      end
+
+      shared_examples_for "Deny Updating" do
+        it "should not update" do
+          begin
+            put :update, updating_attributes
+          rescue CanCan::AccessDenied
+          end
+
+          resource = assigns(model_sym)
+
+          resource.should_not_receive(:update_attributes)
+        end
+      end
+
+      shared_examples_for "Allow Destroying" do
+        it "should destroy" do
+          count = model_count
+          delete :destroy, :id => @current_model.to_param
+
+          resource = assigns(model_sym)
+
+          model_count.should eq(count - 1)
+        end
+      end
+
+      shared_examples_for "Deny Destroying" do
+        it "should not destroy" do
+          count = model_count
+          begin
+            delete :destroy, :id => @current_model.to_param
+          rescue CanCan::AccessDenied
+          end
+
+          resource = assigns(model_sym)
+
+          model_count.should eq(count)
+        end
+      end
+
+    end
+  end
+end

data/lib/social_stream/test_helpers.rb

@@ -0,0 +1,11 @@
+module SocialStream
+  module TestHelpers
+    # Represent this subject
+    def represent(subject)
+      session[:subject_type] = subject.class.to_s
+      session[:subject_id] = subject.id
+
+      subject
+    end
+  end
+end

data/lib/social_stream-base.rb

@@ -0,0 +1,98 @@
+# Database foreign keys
+require 'foreigner'
+# jQuery
+require 'jquery-rails'
+# Permalinks:
+require 'stringex'
+# Hierarchical relationships in Activity and Relation:
+require 'ancestry'
+# Messages
+require 'mailboxer'
+# User authentication
+require 'devise'
+# Authorization
+require 'cancan'
+# REST controllers
+require 'inherited_resources'
+# Scopes in controllers
+require 'has_scope'
+# Logo attachments
+require 'paperclip'
+require 'paperclip/social_stream'
+require 'avatars_for_rails'
+# Pagination
+require 'will_paginate'
+# Oauth
+require 'omniauth/oauth'
+# CSS themes
+require 'rails_css_themes'
+#Tags
+require 'acts-as-taggable-on'
+# HTML forms
+require 'formtastic'
+
+# Provides your Rails application with social network and activity stream support
+module SocialStream
+  autoload :Ability,   'social_stream/ability'
+  autoload :Populate,  'social_stream/populate'
+  autoload :Relations, 'social_stream/relations'
+  autoload :TestHelpers, 'social_stream/test_helpers'
+
+  module Controllers
+    autoload :Helpers, 'social_stream/controllers/helpers'
+  end
+
+  module Models
+    autoload :Supertype, 'social_stream/models/supertype'
+    autoload :Subject,   'social_stream/models/subject'
+    autoload :Object,    'social_stream/models/object'
+  end
+
+  module TestHelpers
+    autoload :Controllers, 'social_stream/test_helpers/controllers'
+  end
+
+  mattr_accessor :subjects
+  @@subjects = [ :user, :group ]
+
+  mattr_accessor :devise_modules
+  @@devise_modules = [ :database_authenticatable, :registerable, :recoverable,
+                       :rememberable, :trackable, :omniauthable, :token_authenticatable]
+
+  mattr_writer :objects
+  @@objects = [ :post, :comment ]
+
+  class << self
+    def setup
+      yield self
+    end
+
+    def objects
+      @@objects.push(:actor) unless @@objects.include?(:actor)
+      @@objects
+    end
+
+    # Load models for rewrite in application
+    #
+    # Use this method when you want to reopen some model in SocialStream in order
+    # to add or modify functionality
+    #
+    # Example, in app/models/user.rb
+    #   SocialStream.require_model('user')
+    #
+    #   class User
+    #     some_new_functionality
+    #   end
+    #
+    # Maybe Rails provides some method to do this, in this case, please tell!!
+    def require_model(m)
+      path = $:.find{ |f| f =~ Regexp.new(File.join('social_stream.*', 'app', 'models')) }
+
+      raise "Can't find social_stream path" if path.blank?
+
+      require_dependency File.join(path, m)
+    end
+  end
+end
+
+require 'social_stream/base'

data/lib/tasks/db/populate.rake

@@ -0,0 +1,194 @@
+namespace :db do
+  desc 'Populate database with fake data for development'
+  task :populate => [ 'db:seed', 'db:populate:create' ]
+  
+  namespace :populate do
+    
+    desc "Reload populate data"
+    task :reload => [ 'db:reset', :create ]
+    
+    desc "Create populate data"
+    task :create => :environment do
+      
+      LOGOS_PATH = File.join(Rails.root, 'lib', 'logos')
+      
+      Mailboxer.setup do |config|
+        config.uses_emails = false
+      end
+      
+      def set_logos(klass)
+        klass.all.each do |i|
+          logo = Dir[File.join(LOGOS_PATH, klass.to_s.tableize, "#{ i.id }.*")].first
+          avatar = Dir[File.join(LOGOS_PATH, klass.to_s.tableize, "#{ i.id }.*")].first
+        
+          if avatar.present? && File.exists?(avatar)
+            Avatar.copy_to_temp_file(avatar)
+            dimensions = Avatar.get_image_dimensions(avatar)
+            l = Avatar.new(:actor => i.actor,:logo => File.open(avatar), :name => File.basename(avatar), :crop_x => 0, :crop_y => 0, :crop_w => dimensions[:width], :crop_h => dimensions[:height] )
+            l.active = true
+            l.save(false)
+          end
+        end
+      end
+      
+      def set_tags(klass)
+        klass.all.each do |el|
+          el.tag_list = Forgery::LoremIpsum.words(1,:random => true)+", "+
+                        Forgery::LoremIpsum.words(1,:random => true)+", "+
+                        Forgery::LoremIpsum.words(1,:random => true)
+          el.save!
+        end
+      end
+      
+      puts 'User population'
+      users_start = Time.now
+      
+      # = Users
+      
+      # Create demo user if not present
+      if User.find_by_name('demo').blank?
+        User.create! :name => 'Demo',
+                     :email => 'demo@social-stream.dit.upm.es',
+                     :password => 'demonstration',
+                     :password_confirmation => 'demonstration'
+      end
+      
+      require 'forgery'
+      
+      9.times do
+        User.create! :name => Forgery::Name.full_name,
+                     :email => Forgery::Internet.email_address,
+                     :password => 'demonstration',
+                     :password_confirmation => 'demonstration'
+      end
+      
+      set_logos(User)
+      
+      users_end = Time.now 
+      puts '   -> ' + (users_end - users_start).round(4).to_s + 's'
+      
+      puts 'Groups population'
+      groups_start = Time.now
+      
+      # = Groups
+      available_actors = Actor.all
+
+      10.times do
+        founder = available_actors[rand(available_actors.size)]
+        
+        Group.create :name  => Forgery::Name.company_name,
+                     :email => Forgery::Internet.email_address,
+        :_founder => founder.slug
+      end
+      
+      set_logos(Group)
+      set_tags(Group)
+      
+      groups_end = Time.now 
+      puts '   -> ' +  (groups_end - groups_start).round(4).to_s + 's'
+      
+      
+      puts 'Ties population'
+      ties_start = Time.now
+      
+      # Reload actors to include groups
+      available_actors = Actor.all      
+      
+      # = Ties
+      available_actors.each do |a|
+        actors = available_actors.dup - Array(a)
+        relations = a.relation_customs
+        
+        Forgery::Basic.number(:at_most => actors.size).times do
+          actor = actors.delete_at((rand * actors.size).to_i)
+          a.sent_ties.create :receiver => actor,
+                             :relation => relations.random
+        end
+      end
+      
+      ties_end = Time.now
+      puts '   -> ' +  (ties_end - ties_start).round(4).to_s + 's'
+      
+      # = Posts
+      
+      puts 'Post population'
+      posts_start = Time.now
+      
+      SocialStream::Populate.power_law(Tie.all) do |t|
+        updated = Time.at(rand(Time.now))
+        
+        p = Post.create :text =>
+                      "This post should be for #{ t.relation.name } of #{ t.sender.name }.\n#{ Forgery::LoremIpsum.paragraph(:random => true) }",
+                        :created_at => Time.at(rand(updated)),
+                        :updated_at => updated,
+        :_activity_tie_id => t.id
+        
+        p.post_activity.update_attributes(:created_at => p.created_at,
+                                          :updated_at => p.updated_at)
+      end
+      
+      posts_end = Time.now 
+      puts '   -> ' +  (posts_end - posts_start).round(4).to_s + 's'
+      
+      puts 'Mailboxer population'
+      mailboxer_start = Time.now
+      
+      # = Mailboxer
+      available_actors = Actor.all
+          
+      available_actors.each do |a|
+        actors = available_actors.dup - Array(a)
+        
+        mult_recp = actors.uniq
+        if (demo = User.find_by_name('demo')) and !mult_recp.include? Actor.normalize(demo)
+          mult_recp << Actor.normalize(demo)
+        end
+        actor = mult_recp[(rand * mult_recp.size).to_i]
+        mult_recp.delete(actor)
+        mail = actor.send_message(mult_recp, "Hello all, I am #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}", Forgery::LoremIpsum.words(10,:random => true))       
+        actor = mult_recp[(rand * mult_recp.size).to_i]
+        mail = actor.reply_to_all(mail, "Well, I am #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+        actor = mult_recp[(rand * mult_recp.size).to_i]
+        mail = actor.reply_to_all(mail, "Ok, I am #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+        actor = mult_recp[(rand * mult_recp.size).to_i]
+        mail = actor.reply_to_all(mail, "Pretty well, I am #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+        actor = mult_recp[(rand * mult_recp.size).to_i]
+        actor.reply_to_all(mail, "Finally, I am #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")      
+        
+        
+        if (demo = User.find_by_name('demo'))
+          next if Actor.normalize(demo)==Actor.normalize(a) 
+          mail = a.send_message(demo, "Hello, #{demo.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}", Forgery::LoremIpsum.words(10,:random => true))
+          if rand > 0.5
+            mail = demo.reply_to_sender(mail, "Pretty well #{a.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+            if rand > 0.5
+              a.reply_to_sender(mail, "Ok #{demo.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+            end
+          end
+          if rand > 0.75
+            mail.conversation.move_to_trash(demo)
+          end
+        end            
+        
+        Forgery::Basic.number(:at_most => actors.size).times do
+          actor = actors.delete_at((rand * actors.size).to_i)
+          next if Actor.normalize(actor)==Actor.normalize(a) 
+          mail = a.send_message(actor, "Hello, #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}", Forgery::LoremIpsum.words(10,:random => true))
+          if rand > 0.5
+            mail = actor.reply_to_sender(mail, "Pretty well #{a.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+            if rand > 0.5
+              a.reply_to_sender(mail, "Ok #{actor.name}. #{Forgery::LoremIpsum.sentences(2,:random => true)}")
+            end
+          end
+          if rand > 0.75
+            mail.conversation.move_to_trash(actor)
+          end          
+        end
+      end
+      
+      mailboxer_end = Time.now
+      puts '   -> ' +  (mailboxer_end - mailboxer_start).round(4).to_s + 's'
+      
+    end
+  end
+end

data/social_stream-base.gemspec

@@ -0,0 +1,69 @@
+require File.join(File.dirname(__FILE__), 'lib', 'social_stream', 'base', 'version')
+
+Gem::Specification.new do |s|
+  s.name = "social_stream-base"
+  s.version = SocialStream::Base::VERSION.dup
+  s.summary = "Basic features for Social Stream, the core for building social network websites"
+  s.description = "Social Stream is a Ruby on Rails engine providing your application with social networking features and activity streams.\n\nThis gem packages the basic functionality, along with basic actors (user, group) and activity objects(post and comments)"
+  s.authors = [ "GING - DIT - UPM",
+                "CISE - ESPOL" ]
+  s.homepage = "http://social-stream.dit.upm.es/"
+  s.files = `git ls-files`.split("\n")
+
+  # Gem dependencies
+  #
+  # Activity and Relation hierarchies
+  s.add_runtime_dependency('ancestry', '~> 1.2.3')
+  # SQL foreign keys
+  s.add_runtime_dependency('foreigner', '~> 0.9.1')
+  # Authentication
+  s.add_runtime_dependency('devise', '~> 1.2.rc')
+  # CRUD controllers
+  s.add_runtime_dependency('inherited_resources', '~> 1.2.2')
+  # Slug generation
+  s.add_runtime_dependency('stringex', '~> 1.2.0')
+  # Avatar attachments
+  s.add_runtime_dependency('paperclip', '~> 2.3.4')
+  s.add_runtime_dependency('avatars_for_rails', '~> 0.0.9')
+  # jQuery
+  s.add_runtime_dependency('jquery-rails', '~> 0.2.5')
+  # Authorization
+  s.add_runtime_dependency('cancan', '~> 1.6.4')
+  # Pagination
+  s.add_runtime_dependency('will_paginate', '~> 3.0.pre2')
+  # OAuth client
+  s.add_runtime_dependency('omniauth','~> 0.2.6')
+  # OAuth provider
+  s.add_runtime_dependency('oauth-plugin','~> 0.4.0.pre1')	
+  # Theme support
+  s.add_runtime_dependency('rails_css_themes','~> 1.0.0')	
+  # Messages
+  s.add_runtime_dependency('mailboxer','~> 0.1.4')
+  # Avatar manipulation
+  s.add_runtime_dependency('rmagick','~> 2.13.1')
+  # Tagging
+  s.add_runtime_dependency('acts-as-taggable-on','~> 2.0.6')
+  # HTML Forms
+  s.add_runtime_dependency('formtastic','~> 1.2.3')
+ 
+  # Development Gem dependencies
+  s.add_development_dependency('rails', '~> 3.0.7')
+  # Integration testing
+  s.add_development_dependency('capybara', '~> 0.3.9')
+  # Testing database
+  s.add_development_dependency('sqlite3-ruby')
+  # Debugging
+  if RUBY_VERSION < '1.9'
+    s.add_development_dependency('ruby-debug', '~> 0.10.3')
+  end
+  # Specs
+  s.add_development_dependency('rspec-rails', '~> 2.5.0')
+  # Fixtures
+  s.add_development_dependency('factory_girl', '~> 1.3.2')
+  # Population
+  s.add_development_dependency('forgery', '~> 0.3.6')
+  # Continous integration
+  s.add_development_dependency('ci_reporter', '~> 1.6.4')
+  # Scaffold generator
+  s.add_development_dependency('nifty-generators','~> 0.4.5')
+end

data/spec/controllers/comments_controller_spec.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe CommentsController do
+  include SocialStream::TestHelpers::Controllers
+
+  render_views
+
+  describe "authorizing" do
+    before do
+      @user = Factory(:user)
+      sign_in @user
+    end
+
+    describe "comment from user" do
+      before do
+        model_assigned_to @user.sent_ties.received_by(@user).related_by(@user.relation_customs.sort.first).first
+      end
+
+      it_should_behave_like "Allow Creating"
+    end
+
+    describe "comment from friend" do
+      before do
+        f = Factory(:friend, :receiver => @user.actor).sender
+
+        model_assigned_to Factory(:friend, :sender => @user.actor, :receiver => f)
+      end
+
+      it_should_behave_like "Allow Creating"
+    end
+
+    describe "post from acquaintance" do
+      before do
+        a = Factory(:acquaintance, :receiver => @user.actor).sender
+
+        model_assigned_to Factory(:friend, :sender => @user.actor, :receiver => a)
+      end
+
+      it_should_behave_like "Deny Creating"
+    end
+  end
+end

data/spec/controllers/contacts_controller_spec.rb

@@ -0,0 +1,41 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ContactsController do
+
+  render_views
+
+  before do
+    sign_in Factory(:friend).sender_subject
+  end
+
+  describe "GET 'index'" do
+    it "should be successful" do
+      get 'index'
+      response.should be_success
+    end
+  end
+
+  describe "when authenticated" do
+    before do
+      @user = Factory(:user)
+
+      sign_in @user
+    end
+
+    it "should render edit" do
+      get :edit, :id => Factory(:user).actor_id
+
+      assert_response :success
+    end
+
+    it "should render update" do
+      contact = Factory(:user)
+
+      put :update, :id => contact.actor_id,
+                   :contact => { "relation_ids" => [ "gotcha", @user.relations.first.id ] }
+
+      response.should redirect_to(contact)
+      @user.sent_ties.received_by(contact).first.relation.should == @user.relations.first
+    end
+  end
+end

data/spec/controllers/frontpage_controller_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe FrontpageController do
+  render_views
+
+  it "should render index" do
+    get :index
+    assert_response :success
+  end
+
+  it "should render host_meta" do
+    get :host_meta, :format => :all
+    assert_response :success
+  end
+end
+