multi_mail 0.0.2 → 0.1.0

data/spec/mandrill/message_spec.rb

@@ -0,0 +1,305 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/mandrill/message'
+
+describe MultiMail::Message::Mandrill do
+  let :message do
+    headers = {
+      'X-Autoreply'  => true,
+      'X-Precedence' => 'auto_reply',
+      'X-Numeric'    => 42,
+      'Delivered-To' => 'Autoresponder',
+    }
+
+    MultiMail::Message::Mandrill.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::Mandrill.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::Mandrill.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::Mandrill.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::Mandrill.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::Mandrill.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::Mandrill.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::Mandrill.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_without_text_body do
+    MultiMail::Message::Mandrill.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::Mandrill.new
+  end
+
+  describe '#mandrill_to' do
+    it 'should return the recipients with names' do
+      message.mandrill_to.should == [
+        {
+          'email' => 'bar@example.com',
+          'name'  => 'Jane Doe',
+        },
+        {
+          'email' => 'baz@example.com',
+          'name'  => nil,
+        },
+      ]
+    end
+
+    it 'should return the recipients without names' do
+      message_without_names.mandrill_to.should == [
+        {
+          'email' => 'bar@example.com',
+          'name'  => nil,
+        },
+        {
+          'email' => 'baz@example.com',
+          'name'  => nil,
+        },
+      ]
+    end
+
+    it 'should return an empty array' do
+      empty_message.mandrill_to.should == []
+    end
+  end
+
+  describe '#mandrill_headers' do
+    it 'should return only the Reply-To and X-* headers' do
+      headers = message.mandrill_headers
+      headers.should == {
+        'Reply-To'     => 'noreply@example.com',
+        'X-Autoreply'  => 'true',
+        'X-Precedence' => 'auto_reply',
+        'X-Numeric'    => '42',
+      }
+    end
+
+    it 'should return empty X-* headers' do
+      headers = message_with_empty_headers.mandrill_headers
+      headers.should == {'X-Autoreply' => ''}
+    end
+
+    it 'should return an empty hash' do
+      empty_message.mandrill_headers.should == {}
+    end
+  end
+
+  describe '#mandrill_attachments' do
+    it 'should return the attachments' do
+      message.mandrill_attachments.should == [
+        {
+          'type' => 'image/gif; filename=empty.gif',
+          'name' => 'empty.gif',
+          'content' => "R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==\n",
+        },
+        {
+          'type' => 'text/plain; filename=foo.txt',
+          'name' => 'foo.txt',
+          'content' => Base64.encode64('hello world'),
+        },
+      ]
+    end
+
+    it 'should return an attachment with an known extension' do
+      message_with_known_extension.mandrill_attachments.should == [
+        {
+          'type' => 'video/quicktime; filename=xxx.mov',
+          'name' => 'xxx.mov',
+          'content' => '',
+        },
+      ]
+    end
+
+    it 'should return an attachment with an unknown extension' do
+      message_with_unknown_extension.mandrill_attachments.should == [
+        {
+          'type' => 'text/plain',
+          'name' => 'xxx.xxx',
+          'content' => '',
+        },
+      ]
+    end
+
+    it 'should return an attachment without an extension' do
+      message_without_extension.mandrill_attachments.should == [
+        {
+          'type' => 'text/plain',
+          'name' => 'xxx',
+          'content' => '',
+        },
+      ]
+    end
+
+    it 'should return an empty array if the attachment is blank' do
+      message_with_empty_file.mandrill_attachments.should == []
+    end
+
+    it 'should return an empty array' do
+      empty_message.mandrill_attachments.should == []
+    end
+  end
+
+  describe '#to_mandrill_hash' do
+    it 'should return the message as Mandrill parameters' do
+      message.to_mandrill_hash.should == {
+        :html       => '<p>hello</p>',
+        :text       => 'hello',
+        :subject    => 'test',
+        :from_email => 'foo@example.com',
+        :from_name  => 'John Doe',
+        :to         => [
+          {
+          'email' => 'bar@example.com',
+          'name'  => 'Jane Doe',
+          },
+          {
+          'email' => 'baz@example.com',
+          'name'  => nil,
+          },
+        ],
+        :headers => {
+          'Reply-To'     => 'noreply@example.com',
+          'X-Autoreply'  => 'true',
+          'X-Precedence' => 'auto_reply',
+          'X-Numeric'    => '42',
+        },
+        :attachments => [
+          {
+            'type' => 'text/plain; filename=foo.txt',
+            'name' => 'foo.txt',
+            'content' => Base64.encode64('hello world'),
+          },
+        ],
+        :images => [
+          {
+            'type' => 'image/gif; filename=empty.gif',
+            'name' => 'empty.gif',
+            'content' => "R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==\n",
+          },
+        ],
+      }
+    end
+
+    it 'should convert the message without a text body' do
+      message_without_text_body.to_mandrill_hash.should == {
+        :html       => '<p>hello</p>',
+        :subject    => 'test',
+        :from_email => 'foo@example.com',
+        :to         => [
+          {
+          'email' => 'bar@example.com',
+          'name'  => nil,
+          },
+        ],
+      }
+    end
+
+    it 'should convert the message without an HTML body' do
+      message_without_html_body.to_mandrill_hash.should == {
+        :text       => 'hello',
+        :subject    => 'test',
+        :from_email => 'foo@example.com',
+        :to         => [
+          {
+          'email' => 'bar@example.com',
+          'name'  => nil,
+          },
+        ],
+      }
+    end
+
+    it 'should convert an empty message' do
+      empty_message.to_mandrill_hash.should == {}
+    end
+  end
+end

data/spec/mandrill/receiver_spec.rb

@@ -3,61 +3,105 @@ require 'multi_mail/mandrill/receiver'
 
 describe MultiMail::Receiver::Mandrill do
   context 'after initialization' do
-    let :service do
-      MultiMail::Receiver.new(:provider => :mandrill)
-    end
-
     def params(fixture)
       MultiMail::Receiver::Mandrill.parse(response('mandrill', fixture))
     end
 
-    # @todo Add a spec for multiple Mandrill events.
-    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 -04:00')
-        message.from.should    == ['james@opennorth.ca']
-        message.to.should      == ['foo+bar@govkit.org']
-        message.subject.should == 'Test'
-
-        # Body
-        message.multipart?.should            == true
-        message.parts.size.should            == 4
-        message.parts[0].content_type.should == 'text/plain'
-        message.parts[1].content_type.should == 'text/html; charset=UTF-8'
-        # @note Mandrill adds a newline at the end of each part.
-        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\n"
-        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><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><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\n"
-        attachment1.read.should == "Nam accumsan euismod eros et rhoncus.\n\n"
-
-        # Extra Mandrill parameters
-        message['ts'].value.should == '1368657709'
-        message['email'].value.should == 'foo+bar@govkit.org'
-        message['dkim-signed'].value.should == 'false'
-        message['dkim-valid'].value.should == 'false'
-        message['spam_report-score'].value.should == '0'
-        message['spf-result'].value.should == 'pass'
+    context 'without optional arguments' do
+      let :service do
+        MultiMail::Receiver.new(:provider => :mandrill)
+      end
+
+      describe '#valid?' do
+        it 'should return true if the response is valid' do
+          service.valid?(params('valid')).should == true
+        end
+
+        it 'should return true if the response is invalid' do
+          service.valid?(params('invalid')).should == true
+        end
+
+        it 'should return true if parameters are missing' do
+          service.valid?(params('missing')).should == true
+        end
       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
+    context 'with optional arguments' do
+      let :service do
+        MultiMail::Receiver.new({
+          :provider => :mandrill,
+          :mandrill_webhook_key => 'rth_rywL9CWIIZBuwPQIWw',
+          :mandrill_webhook_url => 'http://rackbin.herokuapp.com/',
+        })
+      end
+
+      describe '#valid?' do
+        it 'should return true if the response is valid' do
+          service.valid?(params('valid')).should == true
+        end
+
+        it 'should return false if the response is invalid' do
+          service.valid?(params('invalid')).should == false
+        end
+
+        it 'should raise an error if parameters are missing' do
+          expect{ service.valid?(params('missing')) }.to raise_error(IndexError)
+        end
       end
 
-      it 'should return false if the response is ham' do
-        message = service.transform(params('valid'))[0]
-        service.spam?(message).should == false
+      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, 29 May 2013 16:51:45 -04:00')
+          message.from.should    == ['james@opennorth.ca']
+          message.to.should      == ['foo+bar@govkit.org']
+          message.subject.should == 'Test'
+
+          # Body
+          message.multipart?.should            == true
+          message.parts.size.should            == 4
+          message.parts[0].content_type.should == 'text/plain'
+          message.parts[1].content_type.should == 'text/html; charset=UTF-8'
+          # @note Mandrill adds a newline at the end of each part.
+          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\n"
+          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><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><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\n"
+          attachment1.read.should == "Nam accumsan euismod eros et rhoncus.\n\n"
+
+          # Extra Mandrill parameters
+          message['ts'].value.should == '1369860716'
+          message['email'].value.should == 'foo+bar@govkit.org'
+          message['dkim-signed'].value.should == 'false'
+          message['dkim-valid'].value.should == 'false'
+          message['spam_report-score'].value.should == '-0.7'
+          message['spf-result'].value.should == 'pass'
+        end
+
+        it 'should return multiple messages if there are multiple events' do
+          messages = service.transform(params('multiple'))
+          messages.size.should == 2
+        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

data/spec/mandrill/sender_spec.rb

@@ -0,0 +1,138 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/mandrill/sender'
+
+describe MultiMail::Sender::Mandrill do 
+  let :message do
+    Mail.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :empty_message do
+    Mail.new
+  end
+
+  describe '#initialize' do
+    it 'should raise an error if :api_key is missing' do
+      expect{
+        message.delivery_method MultiMail::Sender::Mandrill
+        message.deliver # request not sent
+      }.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::Mandrill, :api_key => nil
+        message.deliver # request not sent
+      }.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::Mandrill, :api_key => 'xxx'
+        message.deliver
+      }.to raise_error(MultiMail::InvalidAPIKey, 'Invalid API key')
+    end
+
+    it 'should have default settings' do
+      sender = MultiMail::Sender::Mandrill.new(:api_key => '')
+
+      sender.api_key.should == ''
+      sender.async.should   == false
+      sender.ip_pool.should == nil
+      sender.send_at.should == nil
+    end
+
+    it 'should assign custom settings' do
+      sender = MultiMail::Sender::Mandrill.new({
+        :api_key => 'xxx',
+        :async   => true,
+        :ip_pool => 'Main Pool',
+        :send_at => 'example send_at',
+      })
+
+      sender.api_key.should == 'xxx'
+      sender.async.should   == true
+      sender.ip_pool.should == 'Main Pool'
+      sender.send_at.should == 'example send_at'
+    end
+  end
+
+  describe '#parameters' do
+    it 'should allow true, false and nil values' do
+      [true, false, nil].each do |value|
+        sender = MultiMail::Sender::Mandrill.new({
+          :api_key => 'xxx',
+          :track => {
+            :clicks => value,
+          }
+        })
+
+        sender.parameters.should == {:track_clicks => value}
+      end
+    end
+
+    it 'should transform "yes" and "no" values' do
+      sender = MultiMail::Sender::Mandrill.new({
+        :api_key => 'xxx',
+        :track => {
+          :opens => 'no',
+          :clicks => 'yes',
+        }
+      })
+
+      sender.parameters.should == {:track_opens => false, :track_clicks => true}
+    end
+
+    it 'should ignore "htmlonly" values' do
+      sender = MultiMail::Sender::Mandrill.new({
+        :api_key => 'xxx',
+        :track => {
+          :clicks => 'htmlonly',
+        }
+      })
+
+      sender.parameters.should == {}
+    end
+  end
+
+  describe '#deliver' do
+    before :all do
+      Mail.defaults do
+        delivery_method MultiMail::Sender::Mandrill, :api_key => ENV['MANDRILL_API_KEY']
+      end
+    end
+
+    it 'should send a message' do
+      message.deliver.should == message
+    end
+  end
+
+  describe '#deliver!' do
+    before :all do
+      Mail.defaults do
+        delivery_method MultiMail::Sender::Mandrill, :api_key => ENV['MANDRILL_API_KEY'], :return_response => true
+      end
+    end
+
+    it 'should send a message' do
+      results = message.deliver!
+      results.size.should == 1
+
+      result = results.first
+      result.size.should == 4
+
+      result['reject_reason'].should == nil
+      result['status'].should == "sent"
+      result['email'].should == "bar@example.com"
+      result['_id'].should match(/\A[0-9a-f]{32}\z/)
+    end
+
+    it 'should not send an empty message' do
+      empty_message.deliver!.should == [] # response not saved
+    end
+  end
+end

data/spec/message/base_spec.rb

@@ -0,0 +1,81 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe MultiMail::Message::Base do
+  let :text_message do
+    MultiMail::Message::Base.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :html_message do
+    MultiMail::Message::Base.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 :html_and_text_message do
+    MultiMail::Message::Base.new do
+      from    'foo@example.com'
+      to      'bar@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
+    end
+  end
+
+  describe '#html?' do
+    it 'should return false if the message is text only' do
+      text_message.html?.should == false
+    end
+
+    it 'should return true if the message is HTML only' do
+      html_message.html?.should == true
+    end
+
+    it 'should return false if the message has both HTML and text parts' do
+      html_and_text_message.html?.should == false
+    end
+  end
+
+  describe '#body_html' do
+    it 'should not return the body if the message is text only' do
+      text_message.body_html.should be_nil
+    end
+
+    it 'should return the body if the message is HTML only' do
+      html_message.body_html.should == '<p>hello</p>'
+    end
+
+    it 'should return the body if the message has both HTML and text parts' do
+      html_and_text_message.body_html.should == '<p>hello</p>'
+    end
+  end
+
+  describe '#text_part' do
+    it 'should return the body if the message is text only' do
+      text_message.body_text.should == 'hello'
+    end
+
+    it 'should return not the body if the message is HTML only' do
+      html_message.body_text.should be_nil
+    end
+
+    it 'should return the body if the message has both HTML and text parts' do
+      html_and_text_message.body_text.should == 'hello'
+    end
+  end
+end