app/models/email_recipient/easy_build_recipient_extension.rb app/models/sender_email.rb db/migrate/002_add_email_recipients.rb lib/has_emails.rb test/app_root/app/models/department.rb test/app_root/app/models/user.rb test/app_root/config/environment.rb test/app_root/db/migrate/001_create_users.rb test/app_root/db/migrate/002_create_departments.rb test/app_root/test/fixtures/departments.yml test/app_root/test/fixtures/email_addresses.yml test/app_root/test/fixtures/message_recipients.yml test/app_root/test/fixtures/messages.yml test/app_root/test/fixtures/users.yml test/test_helper.rb test/unit/build_extension_test.rb test/unit/email_address_test.rb test/unit/email_recipient_test.rb test/unit/has_emails_test.rb test/unit/sender_email_test.rb @@ -1,12 +1,12 @@ -= acts_as_emailable += has_emails -acts_as_emailable . +has_emails . == Resources Wiki -* http://wiki.pluginaweek.org/Acts_as_emailable +* http://wiki.pluginaweek.org/Has_emails Announcement @@ -14,11 +14,11 @@ Announcement Source -* http://svn.pluginaweek.org/trunk/plugins/active_record/acts/acts_as_emailable +* http://svn.pluginaweek.org/trunk/plugins/active_record/has/has_emails Development -* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/acts/acts_as_emailable +* http://dev.pluginaweek.org/browser/trunk/plugins/active_record/has/has_emails == Description README @@ -3,7 +3,7 @@ require 'rake/rdoctask' require 'rake/gempackagetask' require 'rake/contrib/sshpublisher' -PKG_NAME = 'acts_as_emailable' +PKG_NAME = 'has_emails' PKG_VERSION = '0.0.1' PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}" RUBY_FORGE_PROJECT = 'pluginaweek' @@ -11,17 +11,17 @@ RUBY_FORGE_PROJECT = 'pluginaweek' desc 'Default: run unit tests.' task :default => :test -desc 'Test the acts_as_emailable plugin.' +desc 'Test the has_emails plugin.' Rake::TestTask.new(:test) do |t| t.libs << 'lib' t.pattern = 'test/**/*_test.rb' t.verbose = true end -desc 'Generate documentation for the acts_as_emailable plugin.' +desc 'Generate documentation for the has_emails plugin.' Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' - rdoc.title = 'ActsAsEmailable' + rdoc.title = 'HasEmails' rdoc.options << '--line-numbers' << '--inline-source' rdoc.rdoc_files.include('README') rdoc.rdoc_files.include('lib/**/*.rb') @@ -35,7 +35,7 @@ spec = Gem::Specification.new do |s| s.files = FileList['{app,db,lib,tasks,test}/**/*'].to_a + %w(init.rb MIT-LICENSE Rakefile README) s.require_path = 'lib' - s.autorequire = 'acts_as_emailable' + s.autorequire = 'has_emails' s.has_rdoc = true s.test_files = Dir['test/**/*_test.rb'] Rakefile @@ -44,7 +44,7 @@ class ApplicationMailer < ActionMailer::Base def queue Email.transaction do # Create the main email - email = Email.create( + email = Email.create!( :from => from, :subject => subject, :body => body @@ -54,10 +54,6 @@ class ApplicationMailer < ActionMailer::Base email.to = to email.cc = cc email.bcc = bcc - puts email.valid? - puts email.errors.inspect - puts email.to.inspect - puts email.to.first.inspect email.queue! end end app/mailers/application_mailer.rb @@ -1,4 +1,4 @@ -# Represents a verified or unverified email address being used by a user +# Represents a valid RFC822 email address class EmailAddress < ActiveRecord::Base include TokenGenerator @@ -25,67 +25,51 @@ class EmailAddress < ActiveRecord::Base end # Determines if the email spec is a valid address using the RFC822 spec - def is_valid?(spec) + def valid?(spec) !RFC822::EmailAddress.match(spec).nil? end - - # Finds an email-address with the given spec - def find_by_spec(number, spec, *args) - if match = RFC822::EmailAddress.match(spec) - local_name = match.captures[0] - domain = match.captures[1] - - with_scope(:find => {:conditions => ['local_name = ? AND domain = ?', local_name, domain]}) do - find(number, *args) - end - end - end end - attr_protected :local_name, - :domain - - # Ensure the e-mail address has been verified - acts_as_state_machine :initial => :unverified + # Support e-mail address verification + has_states :initial => :unverified # Add messaging capabilities. This will give us an email_box. - acts_as_messageable :email, - :class_name => 'Email' - - belongs_to :emailable, - :polymorphic => true + has_messages :emails, + :message_class => 'Email' + belongs_to :emailable, + :polymorphic => true - validates_presence_of :spec - validates_confirmation_of :spec - validates_uniqueness_of :local_name, - :scope => :domain - validates_as_email :spec + validates_presence_of :spec + validates_uniqueness_of :spec + validates_as_email_address :spec # Ensure that the e-mail address has a verification code that can be sent # to the user - before_create :create_verification_code + before_create :create_verification_code - state :unverified - state :verified + state :unverified, :verified # Verifies that the email address is valid event :verify do - transition_to :verified, :from => :verified + transition_to :verified, :from => :unverified end # Sets the full address - def spec=(value) - @spec = value - - if match = RFC822::EmailAddress.match(value) - self.local_name = match.captures[0] - self.domain = match.captures[1] - end + def spec=(new_spec) + @local_name = @domain = nil + write_attribute(:spec, new_spec) end - # Returns the full email address - def spec - @spec || (@spec = local_name + "@" + domain if local_name? && domain?) + # The part of the e-mail address before the @ + def local_name + parse_spec if !@local_name + @local_name + end + + # The part of the e-mail address after the @ + def domain + parse_spec if !@domain + @domain end # Gets the name of the person whose email address this is. Default is an @@ -105,13 +89,20 @@ class EmailAddress < ActiveRecord::Base spec end - protected + private # Creates the verification code that must be used when validating the email address def create_verification_code - self.verification_code = generate_token(40) do |token| + self.verification_code = generate_token(32) do |token| self.class.find_by_verification_code(token).nil? end self.code_expiry = 48.hour.from_now end + + def parse_spec + if !@local_name && !@domain && match = RFC822::EmailAddress.match(spec) + @local_name = match.captures[0] + @domain = match.captures[1] + end + end end \ No newline at end of file app/models/email_address.rb @@ -1,17 +1,16 @@ class EmailRecipient < MessageRecipient + validates_as_email_address :messageable_spec, + :allow_nil => true + validates_presence_of :messageable_id, + :if => :messageable_id_required? + + before_save :ensure_exclusive_references + # Included for support of recipients from emails sent by a string-based # sender - belongs_to :message, - :class_name => 'Email', - :foreign_key => 'message_id' - alias_method :email, :message - alias_method :email=, :message= - alias_attribute :email_id, :message_id - - validates_as_email :messageable_spec, - :allow_nil => true - validates_xor_presence_of :messageable_id, - :messageable_spec + alias_method :email, :message + alias_method :email=, :message= + alias_attribute :email_id, :message_id # Returns the model that is messageable. def messageable_with_spec @@ -56,6 +55,11 @@ class EmailRecipient < MessageRecipient email_address.to_s end + # Actually delivers the email + def deliver + ApplicationMailer.deliver_email(self) + end + private def validate_on_create #:nodoc: begin @@ -65,4 +69,24 @@ class EmailRecipient < MessageRecipient errors.add 'messageable_id', 'must be a string, have a email_address attribute, or be a class that acts_as_emailable' end end + + # Strings are allowed to participate in messaging + def only_model_participants? + false + end + + # Does the messageable_id column need to be specified? + def messageable_id_required? + messageable_spec.nil? + end + + # Ensures that the country id/user region combo is not set at the same time as + # the region id + def ensure_exclusive_references + if messageable_id_required? + self.messageable_spec = nil + end + + true + end end \ No newline at end of file app/models/email_recipient.rb @@ -1,11 +1,4 @@ -<% -type = <<-EOV -owner_type: 'EmailAddress' -EOV -%> - verify: id: 601 name: verify - long_description: The email address has been verified - <%= type %> \ No newline at end of file + owner_type: EmailAddress \ No newline at end of file db/bootstrap/events.yml @@ -1,17 +1,9 @@ -<% -type = <<-EOV -owner_type: 'EmailAddress' -EOV -%> - unverified: id: 601 name: unverified - long_description: The email address is unverified - <%= type %> + owner_type: EmailAddress verified: id: 602 name: verified - long_description: The email adress has been verified - <%= type %> \ No newline at end of file + owner_type: EmailAddress \ No newline at end of file db/bootstrap/states.yml @@ -1,52 +1,23 @@ class CreateEmailAddresses < ActiveRecord::Migration - class EmailAddress < ActiveRecord::Base; end - class StateChange < ActiveRecord::Base; end - class StateDeadline < ActiveRecord::Base; end - - class State < ActiveRecord::Base - set_table_name 'states' - - has_many :email_addresses, :class_name => EmailAddress.to_s, :dependent => :destroy - has_many :from_changes, :class_name => StateChange.to_s, :foreign_key => 'from_state_id', :dependent => :destroy - has_many :to_changes, :class_name => StateChange.to_s, :foreign_key => 'to_state_id', :dependent => :destroy - end - - class Event < ActiveRecord::Base - set_table_name 'events' - - has_many :state_changes, :class_name => StateChange.to_s, :foreign_key => 'event_id', :dependent => :destroy - has_many :state_deadlines, :class_name => StateDeadline.to_s, :foreign_key => 'event_id', :dependent => :destroy - end - def self.up create_table :email_addresses do |t| - t.column :emailable_id, :integer, :null => false, :unsigned => true, :references => nil - t.column :emailable_type, :string, :null => false - t.column :local_name, :string, :null => false, :limit => 382 - t.column :domain, :string, :null => false, :limit => 382 - t.column :verification_code, :string, :limit => 40 - t.column :code_expiry, :datetime - t.column :type, :string, :mull => false - t.column :created_at, :timestamp, :null => false - t.column :updated_at, :datetime, :null => false - t.column :deleted_at, :datetime + t.column :emailable_id, :integer, :null => false, :references => nil + t.column :emailable_type, :string, :null => false + t.column :spec, :string, :null => false, :limit => 382 + t.column :verification_code, :string, :limit => 40 + t.column :code_expiry, :datetime + t.column :created_at, :timestamp, :null => false + t.column :updated_at, :datetime, :null => false end - add_index :email_addresses, [:local_name, :domain], :unique => true + add_index :email_addresses, :spec, :unique => true add_index :email_addresses, :verification_code, :unique => true - PluginAWeek::Acts::StateMachine.migrate_up(:email_addresses) + PluginAWeek::Has::States.migrate_up(:email_addresses) end def self.down - PluginAWeek::Acts::StateMachine.migrate_down(:email_addresses) + PluginAWeek::Has::States.migrate_down(:email_addresses) drop_table :email_addresses end - - def self.bootstrap - { - 'email_address/states' => {:class => State, :conditions => ['owner_type = ?', 'EmailAddress']}, - 'email_address/events' => {:class => Event, :conditions => ['owner_type = ?', 'EmailAddress']} - } - end end db/migrate/001_create_email_addresses.rb @@ -1 +1 @@ -require 'acts_as_emailable' \ No newline at end of file +require 'has_emails' \ No newline at end of file init.rb app/models/email.rb app/models/email/easy_build_recipient_extension.rb db/migrate/002_add_emails.rb db/migrate/003_add_email_recipients.rb lib/acts_as_emailable.rb test/acts_as_emailable_test.rb 3fd3cfb232802e7b78c90bc84307bc19ce134507 Aaron Pfeifer aaron.pfeifer@gmail.com http://github.com/pluginaweek/has_emails/commit/5eaaa300ef342e68138161476e399e67c4abd22e 5eaaa300ef342e68138161476e399e67c4abd22e 2007-07-30T11:42:09-07:00 2007-07-30T11:42:09-07:00 Initial release 77cc9a640fa93a2308d3471b4d88a3d25501d95f Aaron Pfeifer aaron.pfeifer@gmail.com