multi_mail 0.0.2 → 0.1.0

data/spec/mailgun/message_spec.rb

@@ -0,0 +1,251 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/mailgun/message'
+
+describe MultiMail::Message::Mailgun do
+  let :message do
+    headers = {
+      'X-Autoreply'  => true,
+      'X-Precedence' => 'auto_reply',
+      'X-Numeric'    => 42,
+      'Delivered-To' => 'Autoresponder',
+    }
+
+    MultiMail::Message::Mailgun.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::Mailgun.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::Mailgun.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::Mailgun.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::Mailgun.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::Mailgun.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::Mailgun.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::Mailgun.new do
+      from    'foo@example.com'
+      to      'bar@example.com'
+      subject 'test'
+      body    'hello'
+    end
+  end
+
+  let :message_without_text_body do
+    MultiMail::Message::Mailgun.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::Mailgun.new
+  end
+
+  describe '#mailgun_attachments' do
+    it 'should return the attachments' do
+      attachments = message.mailgun_attachments
+      attachments['inline'][0].content_type.should == 'image/gif; filename=empty.gif'
+      attachments['inline'][0].original_filename.should == 'empty.gif'
+      attachments['inline'][0].read.should == File.open(empty_gif_path, 'r:binary'){|f| f.read}
+      attachments['inline'].size.should == 1
+      attachments['attachment'][0].content_type.should == 'text/plain; filename=foo.txt'
+      attachments['attachment'][0].original_filename.should == 'foo.txt'
+      attachments['attachment'][0].read.should == 'hello world'
+      attachments['attachment'].size.should == 1
+    end
+
+    it 'should return an attachment with an known extension' do
+      attachments = message_with_known_extension.mailgun_attachments['attachment']
+      attachments[0].content_type.should == 'video/quicktime; filename=xxx.mov'
+      attachments[0].original_filename.should == 'xxx.mov'
+      attachments[0].read.should == ''
+      attachments.size.should == 1
+    end
+
+    it 'should return an attachment with an unknown extension' do
+      attachments = message_with_unknown_extension.mailgun_attachments['attachment']
+      attachments[0].content_type.should == 'text/plain'
+      attachments[0].original_filename.should == 'xxx.xxx'
+      attachments[0].read.should == ''
+      attachments.size.should == 1
+    end
+
+    it 'should return an attachment without an extension' do
+      attachments = message_without_extension.mailgun_attachments['attachment']
+      attachments[0].content_type.should == 'text/plain'
+      attachments[0].original_filename.should == 'xxx'
+      attachments[0].read.should == ''
+      attachments.size.should == 1
+    end
+
+    it 'should return an empty array if the attachment is blank' do
+      message_with_empty_file.mailgun_attachments.should == {}
+    end
+
+    it 'should return an empty array' do
+      empty_message.mailgun_attachments.should == {}
+    end
+  end
+
+  describe '#mailgun_headers' do
+    it 'should return the headers' do
+      headers = message.mailgun_headers
+      headers['h:Reply-To'].should     == ['noreply@example.com']
+      headers['h:X-Autoreply'].should  == ['true']
+      headers['h:X-Precedence'].should == ['auto_reply']
+      headers['h:X-Numeric'].should    == ['42']
+      headers['h:Delivered-To'].should == ['Autoresponder']
+
+      Time.parse(headers['h:Date'][0]).should be_within(1).of(Time.at(946702800))
+      headers['h:Content-Type'][0].should match(%r{\Amultipart/alternative; boundary=--==_mimepart_[0-9a-f_]+\z})
+
+      headers.size.should == 7
+    end
+
+    it 'should return empty X-* headers' do
+      headers = message_with_empty_headers.mailgun_headers
+      headers.should == {'h:X-Autoreply' => ['']}
+    end
+
+    it 'should return an empty hash' do
+      empty_message.mailgun_headers.should == {}
+    end
+  end
+
+  describe '#to_mailgun_hash' do
+    it 'should return the message as Mailgun parameters' do
+      hash = message.to_mailgun_hash
+
+      hash[:from].should       == [%("John Doe" <foo@example.com>)]
+      hash[:to].should         == [%("Jane Doe" <bar@example.com>), '<baz@example.com>']
+      hash[:cc].should         == ['cc@example.com']
+      hash[:bcc].should        == ['bcc@example.com']
+      hash[:subject].should    == ['test']
+      hash[:text].should       == ['hello']
+      hash[:html].should       == ['<p>hello</p>']
+      hash[:'h:Reply-To'].should == ['noreply@example.com']
+
+      Time.parse(hash[:'h:Date'][0]).should be_within(1).of(Time.at(946702800))
+      hash[:'h:Content-Type'][0].should match(%r{\Amultipart/alternative; boundary=--==_mimepart_[0-9a-f_]+\z})
+
+      hash[:'h:X-Autoreply'].should  == ['true']
+      hash[:'h:X-Precedence'].should == ['auto_reply']
+      hash[:'h:X-Numeric'].should    == ['42']
+      hash[:'h:Delivered-To'].should == ['Autoresponder']
+
+      hash[:inline][0].content_type.should == 'image/gif; filename=empty.gif'
+      hash[:inline][0].original_filename.should == 'empty.gif'
+      hash[:inline][0].read.should == File.open(empty_gif_path, 'r:binary'){|f| f.read}
+      hash[:inline].size.should == 1
+      hash[:attachment][0].content_type.should == 'text/plain; filename=foo.txt'
+      hash[:attachment][0].original_filename.should == 'foo.txt'
+      hash[:attachment][0].read.should == 'hello world'
+      hash[:attachment].size.should == 1
+
+      hash.size.should == 16
+    end
+
+    it 'should convert the message without a text body' do
+      message_without_text_body.to_mailgun_hash.should == {
+        :from             => ['foo@example.com'],
+        :to               => ['bar@example.com'],
+        :subject          => ['test'],
+        :html             => ['<p>hello</p>'],
+        :'h:Content-Type' => ['text/html; charset=UTF-8'],
+      }
+    end
+
+    it 'should convert the message without an HTML body' do
+      message_without_html_body.to_mailgun_hash.should == {
+        :from    => ['foo@example.com'],
+        :to      => ['bar@example.com'],
+        :subject => ['test'],
+        :text    => ['hello'],
+      }
+    end
+
+    it 'should convert an empty message' do
+      empty_message.to_mailgun_hash.should == {}
+    end
+  end
+end

data/spec/mailgun/receiver_spec.rb

@@ -2,13 +2,6 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'multi_mail/mailgun/receiver'
 
 describe MultiMail::Receiver::Mailgun do
-  describe '#initialize' do
-    it 'should raise an error if :mailgun_api_key is missing' do
-      expect{ MultiMail::Receiver.new :provider => :mailgun }.to raise_error(ArgumentError)
-      expect{ MultiMail::Receiver.new :provider => :mailgun, :mailgun_api_key => nil }.to raise_error(ArgumentError)
-    end
-  end
-
   context 'after initialization' do
     context 'with invalid HTTP POST format' do
       let :service do
@@ -26,15 +19,36 @@ describe MultiMail::Receiver::Mailgun do
       end
     end
 
+    context 'without optional arguments' do
+      let :service do
+        MultiMail::Receiver.new(:provider => :mailgun)
+      end
+
+      def params(fixture)
+        MultiMail::Receiver::Mailgun.parse(response('mailgun/parsed', fixture))
+      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
+
     [false, true].each do |action_dispatch|
       let :action_dispatch do
         action_dispatch
       end
 
-      # @todo Write my own Postbin to have a URL ending with "mime" in order
-      #   to get fixtures to test the raw MIME HTTP POST format; all existing
-      #   OS code for bins suck. Simple Rack app with in-memory storage?
-      ['parsed', '', nil].each do |http_post_format|
+      ['parsed', 'raw', '', nil].each do |http_post_format|
         context "with #{http_post_format.inspect} format and #{action_dispatch ? 'ActionDispatch' : 'Rack'}" do
           let :http_post_format do
             http_post_format
@@ -85,16 +99,16 @@ describe MultiMail::Receiver::Mailgun do
               # 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'
-              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"
-              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>)
+              text_part = message.parts.find{|part| part.content_type == 'text/plain'}
+              html_part = message.parts.find{|part| part.content_type == 'text/html; charset=UTF-8'}
+              text_part.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"
+              html_part.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
-              message.attachments[0].filename.should == 'foo.txt'
-              message.attachments[0].read.should == "Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n"
-              message.attachments[1].filename.should == 'bar.txt'
-              message.attachments[1].read.should == "Nam accumsan euismod eros et rhoncus.\n"
+              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 Mailgun parameters
               # @note Due to a Mailgun bug, `stripped-text` contains "some italic
@@ -114,8 +128,9 @@ describe MultiMail::Receiver::Mailgun do
 
           describe '#spam?' do
             it 'should return true if the response is spam' do
+              # The raw MIME HTTP POST format doesn't perform spam filtering.
               message = service.transform(params('spam'))[0]
-              service.spam?(message).should == true
+              service.spam?(message).should == (actual_http_post_format != 'raw')
             end
 
             it 'should return false if the response is ham' do

data/spec/mailgun/sender_spec.rb

@@ -0,0 +1,175 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/mailgun/sender'
+
+describe MultiMail::Sender::Mailgun do
+  let :message do
+    Mail.new do
+      date    Time.at(946702800)
+      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::Mailgun, :domain => 'xxx'
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: api_key")
+    end
+
+    it 'should raise an error if :domain is missing' do
+      expect{
+        message.delivery_method MultiMail::Sender::Mailgun, :api_key => 'xxx'
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: domain")
+    end
+
+    it 'should raise an error if :api_key is nil' do
+      expect{
+        message.delivery_method MultiMail::Sender::Mailgun, :api_key => nil, :domain => 'xxx'
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: api_key")
+    end
+
+    it 'should raise an error if :domain is nil' do
+      expect{
+        message.delivery_method MultiMail::Sender::Mailgun, :api_key => 'xxx', :domain => nil
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: domain")
+    end
+
+    it 'should raise an error if :domain or :api_key are invalid' do
+      expect{
+        message.delivery_method MultiMail::Sender::Mailgun, :api_key => 'xxx', :domain => 'xxx'
+        message.deliver
+      }.to raise_error(MultiMail::InvalidAPIKey)
+    end
+
+    it 'should assign custom settings' do
+      sender = MultiMail::Sender::Mailgun.new(:api_key => 'xxx', :domain => 'xxx')
+
+      sender.api_key.should == 'xxx'
+      sender.domain.should  == 'xxx'
+    end
+  end
+
+  describe '#parameters' do
+    it 'should allow "yes", "no" and "htmlonly" values' do
+      %w(yes no htmlonly).each do |value|
+        sender = MultiMail::Sender::Mailgun.new({
+          :api_key => 'xxx',
+          :domain => 'xxx',
+          :track => {
+            :clicks => value,
+          }
+        })
+
+        sender.parameters.should == {:'o:tracking-clicks' => value}
+      end
+    end
+
+    it 'should transform true and false values' do
+      sender = MultiMail::Sender::Mailgun.new({
+        :api_key => 'xxx',
+        :domain => 'xxx',
+        :track => {
+          :opens => false,
+          :clicks => true,
+        }
+      })
+
+      sender.parameters.should == {:'o:tracking-opens' => 'no', :'o:tracking-clicks' => 'yes'}
+    end
+
+    it 'should ignore nil values' do
+      sender = MultiMail::Sender::Mailgun.new({
+        :api_key => 'xxx',
+        :domain => 'xxx',
+        :track => {
+          :clicks => nil,
+        }
+      })
+
+      sender.parameters.should == {}
+    end
+  end
+
+  describe '#deliver' do
+    before :all do
+      Mail.defaults do
+        delivery_method MultiMail::Sender::Mailgun, :api_key => ENV['MAILGUN_API_KEY'], :domain => 'multimail.mailgun.org', 'o:testmode' => 'yes'
+      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::Mailgun, :api_key => ENV['MAILGUN_API_KEY'], :domain => 'multimail.mailgun.org', 'o:testmode' => 'yes', :return_response => true
+      end
+    end
+
+    it 'should send a message' do
+      result = message.deliver!
+      result.size.should == 2
+
+      result['message'].should == 'Queued. Thank you.'
+      result['id'].should match(/<\S+@\S+>/)
+    end
+
+    it 'should not send a message without a From header' do
+      expect{message_without_from.deliver!}.to raise_error(MultiMail::MissingSender, "'from' parameter is missing")
+    end
+
+    it 'should not send a message without a To header' do
+      expect{message_without_to.deliver!}.to raise_error(MultiMail::MissingRecipients, "'to' parameter is missing")
+    end
+
+    it 'should not send a message without a body' do
+      expect{message_without_body.deliver!}.to raise_error(MultiMail::MissingBody, "Need at least one of 'text' or 'html' parameters specified")
+    end
+  end
+end