facteur 1.2.1 → 1.3.0

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+spec/db/.*
+*.gemspec

data/CHANGELOG

@@ -0,0 +1,4 @@
+Version 1.3.0 (20.02.2011)
+--------------------------
+- Added mongoid support
+- The mailbox and message models are now in the gem. They were removed from the generators

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in amistad.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    facteur (1.3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.7)
+      actionpack (= 3.0.7)
+      mail (~> 2.2.15)
+    actionpack (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+    activesupport (3.0.7)
+    arel (2.0.9)
+    awesome_print (0.3.2)
+    bson (1.3.0)
+    bson_ext (1.3.0)
+    builder (2.1.2)
+    chalofa_ruby-progressbar (0.0.9.1)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    fuubar (0.0.4)
+      chalofa_ruby-progressbar (~> 0.0.9)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.4)
+    i18n (0.5.0)
+    mail (2.2.17)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    mongo (1.3.0)
+      bson (>= 1.3.0)
+    mongoid (2.0.1)
+      activemodel (~> 3.0)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.7)
+      actionmailer (= 3.0.7)
+      actionpack (= 3.0.7)
+      activerecord (= 3.0.7)
+      activeresource (= 3.0.7)
+      activesupport (= 3.0.7)
+      bundler (~> 1.0)
+      railties (= 3.0.7)
+    railties (3.0.7)
+      actionpack (= 3.0.7)
+      activesupport (= 3.0.7)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.7)
+    rspec-mocks (2.5.0)
+    sqlite3 (1.3.3)
+    sqlite3 (1.3.3-x86-mingw32)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.26)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+  x86-mingw32
+
+DEPENDENCIES
+  activerecord (~> 3.0.7)
+  activesupport (~> 3.0.7)
+  awesome_print (~> 0.3.2)
+  bson_ext (~> 1.3)
+  bundler (~> 1.0.12)
+  facteur!
+  fuubar (~> 0.0.4)
+  mongoid (~> 2.0.0)
+  rails (~> 3.0.7)
+  rspec (~> 2.5.0)
+  sqlite3 (>= 1.3.2)

data/LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2009 Rawane ZOSSOU
-
-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.
+Copyright (c) 2011 Rawane ZOSSOU
+
+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/README.markdown

@@ -1,137 +1,135 @@
-# facteur #
-
-Facteur allows you to add an email-like messaging system in your Rails 3 application. You can create many mailboxes for your users where they will be able to send and receive messages.
-
-## Installation ##
-
-Just run the following command :
-
-    gem install facteur
-  
-Then in your Gemfile add the following line :
-
-    gem 'facteur'
-    
-## Usage ##
-
-First install the messaging system in your application :
-
-    rails generate facteur:install  
-    
-This commands creates two new models called __mailbox__  and __message__ in *'app/models'* (in the future the names will be changeable):
-
-    class Mailbox < ActiveRecord::Base
-      include Facteur::MailboxModel
-    end
-
-    class Message < ActiveRecord::Base
-      include Facteur::MessageModel 
-    end
-
-It also creates the migrations for the new models so don't forget to migrate your database :
-
-    rake db:migrate
-
-Then to activate __facteur__ in your user model, just include the addressee's model as follows :
-
-    class User < ActiveRecord::Base  
-      include Facteur::AddresseeModel
-    end
-    
-You model must be named 'User'. This will be changed in the future.
-
-## Messaging system ##
-
-### Creating mailboxes ###
-
-In the facteur's system, each user must have a mailbox where he can receive messages. The mailboxes can be declared statically and/or dynamically. Let's start first by the static way :
-
-    class User < ActiveRecord::Base  
-      include Facteur::AddresseeModel
-      
-      mailbox :private_mailbox, :default => true
-      mailbox :public_mailbox
-    end
-
-The previous example declare two mailboxes that will be created for each user. The mailboxes are created just after the user was created itself. Facteur generates for you two methods to access your mailboxes :
-
-    # assuming that 'login' and 'password' are fields defined for the User model
-    @john = User.create(:login => 'john', :password => 'pass')
-    
-    # Now, the mailboxes exist and they can be accessed
-    @john.private_mailbox #=> returns the private mailbox
-    @john.public_mailbox #=> returns the public mailbox
-    
-    # To check the mailboxes which where defined
-    User.mailboxes #=> [{:name=>:private_mailbox, :default=>true}, {:name=>:public_mailbox}]
-    
-It is also possible to create a mailbox dynamically. This mailbox will not be available to all the user but only  to the user who created it :
-
-    @john.create_mailbox(:new_mailbox) #=> true
-    User.mailboxes #=> [{:name=>:private_mailbox, :default=>true}, {:name=>:public_mailbox}]
-    @john.mailboxes #=> [{:name=>:private_mailbox, :default=>true}, {:name=>:public_mailbox}, {:name=>:new_mailbox}]
-    
-After the previous example, the "news\_mailbox" is only avalaible to John. The names of the mailboxes must be unique. if you try to create a mailbox which already exists, the create_mailbox() method will return false.
-
-### Sending messages ###
-
-It is possible to send a message to one or many user :
-
-    @peter = User.create(:login => 'peter', :password => 'pass')
-    @mary = User.create(:login => 'mary', :password => 'pass')
-    
-    @john.send_message('hello', :to => @peter, :in => :private_mailbox)
-    @john.send_message('hello', :to => [@peter, @mary], :in => :public_mailbox)
-    
-The 'in' option is not mandatory. If it is not given, the message is delivered to the default mailbox. If there is no default mailbox defined then the method fails.
-
-You can access the messages in a mailbox :
-
-    @peter.private_mailbox.messages
-    
-To list the messages sent by a user :
-
-    @john.messages_sent
-    
-### More methods ###
-
-This section list the other methods available for each elements of the messaging system :
-
-#### User ####
-
-    mailboxes      : mailboxes assigned to this user
-    messages_sent  : messages sent by the user
-
-#### Mailbox ####
-
-    addressee : who the mailbox is assigned to
-    messages  : messages who are stored in the mailbox
-    name      : the name of the mailbox
-
-#### Message ####
-
-    mailbox     : mailbox where the message is stored
-    author      : user who send the message
-    addressee   : who the message was sent to
-    body        : body of the message
-    created_at  : date of creation
-    
-## Testing the gem ##
-
-It is possible to test facteur by running the following command from the gem directory:
-
-    rake spec
-
-## Note on Patches/Pull Requests ##
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-## Copyright ##
-
-Copyright (c) 2010 Rawane ZOSSOU. See LICENSE for details.
+# facteur #
+
+Facteur allows you to add an email-like messaging system in your Rails 3 application. You can create many mailboxes for your users where they will be able to send and receive messages. Facteur supports ActiverRecord 3.0.x and Mongoid 2.0.x.
+
+## Installation ##
+  
+In your Gemfile add the following line :
+
+    gem 'facteur'
+    
+Then run the following command:
+
+    bundle install
+    
+## Usage ##
+
+First install the messaging system in your application :
+
+    rails generate facteur:install  
+    
+This commands creates the migrations which creates the tables we need so don't forget to migrate your database :
+
+    rake db:migrate
+
+Then to activate __facteur__ in your user model, just include the addressee's model as follows :
+
+    class User < ActiveRecord::Base  
+      include Facteur::AddresseeModel
+    end
+    
+or
+
+    class User
+      include Mongoid::Document
+      include Facteur::AddresseeModel
+    end
+    
+You model must be named 'User'. This will be changed in the future.
+
+## Messaging system ##
+
+### Creating mailboxes ###
+
+In the facteur's system, each user must have a mailbox where he can receive messages. The mailboxes can be declared statically and/or dynamically. Let's start first by the static way :
+
+    class User < ActiveRecord::Base  
+      include Facteur::AddresseeModel
+      
+      mailbox :private_mailbox, :default => true
+      mailbox :public_mailbox
+    end
+
+The previous example declare two mailboxes that will be created for each user. The mailboxes are created when they are first accessed. Facteur generates for you two methods to access your mailboxes :
+
+    # assuming that 'login' and 'password' are fields defined for the User model
+    @john = User.create(:login => 'john', :password => 'pass')
+    
+    # Now, the mailboxes exist and they can be accessed
+    @john.private_mailbox #=> generates and returns the private mailbox
+    @john.public_mailbox #=> generates and returns the public mailbox
+    
+    # To check the mailboxes which where defined
+    User.mailboxes #=> [{:name=>:private_mailbox, :default=>true}, {:name=>:public_mailbox}]
+    
+It is also possible to create a mailbox dynamically. This mailbox will not be available for all the users but only for the user who created it :
+
+    @john.create_mailbox(:new_mailbox) #=> true
+    User.mailboxes #=> [{:name=>:private_mailbox, :default=>true}, {:name=>:public_mailbox}]
+    @john.mailboxes #=> [{:name=>:private_mailbox, :default=>true}, {:name=>:public_mailbox}, {:name=>:new_mailbox}]
+    
+After the previous example, the "news\_mailbox" is only avalaible to John. The names of the mailboxes must be unique. if you try to create a mailbox which already exists, the create_mailbox() method will return false.
+
+### Sending messages ###
+
+It is possible to send a message to one or many user :
+
+    @peter = User.create(:login => 'peter', :password => 'pass')
+    @mary = User.create(:login => 'mary', :password => 'pass')
+    
+    @john.send_message('hello', :to => @peter, :in => :private_mailbox)
+    @john.send_message('hello', :to => [@peter, @mary], :in => :public_mailbox)
+    
+The 'in' option is not mandatory. If it is not given, the message is delivered to the default mailbox. If there is no default mailbox defined then the method fails.
+
+You can access the messages in a mailbox :
+
+    @peter.private_mailbox.messages
+    
+To list the messages sent by a user :
+
+    @john.sent_messages
+    
+### More methods ###
+
+This section list the other methods available for each elements of the messaging system :
+
+#### User ####
+
+    mailboxes      : mailboxes assigned to this user
+    sent_messages  : messages sent by the user
+
+#### Mailbox ####
+
+    addressee : who the mailbox is assigned to
+    messages  : messages who are stored in the mailbox
+    name      : the name of the mailbox
+
+#### Message ####
+
+    mailbox     : mailbox where the message is stored
+    author      : user who send the message
+    addressees  : who the message was sent to
+    body        : body of the message
+    subject     : subject of the message
+    created_at  : date of creation
+    
+## Testing the gem ##
+
+It is possible to test facteur by running the following command from the gem directory:
+
+    rake spec
+
+## Note on Patches/Pull Requests ##
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright (c) 2011 Rawane ZOSSOU. See LICENSE for details.