mailboxer 0.3.3 → 0.4.0

data/.gitignore

@@ -12,3 +12,5 @@ Gemfile.lock
 .document
 .settings/
 rdoc/
+doc/
+.yardoc/*

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - rbx
+  - ree
+

data/README.textile

@@ -0,0 +1,98 @@
+h1. Mailboxer "!https://secure.travis-ci.org/ging/mailboxer.png!":http://travis-ci.org/ging/mailboxer
+
+This project is based on the need of a private message system for "ging / social_stream":https://github.com/ging/social_stream. Instead of creating our core message system heavily dependent on our development we are trying to implement a generic and potent messaging gem.
+
+After looking for a good gem to use we notice the lack of messaging gems and functionality in them. Mailboxer tries to fill this emptiness giving a powerfull and generic message system. It supports the use of conversations with two or more recipients, send notification to a recipient (intended to be used as system notifications "Your picture has new comments", "John Doe has updated its document", etc.), emails the messageable model (if configured to do so). It has a complete use of a @Mailbox@ object for each messageable with @inbox@, @sentbox@ and @trash@. 
+
+The gem is constantly growing and improving its functionality. As it is used with our paralell development "(ging / social_stream)":https://github.com/ging/social_stream we are finding and fixing bugs continously. If you want some functionality not supported yet or marked as TODO, you can create an "issue":https://github.com/ging/mailboxer/issues to ask for it. It will be a great feedback for us, and we will know what you may find useful of the gem.
+
+Mailboxer was born from the great, but outdated, code from "lpsergi / acts_as_messageable":https://github.com/psergi/acts_as_messageable.
+
+We are now working to make an exhaustive documentation and some wiki pages in order to make even easier to use the gem at its full potencial. Please, give us some time if you find something missing or "ask for it":https://github.com/ging/mailboxer/issues.
+
+h2. Installation
+
+Add to your Gemfile:
+<pre><code>
+  gem 'mailboxer'
+</code></pre>
+Then run:
+<pre><code>
+  bundle update
+</code></pre>
+Run install script:
+<pre><code>
+  rails g mailboxer:install
+</code></pre>
+And don't forget to migrate you database:
+<pre><code>
+  rake db:migrate
+</code></pre>
+
+h2. 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 must assure that Messageable models have some specific methods. These methods are:
+<pre><code>
+  #Returning any kind of identification 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
+</code></pre>
+These names are explicit enough to avoid colliding with other methods, but as long as you need to change them you can do it by using mailboxer initializer. Just add or uncomment the following lines:
+<pre><code>
+  #Configures the methods needed by mailboxer
+  config.email_method = :email
+  config.name_method = :name
+  config.should_email_method = :should_email?
+</code></pre>
+You may change whatever you want or need. For example:
+<pre><code>
+  config.email_method = :notifications_email
+  config.name_method = :display_name
+  config.should_email_method = :do_you_want_this_to_be_mailed?
+</code></pre>
+Will use the method @notification_email@ instead of @email@, @display_name@ for @name@ and @do_you_want_this_to_be_mailed?@ for @should_email?@ 
+
+Using default or custom method names, if your model doesn't implement them, Mailboxer will use dummy methods not to crash but notify you the missing methods.
+
+h2. Preparing your models
+
+In your model:
+<pre><code>
+  class User < ActiveRecord::Base      
+    acts_as_messageable
+  end
+</code></pre>
+You are not limited to User model. You can use Mailboxer in any other model and use it in serveral different models. If you have ducks and cylons in your application and you want to interchange messages as if they where the same, just use act_as_messageable in each one and you will be able to send duck-duck, duck-cylon, cylon-duck and cylon-cylon messages. Of course, you can extend it for as many clases as you need. Example:
+<pre><code>
+  class Duck < ActiveRecord::Base      
+    acts_as_messageable
+  end
+</code></pre>
+<pre><code>
+  class Cylon < ActiveRecord::Base      
+    acts_as_messageable
+  end
+</code></pre>
+
+h2. Using Mailboxer. API
+
+In order to mantain the README in a proper size and simplicity, all the API is available in "Mailboxer wiki":https://github.com/ging/mailboxer/wiki
+
+h2. License
+
+Copyright (c) 2011 Eduardo Casanova Cuesta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/app/mailers/message_mailer.rb

@@ -19,9 +19,9 @@ class MessageMailer < ActionMailer::Base
     @receiver = receiver
     subject = message.subject.to_s
     subject = strip_tags(subject) unless  subject.html_safe?
-    mail(:to => receiver.send(Mailboxer.email_method), :subject => "You have a new message: " + subject) do |format|
-      format.html {render __method__}
+    mail(:to => receiver.send(Mailboxer.email_method), :subject => t('mailboxer.message_mailer.subject_new', :subject => subject)) do |format|
       format.text {render __method__}
+      format.html {render __method__}
     end
   end
 
@@ -31,9 +31,9 @@ class MessageMailer < ActionMailer::Base
     @receiver = receiver
     subject = message.subject.to_s
     subject = strip_tags(subject) unless  subject.html_safe?
-    mail(:to => receiver.send(Mailboxer.email_method), :subject => "You have a new reply: " + subject) do |format|
-      format.html {render __method__}
+    mail(:to => receiver.send(Mailboxer.email_method), :subject => t('mailboxer.message_mailer.subject_reply', :subject => subject)) do |format|
       format.text {render __method__}
+      format.html {render __method__}
     end
   end
 end

data/app/mailers/notification_mailer.rb

@@ -14,9 +14,9 @@ class NotificationMailer < ActionMailer::Base
     @receiver = receiver
     subject = message.subject.to_s
     subject = strip_tags(subject) unless subject.html_safe?
-    mail(:to => receiver.send(Mailboxer.email_method), :subject => "You have a new notification: " + subject) do |format|
-      format.html {render __method__}
+    mail(:to => receiver.send(Mailboxer.email_method), :subject => t('mailboxer.notification_mailer.subject', :subject => subject)) do |format|
       format.text {render __method__}
+      format.html {render __method__}
     end
   end
 end

data/app/models/notification.rb

@@ -2,7 +2,7 @@ class Notification < ActiveRecord::Base
 
   attr_accessor :recipients
   belongs_to :sender, :polymorphic => :true
-  belongs_to :object, :polymorphic => :true
+  belongs_to :notified_object, :polymorphic => :true
   validates_presence_of :subject, :body
   has_many :receipts, :dependent => :destroy
   
@@ -10,7 +10,7 @@ class Notification < ActiveRecord::Base
     joins(:receipts).where('receipts.receiver_id' => recipient.id,'receipts.receiver_type' => recipient.class.to_s)
   }
   scope :with_object, lambda { |obj|
-    where('object_id' => obj.id,'object_type' => obj.class.to_s)
+    where('notified_object_id' => obj.id,'notified_object_type' => obj.class.to_s)
   }    
   scope :not_trashed, lambda {
     joins(:receipts).where('receipts.trashed' => false)
@@ -21,11 +21,11 @@ class Notification < ActiveRecord::Base
   
   class << self
     #Sends a Notification to all the recipients
-    def notify_all(recipients,subject,body,object = nil)
+    def notify_all(recipients,subject,body,obj = nil)
       notification = Notification.new({:body => body, :subject => subject})
       notification.recipients = recipients.is_a?(Array) ? recipients : [recipients]
       notification.recipients = notification.recipients.uniq
-      notification.object = object if object.present?
+      notification.notified_object = obj if obj.present?
       return notification.deliver
     end
   end
@@ -126,5 +126,11 @@ class Notification < ActiveRecord::Base
     end
     self.body = sanitize self.body
   end
+  
+  #Returns notified_object. DEPRECATED
+  def object
+    warn "DEPRECATION WARNING: use 'notify_object' instead of 'object' to get the object associated with the Notification"
+    notified_object
+  end
 
 end

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  mailboxer:
+    message_mailer:
+      subject_new: "Mailboxer new message: %{subject}"
+      subject_reply: "Mailboxer new reply: %{subject}"
+    notification_mailer:
+      subject: "Mailboxer new notification: %{subject}"

data/db/migrate/20110719110700_add_notified_object.rb

@@ -0,0 +1,17 @@
+class AddNotifiedObject < ActiveRecord::Migration
+  def self.up
+    change_table :notifications do |t|
+      t.references :notified_object, :polymorphic => true
+      t.remove :object_id
+      t.remove :object_type
+    end
+  end
+
+  def self.down
+    change_table :notifications do |t|
+      t.remove :notified_object_id
+      t.remove :notified_object_type
+      t.references :object, :polymorphic => true
+    end
+  end
+end

data/lib/generators/mailboxer/install_generator.rb

@@ -14,6 +14,8 @@ class Mailboxer::InstallGenerator < Rails::Generators::Base #:nodoc:
   end
   
   def create_migration_file
-    migration_template 'migration.rb', 'db/migrate/create_mailboxer.rb'
+    require 'rake'
+    Rails.application.load_tasks
+    Rake::Task['mailboxer_engine:install:migrations'].invoke
   end
 end

data/lib/mailboxer/models/messageable.rb

@@ -18,7 +18,7 @@ module Mailboxer
 
       module InstanceMethods        
           eval <<-EOM
-           #Returning any kind of indentification you want for the model
+           #Returning any kind of identification you want for the model
            def #{Mailboxer.name_method}
              super
            rescue NameError
@@ -47,10 +47,10 @@ module Mailboxer
         end
 
         #Sends a notification to the messageable
-        def notify(subject,body,object = nil)
+        def notify(subject,body,obj = nil)
           notification = Notification.new({:body => body, :subject => subject})
           notification.recipients = [self]
-          notification.object = object if object.present?
+          notification.notified_object = obj if obj.present?
           return notification.deliver
         end
 

data/mailboxer.gemspec

@@ -1,12 +1,15 @@
 Gem::Specification.new do |s|
 	s.name = "mailboxer"
-	s.version = "0.3.3"
+	s.version = "0.4.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." +  
-	                "It also supports sending system notifications to messageable models."
+	s.description = "A Rails engine that allows any model to act as messageable, allowing it 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 " + 
+	                 "sending notifications to messageable models, intended to be used as system notifications."
 	s.email = "ecasanovac@gmail.com"
-	s.homepage = "http://github.com/ging/mailboxer"
+	s.homepage = "https://github.com/ging/mailboxer"
 	s.files = `git ls-files`.split("\n")
 
 	# Gem dependencies
@@ -16,7 +19,7 @@ Gem::Specification.new do |s|
 
 	# Development Gem dependencies
 	#
-  s.add_runtime_dependency('rails', '3.1.0.rc4')
+  s.add_runtime_dependency('rails', '~> 3.1.0.rc4')
 	# Testing database
 	s.add_development_dependency('sqlite3-ruby')
 	# Debugging

data/spec/dummy/db/migrate/20110719121059_add_notified_object.rb

@@ -0,0 +1,17 @@
+class AddNotifiedObject < ActiveRecord::Migration
+  def self.up
+    change_table :notifications do |t|
+      t.references :notified_object, :polymorphic => true
+      t.remove :object_id
+      t.remove :object_type
+    end
+  end
+
+  def self.down
+    change_table :notifications do |t|
+      t.remove :notified_object_id
+      t.remove :notified_object_type
+      t.references :object, :polymorphic => true
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20110511145103) do
+ActiveRecord::Schema.define(:version => 20110719121059) do
 
   create_table "conversations", :force => true do |t|
     t.string   "subject",    :default => ""
@@ -35,15 +35,15 @@ ActiveRecord::Schema.define(:version => 20110511145103) do
   create_table "notifications", :force => true do |t|
     t.string   "type"
     t.text     "body"
-    t.string   "subject",         :default => ""
+    t.string   "subject",              :default => ""
     t.integer  "sender_id"
     t.string   "sender_type"
-    t.integer  "object_id"
-    t.string   "object_type"
     t.integer  "conversation_id"
-    t.boolean  "draft",           :default => false
-    t.datetime "updated_at",                         :null => false
-    t.datetime "created_at",                         :null => false
+    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"
   end
 
   add_index "notifications", ["conversation_id"], :name => "index_notifications_on_conversation_id"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-15 00:00:00 +02:00
+date: 2011-07-20 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,7 +39,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 15424109
         segments: 
@@ -146,7 +146,7 @@ dependencies:
   type: :development
   name: capybara
   version_requirements: *id008
-description: A Rails engine that allows any model to act as messageable, permitting it interchange messages with any other messageable model.It also supports sending system notifications to messageable models.
+description: A Rails engine that allows any model to act as messageable, allowing it 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 sending notifications to messageable models, intended to be used as system notifications.
 email: ecasanovac@gmail.com
 executables: []
 
@@ -157,10 +157,11 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - app/mailers/message_mailer.rb
@@ -176,15 +177,16 @@ files:
 - 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
+- config/locales/en.yml
+- db/migrate/20110511145103_create_mailboxer.rb
+- db/migrate/20110719110700_add_notified_object.rb
 - 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/models/messageable.rb
 - mailboxer.gemspec
 - spec/dummy/Gemfile
-- spec/dummy/Gemfile.lock
 - spec/dummy/Rakefile
 - spec/dummy/app/controllers/application_controller.rb
 - spec/dummy/app/helpers/application_helper.rb
@@ -211,7 +213,8 @@ 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/20110511145103_create_mailboxer.rb
+- spec/dummy/db/migrate/20110719111119_create_mailboxer.rb
+- spec/dummy/db/migrate/20110719121059_add_notified_object.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/public/404.html
 - spec/dummy/public/422.html
@@ -242,7 +245,7 @@ files:
 - spec/models/receipt_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/ging/mailboxer
+homepage: https://github.com/ging/mailboxer
 licenses: []
 
 post_install_message: 

data/README.rdoc

@@ -1,80 +0,0 @@
-= Mailboxer
-
-This project is based on the need of a private message system for {ging / social_stream}[https://github.com/ging/social_stream]. Instead of creating our core message system heavily dependent on our development we are trying to implement a generic and potent messaging gem.
-
-It is born from the great, but old, code from {lpsergi / acts_as_messageable}[https://github.com/psergi/acts_as_messageable].
-
-There is a lack of documentaion and it will be solved as soon as the gem is more stable and had proved to be useful integrated with SocialStream.
-
-
-= Installation
-
-Add to your Gemfile:
-
-  gem 'mailboxer'
-  
-Then run:
-
-  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
-
-These names are explicit enough to not collide with other methods, but as long as you need to change them you can do it by using mailboxer intializer. Just add or uncomment the following lines:
-
-  #Configures the methods needed by mailboxer
-  config.email_method = :email
-  config.name_method = :name
-  config.should_email_method = :should_email?
-  
-You may change to whatever you want or need. For example:
-  
-  config.email_method = :notifications_email
-  config.name_method = :display_name
-  config.should_email_method = :do_you_want_this_to_be_mailed?
-  
-Will use the method "notification_email" instead of "email", "display_name" for "name" and "do_you_want_this_to_be_mailed?" for "should_email?" 
-
-Using default or custom method names, if your model doesn't implement them, Mailboxer will use dummy methods not to crash but notify you the missing methods.
-
-= Usage
-
-In your model:
-
-  class User < ActiveRecord::Base      
-    acts_as_messageable
-  end
-
-You are not limited to User model. You can use Mailboxer in any other model and use it in serveral different models. If you have ducks and cylons in your application and you want to interchange messages as if they where the same, just use act_as_messageable in each one and you will be able to send duck-duck, duck-cylon, cylon-duck and cylon-cylon messages. Of course, you can extend it for as many clases as you need. Example:
-
-  class Duck < ActiveRecord::Base      
-    acts_as_messageable
-  end
-
-  class Cylon < ActiveRecord::Base      
-    acts_as_messageable
-  end

data/spec/dummy/Gemfile.lock

@@ -1,18 +0,0 @@
-PATH
-  remote: ../../../mailboxer
-  specs:
-    mailboxer (0.1.3)
-      foreigner (~> 0.9.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    foreigner (0.9.2)
-    mysql (2.8.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  mailboxer!
-  mysql (= 2.8.1)