mailboxer 0.6.0 → 0.6.1

data/.gitignore

@@ -3,8 +3,10 @@ log/*.log
 pkg/
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
+spec/dummy/log/*.lck
 spec/dummy/tmp/
 spec/dummy/.project
+spec/dummy/solr
 **.tmp_*
 Gemfile.lock
 .idea

data/.travis.yml

@@ -1,6 +1,8 @@
+language: ruby
 rvm:
   - 1.8.7
   - 1.9.2
-  - rbx
+  - 1.9.3
   - ree
-
+  - rbx-18mode
+  - jruby-18mode

data/Gemfile

@@ -1,3 +1,3 @@
 source "http://rubygems.org"
-     
-gemspec
+
+gemspec

data/README.md

@@ -0,0 +1,239 @@
+# Mailboxer 0.6.x [![](https://secure.travis-ci.org/ging/mailboxer.png)](http://travis-ci.org/ging/mailboxer) [![](https://gemnasium.com/ging/mailboxer.png)](https://gemnasium.com/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 parallel 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).
+
+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 & Settings
+
+### Emails
+
+We are now adding support for sending emails when a Notification or a Message is sent to one o more recipients. You should modify mailboxer initializer (/config/initializer/mailboxer.rb) to edit this settings.
+
+````ruby
+Mailboxer.setup do |config|
+  #Configures if you applications uses or no the email sending for Notifications and Messages
+  config.uses_emails = true  
+  #Configures the default from for the email sent for Messages and Notifications of Mailboxer
+  config.default_from = "no-reply@dit.upm.es"
+  ...
+end
+````
+
+### User identities
+
+Users must have an identity defined by a `name` and an `email`. We must assure that Messageable models have some specific methods. These methods are:
+
+````ruby
+#Returning any kind of identification you want for the model
+def name
+  return "You should add method :name in your Messageable model"
+end
+````
+
+````ruby
+#Returning the email address of the model if an email should be sent for this object (Message or Notification).
+#If no mail has to be sent, return nil.
+def mailboxer_email(object)
+  #Check if an email should be sent for that object
+  #if true
+  return "define_email@on_your.model"
+  #if false
+  #return nil
+end
+````
+
+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 (/config/initializer/mailboxer.rb). Just add or uncomment the following lines:
+
+````ruby
+Mailboxer.setup do |config|
+  # ...
+  #Configures the methods needed by mailboxer
+  config.email_method = :mailboxer_email
+  config.name_method = :name
+  # ...
+end
+````
+
+You may change whatever you want or need. For example:
+
+````ruby
+config.email_method = :notifications_email
+config.name_method = :display_name
+````
+
+Will use the method `notification_email(object)` instead of `mailboxer_email(object)` and `display_name` for `name`.
+
+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.
+
+## Preparing your models
+
+In your model:
+
+````ruby
+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:
+
+````ruby
+class Duck < ActiveRecord::Base
+  acts_as_messageable
+end
+````
+
+````ruby
+class Cylon < ActiveRecord::Base
+  acts_as_messageable
+end
+````
+
+## Mailboxer API
+
+### How can I send a message?
+
+````ruby
+  #alfa wants to send a message to beta
+  alfa.send_message(beta, "Body", "subject")
+````
+
+### How can I reply a message?
+
+````ruby
+  #alfa wants to reply to all in a conversation
+  #using a receipt
+  alfa.reply_to_all(receipt, "Reply body")
+  #using a conversation
+  alfa.reply_to_conversation(conversation, "Reply body")
+````
+
+````ruby
+  #alfa wants to reply to the sender of a message (and ONLY the sender)
+  #using a receipt
+  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 paginate conversations?
+
+````ruby
+  #Using Kaminari to paginate the differents sets of conversations
+  #Paginating all conversations using :page parameter and 9 per page
+  conversations = Kaminari.paginate_array(alfa.mailbox.conversations).page(params[:page]).per(9)
+  #Paginating received conversations using :page parameter and 9 per page
+  conversations = Kaminari.paginate_array(alfa.mailbox.inbox).page(params[:page]).per(9)
+  #Paginating sent conversations using :page parameter and 9 per page
+  conversations = Kaminari.paginate_array(alfa.mailbox.sentbox).page(params[:page]).per(9)
+  #Paginating trashed conversations using :page parameter and 9 per page
+  conversations = Kaminari.paginate_array(alfa.mailbox.trash).page(params[:page]).per(9)
+````
+
+### How can I read the messages of a conversation?
+
+As a messageable, what you receive receipts wich are linked with the message itself. You should retrieve your receipts for the conversation a get the message associated to 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 of Mailboxer in [rubydoc.info](http://rubydoc.info/gems/mailboxer/frames).
+
+## I need a GUI!
+Check out the [rails-messaging](https://github.com/frodefi/rails-messaging) project.
+
+## Contributors
+* [Roendal](https://github.com/ging/mailboxer/commits/master?author=Roendal) (Eduardo Casanova)
+* [dickeyxxx](https://github.com/ging/mailboxer/commits/master?author=dickeyxxx) (Jeff Dickey)
+* [tonydewan](https://github.com/ging/mailboxer/commits/master?author=tonydewan) (Tony Dewan)
+* [plentz](https://github.com/ging/mailboxer/commits/master?author=plentz) (Diego Plentz)
+* [laserlemon](https://github.com/ging/mailboxer/commits/master?author=laserlemon) (Steve Richert)
+
+## License
+
+Copyright © 2012 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/Rakefile

@@ -1,27 +1,7 @@
-require 'rubygems'
-begin
-  require 'bundler/setup'
-  require 'bundler'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-require 'rake'
-require 'rake/rdoctask'
+require "bundler/gem_tasks"
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
-
 RSpec::Core::RakeTask.new(:spec)
-
 task :default => :spec
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "Mailboxer"
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb', 'app/**/*.rb')
-end
-
-
-Bundler::GemHelper.install_tasks

data/app/models/message.rb

@@ -8,6 +8,9 @@ class Message < Notification
   scope :conversation, lambda { |conversation|
     where(:conversation_id => conversation.id)
   }
+
+  mount_uploader :attachment, AttachmentUploader
+
   class << self
     #Sets the on deliver callback method.
     def on_deliver(callback_method)

data/app/models/receipt.rb

@@ -135,4 +135,16 @@ class Receipt < ActiveRecord::Base
     end
   end
 
+  if Mailboxer.search_enabled
+    searchable do
+      text :subject, :boost => 5 do
+        message.subject if message
+      end
+      text :body do
+        message.body if message
+      end
+      integer :receiver_id
+    end
+  end
+
 end

data/app/uploaders/attachment_uploader.rb

@@ -0,0 +1,3 @@
+class AttachmentUploader < CarrierWave::Uploader::Base
+  storage :file
+end

data/lib/generators/mailboxer/install_generator.rb

@@ -1,21 +1,29 @@
 class Mailboxer::InstallGenerator < Rails::Generators::Base #:nodoc:
   include Rails::Generators::Migration
-  
   source_root File.expand_path('../templates', __FILE__)
-  
-  require 'rails/generators/active_record'
-  
-  def self.next_migration_number(dirname)
-    ActiveRecord::Generators::Base.next_migration_number(dirname)
+  require 'rails/generators/migration'
+
+  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
-  
+
   def create_initializer_file
     template 'initializer.rb', 'config/initializers/mailboxer.rb'
   end
-  
-  def create_migration_file
-    require 'rake'
-    Rails.application.load_tasks
-    Rake::Task['mailboxer_engine:install:migrations'].invoke
+
+  def copy_migrations
+    migrations = ["create_mailboxer.rb","add_notified_object.rb","add_notification_code.rb","add_attachments.rb"]
+    migrations.each do |migration|
+      begin
+        migration_template migration, "db/migrate/" + migration
+      rescue
+        puts "Another migration is already named '" + migration + "'. Moving to next one."
+      end
+    end
   end
 end

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

@@ -0,0 +1,13 @@
+class AddAttachments < ActiveRecord::Migration
+  def self.up
+    change_table :notifications do |t|
+      t.string :attachment, :default => nil
+    end
+  end
+
+  def self.down
+    change_table :notifications do |t|
+      t.remove :attachment
+    end
+  end
+end

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

@@ -7,6 +7,11 @@ Mailboxer.setup do |config|
   config.default_from = "no-reply@mailboxer.com"
   
   #Configures the methods needed by mailboxer
-  #config.email_method = :mailboxer_email
-  #config.name_method = :name
-end
+  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] 
+  config.search_enabled = false
+  config.search_engine = :solr
+end

data/lib/generators/mailboxer/views_generator.rb

@@ -0,0 +1,9 @@
+class Mailboxer::ViewsGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../../app/views", __FILE__)
+  
+  desc "Copy Mailboxer views into your app"
+  def copy_views    
+    directory('message_mailer', 'app/views/message_mailer')
+    directory('notification_mailer', 'app/views/notification_mailer')
+  end
+end

data/lib/mailboxer.rb

@@ -4,7 +4,13 @@ module Mailboxer
   end  
   
   mattr_accessor :default_from
+  @@default_from = "no-reply@mailboxer.com"
   mattr_accessor :uses_emails
+  @@uses_emails = true
+  mattr_accessor :search_enabled
+  @@search_enabled = false
+  mattr_accessor :search_engine
+  @@search_engine = :solr
   mattr_accessor :email_method
   @@email_method = :mailboxer_email
   mattr_accessor :name_method
@@ -19,4 +25,4 @@ module Mailboxer
 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/engine' 

data/lib/mailboxer/engine.rb

@@ -1,5 +1,7 @@
 # Database foreign keys
 require 'foreigner'
+require 'carrierwave'
+require 'sunspot_rails'
 
 module Mailboxer
   class Engine < Rails::Engine