mailboxer 0.0.16 → 0.1.0

data/README.rdoc

@@ -12,15 +12,45 @@ There is a lack of documentaion and it will be solved as soon as the gem is more
 Add to your Gemfile:
 
   gem 'mailboxer'
+  
+Then run:
 
-Migrations:
+  bundle update
+
+Run install script:
 
   rails g mailboxer:install
+  
+And don't forget to migrate you database:
+
+  rake db:migrate
+  
+= Requirements
+
+We are now adding support for sending emails when a Notification or a Message is sent to one o more recipients. So that, we mus assure that Messageable models have some specific methods. This methods are:
+
+  #Returning any kind of indentification you want for the model
+  def name
+    return "You should add method :name in your Messageable model"
+  end
+
+  #Returning the email address of the model
+  def email
+    return "define_email@on_your.model"
+  end
+
+  #Returning whether an email should be sent for this object (Message or Notification)
+  def should_email?(object)
+    return true
+  end
+
+If these methods are not present, default ones will be created (the ones above).
+
 
 = Usage
 
 In your model:
 
-  class User < ActiveRecord::Base
+  class User < ActiveRecord::Base      
     acts_as_messageable
   end

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/app/mailers/message_mailer.rb

@@ -0,0 +1,35 @@
+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 > 0
+      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
+    mail(:to => receiver.email, :subject => "You have a new message: " + strip_tags(message.subject)) do |format|
+      format.html {render __method__}
+      format.text {render __method__}
+    end
+  end
+
+  #Sends and email for indicating a reply in an already created conversation
+  def reply_message_email(message,receiver)
+    @message = message
+    @receiver = receiver
+    mail(:to => receiver.email, :subject => "You have a new reply: " + strip_tags(message.subject)) do |format|
+      format.html {render __method__}
+      format.text {render __method__}
+    end
+  end
+end

data/app/mailers/notification_mailer.rb

@@ -0,0 +1,20 @@
+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
+    mail(:to => receiver.email, :subject => "You have a new notification: " + strip_tags(notification.subject)) do |format|
+      format.html {render __method__}
+      format.text {render __method__}
+    end
+  end
+end

data/app/models/message.rb

@@ -8,14 +8,13 @@ class Message < Notification
   scope :conversation, lambda { |conversation|
     where(:conversation_id => conversation.id)
   }
-  
   class << self
     #Sets the on deliver callback method.
     def on_deliver(callback_method)
       self.on_deliver_callback = callback_method
     end
   end
-  
+
   #Delivers a Message. USE NOT RECOMENDED.
   #Use Mailboxer::Models::Message.send_message instead.
   def deliver(reply = false, should_clean = true)
@@ -29,6 +28,10 @@ class Message < Notification
       msg_receipt.receiver = r
       msg_receipt.mailbox_type = "inbox"
       temp_receipts << msg_receipt
+      #Should send an email?
+      if r.should_email? self
+        MessageMailer.send_email(self,r).deliver
+      end
     end
     #Sender receipt
     sender_receipt = Receipt.new
@@ -44,9 +47,9 @@ class Message < Notification
       if reply
       self.conversation.update_attribute(:updated_at, Time.now)
       end
-      self.recipients=nil
-      self.on_deliver_callback.call(self) unless self.on_deliver_callback.nil?
+    self.recipients=nil
+    self.on_deliver_callback.call(self) unless self.on_deliver_callback.nil?
     end
     return sender_receipt
-  end  
+  end
 end

data/app/models/notification.rb

@@ -1,6 +1,7 @@
 class Notification < ActiveRecord::Base
 
   attr_accessor :recipients
+  attr_accessor :object
   belongs_to :sender, :polymorphic => :true
   validates_presence_of :subject, :body
   has_many :receipts
@@ -30,7 +31,11 @@ class Notification < ActiveRecord::Base
       msg_receipt.notification = self
       msg_receipt.read = false
       msg_receipt.receiver = r
-      temp_receipts << msg_receipt
+      temp_receipts << msg_receipt      
+      #Should send an email?
+      if r.should_email? self
+        NotificationMailer.send_email(self,r).deliver
+      end
     end
     temp_receipts.each(&:valid?)
     if temp_receipts.all? { |t| t.errors.empty? }

data/app/views/message_mailer/new_message_email.html.erb

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

data/app/views/message_mailer/new_message_email.text.erb

@@ -0,0 +1,10 @@
+You have a new message: <%= strip_tags(@message.subject) %>
+===============================================
+ 
+You have received a new message:
+
+-----------------------------------------------
+<%= strip_tags @message.body %>
+-----------------------------------------------
+
+Visit <%= root_url %> and go to your inbox for more info.

data/app/views/message_mailer/reply_message_email.html.erb

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

data/app/views/message_mailer/reply_message_email.text.erb

@@ -0,0 +1,10 @@
+You have a new reply: <%= strip_tags(@message.subject) %>
+===============================================
+ 
+You have received a new reply:
+
+-----------------------------------------------
+<%= strip_tags @message.body %>
+-----------------------------------------------
+
+Visit <%= root_url %> and go to your inbox for more info.

data/app/views/notification_mailer/new_notification_email.html.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+  </head>
+  <body>
+    <h1>You have a new notification: <%= strip_tags(@notification.subject) %></h1>
+    <p>
+      You have received a new notification:
+    </p>
+    <blockquote>
+      <p>
+        <%= raw @notification.body %>
+      </p>
+    </blockquote>
+    <p>
+      Visit <%= link_to root_url,root_url %> and go to your notifications for more info.
+    </p>
+  </body>
+</html>

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

@@ -0,0 +1,10 @@
+You have a new notification: <%= strip_tags(@notification.subject) %>
+===============================================
+ 
+You have received a new notification:
+
+-----------------------------------------------
+<%= strip_tags @notification.body %>
+-----------------------------------------------
+
+Visit <%= root_url %> and go to your notifications for more info.

data/lib/generators/mailboxer/install_generator.rb

@@ -9,6 +9,10 @@ class Mailboxer::InstallGenerator < Rails::Generators::Base #:nodoc:
     ActiveRecord::Generators::Base.next_migration_number(dirname)
   end
   
+  def create_initializer_file
+    template 'initializer.rb', 'config/initializers/mailboxer.rb'
+  end
+  
   def create_migration_file
     migration_template 'migration.rb', 'db/migrate/create_mailboxer.rb'
   end

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

@@ -0,0 +1,4 @@
+Mailboxer.setup do |config|
+  #Configures the default from for the email sent for Messages and Notifications of Mailboxer
+  config.default_from = "no-reply@mailboxer.com"
+end

data/lib/mailboxer.rb

@@ -2,6 +2,18 @@ module Mailboxer
   module Models
     autoload :Messageable, 'mailboxer/models/messageable'
   end  
+  module Exceptions
+    autoload :NotCompliantModel, 'mailboxer/exceptions'
+  end  
+  
+  mattr_accessor :default_from
+  
+   class << self
+    def setup
+      yield self
+    end
+   end
+   
 end
 # reopen ActiveRecord and include all the above to make
 # them available to all our models if they want it

data/lib/mailboxer/exceptions.rb

@@ -0,0 +1,12 @@
+module Mailboxer
+  module Exceptions
+    #Mailboxer::Exceptions::NotCompliantModel is raised when your model with acts_as_messageable
+    #method is not compliant with the requirements for acting as messageable.
+    #
+    #These requirements are:
+    #* <b>"name" method</b>: Returning any kind of indentification you want for the model
+    #* <b>"email" method</b>: Returning the email address of the model. 
+    #* <b>"should_email?(object)" method</b>: Returning whether an email should be sent for this object (Message or Notification)
+    class NotCompliantModel < RuntimeError; end   
+  end
+end

data/lib/mailboxer/models/messageable.rb

@@ -12,6 +12,34 @@ module Mailboxer
           has_many :messages
           has_many :receipts, :order => 'created_at DESC', :dependent => :delete_all
 
+          if self.table_exists?
+            if !self.new.respond_to? :name
+              self.class_eval do
+              #Returning any kind of indentification you want for the model
+                def name
+                  return "You should add method :name in your Messageable model"
+                end
+              end
+            end
+
+            if !self.new.respond_to? :email
+              self.class_eval do
+              #Returning the email address of the model
+                def email
+                  return "define_email@on_your.model"
+                end
+              end
+            end
+
+            if !self.new.respond_to? :should_email?
+              self.class_eval do
+              #Returning whether an email should be sent for this object (Message or Notification)
+                def should_email?(object)
+                  return true
+                end
+              end
+            end
+          end
           include Mailboxer::Models::Messageable::InstanceMethods
         end
       end

data/mailboxer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "mailboxer"
-	s.version = "0.0.16"
+	s.version = "0.1.0"
 	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, permitting it interchange messages with any other messageable model." +  

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

@@ -1,3 +1,7 @@
 class Cylon < ActiveRecord::Base
-  acts_as_messageable 
+  acts_as_messageable
+    
+  def should_email?(object)
+    return false
+  end
 end

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

@@ -1,3 +1,12 @@
 class Duck < ActiveRecord::Base
-  acts_as_messageable 
+  acts_as_messageable
+  
+  def should_email?(object)
+    case object
+    when Message
+      return false
+    when Notification
+      return true
+    end
+  end
 end

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

@@ -1,3 +1,3 @@
-class User < ActiveRecord::Base 
-  acts_as_messageable 
+class User < ActiveRecord::Base
+  acts_as_messageable
 end

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

@@ -0,0 +1,3 @@
+Mailboxer.setup do |config|
+  config.default_from = "no-reply@mailboxer.com"
+end

data/spec/dummy/db/migrate/20110228120600_create_users.rb

@@ -2,6 +2,7 @@ class CreateUsers < ActiveRecord::Migration
   def self.up
     create_table :users do |t|
       t.string :name
+      t.string :email
 
       t.timestamps
     end

data/spec/dummy/db/migrate/20110306002940_create_ducks.rb

@@ -2,6 +2,7 @@ class CreateDucks < ActiveRecord::Migration
   def self.up
     create_table :ducks do |t|
       t.string :name
+      t.string :email
 
       t.timestamps
     end

data/spec/dummy/db/migrate/20110306015107_create_cylons.rb

@@ -2,6 +2,7 @@ class CreateCylons < ActiveRecord::Migration
   def self.up
     create_table :cylons do |t|
       t.string :name
+      t.string :email
 
       t.timestamps
     end

data/spec/dummy/db/migrate/{20110407111612_create_mailboxer.rb → 20110427123542_create_mailboxer.rb}

@@ -35,6 +35,7 @@ class CreateMailboxer < ActiveRecord::Migration
   	#Conversations
   	#Receipts
   	add_index "receipts","notification_id"
+
   	#Messages  
   	add_index "notifications","conversation_id"
   

data/spec/dummy/db/schema.rb

@@ -10,22 +10,59 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20110306015107) do
+ActiveRecord::Schema.define(:version => 20110427123542) 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
 
   create_table "cylons", :force => true do |t|
     t.string   "name"
+    t.string   "email"
     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"
     t.datetime "updated_at"
   end
 
+  create_table "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
+  end
+
+  add_index "notifications", ["conversation_id"], :name => "index_notifications_on_conversation_id"
+
+  create_table "receipts", :force => true do |t|
+    t.integer  "receiver_id"
+    t.string   "receiver_type"
+    t.integer  "notification_id",                                  :null => false
+    t.boolean  "read",                          :default => false
+    t.boolean  "trashed",                       :default => false
+    t.boolean  "deleted",                       :default => false
+    t.string   "mailbox_type",    :limit => 25
+    t.datetime "created_at",                                       :null => false
+    t.datetime "updated_at",                                       :null => false
+  end
+
+  add_index "receipts", ["notification_id"], :name => "index_receipts_on_notification_id"
+
   create_table "users", :force => true do |t|
     t.string   "name"
+    t.string   "email"
     t.datetime "created_at"
     t.datetime "updated_at"
   end

data/spec/factories/cylon.rb

@@ -1,3 +1,4 @@
 Factory.define :cylon do |c|
   c.sequence(:name) { |n| "Cylon #{ n }" }
+  c.sequence(:email) { |n| "cylon#{ n }@cylon.com" }
 end

data/spec/factories/duck.rb

@@ -1,3 +1,4 @@
 Factory.define :duck do |d|
   d.sequence(:name) { |n| "Duck #{ n }" }
+  d.sequence(:email) { |n| "duck#{ n }@duck.com" }
 end

data/spec/factories/user.rb

@@ -1,3 +1,4 @@
 Factory.define :user do |u|
   u.sequence(:name) { |n| "User #{ n }" }
+  u.sequence(:email) { |n| "user#{ n }@user.com" }
 end

data/spec/mailers/message_mailer_spec.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe MessageMailer do
+  describe "when sending new message" do
+    before do
+      @sender = Factory(:user)
+      @entity1 = Factory(:user)
+      @entity2 = Factory(:duck)
+      @entity3 = Factory(:cylon)
+      @receipt1 = @sender.send_message([@entity1,@entity2,@entity3], "Body Body Body Body Body Body Body Body Body Body Body Body","Subject")
+    end
+
+    it "should send emails when should_email? is true (1 out of 3)" do
+      ActionMailer::Base.deliveries.empty?.should==false
+      ActionMailer::Base.deliveries.size.should==1
+    end
+
+    it "should send an email to user entity" do
+      temp = false
+      ActionMailer::Base.deliveries.each do |email|
+        if email.to.first.to_s.eql? @entity1.email
+        temp = true
+        end
+      end
+      temp.should==true
+    end
+
+    it "shouldn't send an email to duck entity" do
+      temp = false
+      ActionMailer::Base.deliveries.each do |email|
+        if email.to.first.to_s.eql? @entity2.email
+        temp = true
+        end
+      end
+      temp.should==false
+    end
+
+    it "shouldn't send an email to cylon entity" do
+      temp = false
+      ActionMailer::Base.deliveries.each do |email|
+        if email.to.first.to_s.eql? @entity3.email
+        temp = true
+        end
+      end
+      temp.should==false
+    end
+  end
+
+  describe "when replying" do
+    before do
+      @sender = Factory(:user)
+      @entity1 = Factory(:user)
+      @entity2 = Factory(:duck)
+      @entity3 = Factory(:cylon)
+      @receipt1 = @sender.send_message([@entity1,@entity2,@entity3], "Body","Subject")
+      @receipt2 = @sender.reply_to_all(@receipt1, "Body")
+    end
+    
+    it "should send emails when should_email? is true (1 out of 3)" do
+      ActionMailer::Base.deliveries.empty?.should==false
+      ActionMailer::Base.deliveries.size.should==2
+    end
+
+    it "should send an email to user entity" do
+      temp = false
+      ActionMailer::Base.deliveries.each do |email|
+        if email.to.first.to_s.eql? @entity1.email
+        temp = true
+        end
+      end
+      temp.should==true
+    end
+
+    it "shouldn't send an email to duck entity" do
+      temp = false
+      ActionMailer::Base.deliveries.each do |email|
+        if email.to.first.to_s.eql? @entity2.email
+        temp = true
+        end
+      end
+      temp.should==false
+    end
+
+    it "shouldn't send an email to cylon entity" do
+      temp = false
+      ActionMailer::Base.deliveries.each do |email|
+        if email.to.first.to_s.eql? @entity3.email
+        temp = true
+        end
+      end
+      temp.should==false
+    end
+  end
+end
+
+def print_emails
+  ActionMailer::Base.deliveries.each do |email|
+    puts "----------------------------------------------------"
+    puts email.to
+    puts "---"
+    puts email.from
+    puts "---"
+    puts email.subject
+    puts "---"
+    puts email.body
+    puts "---"
+    puts email.encoded
+    puts "----------------------------------------------------"
+  end
+end

data/spec/mailers/notification_mailer_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe NotificationMailer do
+  before do
+    @entity1 = Factory(:user)
+    @entity2 = Factory(:duck)
+    @entity3 = Factory(:cylon)
+    @receipt1 = Notification.notify_all([@entity1,@entity2,@entity3],"Subject", "Body Body Body Body Body Body Body Body Body Body Body Body")
+  end
+
+  it "should send emails when should_email? is true (2 out of 3)" do
+    ActionMailer::Base.deliveries.empty?.should==false
+    ActionMailer::Base.deliveries.size.should==2
+  end
+
+  it "should send an email to user entity" do
+    temp = false
+    ActionMailer::Base.deliveries.each do |email|
+      if email.to.first.to_s.eql? @entity1.email
+      temp = true
+      end
+    end
+    temp.should==true
+  end
+
+  it "should send an email to duck entity" do
+    temp = false
+    ActionMailer::Base.deliveries.each do |email|
+      if email.to.first.to_s.eql? @entity2.email
+      temp = true
+      end
+    end
+    temp.should==true
+  end
+
+  it "shouldn't send an email to cylon entity" do
+    temp = false
+    ActionMailer::Base.deliveries.each do |email|
+      if email.to.first.to_s.eql? @entity3.email
+      temp = true
+      end
+    end
+    temp.should==false
+  end
+end
+
+def print_emails
+  ActionMailer::Base.deliveries.each do |email|
+      puts "----------------------------------------------------"
+      puts email.to
+      puts "---"
+      puts email.from
+      puts "---"
+      puts email.subject
+      puts "---"
+      puts email.body
+      puts "---"
+      puts email.encoded
+      puts "----------------------------------------------------"
+    end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 16
-  version: 0.0.16
+  version: 0.1.0
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-17 00:00:00 +02:00
+date: 2011-04-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -160,15 +160,25 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- app/mailers/message_mailer.rb
+- app/mailers/notification_mailer.rb
 - app/models/conversation.rb
 - app/models/mailbox.rb
 - app/models/message.rb
 - app/models/notification.rb
 - app/models/receipt.rb
+- app/views/message_mailer/new_message_email.html.erb
+- app/views/message_mailer/new_message_email.text.erb
+- app/views/message_mailer/reply_message_email.html.erb
+- app/views/message_mailer/reply_message_email.text.erb
+- app/views/notification_mailer/new_notification_email.html.erb
+- app/views/notification_mailer/new_notification_email.text.erb
 - lib/generators/mailboxer/install_generator.rb
+- lib/generators/mailboxer/templates/initializer.rb
 - lib/generators/mailboxer/templates/migration.rb
 - lib/mailboxer.rb
 - lib/mailboxer/engine.rb
+- lib/mailboxer/exceptions.rb
 - lib/mailboxer/models/messageable.rb
 - mailboxer.gemspec
 - spec/dummy/.project
@@ -191,6 +201,7 @@ files:
 - spec/dummy/config/environments/test.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
 - spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mailboxer.rb
 - spec/dummy/config/initializers/mime_types.rb
 - spec/dummy/config/initializers/secret_token.rb
 - spec/dummy/config/initializers/session_store.rb
@@ -199,7 +210,7 @@ files:
 - spec/dummy/db/migrate/20110228120600_create_users.rb
 - spec/dummy/db/migrate/20110306002940_create_ducks.rb
 - spec/dummy/db/migrate/20110306015107_create_cylons.rb
-- spec/dummy/db/migrate/20110407111612_create_mailboxer.rb
+- spec/dummy/db/migrate/20110427123542_create_mailboxer.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -220,6 +231,8 @@ files:
 - spec/integration/message_and_receipt_spec.rb
 - spec/integration/navigation_spec.rb
 - spec/mailboxer_spec.rb
+- spec/mailers/message_mailer_spec.rb
+- spec/mailers/notification_mailer_spec.rb
 - spec/models/conversation_spec.rb
 - spec/models/mailbox_spec.rb
 - spec/models/mailboxer_models_messageable_spec.rb