facteur 0.1.0 → 0.2.0

data/.gitignore

@@ -19,4 +19,5 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-spec/db/.*
+spec/db/.*
+*.gemspec

data/README.markdown

@@ -0,0 +1,113 @@
+# 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 create 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}]
+    
+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
+    
+## 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.

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "facteur"
-    gem.summary = "Messages managment system for Rails 3"
-    gem.description = "Facteur allows you add a messages management system in your Rails 3. You can create many mailboxes for your users. They will be able to send and receive messages."
+    gem.summary = "Messaging system for Rails 3"
+    gem.description = "Facteur allows you add a messaging system in your Rails 3. You can create many mailboxes for your users. They will be able to send and receive messages."
     gem.email = "dev@raw1z.fr"
     gem.homepage = "http://github.com/raw1z/facteur"
     gem.authors = ["Rawane ZOSSOU"]

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/generators/facteur/install/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Facteur
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      desc "Generate the facteur's message and mailbox models"
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def self.next_migration_number
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def create_facteur_files
+        template 'message.rb', 'app/models/message.rb'
+        template 'create_messages.rb', "db/migrate/#{self.class.next_migration_number}_create_messages.rb"
+        
+        sleep(1)
+        template 'mailbox.rb', 'app/models/mailbox.rb'
+        template 'create_mailboxes.rb', "db/migrate/#{self.class.next_migration_number}_create_mailboxes.rb"
+      end
+    end
+  end
+end

data/lib/generators/facteur/install/templates/create_mailboxes.rb

@@ -0,0 +1,15 @@
+class CreateMailboxes < ActiveRecord::Migration
+  def self.up
+    create_table :mailboxes do |t|
+      t.string :name
+      t.text :contents
+      t.integer :addressee_id
+      t.string :addressee_type
+      t.boolean :default
+    end
+  end
+
+  def self.down
+    drop_table :mailboxes
+  end
+end

data/lib/generators/facteur/install/templates/create_messages.rb

@@ -0,0 +1,19 @@
+class CreateMessages < ActiveRecord::Migration
+  def self.up
+    create_table :messages do |t|
+      t.string    :subject
+      t.text      :body
+      t.integer   :mailbox_id
+      t.integer   :author_id
+      t.boolean   :deleted_by_author, :default => false
+      t.datetime  :deleted_by_author_at
+      t.boolean   :deleted_by_addressee, :default => false
+      t.datetime  :deleted_by_addressee_at
+      t.boolean   :read, :default => false
+    end
+  end
+
+  def self.down
+    drop_table :messages
+  end
+end

data/lib/generators/facteur/install/templates/mailbox.rb

@@ -0,0 +1,3 @@
+class Mailbox < ActiveRecord::Base
+  include Facteur::MailboxModel
+end

data/lib/generators/facteur/install/templates/message.rb

@@ -0,0 +1,3 @@
+class Message < ActiveRecord::Base
+  include Facteur::MessageModel 
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: facteur
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Rawane ZOSSOU
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-10 00:00:00 +02:00
+date: 2010-06-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +34,7 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
-description: Facteur allows you add a messages management system in your Rails 3. You can create many mailboxes for your users. They will be able to send and receive messages.
+description: Facteur allows you add a messaging system in your Rails 3. You can create many mailboxes for your users. They will be able to send and receive messages.
 email: dev@raw1z.fr
 executables: []
 
@@ -42,18 +42,23 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - lib/facteur.rb
 - lib/facteur/addressee_model.rb
 - lib/facteur/mailbox_model.rb
 - lib/facteur/message_model.rb
+- lib/generators/facteur/install/install_generator.rb
+- lib/generators/facteur/install/templates/create_mailboxes.rb
+- lib/generators/facteur/install/templates/create_messages.rb
+- lib/generators/facteur/install/templates/mailbox.rb
+- lib/generators/facteur/install/templates/message.rb
 - spec/db/database.log
 - spec/db/facteur.sqlite3.db
 - spec/facteur_spec.rb
@@ -91,7 +96,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Messages managment system for Rails 3
+summary: Messaging system for Rails 3
 test_files: 
 - spec/facteur_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= facteur
-
-Description goes here.
-
-== 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.