mailboxer 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76560ca95f622b27cb610d4e333f5f07da0145f0
-  data.tar.gz: 5865f0a7a71a57403bc459cae32aba44b2a3ca4e
+  metadata.gz: 20ef2352a667a4efe2b58ba03e9e0ec71be8c6f5
+  data.tar.gz: 62b56eef4d08c04fffea2050d547ea65331cd8d9
 SHA512:
-  metadata.gz: 39519d696f2bc2240d62c3e79738d195148d817cf105cf47a75a74d717c70c58823787bd3c9e0fe6f16977ab731ee858524535b22a5f5755ad5b033d3ad53dd8
-  data.tar.gz: 87c71b2d1e53a05dc3d27842b7dd25577610d28e1016dc3b61e2d190f653e0fcb5bd25cb613e83c6a71df92eb20a66a78759ecb89251db76378ed81d6620f187
+  metadata.gz: 1aa5bbfb3de37857cbccfee7e010f73d9bc92b03e6b221e5bbf4210af8e5fa599b9227bd4f922752d6f19342f846f328e5a3cb08b319bf818f07ba773b615ce8
+  data.tar.gz: 5d6dc14ece4e486dce7ff21afb63ee2d562092e29792cad1dc74fb91135f69c564853b8e939efb9702a305d5f49c168eb57e615830678bb173f45983bb86be74

data/.travis.yml

@@ -3,22 +3,19 @@ cache: bundler
 sudo: false
 
 rvm:
-  - 2.1.4
-
-matrix:
-  include:
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails4.1.gemfile
-    - rvm: 2.0
-      gemfile: gemfiles/rails4.1.gemfile
-    - rvm: jruby-19mode
-      gemfile: gemfiles/rails4.1.gemfile
+  - 2.1.10
+  - 2.2.5
+  - 2.3.1
 
 gemfile:
-  - gemfiles/rails3.2.gemfile
-  - gemfiles/rails4.0.gemfile
-  - gemfiles/rails4.1.gemfile
   - gemfiles/rails4.2.gemfile
+  - gemfiles/rails5.0.gemfile
+
+matrix:
+  exclude:
+    - rvm: 2.1.10
+      gemfile: gemfiles/rails5.0.gemfile
+
 env:
   global:
     - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Appraisals

@@ -1,11 +1,3 @@
-appraise "rails3.2" do
-  gem "rails", "~> 3.2.17"
-end
-
-appraise "rails4.0" do
-  gem "rails", "~> 4.0.4"
-end
-
-appraise "rails4.1" do
-  gem "rails", "~> 4.1.0"
+appraise "rails4.2" do
+  gem "rails", "~> 4.2.6"
 end

data/README.md

@@ -188,7 +188,29 @@ Version 0.8.0 sees `Messageable#read` and `Messageable#unread` renamed to `mark_
 alfa.send_message(beta, "Body", "subject")
 ```
 
-### How can I reply a message?
+### How can I read the messages of a conversation?
+
+As a messageable, what you receive are receipts, which are associated with the message itself. You should retrieve your receipts for the conversation and 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.
+
+```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
+```
+
+### How can I reply to a message?
 
 ```ruby
 #alfa wants to reply to all in a conversation
@@ -205,22 +227,6 @@ alfa.reply_to_conversation(conversation, "Reply body")
 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 delete a message from trash?
 
 ```ruby
@@ -239,10 +245,25 @@ conversation.mark_as_deleted participant
   #* An array with any of them
 alfa.mark_as_deleted conversation
 ```
+### 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.
+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 correctly on Kaminari 0.13.0.
 
 ```ruby
 #Paginating all conversations using :page parameter and 9 per page
@@ -258,28 +279,6 @@ conversations = alfa.mailbox.sentbox.page(params[:page]).per(9)
 conversations = alfa.mailbox.trash.page(params[:page]).per(9)
 ```
 
-### How can I read the messages of a conversation?
-
-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.
-
-```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 for Mailboxer in [rubydoc.info](http://rubydoc.info/gems/mailboxer/frames).
 
 ## Do you want to test Mailboxer?
@@ -288,7 +287,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 these links:
+If you need a GUI you should take a look at 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/app/builders/mailboxer/message_builder.rb

@@ -5,12 +5,4 @@ class Mailboxer::MessageBuilder < Mailboxer::BaseBuilder
   def klass
     Mailboxer::Message
   end
-
-  def subject
-    params[:subject] || default_subject
-  end
-
-  def default_subject
-    "#{params[:conversation].subject}"
-  end
 end

data/app/mailers/mailboxer/notification_mailer.rb

@@ -1,5 +1,5 @@
 class Mailboxer::NotificationMailer < Mailboxer::BaseMailer
-  #Sends and email for indicating a new notification to a receiver.
+  #Sends an email for indicating a new notification to a receiver.
   #It calls new_notification_email.
   def send_email(notification, receiver)
     new_notification_email(notification, receiver)

data/app/models/mailboxer/conversation.rb

@@ -14,8 +14,8 @@ class Mailboxer::Conversation < ActiveRecord::Base
 
   scope :participant, lambda {|participant|
     where('mailboxer_notifications.type'=> Mailboxer::Message.name).
-    order("mailboxer_conversations.updated_at DESC").
-    joins(:receipts).merge(Mailboxer::Receipt.recipient(participant)).uniq
+    order(updated_at: :desc).
+    joins(:receipts).merge(Mailboxer::Receipt.recipient(participant)).distinct
   }
   scope :inbox, lambda {|participant|
     participant(participant).merge(Mailboxer::Receipt.inbox.not_trash.not_deleted)
@@ -32,6 +32,13 @@ class Mailboxer::Conversation < ActiveRecord::Base
   scope :not_trash,  lambda {|participant|
     participant(participant).merge(Mailboxer::Receipt.not_trash)
   }
+  scope :between, lambda {|participant_one, participant_two|
+    joins("INNER JOIN (#{Mailboxer::Notification.recipient(participant_two).to_sql}) participant_two_notifications " \
+          "ON participant_two_notifications.conversation_id = #{table_name}.id AND participant_two_notifications.type IN ('Mailboxer::Message')").
+        joins("INNER JOIN mailboxer_receipts ON mailboxer_receipts.notification_id = participant_two_notifications.id").
+        merge(Mailboxer::Receipt.recipient(participant_one)).
+        order(updated_at: :desc).distinct
+  }
 
   #Mark the conversation as read for one of the participants
   def mark_as_read(participant)
@@ -115,17 +122,17 @@ class Mailboxer::Conversation < ActiveRecord::Base
     receipts_for(participant).any?
   end
 
-	#Adds a new participant to the conversation
-	def add_participant(participant)
-		messages.each do |message|
+  #Adds a new participant to the conversation
+  def add_participant(participant)
+    messages.each do |message|
       Mailboxer::ReceiptBuilder.new({
         :notification => message,
         :receiver     => participant,
         :updated_at   => message.updated_at,
         :created_at   => message.created_at
       }).build.save
-		end
-	end
+    end
+  end
 
   #Returns true if the participant has at least one trashed message of the conversation
   def is_trashed?(participant)
@@ -163,7 +170,7 @@ class Mailboxer::Conversation < ActiveRecord::Base
   end
 
   # Creates a opt out object
-  # because by default all particpants are opt in
+  # because by default all participants are opt in
   def opt_out(participant)
     return unless has_subscriber?(participant)
     opt_outs.create(:unsubscriber => participant)

data/app/models/mailboxer/mailbox.rb

@@ -17,6 +17,11 @@ class Mailboxer::Mailbox
     notifs
   end
 
+  #Returns the conversations between messageable and other messageable
+  def conversations_with(other_messageable)
+    Mailboxer::Conversation.between(messageable, other_messageable)
+  end
+
   #Returns the conversations for the messageable
   #
   #Options

data/app/models/mailboxer/message.rb

@@ -2,7 +2,7 @@ class Mailboxer::Message < Mailboxer::Notification
   attr_accessible :attachment if Mailboxer.protected_attributes?
   self.table_name = :mailboxer_notifications
 
-  belongs_to :conversation, :class_name => "Mailboxer::Conversation", :validate => true, :autosave => true
+  belongs_to :conversation, :validate => true, :autosave => true
   validates_presence_of :sender
 
   class_attribute :on_deliver_callback
@@ -11,7 +11,7 @@ class Mailboxer::Message < Mailboxer::Notification
     where(:conversation_id => conversation.id)
   }
 
-  mount_uploader :attachment, AttachmentUploader
+  mount_uploader :attachment, Mailboxer::AttachmentUploader
 
   class << self
     #Sets the on deliver callback method.
@@ -26,16 +26,17 @@ class Mailboxer::Message < Mailboxer::Notification
     self.clean if should_clean
 
     #Receiver receipts
-    temp_receipts = recipients.map { |r| build_receipt(r, 'inbox') }
+    receiver_receipts = recipients.map do |r|
+      receipts.build(receiver: r, mailbox_type: 'inbox', is_read: false)
+    end
 
     #Sender receipt
-    sender_receipt = build_receipt(sender, 'sentbox', true)
-
-    temp_receipts << sender_receipt
+    sender_receipt =
+      receipts.build(receiver: sender, mailbox_type: 'sentbox', is_read: true)
 
-    if temp_receipts.all?(&:valid?)
-      temp_receipts.each(&:save!)
-      Mailboxer::MailDispatcher.new(self, recipients).call
+    if valid?
+      save!
+      Mailboxer::MailDispatcher.new(self, receiver_receipts).call
 
       conversation.touch if reply
 

data/app/models/mailboxer/notification.rb

@@ -4,12 +4,11 @@ class Mailboxer::Notification < ActiveRecord::Base
   attr_accessor :recipients
   attr_accessible :body, :subject, :global, :expires if Mailboxer.protected_attributes?
 
-  belongs_to :sender, :polymorphic => :true
-  belongs_to :notified_object, :polymorphic => :true
+  belongs_to :sender, :polymorphic => :true, :required => false
+  belongs_to :notified_object, :polymorphic => :true, :required => false
   has_many :receipts, :dependent => :destroy, :class_name => "Mailboxer::Receipt"
 
-  validates :subject, :presence => true,
-                      :length => { :maximum => Mailboxer.subject_max_length }
+  validates :subject, :length => { :maximum => Mailboxer.subject_max_length }
   validates :body,    :presence => true,
                       :length => { :maximum => Mailboxer.body_max_length }
 
@@ -81,11 +80,14 @@ class Mailboxer::Notification < ActiveRecord::Base
   #Use Mailboxer::Models::Message.notify and Notification.notify_all instead.
   def deliver(should_clean = true, send_mail = true)
     clean if should_clean
-    temp_receipts = recipients.map { |r| build_receipt(r, nil, false) }
+    temp_receipts = recipients.map do |r|
+      receipts.build(receiver: r, mailbox_type: nil, is_read: false)
+    end
+
+    if valid?
+      Mailboxer::MailDispatcher.new(self, temp_receipts).call if send_mail
+      save!
 
-    if temp_receipts.all?(&:valid?)
-      temp_receipts.each(&:save!)   #Save receipts
-      Mailboxer::MailDispatcher.new(self, recipients).call if send_mail
       self.recipients = nil
     end
 
@@ -96,7 +98,8 @@ class Mailboxer::Notification < ActiveRecord::Base
   #Returns the recipients of the Notification
   def recipients
     return Array.wrap(@recipients) unless @recipients.blank?
-    @recipients = receipts.map { |receipt| receipt.receiver }
+    recipients  = receipts.includes(:receiver).map(&:receiver)
+    @recipients = Mailboxer::RecipientFilter.new(self, recipients).call
   end
 
   #Returns the receipt for the participant
@@ -176,16 +179,4 @@ class Mailboxer::Notification < ActiveRecord::Base
   def sanitize(text)
     ::Mailboxer::Cleaner.instance.sanitize(text)
   end
-
-  private
-
-  def build_receipt(receiver, mailbox_type, is_read = false)
-    Mailboxer::ReceiptBuilder.new({
-      :notification => self,
-      :mailbox_type => mailbox_type,
-      :receiver     => receiver,
-      :is_read      => is_read
-    }).build
-  end
-
 end

data/app/models/mailboxer/receipt.rb

@@ -2,9 +2,9 @@ class Mailboxer::Receipt < ActiveRecord::Base
   self.table_name = :mailboxer_receipts
   attr_accessible :trashed, :is_read, :deleted if Mailboxer.protected_attributes?
 
-  belongs_to :notification, :class_name => "Mailboxer::Notification", :validate => true, :autosave => true
-  belongs_to :receiver, :polymorphic => :true
-  belongs_to :message, :class_name => "Mailboxer::Message", :foreign_key => "notification_id"
+  belongs_to :notification, :class_name => "Mailboxer::Notification"
+  belongs_to :receiver, :polymorphic => :true, :required => false
+  belongs_to :message, :class_name => "Mailboxer::Message", :foreign_key => "notification_id", :required => false
 
   validates_presence_of :receiver
 
@@ -30,7 +30,6 @@ class Mailboxer::Receipt < ActiveRecord::Base
   scope :is_read, lambda { where(:is_read => true) }
   scope :is_unread, lambda { where(:is_read => false) }
 
-  after_validation :remove_duplicate_errors
   class << self
     #Marks all the receipts from the relation as read
     def mark_as_read(options={})
@@ -140,16 +139,6 @@ class Mailboxer::Receipt < ActiveRecord::Base
 
   protected
 
-  #Removes the duplicate error about not present subject from Conversation if it has been already
-  #raised by Message
-  def remove_duplicate_errors
-    if errors["mailboxer_notification.conversation.subject"].present? and errors["mailboxer_notification.subject"].present?
-      errors["mailboxer_notification.conversation.subject"].each do |msg|
-        errors["mailboxer_notification.conversation.subject"].delete(msg)
-      end
-    end
-  end
-
   if Mailboxer.search_enabled
     searchable do
       text :subject, :boost => 5 do

data/app/views/mailboxer/notification_mailer/new_notification_email.text.erb

@@ -1,6 +1,6 @@
 You have a new notification: <%= @notification.subject.html_safe? ? @notification.subject : strip_tags(@notification.subject) %>
 ===============================================
- 
+
 You have received a new notification:
 
 -----------------------------------------------

data/db/migrate/20110511145103_create_mailboxer.rb

@@ -1,13 +1,13 @@
 class CreateMailboxer < ActiveRecord::Migration
-  def self.up    
+  def self.up
   #Tables
-  	#Conversations
+    #Conversations
     create_table :mailboxer_conversations do |t|
       t.column :subject, :string, :default => ""
       t.column :created_at, :datetime, :null => false
       t.column :updated_at, :datetime, :null => false
-    end    
-  	#Receipts
+    end
+    #Receipts
     create_table :mailboxer_receipts do |t|
       t.references :receiver, :polymorphic => true
       t.column :notification_id, :integer, :null => false
@@ -17,8 +17,8 @@ class CreateMailboxer < ActiveRecord::Migration
       t.column :mailbox_type, :string, :limit => 25
       t.column :created_at, :datetime, :null => false
       t.column :updated_at, :datetime, :null => false
-    end    
-  	#Notifications and Messages
+    end
+    #Notifications and Messages
     create_table :mailboxer_notifications do |t|
       t.column :type, :string
       t.column :body, :text
@@ -33,30 +33,29 @@ class CreateMailboxer < ActiveRecord::Migration
       t.column :created_at, :datetime, :null => false
       t.boolean :global, default: false
       t.datetime :expires
-    end    
-    
-    
+    end
+
   #Indexes
-  	#Conversations
-  	#Receipts
-  	add_index "mailboxer_receipts","notification_id"
+    #Conversations
+    #Receipts
+    add_index "mailboxer_receipts","notification_id"
+
+    #Messages
+    add_index "mailboxer_notifications","conversation_id"
 
-  	#Messages  
-  	add_index "mailboxer_notifications","conversation_id"
-  
-  #Foreign keys    
-  	#Conversations
-  	#Receipts
-  	add_foreign_key "mailboxer_receipts", "mailboxer_notifications", :name => "receipts_on_notification_id", :column => "notification_id"
-  	#Messages  
-  	add_foreign_key "mailboxer_notifications", "mailboxer_conversations", :name => "notifications_on_conversation_id", :column => "conversation_id"
+  #Foreign keys
+    #Conversations
+    #Receipts
+    add_foreign_key "mailboxer_receipts", "mailboxer_notifications", :name => "receipts_on_notification_id", :column => "notification_id"
+    #Messages
+    add_foreign_key "mailboxer_notifications", "mailboxer_conversations", :name => "notifications_on_conversation_id", :column => "conversation_id"
   end
-  
+
   def self.down
-  #Tables  	
-  	remove_foreign_key "mailboxer_receipts", :name => "receipts_on_notification_id"
-  	remove_foreign_key "mailboxer_notifications", :name => "notifications_on_conversation_id"
-  	
+  #Tables
+    remove_foreign_key "mailboxer_receipts", :name => "receipts_on_notification_id"
+    remove_foreign_key "mailboxer_notifications", :name => "notifications_on_conversation_id"
+
   #Indexes
     drop_table :mailboxer_receipts
     drop_table :mailboxer_conversations

data/db/migrate/20151103080417_add_delivery_tracking_info_to_mailboxer_receipts.rb

@@ -0,0 +1,7 @@
+class AddDeliveryTrackingInfoToMailboxerReceipts < ActiveRecord::Migration
+  def change
+    add_column :mailboxer_receipts, :is_delivered, :boolean, default: false
+    add_column :mailboxer_receipts, :delivery_method, :string
+    add_column :mailboxer_receipts, :message_id, :string
+  end
+end

data/gemfiles/{rails4.0.gemfile → rails5.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.0.4"
+gem "rails", "~> 5.0.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/lib/generators/mailboxer/install_generator.rb

@@ -17,20 +17,9 @@ class Mailboxer::InstallGenerator < Rails::Generators::Base #:nodoc:
   end
 
   def copy_migrations
-    if Rails.version < "3.1"
-      migrations = [
-        %w[20110511145103_create_mailboxer.rb create_mailboxer.rb],
-        %w[20131206080416_add_conversation_optout.rb add_conversation_optout.rb],
-        %w[20131206080417_add_missing_indices.rb add_missing_indices.rb]
-      ],
-      migrations.each do |migration|
-        migration_template "../../../../db/migrate/" + migration[0], "db/migrate/" + migration[1]
-      end
-    else
-      require 'rake'
-      Rails.application.load_tasks
-      Rake::Task['railties:install:migrations'].reenable
-      Rake::Task['mailboxer_engine:install:migrations'].invoke
-    end
+    require 'rake'
+    Rails.application.load_tasks
+    Rake::Task['railties:install:migrations'].reenable
+    Rake::Task['mailboxer_engine:install:migrations'].invoke
   end
 end

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

@@ -1,6 +1,6 @@
 Mailboxer.setup do |config|
 
-  #Configures if you application uses or not email sending for Notifications and Messages
+  #Configures if your application uses or not email sending for Notifications and Messages
   config.uses_emails = true
 
   #Configures the default from for emails sent for Messages and Notifications

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

@@ -5,11 +5,6 @@ class MailboxerNamespacingCompatibility < ActiveRecord::Migration
     rename_table :notifications, :mailboxer_notifications
     rename_table :receipts,      :mailboxer_receipts
 
-    if Rails.version < '4'
-      rename_index :mailboxer_notifications, :notifications_on_conversation_id, :mailboxer_notifications_on_conversation_id
-      rename_index :mailboxer_receipts,      :receipts_on_notification_id,      :mailboxer_receipts_on_notification_id
-    end
-
     Mailboxer::Notification.where(type: 'Message').update_all(type: 'Mailboxer::Message')
   end
 
@@ -18,11 +13,6 @@ class MailboxerNamespacingCompatibility < ActiveRecord::Migration
     rename_table :mailboxer_notifications, :notifications
     rename_table :mailboxer_receipts,      :receipts
 
-    if Rails.version < '4'
-      rename_index :notifications, :mailboxer_notifications_on_conversation_id, :notifications_on_conversation_id
-      rename_index :receipts,      :mailboxer_receipts_on_notification_id,      :receipts_on_notification_id
-    end
-
     Mailboxer::Notification.where(type: 'Mailboxer::Message').update_all(type: 'Message')
   end
 end

data/lib/mailboxer.rb

@@ -7,8 +7,6 @@ module Mailboxer
   @@default_from = "no-reply@mailboxer.com"
   mattr_accessor :uses_emails
   @@uses_emails = true
-  mattr_accessor :mailer_wants_array
-  @@mailer_wants_array = false
   mattr_accessor :search_enabled
   @@search_enabled = false
   mattr_accessor :search_engine
@@ -31,7 +29,7 @@ module Mailboxer
     end
 
     def protected_attributes?
-      Rails.version < '4' || defined?(ProtectedAttributes)
+      defined?(ProtectedAttributes)
     end
   end
 
@@ -41,3 +39,4 @@ end
 require 'mailboxer/engine'
 require 'mailboxer/cleaner'
 require 'mailboxer/mail_dispatcher'
+require 'mailboxer/recipient_filter'

data/lib/mailboxer/engine.rb

@@ -1,5 +1,3 @@
-# Database foreign keys
-require 'foreigner' if Rails.version < "4.2.0"
 require 'carrierwave'
 begin
   require 'sunspot_rails'

data/lib/mailboxer/mail_dispatcher.rb

@@ -1,21 +1,17 @@
 module Mailboxer
   class MailDispatcher
+    attr_reader :mailable, :receipts
 
-    attr_reader :mailable, :recipients
-
-    def initialize(mailable, recipients)
-      @mailable, @recipients = mailable, recipients
+    def initialize(mailable, receipts)
+      @mailable, @receipts = mailable, receipts
     end
 
     def call
       return false unless Mailboxer.uses_emails
-      if Mailboxer.mailer_wants_array
-        send_email(filtered_recipients)
-      else
-        filtered_recipients.each do |recipient|
-          email_to = recipient.send(Mailboxer.email_method, mailable)
-          send_email(recipient) if email_to.present?
-        end
+
+      receipts.map do |receipt|
+        email_to = receipt.receiver.send(Mailboxer.email_method, mailable)
+        send_email(receipt) if email_to.present?
       end
     end
 
@@ -27,22 +23,22 @@ module Mailboxer
       Mailboxer.send(method) || "#{mailable.class}Mailer".constantize
     end
 
-    # recipients can be filtered on a conversation basis
-    def filtered_recipients
-      return recipients unless mailable.respond_to?(:conversation)
-
-      recipients.each_with_object([]) do |recipient, array|
-        array << recipient if mailable.conversation.has_subscriber?(recipient)
-      end
-    end
-
-    def send_email(recipient)
+    def send_email(receipt)
       if Mailboxer.custom_deliver_proc
-        Mailboxer.custom_deliver_proc.call(mailer, mailable, recipient)
+        Mailboxer.custom_deliver_proc.call(mailer, mailable, receipt.receiver)
       else
-        email = mailer.send_email(mailable, recipient)
-        email.respond_to?(:deliver_now) ? email.deliver_now : email.deliver
+        default_send_email(receipt)
       end
     end
+
+    def default_send_email(receipt)
+      mail = mailer.send_email(mailable, receipt.receiver)
+      mail.respond_to?(:deliver_now) ? mail.deliver_now : mail.deliver
+      receipt.assign_attributes(
+        :delivery_method => :email,
+        :message_id => mail.message_id
+      )
+      mail
+    end
   end
 end

data/lib/mailboxer/models/messageable.rb

@@ -14,12 +14,7 @@ module Mailboxer
 
       included do
         has_many :messages, :class_name => "Mailboxer::Message", :as => :sender
-        if Rails::VERSION::MAJOR == 4
-          has_many :receipts, -> { order 'created_at DESC' }, :class_name => "Mailboxer::Receipt", dependent: :destroy,     as: :receiver
-        else
-          # Rails 3 does it this way
-          has_many :receipts, :order => 'created_at DESC',    :class_name => "Mailboxer::Receipt", :dependent => :destroy, :as => :receiver
-        end
+        has_many :receipts, -> { order 'created_at DESC' }, :class_name => "Mailboxer::Receipt", dependent: :destroy, as: :receiver
       end
 
       unless defined?(Mailboxer.name_method)

data/lib/mailboxer/recipient_filter.rb

@@ -0,0 +1,17 @@
+module Mailboxer
+  class RecipientFilter
+    attr_reader :mailable, :recipients
+    def initialize(mailable, recipients)
+      @mailable, @recipients = mailable, recipients
+    end
+
+    # recipients can be filtered on a conversation basis
+    def call
+      return recipients unless mailable.respond_to?(:conversation)
+
+      recipients.each_with_object([]) do |recipient, array|
+        array << recipient if mailable.conversation.has_subscriber?(recipient)
+      end
+    end
+  end
+end

data/lib/mailboxer/version.rb

@@ -1,3 +1,3 @@
 module Mailboxer
-  VERSION = "0.13.0"
+  VERSION = "0.14.0"
 end

data/mailboxer.gemspec

@@ -20,11 +20,9 @@ Gem::Specification.new do |s|
 
   # Gem dependencies
   #
-  # SQL foreign keys
-  s.add_runtime_dependency('foreigner', '>= 0.9.1')
 
   # Development Gem dependencies
-  s.add_runtime_dependency('rails', '>= 3.2.0')
+  s.add_runtime_dependency('rails', '>= 4.2.0')
   s.add_runtime_dependency('carrierwave', '>= 0.5.8')
 
   if RUBY_ENGINE == "rbx" && RUBY_VERSION >= "2.1.0"
@@ -37,13 +35,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec-its', '~> 1.1'
   s.add_development_dependency 'rspec-collection_matchers', '~> 1.1'
   s.add_development_dependency('appraisal', '~> 1.0.0')
-  s.add_development_dependency('shoulda-matchers')
-  # Fixtures
-  #if RUBY_VERSION >= '1.9.2'
-   # s.add_development_dependency('factory_girl', '>= 3.0.0')
-  #else
-    #s.add_development_dependency('factory_girl', '~> 2.6.0')
-  #end
+  s.add_development_dependency('shoulda-matchers', '~> 2')
   s.add_development_dependency('factory_girl', '~> 2.6.0')
   # Population
   s.add_development_dependency('forgery', '>= 0.3.6')

data/spec/dummy/config/application.rb

@@ -7,9 +7,6 @@ require "mailboxer"
 
 module Dummy
   class Application < Rails::Application
-    def rails_more_than_4_2?
-      Gem::Version.new(Rails.version) >= Gem::Version.new('4.2.0')
-    end
     # Settings in config/environments/* take precedence over those specified here.
     # Application configuration should go into files in config/initializers
     # -- all .rb files in that directory are automatically loaded.
@@ -40,8 +37,6 @@ module Dummy
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
-    config.active_record.raise_in_transactional_callbacks = true if rails_more_than_4_2?
-
   end
 end
 

data/spec/dummy/db/migrate/20151103202534_add_missing_indices.mailboxer_engine.rb

@@ -0,0 +1,20 @@
+# This migration comes from mailboxer_engine (originally 20131206080417)
+class AddMissingIndices < ActiveRecord::Migration
+  def change
+    # We'll explicitly specify its name, as the auto-generated name is too long and exceeds 63
+    # characters limitation.
+    add_index :mailboxer_conversation_opt_outs, [:unsubscriber_id, :unsubscriber_type],
+      name: 'index_mailboxer_conversation_opt_outs_on_unsubscriber_id_type'
+    add_index :mailboxer_conversation_opt_outs, :conversation_id
+
+    add_index :mailboxer_notifications, :type
+    add_index :mailboxer_notifications, [:sender_id, :sender_type]
+
+    # We'll explicitly specify its name, as the auto-generated name is too long and exceeds 63
+    # characters limitation.
+    add_index :mailboxer_notifications, [:notified_object_id, :notified_object_type],
+      name: 'index_mailboxer_notifications_on_notified_object_id_and_type'
+
+    add_index :mailboxer_receipts, [:receiver_id, :receiver_type]
+  end
+end

data/spec/dummy/db/migrate/20151103202535_add_delivery_tracking_info_to_mailboxer_receipts.mailboxer_engine.rb

@@ -0,0 +1,8 @@
+# This migration comes from mailboxer_engine (originally 20151103080417)
+class AddDeliveryTrackingInfoToMailboxerReceipts < ActiveRecord::Migration
+  def change
+    add_column :mailboxer_receipts, :is_delivered, :boolean, default: false
+    add_column :mailboxer_receipts, :delivery_method, :string
+    add_column :mailboxer_receipts, :message_id, :string
+  end
+end

data/spec/mailboxer/mail_dispatcher_spec.rb

@@ -2,12 +2,15 @@ require 'spec_helper'
 
 describe Mailboxer::MailDispatcher do
 
-  subject(:instance) { described_class.new(mailable, recipients) }
+  subject(:instance) { described_class.new(mailable, receipts) }
 
   let(:mailable)   { Mailboxer::Notification.new }
-  let(:recipient1) { double 'recipient1', mailboxer_email: ''  }
-  let(:recipient2) { double 'recipient2', mailboxer_email: 'foo@bar.com'  }
-  let(:recipients) { [ recipient1, recipient2 ] }
+  let(:recipient1) { double 'recipient1', id: 1, mailboxer_email: '' }
+  let(:recipient2) { double 'recipient2', id: 2, mailboxer_email: 'foo@bar.com'}
+  let(:receipt1) { double 'receipt1', id: 1, receiver: recipient1 }
+  let(:receipt2) { double 'receipt2', id: 2, receiver: recipient2  }
+
+  let(:receipts) { [ receipt1, receipt2 ] }
 
   describe "call" do
     context "no emails" do
@@ -16,19 +19,10 @@ describe Mailboxer::MailDispatcher do
       its(:call) { should be false }
     end
 
-    context "mailer wants array" do
-      before { Mailboxer.mailer_wants_array = true  }
-      after  { Mailboxer.mailer_wants_array = false }
+    context "mailer doesn't want array" do
       it 'sends collection' do
-        expect(subject).to receive(:send_email).with(recipients)
-        subject.call
-      end
-    end
-
-    context "mailer doesnt want array" do
-      it 'sends collection' do
-        expect(subject).not_to receive(:send_email).with(recipient1) #email is blank
-        expect(subject).to receive(:send_email).with(recipient2)
+        expect(subject).not_to receive(:send_email).with(receipt1) #email is blank
+        expect(subject).to receive(:send_email).with(receipt2)
         subject.call
       end
     end
@@ -49,24 +43,25 @@ describe Mailboxer::MailDispatcher do
       after  { Mailboxer.custom_deliver_proc = nil     }
       it "triggers proc" do
         expect(my_proc).to receive(:call).with(mailer, mailable, recipient1)
-        subject.send :send_email, recipient1
+        subject.send :send_email, receipt1
       end
     end
 
     context "without custom_deliver_proc" do
-      let(:email) { double :email }
+      let(:email) { double :email, message_id: '123@local.com' }
 
       it "triggers standard deliver chain" do
         expect(mailer).to receive(:send_email).with(mailable, recipient1).and_return email
+        expect(receipt1).to receive(:assign_attributes).with({:delivery_method=>:email, :message_id=>"123@local.com"}).and_return email
         expect(email).to receive :deliver
 
-        subject.send :send_email, recipient1
+        subject.send :send_email, receipt1
       end
     end
   end
 
   describe "mailer" do
-    let(:recipients) { [] }
+    let(:receipts) { [] }
 
     context "mailable is a Message" do
       let(:mailable) { Mailboxer::Notification.new }
@@ -93,22 +88,4 @@ describe Mailboxer::MailDispatcher do
       end
     end
   end
-
-  describe "filtered_recipients" do
-    context "responds to conversation" do
-      let(:conversation) { double 'conversation' }
-      let(:mailable)     { double 'mailable', :conversation => conversation }
-      before(:each) do
-        expect(conversation).to receive(:has_subscriber?).with(recipient1).and_return false
-        expect(conversation).to receive(:has_subscriber?).with(recipient2).and_return true
-      end
-
-      its(:filtered_recipients){ should eq [recipient2] }
-    end
-
-    context 'doesnt respond to conversation' do
-      let(:mailable) { double 'mailable' }
-      its(:filtered_recipients){ should eq recipients }
-    end
-  end
 end

data/spec/mailboxer/recipient_filter_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Mailboxer::RecipientFilter do
+  subject(:instance) { described_class.new(mailable, recipients) }
+  let(:recipient1) { double 'recipient1', id: 1, mailboxer_email: '' }
+  let(:recipient2) { double 'recipient2', id: 2, mailboxer_email: 'foo@bar.com'}
+  let(:recipients) { [ recipient1, recipient2 ] }
+
+  describe "call" do
+    context "responds to conversation" do
+      let(:conversation) { double 'conversation' }
+      let(:mailable)     { double 'mailable', :conversation => conversation }
+      before(:each) do
+        expect(conversation).to receive(:has_subscriber?).with(recipient1).and_return false
+        expect(conversation).to receive(:has_subscriber?).with(recipient2).and_return true
+      end
+
+      its(:call){ should eq [recipient2] }
+    end
+
+    context 'doesnt respond to conversation' do
+      let(:mailable) { double 'mailable' }
+      its(:call){ should eq recipients }
+    end
+  end
+end

data/spec/mailers/message_mailer_spec.rb

@@ -60,36 +60,6 @@ describe Mailboxer::MessageMailer do
       end
     end
   end
-
-  context "when mailer_wants_array is false" do
-    it_behaves_like 'message_mailer'
-  end
-
-  context "mailer_wants_array is true" do
-    class ArrayMailer < Mailboxer::MessageMailer
-      default template_path: 'mailboxer/message_mailer'
-
-      def new_message_email(message, receivers)
-        receivers.each { |receiver| super(message, receiver) if receiver.mailboxer_email(message).present? }
-      end
-
-      def reply_message_email(message, receivers)
-        receivers.each { |receiver| super(message, receiver) if receiver.mailboxer_email(message).present? }
-      end
-    end
-
-    before :all do
-      Mailboxer.mailer_wants_array = true
-      Mailboxer.message_mailer = ArrayMailer
-    end
-
-    after :all do
-      Mailboxer.mailer_wants_array = false
-      Mailboxer.message_mailer = Mailboxer::MessageMailer
-    end
-
-    it_behaves_like 'message_mailer'
-  end
 end
 
 def print_emails

data/spec/models/conversation_spec.rb

@@ -13,7 +13,7 @@ describe Mailboxer::Conversation do
   let!(:conversation) { message1.conversation }
 
   it { should validate_presence_of :subject }
-  it { should ensure_length_of(:subject).is_at_most(Mailboxer.subject_max_length) }
+  it { should validate_length_of(:subject).is_at_most(Mailboxer.subject_max_length) }
 
   it "should have proper original message" do
     expect(conversation.original_message).to eq message1
@@ -118,6 +118,17 @@ describe Mailboxer::Conversation do
         expect(Mailboxer::Conversation.unread(participant)).to eq [unread_conversation]
       end
     end
+
+    describe ".between" do
+      it "finds conversations where two participants participate" do
+        expect(Mailboxer::Conversation.between(entity1, participant)).to eq [sentbox_conversation, inbox_conversation]
+      end
+
+      it "does not find conversations if the participants have not interacted yet" do
+        expect(Mailboxer::Conversation.between(participant, entity2)).to eq []
+      end
+
+    end
   end
 
   describe "#is_completely_trashed?" do

data/spec/models/mailbox_spec.rb

@@ -14,6 +14,12 @@ describe Mailboxer::Mailbox do
     @conversation = @message1.conversation
   end
 
+  it "should return conversations between two entities" do
+    assert @entity1.mailbox.conversations_with(@entity2)
+
+    expect(@entity1.mailbox.conversations_with(@entity2)).to eq [@conversation]
+  end
+
   it "should return all conversations" do
     @conv2 = @entity1.send_message(@entity2,"Body","Subject").conversation
     @conv3 = @entity2.send_message(@entity1,"Body","Subject").conversation

data/spec/models/message_spec.rb

@@ -1,30 +1,66 @@
 require 'spec_helper'
 
 describe Mailboxer::Message do
-
   before do
+    ActionMailer::Base.deliveries.clear
     @entity1 = FactoryGirl.create(:user)
     @entity2 = FactoryGirl.create(:user)
-    @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
 
-  it "should have right recipients" do
-  	expect(@receipt1.notification.recipients.count).to eq 2
-  	expect(@receipt2.notification.recipients.count).to eq 2
-  	expect(@receipt3.notification.recipients.count).to eq 2
-  	expect(@receipt4.notification.recipients.count).to eq 2
+  context "with errors" do
+    describe "empty subject" do
+      before do
+        @receipt1 = @entity1.send_message(@entity2,"Body","")
+        @message1 = @receipt1.notification
+      end
+
+      it "should add errors to the created notification" do
+        errors = @message1.errors['conversation.subject']
+
+        expect(errors).to eq(["can't be blank"])
+      end
+    end
   end
 
-  it "should be able to be marked as deleted" do
-    expect(@receipt1.deleted).to be false
-    @message1.mark_as_deleted @entity1
-    expect(@message1.is_deleted?(@entity1)).to be true
+  context "after send" do
+
+    before do
+      ActionMailer::Base.deliveries.clear
+      @entity1 = FactoryGirl.create(:user)
+      @entity2 = FactoryGirl.create(:user)
+      @receipt1 = @entity1.send_message(@entity2,"Body","Subject")
+      @message1 = @receipt1.notification
+    end
+
+    it "should be able to be marked as deleted" do
+      expect(@receipt1.deleted).to be false
+      @message1.mark_as_deleted @entity1
+      expect(@message1.is_deleted?(@entity1)).to be true
+    end
+
+    it "creates a conversation" do
+      expect(@message1.conversation).to eq(Mailboxer::Conversation.last)
+    end
+
+    it "should send email only to receivers" do
+      expect(ActionMailer::Base.deliveries.count).to eq 1
+    end
+
+    context "and multiple replies" do
+      before 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")
+      end
+
+      it "should have right recipients" do
+        expect(@receipt1.notification.recipients.count).to eq 2
+        expect(@receipt2.notification.recipients.count).to eq 2
+        expect(@receipt3.notification.recipients.count).to eq 2
+        expect(@receipt4.notification.recipients.count).to eq 2
+      end
+    end
+
   end
 
 end

data/spec/models/notification_spec.rb

@@ -8,11 +8,10 @@ describe Mailboxer::Notification do
     @entity3 = FactoryGirl.create(:user)
   end
 
-  it { should validate_presence_of :subject }
   it { should validate_presence_of :body }
 
-  it { should ensure_length_of(:subject).is_at_most(Mailboxer.subject_max_length) }
-  it { should ensure_length_of(:body).is_at_most(Mailboxer.body_max_length) }
+  it { should validate_length_of(:subject).is_at_most(Mailboxer.subject_max_length) }
+  it { should validate_length_of(:body).is_at_most(Mailboxer.body_max_length) }
 
   it "should notify one user" do
     @entity1.notify("Subject", "Body")

data/spec/spec_helper.rb

@@ -30,6 +30,14 @@ Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each {|f| require f}
 
 # Shoulda Matchers
 require 'shoulda/matchers'
+if Shoulda::Matchers.respond_to?(:configure)
+  Shoulda::Matchers.configure do |config|
+    config.integrate do |with|
+      with.test_framework :rspec
+      with.library :rails
+    end
+  end
+end
 
 RSpec.configure do |config|
   # Remove this line if you don't want RSpec's should and should_not

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mailboxer
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - Eduardo Casanova Cuesta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: foreigner
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: carrierwave
   requirement: !ruby/object:Gem::Requirement
@@ -112,16 +98,16 @@ dependencies:
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -223,10 +209,9 @@ files:
 - db/migrate/20110511145103_create_mailboxer.rb
 - db/migrate/20131206080416_add_conversation_optout.rb
 - db/migrate/20131206080417_add_missing_indices.rb
-- gemfiles/rails3.2.gemfile
-- gemfiles/rails4.0.gemfile
-- gemfiles/rails4.1.gemfile
+- db/migrate/20151103080417_add_delivery_tracking_info_to_mailboxer_receipts.rb
 - gemfiles/rails4.2.gemfile
+- gemfiles/rails5.0.gemfile
 - lib/generators/mailboxer/install_generator.rb
 - lib/generators/mailboxer/namespacing_compatibility_generator.rb
 - lib/generators/mailboxer/templates/initializer.rb
@@ -237,6 +222,7 @@ files:
 - lib/mailboxer/engine.rb
 - lib/mailboxer/mail_dispatcher.rb
 - lib/mailboxer/models/messageable.rb
+- lib/mailboxer/recipient_filter.rb
 - lib/mailboxer/version.rb
 - mailboxer.gemspec
 - spec/dummy/.gitignore
@@ -274,6 +260,8 @@ files:
 - spec/dummy/db/migrate/20110306015107_create_cylons.rb
 - spec/dummy/db/migrate/20120305103200_create_mailboxer.rb
 - spec/dummy/db/migrate/20131206080416_add_conversation_optout.rb
+- spec/dummy/db/migrate/20151103202534_add_missing_indices.mailboxer_engine.rb
+- spec/dummy/db/migrate/20151103202535_add_delivery_tracking_info_to_mailboxer_receipts.mailboxer_engine.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -289,6 +277,7 @@ files:
 - spec/integration/message_and_receipt_spec.rb
 - spec/integration/navigation_spec.rb
 - spec/mailboxer/mail_dispatcher_spec.rb
+- spec/mailboxer/recipient_filter_spec.rb
 - spec/mailboxer_spec.rb
 - spec/mailers/message_mailer_spec.rb
 - spec/mailers/notification_mailer_spec.rb
@@ -320,7 +309,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Messaging system for rails apps.

data/gemfiles/rails3.2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "~> 3.2.17"
-
-gemspec :path => "../"

data/gemfiles/rails4.1.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "rails", "~> 4.1.0"
-
-gemspec :path => "../"