mail_manager 3.2.6 → 3.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5b18070eb704e09c4abee8c914aaa548deb43e6
-  data.tar.gz: 9b29f0f717833d1a4c3b8fa0d2858592b4823195
+  metadata.gz: 7086dba0cddea0712c21f6c60b68081d53aa2d5d
+  data.tar.gz: ff73fe7f60296ab4368baa6ac7b91268be0528ef
 SHA512:
-  metadata.gz: 18a71c74071f945dcfd0cf5590395f72648e82a13222abb83205702c32446de593dbe9a69d9d310dc8b2ae8e021aee3d6a61d850f050d2c4c6efb7829f16926e
-  data.tar.gz: 751c9ef49582c67528776bf9e0e573316e539a38382df09fd59e7a0ac272b98d661aded4c3bbab1ccfb4e4e1dbd5bd550bf1ed105ef0aca10a4ea9cdee4ac8e3
+  metadata.gz: c0119d6ab3f1bc2f1f64680a1178eaf84ee25b61f809c452276178e471f9b0799fffb4442a1b35c2b4fa03f211ed90b3b622dcd6d1ee592a7d396d7e0473e8a1
+  data.tar.gz: 8d41ad9933f4f6b610ded97d39e31c76006d427e82da9f7ac38f0c6c78860b0b0e592572c4458d8725fe61c930a2f1784e95a0d2c32def26402c7155bc5d76dd

data/Gemfile

@@ -25,12 +25,13 @@ group :test, :development do
   gem 'quiet_assets'
   gem "factory_girl_rails", "~>4.3"
   gem "faker"
+  gem 'post_office'
 end
 
-group :test, :development, :post_office do
-  gem 'dotenv'
-  gem 'post_office', "~>0.3"
-end
+#group :test, :development, :post_office do
+#  gem 'dotenv'
+#  gem 'post_office', "~>0.3"
+#end
 
 
 # Testing Gems

data/app/assets/stylesheets/mail_manager/admin.css

@@ -12,6 +12,15 @@ body {
   height: 85px;
   min-width: 766px;
 }
+
+.menu_expand {
+  cursor: pointer;
+}
+
+span.menu_expand:hover {
+  color: #fc6;
+}
+
 /*
 img {
    display: block;
@@ -129,7 +138,9 @@ table.list tr.even {
 	background: #e2e8d9;
 }
 
-
+.mailing_buttons {
+	width: 310px;
+}
 /* form labels have different alignment*/
 label {font-size: 11pt;
    font-family: helvetica, arial, sans-serif;
@@ -143,6 +154,10 @@ label {font-size: 11pt;
    padding: 7px 7px 0 0;
 }       
 
+.field {
+  clear: both;
+}
+
 input, select, textarea {
         margin: 6px 0;
         padding: 2px;
@@ -173,7 +188,7 @@ input.button {
     font-size: 11pt;
     font-weight: bold;
     color: #555;
-    margin-right: 10px;
+    margin-right: 5px;
     cursor: pointer; 
 }
 
@@ -210,7 +225,7 @@ a.button:link, a.button:visited {
     font-size: 11pt;
     font-weight: bold;
     color: #555;
-    margin-right: 10px;
+    margin-right: 5px;
     /* do I need this? */
     cursor: pointer; 
 }

data/app/models/mail_manager/mailable_registry.rb

@@ -75,6 +75,11 @@ module MailManager
       @@mailable_things.merge!({klass => methods})
     end
 
+    # unregister a mailable
+    def self.unregister(klass)
+      @@mailable_things.delete(klass)
+    end
+
 =begin rdoc
     Finds available mailable items by searching through all registered mailables, calling their finders and sorting by name.
 =end

data/app/models/mail_manager/mailer.rb

@@ -50,9 +50,10 @@ module MailManager
 
     class << self
       # send a mailing related to the message's data
-      def deliver_message(message)
+      def deliver_message(message, cached_parts=nil)
+        cached_parts ||= message.parts
         self.send_mail(message.subject,message.email_address_with_name,message.from_email_address,
-          message.parts,message.guid,message.mailing.include_images?)
+          cached_parts,message.guid,message.mailing.include_images?)
       end
 
       # create mailing; parsing html sources for images to attach/include

data/app/models/mail_manager/mailing.rb

@@ -16,7 +16,7 @@ completed - Mailing has been sent
 module MailManager
   class Mailing < ActiveRecord::Base
     self.table_name =  "#{MailManager.table_prefix}mailings"
-    has_many :messages, :class_name => 'MailManager::Message'
+    has_many :messages, :class_name => 'MailManager::Message', inverse_of: :mailing
     has_many :test_messages, :class_name => 'MailManager::TestMessage'
     has_many :bounces, :class_name => 'MailManager::Bounce'
     has_and_belongs_to_many :mailing_lists, :class_name => 'MailManager::MailingList', 
@@ -63,15 +63,14 @@ module MailManager
         end     
         change_status(:processing)
         initialize_messages
-        messages.pending.each do |message|
+        messages.pending.limit(MailManager.deliveries_per_run).each do |message|
           if reload.status.to_s != 'processing'
             Rails.logger.warn "Mailing #{id} is no longer in processing status it was changed to #{status} while running"
             return false
           end
 	        begin
-            # use the cached mailing parts, set messages mailing to self
-            message.mailing=self
-            message.deliver
+            # should use the cached mailing parts as mailing object for message should be the same as its caller
+            message.deliver(raw_parts)
 	        rescue => e
 	          message.result = "Error: #{e.message} - #{e.backtrace.join("\n")}"
 	          message.change_status(:failed)
@@ -79,13 +78,17 @@ module MailManager
           Rails.logger.debug "Sleeping #{MailManager.sleep_time_between_messages} before next message"
           sleep MailManager.sleep_time_between_messages
         end
-        change_status(:completed) if status.to_s.eql?('processing')
+        if messages.pending.count == 0
+          change_status(:completed) 
+        else
+          self.delay(run_at: [scheduled_at,Time.now.utc].max).deliver
+        end
       end
     end
   
     def mailable
       return @mailable if @mailable
-      return self unless mailable_type and mailable_id
+      return (@mailable=nil) if mailable_type.nil? or mailable_id.nil?
       @mailable = mailable_type.constantize.find(mailable_id)
     end
 
@@ -121,9 +124,10 @@ module MailManager
       @raw_parts ||= mailable.mailable_parts
     end
 
-    def parts(substitutions={})
+    def parts(substitutions={}, cached_parts=nil)
+      cached_parts ||= raw_parts
       parts = []
-      raw_parts.each do |type,source|
+      cached_parts.each do |type,source|
         parts << [type, Mailing.substitute_values(source.dup,substitutions)]
       end
       parts
@@ -133,6 +137,7 @@ module MailManager
       return if value.nil?
       self[:mailable_type] = value.class.name
       self[:mailable_id] = value.id
+      @mailable = value
     end
   
     def mailable_class_and_id=(value)
@@ -200,6 +205,7 @@ module MailManager
     end
 
     def can_run?
+       # processing is allowed for failed job reset and is OK since we lock around whole job
        ['scheduled','processing'].include?(status.to_s)
     end
   

data/app/models/mail_manager/mailing_list.rb

@@ -24,12 +24,14 @@ module MailManager
 
     attr_protected :id
 
+    # custom query to efficiently retrieve the active email addresses and contact ids and subscription ids for a 
+    # given list of mailing lists
     def self.active_email_addresses_contact_ids_subscription_ids_for_mailing_list_ids(mailing_list_ids)
       results = MailManager::MailingList.connection.execute(
         %Q|select c.email_address as email_address, c.id as contact_id, 
         s.id as subscription_id from #{MailManager.table_prefix}contacts c 
         inner join #{MailManager.table_prefix}subscriptions s on c.id=s.contact_id 
-        where s.status in ('active') and mailing_list_id in (#{
+        where s.status in ('active') and c.deleted_at is NULL and mailing_list_id in (#{
         mailing_list_ids.join(',')})|
       )
       results = results.map(&:values) if results.first.is_a?(Hash)
@@ -40,11 +42,12 @@ module MailManager
       }
     end
 
-    
+    # whether or not the mailing list has been soft deleted 
     def active?
       deleted_at.nil?
     end
     
+    # whether or not the mailing list has been soft deleted 
     def inactive?
       !active?
     end

data/app/models/mail_manager/message.rb

@@ -80,7 +80,7 @@ module MailManager
     end
 
     # sends the message through Mailer
-    def deliver
+    def deliver(cached_parts=nil)
       # lock only needed until status is updated
       Lock.with_lock("deliver_message_#{self.id}") do
         reload
@@ -90,7 +90,12 @@ module MailManager
           Rails.logger.warn "Message(#{self.id})'s is no longer suitable to deliver.. staus: #{status}"
         end
       end
-      MailManager::Mailer.deliver_message(self)
+      cached_parts = if cached_parts.present? 
+        mailing.parts(substitutions, cached_parts.dup)
+      else
+        parts
+      end
+      MailManager::Mailer.deliver_message(self,cached_parts)
       change_status(:sent)
     # allow other errors to bubble up
     rescue MailManager::LockException => e

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

@@ -3,7 +3,7 @@
 
 <%= form_tag mail_manager.bounces_path, :id => 'search_form', :method => 'GET' do %>
  <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 />
+  <label for="bounce_status">Status:</label><%= select_tag "bounce[status]", options_for_select([['Needs Attention','needs_manual_intervention'],['Dismissed','dismissed'],['Removed','removed'],['Unprocessed','unprocessed'],['Invalid','invalid'],['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>

data/lib/mail_manager/engine.rb

@@ -1,5 +1,7 @@
 module MailManager
   # set up accessors for configuration options from config/mail_manager.yml
+  # deliveries_per_run: how many emails to send per 'run' of a mailing job (it kicks off a new job after this number if more exist.. used to keep run time down)
+  mattr_accessor :deliveries_per_run
   # table_prefix: prefix for database table names to avoid collisions within another app
   mattr_accessor :table_prefix
   # secret: a secret for encrypting tokens and guids
@@ -163,6 +165,7 @@ module MailManager
       MailManager.table_prefix ||= 'mail_manager_'
     end
     MailManager.default_from_email_address ||= conf.default_from_email_address rescue nil
+    MailManager.deliveries_per_run ||= (conf.deliveries_per_run || 50) rescue 50
     MailManager.signup_email_address ||= conf.signup_email_address rescue nil
     MailManager.bounce ||= conf.bounce || {} rescue {}
     MailManager.unsubscribe_path ||= conf.unsubscribe_path || "/listmgr" rescue "/listmgr"

data/lib/mail_manager/version.rb

@@ -1,3 +1,3 @@
 module MailManager
-  VERSION = "3.2.6"
+  VERSION = "3.2.7"
 end

data/lib/tasks/mail_manager.rake

@@ -51,6 +51,7 @@ namespace :mail_manager do
 # roles_method: the method that your "current_user" object defines its role names(returns a list of strings)
 # unsubscribe_path: public url for unsubscribing ... this is a prefix and is followed by a message 'guid', defaults to '/listmgr' and routes as '/listmgr/:guid'
 # dont_include_images_domains: a list of domains that won't include images in the email, whether or not the mailing is set to include them
+# deliveries_per_run: how many messages do deliver for a mailing job 'per run' this keeps the job limited to a short run allowing other jobs to run as well for larger lists and for the job to possibly be more graceful on a delayed job stoppage.
 # sleep_time_between_messages: a timeout between messages to slow the output of emails to your email server; you should probably limit with your mail server itself if possible
 # path_prefix: a prefix to the mail manager routes(defaults to /admin)
 # table_prefix: prefixes all mail manager tables with a string to avoid collisions with your app - should be set BEFORE running migrations

data/mail_manager.gemspec

@@ -12,13 +12,6 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Manages the delivery of mailable items. Handles contacts, mailing lists, bounces, unsubscribe, opt-in, etc. Also available with a newsletter manager (including newsletter designs and elements management, wysiwyg newsletter editor, and newsletter archive) as well as user access control as part of the iReach gem.}
   gem.summary       = %q{Mailing list management tool}
   gem.homepage      = "http://ireachnews.com"
-  gem.post_install_message = <<-EOT
-    #** Mail Manager 3.2.6 messages **********************
-    #** Required Actions for every upgrade **
-      rake mail_manager:upgrade # this adds any new migrations and migrates your DB ...
-      #** NOTE! you should try this in development before pushing to your production site
-    #*END Mail Manager messages ********************
-  EOT
 
   gem.add_dependency "rails", "~>3.2"
   gem.add_dependency 'jquery-rails', "~>3.1"

data/spec/test_app/.env.test

@@ -1,2 +1,2 @@
-export POST_OFFICE_SMTP_PORT=25000
-export POST_OFFICE_POP_PORT=11000
+export POST_OFFICE_SMTP_PORT=25005
+export POST_OFFICE_POP_PORT=11005

data/spec/test_app/script/post_office

@@ -4,7 +4,7 @@ $:.push File.expand_path(File.join('..','..','lib'), __FILE__)
 
 require "rubygems"
 require "bundler"
-Bundler.setup(:post_office)
+Bundler.setup
 require 'post_office_manager'
 require 'dotenv'
 

data/spec/test_app/spec/features/mail_manager/bounce_spec.rb

@@ -20,6 +20,9 @@ RSpec.feature MailManager::Bounce do
         @bounce1 = FactoryGirl.create(:bounce, mailing_id: @mailing1.id, status: 'needs_manual_intervention') 
         @bounce2 = FactoryGirl.create(:bounce, mailing_id: @mailing2.id, status: 'resolved') 
         @bounce3 = FactoryGirl.create(:bounce, status: 'invalid') 
+        @bounce6 = FactoryGirl.create(:bounce, status: 'unprocessed') 
+        @bounce4 = FactoryGirl.create(:bounce, mailing_id: @mailing1.id, status: 'removed') 
+        @bounce5 = FactoryGirl.create(:bounce, mailing_id: @mailing1.id, status: 'dismissed') 
         @mailing1.reload
         @mailing2.reload
       end
@@ -27,14 +30,19 @@ RSpec.feature MailManager::Bounce do
         visit "/mail_manager/bounces"
         select "#{@mailing1.subject} (#{I18n.l @mailing1.status_changed_at}) (#{@mailing1.bounces.size})", from: "Mailing:"
         expect(page).to have_css("#view_bounce_#{@bounce1.id}", count: 1)
-        expect(page).to have_content("View",count: 1)
+        expect(page).to have_css("#view_bounce_#{@bounce4.id}", count: 1)
+        expect(page).to have_css("#view_bounce_#{@bounce5.id}", count: 1)
+        expect(page).to have_content("View",count: 3)
       end
       it "shows them all", js: true do
         visit "/mail_manager/bounces"
         expect(page).to have_css("#view_bounce_#{@bounce1.id}", count: 1)
         expect(page).to have_css("#view_bounce_#{@bounce2.id}", count: 1)
         expect(page).to have_css("#view_bounce_#{@bounce3.id}", count: 1)
-        expect(page).to have_content("View",count: 3)
+        expect(page).to have_css("#view_bounce_#{@bounce4.id}", count: 1)
+        expect(page).to have_css("#view_bounce_#{@bounce5.id}", count: 1)
+        expect(page).to have_css("#view_bounce_#{@bounce6.id}", count: 1)
+        expect(page).to have_content("View",count: 6)
       end
       it "filters by 'Needs Attention' status" do
         visit "/mail_manager/bounces"
@@ -48,9 +56,29 @@ RSpec.feature MailManager::Bounce do
         expect(page).to have_css("#view_bounce_#{@bounce2.id}", count: 1)
         expect(page).to have_content("View",count: 1)
       end
-      it "doesn't show 'invalid' status" do
+      it "filters by 'Removed' status" do
+        visit "/mail_manager/bounces"
+        select "Removed", from: "Status:"
+        expect(page).to have_css("#view_bounce_#{@bounce4.id}", count: 1)
+        expect(page).to have_content("View",count: 1)
+      end
+      it "filters by 'Dismissed' status" do
+        visit "/mail_manager/bounces"
+        select "Dismissed", from: "Status:"
+        expect(page).to have_css("#view_bounce_#{@bounce5.id}", count: 1)
+        expect(page).to have_content("View",count: 1)
+      end
+      it "filters by 'Invalid' status" do
         visit "/mail_manager/bounces"
-        expect{select "Invalid", from: "Status:"}.to raise_error
+        select "Invalid", from: "Status:"
+        expect(page).to have_css("#view_bounce_#{@bounce3.id}", count: 1)
+        expect(page).to have_content("View",count: 1)
+      end
+      it "filters by 'Unprocessed' status" do
+        visit "/mail_manager/bounces"
+        select "Unprocessed", from: "Status:"
+        expect(page).to have_css("#view_bounce_#{@bounce6.id}", count: 1)
+        expect(page).to have_content("View",count: 1)
       end
       it "filters by 'Resolved' status and mailing" do
         visit "/mail_manager/bounces"

data/spec/test_app/spec/models/mail_manager/mailing_list_spec.rb

@@ -49,6 +49,23 @@ RSpec.describe MailManager::MailingList do
           }
         }.sort
       ) 
+      and_it "doesn't include soft deleted contacts" do
+        contact2.delete
+        expect(MailManager::MailingList.
+          active_email_addresses_contact_ids_subscription_ids_for_mailing_list_ids(
+          [list1.id, list2.id]).sort).to eq (
+          {
+            contact1.email_address => {
+              contact_id: contact1.id,
+              subscription_id: sub1.id
+            },
+            contact3.email_address => {
+              contact_id: contact3.id,
+              subscription_id: sub4.id
+            }
+          }.sort
+        ) 
+      end
     end
   end
 end

data/spec/test_app/spec/models/mail_manager/mailing_spec.rb

@@ -1,5 +1,17 @@
 require 'rails_helper'
 
+class MyMailable < MailManager::Mailable
+  cattr_accessor :mailable_parts_call_count
+  def initialize(*args)
+    @@mailable_parts_call_count = 0
+    super
+  end
+
+  def mailable_parts
+    @@mailable_parts_call_count += 1
+    super
+  end
+end
 RSpec.describe MailManager::Mailing do
   let(:valid_attributes) {FactoryGirl.attributes_for(:mailing)}
   let(:invalid_attributes) {FactoryGirl.attributes_for(:mailing).delete(
@@ -15,11 +27,6 @@ RSpec.describe MailManager::Mailing do
     mailing.change_status(:processing)
     expect(mailing.can_run?).to be true
   end
-  it "allows a processing mailing to run(for resetting a failed job)" do
-    mailing = MailManager::Mailing.create(valid_attributes)
-    mailing.change_status(:processing)
-    expect(mailing.can_run?).to be true
-  end
   it "sets its initial status properly" do
     attributes = valid_attributes
     attributes.delete('status')
@@ -107,4 +114,59 @@ RSpec.describe MailManager::Mailing do
       [contact1,contact2].map(&:email_address).sort
     )
   end
+
+  context "when sending a mailing" do
+    before(:each) do
+      if MailManager.register_generic_mailable
+        MailManager::MailableRegistry.register('MyMailable',{
+          :find_mailables => :all,
+          :name => :name,
+          :parts => [
+            ['text/plain', :email_text],
+            ['text/html', :email_html]
+        ]
+        })
+      end
+      Delayed::Worker.delay_jobs = true
+      @list = FactoryGirl.create(:mailing_list)
+      @contacts = FactoryGirl.create_list(:contact,random_int(4,10))
+      @contacts.each{|c| c.subscribe(@list)}
+      @mailable = MyMailable.create(FactoryGirl.attributes_for(:mailable))
+      @mailing = FactoryGirl.create(:mailing, mailable: @mailable)
+      @mailing.mailable = @mailable
+      @mailing.mailing_lists << @list
+      @mailing.schedule
+    end
+    after(:each) do
+      Delayed::Worker.delay_jobs = false
+      MailManager::MailableRegistry.unregister('MyMailable')
+    end
+    it "caches its mailable for use between messages" do
+      MyMailable.mailable_parts_call_count = 0
+      @mailing.deliver
+      expect(MyMailable.mailable_parts_call_count).to eq 1
+    end
+
+    it "sends a specified number of messages per job" do
+      expect(Delayed::Job.count).to eq 1
+      expect(MailManager.deliveries_per_run).to be > 0
+      MailManager.deliveries_per_run = 2
+      ActionMailer::Base.deliveries.clear
+      @mailing.deliver
+      expect(@mailing.status.to_s).to eq 'processing'
+      expect(Delayed::Job.count).to eq 2
+      expect(ActionMailer::Base.deliveries.count).to eq 2
+      expect(@mailing.messages.pending.count).to eq (@contacts.count - 2)
+    end
+    it 'finishes the mailing' do
+      MailManager.deliveries_per_run = 2
+      ActionMailer::Base.deliveries.clear
+      while ['scheduled','processing'].include?(@mailing.status) do
+        @mailing.deliver
+      end
+      expect(Delayed::Job.count).to eq (@contacts.count/2.0).ceil
+      expect(@mailing.status.to_s).to eq 'completed'
+      expect(ActionMailer::Base.deliveries.count).to eq @contacts.count
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail_manager
 version: !ruby/object:Gem::Version
-  version: 3.2.6
+  version: 3.2.7
 platform: ruby
 authors:
 - Lone Star Internet
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -506,12 +506,7 @@ homepage: http://ireachnews.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: |2
-      #** Mail Manager 3.2.6 messages **********************
-      #** Required Actions for every upgrade **
-        rake mail_manager:upgrade # this adds any new migrations and migrates your DB ...
-        #** NOTE! you should try this in development before pushing to your production site
-      #*END Mail Manager messages ********************
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib