has_emails 0.0.1 → 0.1.0

data/app/mailers/application_mailer.rb

@@ -1,85 +0,0 @@
-# Provides base operations for emailing
-class ApplicationMailer < ActionMailer::Base
-  @@default_subject_prefix = "[#{File.basename(File.expand_path(RAILS_ROOT)).camelize}] "
-  cattr_accessor :default_subject_prefix
-  
-  # Specify the prefix to use for the subject. This defaults to the
-  # +default_subject_prefix+ specified for ApplicationMailer.
-  adv_attr_accessor :subject_prefix
-  
-  class << self
-    def method_missing(method_symbol, *parameters) #:nodoc:
-      case method_symbol.id2name
-        when /^queue_([_a-z]\w*)/ then new($1, *parameters).queue
-        else super
-      end
-    end
-  end
-  
-  alias_method :to, :recipients
-  
-  # Sets or gets the subject of the email.  All subjects are prefixed with a
-  # value indicating the application it is coming from.
-  def subject(*parameters)
-    if parameters.empty?
-      super
-    else
-      super(subject_prefix + super)
-    end
-  end
-  alias_method :subject=, :subject
-  
-  # Delivers an email based on the content in the specified email
-  def email(email)
-    @from       = email.sender
-    @recipients = email.to
-    @cc         = email.cc
-    @bcc        = email.bcc
-    @subject    = email.subject
-    @body       = email.body
-    @sent_on    = email.sent_at || Time.now
-  end
-  
-  # Queues the current e-mail that has been constructed
-  def queue
-    Email.transaction do
-      # Create the main email
-      email = Email.create!(
-        :sender => from,
-        :subject => subject,
-        :body => body
-      )
-      
-      # Add recipients
-      email.to = [to].flatten
-      email.cc = [cc].flatten
-      email.bcc = [bcc].flatten
-      email.queue!
-    end
-  end
-  
-  private
-  def initialize_defaults(method_name) #:nodoc
-    @sent_on ||= Time.now
-    @subject_prefix ||= @@default_subject_prefix.dup
-    @recipients ||= []
-    @cc ||= []
-    @bcc ||= []
-    
-    super
-  end
-  
-  def quote_address_if_necessary_with_conversion(address, charset) #:nodoc
-    # Uses is_a? instead of === because of AssociationProxy
-    if !address.is_a?(Array)
-      if EmailAddress === address || EmailRecipient === address
-        address = address.with_name
-      elsif !(String === address)
-        address = EmailAddress.convert_from(address).to_s
-      end
-    end
-    
-    quote_address_if_necessary_without_conversion(address, charset)
-  end
-  alias_method_chain :quote_address_if_necessary, :conversion
-end

data/app/models/email_recipient.rb

@@ -1,78 +0,0 @@
-# Represents a recipient on an email
-class EmailRecipient < MessageRecipient
-  validates_presence_of       :receiver_spec
-  validates_as_email_address  :receiver_spec,
-                                :allow_nil => true
-  
-  before_save :ensure_exclusive_references
-  
-  # Alias for domain-specific language
-  alias_method    :email, :message
-  alias_method    :email=, :message=
-  alias_attribute :email_id, :message_id
-  
-  delegate  :to_s,
-              :to => :email_address
-  
-  # Returns the receiver of the message.  This can be a string if being sent
-  # to an arbitrary e-mail address.
-  def receiver_with_spec
-    receiver_without_spec || receiver_spec
-  end
-  alias_method_chain :receiver, :spec
-  
-  # If receiver is a string, then sets the spec, otherwise uses the original
-  # receiver setter
-  def receiver_with_spec=(value)
-    self.receiver_spec = EmailAddress.convert_from(value).spec
-    self.receiver_without_spec = value if !value.is_a?(String)
-  end
-  alias_method_chain :receiver=, :spec
-  
-  # Converts the receiver into an Email Address, whether it be a string,
-  # EmailAddress, or other model type
-  def email_address
-    EmailAddress.convert_from(receiver_spec)
-  end
-  
-  # The name of the person whose receiving the email
-  def name
-    receiver_without_spec ? EmailAddress.convert_from(receiver_without_spec).name : email_address.name
-  end
-  
-  # Returns a string version of the email address plus any name like
-  # "John Doe <john.doe@gmail.com>"..
-  def with_name
-    address = self.email_address
-    address.name = self.name
-    address.with_name
-  end
-  
-  private
-  def validate_on_create #:nodoc:
-    begin
-      email_address if receiver
-      true
-    rescue ArgumentError
-      errors.add 'receiver_id', 'must be a string, have a email_address attribute, or be a class that has_email_addresses'
-    end
-  end
-  
-  # Strings are allowed to participate in messaging
-  def model_participant?
-    receiver_id && receiver_type || receiver_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 model_participant?
-      self.receiver_spec = nil
-    else
-      self.receiver_id = nil
-      self.receiver_type = nil
-    end
-    
-    true
-  end
-end

data/app/models/email_recipient_build_extension.rb

@@ -1,7 +0,0 @@
-module EmailRecipientBuildExtension #:nodoc:
-  # Checks if the recipient and record are equal, using the recipient's
-  # email_address
-  def is_recipient_equal?(recipient, record) #:nodoc:
-    recipient.email_address.to_s == EmailAddress.convert_from(record).to_s
-  end
-end

data/db/bootstrap/events.yml

@@ -1,4 +0,0 @@
-verify:
-  id: 601
-  name: verify
-  owner_type: EmailAddress

data/db/bootstrap/states.yml

@@ -1,9 +0,0 @@
-unverified:
-  id: 601
-  name: unverified
-  owner_type: EmailAddress
-  
-verified:
-  id: 602
-  name: verified
-  owner_type: EmailAddress

data/db/migrate/002_add_email_specs.rb

@@ -1,18 +0,0 @@
-class AddEmailSpecs < ActiveRecord::Migration
-  def self.up
-    # Workaround change_column not allowing change to :null => true
-    remove_column :messages, :sender_id
-    remove_column :messages, :sender_type
-    
-    add_column :messages, :sender_id, :integer, :null => true, :default => nil, :references => nil
-    add_column :messages, :sender_type, :string, :null => true, :default => nil
-    add_column :messages, :sender_spec, :string, :limit => 320
-  end
-
-  def self.down
-    remove_column :messages, :sender_spec
-    
-    change_column :messages, :sender_id, :integer, :null => false, :references => nil
-    change_column :messages, :sender_type, :string, :null => false
-  end
-end

data/db/migrate/003_add_email_recipient_specs.rb

@@ -1,18 +0,0 @@
-class AddEmailRecipientSpecs < ActiveRecord::Migration
-  def self.up
-    # Workaround change_column not allowing change to :null => true
-    remove_column :message_recipients, :receiver_id
-    remove_column :message_recipients, :receiver_type
-    
-    add_column :message_recipients, :receiver_id, :integer, :null => true, :default => nil, :references => nil
-    add_column :message_recipients, :receiver_type, :string, :null => true, :default => nil
-    add_column :message_recipients, :receiver_spec, :string, :limit => 320
-  end
-
-  def self.down
-    remove_column :message_recipients, :receiver_spec
-    
-    change_column :message_recipients, :receiver_id, :integer, :null => false, :references => nil
-    change_column :message_recipients, :receiver_type, :string, :null => false
-  end
-end

data/test/app_root/app/models/department.rb

@@ -1,2 +0,0 @@
-class Department < ActiveRecord::Base
-end

data/test/app_root/app/models/user.rb

@@ -1,3 +0,0 @@
-class User < ActiveRecord::Base
-  has_email_addresses
-end

data/test/app_root/db/migrate/001_create_users.rb

@@ -1,11 +0,0 @@
-class CreateUsers < ActiveRecord::Migration
-  def self.up
-    create_table :users do |t|
-      t.column :login, :string, :null => false
-    end
-  end
-
-  def self.down
-    drop_table :users
-  end
-end

data/test/app_root/db/migrate/002_create_departments.rb

@@ -1,12 +0,0 @@
-class CreateDepartments < ActiveRecord::Migration
-  def self.up
-    create_table :departments do |t|
-      t.column :name, :string, :null => false
-      t.column :email_address, :string, :null => false
-    end
-  end
-
-  def self.down
-    drop_table :departments
-  end
-end

data/test/fixtures/departments.yml

@@ -1,9 +0,0 @@
-marketing:
-  id: 1
-  name: Marketing
-  email_address: marketing@companyxyz.com
-  
-testing:
-  id: 2
-  name: Testing
-  email_address: testing@companyxyz.com

data/test/fixtures/email_addresses.yml

@@ -1,32 +0,0 @@
-bob:
-  id: 1
-  emailable_id: 1
-  emailable_type: User
-  spec: bob@bob.com
-  verification_code: c2e4f499bf610fa95b8ee3a4e8013dbe
-  code_expiry: <%= Time.now.to_s(:db) %>
-  created_at: <%= Time.now.to_s(:db) %>
-  updated_at: <%= Time.now.to_s(:db) %>
-  state_id: 601
-  
-john:
-  id: 2
-  emailable_id: 2
-  emailable_type: User
-  spec: john@john.com
-  verification_code: 1d3955ee0d05ce5bb847f29d56b990cc
-  code_expiry: <%= Time.now.to_s(:db) %>
-  created_at: <%= Time.now.to_s(:db) %>
-  updated_at: <%= Time.now.to_s(:db) %>
-  state_id: 602
-  
-mary:
-  id: 3
-  emailable_id: 3
-  emailable_type: User
-  spec: mary@mary.com
-  verification_code: 8323145e816cb063d405f5e365d14807
-  code_expiry: <%= Time.now.to_s(:db) %>
-  created_at: <%= Time.now.to_s(:db) %>
-  updated_at: <%= Time.now.to_s(:db) %>
-  state_id: 602

data/test/fixtures/message_recipients.yml

@@ -1,85 +0,0 @@
-bob_to_john:
-  id: 1
-  message_id: 1
-  receiver_id: 2
-  receiver_type: EmailAddress
-  receiver_spec: john@john.com
-  kind: to
-  position: 1
-  state_id: 511
-  type: EmailRecipient
-  
-bob_to_mary:
-  id: 2
-  message_id: 1
-  receiver_id: 3
-  receiver_type: EmailAddress
-  receiver_spec: mary@mary.com
-  kind: cc
-  position: 1
-  state_id: 510
-  type: EmailRecipient
-  
-bob_to_random:
-  id: 3
-  message_id: 1
-  receiver_spec: random@random.com
-  kind: cc
-  position: 2
-  state_id: 510
-  type: EmailRecipient
-  
-bob_to_marketing:
-  id: 4
-  message_id: 1
-  receiver_id: 1
-  receiver_type: Department
-  receiver_spec: marketing@companyxyz.com
-  kind: cc
-  position: 3
-  state_id: 510
-  type: EmailRecipient
-  
-mary_to_john:
-  id: 5
-  message_id: 2
-  receiver_id: 2
-  receiver_type: EmailAddress
-  receiver_spec: john@john.com
-  kind: bcc
-  position: 1
-  state_id: 510
-  type: EmailRecipient
-  
-unsent_bob_to_john:
-  id: 6
-  message_id: 3
-  receiver_id: 2
-  receiver_type: EmailAddress
-  receiver_spec: john@john.com
-  kind: to
-  position: 1
-  state_id: 510
-  type: EmailRecipient
-  
-unsent_bob_to_mary:
-  id: 7
-  message_id: 3
-  receiver_id: 3
-  receiver_type: EmailAddress
-  receiver_spec: mary@mary.com
-  kind: cc
-  position: 1
-  state_id: 510
-  type: EmailRecipient
-  
-queued_bob_to_john:
-  id: 8
-  message_id: 4
-  receiver_id: 2
-  receiver_type: User
-  receiver_spec: john@john.com
-  kind: to
-  position: 1
-  state_id: 510
-  type: EmailRecipient

data/test/fixtures/messages.yml

@@ -1,52 +0,0 @@
-sent_from_bob:
-  id: 1
-  sender_id: 1
-  sender_type: EmailAddress
-  sender_spec: bob@bob.com
-  subject: "Funny joke"
-  body: "Why can't dinosaurs talk? ...Because they're dead!"
-  created_at: <%= Time.now.to_s(:db) %>
-  state_id: 502
-  type: Email
-  
-sent_from_mary:
-  id: 2
-  sender_id: 3
-  sender_type: EmailAddress
-  sender_spec: mary@mary.com
-  subject: "FW: Funny joke"
-  body: "> Why can't dinosaurs talk? ...Because they're dead!"
-  created_at: <%= Time.now.to_s(:db) %>
-  state_id: 502
-  type: Email
-  
-unsent_from_bob:
-  id: 3
-  sender_id: 1
-  sender_type: EmailAddress
-  sender_spec: bob@bob.com
-  subject: "Another funny joke"
-  body: "Where do cows go on a date? ...To the moovies!"
-  created_at: <%= Time.now.to_s(:db) %>
-  state_id: 500
-  type: Email
-  
-queued_from_bob:
-  id: 4
-  sender_id: 1
-  sender_type: EmailAddress
-  sender_spec: bob@bob.com
-  subject: ""
-  body: ""
-  created_at: <%= Time.now.to_s(:db) %>
-  state_id: 501
-  type: Email
-  
-unsent_from_stranger:
-  id: 5
-  sender_spec: stranger@somewhere.com
-  subject: "Do you know where I am?"
-  body: "Just wondering..."
-  created_at: <%= Time.now.to_s(:db) %>
-  state_id: 500
-  type: Email

data/test/fixtures/state_changes.yml

@@ -1,128 +0,0 @@
-# Emails
-sent_from_bob_unsent:
-  id: 1
-  stateful_id: 1
-  stateful_type: Email
-  to_state_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-sent_from_bob_sent:
-  id: 2
-  stateful_id: 1
-  stateful_type: Email
-  from_state_id: 500
-  to_state_id: 502
-  event_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-sent_from_mary_unsent:
-  id: 3
-  stateful_id: 2
-  stateful_type: Email
-  to_state_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-sent_from_mary_sent:
-  id: 4
-  stateful_id: 2
-  stateful_type: Email
-  from_state_id: 500
-  to_state_id: 502
-  event_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-unsent_from_bob_unsent:
-  id: 5
-  stateful_id: 3
-  stateful_type: Email
-  to_state_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-queued_from_bob_unsent:
-  id: 6
-  stateful_id: 4
-  stateful_type: Email
-  to_state_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-queued_from_bob_queued:
-  id: 7
-  stateful_id: 4
-  stateful_type: Email
-  from_state_id: 500
-  to_state_id: 501
-  event_id: 501
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-unsent_from_stranger_unsent:
-  id: 8
-  stateful_id: 5
-  stateful_type: Email
-  to_state_id: 500
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-# EmailRecipients
-bob_to_john_unread:
-  id: 9
-  stateful_id: 1
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-bob_to_john_read:
-  id: 10
-  stateful_id: 1
-  stateful_type: EmailRecipient
-  from_state_id: 510
-  to_state_id: 511
-  event_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-bob_to_mary_unread:
-  id: 11
-  stateful_id: 2
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-bob_to_random_unread:
-  id: 12
-  stateful_id: 3
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-bob_to_marketing_unread:
-  id: 13
-  stateful_id: 4
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-mary_to_john_unread:
-  id: 14
-  stateful_id: 5
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-unsent_bob_to_john_unread:
-  id: 15
-  stateful_id: 6
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-unsent_bob_to_mary_unread:
-  id: 16
-  stateful_id: 7
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>
-  
-queued_bob_to_john_unread:
-  id: 17
-  stateful_id: 8
-  stateful_type: EmailRecipient
-  to_state_id: 510
-  occurred_at: <%= Time.now.to_s(:db) %>

data/test/fixtures/users.yml

@@ -1,11 +0,0 @@
-bob:
-  id: 1
-  login: bob
-  
-john:
-  id: 2
-  login: john
-  
-mary:
-  id: 3
-  login: mary

data/test/unit/application_mailer_test.rb

@@ -1,69 +0,0 @@
-require File.dirname(__FILE__) + '/../test_helper'
-
-class ApplicationMailerTest < Test::Unit::TestCase
-  fixtures :users, :email_addresses, :messages, :message_recipients, :state_changes
-  
-  class TestMailer < ApplicationMailer
-    def signed_up(recipient)
-      recipients recipient
-      subject    'Thanks for signing up'
-      from       'welcome@mywebapp.com'
-      cc         'nobody@mywebapp.com'
-      bcc        'root@mywebapp.com'
-      body       'Congratulations!'
-    end
-  end
-  
-  def setup
-    ActionMailer::Base.delivery_method = :test
-    ActionMailer::Base.perform_deliveries = true
-    ActionMailer::Base.raise_delivery_errors = true
-    ActionMailer::Base.deliveries = []
-    
-    @original_logger = TestMailer.logger
-    @recipient = email_addresses(:bob)
-  end
-  
-  def test_should_use_camelized_application_name_for_default_subject_prefix
-    assert_equal '[AppRoot] ', ApplicationMailer.default_subject_prefix
-  end
-  
-  def test_should_queue_email
-    assert_nothing_raised { TestMailer.queue_signed_up(@recipient) }
-    assert_equal 6, Email.count
-    
-    email = Email.find(6)
-    assert_equal '[AppRoot] Thanks for signing up', email.subject
-    assert_equal 'Congratulations!', email.body
-    assert_equal [@recipient], email.to.map(&:receiver)
-    assert_equal 'welcome@mywebapp.com', email.sender
-    assert_equal ['nobody@mywebapp.com'], email.cc.map(&:receiver)
-    assert_equal ['root@mywebapp.com'], email.bcc.map(&:receiver)
-  end
-  
-  def test_should_deliver_email
-    freeze_time do 
-      expected = new_mail
-      expected.to      = 'john@john.com'
-      expected.cc      = 'mary@mary.com'
-      expected.subject = 'Another funny joke'
-      expected.body    = 'Where do cows go on a date? ...To the moovies!'
-      expected.from    = 'bob@bob.com'
-      expected.date    = Time.now
-      
-      assert_nothing_raised { ApplicationMailer.deliver_email(messages(:unsent_from_bob)) }
-      assert_not_nil ActionMailer::Base.deliveries.first
-      assert_equal expected.encoded, ActionMailer::Base.deliveries.first.encoded
-    end
-  end
-  
-  private
-  def new_mail( charset="utf-8" )
-    mail = TMail::Mail.new
-    mail.mime_version = "1.0"
-    if charset
-      mail.set_content_type "text", "plain", { "charset" => charset }
-    end
-    mail
-  end
-end