multi_mail 0.0.2 → 0.1.0

data/spec/sendgrid/sender_spec.rb

@@ -0,0 +1,140 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'multi_mail/sendgrid/sender'
+
+describe MultiMail::Sender::SendGrid 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_user is missing' do
+      expect{
+        message.delivery_method MultiMail::Sender::SendGrid, :api_key => 'xxx'
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: api_user")
+    end
+
+    it 'should raise an error if :api_key is missing' do
+      expect{
+        message.delivery_method MultiMail::Sender::SendGrid, :api_user => 'xxx'
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: api_key")
+    end
+
+    it 'should raise an error if :api_user is nil' do
+      expect{
+        message.delivery_method MultiMail::Sender::SendGrid, :api_user => nil, :api_key => 'xxx'
+        message.deliver # request not sent
+      }.to raise_error(ArgumentError, "Missing required arguments: api_user")
+    end
+
+    it 'should raise an error if :api_key is nil' do
+      expect{
+        message.delivery_method MultiMail::Sender::SendGrid, :api_user => 'xxx', :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_user or :api_key are invalid' do
+      expect{
+        message.delivery_method MultiMail::Sender::SendGrid, :api_user => 'xxx', :api_key => 'xxx'
+        message.deliver
+      }.to raise_error(MultiMail::InvalidAPIKey, 'Bad username / password')
+    end
+
+    it 'should transform x-smtpapi to JSON if it is not JSON' do
+      sender = MultiMail::Sender::SendGrid.new(:api_user => '', :api_key => '', 'x-smtpapi' => {:foo => 'bar'})
+      sender.settings[:'x-smtpapi'].should == '{"foo":"bar"}'
+    end
+
+    it 'should not transform x-smtpapi to JSON if it is JSON' do
+      sender = MultiMail::Sender::SendGrid.new(:api_user => '', :api_key => '', 'x-smtpapi' => '{"foo":"bar"}')
+      sender.settings[:'x-smtpapi'].should == '{"foo":"bar"}'
+    end
+  end
+
+  describe '#deliver' do
+    before :all do
+      Mail.defaults do
+        delivery_method MultiMail::Sender::SendGrid, :api_user => ENV['SENDGRID_API_USER'], :api_key => ENV['SENDGRID_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::SendGrid, :api_user => ENV['SENDGRID_API_USER'], :api_key => ENV['SENDGRID_API_KEY'], :return_response => true
+      end
+    end
+
+    it 'should send a message' do
+      result = message.deliver!
+      result.size.should == 1
+
+      result['message'].should == 'success'
+    end
+
+    it 'should not send a message without a From header' do
+      expect{message_without_from.deliver!}.to raise_error(MultiMail::MissingSender, 'Empty from email address (required)')
+    end
+
+    it 'should not send a message without a To header' do
+      expect{message_without_to.deliver!}.to raise_error(MultiMail::MissingRecipients, 'Missing destination email')
+    end
+
+    it 'should not send a message without a subject' do
+      expect{message_without_subject.deliver!}.to raise_error(MultiMail::MissingSubject, 'Missing subject')
+    end
+
+    it 'should not send a message without a body' do
+      expect{message_without_body.deliver!}.to raise_error(MultiMail::MissingBody, 'Missing email body')
+    end
+  end
+end

data/spec/service_spec.rb

@@ -2,9 +2,15 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe MultiMail::Service do
   let :klass do
-    Class.new(MultiMail::Service) do
+    Class.new do
+      extend MultiMail::Service
+
       requires :required_argument1, :required_argument2
       recognizes :optional_argument1, :optional_argument2
+
+      def initialize(options = {})
+        self.class.validate_options(options)
+      end
     end
   end
 
@@ -56,5 +62,16 @@ describe MultiMail::Service do
         })
       }.to raise_error(ArgumentError, "Unrecognized arguments: bar, foo")
     end
+
+    it 'should raise not an error if unrecognized arguments are allowed' do
+      expect{
+        klass.validate_options({
+          :required_argument1 => 1,
+          :required_argument2 => 1,
+          :bar => 1,
+          :foo => 1,
+        }, false)
+      }.to_not raise_error(ArgumentError, "Unrecognized arguments: bar, foo")
+    end
   end
 end

data/spec/simple/receiver_spec.rb

@@ -15,7 +15,7 @@ describe MultiMail::Receiver::Simple do
 
     describe '#transform' do
       it 'should return a mail message' do
-        message = service.transform(params('valid'))[0]
+        message = service.transform(params('valid')['message'])[0]
 
         # Headers
         message.date.should    == DateTime.parse('Thu, 27 Dec 2012 15:25:37 -0500')

data/spec/spec_helper.rb

@@ -3,13 +3,26 @@ require 'rubygems'
 require 'coveralls'
 Coveralls.wear!
 
+require 'digest/sha1'
 require 'net/http'
 require 'yaml'
 
 require 'rspec'
 require 'rack'
+require 'vcr'
 require File.dirname(__FILE__) + '/../lib/multi_mail'
 
+if RUBY_VERSION >= '1.9'
+  VCR.configure do |c|
+    c.cassette_library_dir = 'spec/cassettes'
+    c.hook_into :faraday
+
+    c.around_http_request do |request| # Ruby 1.9+
+      VCR.use_cassette(Digest::SHA1.hexdigest(request.uri + request.body), &request)
+    end
+  end
+end
+
 # Requires supporting ruby files with custom matchers and macros, etc,
 # in spec/support/ and its subdirectories.
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
@@ -25,9 +38,13 @@ Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
 #     :mailgun_api_key:  ...
 #     :mandrill_api_key: ...
 #     :postmark_api_key: ...
+#     :sendgrid_username: ...
+#     :sendgrid_password: ...
 #
 # For Postmark, you must create a server to get an API key.
 #
+# If you see `bad content body` exceptions, run `unix2dos` on the fixtures.
+#
 # # Cloudmailin
 #
 # Change the HTTP POST format on Cloudmailin and wait a few minutes. Run
@@ -61,6 +78,14 @@ Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
 # spam.txt     Send a subject-less message with message body XJS*C4JDBQADN1.NSBN3*2IDNEN*GTUBE-STANDARD-ANTI-UBE-TEST-EMAIL*C.34X
 # valid.txt    Send a complex multipart message
 #
+# # SendGrid
+#
+# Run `bundle exec rake sendgrid` to set up SendGrid once SendGrid has
+# provisioned your account.
+#
+# spam.txt     Send a subject-less message with message body XJS*C4JDBQADN1.NSBN3*2IDNEN*GTUBE-STANDARD-ANTI-UBE-TEST-EMAIL*C.34X
+# valid.txt    Send a complex multipart message
+#
 # @param [String] provider a provider
 # @param [String] fixture one of "valid", "invalid" or "spam"
 # @param [Boolean] action_dispatch whether uploaded files should be
@@ -68,8 +93,9 @@ Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f}
 # @return [String] the provider's baked response
 # @see FakeWeb::Responder#baked_response
 # @see https://github.com/rack/rack/blob/master/test/spec_multipart.rb
-def response(provider, fixture, action_dispatch = false)
-  contents = File.read(File.expand_path("../fixtures/#{provider}/#{fixture}.txt", __FILE__))
+def response(provider, fixture, action_dispatch = false, encoding = 'UTF-8')
+  path     = File.expand_path("../fixtures/#{provider}/#{fixture}.txt", __FILE__)
+  contents = File.open(path, "r:#{encoding}"){|f| f.read}
   io       = StringIO.new(contents)
   socket   = Net::BufferedIO.new(io)
   response = Net::HTTPResponse.read_new(socket)
@@ -79,7 +105,13 @@ def response(provider, fixture, action_dispatch = false)
   body = contents[/(?:\r?\n){2,}(.+)\z/m, 1]
 
   # It's kind of crazy that no library has an easier way of doing this.
-  if response.header['content-type']['multipart/form-data']
+  if response.header['x-mandrill-signature']
+    body = Rack::Request.new(Rack::MockRequest.env_for('/', {
+      'HTTP_X_MANDRILL_SIGNATURE' => response.header['x-mandrill-signature'],
+      :method => 'POST',
+      :input => body,
+    }))
+  elsif response.header['content-type']['multipart/form-data']
     body = Rack::Multipart.parse_multipart(Rack::MockRequest.env_for('/', {
       'CONTENT_TYPE' => response.header['content-type'],
       :input => body,
@@ -88,7 +120,7 @@ def response(provider, fixture, action_dispatch = false)
 
   if action_dispatch
     # ActionDispatch would parse the request into a parameters hash.
-    klass = Class.new(MultiMail::Service) do
+    klass = Class.new do
       include MultiMail::Receiver::Base
     end
     normalize_encode_params(klass.parse(body))
@@ -138,3 +170,13 @@ def normalize_encode_params(params)
     params
   end
 end
+
+# @return [String] the path to the GIF file
+def empty_gif_path
+  File.expand_path('../fixtures/empty.gif', __FILE__)
+end
+
+# @return [String] the content of the GIF file
+def empty_gif_content
+  File.read(empty_gif_path)
+end