acts_as_messenger 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mike Nelson
+
+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,65 @@
+= acts_as_messenger
+
+Standard facebook-style messaging system. Not bound to any friendship structure. Integrates directly into your User model. Allows for users to comment on a thread, leave a thread, and be updated when a thread is commented on.
+
+
+== Installation
+
+Install the gem
+
+ gem install acts_as_messenger
+
+Generate the necessary classes and migrations
+
+ script/generate acts_as_messenger
+
+Migrate the DB
+
+ rake db:migrate
+
+Add acts_as_messenger to your user model
+
+ class User < ActiveRecord::Base
+  ...
+  acts_as_messenger
+  ...
+ end
+
+== Usage
+
+With acts_as_messenger now incorporated into your User model, you have access to helper methods for creating messages and recipients. It's as simple as calling the send_message(title, body, recipients) method:
+
+ mike = User.find 4
+ john = User.find 3
+ sky = User.find 2
+
+ thread = mike.send_message('Message Title', 'Message Body', [john, sky])
+  # OR
+ thread = mike.send_message('Message Title', 'Message Body', [3, 2])
+
+The recipients of the message can be an array of AR objects or can be Fixnum's (or any combination). In the case of a Fixnum, the class type is assumed to be the same as the sending class.
+---
+From the thread object you can access the participants of the message directly. Participants are considered as the author of the message and anyone who's commented on the thread.
+
+ thread.participants
+  => [mike]
+
+ john.comment_on(thread, 'Some comment')
+
+ thread.participants
+  => [mike, john]
+
+=== Privacy
+
+All threads have a private_thread field. This allows the can_be_viewed_by? method to be utilized. The can_be_viewed_by? method checks to see if the object is either the author or one of the recipient objects:
+
+ random_user = User.find 490
+ thread.can_be_viewed_by?(random_user)
+  => false
+
+ thread.can_be_viewed_by?(john)
+  => true
+ 
+== Copyright
+
+Copyright (c) 2010 Mike Nelson. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_messenger"
+    gem.summary = "Standard facebook-style messaging system. Not bound to any friendship structure. Integrates directly into your User model."
+    gem.description = "Standard facebook-style messaging system. Not bound to any friendship structure. Integrates directly into your User model. Allows for users to comment on a thread, leave a thread, and be updated when a thread is commented on."
+    gem.email = "mdnelson30@gmail.com"
+    gem.homepage = "http://github.com/mnelson/acts_as_messenger"
+    gem.authors = ["Mike Nelson"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+		gem.add_development_dependency "active_record"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_messenger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/acts_as_messenger.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_messenger}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Nelson"]
+  s.date = %q{2010-02-02}
+  s.description = %q{Standard facebook-style messaging system. Not bound to any friendship structure. Integrates directly into your User model. Allows for users to comment on a thread, leave a thread, and be updated when a thread is commented on.}
+  s.email = %q{mdnelson30@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_messenger.gemspec",
+     "generators/acts_as_messenger/acts_as_messenger_generator.rb",
+     "generators/acts_as_messenger/templates/migrations/create_comments.rb",
+     "generators/acts_as_messenger/templates/migrations/create_message_threads.rb",
+     "generators/acts_as_messenger/templates/migrations/create_recipients.rb",
+     "generators/acts_as_messenger/templates/models/comment.rb",
+     "generators/acts_as_messenger/templates/models/message_thread.rb",
+     "generators/acts_as_messenger/templates/models/recipient.rb",
+     "lib/acts_as_messenger.rb",
+     "lib/acts_as_messenger/thread.rb",
+     "spec/acts_as_messenger_spec.rb",
+     "spec/database.yml",
+     "spec/debug.log",
+     "spec/models/user.rb",
+     "spec/schema.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mnelson/acts_as_messenger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Standard facebook-style messaging system. Not bound to any friendship structure. Integrates directly into your User model.}
+  s.test_files = [
+    "spec/acts_as_messenger_spec.rb",
+     "spec/models/user.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<active_record>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<active_record>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<active_record>, [">= 0"])
+  end
+end
+

data/generators/acts_as_messenger/acts_as_messenger_generator.rb

@@ -0,0 +1,17 @@
+class ActsAsMessengerGenerator < Rails::Generator::Base
+	
+	def manifest 
+		record do |m|
+			
+			%w(comment message_thread recipient).each do |model|
+				m.file "models/#{model}.rb", "app/models/#{model}.rb"
+				m.migration_template "migrations/create_#{model.pluralize}.rb", "db/migrate"
+			end
+			
+		end
+	end
+	
+	def file_name
+		"acts_as_messenger"
+	end
+end

data/generators/acts_as_messenger/templates/migrations/create_comments.rb

@@ -0,0 +1,19 @@
+class CreateComments < ActiveRecord::Migration
+	
+	def self.up
+		create_table :comments do |t|
+			t.references :commentable, :polymorphic => true
+			t.integer :author_id
+			t.text :body
+			t.timestamps
+		end
+		
+		add_index :comments, :author_id
+		add_index :comments, [:commentable_id, :commentable_type]
+	end
+	
+	def self.down
+		drop_table :comments
+	end
+	
+end

data/generators/acts_as_messenger/templates/migrations/create_message_threads.rb

@@ -0,0 +1,19 @@
+class CreateMessageThreads < ActiveRecord::Migration
+	
+	def self.up
+		create_table :message_threads do |t|
+			t.integer :author_id
+			t.string :title
+			t.text :body
+			t.boolean :private_thread, :default => true
+			t.timestamps
+		end
+		
+		add_index :message_threads, :author_id
+	end
+	
+	def self.down
+		drop_table :message_threads
+	end
+	
+end

data/generators/acts_as_messenger/templates/migrations/create_recipients.rb

@@ -0,0 +1,20 @@
+class CreateRecipients < ActiveRecord::Migration
+	
+	def self.up
+		create_table :recipients do |t|
+			t.references :receiver, :polymorphic => true
+			t.references :message_thread
+			t.boolean :has_read
+			t.timestamps
+		end
+		
+		add_index :recipients, :message_thread_id
+		add_index :recipients, [:receiver_id, :receiver_type]
+		
+	end
+	
+	def self.down
+		
+	end
+	
+end

data/generators/acts_as_messenger/templates/models/comment.rb

@@ -0,0 +1,8 @@
+class Comment < ActiveRecord::Base
+	
+	default_scope :order => 'created_at asc'
+	
+	belongs_to :author, :class_name => 'User'
+  belongs_to :commentable, :polymorphic => true
+
+end

data/generators/acts_as_messenger/templates/models/message_thread.rb

@@ -0,0 +1,21 @@
+class MessageThread < ActiveRecord::Base
+	include SocialButterfly::Thread
+	
+	acts_as_thread  
+  has_many :recipients, :dependent => :destroy
+
+	def recipient_by_user(u)
+    self.recipients.by_user(u).first
+  end
+	
+	
+  def can_be_viewed_by?(user)
+    !!(user && (!self.private_thread || self.author == user || self.recipient_objects.include?(user)))
+  end
+
+	protected 
+	
+		def recipient_objects
+			self.recipients.find(:all, :include => :receiver).collect{|r| r.receiver}
+		end
+end

data/generators/acts_as_messenger/templates/models/recipient.rb

@@ -0,0 +1,22 @@
+class Recipient < ActiveRecord::Base
+	
+	
+	belongs_to :receiver, :polymorphic => true
+  belongs_to :message_thread
+
+  default_scope :order => 'has_read ASC, created_at DESC'
+
+  named_scope :by_user, lambda {|u| {:conditions => ['receiver_type = ? and receiver_id = ?', 'User', u.id]}}
+  named_scope :read, :conditions => ['has_read = ?', true]
+  named_scope :unread, :conditions => ['has_read = ?', false]
+
+
+	def read!
+		self.update_attribute(:has_read, true)
+	end
+	
+	def unread!
+		self.update_attribute(:has_read, false)
+	end
+	
+end

data/lib/acts_as_messenger/thread.rb

@@ -0,0 +1,36 @@
+module SocialButterfly
+  module Thread
+    
+    def self.included(model)
+      model.extend(SocialButterfly::Thread::ClassMethods)
+      
+      model.send(:include, SocialButterfly::Thread::InstanceMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_thread
+     
+        validates_presence_of :author
+        validates_inclusion_of :private_thread, :in => [true, false]
+
+        belongs_to :author, :class_name => 'User'
+        has_many :comments, :as => :commentable, :dependent => :destroy
+        has_many :comment_participants, :through => :comments, :source => :author, :uniq => true
+        
+        named_scope :by_user, lambda {|u| u && {:conditions => ['author_id = ?', u.id]} || {}}
+     
+      end
+    end
+    
+    module InstanceMethods
+      def last_post
+        self.comments.last || self
+      end
+      
+      def participants
+        (self.comment_participants + [self.author].compact).uniq
+      end
+  
+    end
+  end
+end

data/lib/acts_as_messenger.rb

@@ -0,0 +1,50 @@
+module SocialButterfly
+  module Message
+    def self.included(model)
+      model.extend(SocialButterfly::Message::ClassMethods)
+      model.send(:include, SocialButterfly::Message::InstanceMethods)
+    end
+    
+    module ClassMethods
+      def acts_as_messenger
+          has_many :recipients, :as => :receiver
+          has_many :unread_recipients, :source => :recipients, :class_name => 'Recipient', :as => :receiver, :conditions => {:read => false}
+          has_many :read_recipients, :source => :recipients, :class_name => 'Recipient', :as => :receiver, :conditions => {:read => true}
+
+          has_many :sent_messages, :class_name => 'MessageThread', :foreign_key => :author_id
+          has_many :unread_messages, :through => :unread_recipients, :source => :message_thread
+          has_many :read_messages, :through => :read_recipients, :source => :message_thread
+      end
+    end
+    
+    module InstanceMethods
+      def send_message(title, body, recips)
+        thread = ::MessageThread.create(:author => self, :title => title, :body => body, :private_thread => true)
+        thread.recipients = [recips].flatten.uniq.collect{|r| rdata = recipient_data(r); thread.recipients.create(:receiver_id => rdata[0], :receiver_type => rdata[1])}
+        thread
+      end
+      def recipient_for(message)
+        self.recipients.find(:first, :conditions => ['message_thread_id = ?', message.id])
+      end
+      
+      def comment_on(message, body)
+        if message && body
+          message.comments.create(:author => self, :body => body)
+          recip = recipient_for(message)
+          (message.recipients - [recip].compact).each{|r| r.unread!}
+          true
+        else
+          false
+        end
+      end
+
+			private 
+			
+				def recipient_data(given)
+					given.is_a?(Fixnum) && [given, self.class.name] || [given.id, given.class.name]
+				end
+    end
+  end
+end
+
+::ActiveRecord::Base.send :include, SocialButterfly::Message

data/spec/acts_as_messenger_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ActsAsMessenger" do
+	
+	before(:each) do 
+		@mike = User.create(:name => 'Mike')
+		@john = User.create(:name => 'John')
+		@sky = User.create(:name => 'Sky')
+	end
+	
+  it "Should integrate flawlessly" do
+		@mike.methods.include?('send_message').should be_true
+		m = @mike.method('send_message')
+		m.arity.should eql(3)
+  end
+
+	it "Should generate a valid thread" do
+		thread = @mike.send_message('Title', 'Body', @john)
+		thread.valid?.should be_true
+	end
+	
+	it "Should generate recipients correctly" do
+		thread = @mike.send_message('Title 1', 'Body 1', @john)
+		
+		thread.recipients.size.should eql(1)
+		@john.recipients.size.should eql(1)
+		@mike.recipients.size.should eql(0)
+		
+		thread = @john.send_message('Title 2', 'Body 2', [@mike.id, @sky.id])
+		
+		thread.recipients.size.should eql(2)
+	
+		@mike.reload
+		@john.reload
+		@sky.reload
+		
+		@mike.recipients.size.should eql(1)
+		@john.recipients.size.should eql(1)
+		@sky.recipients.size.should eql(1)
+		
+	end
+	
+	it "Should allow for removal of recipient from thread" do
+		thread = @mike.send_message('Title 3', 'Body 3', [@john, @sky])
+		
+		@john.recipients.first.read!
+		@john.recipients.read.size.should eql(1)
+		@john.recipients.unread.size.should eql(0)
+		
+		@sky.comment_on(thread, 'This is totally awesome')
+		
+		@john.recipients.unread.size.should eql(1)
+		@john.recipients.read.size.should eql(0)
+		
+		@john.recipients.first.destroy
+		
+		@sky.comment_on(thread, 'Seriously, i love this')
+		
+		@john.recipients.size.should eql(0)
+		
+	end
+	
+	it "Should allow destroy all recipients on thread destruction" do
+		thread = @mike.send_message('Title 4', 'Body 4', [@john, @sky, @john, @sky])
+		
+		@john.recipients.size.should eql(1)
+		
+		thread.destroy
+		
+		@john.recipients.size.should eql(0)
+		@sky.recipients.size.should eql(0)
+		
+	end
+	
+	it "Should access participants properly" do
+		thread = @mike.send_message('Title 5', 'Body 5', [@john, @sky])
+		
+		thread.participants.sort{|a,b| a.id <=> b.id}.should eql([@mike])
+		
+		@john.comment_on(thread, 'Test')
+		
+		thread.reload
+		thread.participants.sort{|a,b| a.id <=> b.id}.should eql([@mike, @john])
+		
+		@sky.comment_on(thread, 'Tester')
+		
+		thread.reload
+		thread.participants.sort{|a,b| a.id <=> b.id}.should eql([@mike, @john, @sky])
+	end
+	
+	it "Should restrict access to the right objects" do
+		thread = @mike.send_message('Title 6', 'Body 6', [@john, @sky])
+		
+		frank = User.create
+		thread.can_be_viewed_by?(frank).should be_false
+		
+		thread.can_be_viewed_by?(@sky).should be_true
+		
+	end
+	
+end

data/spec/database.yml

@@ -0,0 +1,7 @@
+mysql:
+ adapter: mysql
+ encoding: utf8
+ database: gem_test
+ username: root
+ password:
+ pool: 5