mailboxer 0.11.0 → 0.12.0.rc1

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

@@ -0,0 +1,24 @@
+class MailboxerNamespacingCompatibility < ActiveRecord::Migration
+
+  def self.up
+    rename_table :conversations, :mailboxer_conversations
+    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
+  end
+
+  def self.down
+    rename_table :mailboxer_conversations, :conversations
+    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
+  end
+end

data/lib/mailboxer.rb

@@ -17,8 +17,13 @@ module Mailboxer
   @@email_method = :mailboxer_email
   mattr_accessor :name_method
   @@name_method = :name
+  mattr_accessor :subject_max_length
+  @@subject_max_length = 255
+  mattr_accessor :body_max_length
+  @@body_max_length = 32000
   mattr_accessor :notification_mailer
   mattr_accessor :message_mailer
+  mattr_accessor :custom_deliver_proc
 
   class << self
     def setup
@@ -34,4 +39,5 @@ end
 # reopen ActiveRecord and include all the above to make
 # them available to all our models if they want it
 require 'mailboxer/engine'
-require 'mailboxer/concerns/configurable_mailer'
+require 'mailboxer/cleaner'
+require 'mailboxer/mail_dispatcher'

data/lib/mailboxer/cleaner.rb

@@ -0,0 +1,9 @@
+require 'singleton'
+
+module Mailboxer
+  class Cleaner
+    include Singleton
+    include ActionView::Helpers::SanitizeHelper
+
+  end
+end

data/lib/mailboxer/engine.rb

@@ -10,7 +10,7 @@ module Mailboxer
   class Engine < Rails::Engine
     initializer "mailboxer.models.messageable" do
       ActiveSupport.on_load(:active_record) do
-        extend Mailboxer::Models::Messageable::ActiveRecord
+        extend Mailboxer::Models::Messageable::ActiveRecordExtension
       end
     end
   end

data/lib/mailboxer/mail_dispatcher.rb

@@ -0,0 +1,48 @@
+module Mailboxer
+  class MailDispatcher
+
+    attr_reader :mailable, :recipients
+
+    def initialize(mailable, recipients)
+      @mailable, @recipients = mailable, recipients
+    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
+      end
+    end
+
+    private
+
+    def mailer
+      klass = mailable.class.name.demodulize
+      method = "#{klass.downcase}_mailer".to_sym
+      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)
+      if Mailboxer.custom_deliver_proc
+        Mailboxer.custom_deliver_proc.call(mailer, mailable, recipient)
+      else
+        mailer.send_email(mailable, recipient).deliver
+      end
+    end
+
+  end
+end

data/lib/mailboxer/models/messageable.rb

@@ -3,7 +3,7 @@ module Mailboxer
     module Messageable
       extend ActiveSupport::Concern
 
-      module ActiveRecord
+      module ActiveRecordExtension
         #Converts the model into messageable allowing it to interchange messages and
         #receive notifications
         def acts_as_messageable
@@ -11,13 +11,14 @@ module Mailboxer
         end
       end
 
+
       included do
-        has_many :messages, :as => :sender
+        has_many :messages, :class_name => "Mailboxer::Message", :as => :sender
         if Rails::VERSION::MAJOR == 4
-          has_many :receipts, -> { order 'created_at DESC' }, dependent: :destroy, as: :receiver
+          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', :dependent => :destroy, :as => :receiver
+          has_many :receipts, :order => 'created_at DESC',    :class_name => "Mailboxer::Receipt", :dependent => :destroy, :as => :receiver
         end
       end
 
@@ -46,20 +47,20 @@ module Mailboxer
 
       #Gets the mailbox of the messageable
       def mailbox
-        @mailbox = Mailbox.new(self) if @mailbox.nil?
+        @mailbox = Mailboxer::Mailbox.new(self) if @mailbox.nil?
         @mailbox.type = :all
         @mailbox
       end
 
       #Sends a notification to the messageable
       def notify(subject,body,obj = nil,sanitize_text=true,notification_code=nil,send_mail=true)
-        Notification.notify_all([self],subject,body,obj,sanitize_text,notification_code,send_mail)
+        Mailboxer::Notification.notify_all([self],subject,body,obj,sanitize_text,notification_code,send_mail)
       end
 
       #Sends a messages, starting a new conversation, with the messageable
       #as originator
       def send_message(recipients, msg_body, subject, sanitize_text=true, attachment=nil, message_timestamp = Time.now)
-        convo = Conversation.new({:subject => subject})
+        convo = Mailboxer::Conversation.new({:subject => subject})
         convo.created_at = message_timestamp
         convo.updated_at = message_timestamp
         message = messages.new({:body => msg_body, :subject => subject, :attachment => attachment})
@@ -115,11 +116,11 @@ module Mailboxer
       #* An array with any of them
       def mark_as_read(obj)
         case obj
-        when Receipt
+        when Mailboxer::Receipt
           obj.mark_as_read if obj.receiver == self
-        when Message, Notification
+        when Mailboxer::Message, Mailboxer::Notification
           obj.mark_as_read(self)
-        when Conversation
+        when Mailboxer::Conversation
           obj.mark_as_read(self)
         when Array
           obj.map{ |sub_obj| mark_as_read(sub_obj) }
@@ -136,11 +137,11 @@ module Mailboxer
       #* An array with any of them
       def mark_as_unread(obj)
         case obj
-        when Receipt
+        when Mailboxer::Receipt
           obj.mark_as_unread if obj.receiver == self
-        when Message, Notification
+        when Mailboxer::Message, Mailboxer::Notification
           obj.mark_as_unread(self)
-        when Conversation
+        when Mailboxer::Conversation
           obj.mark_as_unread(self)
         when Array
           obj.map{ |sub_obj| mark_as_unread(sub_obj) }
@@ -180,11 +181,11 @@ module Mailboxer
       #* An array with any of them
       def trash(obj)
         case obj
-        when Receipt
+        when Mailboxer::Receipt
           obj.move_to_trash if obj.receiver == self
-        when Message, Notification
+        when Mailboxer::Message, Mailboxer::Notification
           obj.move_to_trash(self)
-        when Conversation
+        when Mailboxer::Conversation
           obj.move_to_trash(self)
         when Array
           obj.map{ |sub_obj| trash(sub_obj) }
@@ -201,11 +202,11 @@ module Mailboxer
       #* An array with any of them
       def untrash(obj)
         case obj
-        when Receipt
+        when Mailboxer::Receipt
           obj.untrash if obj.receiver == self
-        when Message, Notification
+        when Mailboxer::Message, Mailboxer::Notification
           obj.untrash(self)
-        when Conversation
+        when Mailboxer::Conversation
           obj.untrash(self)
         when Array
           obj.map{ |sub_obj| untrash(sub_obj) }
@@ -213,7 +214,7 @@ module Mailboxer
       end
 
       def search_messages(query)
-        @search = Receipt.search do
+        @search = Mailboxer::Receipt.search do
           fulltext query
           with :receiver_id, self.id
         end

data/lib/mailboxer/version.rb

@@ -0,0 +1,3 @@
+module Mailboxer
+  VERSION = "0.12.0.rc1"
+end

data/mailboxer.gemspec

@@ -1,12 +1,17 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailboxer/version'
+
 Gem::Specification.new do |s|
   s.name = "mailboxer"
-  s.version = "0.11.0"
+  s.version = Mailboxer::VERSION
+
   s.authors = ["Eduardo Casanova Cuesta"]
   s.summary = "Messaging system for rails apps."
   s.description = "A Rails engine that allows any model to act as messageable, adding the ability to exchange messages " +
                    "with any other messageable model, even different ones. It supports the use of conversations with " +
-                   "two or more recipients to organize the messages. You have a complete use of a mailbox object for " + 
-                   "each messageable model that manages an inbox, sentbox and trash for conversations. It also supports " + 
+                   "two or more recipients to organize the messages. You have a complete use of a mailbox object for " +
+                   "each messageable model that manages an inbox, sentbox and trash for conversations. It also supports " +
                    "sending notifications to messageable models, intended to be used as system notifications."
   s.email = "ecasanovac@gmail.com"
   s.homepage = "https://github.com/ging/mailboxer"
@@ -19,15 +24,18 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('foreigner', '>= 0.9.1')
 
   # Development Gem dependencies
-  s.add_runtime_dependency('rails', '> 3.0.0')
+  s.add_runtime_dependency('rails', '>= 3.2.0')
   s.add_runtime_dependency('carrierwave', '>= 0.5.8')
-  # Debugging
-  if RUBY_VERSION < '1.9'
-    s.add_development_dependency('ruby-debug', '>= 0.10.3')
+
+  if RUBY_ENGINE == "rbx" && RUBY_VERSION >= "2.1.0"
+    # Rubinius has it's own dependencies
+    s.add_runtime_dependency     'rubysl'
+    s.add_development_dependency 'racc'
   end
   # Specs
   s.add_development_dependency('rspec-rails', '>= 2.6.1')
-  s.add_development_dependency("appraisal")
+  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')

data/spec/dummy/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'rails', '~> 3.0.0'
+gem 'rails', '~> 4.1.0'
 gem 'mailboxer', :path => '../../'
 gem 'factory_girl'
 

data/spec/dummy/app/models/duck.rb

@@ -2,9 +2,9 @@ class Duck < ActiveRecord::Base
   acts_as_messageable
   def mailboxer_email(object)
     case object
-    when Message
+    when Mailboxer::Message
       return nil
-    when Notification
+    when Mailboxer::Notification
       return email
     end
   end

data/spec/dummy/config/initializers/mailboxer.rb

@@ -14,4 +14,8 @@ Mailboxer.setup do |config|
   #Supported enignes: [: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

data/spec/dummy/db/migrate/20120305103200_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.references :notified_object, :polymorphic => true
+      t.string :notification_code, :default => nil
       t.column :conversation_id, :integer
       t.column :draft, :boolean, :default => false
+      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/spec/dummy/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/spec/dummy/db/schema.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -10,47 +11,55 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20120305103203) do
-
-  create_table "conversations", :force => true do |t|
-    t.string   "subject",    :default => ""
-    t.datetime "created_at",                 :null => false
-    t.datetime "updated_at",                 :null => false
-  end
+ActiveRecord::Schema.define(:version => 20131206080416) do
 
   create_table "cylons", :force => true do |t|
     t.string   "name"
     t.string   "email"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
   create_table "ducks", :force => true do |t|
     t.string   "name"
     t.string   "email"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "mailboxer_conversation_opt_outs", :force => true do |t|
+    t.integer "unsubscriber_id"
+    t.string  "unsubscriber_type"
+    t.integer "conversation_id"
+  end
+
+  create_table "mailboxer_conversations", :force => true do |t|
+    t.string   "subject",    :default => ""
+    t.datetime "created_at",                 :null => false
+    t.datetime "updated_at",                 :null => false
   end
 
-  create_table "notifications", :force => true do |t|
+  create_table "mailboxer_notifications", :force => true do |t|
     t.string   "type"
     t.text     "body"
     t.string   "subject",              :default => ""
     t.integer  "sender_id"
     t.string   "sender_type"
-    t.integer  "conversation_id"
-    t.boolean  "draft",                :default => false
-    t.datetime "updated_at",                              :null => false
-    t.datetime "created_at",                              :null => false
     t.integer  "notified_object_id"
     t.string   "notified_object_type"
     t.string   "notification_code"
+    t.integer  "conversation_id"
+    t.boolean  "draft",                :default => false
     t.string   "attachment"
+    t.datetime "updated_at",                              :null => false
+    t.datetime "created_at",                              :null => false
+    t.boolean  "global",               :default => false
+    t.datetime "expires"
   end
 
-  add_index "notifications", ["conversation_id"], :name => "index_notifications_on_conversation_id"
+  add_index "mailboxer_notifications", ["conversation_id"], :name => "index_mailboxer_notifications_on_conversation_id"
 
-  create_table "receipts", :force => true do |t|
+  create_table "mailboxer_receipts", :force => true do |t|
     t.integer  "receiver_id"
     t.string   "receiver_type"
     t.integer  "notification_id",                                  :null => false
@@ -62,13 +71,13 @@ ActiveRecord::Schema.define(:version => 20120305103203) do
     t.datetime "updated_at",                                       :null => false
   end
 
-  add_index "receipts", ["notification_id"], :name => "index_receipts_on_notification_id"
+  add_index "mailboxer_receipts", ["notification_id"], :name => "index_mailboxer_receipts_on_notification_id"
 
   create_table "users", :force => true do |t|
     t.string   "name"
     t.string   "email"
-    t.datetime "created_at", :null => false
-    t.datetime "updated_at", :null => false
+    t.datetime "created_at"
+    t.datetime "updated_at"
   end
 
 end