mailboxer 0.11.0 → 0.12.0.rc1

data/app/models/{notification.rb → mailboxer/notification.rb}

@@ -1,40 +1,42 @@
-class Notification < ActiveRecord::Base
+class Mailboxer::Notification < ActiveRecord::Base
+  self.table_name = :mailboxer_notifications
+
   attr_accessor :recipients
   attr_accessible :body, :subject, :global, :expires if Mailboxer.protected_attributes?
 
   belongs_to :sender, :polymorphic => :true
   belongs_to :notified_object, :polymorphic => :true
-  has_many :receipts, :dependent => :destroy
+  has_many :receipts, :dependent => :destroy, :class_name => "Mailboxer::Receipt"
 
-  validates_presence_of :subject, :body
+  validates :subject, :presence => true,
+                      :length => { :maximum => Mailboxer.subject_max_length }
+  validates :body,    :presence => true,
+                      :length => { :maximum => Mailboxer.body_max_length }
 
   scope :recipient, lambda { |recipient|
-    joins(:receipts).where('receipts.receiver_id' => recipient.id,'receipts.receiver_type' => recipient.class.base_class.to_s)
+    joins(:receipts).where('mailboxer_receipts.receiver_id' => recipient.id,'mailboxer_receipts.receiver_type' => recipient.class.base_class.to_s)
   }
   scope :with_object, lambda { |obj|
     where('notified_object_id' => obj.id,'notified_object_type' => obj.class.to_s)
   }
   scope :not_trashed, lambda {
-    joins(:receipts).where('receipts.trashed' => false)
+    joins(:receipts).where('mailboxer_receipts.trashed' => false)
   }
   scope :unread,  lambda {
-    joins(:receipts).where('receipts.is_read' => false)
+    joins(:receipts).where('mailboxer_receipts.is_read' => false)
   }
   scope :global, lambda { where(:global => true) }
-  scope :expired, lambda { where("notifications.expires < ?", Time.now) }
+  scope :expired, lambda { where("mailboxer_notifications.expires < ?", Time.now) }
   scope :unexpired, lambda {
-    where("notifications.expires is NULL OR notifications.expires > ?", Time.now)
+    where("mailboxer_notifications.expires is NULL OR mailboxer_notifications.expires > ?", Time.now)
   }
 
-  include Concerns::ConfigurableMailer
-
   class << self
     #Sends a Notification to all the recipients
     def notify_all(recipients,subject,body,obj = nil,sanitize_text = true,notification_code=nil,send_mail=true)
-      notification = Notification.new({:body => body, :subject => subject})
-      notification.recipients = recipients.respond_to?(:each) ? recipients : [recipients]
-      notification.recipients = notification.recipients.uniq if recipients.respond_to?(:uniq)
-      notification.notified_object = obj if obj.present?
+      notification = Mailboxer::Notification.new({:body => body, :subject => subject})
+      notification.recipients        = Array(recipients).uniq
+      notification.notified_object   = obj               if obj.present?
       notification.notification_code = notification_code if notification_code.present?
       notification.deliver sanitize_text, send_mail
     end
@@ -43,7 +45,7 @@ class Notification < ActiveRecord::Base
     #successful or +false+ if some error raised
     def successful_delivery? receipts
       case receipts
-      when Receipt
+      when Mailboxer::Receipt
         receipts.valid?
         receipts.errors.empty?
       when Array
@@ -75,30 +77,20 @@ class Notification < ActiveRecord::Base
   #Delivers a Notification. USE NOT RECOMENDED.
   #Use Mailboxer::Models::Message.notify and Notification.notify_all instead.
   def deliver(should_clean = true, send_mail = true)
-    self.clean if should_clean
+    clean if should_clean
     temp_receipts = Array.new
+
     #Receiver receipts
     self.recipients.each do |r|
-      msg_receipt = Receipt.new
-      msg_receipt.notification = self
-      msg_receipt.is_read = false
-      msg_receipt.receiver = r
-      temp_receipts << msg_receipt
+      temp_receipts << build_receipt(r, nil, false)
     end
-    temp_receipts.each(&:valid?)
-    if temp_receipts.all? { |t| t.errors.empty? }
+
+    if temp_receipts.all?(&:valid?)
       temp_receipts.each(&:save!)   #Save receipts
-      self.recipients.each do |r|
-        #Should send an email?
-        if Mailboxer.uses_emails
-          email_to = r.send(Mailboxer.email_method,self)
-          if send_mail && !email_to.blank?
-            get_mailer.send_email(self,r).deliver
-          end
-        end
-      end
-      self.recipients=nil
+      Mailboxer::MailDispatcher.new(self, recipients).call if send_mail
+      self.recipients = nil
     end
+
     return temp_receipts if temp_receipts.size > 1
     temp_receipts.first
   end
@@ -119,7 +111,7 @@ class Notification < ActiveRecord::Base
 
   #Returns the receipt for the participant
   def receipt_for(participant)
-    Receipt.notification(self).recipient(participant)
+    Mailboxer::Receipt.notification(self).recipient(participant)
   end
 
   #Returns the receipt for the participant. Alias for receipt_for(participant)
@@ -179,14 +171,10 @@ class Notification < ActiveRecord::Base
     return self.receipt_for(participant).mark_as_deleted
   end
 
-  include ActionView::Helpers::SanitizeHelper
-
   #Sanitizes the body and subject
   def clean
-    unless self.subject.nil?
-      self.subject = sanitize self.subject
-    end
-    self.body = sanitize self.body
+    self.subject = sanitize(subject) if subject
+    self.body    = sanitize(body)
   end
 
   #Returns notified_object. DEPRECATED
@@ -194,4 +182,20 @@ class Notification < ActiveRecord::Base
     warn "DEPRECATION WARNING: use 'notify_object' instead of 'object' to get the object associated with the Notification"
     notified_object
   end
+
+  def sanitize(text)
+    ::Mailboxer::Cleaner.instance.sanitize(text)
+  end
+
+  private
+
+  def build_receipt(receiver, mailbox_type, is_read = false)
+    Mailboxer::Receipt.new.tap do |receipt|
+      receipt.notification = self
+      receipt.is_read = is_read
+      receipt.receiver = receiver
+      receipt.mailbox_type = mailbox_type
+    end
+  end
+
 end

data/app/models/{receipt.rb → mailboxer/receipt.rb}

@@ -1,9 +1,10 @@
-class Receipt < ActiveRecord::Base
+class Mailboxer::Receipt < ActiveRecord::Base
+  self.table_name = :mailboxer_receipts
   attr_accessible :trashed, :is_read, :deleted if Mailboxer.protected_attributes?
 
-  belongs_to :notification, :validate => true, :autosave => true
+  belongs_to :notification, :class_name => "Mailboxer::Notification", :validate => true, :autosave => true
   belongs_to :receiver, :polymorphic => :true
-  belongs_to :message, :foreign_key => "notification_id"
+  belongs_to :message, :class_name => "Mailboxer::Message", :foreign_key => "notification_id"
 
   validates_presence_of :receiver
 
@@ -12,13 +13,13 @@ class Receipt < ActiveRecord::Base
   }
   #Notifications Scope checks type to be nil, not Notification because of STI behaviour
   #with the primary class (no type is saved)
-  scope :notifications_receipts, lambda { joins(:notification).where('notifications.type' => nil) }
-  scope :messages_receipts, lambda { joins(:notification).where('notifications.type' => Message.to_s) }
+  scope :notifications_receipts, lambda { joins(:notification).where('mailboxer_notifications.type' => nil) }
+  scope :messages_receipts, lambda { joins(:notification).where('mailboxer_notifications.type' => Mailboxer::Message.to_s) }
   scope :notification, lambda { |notification|
     where(:notification_id => notification.id)
   }
   scope :conversation, lambda { |conversation|
-    joins(:message).where('notifications.conversation_id' => conversation.id)
+    joins(:message).where('mailboxer_notifications.conversation_id' => conversation.id)
   }
   scope :sentbox, lambda { where(:mailbox_type => "sentbox") }
   scope :inbox, lambda { where(:mailbox_type => "inbox") }
@@ -86,7 +87,7 @@ class Receipt < ActiveRecord::Base
           condition << "OR id = ? "
         end
         conditions[0] = condition
-        Receipt.except(:where).except(:joins).where(conditions).update_all(updates)
+        Mailboxer::Receipt.except(:where).except(:joins).where(conditions).update_all(updates)
       end
     end
   end
@@ -134,7 +135,7 @@ class Receipt < ActiveRecord::Base
 
   #Returns the conversation associated to the receipt if the notification is a Message
   def conversation
-    message.conversation if message.is_a? Message
+    message.conversation if message.is_a? Mailboxer::Message
   end
 
   #Returns if the participant have read the Notification
@@ -152,9 +153,9 @@ class Receipt < ActiveRecord::Base
   #Removes the duplicate error about not present subject from Conversation if it has been already
   #raised by Message
   def remove_duplicate_errors
-    if self.errors["notification.conversation.subject"].present? and self.errors["notification.subject"].present?
-      self.errors["notification.conversation.subject"].each do |msg|
-        self.errors["notification.conversation.subject"].delete(msg)
+    if self.errors["mailboxer_notification.conversation.subject"].present? and self.errors["mailboxer_notification.subject"].present?
+      self.errors["mailboxer_notification.conversation.subject"].each do |msg|
+        self.errors["mailboxer_notification.conversation.subject"].delete(msg)
       end
     end
   end

data/app/views/{message_mailer → mailboxer/message_mailer}/new_message_email.html.erb

@@ -4,7 +4,7 @@
     <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
   </head>
   <body>
-    <h1>You have a new message: <%= @message.subject.html_safe? ? @message.subject : strip_tags(@message.subject) %></h1>
+    <h1>You have a new message: <%= @subject %></h1>
     <p>
       You have received a new message:
     </p>
@@ -14,7 +14,7 @@
       </p>
     </blockquote>
     <p>
-      Visit <%= link_to root_url,root_url %> and go to your inbox for more info.
+      Visit <%= link_to root_url, root_url %> and go to your inbox for more info.
     </p>
   </body>
-</html>
+</html>

data/app/views/{message_mailer → mailboxer/message_mailer}/new_message_email.text.erb

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

data/app/views/{message_mailer → mailboxer/message_mailer}/reply_message_email.html.erb

@@ -4,7 +4,7 @@
     <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
   </head>
   <body>
-    <h1>You have a new reply: <%= @message.subject.html_safe? ? @message.subject : strip_tags(@message.subject) %></h1>
+    <h1>You have a new reply: <%= @subject %></h1>
     <p>
       You have received a new reply:
     </p>
@@ -14,7 +14,7 @@
       </p>
     </blockquote>
     <p>
-      Visit <%= link_to root_url,root_url %> and go to your inbox for more info.
+      Visit <%= link_to root_url, root_url %> and go to your inbox for more info.
     </p>
   </body>
-</html>
+</html>

data/app/views/{message_mailer → mailboxer/message_mailer}/reply_message_email.text.erb

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

data/db/migrate/20110511145103_create_mailboxer.rb

@@ -2,16 +2,16 @@ class CreateMailboxer < ActiveRecord::Migration
   def self.up    
   #Tables
   	#Conversations
-    create_table :conversations do |t|
+    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
-    create_table :receipts do |t|
+    create_table :mailboxer_receipts do |t|
       t.references :receiver, :polymorphic => true
       t.column :notification_id, :integer, :null => false
-      t.column :read, :boolean, :default => false
+      t.column :is_read, :boolean, :default => false
       t.column :trashed, :boolean, :default => false
       t.column :deleted, :boolean, :default => false
       t.column :mailbox_type, :string, :limit => 25
@@ -19,43 +19,47 @@ class CreateMailboxer < ActiveRecord::Migration
       t.column :updated_at, :datetime, :null => false
     end    
   	#Notifications and Messages
-    create_table :notifications do |t|
+    create_table :mailboxer_notifications do |t|
       t.column :type, :string
       t.column :body, :text
       t.column :subject, :string, :default => ""
       t.references :sender, :polymorphic => true
-      t.references :object, :polymorphic => true
       t.column :conversation_id, :integer
       t.column :draft, :boolean, :default => false
+      t.string :notification_code, :default => nil
+      t.references :notified_object, :polymorphic => true
+      t.column :attachment, :string
       t.column :updated_at, :datetime, :null => false
       t.column :created_at, :datetime, :null => false
+      t.boolean :global, default: false
+      t.datetime :expires
     end    
     
     
   #Indexes
   	#Conversations
   	#Receipts
-  	add_index "receipts","notification_id"
+  	add_index "mailboxer_receipts","notification_id"
 
   	#Messages  
-  	add_index "notifications","conversation_id"
+  	add_index "mailboxer_notifications","conversation_id"
   
   #Foreign keys    
   	#Conversations
   	#Receipts
-  	add_foreign_key "receipts", "notifications", :name => "receipts_on_notification_id"
+  	add_foreign_key "mailboxer_receipts", "mailboxer_notifications", :name => "receipts_on_notification_id", :column => "notification_id"
   	#Messages  
-  	add_foreign_key "notifications", "conversations", :name => "notifications_on_conversation_id"
+  	add_foreign_key "mailboxer_notifications", "mailboxer_conversations", :name => "notifications_on_conversation_id", :column => "conversation_id"
   end
   
   def self.down
   #Tables  	
-  	remove_foreign_key "receipts", :name => "receipts_on_notification_id"
-  	remove_foreign_key "notifications", :name => "notifications_on_conversation_id"
+  	remove_foreign_key "mailboxer_receipts", :name => "receipts_on_notification_id"
+  	remove_foreign_key "mailboxer_notifications", :name => "notifications_on_conversation_id"
   	
   #Indexes
-    drop_table :receipts
-    drop_table :conversations
-    drop_table :notifications
+    drop_table :mailboxer_receipts
+    drop_table :mailboxer_conversations
+    drop_table :mailboxer_notifications
   end
 end

data/db/migrate/20131206080416_add_conversation_optout.rb

@@ -0,0 +1,14 @@
+class AddConversationOptout < ActiveRecord::Migration
+  def self.up
+    create_table :mailboxer_conversation_opt_outs do |t|
+      t.references :unsubscriber, :polymorphic => true
+      t.references :conversation
+    end
+    add_foreign_key "mailboxer_conversation_opt_outs", "mailboxer_conversations", :name => "mb_opt_outs_on_conversations_id", :column => "conversation_id"
+  end
+
+  def self.down
+    remove_foreign_key "mailboxer_conversation_opt_outs", :name => "mb_opt_outs_on_conversations_id"
+    drop_table :mailboxer_conversation_opt_outs
+  end
+end

data/gemfiles/rails3.2.gemfile

@@ -2,7 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "rails", "~> 3.2.6"
-gem "mailboxer", :path=>"../"
+gem "rails", "~> 3.2.17"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails4.0.gemfile

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

data/gemfiles/rails4.1.gemfile

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

data/lib/generators/mailboxer/install_generator.rb

@@ -18,10 +18,7 @@ class Mailboxer::InstallGenerator < Rails::Generators::Base #:nodoc:
 
   def copy_migrations
     if Rails.version < "3.1"
-      migrations = [["20110511145103_create_mailboxer.rb","create_mailboxer.rb"],
-                    ["20110719110700_add_notified_object.rb","add_notified_object.rb"],
-                    ["20110912163911_add_notification_code.rb","add_notification_code.rb"],
-                    ["20111204163911_add_attachments.rb","add_attachments.rb"]]
+      migrations = [["20110511145103_create_mailboxer.rb","create_mailboxer.rb"], ["20131206080416_add_conversation_optout.rb","add_conversation_optout.rb"]],
       migrations.each do |migration|
         migration_template "../../../../db/migrate/" + migration[0], "db/migrate/" + migration[1]
       end

data/lib/generators/mailboxer/namespacing_compatibility_generator.rb

@@ -0,0 +1,22 @@
+class Mailboxer::NamespacingCompatibilityGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+  require 'rails/generators/migration'
+
+  FILENAME = 'mailboxer_namespacing_compatibility.rb'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_model_file
+    migration_template FILENAME, "db/migrate/#{FILENAME}"
+  end
+
+  def self.next_migration_number path
+    unless @prev_migration_nr
+    @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+    else
+    @prev_migration_nr += 1
+    end
+    @prev_migration_nr.to_s
+  end
+end

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

@@ -1,17 +1,21 @@
 Mailboxer.setup do |config|
 
-  #Configures if you applications uses or no the email sending for Notifications and Messages
+  #Configures if you application uses or not 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 for emails sent for Messages and Notifications
   config.default_from = "no-reply@mailboxer.com"
 
   #Configures the methods needed by mailboxer
   config.email_method = :mailboxer_email
   config.name_method = :name
 
-  #Configures if you use or not a search engine and wich one are you using
-  #Supported enignes: [:solr,:sphinx]
+  #Configures if you use or not a search engine and which one you are using
+  #Supported engines: [:solr,:sphinx]
   config.search_enabled = false
   config.search_engine = :solr
+
+  #Configures maximum length of the message subject and body
+  config.subject_max_length = 255
+  config.body_max_length = 32000
 end