social_stream 0.0.1

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.0"
+gem "capybara", ">= 0.3.9"
+gem "sqlite3-ruby", :require => "sqlite3"
+
+if RUBY_VERSION < '1.9'
+  gem "ruby-debug", ">= 0.10.3"
+end
+
+gem 'atd-ancestry', :require => 'ancestry'
+gem 'cancan'
+
+gem "rspec-rails", ">= 2.0.0.beta"
+gem "factory_girl"
+

data/Gemfile.lock

@@ -0,0 +1,117 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    atd-ancestry (1.3.0)
+    builder (2.1.2)
+    cancan (1.3.4)
+    capybara (0.3.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.3)
+    columnize (0.3.1)
+    culerity (0.2.12)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    factory_girl (1.3.2)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    i18n (0.4.1)
+    json_pure (1.4.6)
+    linecache (0.43)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+    rspec-rails (2.0.0.beta.20)
+      rspec (= 2.0.0.beta.20)
+    ruby-debug (0.10.3)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.3.0)
+    ruby-debug-base (0.10.3)
+      linecache (>= 0.3)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.0.28)
+      ffi (>= 0.6.1)
+      json_pure
+      rubyzip
+    sqlite3-ruby (1.3.1)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  atd-ancestry
+  cancan
+  capybara (>= 0.3.9)
+  factory_girl
+  rails (= 3.0.0)
+  rspec-rails (>= 2.0.0.beta)
+  ruby-debug (>= 0.10.3)
+  sqlite3-ruby

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Universidad Politécnica de Madrid
+
+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.rdoc

@@ -0,0 +1,63 @@
+= Social Stream
+Social Stream is a plugin for Ruby on Rails. It provides your application with social networking
+features and activity streams.
+
+== Social networking
+Social networks are a new paradigm on web application design. Social networking platforms stand 
+among the most popular websites, while many content oriented applications are supporting social
+networking features in order to improve engagement, enhance user awareness and stimulate communities
+around the website.
+
+{Social Stream}[http://github.com/ging/social_stream] is based in
+{Social Network Analysis}[http://en.wikipedia.org/wiki/Social_network] concepts and methods,
+including social entities (actors), ties and relations.
+It also provides a new tie-based access control model.
+
+== Activity Streams
+{Activity Streams}[http://activitystrea.ms/] is a format for syndicating social activities around the web. It has already been adopted by some of the major social networking platforms.
+
+{Social Stream}[http://github.com/ging/social_stream] provides a database schema based on the
+{Activity Streams specification}[http://activitystrea.ms/head/activity-schema.html], leading your
+application towards a well-known compatible data model design.
+
+= Installation
+
+Add to your Gemfile:
+
+  gem 'social_stream'
+
+and run:
+
+  bundle update
+
+Then, execute:
+
+  rails generate social_stream:install
+
+This will generate the following:
+* A migration providing the database schema
+* An initializer configuration file for Social Stream.
+* A database seeds file for defining Social Stream relations. You must add:
+    SocialStream.seed!
+  to your db/seeds.rb
+* A devise:install generation for authentication support
+
+== Actors and Activity Objects
+
+{Social Stream}[http://github.com/ging/social_stream] relies in Devise[http://github.com/plataformatec/devise].
+
+You must include an <tt>actor_id</tt> column in the user's migration. Then add user to
+<tt>config/initializers/social_stream.rb</tt>
+
+You must do the same with Activity Objects, like posts, comments or photos. Don't forget to add
+a <tt>activity_object_id</tt> column in the migration and add them to the initializer.
+
+= Documentation
+
+{Social Stream documentation}[http://rdoc.info/github/ging/social_stream/frames] is available at
+{rdoc.info}[http://rdoc.info/]
+
+= Discussion
+
+It is at an early stage of development.
+Feel free to add an issue or send a message at github[http://github.com/ging/social_stream].

data/Rakefile

@@ -0,0 +1,43 @@
+# encoding: UTF-8
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+require File.join(File.dirname(__FILE__), 'lib', 'social_stream', 'version')
+
+
+Rspec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ["--color"]
+end
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SocialStream'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'app/**/*.rb')
+end
+
+spec = Gem::Specification.new do |s|
+  s.name = "social_stream"
+  s.version = SocialStream::VERSION.dup
+  s.summary = "Social networking features and activity streams."
+  s.description = "Ruby on Rails plug-in supporting social networking features and activity streams."
+  s.authors = ['Antonio Tapiador', 'Diego Carrera']
+  s.files =  FileList["[A-Z]*", "{app,config,lib}/**/*"]
+  s.add_dependency('atd-ancestry', '~> 1.3.0')
+  s.add_dependency('devise', '~> 1.1.3')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+end
+
+desc "Install the gem #{spec.name}-#{spec.version}.gem"
+task :install => :gem do
+  system("sudo gem install pkg/#{spec.name}-#{spec.version}.gem --no-ri --no-rdoc")
+end

data/app/controllers/home_controller.rb

@@ -0,0 +1,3 @@
+class HomeController < ApplicationController
+  before_filter :authenticate_user!
+end

data/app/helpers/activities_helper.rb

@@ -0,0 +1,10 @@
+module ActivitiesHelper
+
+  def like_activity(activity)
+    if (activity.liked_by?(current_user))
+      link_to t('activity.unlike'), activity_like_path(activity), :method => :delete, :remote => true
+    else
+      link_to t('activity.like'), activity_like_path(activity), :method => :post, :remote => true
+    end
+  end
+end

data/app/models/activity.rb

@@ -0,0 +1,75 @@
+# Activities follow the {Activity Streams}[http://activitystrea.ms/] standard.
+#
+# == Activities and Ties
+# Every activity is attached to a Tie, which defines the sender, the receiver and
+# the relation in which the activity is transferred
+#
+# == Wall
+# The Activity.wall(ties) scope provides all the activities attached to a set of ties
+#
+class Activity < ActiveRecord::Base
+  has_ancestry
+
+  belongs_to :activity_verb
+
+  belongs_to :tie,
+             :include => [ :sender ]
+
+  has_one :sender,
+          :through => :tie
+  has_one :receiver,
+          :through => :tie
+  has_one :relation,
+          :through => :tie
+
+  delegate :sender_subject,
+           :receiver_subject,
+           :to => :tie
+
+  has_many :activity_object_activities,
+           :dependent => :destroy
+  has_many :activity_objects,
+           :through => :activity_object_activities
+
+  scope :wall, lambda { |ties|
+    select("DISTINCT activities.*").
+      roots.
+      where(:tie_id => ties).
+      order("created_at desc")
+  }
+
+  # The name of the verb of this activity
+  def verb
+    activity_verb.name
+  end
+
+  # Set the name of the verb of this activity
+  def verb=(name)
+    self.activity_verb = ActivityVerb[name]
+  end
+
+  # The comments about this activity
+  def comments
+    children.includes(:activity_objects).where('activity_objects.object_type' => "Comment")
+  end
+
+  # The 'like' qualifications emmited to this activities
+  def likes
+    children.joins(:activity_verb).where('activity_verbs.name' => "like")
+  end
+
+  def liked_by(user) #:nodoc:
+    likes.includes(:tie) & Tie.sent_by(user)
+  end
+
+  # Does user like this activity?
+  def liked_by?(user)
+    liked_by(user).present?
+  end
+
+  # The first object of this activity
+  def direct_object
+    activity_objects.first.try(:object)
+  end
+
+end

data/app/models/activity_object.rb

@@ -0,0 +1,18 @@
+class ActivityObject < ActiveRecord::Base
+  include SocialStream::Models::Supertype
+
+  has_many :activity_object_activities, :dependent => :destroy
+  has_many :activities, :through => :activity_object_activities
+  has_one  :actor
+
+  # The object of this activity object
+  def object
+    subtype_instance ||
+      actor.try(:subject)
+  end
+
+  # The activity in which this activity_object was created
+  def post_activity
+    activities.includes(:activity_verb).where('activity_verbs.name' => 'post').first
+  end
+end

data/app/models/activity_object_activity.rb

@@ -0,0 +1,4 @@
+class ActivityObjectActivity < ActiveRecord::Base
+  belongs_to :activity, :dependent => :destroy
+  belongs_to :activity_object
+end

data/app/models/activity_verb.rb

@@ -0,0 +1,14 @@
+class ActivityVerb < ActiveRecord::Base
+  # Activity Strems verbs
+  Available = %w( post update like )
+
+  validates_uniqueness_of :name
+
+  has_many :activities
+
+  class << self
+    def [] name
+      find_by_name(name)
+    end
+  end
+end

data/app/models/actor.rb

@@ -0,0 +1,31 @@
+# An actor is a social entity. This includes individuals, but also groups, departments, organizations even nations or states. Actors are linked by ties.
+class Actor < ActiveRecord::Base
+  include SocialStream::Models::Supertype
+
+  has_many :sent_ties,
+           :class_name => "Tie",
+           :foreign_key => 'sender_id',
+           :dependent => :destroy
+
+  has_many :received_ties,
+           :class_name => "Tie",
+           :foreign_key => 'receiver_id',
+           :dependent => :destroy
+
+  # The subject instance for this actor
+  def subject
+    subtype_instance ||
+      activity_object.try(:object)
+  end
+
+  # All the ties sent or received by this actor
+  def ties
+    Tie.sent_or_received_by(self)
+  end
+
+  # The set of activities in the wall of this actor
+  # TODO: authorization
+  def wall
+    Activity.wall ties
+  end
+end

data/app/models/permission.rb

@@ -0,0 +1,4 @@
+class Permission < ActiveRecord::Base
+  has_many :relation_permissions, :dependent => :destroy
+  has_many :relations, :through => :relation_permissions
+end

data/app/models/relation.rb

@@ -0,0 +1,73 @@
+# A Relation defines a type of Tie. Relations are affective (friendship, liking, 
+# respect), formal or biological (authority, kinship), transfer of material 
+# resources (transactions, lending and borrowing), messages or conversations, 
+# physical connection and affiliation to same organizations.
+#
+# == Strength hierarchies
+# Relations are arranged in strength hierarchies, denoting that some ties between
+# two actors are stronger than others.
+# When a strong tie is established, ties with weaker relations are establised as well
+#
+# == Inverse relations
+# A Relation can have its inverse. When a tie is established, an inverse tie will be
+# established if an inverse relation exists. An example is a relation of friendship,
+# whose inverse relation is itself. When A is friend of B, the inverse tie B is friend of A
+# is establised as well.
+#
+# == Granted relations
+# There are cases when relations need previous invitation or request to be granted.
+# This is the case of friendship requests. When A wants to become friend of B, A
+# sends a friendship_request to B. A is granting the friend relation with B, that is,
+# friendship_request grants friend relation.
+#
+class Relation < ActiveRecord::Base
+  has_ancestry
+
+  scope :mode, lambda { |st, rt|
+    where(:sender_type => st, :receiver_type => rt)
+  }
+
+  belongs_to :inverse,
+             :class_name => "Relation"
+  belongs_to :granted,
+             :class_name => "Relation"
+
+  scope :request, where('relations.granted_id IS NOT NULL')
+
+  has_many :relation_permissions, :dependent => :destroy
+  has_many :permissions, :through => :relation_permissions
+
+  has_many :ties, :dependent => :destroy
+
+  class << self
+    # A relation in the top of a strength hierarchy
+    def strongest
+      roots.first
+    end
+  end
+
+  # Other relations below in the same hierarchy that this relation
+  def weaker
+    descendants
+  end
+
+  # Relations below or at the same level of this relation
+  def weaker_or_equal
+    Array(self) + descendants
+  end
+
+  # Other relations above in the same hierarchy that this relation
+  def stronger
+    ancestors
+  end
+
+  # Relations above or at the same level of this relation
+  def stronger_or_equal
+    ancestors + Array(self)
+  end
+
+  # Relation class scoped in the same mode that this relation
+  def mode
+    Relation.mode(sender_type, receiver_type)
+  end
+end