mailboxer 0.10.3 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd3c7b425e191ba6788668307d71c0a472d0db03
-  data.tar.gz: f9910f2a5eae2f12f4daf3a56c5654b89bf8e716
+  metadata.gz: b22e110378d5da7e6e327c807f46a5f0475b2fa1
+  data.tar.gz: bc9242e076e3a10d2e3d9ca1106a42200ca7bc12
 SHA512:
-  metadata.gz: a0fcdb2b6596e63d82183fbf73f758fb0755bfe2afe1c7e9939a041e35b2959c37bcfa41aceecac62314d16967bf6e77a9dd628d7d7c58361a34b76d82e603d5
-  data.tar.gz: c3ab6f97dfaf4dd8b808cd52f8c66551a576a554231c0a6142d7d37b715e4c04abcc14eb1f7c71ea3590ed494b03de21990cc8834a45f9b6c32c3fb6c3874ce9
+  metadata.gz: f67c3839eb84ce3153e7e9b1b50b012f80a1d17bdb56589e18279ba1043e3e4fc4f443c17b2ed9cff7a0e4bcbc9ebef10139bd63de67b520ac12f3fcd40bc05e
+  data.tar.gz: 277d0c3921688613e407b095665d7d2b2afe783294f1500d9ba2a423c83460b5854711520a9cfaddcec876b864924c65136edcd78dbdad4fbbd8286eb5d5405f

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - ree
-  - rbx-18mode
+  - 2.0.0
   - rbx-19mode
-  - jruby-18mode
   - jruby-19mode
+gemfile:
+  #- gemfiles/rails3.0.gemfile
+  - gemfiles/rails3.1.gemfile
+  - gemfiles/rails3.2.gemfile
+  - gemfiles/rails4.0.gemfile

data/Appraisals

@@ -0,0 +1,19 @@
+# appraise "rails3.0" do
+#   gem "rails", "~> 3.0.15"
+#   gem "mailboxer", :path => "../"
+# end
+
+appraise "rails3.1" do
+  gem "rails", "~> 3.1.6"
+  gem "mailboxer", :path => "../"
+end
+
+appraise "rails3.2" do
+  gem "rails", "~> 3.2.6"
+  gem "mailboxer", :path => "../"
+end
+
+appraise "rails4.0" do
+  gem "rails", ">=4.0.0"
+  gem "mailboxer", :path => "../"
+end

data/LICENSE.txt

@@ -1,3 +1,4 @@
+Copyright (c) 2013 Justin Coyne
 Copyright (c) 2012 Universidad Politécnica de Madrid
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -1,31 +1,31 @@
-# Mailboxer 0.10.x [![](https://secure.travis-ci.org/ging/mailboxer.png)](http://travis-ci.org/ging/mailboxer) [![](https://gemnasium.com/ging/mailboxer.png)](https://gemnasium.com/ging/mailboxer)
+# Mailboxer 0.10.x [![](https://secure.travis-ci.org/ging/mailboxer.png)](http://travis-ci.org/ging/mailboxer) [![Gem Version](https://badge.fury.io/rb/mailboxer.png)](http://badge.fury.io/rb/mailboxer) [![](https://gemnasium.com/ging/mailboxer.png)](https://gemnasium.com/ging/mailboxer)
 
-This project is based on the need of a private message system for [ging
+This project is based on the need for a private message system for [ging
 / social\_stream](https://github.com/ging/social_stream). Instead of creating our core message system heavily
-dependent on our development we are trying to implement a generic and
+dependent on our development, we are trying to implement a generic and
 potent messaging gem.
 
-After looking for a good gem to use we notice the lack of messaging gems
-and functionality in them. Mailboxer tries to fill this emptiness giving
-a powerfull and generic message system. It supports the use of
-conversations with two or more recipients, send notification to a
-recipient (intended to be used as system notifications “Your picture has
-new comments”, “John Doe has updated its document”, etc.), emails the
-messageable model (if configured to do so). It has a complete use of a
-`Mailbox` object for each messageable with `inbox`, `sentbox` and
+After looking for a good gem to use we noticed the lack of messaging gems
+and functionality in them. Mailboxer tries to fill this void delivering
+a powerful and flexible message system. It supports the use of
+conversations with two or more participants, sending notifications to
+recipients (intended to be used as system notifications “Your picture has
+new comments”, “John Doe has updated his document”, etc.), and emailing the
+messageable model (if configured to do so). It has a complete implementation 
+of a `Mailbox` object for each messageable with `inbox`, `sentbox` and
 `trash`.
 
 The gem is constantly growing and improving its functionality. As it is
 used with our parallel development [ging / social\_stream](https://github.com/ging/social_stream) we are finding and fixing bugs continously. If you want
 some functionality not supported yet or marked as TODO, you can create
-an [issue](https://github.com/ging/mailboxer/issues) to ask for it. It will be a great feedback for us, and we
-will know what you may find useful of the gem.
+an [issue](https://github.com/ging/mailboxer/issues) to ask for it. It will be great feedback for us, and we
+will know what you may find useful in the gem.
 
 Mailboxer was born from the great, but outdated, code from [lpsergi /
 acts*as*messageable](https://github.com/psergi/acts_as_messageable).
 
-We are now working to make an exhaustive documentation and some wiki
-pages in order to make even easier to use the gem at its full potencial.
+We are now working to make exhaustive documentation and some wiki
+pages in order to make it even easier to use the gem to its full potencial.
 Please, give us some time if you find something missing or [ask for
 it](https://github.com/ging/mailboxer/issues).
 
@@ -50,7 +50,7 @@ Run install script:
 $ rails g mailboxer:install
 ```
 
-And don't forget to migrate you database:
+And don't forget to migrate your database:
 
 ```sh
 $ rake db:migrate
@@ -60,19 +60,19 @@ $ rake db:migrate
 
 ### Emails
 
-We are now adding support for sending emails when a Notification or a Message is sent to one or more recipients. You should modify mailboxer initializer (/config/initializer/mailboxer.rb) to edit this settings.
+We are now adding support for sending emails when a Notification or a Message is sent to one or more recipients. You should modify the mailboxer initializer (/config/initializer/mailboxer.rb) to edit these settings.
 
 ```ruby
 Mailboxer.setup do |config|
-  #Configures if you applications uses or no the email sending for Notifications and Messages
+  #Enables or disables email sending for Notifications and Messages
   config.uses_emails = true  
-  #Configures the default from for the email sent for Messages and Notifications of Mailboxer
+  #Configures the default `from` address for the email sent for Messages and Notifications of Mailboxer
   config.default_from = "no-reply@dit.upm.es"
   ...
 end
 ```
 
-You can change the way in which emails are delivered by specifying a custom implementation for notification and message mailer 
+You can change the way in which emails are delivered by specifying a custom implementation of notification and message mailers
 
 ```ruby
 Mailboxer.setup do |config|
@@ -84,7 +84,7 @@ end
 
 ### User identities
 
-Users must have an identity defined by a `name` and an `email`. We must assure that Messageable models have some specific methods. These methods are:
+Users must have an identity defined by a `name` and an `email`. We must ensure that Messageable models have some specific methods. These methods are:
 
 ```ruby
 #Returning any kind of identification you want for the model
@@ -126,7 +126,7 @@ config.name_method = :display_name
 
 Will use the method `notification_email(object)` instead of `mailboxer_email(object)` and `display_name` for `name`.
 
-Using default or custom method names, if your model doesn't implement them, Mailboxer will use dummy methods not to crash but notify you the missing methods.
+Using default or custom method names, if your model doesn't implement them, Mailboxer will use dummy methods so as to notify you of missing methods rather than crashing.
 
 ## Preparing your models
 
@@ -138,7 +138,7 @@ class User < ActiveRecord::Base
 end
 ```
 
-You are not limited to User model. You can use Mailboxer in any other model and use it in serveral different models. If you have ducks and cylons in your application and you want to interchange messages as if they where the same, just use act_as_messageable in each one and you will be able to send duck-duck, duck-cylon, cylon-duck and cylon-cylon messages. Of course, you can extend it for as many clases as you need.
+You are not limited to the User model. You can use Mailboxer in any other model and use it in serveral different models. If you have ducks and cylons in your application and you want to exchange messages as if they were the same, just add `acts_as_messageable` to each one and you will be able to send duck-duck, duck-cylon, cylon-duck and cylon-cylon messages. Of course, you can extend it for as many classes as you need.
 
 Example:
 
@@ -199,6 +199,25 @@ alfa.mailbox.sentbox
 alfa.mailbox.trash
 ```
 
+### How can I delete a message from trash?
+
+```ruby
+#delete conversations forever for one receipt (still in database)
+receipt.mark_as_deleted
+
+#you can mark conversation as deleted for one participant
+conversation.mark_as_deleted participant
+
+#Mark the object as deleted for messageable
+#Object can be:
+  #* A Receipt
+  #* A Conversation
+  #* A Notification
+  #* A Message
+  #* An array with any of them
+alfa.mark_as_deleted conversation
+```
+
 ### How can I paginate conversations?
 
 You can use Kaminari to paginate the conversations as normal. Please, make sure you use the last version as mailboxer uses `select('DISTINCT conversations.*')` which was not respected before Kaminari 0.12.4 according to its changelog. Working corretly on Kaminari 0.13.0.
@@ -219,7 +238,7 @@ conversations = alfa.mailbox.trash.page(params[:page]).per(9)
 
 ### How can I read the messages of a conversation?
 
-As a messageable, what you receive receipts wich are linked with the message itself. You should retrieve your receipts for the conversation a get the message associated to them.
+As a messageable, what you receive are receipts, which are associated with the message itself. You should retrieve your receipts for the conversation a get the message associated with them.
 
 This is done this way because receipts save the information about the relation between messageable and the messages: is it read?, is it trashed?, etc.
 
@@ -239,7 +258,7 @@ receipts.each do |receipt|
 end
 ```
 
-You can take a look at the full documentation of Mailboxer in [rubydoc.info](http://rubydoc.info/gems/mailboxer/frames).
+You can take a look at the full documentation for Mailboxer in [rubydoc.info](http://rubydoc.info/gems/mailboxer/frames).
 
 ## Do you want to test Mailboxer?
 
@@ -247,7 +266,7 @@ Thanks to [Roman Kushnir (@RKushnir)](https://github.com/RKushnir/) you can test
 
 ## I need a GUI!
 
-If you need a GUI you should take a look a this links:
+If you need a GUI you should take a look a these links:
 
 * The [rails-messaging](https://github.com/frodefi/rails-messaging) project.
 * The wiki page [GUI Example on a real application](https://github.com/ging/mailboxer/wiki/GUI-Example-on-a-real-application).

data/Rakefile

@@ -1,5 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+
 require "bundler/gem_tasks"
 
+require 'appraisal'
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)

data/app/mailers/message_mailer.rb

@@ -1,16 +1,16 @@
 class MessageMailer < ActionMailer::Base
   default :from => Mailboxer.default_from
-  #Sends and email for indicating a new message or a reply to a receiver. 
+  #Sends and email for indicating a new message or a reply to a receiver.
   #It calls new_message_email if notifing a new message and reply_message_email
   #when indicating a reply to an already created conversation.
-  def send_email(message,receiver)    
-    if message.conversation.messages.size > 1 
+  def send_email(message, receiver)
+    if message.conversation.messages.size > 1
       reply_message_email(message,receiver)
     else
       new_message_email(message,receiver)
     end
   end
-  
+
   include ActionView::Helpers::SanitizeHelper
 
   #Sends an email for indicating a new message for the receiver

data/app/models/conversation.rb

@@ -1,24 +1,24 @@
 class Conversation < ActiveRecord::Base
-  attr_accessible :subject
+  attr_accessible :subject if Mailboxer.protected_attributes?
 
-	has_many :messages, :dependent => :destroy
-	has_many :receipts, :through => :messages
+  has_many :messages, :dependent => :destroy
+  has_many :receipts, :through => :messages
 
-	validates_presence_of :subject
+  validates_presence_of :subject
 
-	before_validation :clean
+  before_validation :clean
 
   scope :participant, lambda {|participant|
     select('DISTINCT conversations.*').
-    where('notifications.type'=> Message.name).
-    order("conversations.updated_at DESC").
-    joins(:receipts).merge(Receipt.recipient(participant))
+      where('notifications.type'=> Message.name).
+      order("conversations.updated_at DESC").
+      joins(:receipts).merge(Receipt.recipient(participant))
   }
   scope :inbox, lambda {|participant|
-    participant(participant).merge(Receipt.inbox.not_trash)
+    participant(participant).merge(Receipt.inbox.not_trash.not_deleted)
   }
   scope :sentbox, lambda {|participant|
-    participant(participant).merge(Receipt.sentbox.not_trash)
+    participant(participant).merge(Receipt.sentbox.not_trash.not_deleted)
   }
   scope :trash, lambda {|participant|
     participant(participant).merge(Receipt.trash)
@@ -31,113 +31,136 @@ class Conversation < ActiveRecord::Base
   }
 
   #Mark the conversation as read for one of the participants
-	def mark_as_read(participant)
-		return if participant.nil?
-		return self.receipts_for(participant).mark_as_read
-	end
+  def mark_as_read(participant)
+    return if participant.nil?
+    self.receipts_for(participant).mark_as_read
+  end
 
   #Mark the conversation as unread for one of the participants
-	def mark_as_unread(participant)
-		return if participant.nil?
-		return self.receipts_for(participant).mark_as_unread
-	end
+  def mark_as_unread(participant)
+    return if participant.nil?
+    self.receipts_for(participant).mark_as_unread
+  end
 
   #Move the conversation to the trash for one of the participants
-	def move_to_trash(participant)
-		return if participant.nil?
-		return self.receipts_for(participant).move_to_trash
-	end
+  def move_to_trash(participant)
+    return if participant.nil?
+    self.receipts_for(participant).move_to_trash
+  end
 
   #Takes the conversation out of the trash for one of the participants
-	def untrash(participant)
-		return if participant.nil?
-		return self.receipts_for(participant).untrash
-	end
+  def untrash(participant)
+    return if participant.nil?
+    self.receipts_for(participant).untrash
+  end
 
-  #Returns an array of participants
-	def recipients
-		if self.last_message
-			recps = self.last_message.recipients
-			recps = recps.is_a?(Array) ? recps : [recps]
-		return recps
-		end
-		return []
-	end
+  #Mark the conversation as deleted for one of the participants
+  def mark_as_deleted(participant)
+    return if participant.nil?
+    return self.receipts_for(participant).mark_as_deleted
+  end
 
   #Returns an array of participants
-	def participants
-	  return recipients
-	end
-
-	#Originator of the conversation.
-	def originator
-		@originator = self.original_message.sender if @originator.nil?
-		return @originator
-	end
-
-	#First message of the conversation.
-	def original_message
-		@original_message = self.messages.find(:first, :order => 'created_at') if @original_message.nil?
-		return @original_message
-	end
-
-	#Sender of the last message.
-	def last_sender
-		@last_sender = self.last_message.sender if @last_sender.nil?
-		return @last_sender
-	end
+  def recipients
+    if self.last_message
+      recps = self.last_message.recipients
+      recps = recps.is_a?(Array) ? recps : [recps]
+      recps
+    else
+      []
+    end
+  end
 
-	#Last message in the conversation.
-	def last_message
-		@last_message = self.messages.find(:first, :order => 'created_at DESC') if @last_message.nil?
-		return @last_message
-	end
+  #Returns an array of participants
+  def participants
+    recipients
+  end
+
+  #Originator of the conversation.
+  def originator
+    @originator ||= self.original_message.sender
+  end
+
+  #First message of the conversation.
+  def original_message
+    @original_message ||= self.messages.order('created_at').first
+  end
+
+  #Sender of the last message.
+  def last_sender
+    @last_sender ||= self.last_message.sender
+  end
+
+  #Last message in the conversation.
+  def last_message
+    @last_message ||= self.messages.order('created_at DESC').first
+  end
 
   #Returns the receipts of the conversation for one participants
-	def receipts_for(participant)
-	  return Receipt.conversation(self).recipient(participant)
-	end
+  def receipts_for(participant)
+    Receipt.conversation(self).recipient(participant)
+  end
 
   #Returns the number of messages of the conversation
-	def count_messages
-		return Message.conversation(self).count
-	end
+  def count_messages
+    Message.conversation(self).count
+  end
 
   #Returns true if the messageable is a participant of the conversation
-	def is_participant?(participant)
-		return false if participant.nil?
-		return self.receipts_for(participant).count != 0
+  def is_participant?(participant)
+    return false if participant.nil?
+    self.receipts_for(participant).count != 0
+  end
+
+	#Adds a new participant to the conversation
+	def add_participant(participant)
+		messages = self.messages
+		messages.each do |message|
+		  receipt = Receipt.new
+		  receipt.notification = message
+		  receipt.is_read = false
+		  receipt.receiver = participant
+		  receipt.mailbox_type = 'inbox'
+		  receipt.updated_at = message.updated_at
+		  receipt.created_at = message.created_at
+		  receipt.save
+		end
 	end
 
   #Returns true if the participant has at least one trashed message of the conversation
-	def is_trashed?(participant)
-		return false if participant.nil?
-		return self.receipts_for(participant).trash.count!=0
-	end
+  def is_trashed?(participant)
+    return false if participant.nil?
+    self.receipts_for(participant).trash.count != 0
+  end
+
+  #Returns true if the participant has deleted the conversation
+  def is_deleted?(participant)
+    return false if participant.nil?
+    return self.receipts_for(participant).trash.count==0
+  end
 
   #Returns true if the participant has trashed all the messages of the conversation
-	def is_completely_trashed?(participant)
-		return false if participant.nil?
-		return self.receipts_for(participant).trash.count == self.receipts_for(participant).count
-	end
+  def is_completely_trashed?(participant)
+    return false if participant.nil?
+    self.receipts_for(participant).trash.count == self.receipts_for(participant).count
+  end
 
-	def is_read?(participant)
-		!self.is_unread?(participant)
-	end
+  def is_read?(participant)
+    !self.is_unread?(participant)
+  end
 
   #Returns true if the participant has at least one unread message of the conversation
-	def is_unread?(participant)
-		return false if participant.nil?
-		return self.receipts_for(participant).not_trash.is_unread.count!=0
-	end
+  def is_unread?(participant)
+    return false if participant.nil?
+    self.receipts_for(participant).not_trash.is_unread.count != 0
+  end
 
-	protected
+  protected
 
-	include ActionView::Helpers::SanitizeHelper
+  include ActionView::Helpers::SanitizeHelper
 
   #Use the default sanitize to clean the conversation subject
-	def clean
-		self.subject = sanitize self.subject
-	end
-
+  def clean
+    self.subject = sanitize self.subject
+  end
 end