mail_manager 3.0.0 → 3.2.0

data/app/models/mail_manager/mailing.rb

@@ -26,25 +26,18 @@ module MailManager
   
     accepts_nested_attributes_for :mailable
 
+    include Deleteable if (column_names.include?('deleted_at') rescue false)
+
     attr_accessor :bounce_count
 
     validates_presence_of :subject
     #validates_presence_of :mailable
   
-    scope :ready, lambda {{:conditions => ["(status='scheduled' AND scheduled_at < ?) OR status='resumed'",Time.now.utc]}}
+    scope :ready, lambda {{:conditions => ["(status='scheduled' AND scheduled_at < ?)",Time.now.utc]}}
     scope :by_statuses, lambda {|*statuses| {:conditions => ["status in (#{statuses.collect{|bindings,status| '?'}.join(",")})",statuses].flatten}}
   
-    def self.with_bounces(bounce_status=nil)
-      bounce_status_condition = bounce_status.present? ? ActiveRecord::Base.send(:sanitize_sql_array,[" WHERE status=?", bounce_status]) : ''
-      bounce_query = "SELECT mailing_id, COUNT(id) AS count from #{MailManager.table_prefix}bounces #{bounce_status_condition} group by mailing_id"
-      bounce_data = Bounce.connection.execute(bounce_query).inject({}){|hash,(mailing_id,count)| hash.merge(mailing_id => count)}
-      mailings = scoped
-      mailings = mailings.where("id in (#{bounce_data.keys.select(&:present?).join(',')})") if bounce_data.keys.select(&:present?).present?
-      mailings.order("created_at desc").map{|mailing| mailing.bounce_count = bounce_data[mailing.id]; mailing}
-    end
-
     include StatusHistory
-    override_statuses(['pending','scheduled','processing','paused','resumed','cancelled','completed'],'pending')
+    override_statuses(['pending','scheduled','processing','cancelled','completed'],'pending')
     before_create :set_default_status
 
     attr_protected :id
@@ -78,9 +71,7 @@ module MailManager
 	        begin
             # use the cached mailing parts, set messages mailing to self
             message.mailing=self
-	          message.change_status(:processing)
             message.deliver
-	          message.change_status(:sent)
 	        rescue => e
 	          message.result = "Error: #{e.message} - #{e.backtrace.join("\n")}"
 	          message.change_status(:failed)
@@ -212,24 +203,16 @@ module MailManager
       self.mailing_lists = mailing_list_ids.collect{|mailing_list_id| MailingList.find_by_id(mailing_list_id)}
     end
   
-    def can_pause?
-      ['processing'].include?(status.to_s)
-    end
-
     def can_edit?
-      ['pending','scheduled','paused'].include?(status.to_s)
+      ['pending','scheduled'].include?(status.to_s)
     end
   
     def can_cancel?
-       ['pending','scheduled','processing','paused','resumed'].include?(status.to_s)
-    end
-  
-    def can_resume?
-      ['paused'].include?(status.to_s)
+       ['pending','scheduled','processing'].include?(status.to_s)
     end
   
     def can_schedule?
-      ['pending'].include?(status.to_s)
+      ['pending'].include?(status.to_s) && scheduled_at.present?
     end
   
     def schedule
@@ -237,30 +220,28 @@ module MailManager
       change_status('scheduled')
       delay(run_at: scheduled_at).deliver
     end
+
+    def scheduled?
+      status.to_s.eql?('scheduled')
+    end
+
+    def job
+      mailing_jobs.first
+    end
   
+    def mailing_jobs
+      Delayed::Job.where("handler like ?","%MailManager::Mailing%#{subject}%")
+    end
+
     def cancel
       raise "Unable to cancel" unless can_cancel?
       change_status('pending')
-      # Delayed::Job.active.find(:all, :conditions => ["handler like ?","MailMgr::Mailing"])
-
-      #Changing this to return only the jobs that match the id so I don't have to parse with YAML ... seems logical
-      mailing_jobs = Delayed::Job.find(:all, :conditions => ["handler like ?","%MailMgr::Mailing%"] || ["handler like ?", "%id: {job_mailing_id.to_i}\n%"])
-      #mailing_jobs = Delayed::Job.active.find(:all, :conditions => ["handler like ?","%MailMgr::Mailing%"])
-      mailing_jobs.each do |job|
-        #job_mailing_id = YAML::load(job.handler).object.split(':').last
-        #logger.debug "Job mailing id: #{job_mailing_id} - This mailing id: #{self.id} - do they match: #{job_mailing_id.to_i == self.id.to_i}"
-        job.destroy #if job_mailing_id.to_i == self.id.to_i
-      end
+      mailing_jobs.delete_all
     end
-  
-    def resume
-      raise "Unable to resume" unless can_resume?
-      change_status('resumed')
+
+    def pending?
+      status.to_s.eql?('pending')
     end
   
-    def pause
-      raise "Unable to pause" unless can_pause?
-      change_status('paused')
-    end
   end
 end

data/app/models/mail_manager/message.rb

@@ -15,7 +15,7 @@ failed - either the message couldn't be handed to the Email Server or it has bee
 module MailManager
   class Message < ActiveRecord::Base
     self.table_name =  "#{MailManager.table_prefix}messages"
-    belongs_to :mailing, :class_name => 'MailManager::Mailing'
+    belongs_to :mailing, :class_name => 'MailManager::Mailing', counter_cache: true
     belongs_to :subscription, :class_name => 'MailManager::Subscription'
     has_many :bounces, :class_name => 'MailManager::Bounce'
     belongs_to :contact, :class_name => 'MailManager::Contact'
@@ -28,6 +28,10 @@ module MailManager
     scope :sent, :conditions => ["status=?", 'sent']
     scope :processing, :conditions => ["status=?", 'processing']
 
+    before_save :fix_counter_cache, if: lambda {|message| !message.new_record? && 
+      message.mailing_id_changed?
+    }
+
     attr_protected :id
 
     def initialize(*args)
@@ -36,7 +40,7 @@ module MailManager
     end
 
     scope :search, lambda{|params| 
-      conditions = ["1"]
+      conditions = ["1=1"]
       if params[:mailing_id]
         conditions[0] += " AND #{MailManager.table_prefix}messages.mailing_id=?"
         conditions << params[:mailing_id]
@@ -56,6 +60,9 @@ module MailManager
     before_create :set_default_status
     after_create :generate_guid
 
+    # returns a string in the form of "contact name" <email@example.com> if 
+    # the contact's full name returns anything ... or simply email@example.com if
+    # there is no name at all
     def email_address_with_name
       return %Q|"#{full_name}" <#{email_address}>|.gsub(/\s+/,' ') unless full_name.eql?('')
       email_address
@@ -63,22 +70,50 @@ module MailManager
 
     # sends the message through Mailer
     def deliver
+      # lock only needed until status is updated
+      Lock.with_lock("deliver_message_#{self.id}") do
+        reload
+        if can_deliver?
+          change_status(:processing)
+        else
+          Rails.logger.warn "Message(#{self.id})'s is no longer suitable to deliver.. staus: #{status}"
+        end
+      end
       MailManager::Mailer.deliver_message(self)
       change_status(:sent)
+    # allow other errors to bubble up
+    rescue MailManager::LockException => e
+      Rails.logger.warn "Locking error while trying to send MailManager::Message(#{id}) leaving in #{status} status"
+    end
+
+    # whether or not you can deliver a message
+    def can_deliver?
+      ['ready','pending'].include?(status) 
+    end
+
+    # return a contact whether its deleted or not
+    def active_or_deleted_contact
+      @active_or_deleted_contact ||= self.contact || MailManager::Contact.unscoped.
+        where(id: self.contact_id).first
     end
   
+    # returns the contact's full name
     def full_name
-      contact.full_name
+      active_or_deleted_contact.try(:full_name)
     end
 
+    # returns the contact's email address
     def email_address
-      contact.email_address
+      active_or_deleted_contact.try(:email_address)
     end
 
+    # returns the mailings subject
     def subject
       mailing.subject
     end
 
+    # the "From: " email address for the email
+    # lazy sets the from email addres if not present from the mailing 
     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)
@@ -90,16 +125,18 @@ module MailManager
       @parts ||= mailing.parts(substitutions)
     end
     
+    # returns the contact's 'contactable' object tied to the contact
     def contactable
-      contact.try(:contactable)
+      active_or_deleted_contact.try(:contactable)
     end
 
+    # returns a hash of substitutions to be used to modify the mailable's html/plaing text
     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)
+        if active_or_deleted_contact.respond_to?(method)
+          substitutions_hash[method_key] = active_or_deleted_contact.send(method)
         elsif contactable.respond_to?(method)
           substitutions_hash[method_key] = contactable.send(method)
         else
@@ -109,6 +146,7 @@ module MailManager
       substitutions_hash.merge('UNSUBSCRIBE_URL' => unsubscribe_url)
     end
 
+    # the full url to unsubscribe based on this message; including site url & guid
     def unsubscribe_url
       "#{MailManager.site_url}#{MailManager.unsubscribe_path}/#{guid}"
     end
@@ -116,12 +154,18 @@ module MailManager
     # 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}")}")
+        "#{active_or_deleted_contact.try(:id)}-#{subscription.try(:id)}-#{self.id}-#{Digest::SHA1.hexdigest("#{active_or_deleted_contact.try(:id)}-#{subscription.try(:id)}-#{self.id}-#{MailManager.secret}")}")
     end
 
     protected
+    # nodoc: set the type on create
     def set_type
       self[:type] = self.class.name
     end
+
+    def fix_counter_cache
+        MailManager::Mailing.decrement_counter(:messages_count, self.mailing_id_was) if self.mailing_id_was.present?
+        MailManager::Mailing.increment_counter(:messages_count, self.mailing_id)
+    end
   end
 end

data/app/models/mail_manager/subscription.rb

@@ -83,6 +83,10 @@ module MailManager
       status.eql?('active')
     end
 
+    def pending?
+      status.eql?('pending')
+    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
@@ -91,8 +95,7 @@ module MailManager
       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?
+          unsubscribed_subscriptions = self.unsubscribe_by_email_address(message.contact.email_address, message)
           return unsubscribed_subscriptions
         rescue => e
           Rails.logger.warn "Error Unsubscribing email: #{message.contact.email_address}\n#{e.message}\n #{e.backtrace.join("\n ")}"
@@ -112,13 +115,16 @@ module MailManager
       end
     end
     
-    def self.unsubscribe_by_email_address(email_address)
+    def self.unsubscribe_by_email_address(email_address,message=nil)
       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
+      Mailer.delay.unsubscribed(subscriptions,email_address,
+        subscriptions.first.contact, message) if \
+        subscriptions.present?
       subscriptions
     end
   end

data/app/models/status_history.rb

@@ -37,7 +37,8 @@ module StatusHistory
 
   def status
     return self[:status].to_s unless self[:status].blank?
-    self[:status] = default_status
+    set_default_status
+    self[:status]
   end
   
   def status=(new_status)
@@ -50,7 +51,7 @@ module StatusHistory
   end
   
   def set_default_status
-    return unless status.blank?
+    return unless self[:status].blank?
     self[:status_changed_at] = Time.now.utc
     self[:status] = default_status
     Rails.logger.debug "Setting Default Status to #{default_status} #{self.name rescue "Not a class?"} #{self.class.name}"

data/app/views/layouts/mail_manager/application.html.erb

@@ -1,14 +1,42 @@
 <!DOCTYPE html>
-<html>
+<html lang='en'>
 <head>
-  <title>MailManager</title>
+  <!-- iReach application.html.rb -->
+  <title><%= h(yield(:title) || "iReach Newsletter Manager") %></title>
   <%= stylesheet_link_tag    "mail_manager/application", :media => "all" %>
+  <link href="http://ajax.googleapis.com/ajax/libs/jqueryui/1.10.3/themes/le-frog/jquery-ui.css" media="screen" rel="stylesheet" type="text/css" />
   <%= javascript_include_tag "mail_manager/application" %>
   <%= csrf_meta_tags %>
+  <%= content_for :head %>
 </head>
 <body>
-
-<%= yield %>
-
+<div id="top"><%= image_tag "mail_manager/iReach_logo.gif", width: "269", height:"85", style: "float: left;" %><%= image_tag "mail_manager/TopCenter.gif", width: "435", height: "85", style: "float: left;" %><%= image_tag "mail_manager/TopRight.gif", width: "62", height: "85", style: "float: right;" %>&nbsp;</div>
+<div style="background-color: #fff;">
+  <div id="menu">
+    <ul>
+      <li><span onClick="$('#mailings_submenu').toggle();return false">Mailings</span>
+        <ul id='mailings_submenu' <%= ' style="display:none"' unless request.path =~ %r|/mail_manager| %>>
+          <%= content_tag(:li, link_to('Contacts', mail_manager.contacts_path)) if can?(:manage, MailManager::Contact) %>
+          <%= content_tag(:li, link_to('Mailings', mail_manager.mailings_path)) if can?(:manage, MailManager::Mailing) %>
+          <%= content_tag(:li, link_to('Mailing Lists', mail_manager.mailing_lists_path)) if can?(:manage, MailManager::MailingList) %>
+          <%= content_tag(:li, link_to('Bounces', mail_manager.bounces_path)) if can?(:manage, MailManager::Bounce) %>
+        </ul>
+      </li>
+    </ul>
+  </div>
+<div id="page_content">
+      <% flash.each do |name, msg| -%>
+        <%= content_tag :div, msg, :id => "flash_#{name}" %>
+      <% end -%>
+      
+      <% if show_title? -%>
+        <h1><%=h yield(:title) %></h1>
+      <% end -%>
+      <%= yield %>
+      
+      <%= yield :page_navigation %>
+</div>
+</div>
+<%= image_tag "mail_manager/BottomRight.gif", width: "62", height: "85", style: "float: right;" %>
 </body>
 </html>

data/app/views/layouts/mail_manager/layout.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+  <title>IReach Newsletter Archive</title>
+</head>
+<body>
+  <div id="top"><%= image_tag "mail_manager/iReach_logo.gif", width: "269", height:"85" %></div>
+  <div id="page_content">
+    <% flash.each do |name, msg| -%>
+      <%= content_tag :div, msg, :id => "flash_#{name}" %>
+    <% end -%>
+    <%= yield %>
+  </div>
+</body>
+</html>

data/app/views/mail_manager/bounces/index.html.erb

@@ -1,9 +1,9 @@
-<% title "Listing Bounces for #{@mailing.try(:subject)}" %>
+<%= title "Listing Bounces#{"for #{@mailing.subject}" if @mailing.present?}" %>
 
 
 <%= form_tag mail_manager.bounces_path, :id => 'search_form', :method => 'GET' do %>
-  Mailing: <%= select_tag "mailing_id", options_for_select(@mailings.collect{|mailing| ["#{mailing.subject} (#{l mailing.status_changed_at}) (#{mailing.bounce_count})",mailing.id.to_s]},params[:mailing_id].to_i), :include_blank => true, :onChange => "$('#search_form').submit()" %></br>
-  Status:<%= select_tag "bounce[status]", options_for_select([['Needs Attention','needs_manual_intervention'],['Resolved','resolved']],params[:bounce][:status]), :include_blank => true,  :onChange => "$('#search_form').submit()" %>
+ <label for="mailing_id">Mailing:</label><%= select_tag "mailing_id", options_for_select(@mailings.collect{|mailing| ["#{mailing.subject} (#{l mailing.status_changed_at if mailing.status_changed_at.present?}) (#{mailing.bounces.size})",mailing.id.to_s]},params[:mailing_id].to_i), :include_blank => true, :onChange => "$('#search_form').submit()" %><br />
+  <label for="bounce_status">Status:</label><%= select_tag "bounce[status]", options_for_select([['Needs Attention','needs_manual_intervention'],['Resolved','resolved']],params[:bounce][:status]), :include_blank => true,  :onChange => "$('#search_form').submit()" %><br />
 <% end %>
 <% if @bounces.length == 0 %>
   <h3>No bounces found for the Mailing with given status.</h3>
@@ -14,6 +14,7 @@
 <table class="list" cellpadding="1" cellspacing="0">
   <tr class="title">
     <td>Contact</td>
+    <td>Status</td>
     <td>Status changed at</td>
     <td>Comments</td>
     <td>&nbsp;</td>
@@ -21,9 +22,10 @@
   <% for bounce in @bounces %>
     <tr class="<%= cycle('odd','even') %>">
       <td><%=h bounce.contact_full_name %>  <%=h bounce.contact_email_address %></td>
+      <td><%=h bounce.status rescue 'N/A' %></td>
       <td><%=l bounce.status_changed_at rescue nil %></td>
       <td><%=h bounce.comments %></td>
-      <td><%= link_to "View", bounce, :class => 'button' %><div class="linkbuttonEnding"></div></td>
+      <td><%= link_to "View", bounce, :id => "view_bounce_#{bounce.id}", :class => 'button' %></td>
     </tr>
   <% end %>
 </table>

data/app/views/mail_manager/bounces/show.html.erb

@@ -3,9 +3,9 @@
 
 <% if @bounce.status.eql?('needs_manual_intervention') %>
 <div>
-  <%= link_to "Unsubscribe", mail_manager.fail_address_bounce_path(@bounce), :class => 'button' %><div class="linkbuttonEnding"></div>
+  <%= link_to "Unsubscribe", mail_manager.fail_address_bounce_path(@bounce), :class => 'button' %>
     &nbsp;
-  <%= link_to "Dismiss", mail_manager.dismiss_bounce_path(@bounce), :class => 'button' %><div class="linkbuttonEnding"></div>
+  <%= link_to "Dismiss", mail_manager.dismiss_bounce_path(@bounce), :class => 'button' %>
 </div>
 <% end %>
 
@@ -33,6 +33,6 @@
 <%= content_for :page_navigation do %>
 <div>
   <%= link_to "Back", mail_manager.bounces_path(:mailing_id => @mailing.try(:id), 
-      :bounce => {:status => @bounce.status}), :class => 'button' %><div class="linkbuttonEnding"></div>
+      :bounce => {:status => @bounce.status}), :class => 'button' %>
 </div>
 <% end %>

data/app/views/mail_manager/contacts/_form.html.erb

@@ -1,27 +1,11 @@
 <%= form_for @contact do |f| %>
   <%= f.error_messages %>
-  <table cellspacing='1' cellpadding='0' border='0' width="400">  
-    <tr valign='top'>
-    <tr valign="top">
-       <td width='150'><%= f.label :first_name %></td>
-       <td><%= f.text_field :first_name %></td>
-    </tr>
-    <tr valign='top'>
-    <tr valign="top">
-       <td width='150'><%= f.label :last_name %></td>
-       <td><%= f.text_field :last_name %></td>
-    </tr>
-    <tr valign='top'>
-    <tr valign="top">
-       <td width='150'><%= f.label :email_address %></td>
-       <td><%= f.text_field :email_address %></td>
-    </tr>
-  </table>
-  <table cellspacing='1' cellpadding='0' border='0' width="400">
+       <%= f.label :first_name %>
+       <%= f.text_field :first_name, :style => 'width: 300px;' %><br />
+       <%= f.label :last_name %>
+       <%= f.text_field :last_name, :style => 'width: 300px;' %><br />
+       <%= f.label :email_address %>
+       <%= f.text_field :email_address, :style => 'width: 300px;' %><br />
     <%= contactable_subscriptions_selector(f) %>
-    <tr valign='top'>
-      <td align="right" colspan="2"><%= f.submit "Submit", :class => 'button' %><div class="buttonEnding"></div></td>
-    </tr>
-  </table>
-    
+      <div class="submit_button"><%= f.submit "Submit", :class => 'button' %></div>
 <% end %>