mail_manager 3.0.0 → 3.2.0

data/app/controllers/mail_manager/mailing_lists_controller.rb

@@ -1,7 +1,5 @@
 module MailManager
-  class MailingListsController < BaseController
-    before_filter :find_mailing_list, :except => [:new,:create,:index]
-
+  class MailingListsController < MailManager::ApplicationController
     def index
       @mailing_lists = MailingList.active.order("name asc").paginate(:page => params[:page])
     end
@@ -19,7 +17,7 @@ module MailManager
     def create
       @mailing_list = MailingList.new(params[:mailing_list])
       if @mailing_list.save
-        flash[:notice] = 'MailingList was successfully created.'
+        flash[:notice] = 'Mailing List was successfully created.'
         redirect_to(mail_manager.mailing_lists_path)
       else
         render :action => "new"
@@ -28,7 +26,7 @@ module MailManager
 
     def update
       if @mailing_list.update_attributes(params[:mailing_list])
-        flash[:notice] = 'MailingList was successfully updated.'
+        flash[:notice] = 'Mailing List was successfully updated.'
         redirect_to(mail_manager.mailing_lists_path)
       else
         render :action => "edit"
@@ -37,13 +35,8 @@ module MailManager
 
     def destroy
       @mailing_list.destroy
+      flash[:notice] = "Mailing List was deleted."
       redirect_to(mail_manager.mailing_lists_url)
     end
-  
-    protected 
-  
-    def find_mailing_list
-      @mailing_list = MailingList.find(params[:id])
-    end
   end
-end
+end

data/app/controllers/mail_manager/mailings_controller.rb

@@ -1,12 +1,15 @@
 module MailManager
-  class MailingsController < BaseController
+  class MailingsController < ::MailManager::ApplicationController
     before_filter :find_mailing, :except => [:new,:create,:index]
     before_filter :find_all_mailing_lists, :only => [:new,:create,:edit,:update]
     before_filter :find_mailables, :only => [:new,:create,:edit,:update]
     before_filter :get_mailables_for_select, :only => [:new,:create,:edit,:update]
 
+    include DeleteableActions
+
     def index
-      @mailings = Mailing.all.sort_by{|mailing| mailing.created_at}.reverse
+      @mailings = Mailing.order("created_at desc").paginate(page: (params[:page] || 1),
+        per_page: (params[:per_page] || 10))
     end
 
     def show
@@ -27,22 +30,24 @@ module MailManager
     end
   
     def schedule
-      @mailing.schedule
+      if @mailing.can_schedule? 
+        @mailing.schedule
+        flash[:info] = "Mailing scheduled."
+      else
+        flash[:warning] = ""
+        if @mailing.scheduled_at.nil?
+          flash[:warning] += "Error! You must edit your mailing and set a time for your mailing to run.<br/>"
+        end
+        if @mailing.status != 'pending'
+          flash[:warning] += "Error! Your mailing must be pending in order to schedule it."
+        end
+      end
       redirect_to mail_manager.mailings_path
     end
   
     def cancel
       @mailing.cancel
-      redirect_to mail_manager.mailings_path
-    end
-  
-    def resume
-      @mailing.resume
-      redirect_to mail_manager.mailings_path
-    end
-  
-    def pause
-      @mailing.pause
+      flash[:notice] = "Mailing cancelled."
       redirect_to mail_manager.mailings_path
     end
   
@@ -72,11 +77,6 @@ module MailManager
       end
     end
 
-    def destroy
-      @mailing.destroy
-      redirect_to(mail_manager.mailings_url)
-    end
-  
     protected
   
     def find_mailing

data/app/controllers/mail_manager/messages_controller.rb

@@ -1,14 +1,11 @@
 module MailManager
-  class MessagesController < ApplicationController
-    layout 'admin'
-    before_filter :find_message, :except => [:new,:create,:index]
+  class MessagesController < ::MailManager::ApplicationController
     before_filter :find_mailing
 
     def index
       params[:message] = Hash.new unless params[:message]
-      params[:message][:status] = 'failed' if params[:message][:status].nil?
       search_params = params[:message].merge(:mailing_id => params[:mailing_id]) 
-      @valid_statuses = Message.valid_statuses
+      @valid_statuses = [['Any Status','']] + Message.valid_statuses.map{|s| [s.capitalize,s]}
       @messages = Message.search(search_params).paginate(:page => params[:page])
     end
 
@@ -17,14 +14,10 @@ module MailManager
   
     protected
   
-    def find_message
-      @message = Message.find(params[:id])
-    end
-
     def find_mailing
       return @mailing = Mailing.find_by_id(params[:mailing_id]) if params[:mailing_id]
       return @mailing = @message.message.try(:mailing) if @message
       nil
     end
   end
-end
+end

data/app/controllers/mail_manager/subscriptions_controller.rb

@@ -1,22 +1,15 @@
 module MailManager
-  class SubscriptionsController < BaseController
-    before_filter :find_subscription, :except => [:new,:create,:index,:unsubscribe,:unsubscribe_by_email_address]
-    before_filter :find_mailing_list
-    before_filter :find_contact, :except => [:new,:create,:index,:unsubscribe,:unsubscribe_by_email_address]
-    skip_before_filter :authorize, :only => [:unsubscribe,:unsubscribe_by_email_address]
+  class SubscriptionsController < ::MailManager::ApplicationController
+    skip_before_filter :authorize_resource
+    skip_before_filter :load_resource
 
-    def index
-      params[:search] = Hash.new unless params[:search]
-      search_params = params[:search].merge(:mailing_list_id => params[:mailing_list_id]) 
-      @valid_statuses = Subscription.valid_statuses
-      @subscriptions = Subscription.search(search_params).paginate(:all, :page => params[:page])
-    end
-  
+    # unsubscribes an email adress by a message's guid(sent in the link)
     def unsubscribe
-      raise "Empty id for#{params[:guid]}" if params[:guid].blank?
+      raise "Empty id for #{params[:guid]}" if params[:guid].blank?
       if params[:guid] =~ /^test/
         @message = TestMessage.find_by_guid(params[:guid])
         @mailing_lists = ['Test Mailing List'] 
+        @email_address = @message.test_email_address
         @contact = Contact.new(:first_name => 'Test', :last_name => 'Guy', 
           :email_address => @message.test_email_address)
       else
@@ -25,80 +18,28 @@ module MailManager
           subscription.mailing_list.nil?}.collect{|subscription| subscription.mailing_list.name}
         @contact = Message.find_by_guid(params[:guid]).try(:contact)
         raise "Could not find your subscription. Please try unsubscribing with your email address." if @contact.nil?
+        @email_address = @contact.email_address
       end
-      render 'unsubscribe', :layout => 'layout'
+      render 'unsubscribe', :layout => MailManager.public_layout
     rescue => e
+      # :nocov: catastrophic failure... shouldn't happen
       Rails.logger.warn "Error unsubscribing: #{e.message}\n #{e.backtrace.join("\n ")}"
-      flash[:error] = e.message
-      redirect_to mail_manager.unsubscribe_by_email_address_path
+      flash[:error] = "We did not recognize that unsubscribe url! Please try unsubscribing with your email address."
+      redirect_to main_app.unsubscribe_by_email_address_path
+      # :nocov:
     end
     
+    # prints/executes form for unsubscribing by email address
     def unsubscribe_by_email_address
       unless params[:email_address].blank?
         unsubscribed_subscriptions = Subscription.unsubscribe_by_email_address(params[:email_address])
+        @email_address = params[:email_address]
         @mailing_lists = unsubscribed_subscriptions.reject{|subscription|
           subscription.mailing_list.nil?}.collect{|subscription| subscription.mailing_list.name}
         @contact = Contact.new(:email_address => params[:email_address])
-        return render('unsubscribe', :layout => 'layout')
-      end
-      render :layout => 'layout'
-    end
-
-    def show
-    end
-
-    def new
-      @subscription = Subscription.new
-      @subscription.mailing_list = @mailing_list
-      @contact = @subscription
-    end
-
-    def edit
-    end
-
-    def create
-      @subscription = Subscription.new(params[:subscription])
-      @subscription.mailing_list_id = @mailing_list.id
-      if @subscription.save
-        flash[:notice] = 'Subscription was successfully created.'
-        return redirect_to(mail_manager.mailing_list_subscriptions_path(@mailing_list))
-      else
-        @contact = @subscription
-        render :action => "new"
+        return render('unsubscribe', :layout => MailManager.public_layout)
       end
-    end
-
-    def update
-      if @subscription.update_attributes(params[:subscription])
-        @subscription.change_status(params[:subscription][:status])
-        flash[:notice] = 'Subscription was successfully updated.'
-        redirect_to(mail_manager.mailing_list_subscriptions_path(@mailing_list))
-      else
-        render :action => "edit"
-      end
-    end
-
-    def destroy
-      @subscription.destroy
-      redirect_to(mail_manager.subscriptions_url)
-    end
-  
-    protected 
-  
-    def find_subscription
-      @subscription = Subscription.find(params[:id])
-    end
-
-    def find_mailing_list
-      return @mailing_list = @subscription.mailing_list if @subscription
-      return @mailing_list = MailingList.find_by_id(params[:mailing_list_id]) if params[:mailing_list_id]
-      return @mailing_list = MailingList.find_by_id(params[:subscription][:mailing_list_id]) if
-        params[:subscription]
-      nil
-    end
-  
-    def find_contact
-      @contact = @subscription.contact
+      render :layout => MailManager.public_layout
     end
   end
 end

data/app/helpers/mail_manager/layout_helper.rb

@@ -0,0 +1,43 @@
+module MailManager
+  module LayoutHelper
+    def title(value=nil, locals={})
+      if value.nil?
+        @page_title
+      else
+        @page_title = translate( value, locals)
+        "<h1>#{@page_title}</h1>".html_safe
+      end
+    end
+
+    def use_show_for_resources?
+      ::MailManager.use_show_for_resources
+    rescue 
+      # :nocov: shouldn't happen
+      false
+      # :nocov:
+    end
+
+    def show_title?
+      return @show_title if defined? @show_title
+      true
+    rescue 
+      # :nocov: shouldn't happen
+      false
+      # :nocov:
+    end
+
+    def site_url
+      ::MailManager.site_url
+    rescue
+      # :nocov: shouldn't happen
+      "#{default_url_options[:protocol]||'http'}://#{default_url_options[:domain]}"
+      # :nocov:
+    end
+
+    def translate(key, options={})
+      super(key, options.merge(raise: true))
+    rescue I18n::MissingTranslationData
+      key
+    end
+  end
+end

data/app/models/mail_manager/bounce.rb

@@ -20,19 +20,24 @@ module MailManager
   class Bounce < ActiveRecord::Base
     self.table_name = "#{MailManager.table_prefix}bounces"
     belongs_to :message, :class_name => 'MailManager::Message'
-    belongs_to :mailing, :class_name => 'MailManager::Mailing'
+    belongs_to :mailing, :class_name => 'MailManager::Mailing', counter_cache: true
     include StatusHistory
     override_statuses(['needs_manual_intervention','unprocessed','dismissed','resolved','invalid'],'unprocessed')
     before_create :set_default_status
-    default_scope :order => "#{MailManager.table_prefix}contacts.last_name, #{MailManager.table_prefix}contacts.first_name, #{MailManager.table_prefix}contacts.email_address",
-        :joins => 
-        "LEFT OUTER JOIN #{MailManager.table_prefix}messages on #{MailManager.table_prefix}bounces.message_id=#{MailManager.table_prefix}messages.id "+
-        " LEFT OUTER JOIN #{MailManager.table_prefix}contacts on #{MailManager.table_prefix}messages.contact_id=#{MailManager.table_prefix}contacts.id"
+    #default_scope :order => "#{MailManager.table_prefix}contacts.last_name, #{MailManager.table_prefix}contacts.first_name, #{MailManager.table_prefix}contacts.email_address",
+    #    :joins => 
+    #    "LEFT OUTER JOIN #{MailManager.table_prefix}messages on #{MailManager.table_prefix}bounces.message_id=#{MailManager.table_prefix}messages.id "+
+    #    " LEFT OUTER JOIN #{MailManager.table_prefix}contacts on #{MailManager.table_prefix}messages.contact_id=#{MailManager.table_prefix}contacts.id"
 #
     scope :by_mailing_id, lambda {|mailing_id| where(:mailing_id => mailing_id)}
     scope :by_status, lambda {|status| where(:status => status.to_s)}
 
+    before_save :fix_counter_cache, if: lambda {|bounce| !bounce.new_record? && 
+      bounce.mailing_id_changed?
+    }
+
     attr_protected :id
+
     #Parses email contents for bounce resolution
     def process(force=false)
       if status.eql?('unprocessed') || force
@@ -129,5 +134,11 @@ module MailManager
       return @email if @email
       @email = Mail.new(bounce_message)
     end
+  
+   protected
+    def fix_counter_cache
+        MailManager::Mailing.decrement_counter(:bounces_count, self.mailing_id_was) if self.mailing_id_was.present?
+        MailManager::Mailing.increment_counter(:bounces_count, self.mailing_id)
+    end
   end
 end

data/app/models/mail_manager/contact.rb

@@ -66,12 +66,65 @@ module MailManager
     end
 
     def self.signup(params)
-      contact = MailManager::Contact.active.find_by_email_address(params['email_address']) 
+      contact = Contact.active.find_by_email_address(params['email_address']) 
       contact ||= Contact.new
       Rails.logger.debug "Updating contact(#{contact.new_record? ? "New" : contact.id}) params: #{params.inspect}"
       contact.update_attributes(params)
       contact
     end
+
+    def double_opt_in(mailing_list_ids)
+      previously_active_subscriptions = subscriptions.select(&:"active?")
+      new_subscriptions = subscriptions.select do |s| 
+        mailing_list_ids.include?(s.mailing_list_id.to_s)
+      end
+      if new_subscriptions.present?
+        new_subscriptions.each{|subscription| subscription.change_status(:pending)}
+        self.delay.deliver_double_opt_in
+      end
+      nil
+    end
+
+    def deliver_double_opt_in
+      Mailer.double_opt_in(self).deliver
+    end
+
+    def double_opt_in_url
+      "#{MailManager.site_url}#{MailManager.double_opt_in_path}/#{login_token}"
+    end
+
+    def self.inject_contact_id(token,id)
+      token = token.split('')
+      id_string = id.to_s.split('')
+      new_token = ""
+      0.upto(39) do |index|
+        new_token << token.pop
+        new_token << id_string.shift unless id_string.blank?
+      end
+      new_token
+    end
+
+    def self.extract_contact_id(token)
+      token = token.split('')
+      id_string = ""
+      0.upto(token.length - 41) do |index|
+        token.shift 
+        id_string << token.shift
+      end
+      id_string.to_i
+    end
+
+    def self.find_by_token(token)
+      Contact.find_by_id(Contact::extract_contact_id(token))
+    end
+      
+    def login_token
+      self[:login_token] ||= generate_login_token
+    end
+
+    def authorized?(token)
+      login_token.eql?(token) and login_token_created_at > 2.days.ago
+    end
         
     def initialize_subscriptions
       @subscriptions = new_record? ? [] : Subscription.find_all_by_contact_id(self.id) 
@@ -87,5 +140,15 @@ module MailManager
         subscription.mailing_list.nil?}.sort_by{|subscription|
         subscription.mailing_list.name.downcase}
     end
+    
+    # generated the token for which an opt-in is emailed
+    def generate_login_token
+      time = Time.now
+      token = Contact::inject_contact_id("#{Digest::SHA1.hexdigest(
+        "#{self.id}#{::MailManager.secret}#{time}")}", self.id)
+      self.update_attribute(:login_token, token)
+      self.update_attribute(:login_token_created_at, time)
+      token
+    end
   end
 end

data/app/models/mail_manager/mailable.rb

@@ -0,0 +1,14 @@
+class MailManager::Mailable < ActiveRecord::Base
+  attr_accessible :name, :email_text, :email_html
+  default_scope where(reusable: true)
+  include MailManager::MailableRegistry::Mailable
+end
+
+MailManager::MailableRegistry.register('MailManager::Mailable',{
+  :find_mailables => :all,
+  :name => :name,
+  :parts => [
+    ['text/plain', :email_text],
+    ['text/html', :email_html]
+  ]
+})

data/app/models/mail_manager/mailer.rb

@@ -12,37 +12,50 @@ mail - knows how to send any message based on the different "mime" parts its giv
 
 =end
 
-require 'net/http'
-require 'uri'
+require 'open-uri'
 require "base64"
 begin
   require "mini_magick" 
 rescue => e
+  # :nocov:
   require 'rmagick' rescue nil
+  # :nocov:
 end
 
 
 module MailManager
   class Mailer < ActionMailer::Base
-    def unsubscribed(message,subscriptions)
-      @contact = message.contact
-      @recipients = @contact.email_address
-      @from = message.from_email_address
-      @message = message
+    # send a confirmation email for unsubscribing
+    def unsubscribed(subscriptions,email_address,contact=nil,message=nil)
+      @contact = contact
+      @email_address = email_address
+      @recipients = @email_address
+      @from = message.try(:from_email_address) || MailManager.default_from_email_address
       @mailing_lists = subscriptions.reject{|subscription| subscription.mailing_list.nil?}.
         collect{|subscription| subscription.mailing_list.name}
       @subject = "Unsubscribed from #{@mailing_lists.join(',')} at #{MailManager.site_url}"
-      Rails.logger.debug "Really Sending Unsubscribed from #{@mailing_lists.first} to #{@contact.email_address}"
+      Rails.logger.debug "Really Sending Unsubscribed from #{@mailing_lists.first} to #{@email_address}"
+      mail(to: @recipients, from: @from, subject: @subject)
+    end
+
+    def double_opt_in(contact)
+      @contact = contact
+      @recipients = @contact.email_address
+      @subject = "Confirm Newsletter Subscription at #{::MailManager.site_url}"
+      @from = ::MailManager.signup_email_address
+      @mailing_list_names = contact.subscriptions.map(&:mailing_list).map(&:name).join(', ')
+      @headers    = {'Return-Path' => ::MailManager.bounce['email_address']}
       mail(to: @recipients, from: @from, subject: @subject)
     end
 
-    # we do special junk ... so lets make them class methods
     class << self
+      # send a mailing related to the message's data
       def deliver_message(message)
         self.send_mail(message.subject,message.email_address_with_name,message.from_email_address,
           message.parts,message.guid,message.mailing.include_images?)
       end
 
+      # create mailing; parsing html sources for images to attach/include
       def multipart_with_inline_images(subject,to_email_address,from_email_address,the_parts,message_id=nil,include_images=true)
         text_source = the_parts.first[1];nil
         original_html_source = the_parts.last[1];nil
@@ -72,6 +85,7 @@ module MailManager
         mail
       end
 
+      # create mailing without fetching image data
       def multipart_alternative_without_images(subject,to_email_address,from_email_address,the_parts,message_id=nil,include_images=true)
         text_source = the_parts.first[1];nil
         original_html_source = the_parts.last[1];nil
@@ -92,6 +106,7 @@ module MailManager
         mail
       end
     
+      # send the mailing with the given subject, addresses, and parts
       def send_mail(subject,to_email_address,from_email_address,the_parts,message_id=nil,include_images=true)
         include_images = (include_images and !MailManager.dont_include_images_domains.detect{|domain| 
           to_email_address.strip =~ /#{domain}>?$/})
@@ -108,8 +123,11 @@ module MailManager
         Rails.logger.debug mail.to_s
       end
 
+      # set mail delivery settings
       def set_mail_settings(mail)
-        mail.delivery_method ActionMailer::Base.delivery_method.eql?(:letter_opener) ? :test : ActionMailer::Base.delivery_method
+        delivery_method = ActionMailer::Base.delivery_method
+        delivery_method = delivery_method.eql?(:letter_opener) ? :test : delivery_method
+        mail.delivery_method delivery_method
         # letter opener blows up!
         # Ex set options!
         #         mail.delivery_method.settings.merge!( {
@@ -123,25 +141,20 @@ module MailManager
         # } )
 
         mail.delivery_method.settings.merge!(
-          (case method
+          (case delivery_method 
            when :smtp then ActionMailer::Base.smtp_settings
+           # :nocov:
            when :sendmail then ActionMailer::Base.sendmail_settings
+           # :nocov:
            else
              {}
            end rescue {})
         )
       end
     
-      def inline_attachment(params, &block)
-        params = { :content_type => params } if String === params
-        params = { :disposition => "inline",
-                   :transfer_encoding => "base64" }.merge(params)
-        params[:headers] ||= {}
-        params[:headers]['Content-ID'] = params[:cid]
-        params
-      end
-
+      # return mime type for images by extension
       def image_mime_types(extension)
+        # :nocov:
         case extension.downcase
           when 'bmp' then 'image/bmp'
           when 'cod' then 'image/cis-cod'
@@ -156,13 +169,21 @@ module MailManager
           when 'tif' then 'image/tiff'
           when 'tiff' then 'image/tiff'
         end
+        # :nocov:
       end
       
+      # find the extension for images by inspecting their data
       def get_extension_from_data(image_data)
         if defined?(MiniMagick)
-          MiniMagick::Image.read(image_data)[:format] || ''
+          format = ''
+          file = Tempfile.new('get-extension','tmp')
+          file.close
+          File.open(file.path,'wb'){|binfile| binfile.write(image_data)}
+          MiniMagick::Image.open(file.path)[:format] || ''
         elsif defined?(Magick)
+          # :nocov: currently on ly mini_magick is tested
           Magick::Image.from_blob(image_data).first.format || ''
+          # :nocov:
         else
           ''
         end
@@ -170,6 +191,8 @@ module MailManager
         ''
       end
     
+
+      # parses html and retrieves images and inserts them with CID/attachments
       def inline_html_with_images(html_source)
         parsed_data = html_source.split(/(<\s*img[^>]+src\s*=\s*["'])([^"']*)(["'])/i)
         images = Array.new
@@ -200,72 +223,16 @@ module MailManager
         end
         raise image_errors unless image_errors.eql?('')
         [final_html,images]
-        # related_part = Mail::Part.new do 
-        #   body final_html
-        # end
-        # images.each do |image|
-        #   related_part.part inline_attachment(image)
-        # end
-        # related_part.content_type = 'multipart/related'
-        # related_part
-
-        # related_part = Mail::Part.new do
-        #   content_type 'multipart/related'
-        #   # content_type 'text/html; charset=UTF-8'
-        #   # body final_html
-        # end
-        # related_part.parts << Mail::Part.new do
-        #   content_type 'text/html; charset=UTF-8'
-        #   body final_html
-        # end
-        # images.each do |image|
-        #   related_part.attachments[image[:filename]] = image[:body]
-        # end
-        # related_part.content_type = 'multipart/related'
-        # related_part.parts.first.content_type = 'text/html; charset=UTF-8'
-        # related_part.parts.first.header['Content-Disposition'] = 'inline'
-
-      end
-
-      def local_ips
-        `/sbin/ifconfig`
       end
 
-      def request_local?(uri_str)
-        uri = URI.parse(uri_str)
-        ip_address = `host #{uri.host}`.gsub(/.*has address ([\d\.]+)\s.*/m,"\\1")
-        local_ips.include?(ip_address)
-      rescue => e
-        false
-      end
-    
+      # fetch the data from a url (used for images) 
       def fetch(uri_str, limit = 10)
-        # You should choose better exception.
-        raise ArgumentError, 'HTTP redirect too deep' if limit == 0
         uri = URI.parse(uri_str)
-        request = Net::HTTP::Get.new("#{uri.path}#{"?"+uri.query if uri.query.to_s.strip != ''}")
-        
-        response = Net::HTTP.start(
-          uri.host, uri.port, 
-          :use_ssl => uri.scheme == 'https', 
-          :verify_mode => OpenSSL::SSL::VERIFY_NONE) do |https|
-          https.request(request)
-        end
-        case response
-        when Net::HTTPSuccess     then response.body
-        when Net::HTTPRedirection then fetch(response['location'], limit - 1)
+        if uri.scheme.eql?('file')
+          File.binread(uri_str.gsub(%r#^file://#,''))
         else
-          response.error!
+          uri.read
         end
-        # CURB version - gem wouldn't install anymore on CentOS
-        # body = ''
-        # Curl.get(uri_str) do |http|
-        #   http.follow_location = true
-        #   http.interface = '127.0.0.1' if request_local?(uri_str)
-        #   http.on_success{|response| body = response.body}
-        # end
-        # raise Exception.new("Couldn't fetch URL: #{uri_str}") unless body.present?
-        # body
       end
     end
   end