social_connections 0.0.6 → 0.0.7

data/.gitignore

@@ -6,3 +6,4 @@ test/debug.log
 tmp/
 .*.swp
 social_connections*.gem
+.rvmrc

data/Gemfile.lock

@@ -0,0 +1,14 @@
+PATH
+  remote: .
+  specs:
+    social_connections (0.0.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  social_connections!

data/{README → README.md}

@@ -1,4 +1,5 @@
-= SocialConnections
+SocialConnections
+=================
 
 Enables
 
@@ -9,59 +10,64 @@ Enables
 This gem is work in progress and my playground, and currently my playground, don't use it!
 
 
-== Setup
+Setup
+-----
 
 Install as a gem
 
-  gem install social_connections
+	gem install social_connections
 
 or reference in your Gemfile
 
-  gem 'social_connections'
+	gem 'social_connections'
 
 and run
 
-  bundle install
+	bundle install
 
 
-Next, you need to add the migration. This works currently by executing
+Next, you need to add the migration by using the install generator of the gem:
 
-  rake db:migrate:social_connections
+	rails g social_connections:install
 
-which adds the required tables.
+which adds the required migration(s). Doing a migration
+will generate the required tables:
+
+	rake db:migrate
 
 Now, every model that is supposed to act as a connectable thing (so that friends can connect
 other friend or users can like books, or similar), add to all those models
 
-  acts_as_connectable :verbs => [ :likes, :recommends, :comments ]
+	acts_as_connectable :verbs => [ :likes, :recommends, :comments ]
 
 where the verbs specify what you want to allow those connectables to do to other connectables.
 See the example below, that may make it clearer.
 
-== Example
+Example
+-------
 
 Users can like books, and they can comment on books.
 
 Enable model User to be connected to other users and things (books, in this example):
 
-  acts_as_connectable :verbs => [ :likes, :comments ]
+	acts_as_connectable :verbs => [ :likes, :comments ]
 
 Given a user `u` and a book `b`, you can now say
 
-  u.likes(b)
+	u.likes(b)
 
 and
 
-  u.comments(b, :comment => 'awesome book!')
+	u.comments(b, :comment => 'awesome book!')
 
 . This creates activities for the user and the book. These activities can be
 queried:
 
-  b.likes_by_count
+	b.likes_by_count
 
 Gives the number of users (or other 'connectables') that liked this book. Same for
 
-  b.comments_by_count
+	b.comments_by_count
 
 . For more examples, see the spec files.
 
@@ -71,31 +77,30 @@ Gives the number of users (or other 'connectables') that liked this book. Same f
 Assuming that `current_user` gives you the currently logged in user, a controller
 responding to a 'like' button could look as follows:
 
-  class CurrentUserLikesController < ApplicationController
-    def likes_book
-      @book = Book.find(params[:id])
-      current_user.likes(@book) unless current_user.likes?(@book)
-    end
-  end
+	  class CurrentUserLikesController < ApplicationController
+	    def likes_book
+	      @book = Book.find(params[:id])
+	      current_user.likes(@book) unless current_user.likes?(@book)
+	    end
+	  end
 
 A route in config/routes.rb might then look as follows:
 
-  match '/current_user_likes_book/:id' => 'current_user_likes#likes_book', :as => :current_user_likes_book
+	match '/current_user_likes_book/:id' => 'current_user_likes#likes_book', :as => :current_user_likes_book
 
 The view (e.g. `app/views/books/show.html.erb`) may then contain the following 'like' button:
 
-  <%= link_to('I like this', current_user_likes_book_path(@book) %>
+	<%= link_to('I like this', current_user_likes_book_path(@book) %>
 
 
 == How to run the Tests (in the gem itself, not in your Rails app)
 
 Run test in ./test:
 
-  rake
+	rake
 
 Run specs in ./spec:
 
-  rspec spec
-
+	rspec spec
 
 Copyright (c) 2011 Chris Oloff, released under the MIT license

data/lib/app/models/social_activity.rb

@@ -8,6 +8,15 @@ class SocialActivity < ActiveRecord::Base
     JSON.parse options_as_json
   end
 
+  def to_s
+    "SocialActivity #{subject} #{verb} #{target} (owned by #{owner})"
+  end
+
+  def consume
+    self.unseen = false
+    self.save
+  end
+
   def self.create_activities(subject, verb, object, options = {})
     # TODO: we may want to delay this
     activities = []
@@ -31,17 +40,23 @@ class SocialActivity < ActiveRecord::Base
   end 
 
   def self.unseen_activities(for_whom)
-    SocialActivity.where('owner_id = ? and owner_type = ? and unseen = ?', for_whom.id, for_whom.class.name, true)
+    SocialActivity.where('owner_id = ? and owner_type = ? and unseen = ?',
+                         for_whom.id, for_whom.class.name,
+                         true).order("created_at DESC")
   end
 
   def self.exists(subject, verb, object)
-    SocialActivity.where('subject_id = ? and subject_type = ? and verb = ? and target_id = ? and target_type = ?',
-                        subject.id, subject.class.name, verb, object.id, object.class.name).exists?
+    SocialActivity.where('subject_id = ? and subject_type = ? and verb = ? ' +
+                         'and target_id = ? and target_type = ?',
+                         subject.id, subject.class.name, verb, object.id,
+                         object.class.name).exists?
   end
 
   def self.objects_by_verb_count(object, verb)
-    SocialActivity.where('target_id = ? and target_type = ? and verb = ? and owner_id = ? and owner_type = ?',
-                         object.id, object.class.name, verb, object.id, object.class.name).count
+    SocialActivity.where('target_id = ? and target_type = ? and verb = ? ' +
+                         'and owner_id = ? and owner_type = ?',
+                         object.id, object.class.name, verb, object.id,
+                         object.class.name).count
   end
 
 end

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

@@ -1 +1,27 @@
-<p>Hi, <%= @email %></p>
+<p>Note: This view serves as an example only, please set up your own
+view at app/views/digest_mailer/digest.html.erb</p>
+
+<p>Hi, <%= @feed.who %></p>
+
+<p>You have got <%= pluralize @feed.activities.count, 'activity' %> in total,
+and 
+<%= pluralize @feed.excluding_self.activities.count, 'activity' %> excluding your own activities.</p>
+
+<% @feed.excluding_self.by_verb.keys.each do |verb| %>
+  <p>All the <%= verb.to_s %> of those you are connected with:</p>
+  <ul>
+    <% @feed.excluding_self.by_verb[verb].each do |a| %>
+      <li><%= a.to_s %></li>
+    <% end %>
+  </ul>
+<% end %>
+
+<p>All activities, including your own ones:</p>
+<ul>
+  <% @feed.activities.each do |a| %>
+    <li><%= a.to_s %>, <%= time_ago_in_words a.created_at %> ago</li>
+  <% end %>
+</ul>
+
+<p>That's all for now...</p>
+

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

@@ -1,10 +1,12 @@
 class CreateSocialConnections < ActiveRecord::Migration
   def self.up
+    puts "Warning: Migrating via rake is deprecated for social_connections, use 'rails g social_connections:install' instead"
     create_table :social_connections do |t|
       t.integer :source_id
       t.string :source_type
       t.integer :target_id
       t.string :target_type
+      t.timestamps
     end
     create_table :social_activities do |t|
       t.integer :owner_id
@@ -16,6 +18,7 @@ class CreateSocialConnections < ActiveRecord::Migration
       t.string :verb
       t.text :options_as_json
       t.boolean :unseen, :default => true
+      t.timestamps
     end
   end
   def self.down

data/lib/generators/social_connections/install/install_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/migration'
+
+module SocialConnections
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add the migrations"
+
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
+      end
+
+      def copy_migrations
+        migration_template "create_social_connections_tables.rb", "db/migrate/create_social_connections.rb"
+      end
+
+    end
+  end
+end

data/lib/generators/social_connections/install/templates/create_social_connections_tables.rb

@@ -0,0 +1,27 @@
+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
+      t.timestamps
+    end
+    create_table :social_activities do |t|
+      t.integer :owner_id
+      t.string :owner_type
+      t.integer :subject_id
+      t.string :subject_type
+      t.integer :target_id
+      t.string :target_type
+      t.string :verb
+      t.text :options_as_json
+      t.boolean :unseen, :default => true
+      t.timestamps
+    end
+  end
+  def self.down
+    drop_table :social_connections
+    drop_table :social_activities
+  end
+end

data/lib/social_connections/acts_as_connectable.rb

@@ -31,9 +31,15 @@ module SocialConnections
       c = SocialConnection.new
       c.target = other
       c.source = self
+      c.save
       c
     end
 
+    def connected_to?(other)
+      SocialConnection.where("source_id = ? and source_type = ? and target_id = ? and target_type = ?",
+                             self.id, self.class.name, other.id, other.class.name).exists?
+    end
+
     def acts_as_connectable_verbs
       acts_as_connectable_options[:verbs] || [ :likes ]
     end
@@ -43,7 +49,6 @@ module SocialConnections
     end
 
     def method_missing(name, *args)
-      puts "BLABLA"
       if acts_as_connectable_verbs.include? name
         verb = name
         object = args[0]

data/lib/social_connections/social_aggregator.rb

@@ -1,14 +1,37 @@
 module SocialConnections
 
-  class Feed
-    attr_accessor :activities
+  class AggregatedActivities
+    attr_accessor :activities, :by_verb
     def initialize(activities)
       self.activities = activities
+      self.by_verb = activities_by_verb(activities)
+    end
+
+    private
+
+    def activities_by_verb(activities)
+      by_verb = {}
+      activities.collect {|a| a.verb }.uniq.each do |verb| 
+        by_verb[verb.to_sym] = activities.select {|b| b.verb == verb }
+      end
+      by_verb
+    end
+
+  end
+
+  class Feed
+    attr_accessor :who, :activities, :by_verb, :excluding_self
+    def initialize(who)
+      self.who = who
+      self.activities = SocialActivity.unseen_activities(who)
+      aggreg = AggregatedActivities.new(activities)
+      self.by_verb = aggreg.by_verb
+      self.excluding_self = AggregatedActivities.new( activities.select {|a| a.subject != who} )
     end
   end
 
   def self.aggregate(who)
-    Feed.new(SocialActivity.unseen_activities(who))
+    Feed.new(who)
   end
 
 end

data/lib/social_connections/version.rb

@@ -1,3 +1,3 @@
 module SocialConnections
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/social_connections.rb

@@ -3,7 +3,7 @@
 require 'social_connections/acts_as_connectable'
 require 'social_connections/social_aggregator'
 
-unless ENV['TEST'] = 'TRUE'
+unless ENV['TEST'] == 'TRUE'
   class SocialConnectionsTasks < Rails::Railtie
     rake_tasks do
       Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }

data/lib/tasks/social_connections.rake

@@ -6,6 +6,7 @@ namespace :db do
     task :social_connections => :environment do
       ActiveRecord::Migration.verbose = true
       ActiveRecord::Migrator.migrate(File.join(File.dirname(__FILE__), '../db/migrate/'), ENV['VERSION'] ? ENV['VERSION'].to_i : nil)
+      ActiveSupport::Deprecation.warn "Migration via rake is deprecated, use 'rails generate social_connections:install' instead." # mhm, this doesn't display when migrating...
       Rake::Task["db:schema:dump"].invoke if ActiveRecord::Base.schema_format == :ruby
     end
   end

data/run-tests.sh

@@ -0,0 +1,6 @@
+#!/bin/bash -ex
+
+# Idea is to run all automated tests from a single script
+
+rake test
+rspec spec -f d

data/spec/activities_aggregator_spec.rb

@@ -13,27 +13,53 @@ describe "Aggregation" do
     @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 "When Tim and Tom interacted" do
+
+    before(:each) do
+      @tim.likes(@tom)
+      @tim.comments(@tom, :comment => "Got news for you")
+      @tom.comments(@tim, :comment => "What news?")
+    end
+
+    it "aggregates unseen activities only" do
+      feed_tim = SocialConnections.aggregate(@tim)
+      feed_tim.activities.count.should be_>(1)
+      feed_tim.activities.each { |a| a.consume }
+      SocialConnections.aggregate(@tim).activities.count.should be(0)
+      SocialConnections.aggregate(@tom).activities.count.should be_>(0)
+    end
+
+  end
+
   describe DigestMailer do
 
     before(:each) do
       @tim.likes(@tom)
       @tim.comments(@tom, :comment => "This is boring...")
+      @tom.comments(@tim, :comment => "Maybe boring, but it documents this gem :)")
       @feed_tim = SocialConnections.aggregate(@tim)
-      @mail = DigestMailer.digest(@feed_tim, @tim.email)
+      @mail = DigestMailer.digest(@feed_tim, @tim.email).deliver
+    end
+
+    it "determines activities and activities by verb" do
+      @feed_tim.activities.count.should eql(3)
+      @feed_tim.by_verb.should_not eql(nil)
+      @feed_tim.by_verb[:comments].count.should eql(2)
+      @feed_tim.by_verb[:likes].count.should eql(1)
+      @feed_tim.by_verb[:recommends].blank?.should be(true)
+      @feed_tim.excluding_self.by_verb[:comments].count.should eql(1)
+      @feed_tim.excluding_self.by_verb[:likes].blank?.should be(true)
     end
 
-    it "delivers an email which references all unseen activities ..." do
+    it "delivers an email" 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

data/spec/social_activities_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/../test/test_helper'
 
-describe "Subjects" do
+describe "Social Activities" do
 
   before(:each) do
     load_schema
@@ -8,71 +8,75 @@ describe "Subjects" do
     @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
+  describe "Subjects" do
 
-  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 "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 "knows if subject/verb/object occured before" do
-    @sub.likes @obj
-    @sub.likes?(@obj).should be_true
-    @sub.recommends?(@obj).should be_false
-    @sub.recommends @obj
-    @sub.recommends?(@obj).should be_true
-  end
+    it "allow the verbs given, but no other verbs" do
+      @sub.likes(@obj)
+      @sub.recommends(@obj)
+      lambda { @sub.suggests(@obj) }.should raise_error
+    end
+
+    it "know if subject/verb/object occured before" do
+      @sub.likes @obj
+      @sub.likes?(@obj).should be_true
+      @sub.recommends?(@obj).should be_false
+      @sub.recommends @obj
+      @sub.recommends?(@obj).should be_true
+    end
+
+    it "count by how many an object is liked by (or any other verb)" do
+      @obj.likes_by_count.should eql(0)
+      @sub.likes @obj
+      @obj.likes_by_count.should eql(1)
+    end
 
-  it "counts by how many an object is liked by (or any other verb)" do
-    @obj.likes_by_count.should eql(0)
-    @sub.likes @obj
-    @obj.likes_by_count.should eql(1)
   end
 
-  it "allows options on activities (e.g. a comment)" do
+  it "allow 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
+  it "create 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
+  it "create activities for those connected to the subject" do
     mary = Connectable.create(:name => 'Mary')
-    mary.connect_to(@sub).save # mary is now connected to Tim
+    mary.connect_to(@sub) # 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
+  it "do *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
+    @sub.connect_to(mary) # 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
+  it "create activities for those connected to the object" do
     anne = Connectable.create(:name => 'Anne')
-    anne.connect_to(@obj).save
+    anne.connect_to(@obj)
     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
+  it "do *not* create an activity for those the subject is connected to" do
     anne = Connectable.create(:name => 'Anne')
-    @obj.connect_to(anne).save
+    @obj.connect_to(anne)
     activities = @sub.likes(@obj)
     # Anne does not get an activity
     activities.select {|a| a.owner == anne}.should be_empty

data/test/acts_as_connectable_test.rb

@@ -23,7 +23,9 @@ class ActsAsConnectableTest < ActiveSupport::TestCase
   end
 
   test "should allow adding connections" do
-    @connectable1.connect_to(@connectable2).save
+    assert @connectable1.connected_to?(@connectable2) == false
+    @connectable1.connect_to(@connectable2)
+    assert @connectable1.connected_to?(@connectable2) == true
     assert @connectable1.outgoing_social_connections.count == 1
     assert @connectable1.incoming_social_connections.count == 0
     assert @connectable2.outgoing_social_connections.count == 0

data/test/schema.rb

@@ -1,9 +1,11 @@
 ActiveRecord::Schema.define(:version => 0) do
+  # TODO: not DRY: Same in lib/generators/social_connections/install/templates/
   create_table :social_connections, :force => true do |t|
     t.integer :source_id
     t.string :source_type
     t.integer :target_id
     t.string :target_type
+    t.timestamps
   end
   create_table :social_activities, :force => true do |t|
     t.integer :owner_id
@@ -15,6 +17,7 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string :verb
     t.text :options_as_json
     t.boolean :unseen, :default => true
+    t.timestamps
   end
 
   # the 'connectables' table is for the tests

data/test/test_helper.rb

@@ -42,7 +42,22 @@ def load_schema
     raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
   end
 
-  ActiveRecord::Base.establish_connection(config[db_adapter])
-  load(File.dirname(__FILE__) + "/schema.rb")
+  # helper needed here only
+  def capture_stdout &block
+    real_out, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = real_out
+  end
+
+  capture_stdout do # we ignore stdout for this, it pollutes the output
+    ActiveRecord::Base.establish_connection(config[db_adapter])
+    load(File.dirname(__FILE__) + "/schema.rb")
+  end
+
 end
 
+ActionMailer::Base.delivery_method = :file
+ActionMailer::Base.file_settings = { :location => 'tmp/mails' }
+ActionMailer::Base.raise_delivery_errors = true

metadata

@@ -2,7 +2,7 @@
 name: social_connections
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Chris
@@ -10,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-26 00:00:00 +02:00
-default_executable: 
+date: 2011-08-16 00:00:00 Z
 dependencies: []
 
 description: The idea is to provide pluggable social connections, activities and a method to digest those activities (e.g. in daily emails).
@@ -27,8 +26,9 @@ files:
 - .gitignore
 - .yardopts
 - Gemfile
+- Gemfile.lock
 - MIT-LICENSE
-- README
+- README.md
 - Rakefile
 - db/keep-this-dir.txt
 - init.rb
@@ -38,11 +38,14 @@ files:
 - lib/app/models/social_connection.rb
 - lib/app/views/digest_mailer/digest.html.erb
 - lib/db/migrate/20110516181115_create_social_connections.rb
+- lib/generators/social_connections/install/install_generator.rb
+- lib/generators/social_connections/install/templates/create_social_connections_tables.rb
 - lib/social_connections.rb
 - lib/social_connections/acts_as_connectable.rb
 - lib/social_connections/social_aggregator.rb
 - lib/social_connections/version.rb
 - lib/tasks/social_connections.rake
+- run-tests.sh
 - social_connections.gemspec
 - spec/activities_aggregator_spec.rb
 - spec/social_activities_spec.rb
@@ -53,7 +56,6 @@ files:
 - test/social_connection_test.rb
 - test/test_helper.rb
 - uninstall.rb
-has_rdoc: true
 homepage: https://sites.google.com/site/socialconnections7/
 licenses: []
 
@@ -77,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: social_connections
-rubygems_version: 1.6.1
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Social connections for ActiveRecord.