facteur 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +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.

data/README.rdoc

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

data/Rakefile

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'rake'
+
+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.email = "dev@raw1z.fr"
+    gem.homepage = "http://github.com/raw1z/facteur"
+    gem.authors = ["Rawane ZOSSOU"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+Rspec::Core::RakeTask.new(:spec) do |spec|
+end
+
+Rspec::Core::RakeTask.new(:rcov) do |spec|
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "facteur #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/facteur/addressee_model.rb

@@ -0,0 +1,122 @@
+module Facteur
+  module AddresseeModel
+    def self.included(receiver)
+      receiver.class_exec do
+        include InstanceMethods
+        
+        has_many :mailboxes, :as => :addressee
+        has_many :messages_sent, :class_name => "Message", :foreign_key => "author_id"
+        
+        # the addressee's mailboxes are created after its creation
+        after_create :create_mailboxes
+      end
+      
+      receiver.extend ClassMethods
+    end
+    
+    module ClassMethods
+      
+      # Define a mailbox. The following options are available:
+      # <tt>:default</tt>:: defines the default mailbox. You must choose one default mailbox
+      def mailbox(name, options={})
+        mailbox = {:name => name}
+        mailbox.merge! options
+        mailboxes << mailbox
+      end
+      
+      # Returns the mailboxes defined for the class
+      def mailboxes
+        @mailboxes ||= []
+      end
+    end
+    
+    module InstanceMethods
+      
+      # Sends a message to one or many addressees. The following options are available:
+      #
+      # <tt>:to</tt>:: the addressee or the list of addressees (mandatory)
+      # <tt>:in</tt>:: the name of the mailbox in which the message is posted (mandatory)
+      # <tt>:body</tt>:: the message's body (mandatory)
+      #
+      # Usage :
+      #
+      #     # send a message to one addressee
+      #     @john.send_message('message contents', :to => @peter, :in => :private_mailbox)
+      #
+      #     # send a message to many addressees
+      #     @john.send_message('message contents', :to => [@peter, @james], :in => :private_mailbox)
+      def send_message(message, options)
+        options[:body] = message
+        if options[:to].is_a? Array
+          options[:to].each do |addressee|
+            send_message_to(addressee, options[:in], options[:body])
+          end
+        else
+          send_message_to(options[:to], options[:in], options[:body])
+        end
+      end
+      
+      # Creates a new mailbox. if a mailbox with the same name already exists, it fails and returns false. If succeeded, it creates an accessor for the new mail box and returns true.
+      # Example :
+      #
+      #     class User < ActiveRecord::base
+      #        include Facteur::AddresseeModel
+      #        
+      #        mailbox :private_mailbox
+      #     end
+      #
+      # The previous declaration will add : User#private_mailbox
+      #     
+      #     # supposing that a name field exists
+      #     user = User.new(:name => 'John')
+      #     user.create_mailbox :public_mailbox #=> return true
+      #     user.create_mailbox :private_mailbox #=> return false
+      def create_mailbox(name, options={})
+        mailbox = Mailbox.new(:name => name.to_s)
+        mailbox.addressee = self
+        return false if mailbox.save == false
+        
+        @default_mailbox = name if options[:default]
+        self.class.class_eval do
+          define_method(name) do
+            self.mailboxes.where(:name => name.to_s).first
+          end
+        end
+        true
+      end
+      
+      # Creates a new mailbox. if a mailbox with the same name already exists, it raises an exception. If succeeded, it creates an accessor for the new mail box and returns the created mailbox.
+      def create_mailbox!(name, options={})
+        if create_mailbox(name, options) == false
+          raise "Mailboxes names must be unique. Can't create '#{name}'"
+        end
+        self.send "#{name}"
+      end
+      
+      private
+      
+      # creates the mailboxes defined in the configuration
+      def create_mailboxes
+        self.class.mailboxes.each do |mailbox|
+          options = {}.merge(mailbox)
+          name = options.delete(:name)
+          create_mailbox!(name, options)
+        end
+      end
+      
+      # send a message to an addressee
+      def send_message_to(addressee, mailbox_name, contents)
+        return false if addressee.nil? or contents.nil?
+        
+        mailbox_name = @default_mailbox if mailbox_name.nil?
+        return false if mailbox_name.nil?
+        
+        message = Message.new
+        message.author = self
+        message.mailbox = addressee.send(mailbox_name)
+        message.body = contents
+        message.save
+      end
+    end
+  end
+end

data/lib/facteur/mailbox_model.rb

@@ -0,0 +1,12 @@
+module Facteur
+  module MailboxModel
+    def self.included(receiver)
+      receiver.class_exec do
+        belongs_to :addressee, :polymorphic => true
+        has_many :messages
+        validates_presence_of :name
+        validates_uniqueness_of :name, :scope => [:addressee_id, :addressee_type]
+      end
+    end
+  end
+end

data/lib/facteur/message_model.rb

@@ -0,0 +1,16 @@
+module Facteur
+  module MessageModel
+    def self.included(receiver)
+      receiver.class_exec do
+        validates_presence_of :author_id, :mailbox_id, :body
+
+        belongs_to :mailbox
+        belongs_to :author, :class_name => "User", :foreign_key => "author_id"
+
+        delegate :addressee, :to => :mailbox
+        delegate :addressee_type, :to => :mailbox
+      end
+    end
+  end
+end
+

data/lib/facteur.rb

@@ -0,0 +1,3 @@
+require File.join(File.dirname(__FILE__), 'facteur/message_model')
+require File.join(File.dirname(__FILE__), 'facteur/mailbox_model')
+require File.join(File.dirname(__FILE__), 'facteur/addressee_model')

data/spec/facteur_spec.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Facteur::AddresseeModel do
+  context "when creating mailboxes" do
+    before(:each) do
+      create_users
+      Message.delete_all
+    end
+    
+    it "creates a new mailbox" do
+      @john.create_mailbox(:news_mailbox).should == true
+      
+      lambda { @peter.create_mailbox! :news_mailbox }.should_not raise_error
+      
+      mailbox = @victoria.create_mailbox! :news_mailbox
+      mailbox.addressee.should == @victoria
+    end
+    
+    it "could not create a mailbox with the name of an existing mailbox" do
+      @john.create_mailbox(:private_mailbox).should == false
+      lambda { mailbox = @peter.create_mailbox! :private_mailbox }.should raise_error
+    end
+  end
+  
+  context "when initialized" do
+    before(:each) do
+      create_users
+      Message.delete_all
+    end
+    
+    it "creates the addressee's mailboxes" do
+      @john.mailboxes.where(:name => 'private_mailbox').first.should_not be_nil
+      @john.mailboxes.where(:name => 'public_mailbox').first.should_not be_nil
+    end
+    
+    it "defines the mailboxes accessors" do
+      @john.should respond_to :private_mailbox
+      @john.should respond_to :public_mailbox
+      @john.private_mailbox.should_not be_nil
+      @john.public_mailbox.should_not be_nil
+    end
+  end
+  
+  context "when sending message" do
+    before(:each) do
+      create_users
+      Message.delete_all
+    end
+    
+    it "sends a message to another addressee" do
+      @john.send_message('message contents', :to => @peter, :in => :private_mailbox).should == true
+      message = @peter.private_mailbox.messages.last
+      message.author.should == @john
+      message.body.should == 'message contents'
+    end
+    
+    it "sends the messages in the default mailbox" do
+      @john.send_message('message contents', :to => @peter).should == true
+      message = @peter.private_mailbox.messages.last
+      message.author.should == @john
+      message.body.should == 'message contents'
+    end
+    
+    it "could not send a message if the addressee is not given" do
+      @john.send_message('message contents', :in => :private_mailbox).should == false
+    end
+    
+    it "raises an error if the mailbox name given is unknown" do
+      lambda{ @john.send_message('message contents', :to => @peter, :in => :unknown_mailbox) }.should raise_error
+    end
+    
+    it "sends a message to many addressees" do
+      @john.send_message('message contents', :to => [@peter, @james, @jane], :in => :private_mailbox)
+      
+      message = @peter.private_mailbox.messages.last
+      message.author.should == @john
+      message.body.should == 'message contents'
+      
+      message = @james.private_mailbox.messages.last
+      message.author.should == @john
+      message.body.should == 'message contents'
+      
+      message = @jane.private_mailbox.messages.last
+      message.author.should == @john
+      message.body.should == 'message contents'
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,67 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'parchemin'
+require 'rspec/core'
+require 'rspec/autorun'
+require 'active_record'
+require 'logger'
+require 'facteur'
+
+SPEC_ROOT = File.dirname(__FILE__)
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "#{SPEC_ROOT}/db/facteur.sqlite3.db"
+)
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :users, :force => true do |t|
+    t.string :name, :null => false
+  end
+
+  create_table :mailboxes, :force => true do |t|
+    t.string :name
+    t.text :contents
+    t.integer :addressee_id
+    t.string :addressee_type
+    t.boolean :default
+  end
+  
+  create_table :messages, :force => true 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
+
+ActiveRecord::Base.logger = Logger.new(File.open("#{SPEC_ROOT}/db/database.log", 'a'))
+
+class User < ActiveRecord::Base
+  include Facteur::AddresseeModel
+  
+  mailbox :private_mailbox, :default => true
+  mailbox :public_mailbox
+end
+
+class Mailbox < ActiveRecord::Base
+  include Facteur::MailboxModel
+end
+
+class Message < ActiveRecord::Base
+  include Facteur::MessageModel 
+end
+
+def create_users
+  %w(John Peter James Mary Jane Victoria).each do |name|
+    eval "@#{name.downcase} = User.create(:name => '#{name}')"
+  end
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: facteur
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rawane ZOSSOU
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-10 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        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.
+email: dev@raw1z.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/facteur.rb
+- lib/facteur/addressee_model.rb
+- lib/facteur/mailbox_model.rb
+- lib/facteur/message_model.rb
+- spec/db/database.log
+- spec/db/facteur.sqlite3.db
+- spec/facteur_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/raw1z/facteur
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Messages managment system for Rails 3
+test_files: 
+- spec/facteur_spec.rb
+- spec/spec_helper.rb