mlist 0.1.9

data/spec/models/email_post_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe MList::EmailPost do
+  before do
+    @subscriber = MList::EmailSubscriber.new('john@example.com')
+    @post = MList::EmailPost.new({
+      :subscriber => @subscriber,
+      :subject => "I'm a Program!",
+      :text => "My simple message that isn't too short"
+    })
+  end
+  
+  it 'should include html and text when both provided' do
+    @post.html = '<p>My simple message</p>'
+    
+    tmail = @post.to_tmail
+    tmail.content_type.should == 'multipart/alternative'
+    tmail.parts.size.should == 2
+    
+    # The first part should be the least desirable...
+    part = tmail.parts.first
+    part.content_type.should == 'text/plain'
+    
+    # And the last should be the best alternative.
+    part = tmail.parts.last
+    part.content_type.should == 'text/html'
+  end
+  
+  it "should default the mailer to 'MList Client Application'" do
+    @post.to_tmail['x-mailer'].to_s.should == 'MList Client Application'
+  end
+  
+  it 'should use the given mailer' do
+    @post.mailer = 'My Program'
+    @post.to_tmail['x-mailer'].to_s.should == 'My Program'
+  end
+  
+  it 'should use the given subject' do
+    @post.subject.should == "I'm a Program!"
+    @post.to_tmail.subject.should == "I'm a Program!"
+    
+    @post.subject = 'My Program'
+    @post.subject.should == 'My Program'
+    @post.to_tmail.subject.should == 'My Program'
+  end
+  
+  it 'should assign the identifier it is in-reply-to and references' do
+    message = MList::Message.new
+    stub(message).identifier { 'blahblah@example.com' }
+    @post.reply_to_message = message
+    @post.to_tmail.in_reply_to.should == ["<blahblah@example.com>"]
+    @post.to_tmail.references.should == ["<blahblah@example.com>"]
+  end
+  
+  it 'should include the subscriber display name in the from address if subscriber supports it' do
+    stub(@subscriber).display_name { 'Johnny' }
+    @post.to_tmail['from'].to_s.should == "Johnny <john@example.com>"
+  end
+end
+
+describe MList::EmailPost, 'validations' do
+  before do
+    subscriber = MList::EmailSubscriber.new('john@example.com')
+    @post = MList::EmailPost.new({
+      :subscriber => subscriber,
+      :subject => "I'm a Program!",
+      :text => "My simple message that isn't too short"
+    })
+  end
+  
+  it 'should be valid with subject and a few words' do
+    @post.should be_valid
+  end
+  
+  it 'should require text' do
+    @post.text = ''
+    @post.should_not be_valid
+    @post.errors[:text].should_not be_nil
+  end
+  
+  it 'should require at least 25 characters of text' do
+    @post.text = 'A' * 24
+    @post.should_not be_valid
+    @post.errors[:text].should_not be_nil
+    
+    @post.text = 'A' * 25
+    @post.should be_valid
+    @post.errors[:text].should be_nil
+  end
+  
+  it 'should require subject' do
+    @post.subject = ''
+    @post.should_not be_valid
+    @post.errors[:subject].should_not be_nil
+  end
+  
+  it 'should not fail to work when asked to generate error messages' do
+    @post.errors.add(:text)
+  end
+end

data/spec/models/email_server/base_spec.rb

@@ -0,0 +1,11 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe MList::EmailServer::Base do
+  before do
+    @email_server = MList::EmailServer::Fake.new(:domain => 'test.host')
+  end
+  
+  it 'should provide unique message id generator' do
+    @email_server.generate_message_id.should match(/([a-f0-9]+-){4,}[a-f0-9]+@test.host/)
+  end
+end

data/spec/models/email_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe MList::Email do
+  before do
+    @tmail = tmail_fixture('single_list')
+    @email = MList::Email.new(:tmail => @tmail)
+  end
+  
+  it 'should downcase the from address' do
+    @tmail.from = 'ALL_Down_CaSe@NOmail.NET'
+    @email.from_address.should == 'all_down_case@nomail.net'
+  end
+  
+  it 'should downcase list addresses' do
+    @tmail.to = 'ALL_Down_CaSe@NOmail.NET, ALL_Down_CaSe@YESmail.NET'
+    @email.list_addresses.should == %w(all_down_case@nomail.net all_down_case@yesmail.net)
+  end
+  
+  it 'should handle @ in label of addresses' do
+    @tmail = tmail_fixture('at_in_address_label')
+    @email = MList::Email.new(:tmail => @tmail)
+    @email.list_addresses.should == %w(whatever@yesmail.net)
+  end
+  
+  it 'should include the cc field in list addresses, no duplicates' do
+    @tmail.to = 'list_one@example.com'
+    @tmail.cc = 'list_one@example.com, list_two@example.com'
+    @email.list_addresses.should == %w(list_one@example.com list_two@example.com)
+  end
+  
+  it 'should answer the subject of the email' do
+    @email.subject.should == 'Test'
+  end
+  
+  it 'should be careful to save true source of email' do
+    @email = MList::Email.new(:tmail => tmail_fixture('embedded_content'))
+    @email.save!
+    @email.reload.source.should == email_fixture('embedded_content')
+  end
+  
+  it 'should answer the Date of the email, created_at otherwise' do
+    @email.date.should == Time.parse('Mon, 15 Dec 2008 00:38:31 -0500')
+    
+    @tmail['date'] = nil
+    stub(Time).now { Time.local(2009,1,1) }
+    @email.date.should == Time.local(2009,1,1)
+    
+    stub(Time).now { Time.local(2009,3,1) }
+    @email.date.should == Time.local(2009,1,1)
+    
+    @email.created_at = Time.local(2009,2,1)
+    @email.date.should == Time.local(2009,2,1)
+  end
+end

data/spec/models/mail_list_spec.rb

@@ -0,0 +1,469 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe MList::MailList do
+  class ManagerList
+    include MList::List
+  end
+  
+  before do
+    @manager_list = ManagerList.new
+    stub(@manager_list).label       {'Discussions'}
+    stub(@manager_list).address     {'list_one@example.com'}
+    stub(@manager_list).list_id     {'list_one@example.com'}
+    
+    @subscriber_one = MList::EmailSubscriber.new('adam@nomail.net')
+    @subscriber_two = MList::EmailSubscriber.new('john@example.com')
+    stub(@manager_list).subscribers {[@subscriber_one, @subscriber_two]}
+    
+    @outgoing_server = MList::EmailServer::Fake.new
+    @mail_list = MList::MailList.create!(
+      :manager_list => @manager_list,
+      :outgoing_server => @outgoing_server)
+  end
+  
+  it 'should not require the manager list be an ActiveRecord type' do
+    @mail_list.list.should == @manager_list
+    @mail_list.manager_list.should be_nil
+  end
+  
+  it 'should have messages counted' do
+    MList::Message.reflect_on_association(:mail_list).counter_cache_column.should == :messages_count
+    MList::MailList.column_names.should include('messages_count')
+  end
+  
+  it 'should have threads counted' do
+    MList::Thread.reflect_on_association(:mail_list).counter_cache_column.should == :threads_count
+    MList::MailList.column_names.should include('threads_count')
+  end
+  
+  it 'should delete email not referenced by other lists' do
+    email_in_other = MList::Email.create!(:tmail => tmail_fixture('single_list'))
+    email_not_other = MList::Email.create!(:tmail => tmail_fixture('single_list'))
+    lambda do
+      MList::Message.create!(:mail_list_id => 2342342, :email => email_in_other)
+      @mail_list.process_email(email_in_other, @subscriber_one)
+      @mail_list.process_email(email_not_other, @subscriber_one)
+    end.should change(MList::Message, :count).by(3)
+    @mail_list.destroy
+    MList::Email.exists?(email_in_other).should be_true
+    MList::Email.exists?(email_not_other).should be_false
+  end
+  
+  describe 'post' do
+    it 'should allow posting a new message to the list' do
+      lambda do
+        lambda do
+          @mail_list.post(
+            :subscriber => @subscriber_one,
+            :subject => "I'm a Program!",
+            :text => 'Are you a programmer or what?'
+          )
+        end.should change(MList::Message, :count).by(1)
+      end.should change(MList::Thread, :count).by(1)
+      
+      tmail = @outgoing_server.deliveries.last
+      tmail.subject.should =~ /I'm a Program!/
+      tmail.from.should == ['adam@nomail.net']
+    end
+    
+    it 'should answer the message for use by the application' do
+      @mail_list.post(
+        :subscriber => @subscriber_one,
+        :subject => "I'm a Program!",
+        :text => 'Are you a programmer or what?'
+      ).should be_instance_of(MList::Message)
+    end
+    
+    it 'should allow posting a reply to an existing message' do
+      @mail_list.process_email(MList::Email.new(:tmail => tmail_fixture('single_list')), @subscriber_one)
+      existing_message = @mail_list.messages.last
+      lambda do
+        lambda do
+          @mail_list.post(
+            :reply_to_message => existing_message,
+            :subscriber => @subscriber_one,
+            :text => 'I am a programmer too, dude!'
+          )
+        end.should change(MList::Message, :count).by(1)
+      end.should_not change(MList::Thread, :count)
+      new_message = MList::Message.last
+      new_message.subject.should == "Re: Test"
+    end
+    
+    it 'should not associate a posting to a parent if not reply' do
+      @mail_list.process_email(MList::Email.new(:tmail => tmail_fixture('single_list')), @subscriber_one)
+      lambda do
+        lambda do
+          @mail_list.post(
+            :subscriber => @subscriber_one,
+            :subject => 'Test',
+            :text => 'It is up to the application to provide reply_to'
+          )
+        end.should change(MList::Message, :count).by(1)
+      end.should change(MList::Thread, :count).by(1)
+      message = MList::Message.last
+      message.parent.should be_nil
+      message.parent_identifier.should be_nil
+    end
+    
+    it 'should capture the message-id of delivered email' do
+      message = @mail_list.post(
+        :subscriber => @subscriber_one,
+        :subject => 'Test',
+        :text => 'Email must have a message id for threading')
+      message.reload.identifier.should_not be_nil
+    end
+    
+    it 'should copy the subscriber if desired' do
+      @mail_list.post(
+        :subscriber => @subscriber_one,
+        :subject => 'Copy Me',
+        :text => 'Email should be sent to subscriber if desired',
+        :copy_sender => true)
+        
+      tmail = @outgoing_server.deliveries.last
+      tmail.bcc.should include(@subscriber_one.email_address)
+    end
+    
+    it 'should not copy the subscriber if undesired and list includes the subscriber' do
+      # The MList::List implementor may include the sending subscriber
+      stub(@manager_list).recipients {[@subscriber_one, @subscriber_two]}
+      
+      @mail_list.post(
+        :subscriber => @subscriber_one,
+        :subject => 'Do Not Copy Me',
+        :text => 'Email should not be sent to subscriber if undesired',
+        :copy_sender => false)
+        
+      tmail = @outgoing_server.deliveries.last
+      tmail.bcc.should_not include(@subscriber_one.email_address)
+    end
+  end
+  
+  describe 'message storage' do
+    def process_post
+      @mail_list.process_email(MList::Email.new(:tmail => @post_tmail), @subscriber)
+      MList::Message.last
+    end
+    
+    before do
+      @post_tmail = tmail_fixture('single_list')
+      @subscriber = @subscriber_one
+    end
+    
+    it 'should not include list label in subject' do
+      @post_tmail.subject = '[Discussions] Test'
+      process_post.subject.should == 'Test'
+    end
+    
+    it 'should not include list label in reply subject' do
+      @post_tmail.subject = 'Re: [Discussions] Test'
+      process_post.subject.should == 'Re: Test'
+    end
+    
+    it 'should not bother labels it does not understand in subject' do
+      @post_tmail.subject = '[Ann] Test'
+      process_post.subject.should == '[Ann] Test'
+    end
+    
+    it 'should not bother labels it does not understand in reply subject' do
+      @post_tmail.subject = 'Re: [Ann] Test'
+      process_post.subject.should == 'Re: [Ann] Test'
+    end
+    
+    it 'should be careful of multiple re:' do
+      @post_tmail.subject = 'Re: [Ann] RE: Test'
+      process_post.subject.should == 'Re: [Ann] Test'
+    end
+  end
+  
+  describe 'finding parent message' do
+    def email(path)
+      MList::Email.new(:tmail => tmail_fixture(path))
+    end
+    
+    before do
+      @parent_message = MList::Message.new
+    end
+    
+    it 'should be nil if none found' do
+      do_not_call(@mail_list.messages).find
+      @mail_list.find_parent_message(email('single_list')).should be_nil
+    end
+    
+    it 'should use in-reply-to field when present' do
+      mock(@mail_list.messages).find(:first, :conditions => [
+        'identifier = ?', 'F5F9DC55-CB54-4F2C-9B46-A05F241BCF22@recursivecreative.com'
+        ]) { @parent_message }
+      @mail_list.find_parent_message(email('single_list_reply')).should == @parent_message
+    end
+    
+    it 'should be references field if present and no in-reply-to' do
+      tmail = tmail_fixture('single_list_reply')
+      tmail['in-reply-to'] = nil
+      mock(@mail_list.messages).find(:first,
+        :conditions => ['identifier in (?)', ['F5F9DC55-CB54-4F2C-9B46-A05F241BCF22@recursivecreative.com']],
+        :order => 'created_at desc') { @parent_message }
+      @mail_list.find_parent_message(MList::Email.new(:tmail => tmail)).should == @parent_message
+    end
+    
+    describe 'by subject' do
+      def search_subject(subject = nil)
+        simple_matcher("search by the subject '#{subject}'") do |email|
+          if subject
+            mock(@mail_list.messages).find(
+              :first,
+              :conditions => ['subject = ?', subject],
+              :order => 'created_at asc'
+            ) {@parent_message}
+          else
+            do_not_call(@mail_list.messages).find
+          end
+          @mail_list.find_parent_message(email)
+          !subject.nil?
+        end
+      end
+      
+      before do
+        @parent_message = MList::Message.new
+        @mail_list = MList::MailList.new
+        stub(@mail_list).label { 'list name' }
+        @reply_tmail = tmail_fixture('single_list')
+        @reply_email = MList::Email.new(:tmail => @reply_tmail)
+      end
+      
+      it 'should be employed if it has "re:" in it' do
+        @reply_tmail.subject = "Re: Test"
+        @reply_email.should search_subject('Test')
+      end
+      
+      it 'should not be employed when no "re:"' do
+        @reply_email.should_not search_subject
+      end
+      
+      ['RE: [list name] Re: Test', 'Re: [list name] Re: [list name] Test', '[list name] Re: Test'].each do |subject|
+        it "should handle '#{subject}'" do
+          @reply_tmail.subject = subject
+          @reply_email.should search_subject('Test')
+        end
+      end
+    end
+  end
+  
+  describe 'delivery' do
+    include MList::Util::EmailHelpers
+    
+    def process_post
+      @mail_list.process_email(MList::Email.new(:source => @post_tmail.to_s), @subscriber)
+      @outgoing_server.deliveries.last
+    end
+    
+    before do
+      @post_tmail = tmail_fixture('single_list')
+      @subscriber = @subscriber_one
+    end
+    
+    it 'should be blind copied to recipients' do
+      mock.proxy(@mail_list.messages).build(anything) do |message|
+        mock(message.delivery).bcc=(%w(john@example.com))
+        message
+      end
+      process_post
+    end
+    
+    it 'should not deliver to addresses found in the to header' do
+      @post_tmail.to = ['john@example.com', 'list_one@example.com']
+      mock.proxy(@mail_list.messages).build(anything) do |message|
+        mock(message.delivery).bcc=([])
+        message
+      end
+      process_post
+    end
+    
+    it 'should not deliver to addresses found in the cc header' do
+      @post_tmail.cc = ['john@example.com']
+      mock.proxy(@mail_list.messages).build(anything) do |message|
+        mock(message.delivery).bcc=([])
+        message
+      end
+      process_post
+    end
+    
+    it 'should use list address as reply-to by default' do
+      process_post.should have_header('reply-to', 'Discussions <list_one@example.com>')
+    end
+    
+    it 'should use subscriber address as reply-to if list says to not use address' do
+      mock(@manager_list).reply_to_list? { false }
+      process_post.should have_header('reply-to', 'adam@nomail.net')
+    end
+    
+    it 'should use the reply-to already in an email - should not override it' do
+      @post_tmail['reply-to'] = 'theotheradam@nomail.net'
+      process_post.should have_header('reply-to', 'theotheradam@nomail.net')
+    end
+    
+    it 'should set x-beenthere on emails it delivers to keep from re-posting them' do
+      process_post.should have_header('x-beenthere', 'list_one@example.com')
+    end
+    
+    it 'should not remove any existing x-beenthere headers' do
+      @post_tmail['x-beenthere'] = 'somewhere@nomail.net'
+      process_post.should have_header('x-beenthere', %w(list_one@example.com somewhere@nomail.net))
+    end
+    
+    it 'should not modify existing headers' do
+      @post_tmail['x-something-custom'] = 'existing'
+      process_post.should have_header('x-something-custom', 'existing')
+    end
+    
+    it 'should delete Return-Receipt-To headers since they cause clients to spam the list (the sender address)' do
+      @post_tmail['return-receipt-to'] = 'somewhere@nomail.net'
+      process_post.should_not have_header('return-receipt-to')
+    end
+    
+    it 'should not have any cc addresses' do
+      @post_tmail['cc'] = 'billybob@anywhere.com'
+      process_post.should_not have_header('cc')
+    end
+    
+    it 'should prefix the list label to the subject of messages' do
+      process_post.subject.should == '[Discussions] Test'
+    end
+    
+    it 'should move the list label to the front of subjects that already include the label' do
+      @post_tmail.subject = 'Re: [Discussions] Test'
+      process_post.subject.should == 'Re: [Discussions] Test'
+    end
+    
+    it 'should remove multiple occurrences of Re:' do
+      @post_tmail.subject = 'Re: [Discussions] Re: Test'
+      process_post.subject.should == 'Re: [Discussions] Test'
+    end
+    
+    it 'should remove DomainKey-Signature headers so that we can sign the redistribution' do
+      @post_tmail['DomainKey-Signature'] = "a whole bunch of junk"
+      process_post.should_not have_header('domainkey-signature')
+    end
+    
+    it 'should remove DKIM-Signature headers so that we can sign the redistribution' do
+      @post_tmail['DKIM-Signature'] = "a whole bunch of junk"
+      process_post.should_not have_header('dkim-signature')
+    end
+    
+    it 'should capture the new message-ids' do
+      delivered = process_post
+      delivered.header_string('message-id').should_not be_blank
+      MList::Message.last.identifier.should == remove_brackets(delivered.header_string('message-id'))
+      delivered.header_string('message-id').should_not match(/F5F9DC55-CB54-4F2C-9B46-A05F241BCF22@recursivecreative\.com/)
+    end
+    
+    it 'should maintain the content-id part headers (inline images, etc)' do
+      @post_tmail = tmail_fixture('embedded_content')
+      process_post.parts[1].parts[1]['content-id'].to_s.should == "<CF68EC17-F8ED-478A-A4A1-AEBF165A8830/bg_pattern.jpg>"
+    end
+    
+    it 'should add standard list headers when they are available' do
+      stub(@manager_list).help_url        {'http://list_manager.example.com/help'}
+      stub(@manager_list).subscribe_url   {'http://list_manager.example.com/subscribe'}
+      stub(@manager_list).unsubscribe_url {'http://list_manager.example.com/unsubscribe'}
+      stub(@manager_list).owner_url       {"<mailto:list_manager@example.com>\n(Jimmy Fish)"}
+      stub(@manager_list).archive_url     {'http://list_manager.example.com/archive'}
+      
+      tmail = process_post
+      tmail.should have_headers(
+        'list-id'          => "<list_one@example.com>",
+        'list-help'        => "<http://list_manager.example.com/help>",
+        'list-subscribe'   => "<http://list_manager.example.com/subscribe>",
+        'list-unsubscribe' => "<http://list_manager.example.com/unsubscribe>",
+        'list-post'        => "<list_one@example.com>",
+        'list-owner'       => '<mailto:list_manager@example.com>(Jimmy Fish)',
+        'list-archive'     => "<http://list_manager.example.com/archive>",
+        'errors-to'        => '"Discussions" <mlist-list_one@example.com>',
+        # I couldn't get tmail to quote 'Discussions', so apostrophe's would break smtp
+        'sender'           => 'mlist-list_one@example.com'
+      )
+      tmail.header_string('x-mlist-version').should =~ /\d+\.\d+\.\d+/
+    end
+    
+    it 'should not add list headers that are not available or nil' do
+      stub(@manager_list).help_url {nil}
+      delivery = process_post
+      delivery.should_not have_header('list-help')
+      delivery.should_not have_header('list-subscribe')
+    end
+    
+    it 'should append the list footer to text/plain emails' do
+      @post_tmail.body = "My Email\n\n\n\n\n"
+      mock(@manager_list).footer_content(is_a(MList::Message)) { 'my footer' }
+      process_post.body.should == "My Email\n\n\n\n\n#{MList::MailList::FOOTER_BLOCK_START}\nmy footer\n#{MList::MailList::FOOTER_BLOCK_END}"
+    end
+    
+    it 'should append the list footer to multipart/alternative, text/plain part of emails' do
+      @post_tmail = tmail_fixture('content_types/multipart_alternative_simple')
+      mock(@manager_list).footer_content(is_a(MList::Message)) { 'my footer' }
+      process_post.parts[0].body.should match(/#{MList::MailList::FOOTER_BLOCK_START}\nmy footer\n#{MList::MailList::FOOTER_BLOCK_END}/)
+    end
+    
+    it 'should handle whitespace well when appending footer' do
+      @post_tmail.body = "My Email"
+      mock(@manager_list).footer_content(is_a(MList::Message)) { 'my footer' }
+      process_post.body.should == "My Email\n\n#{MList::MailList::FOOTER_BLOCK_START}\nmy footer\n#{MList::MailList::FOOTER_BLOCK_END}"
+    end
+    
+    it 'should strip out any existing footers from the list' do
+      mock(@manager_list).footer_content(is_a(MList::Message)) { 'my footer' }
+      @post_tmail.body = %{My Email
+
+>  >  #{MList::MailList::FOOTER_BLOCK_START}
+>     >  content at front shouldn't matter
+>      >  #{MList::MailList::FOOTER_BLOCK_END}
+
+>>  #{MList::MailList::FOOTER_BLOCK_START}
+>>  this is fine to be removed
+>>  #{MList::MailList::FOOTER_BLOCK_END}
+
+#{MList::MailList::FOOTER_BLOCK_START}
+this is without any in front
+#{MList::MailList::FOOTER_BLOCK_END}
+      }
+      process_post.body.should == "My Email\n\n#{MList::MailList::FOOTER_BLOCK_START}\nmy footer\n#{MList::MailList::FOOTER_BLOCK_END}"
+    end
+    
+    describe 'time' do
+      include TMail::TextUtils
+      
+      before do
+        @old_zone_default = Time.zone_default
+        @system_time = Time.parse('Thu, 2 Apr 2009 15:22:04')
+        mock(Time).now.times(any_times) { @system_time }
+      end
+      
+      after do
+        Time.zone_default = @old_zone_default
+      end
+      
+      it 'should keep date of email post' do
+        @post_tmail['date'] = 'Thu, 2 Apr 2009 15:22:04 -0400'
+        process_post.header_string('date').should == 'Thu, 2 Apr 2009 15:22:04 -0400'
+      end
+      
+      it 'should store the delivery time as created_at of message record' do
+        Time.zone_default = 'Pacific Time (US & Canada)'
+        @post_tmail['date'] = 'Wed, 1 Apr 2009 15:22:04 -0400'
+        process_post.header_string('date').should == 'Wed, 1 Apr 2009 15:22:04 -0400'
+        MList::Message.last.created_at.should == @system_time
+      end
+      
+      # I think that what TMail is doing is evil, but it's reference to
+      # a ruby-talk discussion leads to Japanese, which I cannot read.
+      # I'd prefer that it leave the problem of timezones up to the client,
+      # especially since ActiveSupport does an EXCELLENT job of making
+      # time zones not hurt so much.
+      it 'should use the Time.now (zone of the machine) for date header' do
+        @post_tmail['date'] = nil
+        process_post.header_string('date').should == time2str(@system_time)
+      end
+    end
+  end
+end