mail_manager 0.0.1

data/app/models/mail_manager/mailing_list.rb

@@ -0,0 +1,36 @@
+=begin rdoc
+Author::    Chris Hauboldt (mailto:biz@lnstar.com)
+Copyright:: 2009 Lone Star Internet Inc.
+
+MailingList simply defines the available lists for subscriptions in the system. See Subscription for more information.
+
+=end
+module MailManager
+  class MailingList < ActiveRecord::Base
+
+    self.table_name =  "#{MailManager.table_prefix}mailing_lists"
+    
+    # associations get stupid when ActiveRecord is scoped for some horrible reason
+    has_many :subscriptions, :class_name => 'MailManager::Subscription'
+    has_and_belongs_to_many :mailings, :class_name => 'MailManager::Mailing',
+      :join_table => "#{MailManager.table_prefix}mailing_lists_#{MailManager.table_prefix}mailings"
+  
+    scope :active, {:conditions => {:status => 'active',:deleted_at => nil}}
+
+    validates :name, presence: true
+  
+    include StatusHistory
+    before_create :set_default_status
+
+    attr_protected :id
+    
+    def active?
+      deleted_at.nil?
+    end
+    
+    def inactive?
+      !active?
+    end
+  
+  end
+end

data/app/models/mail_manager/message.rb

@@ -0,0 +1,127 @@
+=begin rdoc
+Author::    Chris Hauboldt (mailto:biz@lnstar.com)
+Copyright:: 2009 Lone Star Internet Inc.
+
+Message is used in sending a message from an Mailing and keeping state of the message. Generates a "GUID" which is sent in the email and used to identify it in bounces.
+
+Statuses:
+pending - MailingJob has created the message but it has not yet been sent
+processing - MailingJob is in process of sending the message
+sent - MailingJob has successfully sent the message to the Email Server
+failed - either the message couldn't be handed to the Email Server or it has been bounced as a permanent failure
+
+=end
+
+module MailManager
+  class Message < ActiveRecord::Base
+    self.table_name =  "#{MailManager.table_prefix}messages"
+    belongs_to :mailing, :class_name => 'MailManager::Mailing'
+    belongs_to :subscription, :class_name => 'MailManager::Subscription'
+    has_many :bounces, :class_name => 'MailManager::Bounce'
+    belongs_to :contact, :class_name => 'MailManager::Contact'
+    #FIXME: if we add more types ... change the base message to be MailingMessage or something and don't use
+    #me as a message type
+    default_scope :conditions => {:type => "MailManager::#{(self.class.name.eql?('Class') ? self.name : self.class.name).gsub(/^MailManager::/,'')}" } 
+  
+    scope :pending, {:conditions => {:status => 'pending'}}
+    scope :ready, :conditions => ["status=?", 'ready']
+    scope :sent, :conditions => ["status=?", 'sent']
+    scope :processing, :conditions => ["status=?", 'processing']
+
+    attr_protected :id
+
+    def initialize(*args)
+      super
+      set_type
+    end
+
+    scope :search, lambda{|params| 
+      conditions = ["1"]
+      if params[:mailing_id]
+        conditions[0] += " AND #{MailManager.table_prefix}messages.mailing_id=?"
+        conditions << params[:mailing_id]
+      end
+      if params[:status]
+        conditions[0] += " AND #{MailManager.table_prefix}messages.status=?"
+        conditions << params[:status]
+      end
+      {
+        :conditions => conditions, 
+        :order => "#{MailManager.table_prefix}contacts.last_name, #{MailManager.table_prefix}contacts.first_name, #{MailManager.table_prefix}contacts.email_address",
+        :joins => " INNER JOIN #{MailManager.table_prefix}contacts on #{MailManager.table_prefix}messages.contact_id=#{MailManager.table_prefix}contacts.id"
+      }}
+  
+    include StatusHistory
+    override_statuses(['pending','processing','sent','failed','ready'], 'pending')
+    before_create :set_default_status
+    after_create :generate_guid
+
+    def email_address_with_name
+      return %Q|"#{full_name}" <#{email_address}>|.gsub(/\s+/,' ') unless full_name.eql?('')
+      email_address
+    end
+
+    # sends the message through Mailer
+    def deliver
+      MailManager::Mailer.deliver_message(self)
+      change_status(:sent)
+    end
+  
+    def full_name
+      contact.full_name
+    end
+
+    def email_address
+      contact.email_address
+    end
+
+    def subject
+      mailing.subject
+    end
+
+    def from_email_address
+      return self[:from_email_address] if self[:from_email_address].present?
+      self.update_attribute(:from_email_address,mailing.from_email_address)
+      self[:from_email_address]
+    end
+
+    # returns the separate mime parts of the message's Mailable
+    def parts
+      @parts ||= mailing.parts(substitutions)
+    end
+    
+    def contactable
+      contact.try(:contactable)
+    end
+
+    def substitutions
+      substitutions_hash = {}
+      MailManager::ContactableRegistry.registered_methods.each do |method|
+        method_key = method.to_s.upcase
+        if contact.respond_to?(method)
+          substitutions_hash[method_key] = contact.send(method)
+        elsif contactable.respond_to?(method)
+          substitutions_hash[method_key] = contactable.send(method)
+        else
+          substitutions_hash[method_key] = ''
+        end
+      end
+      substitutions_hash.merge('UNSUBSCRIBE_URL' => unsubscribe_url)
+    end
+
+    def unsubscribe_url
+      "#{MailManager.site_url}#{MailManager.unsubscribe_path}/#{guid}"
+    end
+
+    # generated the guid for which the message is identified by in transit
+    def generate_guid
+      update_attribute(:guid,       
+        "#{contact.id}-#{subscription.try(:id)}-#{self.id}-#{Digest::SHA1.hexdigest("#{contact.id}-#{subscription.try(:id)}-#{self.id}-#{MailManager.secret}")}")
+    end
+
+    protected
+    def set_type
+      self[:type] = self.class.name
+    end
+  end
+end

data/app/models/mail_manager/subscription.rb

@@ -0,0 +1,126 @@
+=begin rdoc
+Author::    Chris Hauboldt (mailto:biz@lnstar.com)
+Copyright:: 2009 Lone Star Internet Inc.
+
+Subscription ties Contacts to MailingLists and keeps track of subscription preferences or 'status'
+
+Statuses:
+'active' - user has an active subscription to list
+'pending' - awaiting user approval through email
+'unsubscribed' - user or admin has unsubscribe user from list 
+'failed_address' - BounceJob has detected a 'permanently' fatal email failure - like the account or domain doesn't exist 
+
+FIXME: currently tied to users table
+=end
+
+module MailManager
+  class Subscription < ActiveRecord::Base
+    self.table_name =  "#{MailManager.table_prefix}subscriptions"
+    belongs_to :contact, :class_name => 'MailManager::Contact'
+    belongs_to :mailing_list, :class_name => 'MailManager::MailingList'
+    has_many :messages, :class_name => 'MailManager::Message'
+
+    validates_presence_of :mailing_list_id
+    validates_associated :mailing_list
+
+    scope :active, :conditions => {:status => 'active'}, 
+                         :joins => "INNER JOIN #{MailManager.table_prefix}contacts ON 
+                            #{MailManager.table_prefix}subscriptions.contact_id = #{MailManager.table_prefix}contacts.id 
+                            and #{MailManager.table_prefix}contacts.deleted_at IS NULL"
+
+    scope :unsubscribed, :conditions => {:status => 'unsubscribed'}, 
+                         :joins => "INNER JOIN #{MailManager.table_prefix}contacts ON 
+                            #{MailManager.table_prefix}subscriptions.contact_id = #{MailManager.table_prefix}contacts.id 
+                            and #{MailManager.table_prefix}contacts.deleted_at IS NULL"
+
+    scope :failed_address, :conditions => {:status => 'failed_address'}, 
+                         :joins => "INNER JOIN #{MailManager.table_prefix}contacts ON 
+                            #{MailManager.table_prefix}subscriptions.contact_id = #{MailManager.table_prefix}contacts.id 
+                            and #{MailManager.table_prefix}contacts.deleted_at IS NULL"
+
+    scope :pending, :conditions => {:status => 'pending'}, 
+                         :joins => "INNER JOIN #{MailManager.table_prefix}contacts ON 
+                            #{MailManager.table_prefix}subscriptions.contact_id = #{MailManager.table_prefix}contacts.id 
+                            and #{MailManager.table_prefix}contacts.deleted_at IS NULL" 
+
+    include StatusHistory  
+    override_statuses(['active','unsubscribed','failed_address','pending','duplicate','admin_unsubscribed'],'pending')
+    before_create :set_default_status
+
+    attr_protected :id
+    
+    #acts_as_audited rescue Rails.logger.warn "Audit Table not defined!"
+  
+    def contact_full_name
+       contact.full_name
+    end
+ 
+    # changes or creates a subscription for the given contact and list and assigns the given status
+    def self.change_subscription_status(contact, mailing_list, status)
+      subscription = self.find_by_contact_id_and_mailing_list_id(contact.id, mailing_list.id)
+      return subscription.change_status(status) if subscription
+      subscription = Subscription.new
+      subscription.contact = contact
+      subscription.mailing_list = mailing_list
+      subscription.change_status(status)
+    end
+
+    # subscribes the contact to the list
+    def self.subscribe(contact, mailing_list)
+      change_subscription_status(contact, mailing_list, 'active')
+    end
+
+    # unsubscribes the contact from the list
+    def self.unsubscribe(contact, mailing_list)
+      change_subscription_status(contact, mailing_list, 'unsubscribed')
+    end
+  
+    def mailing_list_name
+      mailing_list.try(:name)
+    end
+    
+    def active?
+      status.eql?('active')
+    end
+
+    # unsubscribes a contact from all lists by looking them up through a messages GUID
+    # FIXME: when we add more lists and the ability to have multiple subscriptions, this should 
+    # remove only the list that is tied in the GUID and they should be linked to their options
+    def self.unsubscribe_by_message_guid(guid)
+      message = Message.find_by_guid(guid)
+      contact = message.contact
+      if message
+        begin
+          unsubscribed_subscriptions = self.unsubscribe_by_email_address(message.contact.email_address)
+          Mailer.deliver_unsubscribed(message,unsubscribed_subscriptions) unless unsubscribed_subscriptions.empty?
+          return unsubscribed_subscriptions
+        rescue => e
+          Rails.logger.warn "Error Unsubscribing email: #{message.contact.email_address}\n#{e.message}\n #{e.backtrace.join("\n ")}"
+          raise "An error occured."
+        end
+      else
+        raise "Could not find your subscription!"
+      end
+      nil
+    end
+  
+    def self.fail_by_email_address(email_address)
+      Contact.find_all_by_email_address(email_address).each do |contact|
+        contact.active_subscriptions.each do |subscription|
+          subscription.change_status(:failed_address)
+        end
+      end
+    end
+    
+    def self.unsubscribe_by_email_address(email_address)
+      subscriptions = []
+      Contact.find_all_by_email_address(email_address).each do |contact|
+        subscriptions += contact.active_subscriptions.each do |subscription|
+          subscription.change_status(:unsubscribed)
+        end
+      end
+      subscriptions
+    end
+  end
+end
+

data/app/models/mail_manager/test_message.rb

@@ -0,0 +1,175 @@
+module MailManager
+  class TestMessage  < ActiveRecord::Base
+    self.table_name =  "#{MailManager.table_prefix}messages"
+    belongs_to :mailing, :class_name => 'MailManager::Mailing'
+    belongs_to :subscription, :class_name => 'MailManager::Subscription'
+    has_many :bounces, :class_name => 'MailManager::Bounce'
+    belongs_to :contact, :class_name => 'MailManager::Contact'
+    #FIXME: if we add more types ... change the base message to be MailingMessage or something and don't use
+    #me as a message type
+    default_scope :conditions => {:type => "MailManager::#{(self.class.name.eql?('Class') ? self.name : self.class.name).gsub(/^MailManager::/,'')}" } 
+  
+    scope :pending, {:conditions => {:status => 'pending'}}
+    scope :ready, :conditions => ["status=?", 'ready']
+
+    def initialize(*args)
+      super
+      set_type
+    end
+
+    include StatusHistory
+    override_statuses(['pending','processing','sent','failed','ready'], 'pending')
+
+    attr_protected :id
+
+    scope :search, lambda{|params| 
+      conditions = ["1"]
+      if params[:mailing_id]
+        conditions[0] += " AND #{MailManager.table_prefix}messages.mailing_id=?"
+        conditions << params[:mailing_id]
+      end
+      if params[:status]
+        conditions[0] += " AND #{MailManager.table_prefix}messages.status=?"
+        conditions << params[:status]
+      end
+      {
+        :conditions => conditions, 
+        :order => "#{MailManager.table_prefix}contacts.last_name, #{MailManager.table_prefix}contacts.first_name, #{MailManager.table_prefix}contacts.email_address",
+        :joins => " INNER JOIN #{MailManager.table_prefix}contacts on #{MailManager.table_prefix}messages.contact_id=#{MailManager.table_prefix}contacts.id"
+      }}
+  
+    before_create :set_default_status
+    after_create :generate_guid
+
+    def email_address_with_name
+      return %Q|"#{full_name}" <#{email_address}>|.gsub(/\s+/,' ') unless full_name.eql?('')
+      email_address
+    end
+
+    # sends the message through Mailer
+    def deliver
+      MailManager::Mailer.deliver_message(self)
+      change_status(:sent)
+    end
+  
+    def full_name
+      contact.full_name
+    end
+
+    def email_address
+      contact.email_address
+    end
+
+    def subject
+      mailing.subject
+    end
+
+    def from_email_address
+      return self[:from_email_address] if self[:from_email_address].present?
+      self.update_attribute(:from_email_address,mailing.from_email_address)
+      self[:from_email_address]
+    end
+
+    # returns the separate mime parts of the message's Mailable
+    def parts
+      @parts ||= mailing.parts(substitutions)
+    end
+    
+    def contactable
+      contact.try(:contactable)
+    end
+
+    def substitutions
+      substitutions_hash = {}
+      MailManager::ContactableRegistry.registered_methods.each do |method|
+        method_key = method.to_s.upcase
+        if contact.respond_to?(method)
+          substitutions_hash[method_key] = contact.send(method)
+        elsif contactable.respond_to?(method)
+          substitutions_hash[method_key] = contactable.send(method)
+        else
+          substitutions_hash[method_key] = ''
+        end
+      end
+      substitutions_hash.merge('UNSUBSCRIBE_URL' => unsubscribe_url)
+    end
+
+    def unsubscribe_url
+      "#{MailManager.site_url}#{MailManager.unsubscribe_path}/#{guid}"
+    end
+  
+    def self.valid_statuses
+      ['pending','processing','sent','failed','ready']
+    end
+
+    def valid_statuses
+      ['pending','processing','sent','failed','ready']
+    end
+  
+    # generated the guid for which the message is identified by in transit
+    def generate_guid
+      update_attribute(:guid,       
+        "#{contact.id}-#{subscription.try(:id)}-#{self.id}-#{Digest::SHA1.hexdigest("#{contact.id}-#{subscription.try(:id)}-#{self.id}-#{MailManager.secret}")}")
+    end
+  
+    def default_status
+      'pending'
+    end
+
+    default_scope :conditions => {:type => "MailManager::#{(self.class.name.eql?('Class') ? self.name : self.class.name).gsub(/^MailManager::/,'')}" } 
+
+    scope :ready, :conditions => ["status=?", 'ready']
+    def email_address
+      self[:test_email_address]
+    end
+
+    def email_address_with_name
+      "\"Test Guy\" <#{email_address}>" 
+    end
+
+    def default_status
+      'ready'
+    end
+    def generate_guid
+      update_attribute(:guid,       
+        "test-#{self.id}-#{Digest::SHA1.hexdigest("test-#{self.id}-#{MailManager.secret}")}")
+    end
+        
+    def subscription
+      Subscription.new(self)
+    end
+        
+    def valid_statuses
+      ['ready'] + super
+    end
+    class Subscription
+      def initialize(test_message)
+        @test_message = test_message
+      end
+      def contact
+        Contact.new(@test_message)
+      end
+    end
+    class Contact
+      def initialize(test_message)
+        @test_message = test_message
+      end
+      def full_name
+        "#{first_name} #{last_name}".strip
+      end
+      def first_name
+        'Test'
+      end
+      def last_name
+        'Guy'
+      end
+      def email_address
+        @test_message.email_address
+      end
+    end
+    protected
+    def set_type
+      self[:type] = self.class.name
+    end
+  end
+end