mailboxer 0.2.1 → 0.2.2

data/app/models/notification.rb

@@ -8,6 +8,12 @@ class Notification < ActiveRecord::Base
   
   scope :recipient, lambda { |recipient|
     joins(:receipts).where('receipts.receiver_id' => recipient.id,'receipts.receiver_type' => recipient.class.to_s)
+  }  
+  scope :not_trashed, lambda {
+    joins(:receipts).where('receipts.trashed' => false)
+  }
+  scope :unread,  lambda {
+    joins(:receipts).where('receipts.read' => false)
   }
   
   class << self
@@ -43,7 +49,8 @@ class Notification < ActiveRecord::Base
       temp_receipts.each(&:save!)   #Save receipts
       self.recipients=nil
     end
-    return temp_receipts
+    return temp_receipts if temp_receipts.size > 1
+    return temp_receipts.first
   end
   
   #Returns the recipients of the Notification
@@ -62,6 +69,11 @@ class Notification < ActiveRecord::Base
   def receipt_for(participant)
     return Receipt.notification(self).recipient(participant)
   end
+  
+  #Returns the receipt for the participant. Alias for receipt_for(participant)
+  def receipts_for(participant)
+    return receipt_for(participant)
+  end
 
   #Returns if the participant have read the Notification
   def is_unread?(participant)
@@ -69,6 +81,37 @@ class Notification < ActiveRecord::Base
     return self.receipt_for(participant).first.read
   end
 
+  #Returns if the participant have trashed the Notification
+  def is_trashed?(participant)
+    return false if participant.nil?
+    return self.receipt_for(participant).first.trashed
+  end  
+
+  #Mark the notification as read
+  def mark_as_read(participant)
+    return if participant.nil?
+    return self.receipt_for(participant).mark_as_read
+  end
+
+  #Mark the notification as unread
+  def mark_as_unread(participant)
+    return if participant.nil?
+    return self.receipt_for(participant).mark_as_unread
+  end
+
+  #Move the notification to the trash
+  def move_to_trash(participant)
+    return if participant.nil?
+    return self.receipt_for(participant).move_to_trash
+  end
+
+  #Takes the notification out of the trash 
+  def untrash(participant)
+    return if participant.nil?
+    return self.receipt_for(participant).untrash
+  end
+
+
   include ActionView::Helpers::SanitizeHelper
 
   #Sanitizes the body and subject

data/app/models/receipt.rb

@@ -65,12 +65,13 @@ class Receipt < ActiveRecord::Base
       where(options).each do |rcp|
         ids << rcp.id
       end
-      temp_ids = ids.clone
+      return if ids.empty?      
+      conditions = [""].concat(ids)
       condition = "id = ? "
-      temp_ids.drop(1).each do
+      ids.drop(1).each do
         condition << "OR id = ? "
       end
-      conditions = [condition].concat(ids)
+      conditions[0] = condition
       Receipt.except(:where).except(:joins).where(conditions).update_all(updates)
     end
   end
@@ -111,6 +112,17 @@ class Receipt < ActiveRecord::Base
     return nil
   end
 
+  #Returns if the participant have read the Notification
+  def is_unread?
+    return !self.read
+  end
+
+  #Returns if the participant have trashed the Notification
+  def is_trashed?
+    return self.trashed
+  end  
+
+  
   protected
 
   #Removes the duplicate error about not present subject from Conversation if it has been already

data/lib/mailboxer/models/messageable.rb

@@ -107,11 +107,9 @@ module Mailboxer
           when Receipt
             return obj.mark_as_read if obj.receiver == self
           when Message, Notification
-            receipt = obj.receipt_for(self)
-            return receipt.mark_as_read
+            obj.mark_as_read(self)
           when Conversation
-            receipts = obj.receipts_for(self)
-            return receipts.mark_as_read
+            obj.mark_as_read(self)
           when Array
             obj.map{ |sub_obj| read(sub_obj) }
           else
@@ -132,17 +130,62 @@ module Mailboxer
           when Receipt
             return obj.mark_as_unread if obj.receiver == self
           when Message, Notification
-            receipt = obj.receipt_for(self)
-            return receipt.mark_as_unread
+            obj.mark_as_unread(self)
           when Conversation
-            receipts = obj.receipts_for(self)
-            return receipts.mark_as_unread
+            obj.mark_as_unread(self)
           when Array
             obj.map{ |sub_obj| unread(sub_obj) }
           else
           return nil
           end
         end
+        
+        
+        #Mark the object as trashed for messageable.
+        #
+        #Object can be:
+        #* A Receipt
+        #* A Message
+        #* A Notification
+        #* A Conversation
+        #* An array with any of them
+        def trash(obj)
+          case obj
+          when Receipt
+            return obj.move_to_trash if obj.receiver == self
+          when Message, Notification
+            obj.move_to_trash(self)
+          when Conversation
+            obj.move_to_trash(self)
+          when Array
+            obj.map{ |sub_obj| trash(sub_obj) }
+          else
+          return nil
+          end
+        end
+
+        #Mark the object as not trashed for messageable.
+        #
+        #Object can be:
+        #* A Receipt
+        #* A Message
+        #* A Notification
+        #* A Conversation
+        #* An array with any of them
+        def untrash(obj)
+          case obj
+          when Receipt
+            return obj.untrash if obj.receiver == self
+          when Message, Notification
+            obj.untrash(self)
+          when Conversation
+            obj.untrash(self)
+          when Array
+            obj.map{ |sub_obj| untrash(sub_obj) }
+          else
+          return nil
+          end
+        end
       end
     end
   end

data/mailboxer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "mailboxer"
-	s.version = "0.2.1"
+	s.version = "0.2.2"
 	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." +  

data/spec/models/mailbox_spec.rb

@@ -97,4 +97,5 @@ describe Mailbox do
     @entity2.mailbox.receipts.trash.count.should==0    
   end
   
+  
 end

data/spec/models/mailboxer_models_messageable_spec.rb

@@ -25,18 +25,16 @@ describe "Mailboxer::Models::Messageable through User" do
     assert @entity2.reply_to_all(@receipt,"Reply body")    
   end
   
-  it "should be able to reply to conversation (TODO)" do
-    #TODO
-  end
   
-  it "should be able to unread an owned mail (mark as unread)" do
+  
+  it "should be able to unread an owned Receipt (mark as unread)" do
     @receipt = @entity1.send_message(@entity2,"Body","Subject")
     @receipt.read.should==true
     @entity1.unread(@receipt)
     @receipt.read.should==false
   end
   
-  it "should be able to read an owned mail (mark as read)" do
+  it "should be able to read an owned Receipt (mark as read)" do
     @receipt = @entity1.send_message(@entity2,"Body","Subject")
     @receipt.read.should==true
     @entity1.unread(@receipt)
@@ -44,14 +42,14 @@ describe "Mailboxer::Models::Messageable through User" do
     @receipt.read.should==true
   end
   
-  it "should be able to unread anot owned mail (mark as unread)" do
+  it "should not be able to unread a not owned Receipt (mark as unread)" do
     @receipt = @entity1.send_message(@entity2,"Body","Subject")
     @receipt.read.should==true
     @entity2.unread(@receipt) #Should not change
     @receipt.read.should==true
   end
   
-  it "should be able to read a not owned mail (mark as read)" do
+  it "should not be able to read a not owned Receipt (mark as read)" do
     @receipt = @entity1.send_message(@entity2,"Body","Subject")
     @receipt.read.should==true
     @entity1.unread(@receipt) #From read to unread
@@ -59,49 +57,246 @@ describe "Mailboxer::Models::Messageable through User" do
     @receipt.read.should==false
   end
   
-=begin  
-  it "should be able to read owned mails of a conversation" do
-    @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.message
-    @conversation = @message1.conversation
-    
-    @conversation.mark_as_read(@entity1)
-    
-    @receipts = @conversation.receipts(@entity1)
-    
-    @receipts.each do |mail|
-      mail.read.should==true
-    end    
-  end
-  
-  it "should not be able to read not owned mails of a conversation" do
-    @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.message
-    @conversation = @message1.conversation
-    
-    @conversation.mark_as_read(@entity2)
-    
-    @receipts = @conversation.receipts(@entity1)
-    @receipts_total = @conversation.receipts
-    
-    unread_mails = 0
-    
-    @receipts.each do |mail|
-      unread_mails+=1 if !mail.read
-    end
-    
-    unread_mails.should==2
-    
-    
-    
-  end
-=end  
+  it "should be able to trash an owned Receipt" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @receipt.trashed.should==false
+    @entity1.trash(@receipt)
+    @receipt.trashed.should==true
+  end
+  
+  it "should be able to untrash an owned Receipt" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @receipt.trashed.should==false
+    @entity1.trash(@receipt)
+    @entity1.untrash(@receipt)
+    @receipt.trashed.should==false
+  end
+  
+  it "should not be able to trash a not owned Receipt" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @receipt.trashed.should==false
+    @entity2.trash(@receipt) #Should not change
+    @receipt.trashed.should==false
+  end
+  
+  it "should not be able to untrash a not owned Receipt" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @receipt.trashed.should==false
+    @entity1.trash(@receipt) #From read to unread
+    @entity2.untrash(@receipt) #Should not change
+    @receipt.trashed.should==true
+  end
+  
+  
+  
+  it "should be able to unread an owned Message (mark as unread)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.read.should==true
+    @entity1.unread(@message)
+    @message.receipt_for(@entity1).first.read.should==false
+  end
+  
+  it "should be able to read an owned Message (mark as read)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.read.should==true
+    @entity1.unread(@message)
+    @entity1.read(@message)
+    @message.receipt_for(@entity1).first.read.should==true
+  end
+  
+  it "should not be able to unread a not owned Message (mark as unread)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.read.should==true
+    @entity2.unread(@message) #Should not change
+    @message.receipt_for(@entity1).first.read.should==true
+  end
+  
+  it "should not be able to read a not owned Message (mark as read)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.read.should==true
+    @entity1.unread(@message) #From read to unread
+    @entity2.read(@message) #Should not change
+    @message.receipt_for(@entity1).first.read.should==false
+  end
+  
+  it "should be able to trash an owned Message" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.trashed.should==false
+    @entity1.trash(@message)
+    @message.receipt_for(@entity1).first.trashed.should==true
+  end
+  
+  it "should be able to untrash an owned Message" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.trashed.should==false
+    @entity1.trash(@message)
+    @entity1.untrash(@message)
+    @message.receipt_for(@entity1).first.trashed.should==false
+  end
+  
+  it "should not be able to trash a not owned Message" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.trashed.should==false
+    @entity2.trash(@message) #Should not change
+    @message.receipt_for(@entity1).first.trashed.should==false
+  end
+  
+  it "should not be able to untrash a not owned Message" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @message = @receipt.message
+    @receipt.trashed.should==false
+    @entity1.trash(@message) #From read to unread
+    @entity2.untrash(@message) #Should not change
+    @message.receipt_for(@entity1).first.trashed.should==true
+  end
+
+
+
+  it "should be able to unread an owned Notification (mark as unread)" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.read.should==false
+    @entity1.read(@notification)
+    @entity1.unread(@notification)
+    @notification.receipt_for(@entity1).first.read.should==false
+  end
+  
+  it "should be able to read an owned Notification (mark as read)" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.read.should==false
+    @entity1.read(@notification)
+    @notification.receipt_for(@entity1).first.read.should==true
+  end
+  
+  it "should not be able to unread a not owned Notification (mark as unread)" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.read.should==false
+    @entity1.read(@notification)
+    @entity2.unread(@notification)
+    @notification.receipt_for(@entity1).first.read.should==true
+  end
+  
+  it "should not be able to read a not owned Notification (mark as read)" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.read.should==false
+    @entity2.read(@notification)
+    @notification.receipt_for(@entity1).first.read.should==false
+  end
+  
+  it "should be able to trash an owned Notification" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.trashed.should==false
+    @entity1.trash(@notification)
+    @notification.receipt_for(@entity1).first.trashed.should==true
+  end
+  
+  it "should be able to untrash an owned Notification" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.trashed.should==false
+    @entity1.trash(@notification)
+    @entity1.untrash(@notification)
+    @notification.receipt_for(@entity1).first.trashed.should==false
+  end
+  
+  it "should not be able to trash a not owned Notification" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.trashed.should==false
+    @entity2.trash(@notification)
+    @notification.receipt_for(@entity1).first.trashed.should==false
+  end
+  
+  it "should not be able to untrash a not owned Notification" do
+    @receipt = @entity1.notify("Subject","Body")
+    @notification = @receipt.notification
+    @receipt.trashed.should==false
+    @entity1.trash(@notification)
+    @entity2.untrash(@notification)
+    @notification.receipt_for(@entity1).first.trashed.should==true
+  end
+  
+  
+  
+  it "should be able to unread an owned Conversation (mark as unread)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.read.should==true
+    @entity1.unread(@conversation)
+    @conversation.receipts_for(@entity1).first.read.should==false
+  end
+  
+  it "should be able to read an owned Conversation (mark as read)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.read.should==true
+    @entity1.unread(@conversation)
+    @entity1.read(@conversation)
+    @conversation.receipts_for(@entity1).first.read.should==true
+  end
+  
+  it "should not be able to unread a not owned Conversation (mark as unread)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.read.should==true
+    @entity2.unread(@conversation)
+    @conversation.receipts_for(@entity1).first.read.should==true
+  end
+  
+  it "should not be able to read a not owned Conversation (mark as read)" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.read.should==true
+    @entity1.unread(@conversation)
+    @entity2.read(@conversation)
+    @conversation.receipts_for(@entity1).first.read.should==false
+  end
+  
+  it "should be able to trash an owned Conversation" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.trashed.should==false
+    @entity1.trash(@conversation)
+    @conversation.receipts_for(@entity1).first.trashed.should==true
+  end
+  
+  it "should be able to untrash an owned Conversation" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.trashed.should==false
+    @entity1.trash(@conversation)
+    @entity1.untrash(@conversation)
+    @conversation.receipts_for(@entity1).first.trashed.should==false
+  end
+  
+  it "should not be able to trash a not owned Conversation" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.trashed.should==false
+    @entity2.trash(@conversation)
+    @conversation.receipts_for(@entity1).first.trashed.should==false
+  end
   
+  it "should not be able to untrash a not owned Conversation" do
+    @receipt = @entity1.send_message(@entity2,"Body","Subject")
+    @conversation = @receipt.conversation
+    @receipt.trashed.should==false
+    @entity1.trash(@conversation)
+    @entity2.untrash(@conversation)
+    @conversation.receipts_for(@entity1).first.trashed.should==true
+  end
+
+
   
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta