curationexperts-mailboxer 0.10.3.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2c8a26ae7c959416ecf05e4f596960cef2704c5
+  data.tar.gz: 6b213b2edbc6c9773102cb3bd657130adf66fba3
+SHA512:
+  metadata.gz: 76a2a3ad96c9d859199b8cd792a701832977062535d02ec4cb9ac9cffb74b5087314f0d7d75d3495dd80d41fe9c388e7a98cf8459a387d62abd924e585aac3cf
+  data.tar.gz: 2be1cf1b92b7a8db4bff3932226ce3ce07a96810dac9aa39ad44e85ec1a767df81970649b0a7f783d06bd385540b556538d8842f7bff1e57d2bbc701b8288c89

data/.gitignore

@@ -0,0 +1,18 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/log/*.lck
+spec/dummy/tmp/
+spec/dummy/.project
+spec/dummy/solr
+**.tmp_*
+Gemfile.lock
+.idea
+.project
+.document
+.settings/
+rdoc/
+doc/
+.yardoc/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ree
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode

data/.yardopts

@@ -0,0 +1,2 @@
+lib/**/*.rb
+app/**/*.rb

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Universidad Politécnica de Madrid
+
+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.md

@@ -0,0 +1,273 @@
+# 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)
+
+This project is based on the need of 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
+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
+`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.
+
+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.
+Please, give us some time if you find something missing or [ask for
+it](https://github.com/ging/mailboxer/issues).
+
+Installation
+------------
+
+Add to your Gemfile:
+
+```ruby
+gem 'mailboxer'
+```
+
+Then run:
+
+```sh
+$ bundle update
+```
+
+Run install script:
+
+```sh
+$ rails g mailboxer:install
+```
+
+And don't forget to migrate you database:
+
+```sh
+$ rake db:migrate
+```
+
+## Requirements & Settings
+
+### 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.
+
+```ruby
+Mailboxer.setup do |config|
+  #Configures if you applications uses or no the email sending for Notifications and Messages
+  config.uses_emails = true  
+  #Configures the default from 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 
+
+```ruby
+Mailboxer.setup do |config|
+  config.notification_mailer = CustomNotificationMailer
+  config.message_mailer = CustomMessageMailer
+  ...
+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:
+
+```ruby
+#Returning any kind of identification you want for the model
+def name
+  return "You should add method :name in your Messageable model"
+end
+```
+
+```ruby
+#Returning the email address of the model if an email should be sent for this object (Message or Notification).
+#If no mail has to be sent, return nil.
+def mailboxer_email(object)
+  #Check if an email should be sent for that object
+  #if true
+  return "define_email@on_your.model"
+  #if false
+  #return nil
+end
+```
+
+These names are explicit enough to avoid colliding with other methods, but as long as you need to change them you can do it by using mailboxer initializer (/config/initializer/mailboxer.rb). Just add or uncomment the following lines:
+
+```ruby
+Mailboxer.setup do |config|
+  # ...
+  #Configures the methods needed by mailboxer
+  config.email_method = :mailboxer_email
+  config.name_method = :name
+  # ...
+end
+```
+
+You may change whatever you want or need. For example:
+
+```ruby
+config.email_method = :notifications_email
+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.
+
+## Preparing your models
+
+In your model:
+
+```ruby
+class User < ActiveRecord::Base
+  acts_as_messageable
+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.
+
+Example:
+
+```ruby
+class Duck < ActiveRecord::Base
+  acts_as_messageable
+end
+```
+
+```ruby
+class Cylon < ActiveRecord::Base
+  acts_as_messageable
+end
+```
+
+## Mailboxer API
+
+### Warning for version 0.8.0
+Version 0.8.0 sees `Messageable#read` and `Messageable#unread` renamed to `mark_as_(un)read`, and `Receipt#read` and `Receipt#unread` to `is_(un)read`. This may break existing applications, but `read` is a reserved name for Active Record, and the best pratice in this case is simply avoid using it.
+
+### How can I send a message?
+
+```ruby
+#alfa wants to send a message to beta
+alfa.send_message(beta, "Body", "subject")
+```
+
+### How can I reply a message?
+
+```ruby
+#alfa wants to reply to all in a conversation
+#using a receipt
+alfa.reply_to_all(receipt, "Reply body")
+
+#using a conversation
+alfa.reply_to_conversation(conversation, "Reply body")
+```
+
+```ruby
+#alfa wants to reply to the sender of a message (and ONLY the sender)
+#using a receipt
+alfa.reply_to_sender(receipt, "Reply body")
+```
+
+### How can I retrieve my conversations?
+
+```ruby
+#alfa wants to retrieve all his conversations
+alfa.mailbox.conversations
+
+#A wants to retrieve his inbox
+alfa.mailbox.inbox
+
+#A wants to retrieve his sent conversations
+alfa.mailbox.sentbox
+
+#alfa wants to retrieve his trashed conversations
+alfa.mailbox.trash
+```
+
+### 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.
+
+```ruby
+#Paginating all conversations using :page parameter and 9 per page
+conversations = alfa.mailbox.conversations.page(params[:page]).per(9)
+
+#Paginating received conversations using :page parameter and 9 per page
+conversations = alfa.mailbox.inbox.page(params[:page]).per(9)
+  
+#Paginating sent conversations using :page parameter and 9 per page
+conversations = alfa.mailbox.sentbox.page(params[:page]).per(9)
+
+#Paginating trashed conversations using :page parameter and 9 per page
+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.
+
+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.
+
+```ruby
+#alfa gets the last conversation (chronologically, the first in the inbox)
+conversation = alfa.mailbox.inbox.first
+
+#alfa gets it receipts chronologically ordered.
+receipts = conversation.receipts_for alfa
+
+#using the receipts (i.e. in the view)
+receipts.each do |receipt|
+  ...
+  message = receipt.message
+  read = receipt.is_unread? #or message.is_unread?(alfa)
+  ...
+end
+```
+
+You can take a look at the full documentation of Mailboxer in [rubydoc.info](http://rubydoc.info/gems/mailboxer/frames).
+
+## Do you want to test Mailboxer?
+
+Thanks to [Roman Kushnir (@RKushnir)](https://github.com/RKushnir/) you can test Mailboxer with this [sample app](https://github.com/RKushnir/mailboxer-app).
+
+## I need a GUI!
+
+If you need a GUI you should take a look a this 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).
+
+## Contributors
+* [Roendal](https://github.com/ging/mailboxer/commits/master?author=Roendal) (Eduardo Casanova)
+* [dickeyxxx](https://github.com/ging/mailboxer/commits/master?author=dickeyxxx) (Jeff Dickey)
+* [RKushnir](https://github.com/ging/mailboxer/commits/master?author=RKushnir) (Roman Kushnir)
+* [amaierhofer](https://github.com/ging/mailboxer/commits/master?author=amaierhofer) (Andreas Maierhofer)
+* [tonydewan](https://github.com/ging/mailboxer/commits/master?author=tonydewan) (Tony Dewan)
+* [plentz](https://github.com/ging/mailboxer/commits/master?author=plentz) (Diego Plentz)
+* [laserlemon](https://github.com/ging/mailboxer/commits/master?author=laserlemon) (Steve Richert)
+* [daveworth](https://github.com/ging/mailboxer/commits/master?author=daveworth) (Dave Worth)
+* [rafaelgg](https://github.com/ging/mailboxer/commits/master?author=rafaelgg) (Rafael Garcia)
+* [joshblour](https://github.com/ging/mailboxer/commits/master?author=joshblour) (joshblour)
+* [iamdeuterium](https://github.com/ging/mailboxer/commits/master?author=iamdeuterium) (iamdeuterium)
+* [daveworth](https://github.com/ging/mailboxer/commits/master?author=daveworth) (Dave Worth)
+* [parndt](https://github.com/ging/mailboxer/commits/master?author=parndt) (Philip Arndt)
+* [atd](https://github.com/ging/mailboxer/commits/master?author=atd) (Antonio Tapiador)
+* [mobilutz](https://github.com/ging/mailboxer/commits/master?author=mobilutz) (Lutz)
+* [bennick](https://github.com/ging/mailboxer/commits/master?author=bennick) (Ryan Bennick)
+* [rjst](https://github.com/ging/mailboxer/commits/master?author=rjst) (Ricardo Trindade)
+* [fabianoalmeida](https://github.com/ging/mailboxer/commits/master?author=fabianoalmeida) (Fabiano Almeida)

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/app/mailers/message_mailer.rb

@@ -0,0 +1,37 @@
+class MessageMailer < ActionMailer::Base
+  default :from => Mailboxer.default_from
+  #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 
+      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
+  def new_message_email(message,receiver)
+    @message = message
+    @receiver = receiver
+    subject = message.subject.to_s
+    subject = strip_tags(subject) unless subject.html_safe?
+    mail :to => receiver.send(Mailboxer.email_method,message),
+         :subject => t('mailboxer.message_mailer.subject_new', :subject => subject),
+         :template_name => 'new_message_email'
+  end
+
+  #Sends and email for indicating a reply in an already created conversation
+  def reply_message_email(message,receiver)
+    @message = message
+    @receiver = receiver
+    subject = message.subject.to_s
+    subject = strip_tags(subject) unless subject.html_safe?
+    mail :to => receiver.send(Mailboxer.email_method,message),
+         :subject => t('mailboxer.message_mailer.subject_reply', :subject => subject),
+         :template_name => 'reply_message_email'
+  end
+end

data/app/mailers/notification_mailer.rb

@@ -0,0 +1,21 @@
+class NotificationMailer < ActionMailer::Base
+  default :from => Mailboxer.default_from
+  #Sends and email for indicating a new notification to a receiver.
+  #It calls new_notification_email.
+  def send_email(notification,receiver)
+    new_notification_email(notification,receiver)
+  end
+
+  include ActionView::Helpers::SanitizeHelper
+
+  #Sends an email for indicating a new message for the receiver
+  def new_notification_email(notification,receiver)
+    @notification = notification
+    @receiver = receiver
+    subject = notification.subject.to_s
+    subject = strip_tags(subject) unless subject.html_safe?
+    mail :to => receiver.send(Mailboxer.email_method,notification),
+         :subject => t('mailboxer.notification_mailer.subject', :subject => subject),
+         :template_name => 'new_notification_email'
+  end
+end

data/app/models/conversation.rb

@@ -0,0 +1,143 @@
+class Conversation < ActiveRecord::Base
+  attr_accessible :subject if Rails::VERSION::MAJOR == 3
+
+	has_many :messages, :dependent => :destroy
+	has_many :receipts, :through => :messages
+
+	validates_presence_of :subject
+
+	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))
+  }
+  scope :inbox, lambda {|participant|
+    participant(participant).merge(Receipt.inbox.not_trash)
+  }
+  scope :sentbox, lambda {|participant|
+    participant(participant).merge(Receipt.sentbox.not_trash)
+  }
+  scope :trash, lambda {|participant|
+    participant(participant).merge(Receipt.trash)
+  }
+  scope :unread,  lambda {|participant|
+    participant(participant).merge(Receipt.is_unread)
+  }
+  scope :not_trash,  lambda {|participant|
+    participant(participant).merge(Receipt.not_trash)
+  }
+
+  #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
+
+  #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
+
+  #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
+
+  #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
+
+  #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
+
+  #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.order('created_at').first 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
+
+	#Last message in the conversation.
+	def last_message
+		@last_message = self.messages.order('created_at DESC').first if @last_message.nil?
+		return @last_message
+	end
+
+  #Returns the receipts of the conversation for one participants
+	def receipts_for(participant)
+	  return Receipt.conversation(self).recipient(participant)
+	end
+
+  #Returns the number of messages of the conversation
+	def count_messages
+		return 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
+	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
+
+  #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_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
+
+	protected
+
+	include ActionView::Helpers::SanitizeHelper
+
+  #Use the default sanitize to clean the conversation subject
+	def clean
+		self.subject = sanitize self.subject
+	end
+
+end