social_connections 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+*.sqlite3
+*.log
+tmp/
+.*.swp

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [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,25 @@
+SocialConnections
+=================
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+How to run the Tests
+====================
+
+Run test in ./test:
+
+  rake
+
+Run specs in ./spec:
+
+  rspec spec
+
+
+Copyright (c) 2011 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the social_connections plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the social_connections plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SocialConnections'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/db/keep-this-dir.txt

@@ -0,0 +1 @@
+keep this dir so that tests work.

data/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+
+require 'social_connections'

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/mailers/digest_mailer.rb

@@ -0,0 +1,17 @@
+class DigestMailer < ActionMailer::Base
+
+  default :from => 'from@example.com'
+
+  append_view_path(File.dirname(__FILE__) + '../../views')
+
+  def digest(feed, email)
+
+    @feed = feed
+    @email = email
+    mail(:to => @email, :subject => 'Digest') do |format|
+      format.html
+    end
+
+  end
+
+end

data/lib/app/models/social_activity.rb

@@ -0,0 +1,37 @@
+class SocialActivity < ActiveRecord::Base
+
+  belongs_to :owner, :polymorphic => true
+  belongs_to :subject, :polymorphic => true
+  belongs_to :target, :polymorphic => true
+
+  def options
+    JSON.parse options_as_json
+  end
+
+  def self.create_activities(subject, verb, object, options = {})
+    # TODO: we may want to delay this
+    activities = []
+    [ subject, object ].each do |owner| # one activity for the subject, and one for the object
+      activities << SocialActivity.create(:owner => owner,
+                                          :subject => subject,
+                                          :verb => verb,
+                                          :target => object,
+                                          :options_as_json => options.to_json)
+    end
+    [ subject, object ].each do |who| # for both subject and object...
+      who.incoming_social_connections.each do |connection|
+        activities << SocialActivity.create(:owner => connection.source, # ... an activity for each one connected
+                                            :subject => subject,
+                                            :verb => verb,
+                                            :target => object,
+                                            :options_as_json => options.to_json)
+      end
+    end
+    activities
+  end 
+
+  def self.unseen_activities(for_whom)
+    SocialActivity.where('owner_id = ? and owner_type = ? and unseen = ?', for_whom.id, for_whom.class.name, true)
+  end
+
+end

data/lib/app/models/social_connection.rb

@@ -0,0 +1,6 @@
+class SocialConnection < ActiveRecord::Base
+
+  belongs_to :source, :polymorphic => true
+  belongs_to :target, :polymorphic => true
+
+end

data/lib/app/views/digest_mailer/digest.html.erb

@@ -0,0 +1 @@
+<p>Hi, <%= @email %></p>

data/lib/db/migrate/20110516181115_create_social_connections.rb

@@ -0,0 +1,13 @@
+class CreateSocialConnections < ActiveRecord::Migration
+  def self.up
+    create_table :social_connections do |t|
+      t.integer :source_id
+      t.string :source_type
+      t.integer :target_id
+      t.string :target_type
+    end
+  end
+  def self.down
+    drop_table :social_connections
+  end
+end

data/lib/social_connections/acts_as_connectable.rb

@@ -0,0 +1,58 @@
+module SocialConnections
+
+  def self.included(base)
+    base.send :extend, ClassMethods
+  end
+
+  module ClassMethods
+    def acts_as_connectable(options = {})
+      cattr_accessor :acts_as_connectable_options
+      send :acts_as_connectable_options=, options
+      send :include, InstanceMethods
+    end
+  end
+
+  module InstanceMethods
+
+    def outgoing_social_connections
+      SocialConnection.where("source_id = ? and source_type = ?", self.id, self.class.name)
+    end
+
+    def incoming_social_connections
+      SocialConnection.where("target_id = ? and target_type = ?", self.id, self.class.name)
+    end
+
+    def connect_to(other)
+      raise ArgumentError.new("other cannot be nil") if other.nil?
+      c = SocialConnection.new
+      c.target = other
+      c.source = self
+      c
+    end
+
+    def acts_as_connectable_verbs
+      acts_as_connectable_options[:verbs] || [ :likes ]
+    end
+
+    def method_missing(name, *args)
+      if acts_as_connectable_verbs.include? name
+        verb = name
+        object = args[0]
+        options = args[1] || {}
+        create_activity(verb, object, options)
+      else
+        super
+      end
+    end
+
+    private
+
+    def create_activity(verb, object, options = {})
+      SocialActivity.create_activities(self, verb, object, options)
+    end
+
+  end
+
+end
+
+ActiveRecord::Base.send :include, SocialConnections

data/lib/social_connections/social_aggregator.rb

@@ -0,0 +1,14 @@
+module SocialConnections
+
+  class Feed
+    attr_accessor :activities
+    def initialize(activities)
+      self.activities = activities
+    end
+  end
+
+  def self.aggregate(who)
+    Feed.new(SocialActivity.unseen_activities(who))
+  end
+
+end

data/lib/social_connections/version.rb

@@ -0,0 +1,3 @@
+module SocialConnections
+  VERSION = "0.0.1"
+end

data/lib/social_connections.rb

@@ -0,0 +1,12 @@
+# SocialConnections
+
+require 'social_connections/acts_as_connectable'
+require 'social_connections/social_aggregator'
+
+%w{ models mailers }.each do |dir|
+  path = File.join(File.dirname(__FILE__), 'app', dir)
+  $LOAD_PATH << path
+  ActiveSupport::Dependencies.autoload_paths << path
+  ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+end
+

data/lib/tasks/social_connections.rake

@@ -0,0 +1,14 @@
+namespace :db do
+  namespace :migrate do
+    description = "migrate the db in vendor/plugins/social_connections/lib/db/migrate"
+
+    puts "migration?"
+
+    desc description
+    task :social_connections => :environment do
+      ActiveRecord::Migration.verbose = true
+      ActiveRecord::Migrator.migrate("vendor/plugins/social_connections/lib/db/migrate/", ENV['VERSION'] ? ENV['VERSION'].to_i : nil)
+      Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
+    end
+  end
+end

data/social_connections.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "social_connections/version"
+
+Gem::Specification.new do |s|
+  s.name        = "social_connections"
+  s.version     = SocialConnections::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris"]
+  s.email       = ["christian.oloff+gem@gmail.com"]
+  s.homepage    = "https://sites.google.com/site/socialconnections7/"
+  s.summary     = %q{Social connections for ActiveRecord.}
+  s.description = %q{The idea is to provide pluggable social connections, activities and a method to digest those activities (e.g. in daily emails).}
+
+  s.rubyforge_project = "social_connections"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+#  s.test_files.reject! { |fn| fn.include? ".swp" }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/activities_aggregator_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/../test/test_helper'
+
+describe "Aggregation" do
+
+  before(:each) do
+    load_schema
+    @tim = Connectable.create(:name => 'Tim', :email => 'tim@test.com')
+    @tom = Connectable.create(:name => 'Tom', :email => 'tom@test.com')
+  end
+
+  it "aggregates activities into feeds for specific users" do
+    @tim.likes(@tom)
+    @tim.comments(@tom, :comment => "This is cool")
+    feed_tim = SocialConnections.aggregate(@tim)
+    feed_tim.activities.count.should be_>(1)
+    feed_tim.activities.each {|a| puts "For Tim: #{a.subject} #{a.verb} #{a.target}, options=#{a.options}"}
+    feed_tom = SocialConnections.aggregate(@tom)
+    feed_tom.activities.each {|a| puts "For Tom: #{a.subject} #{a.verb} #{a.target}, options=#{a.options}"}
+    feed_tom.activities.count.should be_>(1)
+  end
+
+  describe DigestMailer do
+
+    before(:each) do
+      @tim.likes(@tom)
+      @tim.comments(@tom, :comment => "This is boring...")
+      @feed_tim = SocialConnections.aggregate(@tim)
+      @mail = DigestMailer.digest(@feed_tim, @tim.email)
+    end
+
+    it "delivers an email which references all unseen activities ..." do
+      @mail.subject.should eq("Digest")
+      @mail.to.should eq(["tim@test.com"])
+      @mail.from.should eq(["from@example.com"])
+      @mail.body.encoded.should match("Hi")
+      pending
+    end
+
+  end
+
+end

data/spec/social_activities_spec.rb

@@ -0,0 +1,67 @@
+require File.dirname(__FILE__) + '/../test/test_helper'
+
+describe "Subjects" do
+
+  before(:each) do
+    load_schema
+    @sub = Connectable.create(:name => 'Tim')
+    @obj = Connectable.create(:name => 'Tom')
+  end
+
+  it "can emit activities" do
+    activities = @sub.likes(@obj) # what about the 'owner'? everybody 'connected' to the subject *and*
+    # the object becomes an owner!
+    activities.should_not be_nil
+    activities[0].verb.should eql(:likes) 
+  end
+
+  it "allows the verbs given, but no other verbs" do
+    @sub.likes(@obj)
+    @sub.recommends(@obj)
+    lambda { @sub.suggests(@obj) }.should raise_error
+  end
+
+  it "allows options on activities (e.g. a comment)" do
+    activities = @sub.comments(@obj, :comment => 'This is a silly comment on Tom')
+    activities[0].options['comment'].should eql('This is a silly comment on Tom')
+  end
+
+  it "creates an activity for both subject and object" do
+    activities = @sub.likes(@obj)
+    activities.select {|a| a.owner == @sub}.should_not be_empty # one activity owned by the subject
+    activities.select {|a| a.owner == @obj}.should_not be_empty # ... and one owned by the object
+  end
+
+  it "creates activities for those connected to the subject" do
+    mary = Connectable.create(:name => 'Mary')
+    mary.connect_to(@sub).save # mary is now connected to Tim
+    activities = @sub.likes(@obj)
+    activities.select {|a| a.owner == mary}.should_not be_empty # Mary gets an activity, because she's connected to Tim
+  end
+
+  it "does *not* create activities for those the subject is connected to" do
+    mary = Connectable.create(:name => 'Mary')
+    @sub.connect_to(mary).save # Tim is now connected to Mary
+    activities = @sub.likes(@obj)
+    # Mary does not get an activity,
+    # because she's *not* connected to Tim (Tim is connected to Mary, though)
+    activities.select {|a| a.owner == mary}.should be_empty
+  end
+
+  it "creates activities for those connected to the object" do
+    anne = Connectable.create(:name => 'Anne')
+    anne.connect_to(@obj).save
+    activities = @sub.likes(@obj)
+    # Anne gets an activity
+    activities.select {|a| a.owner == anne}.should_not be_empty
+  end
+
+  it "does *not* create an activity for those the subject is connected to" do
+    anne = Connectable.create(:name => 'Anne')
+    @obj.connect_to(anne).save
+    activities = @sub.likes(@obj)
+    # Anne does not get an activity
+    activities.select {|a| a.owner == anne}.should be_empty
+  end
+
+end

data/test/activities_test.rb

@@ -0,0 +1,9 @@
+# subject, verb, object
+# both subject and object are 'acts_as_connectable'
+# examples:
+# - tim likes idea x
+# - tom comments "this is awesome" on idea y
+# - ben bought deal "25% off on xyz"
+#
+# how to indicate that someone has seen an activity already?
+# by having "owner, subject, verb, object", there could be a flag on the activity?

data/test/acts_as_connectable_test.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ActsAsConnectableTest < ActiveSupport::TestCase
+
+  load_schema
+
+  def setup
+    @connectable1 = Connectable.create(:name => 'Anne')
+    @connectable2 = Connectable.create(:name => 'Bob')
+  end
+
+  test "should define collection accessors" do
+    c = Connectable.create(:name => 'Tim', :email => '2@test.com')
+    assert c.respond_to?(:outgoing_social_connections) == true, "does not respond to outgoing connections getter."
+    assert c.respond_to?(:incoming_social_connections) == true, "does not respond to incoming connections getter."
+    # etc.
+  end
+
+  test "should not allow nil as 'other'" do
+    assert_raise ArgumentError do
+      @connectable1.connect_to(nil)
+    end
+  end
+
+  test "should allow adding connections" do
+    @connectable1.connect_to(@connectable2).save
+    assert @connectable1.outgoing_social_connections.count == 1
+    assert @connectable1.incoming_social_connections.count == 0
+    assert @connectable2.outgoing_social_connections.count == 0
+    assert @connectable2.incoming_social_connections.count == 1
+  end
+
+end

data/test/database.yml

@@ -0,0 +1,4 @@
+sqlite3:
+  :adapter: sqlite3
+  # :dbfile: vendor/plugins/social_connections/test/social_connections_plugin.sqlite3.db
+  :database: db/social_connections_plugin.sqlite3