multi_mail 0.0.2 → 0.1.0

data/spec/postmark/receiver_spec.rb

@@ -20,7 +20,7 @@ describe MultiMail::Receiver::Postmark do
         # Headers
         message.date.should    == DateTime.parse('Mon, 15 Apr 2013 20:20:12 -0400')
         message.from.should    == ['james@opennorth.ca']
-        message.to.should      == ['4354473e2e6ab001fa836f627a54004e@inbound.postmarkapp.com']
+        message.to.should      == ['4354473e2e6ab001fa836f627a54004e+bar@inbound.postmarkapp.com']
         message.subject.should == 'Test'
 
         # Body
@@ -39,8 +39,8 @@ describe MultiMail::Receiver::Postmark do
         attachment1.read.should == "Nam accumsan euismod eros et rhoncus.\n"
 
         # Extra Postmark parameters
-        message['MailboxHash'].should be_nil
-        message['MessageID'].value.should == '61c7c8b8-ba7e-43c3-b9ad-0ba865e8caa2'
+        message['MailboxHash'].value.should == 'bar'
+        message['MessageID'].value.should == 'e27500eb-142e-4ca0-8529-e32ffd9931d6'
         message['Tag'].should be_nil
       end
     end
@@ -56,5 +56,5 @@ describe MultiMail::Receiver::Postmark do
         service.spam?(message).should == false
       end
     end
-  end  
+  end
 end

data/spec/postmark/sender_spec.rb

@@ -0,0 +1,118 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/postmark/sender'
+
+# @see https://github.com/wildbit/postmark-gem/blob/master/spec/unit/postmark/handlers/mail_spec.rb
+# @see https://github.com/wildbit/postmark-gem/blob/master/spec/integration/mail_delivery_method_spec.rb
+describe MultiMail::Sender::Postmark do
+  let :message do
+    Mail.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_without_from do
+    Mail.new do
+      date    Time.at(946702800)
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_without_to do
+    Mail.new do
+      date    Time.at(946702800)
+      from    'foo@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_without_subject do
+    Mail.new do
+      date    Time.at(946702800)
+      from    'foo@example.com'
+      to      'bar@example.com'
+      body    'hello'
+    end
+  end
+
+  let :message_without_body do
+    Mail.new do
+      date    Time.at(946702800)
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+    end
+  end
+
+  describe '#initialize' do
+    it 'should raise an error if :api_key is missing' do
+      expect{
+        message.delivery_method MultiMail::Sender::Postmark
+        message.deliver
+      }.to raise_error(ArgumentError, "Missing required arguments: api_key")
+    end
+
+    it 'should raise an error if :api_key is nil' do
+      expect{
+        message.delivery_method MultiMail::Sender::Postmark, :api_key => nil
+        message.deliver
+      }.to raise_error(ArgumentError, "Missing required arguments: api_key")
+    end
+
+    it 'should raise an error if :api_key is invalid' do
+      expect{
+        message.delivery_method MultiMail::Sender::Postmark, :api_key => 'xxx'
+        message.deliver
+      }.to raise_error(MultiMail::InvalidAPIKey, 'Bad or missing server or user API token.')
+    end
+  end
+
+  describe '#deliver' do
+    before :all do
+      Mail.defaults do
+        delivery_method MultiMail::Sender::Postmark, :api_key => 'POSTMARK_API_TEST'
+      end
+    end
+
+    it 'should send a message' do
+      message.deliver.should == message
+      message['Message-ID'].should_not be_nil # postmark gem
+    end
+  end
+
+  describe '#deliver!' do
+    before :all do
+      Mail.defaults do
+        delivery_method MultiMail::Sender::Postmark, :api_key => 'POSTMARK_API_TEST', :return_response => true
+      end
+    end
+
+    it 'should send a message' do
+      result = message.deliver!
+      result.size.should == 10 # string keys are deprecated
+
+      Time.parse(result[:submitted_at]).should be_within(1).of(Time.now)
+      result[:to].should == "bar@example.com"
+      result[:message_id].should match(/\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/)
+      result[:error_code].should == 0
+      result[:message].should == 'Test job accepted'
+    end
+
+    it 'should not send a message without a From header' do
+      expect{message_without_from.deliver!}.to raise_error(MultiMail::MissingSender, "Invalid 'From' value.")
+    end
+
+    it 'should not send a message without a To header' do
+      expect{message_without_to.deliver!}.to raise_error(MultiMail::MissingRecipients, 'Zero recipients specified')
+    end
+
+    it 'should not send a message without a body' do
+      expect{message_without_body.deliver!}.to raise_error(MultiMail::MissingBody, 'Provide either email TextBody or HtmlBody or both.')
+    end
+  end
+end

data/spec/receiver/base_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe MultiMail::Receiver::Base do
   let :klass do
-    Class.new(MultiMail::Service) do
+    Class.new do
       include MultiMail::Receiver::Base
 
       def valid?(params)
@@ -36,29 +36,36 @@ describe MultiMail::Receiver::Base do
   end
 
   describe '#parse' do
+    let :expected do
+      {'foo' => '1', 'bar' => ['1', '1']}
+    end
+
     it 'should parse JSON' do
-      klass.parse('{"foo":1,"bar":1,"bar":1}').should == {'foo' => 1, 'bar' => 1}
+      klass.parse('{"foo":"1","bar":["1","1"]}').should == expected
     end
 
     it 'should parse raw POST data' do
-      klass.parse('foo=1&bar=1&bar=1').should == {'foo' => '1', 'bar' => ['1', '1']}
+      klass.parse('foo=1&bar=1&bar=1').should == expected
     end
 
     it 'should accept an array' do
-      klass.parse([['foo', 1], ['bar', [1, 1]]]).should == {'foo' => 1, 'bar' => [1, 1]}
-    end
-
-    it 'should accept a Rack::Request object' do
-      klass.parse(Rack::Request.new(Rack::MockRequest.env_for('/?foo=1&bar[]=1&bar[]=1'))).should == {'foo' => '1', 'bar' => ['1', '1']}
+      klass.parse([['foo', '1'], ['bar', ['1', '1']]]).should == expected
     end
 
     it 'should pass-through a hash' do
-      klass.parse('foo' => 1).should == {'foo' => 1}
+      klass.parse({'foo' => '1', 'bar' => ['1', '1']}).should == expected
     end
 
     it 'should raise an error if the argument is invalid' do
       expect{ klass.parse(1) }.to raise_error(ArgumentError, "Can't handle Fixnum input")
     end
+
+    it 'should accept a Rack::Request object' do
+      params = klass.parse(Rack::Request.new(Rack::MockRequest.env_for('/?foo=1&bar[]=1&bar[]=1')))
+      params['env'].should be_a(Hash)
+      params.delete('env')
+      params.should == expected
+    end
   end
 
   describe '#add_file_arguments' do

data/spec/sender/base_spec.rb

@@ -2,20 +2,34 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe MultiMail::Sender::Base do
   let :klass do
-    Class.new(MultiMail::Service) do
+    Class.new do
       include MultiMail::Sender::Base
 
-      def valid?(params)
-        params['foo'] == 1
-      end
-
-      def transform(params)
-        [Mail.new]
-      end
+      requires :foo
     end
   end
 
-  let :service do
-    klass.new
+  describe '#initialize' do
+    it 'should symbolize keys' do
+      instance = klass.new('foo' => 1, :bar => 2, nil => 3, true => 4, false => 5, 6 => 6)
+      instance.settings.should == {
+        :foo  => 1,
+        :bar  => 2,
+        nil   => 3,
+        true  => 4,
+        false => 5,
+        6     => 6,
+      }
+    end
+
+    it 'should have default settings' do
+      sender = klass.new(:foo => '')
+      sender.tracking.should == {}
+    end
+
+    it 'should assign custom settings' do
+      sender = klass.new(:foo => '', :track => {:opens => true})
+      sender.tracking.should == {:opens => true}
+    end
   end
 end

data/spec/sendgrid/message_spec.rb

@@ -0,0 +1,265 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/sendgrid/message'
+
+describe MultiMail::Message::SendGrid do
+  let :message do
+    headers = {
+      'X-Autoreply'  => true,
+      'X-Precedence' => 'auto_reply',
+      'X-Numeric'    => 42,
+      'Delivered-To' => 'Autoresponder',
+    }
+
+    MultiMail::Message::SendGrid.new do
+      date     Time.at(946702800)
+      headers  headers
+      from     %("John Doe" <foo@example.com>)
+      to       [%("Jane Doe" <bar@example.com>), '<baz@example.com>']
+      cc       'cc@example.com'
+      bcc      'bcc@example.com'
+      reply_to 'noreply@example.com'
+      subject  'test'
+
+      text_part do
+        body 'hello'
+      end
+
+      html_part do
+        content_type 'text/html; charset=UTF-8'
+        body '<p>hello</p>'
+      end
+
+      add_file  empty_gif_path
+      add_file  :filename => 'foo.txt', :content => 'hello world'
+    end
+  end
+
+  let :message_without_names do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      ['bar@example.com', 'baz@example.com']
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_with_known_extension do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+      add_file :filename => 'xxx.mov', :content => ''
+    end
+  end
+
+  let :message_with_unknown_extension do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+      add_file :filename => 'xxx.xxx', :content => ''
+    end
+  end
+
+  let :message_without_extension do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+      add_file :filename => 'xxx', :content => ''
+    end
+  end
+
+  let :message_with_empty_file do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+      add_file :filename => '', :content => ''
+    end
+  end
+
+  let :message_with_empty_headers do
+    headers = {
+      'X-Autoreply' => nil,
+    }
+
+    MultiMail::Message::SendGrid.new do
+      headers  headers
+      from    'foo@example.com'
+      to      'bar@example.com'
+      reply_to nil
+      subject  'test'
+      body     'hello'
+    end
+  end
+
+  let :message_without_html_body do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_without_text_body do
+    MultiMail::Message::SendGrid.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    '<p>hello</p>'
+      content_type 'text/html; charset=UTF-8'
+    end
+  end
+
+  let :empty_message do
+    MultiMail::Message::SendGrid.new
+  end
+
+  describe '#sendgrid_files' do
+    it 'should return the attachments' do
+      files = message.sendgrid_files
+      files['empty.gif'].content_type.should == 'image/gif; filename=empty.gif'
+      files['empty.gif'].original_filename.should == 'empty.gif'
+      files['empty.gif'].read.should == File.open(empty_gif_path, 'r:binary'){|f| f.read}
+      files['foo.txt'].content_type.should == 'text/plain; filename=foo.txt'
+      files['foo.txt'].original_filename.should == 'foo.txt'
+      files['foo.txt'].read.should == 'hello world'
+      files.size.should == 2
+    end
+
+    it 'should return an attachment with an known extension' do
+      files = message_with_known_extension.sendgrid_files
+      files['xxx.mov'].content_type.should == 'video/quicktime; filename=xxx.mov'
+      files['xxx.mov'].original_filename.should == 'xxx.mov'
+      files['xxx.mov'].read.should == ''
+      files.size.should == 1
+    end
+
+    it 'should return an attachment with an unknown extension' do
+      files = message_with_unknown_extension.sendgrid_files
+      files['xxx.xxx'].content_type.should == 'text/plain'
+      files['xxx.xxx'].original_filename.should == 'xxx.xxx'
+      files['xxx.xxx'].read.should == ''
+      files.size.should == 1
+    end
+
+    it 'should return an attachment without an extension' do
+      files = message_without_extension.sendgrid_files
+      files['xxx'].content_type.should == 'text/plain'
+      files['xxx'].original_filename.should == 'xxx'
+      files['xxx'].read.should == ''
+      files.size.should == 1
+    end
+
+    it 'should return an empty array if the attachment is blank' do
+      message_with_empty_file.sendgrid_files.should == {}
+    end
+
+    it 'should return an empty array' do
+      empty_message.sendgrid_files.should == {}
+    end
+  end
+
+  describe '#sendgrid_content' do
+    it 'should return the content IDs' do
+      content = message.sendgrid_content
+      content.should == {'empty.gif' => 'empty.gif'}
+    end
+
+    it 'should return an empty array if the attachment is blank' do
+      message_with_empty_file.sendgrid_content.should == {}
+    end
+
+    it 'should return an empty array' do
+      empty_message.sendgrid_content.should == {}
+    end
+  end
+
+  describe '#sendgrid_headers' do
+    it 'should return the headers' do
+      headers = message.sendgrid_headers
+      headers['Cc'].should           == 'cc@example.com'
+      headers['X-Autoreply'].should  == 'true'
+      headers['X-Precedence'].should == 'auto_reply'
+      headers['X-Numeric'].should    == '42'
+      headers['Delivered-To'].should == 'Autoresponder'
+
+      headers['Content-Type'].should match(%r{\Amultipart/alternative; boundary=--==_mimepart_[0-9a-f_]+\z})
+
+      headers.size.should == 6
+    end
+
+    it 'should return empty X-* headers' do
+      headers = message_with_empty_headers.sendgrid_headers
+      headers.should == {'X-Autoreply' => ''}
+    end
+
+    it 'should return an empty hash' do
+      empty_message.sendgrid_headers.should == {}
+    end
+  end
+
+  describe '#to_sendgrid_hash' do
+    it 'should return the message as SendGrid parameters' do
+      hash = message.to_sendgrid_hash
+
+      hash[:to].should       == ['bar@example.com', 'baz@example.com']
+      hash[:toname].should   == ['Jane Doe', nil]
+      hash[:subject].should  == 'test'
+      hash[:text].should     == 'hello'
+      hash[:html].should     == '<p>hello</p>'
+      hash[:from].should     == 'foo@example.com'
+      hash[:bcc].should      == ['bcc@example.com']
+      hash[:fromname].should == 'John Doe'
+      hash[:replyto].should  == 'noreply@example.com'
+      hash[:content].should  == {'empty.gif' => 'empty.gif'}
+
+      hash[:headers].should match(/"Cc":"cc@example.com"/)
+      hash[:headers].should match(%r{"Content-Type":"multipart/alternative; boundary=--==_mimepart_[0-9a-f_]+"})
+      hash[:headers].should match(/"X-Autoreply":"true"/)
+      hash[:headers].should match(/"X-Precedence":"auto_reply"/)
+      hash[:headers].should match(/"X-Numeric":"42"/)
+      hash[:headers].should match(/"Delivered-To":"Autoresponder"/)
+      Time.parse(hash[:'date']).should be_within(1).of(Time.at(946702800))
+
+      hash[:files]['empty.gif'].content_type.should == 'image/gif; filename=empty.gif'
+      hash[:files]['empty.gif'].original_filename.should == 'empty.gif'
+      hash[:files]['empty.gif'].read.should == File.open(empty_gif_path, 'r:binary'){|f| f.read}
+      hash[:files]['foo.txt'].content_type.should == 'text/plain; filename=foo.txt'
+      hash[:files]['foo.txt'].original_filename.should == 'foo.txt'
+      hash[:files]['foo.txt'].read.should == 'hello world'
+      hash[:files].size.should == 2
+
+      hash.size.should == 13
+    end
+
+    it 'should convert the message without a text body' do
+      message_without_text_body.to_sendgrid_hash.should == {
+        :to      => ['bar@example.com'],
+        :subject => 'test',
+        :html    => '<p>hello</p>',
+        :from    => 'foo@example.com',
+        :headers => %({"Content-Type":"text/html; charset=UTF-8"}),
+      }
+    end
+
+    it 'should convert the message without an HTML body' do
+      message_without_html_body.to_sendgrid_hash.should == {
+        :to      => ['bar@example.com'],
+        :subject => 'test',
+        :text    => 'hello',
+        :from    => 'foo@example.com',
+      }
+    end
+
+    it 'should convert an empty message' do
+      empty_message.to_sendgrid_hash.should == {}
+    end
+  end
+end

data/spec/sendgrid/receiver_spec.rb

@@ -0,0 +1,77 @@
+# coding: utf-8
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/sendgrid/receiver'
+
+describe MultiMail::Receiver::SendGrid do
+  context 'after initialization' do
+    let :service do
+      MultiMail::Receiver.new(:provider => :sendgrid)
+    end
+
+    def params(fixture, encoding = 'UTF-8')
+      MultiMail::Receiver::SendGrid.parse(response('sendgrid', fixture, false, encoding))
+    end
+
+    describe '#transform' do
+      it 'should return a mail message' do
+        messages = service.transform(params('valid'))
+        messages.size.should == 1
+        message = messages[0]
+
+        # Headers
+        message.date.should    == DateTime.parse('Mon, 15 Apr 2013 20:20:12 -0400')
+        message.from.should    == ['james@opennorth.ca']
+        message.to.should      == ['foo+bar@parolecitoyenne.com']
+        message.subject.should == 'Test'
+
+        # Body
+        message.multipart?.should            == true
+        # @note SendGrid adds additional HTML parts as attachments, which is
+        # sensible, but it does not match the behavior of other email APIs.
+        message.parts.size.should            == 6
+        message.parts[0].content_type.should == 'text/plain'
+        message.parts[1].content_type.should == 'text/html; charset=UTF-8'
+        message.parts[0].body.decoded.should == "bold text\n\n\n\nsome more bold text\n\n\n\nsome italic text\n\n> multiline\n> quoted\n> text\n\n\n--\nSignature block"
+        # @note Due to a SendGrid bug, the HTML part is missing content.
+        message.parts[1].body.decoded.should == %(<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><b>bold text</b><div><br></div><div></div></body></html>)
+
+        # HTML attachments
+        message.parts[3].content_type.should == 'text/html; filename=msg-12415-313.html'
+        message.parts[5].content_type.should == 'text/html; filename=msg-12415-314.html'
+        message.parts[3].body.decoded.should == %(<html><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><head></head><br><div></div><div><br></div><div><b>some more bold text</b></div><div><b><br></b></div><div><b></b></div></body></html>)
+        message.parts[5].body.decoded.should == %(<html><head></head><body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; "><br><div><b></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><br></span></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><i>some italic text</i></span></b></div><div><b><span class="Apple-style-span" style="font-weight: normal; "><br></span></b></div><div><blockquote type="cite">multiline</blockquote><blockquote type="cite">quoted</blockquote><blockquote type="cite">text</blockquote></div><div><br></div><div>--</div><div>Signature block</div></body></html>)
+
+        # Attachments
+        attachment0 = message.attachments.find{|attachment| attachment.filename == 'foo.txt'}
+        attachment1 = message.attachments.find{|attachment| attachment.filename == 'bar.txt'}
+        attachment0.read.should == "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n"
+        attachment1.read.should == "Nam accumsan euismod eros et rhoncus.\n"
+
+        # Extra SendGrid parameters
+        message['dkim'].value.should == 'none'
+        message['SPF'].value.should == 'pass'
+        message['spam_report'].value.should == "Spam detection software, running on the system \"mx3.sendgrid.net\", has\r\nidentified this incoming email as possible spam.  The original message\r\nhas been attached to this so you can view it (if it isn't spam) or label\r\nsimilar future email.  If you have any questions, see\r\nthe administrator of that system for details.\r\n\r\nContent preview:  bold text some more bold text some italic text [...] \r\n\r\nContent analysis details:   (-2.6 points, 5.0 required)\r\n\r\n pts rule name              description\r\n---- ---------------------- --------------------------------------------------\r\n-0.7 RCVD_IN_DNSWL_LOW      RBL: Sender listed at http://www.dnswl.org/, low\r\n                            trust\r\n                            [209.85.223.172 listed in list.dnswl.org]\r\n-1.9 BAYES_00               BODY: Bayes spam probability is 0 to 1%\r\n                            [score: 0.0000]\r\n 0.0 HTML_MESSAGE           BODY: HTML included in message\r\n\r\n"
+        message['spam_score'].value.should == '-2.599'
+      end
+
+      # No postbin is capable of handling mixed encodings, and most fail to even
+      # display the request. http://postbin.hackyon.com/ works best, but we
+      # still need to hand-edit the response.
+      it 'should respect encodings' do
+        service.transform(params('encoding', 'WINDOWS-1252'))[0].text_part.decoded.should == 'World €'
+      end
+    end
+
+    describe '#spam?' do
+      it 'should return true if the response is spam' do
+        message = service.transform(params('spam'))[0]
+        service.spam?(message).should == true
+      end
+
+      it 'should return false if the response is ham' do
+        message = service.transform(params('valid'))[0]
+        service.spam?(message).should == false
+      end
+    end
+  end
+end