mailboxer 0.2.5 → 0.3.0

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.rdoc

@@ -27,6 +27,7 @@ And don't forget to migrate you database:
   
 = Requirements
 
+OUTDATED - It will be documented in the next days
 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
@@ -45,7 +46,7 @@ We are now adding support for sending emails when a Notification or a Message is
   end
 
 If these methods are not present, default ones will be created (the ones above).
-
+/OUTDATED
 
 = Usage
 

data/app/models/message.rb

@@ -29,7 +29,7 @@ class Message < Notification
       msg_receipt.mailbox_type = "inbox"
       temp_receipts << msg_receipt
       #Should send an email?
-      if Mailboxer.uses_emails and r.should_email? self
+      if Mailboxer.uses_emails and r.send(Mailboxer.should_email_method,self)
         MessageMailer.send_email(self,r).deliver
       end
     end

data/app/models/notification.rb

@@ -43,7 +43,7 @@ class Notification < ActiveRecord::Base
       msg_receipt.receiver = r
       temp_receipts << msg_receipt      
       #Should send an email?
-      if Mailboxer.uses_emails and r.should_email? self
+      if Mailboxer.uses_emails and r.send(Mailboxer.should_email_method,self)
         NotificationMailer.send_email(self,r).deliver
       end
     end

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

@@ -5,4 +5,9 @@ Mailboxer.setup do |config|
   
   #Configures the default from for the email sent for Messages and Notifications of Mailboxer
   config.default_from = "no-reply@mailboxer.com"
+  
+  #Configures the methods needed by mailboxer
+  #config.email_method = :email
+  #config.name_method = :name
+  #config.should_email_method = :should_email?
 end

data/lib/mailboxer.rb

@@ -2,12 +2,15 @@ module Mailboxer
   module Models
     autoload :Messageable, 'mailboxer/models/messageable'
   end  
-  module Exceptions
-    autoload :NotCompliantModel, 'mailboxer/exceptions'
-  end  
   
   mattr_accessor :default_from
   mattr_accessor :uses_emails
+  mattr_accessor :email_method
+  @@email_method = :email
+  mattr_accessor :name_method
+  @@name_method = :name
+  mattr_accessor :should_email_method
+  @@should_email_method = :should_email?
   
    class << self
     def setup

data/lib/mailboxer/models/messageable.rb

@@ -16,28 +16,29 @@ module Mailboxer
         end
       end
 
-      module InstanceMethods
-        #Returning any kind of indentification you want for the model
-        def name
-          super
-        rescue NameError
-          return "You should add method :name in your Messageable model"
-          end
+      module InstanceMethods        
+          eval <<-EOM
+           #Returning any kind of indentification you want for the model
+           def #{Mailboxer.name_method}
+             super
+           rescue NameError
+             return "You should add method :name in your Messageable model"
+           end
 
-        #Returning the email address of the model
-        def email
-          super
-        rescue NameError
-          return "define_email@on_your.model"
-          end
-
-        #Returning whether an email should be sent for this object (Message or Notification)
-        def should_email?(object)
-          super
-        rescue NameError
-          return true
-          end
+           #Returning the email address of the model
+           def #{Mailboxer.email_method}
+             super
+           rescue NameError
+             return "define_email@on_your.model"
+           end
 
+           #Returning whether an email should be sent for this object (Message or Notification)
+           def #{Mailboxer.should_email_method}(object)
+             super
+           rescue NameError
+            return true
+            end
+           EOM
         #Gets the mailbox of the messageable
         def mailbox
           @mailbox = Mailbox.new(self) if @mailbox.nil?
@@ -139,8 +140,7 @@ module Mailboxer
           return nil
           end
         end
-        
-        
+
         #Mark the object as trashed for messageable.
         #
         #Object can be:

data/mailboxer.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name = "mailboxer"
-	s.version = "0.2.5"
+	s.version = "0.3.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." +  

data/spec/dummy/config/initializers/mailboxer.rb

@@ -5,4 +5,9 @@ Mailboxer.setup do |config|
   
   #Configures the default from for the email sent for Messages and Notifications of Mailboxer
   config.default_from = "no-reply@mailboxer.com"
+  
+  #Configures the methods needed by mailboxer
+  #config.email_method = :email
+  #config.name_method = :name
+  #config.should_email_method = :should_email?
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mailboxer
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
-  - 5
-  version: 0.2.5
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Eduardo Casanova Cuesta
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-08 00:00:00 +02:00
+date: 2011-07-12 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -156,6 +156,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - .yardopts
 - Gemfile
 - LICENSE.txt
@@ -180,7 +181,6 @@ files:
 - lib/generators/mailboxer/templates/migration.rb
 - lib/mailboxer.rb
 - lib/mailboxer/engine.rb
-- lib/mailboxer/exceptions.rb
 - lib/mailboxer/models/messageable.rb
 - mailboxer.gemspec
 - spec/dummy/Gemfile

data/lib/mailboxer/exceptions.rb

@@ -1,12 +0,0 @@
-module Mailboxer
-  module Exceptions
-    #Mailboxer::Exceptions::NotCompliantModel is raised when your model with acts_as_messageable
-    #method is not compliant with the requirements for acting as messageable.
-    #
-    #These requirements are:
-    #* <b>"name" method</b>: Returning any kind of indentification you want for the model
-    #* <b>"email" method</b>: Returning the email address of the model. 
-    #* <b>"should_email?(object)" method</b>: Returning whether an email should be sent for this object (Message or Notification)
-    class NotCompliantModel < RuntimeError; end   
-  end
-end