mailboxer 0.0.14 → 0.0.15

data/README.rdoc

@@ -4,4 +4,23 @@ This project is based on the need of a private message system for {ging / social
 
 It is born from the great, but old, code from {lpsergi / acts_as_messageable}[https://github.com/psergi/acts_as_messageable].
 
-There is a lack of documentaion and it will be solved as soon as the gem is more stable and had proved to be useful integrated with SocialStream.
+There is a lack of documentaion and it will be solved as soon as the gem is more stable and had proved to be useful integrated with SocialStream.
+
+
+= Installation
+
+Add to your Gemfile:
+
+  gem 'mailboxer'
+
+Migrations:
+
+  rails g mailboxer:install
+
+= Usage
+
+In your model:
+
+  class User < ActiveRecord::Base
+    acts_as_messageable
+  end

data/app/models/conversation.rb

@@ -9,19 +9,19 @@ class Conversation < ActiveRecord::Base
 
 	#  before_create :clean
 	scope :participant, lambda {|participant|
-    joins(:receipts).select('DISTINCT conversations.*').where('receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s).order("conversations.updated_at DESC")
+    joins(:receipts).select('DISTINCT conversations.*').where('notifications.type'=> Message.to_s,'receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s).order("conversations.updated_at DESC")
   }
 	scope :inbox, lambda {|participant|
-    joins(:receipts).select('DISTINCT conversations.*').where('receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s, 'receipts.mailbox_type' => 'inbox','receipts.trashed' => false).order("conversations.updated_at DESC")
+    joins(:receipts).select('DISTINCT conversations.*').where('notifications.type'=> Message.to_s,'receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s, 'receipts.mailbox_type' => 'inbox','receipts.trashed' => false).order("conversations.updated_at DESC")
   }
 	scope :sentbox, lambda {|participant|
-    joins(:receipts).select('DISTINCT conversations.*').where('receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s, 'receipts.mailbox_type' => 'sentbox','receipts.trashed' => false).order("conversations.updated_at DESC")
+    joins(:receipts).select('DISTINCT conversations.*').where('notifications.type'=> Message.to_s,'receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s, 'receipts.mailbox_type' => 'sentbox','receipts.trashed' => false).order("conversations.updated_at DESC")
   }
 	scope :trash, lambda {|participant|
-    joins(:receipts).select('DISTINCT conversations.*').where('receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s,'receipts.trashed' => true).order("conversations.updated_at DESC")
+    joins(:receipts).select('DISTINCT conversations.*').where('notifications.type'=> Message.to_s,'receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s,'receipts.trashed' => true).order("conversations.updated_at DESC")
   }
 	scope :unread,  lambda {|participant|
-    joins(:receipts).select('DISTINCT conversations.*').where('receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s,'receipts.read' => false).order("conversations.updated_at DESC")
+    joins(:receipts).select('DISTINCT conversations.*').where('notifications.type'=> Message.to_s,'receipts.receiver_id' => participant.id,'receipts.receiver_type' => participant.class.to_s,'receipts.read' => false).order("conversations.updated_at DESC")
   }
 	class << self
 		def total
@@ -31,22 +31,22 @@ class Conversation < ActiveRecord::Base
 
 	def mark_as_read(participant)
 		return if participant.nil?
-		return self.receipts(participant).mark_as_read
+		return self.receipts_for(participant).mark_as_read
 	end
 
 	def mark_as_unread(participant)
 		return if participant.nil?
-		return self.receipts(participant).mark_as_unread
+		return self.receipts_for(participant).mark_as_unread
 	end
 
 	def move_to_trash(participant)
 		return if participant.nil?
-		return self.receipts(participant).move_to_trash
+		return self.receipts_for(participant).move_to_trash
 	end
 
 	def untrash(participant)
 		return if participant.nil?
-		return self.receipts(participant).untrash
+		return self.receipts_for(participant).untrash
 	end
 
 	def recipients
@@ -82,9 +82,8 @@ class Conversation < ActiveRecord::Base
 		return @last_message
 	end
 
-	def receipts(participant=nil)
-		return Receipt.conversation(self).receiver(participant) if participant
-		return Receipt.conversation(self)
+	def receipts_for(participant)
+		return Receipt.conversation(self).receiver(participant)
 	end
 
 	def count_messages
@@ -93,22 +92,22 @@ class Conversation < ActiveRecord::Base
 
 	def is_participant?(participant)
 		return false if participant.nil?
-		return self.receipts(participant).count != 0
+		return self.receipts_for(participant).count != 0
 	end
 
 	def is_trashed?(participant)
 		return false if participant.nil?
-		return self.receipts(participant).trash.count!=0
+		return self.receipts_for(participant).trash.count!=0
 	end
 
 	def is_completely_trashed?(participant)
 		return false if participant.nil?
-		return self.receipts(participant).trash.count==self.receipts(participant).count
+		return self.receipts_for(participant).trash.count==self.receipts(participant).count
 	end
 
 	def is_unread?(participant)
 		return false if participant.nil?
-		return self.receipts(participant).unread.count!=0
+		return self.receipts_for(participant).unread.count!=0
 	end
 	#  protected
 	#  #[empty method]

data/app/models/mailbox.rb

@@ -4,6 +4,10 @@ class Mailbox
 	def initialize(recipient, box = :all)
 		@messageable = recipient
 	end
+	
+	def notifications(options = {})
+	  return Receipt.where(options).receiver(@messageable).notifications
+	end
 
 	def conversations(options = {})
 		conv = Conversation.participant(@messageable)
@@ -22,7 +26,7 @@ class Mailbox
 		if (options[:read].present? and options[:read]==false) or (options[:unread].present? and options[:unread]==true)
 		conv = conv.unread(@messageable)
 		end
-
+		
 		return conv.uniq
 	end
 
@@ -46,6 +50,7 @@ class Mailbox
 	end
 
 	def empty_trash(options = {})
+	  #TODO
 		return false
 	end
 

data/app/models/message.rb

@@ -1,82 +1,50 @@
-class Message < ActiveRecord::Base
-  #  
-  attr_accessor :recipients
-  belongs_to :sender, :polymorphic => :true
+class Message < Notification
+  #
   belongs_to :conversation, :validate => true, :autosave => true
-  validates_presence_of :subject, :body, :sender  
-  
+  validates_presence_of :sender
+
   class_inheritable_accessor :on_deliver_callback
-  protected :on_deliver_callback  
-  has_many :receipts
-  scope :conversation, lambda { |conversation|    
+  protected :on_deliver_callback
+  scope :conversation, lambda { |conversation|
     where(:conversation_id => conversation.id)
   }
-    
   class << self
     def on_deliver(callback_method)
       self.on_deliver_callback = callback_method
     end
-  end  
-  
+  end
+
   def deliver(reply = false, should_clean = true)
     self.clean if should_clean
     temp_receipts = Array.new
     #Receiver receipts
     self.recipients.each do |r|
       msg_receipt = Receipt.new
-	  msg_receipt.message = self
-	  msg_receipt.read = false
-	  msg_receipt.receiver = r
-	  msg_receipt.mailbox_type = "inbox"
-   	  temp_receipts << msg_receipt
+      msg_receipt.notification = self
+      msg_receipt.read = false
+      msg_receipt.receiver = r
+      msg_receipt.mailbox_type = "inbox"
+      temp_receipts << msg_receipt
     end
     #Sender receipt
     sender_receipt = Receipt.new
-	sender_receipt.message = self
-	sender_receipt.read = true
-	sender_receipt.receiver = self.sender
-	sender_receipt.mailbox_type = "sentbox"
-   	temp_receipts << sender_receipt
-    
- 	temp_receipts.each(&:valid?)
- 	if temp_receipts.all? { |t| t.errors.empty? }
-		temp_receipts.each(&:save!) 	#Save receipts
-		if reply
-			self.conversation.update_attribute(:updated_at, Time.now)
-		end
-		self.recipients=nil
-		self.on_deliver_callback.call(self) unless self.on_deliver_callback.nil?
-	end
-    return sender_receipt	
-  end
-   
-  def recipients
-		if @recipients.blank?
-			recipients_array = Array.new
-			self.receipts.each do |receipt|
-				recipients_array << receipt.receiver
-			end
-		return recipients_array
-		end
-		return @recipients
-	end
+    sender_receipt.notification = self
+    sender_receipt.read = true
+    sender_receipt.receiver = self.sender
+    sender_receipt.mailbox_type = "sentbox"
+    temp_receipts << sender_receipt
+
+    temp_receipts.each(&:valid?)
+    if temp_receipts.all? { |t| t.errors.empty? }
+      temp_receipts.each(&:save!) 	#Save receipts
+      if reply
+      self.conversation.update_attribute(:updated_at, Time.now)
+      end
+      self.recipients=nil
+      self.on_deliver_callback.call(self) unless self.on_deliver_callback.nil?
+    end
+    return sender_receipt
+  end  
+
 
-	def receipts(participant=nil)
-		return Receipt.message(self).receiver(participant) if participant
-		return Receipt.message(self)
-	end
-	
-	def is_unread?(participant)
-		return false if participant.nil?
-    	return self.receipts(participant).unread.count!=0
-	end
-  
-  include ActionView::Helpers::SanitizeHelper
-  def clean 
-  	unless self.subject.nil?
-  		self.subject = sanitize self.subject
-  	end
-  	self.body = sanitize self.body
-  end
-  
 end

data/app/models/notification.rb

@@ -0,0 +1,65 @@
+class Notification < ActiveRecord::Base
+
+  attr_accessor :recipients
+  belongs_to :sender, :polymorphic => :true
+  validates_presence_of :subject, :body
+  has_many :receipts
+  
+  class << self
+    def notify_all(recipients,subject,body)
+      notification = Notification.new({:body => body, :subject => subject})
+      notification.recipients = recipients.is_a?(Array) ? recipients : [recipients]
+      notification.recipients = notification.recipients.uniq
+      return notification.deliver
+    end
+  end
+
+  def deliver(should_clean = true)
+    self.clean if should_clean
+    temp_receipts = Array.new
+    #Receiver receipts
+    self.recipients.each do |r|
+      msg_receipt = Receipt.new
+      msg_receipt.notification = self
+      msg_receipt.read = false
+      msg_receipt.receiver = r
+      temp_receipts << msg_receipt
+    end
+    temp_receipts.each(&:valid?)
+    if temp_receipts.all? { |t| t.errors.empty? }
+      temp_receipts.each(&:save!)   #Save receipts
+      self.recipients=nil
+    end
+    return temp_receipts
+  end
+
+  def recipients
+    if @recipients.blank?
+      recipients_array = Array.new
+      self.receipts.each do |receipt|
+        recipients_array << receipt.receiver
+      end
+    return recipients_array
+    end
+    return @recipients
+  end
+
+  def receipt_for(participant)
+    return Receipt.notification(self).receiver(participant)
+  end
+
+  def is_unread?(participant)
+    return false if participant.nil?
+    return self.receipt_for(participant).unread.count!=0
+  end
+
+  include ActionView::Helpers::SanitizeHelper
+
+  def clean
+    unless self.subject.nil?
+      self.subject = sanitize self.subject
+    end
+    self.body = sanitize self.body
+  end
+
+end

data/app/models/receipt.rb

@@ -1,18 +1,22 @@
 class Receipt < ActiveRecord::Base
-	belongs_to :message, :validate => true, :autosave => true
-	has_one :conversation, :through => :message
+	belongs_to :notification, :validate => true, :autosave => true
 	belongs_to :receiver, :polymorphic => :true
-
+	belongs_to :message, :foreign_key => "notification_id" 
+	
 	validates_presence_of :receiver
 
 	scope :receiver, lambda { |receiver|
     where(:receiver_id => receiver.id,:receiver_type => receiver.class.to_s)
   }
-	scope :message, lambda { |message|
-    where(:message_id => message.id)
+  #Notifications Scope checks type to be nil, not Notification because of STI behaviour
+  #with the primary class (no type is saved)
+  scope :notifications, joins(:notification).where('notifications.type' => nil)
+  scope :messages, joins(:notification).where('notifications.type' => Message.to_s)
+	scope :notification, lambda { |notification|
+    where(:notification_id => notification.id)
   }
 	scope :conversation, lambda { |conversation|
-    joins(:message).where('messages.conversation_id' => conversation.id)
+    joins(:notification).where('notifications.conversation_id' => conversation.id)
   }
 	scope :sentbox, where(:mailbox_type => "sentbox")
 	scope :inbox, where(:mailbox_type => "inbox")
@@ -72,6 +76,11 @@ class Receipt < ActiveRecord::Base
 		update_attributes(:mailbox_type => :sentbox, :trashed => false)
 	end
 
+  def conversation
+    return nil if notification.class == Notification
+    return notification.conversation if notification.class == Message
+  end
+
 	protected
 
 	def remove_duplicate_errors

data/lib/generators/mailboxer/templates/migration.rb

@@ -10,7 +10,7 @@ class CreateMailboxer < ActiveRecord::Migration
   	#Receipts
     create_table :receipts do |t|
       t.references :receiver, :polymorphic => true
-      t.column :message_id, :integer, :null => false
+      t.column :notification_id, :integer, :null => false
       t.column :read, :boolean, :default => false
       t.column :trashed, :boolean, :default => false
       t.column :deleted, :boolean, :default => false
@@ -18,8 +18,9 @@ class CreateMailboxer < ActiveRecord::Migration
       t.column :created_at, :datetime, :null => false
       t.column :updated_at, :datetime, :null => false
     end    
-  	#Messages
-    create_table :messages do |t|
+  	#Notifications and Messages
+    create_table :notifications do |t|
+      t.column :type, :string
       t.column :body, :text
       t.column :subject, :string, :default => ""
       t.references :sender, :polymorphic => true
@@ -33,26 +34,27 @@ class CreateMailboxer < ActiveRecord::Migration
   #Indexes
   	#Conversations
   	#Receipts
-  	add_index "receipts","message_id"
+  	add_index "receipts","notification_id"
+
   	#Messages  
-  	add_index "messages","conversation_id"
+  	add_index "notifications","conversation_id"
   
   #Foreign keys    
   	#Conversations
   	#Receipts
-  	add_foreign_key "receipts", "messages", :name => "receipts_on_message_id"
+  	add_foreign_key "receipts", "notifications", :name => "receipts_on_notification_id"
   	#Messages  
-  	add_foreign_key "messages", "conversations", :name => "messages_on_conversation_id"
+  	add_foreign_key "notifications", "conversations", :name => "notifications_on_conversation_id"
   end
   
   def self.down
   #Tables  	
-  	remove_foreign_key "receipts", :name => "receipts_on_message_id"
-  	remove_foreign_key "messages", :name => "messages_on_conversation_id"
+  	remove_foreign_key "receipts", :name => "receipts_on_notification_id"
+  	remove_foreign_key "notifications", :name => "notifications_on_conversation_id"
   	
   #Indexes
     drop_table :receipts
     drop_table :conversations
-    drop_table :messages
+    drop_table :notifications
   end
 end

data/lib/mailboxer/engine.rb

@@ -1,3 +1,6 @@
+# Database foreign keys
+require 'foreigner'
+
 module Mailboxer
   class Engine < Rails::Engine
     

data/lib/mailboxer/models/messageable.rb

@@ -15,11 +15,24 @@ module Mailboxer
 			end
 
 			module InstanceMethods
+			  
+			  ################################### MAILBOXES
+			  
 				def mailbox
 					@mailbox = Mailbox.new(self) if @mailbox.nil?
 					@mailbox.type = :all
 					return @mailbox
 				end
+				
+				################################### NOTIFICATIONS
+				
+				def notify(subject,body)
+          notification = Notification.new({:body => body, :subject => subject})
+          notification.recipients = [self]
+          return notification.deliver				  
+				end
+				
+				################################### MESSAGES
 
 				def send_message(recipients, msg_body, subject)
 					convo = Conversation.new({:subject => subject})
@@ -39,11 +52,11 @@ module Mailboxer
 				end
 
 				def reply_to_sender(receipt, reply_body, subject = nil)
-					return reply(receipt.conversation, receipt.message.sender, reply_body, subject)
+					return reply(receipt.conversation, receipt.notification.sender, reply_body, subject)
 				end
 
 				def reply_to_all(receipt, reply_body, subject = nil)
-					return reply(receipt.conversation, receipt.message.recipients, reply_body, subject)
+					return reply(receipt.conversation, receipt.notification.recipients, reply_body, subject)
 				end
 
 				def reply_to_conversation(conversation, reply_body, subject = nil)
@@ -81,6 +94,8 @@ module Mailboxer
 					end
 					return nil
 				end
+				
+				
 			end
 		end
 	end

data/mailboxer.gemspec

@@ -1,9 +1,10 @@
 Gem::Specification.new do |s|
 	s.name = "mailboxer"
-	s.version = "0.0.14"
+	s.version = "0.0.15"
 	s.authors = ["Eduardo Casanova Cuesta"]
 	s.summary = "Messaging system for rails apps."
-	s.description = "A Rails engine that allows any model to act as messageable, permitting it interchange messages with any other messageable model."
+	s.description = "A Rails engine that allows any model to act as messageable, permitting it interchange messages with any other messageable model." +  
+	                "It also supports sending system notifications to messageable models."
 	s.email = "ecasanovac@gmail.com"
 	s.homepage = "http://github.com/ging/mailboxer"
 	s.files = `git ls-files`.split("\n")

data/spec/dummy/db/migrate/{20110322000127_create_mailboxer.rb → 20110407111612_create_mailboxer.rb}

@@ -1,13 +1,16 @@
 class CreateMailboxer < ActiveRecord::Migration
   def self.up    
+  #Tables
+  	#Conversations
     create_table :conversations do |t|
       t.column :subject, :string, :default => ""
       t.column :created_at, :datetime, :null => false
       t.column :updated_at, :datetime, :null => false
     end    
+  	#Receipts
     create_table :receipts do |t|
       t.references :receiver, :polymorphic => true
-      t.column :message_id, :integer, :null => false
+      t.column :notification_id, :integer, :null => false
       t.column :read, :boolean, :default => false
       t.column :trashed, :boolean, :default => false
       t.column :deleted, :boolean, :default => false
@@ -15,23 +18,42 @@ class CreateMailboxer < ActiveRecord::Migration
       t.column :created_at, :datetime, :null => false
       t.column :updated_at, :datetime, :null => false
     end    
-    create_table :messages do |t|
+  	#Notifications and Messages
+    create_table :notifications do |t|
+      t.column :type, :string
       t.column :body, :text
       t.column :subject, :string, :default => ""
-      t.column :headers, :text
       t.references :sender, :polymorphic => true
       t.column :conversation_id, :integer
-      t.column :sent, :boolean, :default => false
       t.column :draft, :boolean, :default => false
-      t.column :system, :boolean, :default => false
       t.column :updated_at, :datetime, :null => false
       t.column :created_at, :datetime, :null => false
     end    
+    
+    
+  #Indexes
+  	#Conversations
+  	#Receipts
+  	add_index "receipts","notification_id"
+  	#Messages  
+  	add_index "notifications","conversation_id"
+  
+  #Foreign keys    
+  	#Conversations
+  	#Receipts
+  	add_foreign_key "receipts", "notifications", :name => "receipts_on_notification_id"
+  	#Messages  
+  	add_foreign_key "notifications", "conversations", :name => "notifications_on_conversation_id"
   end
   
   def self.down
+  #Tables  	
+  	remove_foreign_key "receipts", :name => "receipts_on_notification_id"
+  	remove_foreign_key "notifications", :name => "notifications_on_conversation_id"
+  	
+  #Indexes
     drop_table :receipts
     drop_table :conversations
-    drop_table :messages
+    drop_table :notifications
   end
 end

data/spec/integration/message_and_receipt_spec.rb

@@ -11,8 +11,8 @@ describe "Messages And Receipts" do
     describe "message sending" do    
       
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @message1 = @mail1.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @message1 = @receipt1.notification
       end
       
       it "should create proper message" do
@@ -24,7 +24,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity1).message(@message1).first
+        mail = Receipt.receiver(@entity1).notification(@message1).first
         assert mail
         if mail
           mail.read.should==true
@@ -32,7 +32,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity2).message(@message1).first
+        mail = Receipt.receiver(@entity2).notification(@message1).first
         assert mail
         if mail
           mail.read.should==false
@@ -52,10 +52,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to sender" do
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @mail2 = @entity2.reply_to_sender(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @receipt2 = @entity2.reply_to_sender(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -67,7 +67,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -75,7 +75,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -98,10 +98,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to all" do
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @mail2 = @entity2.reply_to_all(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -113,7 +113,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -121,7 +121,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -143,10 +143,10 @@ describe "Messages And Receipts" do
     end
     describe "message replying to conversation" do
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @mail2 = @entity2.reply_to_conversation(@mail1.conversation,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @receipt2 = @entity2.reply_to_conversation(@receipt1.conversation,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -158,7 +158,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -166,7 +166,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -197,8 +197,8 @@ describe "Messages And Receipts" do
     describe "message sending" do    
       
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @message1 = @mail1.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @message1 = @receipt1.notification
       end
       
       it "should create proper message" do
@@ -210,7 +210,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity1).message(@message1).first
+        mail = Receipt.receiver(@entity1).notification(@message1).first
         assert mail
         if mail
           mail.read.should==true
@@ -218,7 +218,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity2).message(@message1).first
+        mail = Receipt.receiver(@entity2).notification(@message1).first
         assert mail
         if mail
           mail.read.should==false
@@ -238,10 +238,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to sender" do
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @mail2 = @entity2.reply_to_sender(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @receipt2 = @entity2.reply_to_sender(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -253,7 +253,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -261,7 +261,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -284,10 +284,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to all" do
       before do
-        @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-        @mail2 = @entity2.reply_to_all(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+        @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -299,7 +299,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -307,7 +307,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -363,8 +363,8 @@ describe "Messages And Receipts" do
     describe "message sending" do    
       
       before do
-        @mail1 = @entity1.send_message(@recipients,"Body","Subject")
-        @message1 = @mail1.message
+        @receipt1 = @entity1.send_message(@recipients,"Body","Subject")
+        @message1 = @receipt1.notification
       end
       
       it "should create proper message" do
@@ -376,7 +376,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity1).message(@message1).first
+        mail = Receipt.receiver(@entity1).notification(@message1).first
         assert mail
         if mail
           mail.read.should==true
@@ -385,7 +385,7 @@ describe "Messages And Receipts" do
         end      
         #Receiver Mails
         @recipients.each do |receiver|
-          mail = Receipt.receiver(receiver).message(@message1).first
+          mail = Receipt.receiver(receiver).notification(@message1).first
           assert mail
           if mail
             mail.read.should==false
@@ -407,10 +407,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to sender" do
       before do
-        @mail1 = @entity1.send_message(@recipients,"Body","Subject")
-        @mail2 = @entity2.reply_to_sender(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@recipients,"Body","Subject")
+        @receipt2 = @entity2.reply_to_sender(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -422,7 +422,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -430,7 +430,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -439,7 +439,7 @@ describe "Messages And Receipts" do
         end
         
         #No Receiver, No Mail
-        mail = Receipt.receiver(@entity3).message(@message2).first
+        mail = Receipt.receiver(@entity3).notification(@message2).first
         assert mail.nil?
         
       end
@@ -459,10 +459,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to all" do
       before do
-        @mail1 = @entity1.send_message(@recipients,"Body","Subject")
-        @mail2 = @entity2.reply_to_all(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@recipients,"Body","Subject")
+        @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
         @recipients2 = Array.new
         @recipients2 << @entity1
         @recipients2 << @entity3
@@ -478,7 +478,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -487,7 +487,7 @@ describe "Messages And Receipts" do
         end      
         #Receiver Mails
         @recipients2.each do |receiver|
-          mail = Receipt.receiver(receiver).message(@message2).first
+          mail = Receipt.receiver(receiver).notification(@message2).first
           assert mail
           if mail
             mail.read.should==false
@@ -545,8 +545,8 @@ describe "Messages And Receipts" do
     describe "message sending" do    
       
       before do
-        @mail1 = @entity1.send_message(@recipients,"Body","Subject")
-        @message1 = @mail1.message
+        @receipt1 = @entity1.send_message(@recipients,"Body","Subject")
+        @message1 = @receipt1.notification
       end
       
       it "should create proper message" do
@@ -558,7 +558,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity1).message(@message1).first
+        mail = Receipt.receiver(@entity1).notification(@message1).first
         assert mail
         if mail
           mail.read.should==true
@@ -567,7 +567,7 @@ describe "Messages And Receipts" do
         end      
         #Receiver Mails
         @recipients.each do |receiver|
-          mail = Receipt.receiver(receiver).message(@message1).first
+          mail = Receipt.receiver(receiver).notification(@message1).first
           assert mail
           if mail
             mail.read.should==false
@@ -589,10 +589,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to sender" do
       before do
-        @mail1 = @entity1.send_message(@recipients,"Body","Subject")
-        @mail2 = @entity2.reply_to_sender(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@recipients,"Body","Subject")
+        @receipt2 = @entity2.reply_to_sender(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
       end
       
       it "should create proper message" do
@@ -604,7 +604,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -612,7 +612,7 @@ describe "Messages And Receipts" do
           mail.mailbox_type.should=="sentbox"
         end      
         #Receiver Mail
-        mail = Receipt.receiver(@entity1).message(@message2).first
+        mail = Receipt.receiver(@entity1).notification(@message2).first
         assert mail
         if mail
           mail.read.should==false
@@ -621,7 +621,7 @@ describe "Messages And Receipts" do
         end
         
         #No Receiver, No Mail
-        mail = Receipt.receiver(@entity3).message(@message2).first
+        mail = Receipt.receiver(@entity3).notification(@message2).first
         assert mail.nil?
         
       end
@@ -641,10 +641,10 @@ describe "Messages And Receipts" do
     
     describe "message replying to all" do
       before do
-        @mail1 = @entity1.send_message(@recipients,"Body","Subject")
-        @mail2 = @entity2.reply_to_all(@mail1,"Reply body")
-        @message1 = @mail1.message
-        @message2 = @mail2.message
+        @receipt1 = @entity1.send_message(@recipients,"Body","Subject")
+        @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body")
+        @message1 = @receipt1.notification
+        @message2 = @receipt2.notification
         @recipients2 = Array.new
         @recipients2 << @entity1
         @recipients2 << @entity3
@@ -660,7 +660,7 @@ describe "Messages And Receipts" do
       
       it "should create proper mails" do
         #Sender Mail
-        mail = Receipt.receiver(@entity2).message(@message2).first
+        mail = Receipt.receiver(@entity2).notification(@message2).first
         assert mail
         if mail
           mail.read.should==true
@@ -669,7 +669,7 @@ describe "Messages And Receipts" do
         end      
         #Receiver Mails
         @recipients2.each do |receiver|
-          mail = Receipt.receiver(receiver).message(@message2).first
+          mail = Receipt.receiver(receiver).notification(@message2).first
           assert mail
           if mail
             mail.read.should==false

data/spec/models/conversation_spec.rb

@@ -5,12 +5,12 @@ describe Conversation do
   before do
     @entity1 = Factory(:user)
     @entity2 = Factory(:user)
-    @mail1 = @entity1.send_message(@entity2,"Body","Subject")
-    @mail2 = @entity2.reply_to_all(@mail1,"Reply body 1")
-    @mail3 = @entity1.reply_to_all(@mail2,"Reply body 2")
-    @mail4 = @entity2.reply_to_all(@mail3,"Reply body 3")
-    @message1 = @mail1.message
-    @message4 = @mail4.message
+    @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+    @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body 1")
+    @receipt3 = @entity1.reply_to_all(@receipt2,"Reply body 2")
+    @receipt4 = @entity2.reply_to_all(@receipt3,"Reply body 3")
+    @message1 = @receipt1.notification
+    @message4 = @receipt4.notification
     @conversation = @message1.conversation
   end
   

data/spec/models/mailbox_spec.rb

@@ -9,8 +9,8 @@ describe Mailbox do
     @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body 1")
     @receipt3 = @entity1.reply_to_all(@receipt2,"Reply body 2")
     @receipt4 = @entity2.reply_to_all(@receipt3,"Reply body 3")
-    @message1 = @receipt1.message
-    @message4 = @receipt4.message
+    @message1 = @receipt1.notification
+    @message4 = @receipt4.notification
     @conversation = @message1.conversation
   end  
   

data/spec/models/message_spec.rb

@@ -9,16 +9,16 @@ describe Message do
     @receipt2 = @entity2.reply_to_all(@receipt1,"Reply body 1")
     @receipt3 = @entity1.reply_to_all(@receipt2,"Reply body 2")
     @receipt4 = @entity2.reply_to_all(@receipt3,"Reply body 3")
-    @message1 = @receipt1.message
-    @message4 = @receipt4.message
+    @message1 = @receipt1.notification
+    @message4 = @receipt4.notification
     @conversation = @message1.conversation
   end  
   
   it "should have right recipients" do
-  	@receipt1.message.recipients.count.should==2
-  	@receipt2.message.recipients.count.should==2
-  	@receipt3.message.recipients.count.should==2
-  	@receipt4.message.recipients.count.should==2      
+  	@receipt1.notification.recipients.count.should==2
+  	@receipt2.notification.recipients.count.should==2
+  	@receipt3.notification.recipients.count.should==2
+  	@receipt4.notification.recipients.count.should==2      
   end
     
 end

data/spec/models/notification_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Message do
+  
+  before do
+    @entity1 = Factory(:user)
+    @entity2 = Factory(:user)
+    @entity3 = Factory(:user)
+  end  
+  
+  it "should notify one user" do
+    @entity1.notify("Subject","Body")
+    
+    #Check getting ALL receipts
+    @entity1.mailbox.receipts.size.should==1
+    receipt = @entity1.mailbox.receipts.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+    
+    #Check getting NOTIFICATION receipts only
+    @entity1.mailbox.notifications.size.should==1
+    receipt = @entity1.mailbox.notifications.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"       
+  end
+  
+  it "should notify several users" do
+    Notification.notify_all([@entity1,@entity2,@entity3],"Subject","Body")
+    
+    #Check getting ALL receipts
+    @entity1.mailbox.receipts.size.should==1
+    receipt = @entity1.mailbox.receipts.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+    @entity2.mailbox.receipts.size.should==1
+    receipt = @entity2.mailbox.receipts.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+    @entity3.mailbox.receipts.size.should==1
+    receipt = @entity3.mailbox.receipts.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+    
+    #Check getting NOTIFICATION receipts only
+    @entity1.mailbox.notifications.size.should==1
+    receipt = @entity1.mailbox.notifications.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+    @entity2.mailbox.notifications.size.should==1
+    receipt = @entity2.mailbox.notifications.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+    @entity3.mailbox.notifications.size.should==1
+    receipt = @entity3.mailbox.notifications.first
+    notification = receipt.notification
+    notification.subject.should=="Subject"
+    notification.body.should=="Body"
+          
+  end
+    
+end

data/spec/models/receipt_spec.rb

@@ -9,7 +9,7 @@ describe Receipt do
   end
   
   it "should belong to a message" do
-    assert @mail1.message
+    assert @mail1.notification
   end
   
   it "should belong to a conversation" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: false
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 15
+  version: 0.0.15
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-30 00:00:00 +02:00
+date: 2011-04-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -144,7 +144,7 @@ dependencies:
         version: 0.3.9
   type: :development
   version_requirements: *id008
-description: A Rails engine that allows any model to act as messageable, permitting it interchange messages with any other messageable model.
+description: A Rails engine that allows any model to act as messageable, permitting it interchange messages with any other messageable model.It also supports sending system notifications to messageable models.
 email: ecasanovac@gmail.com
 executables: []
 
@@ -163,6 +163,7 @@ files:
 - app/models/conversation.rb
 - app/models/mailbox.rb
 - app/models/message.rb
+- app/models/notification.rb
 - app/models/receipt.rb
 - lib/generators/mailboxer/install_generator.rb
 - lib/generators/mailboxer/templates/migration.rb
@@ -198,7 +199,7 @@ files:
 - spec/dummy/db/migrate/20110228120600_create_users.rb
 - spec/dummy/db/migrate/20110306002940_create_ducks.rb
 - spec/dummy/db/migrate/20110306015107_create_cylons.rb
-- spec/dummy/db/migrate/20110322000127_create_mailboxer.rb
+- spec/dummy/db/migrate/20110407111612_create_mailboxer.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -223,6 +224,7 @@ files:
 - spec/models/mailbox_spec.rb
 - spec/models/mailboxer_models_messageable_spec.rb
 - spec/models/message_spec.rb
+- spec/models/notification_spec.rb
 - spec/models/receipt_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true