mailgun-ruby 1.4.2 → 1.4.3

data/spec/unit/messages/message_builder_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 require 'stringio'
 
 describe 'MessageBuilder attribute readers' do
-  it 'should be readable' do
+  it 'is readable' do
     @mb_obj = Mailgun::MessageBuilder.new
 
     expect(@mb_obj).to respond_to(:message)
@@ -13,7 +13,7 @@ describe 'MessageBuilder attribute readers' do
 end
 
 describe 'The instantiation of MessageBuilder' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
 
@@ -37,7 +37,7 @@ describe 'The instantiation of MessageBuilder' do
 end
 
 describe 'The method add_recipient' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
     @address = 'jane@example.com'
     @variables = { 'first' => 'Jane', 'last' => 'Doe' }
@@ -92,6 +92,7 @@ describe 'The method add_recipient' do
     expect(@mb_obj.message[recipient_type][0]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
     @mb_obj.counters[:recipients].each_value { |value| expect(value).to eq(0) }
   end
+
   it 'adds too many to recipients and raises an exception.' do
     recipient_type = :to
 
@@ -101,6 +102,7 @@ describe 'The method add_recipient' do
       end
     end.to raise_error(Mailgun::ParameterError)
   end
+
   it 'adds too many cc recipients and raises an exception.' do
     recipient_type = :cc
 
@@ -110,6 +112,7 @@ describe 'The method add_recipient' do
       end
     end.to raise_error(Mailgun::ParameterError)
   end
+
   it 'adds too many bcc recipients and raises an exception.' do
     recipient_type = :bcc
 
@@ -130,7 +133,7 @@ describe 'The method set_subject' do
 end
 
 describe 'The method subject' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
 
@@ -167,18 +170,21 @@ describe 'The method set_text_body' do
 end
 
 describe 'The method body_text' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'sets the body_text to blank if called and no parameters are provided' do
     @mb_obj.body_text
     @mb_obj.message[:text] = ''
   end
+
   it 'sets the message text if called with the body_text parameter' do
     the_text = 'Don\'t mess with Texas!'
     @mb_obj.body_text(the_text)
     @mb_obj.message[:text] = the_text
   end
+
   it 'ensures no duplicate text bodies can exist and last setter is stored' do
     the_first_text = 'Mess with Texas!'
     the_second_text = 'Don\'t mess with Texas!'
@@ -209,7 +215,7 @@ describe 'The method set_from_address' do
 end
 
 describe 'The method from' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
 
@@ -246,9 +252,10 @@ describe 'The method from' do
 end
 
 describe 'The method add_attachment' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'adds a few file paths to the message object' do
     file1 = "#{File.dirname(__FILE__)}/sample_data/mailgun_icon.png"
     file2 = "#{File.dirname(__FILE__)}/sample_data/rackspace_logo.jpg"
@@ -283,9 +290,10 @@ describe 'The method add_attachment' do
 end
 
 describe 'The method add_inline_image' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'adds a few file paths to the message object' do
     file1 = "#{File.dirname(__FILE__)}/sample_data/mailgun_icon.png"
     file2 = "#{File.dirname(__FILE__)}/sample_data/rackspace_logo.jpg"
@@ -299,7 +307,7 @@ describe 'The method add_inline_image' do
 end
 
 describe 'The method list_unsubscribe' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
 
@@ -323,38 +331,35 @@ describe 'The method list_unsubscribe' do
   end
 end
 
-describe 'The method set_test_mode' do
-  it 'warns of set_test_mode deprecation' do
-    @mb_obj = Mailgun::MessageBuilder.new
-    expect(@mb_obj).to receive :warn
-    @mb_obj.set_test_mode 'Yes'
-  end
-end
-
 describe 'The method test_mode' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'turns on test mode with boolean true' do
     @mb_obj.test_mode(true)
 
     expect(@mb_obj.message['o:testmode'][0]).to eq('yes')
   end
+
   it 'turns on test mode with string true' do
     @mb_obj.test_mode('true')
 
     expect(@mb_obj.message['o:testmode'][0]).to eq('yes')
   end
+
   it 'turns off test mode with boolean false' do
     @mb_obj.test_mode(false)
 
     expect(@mb_obj.message['o:testmode'][0]).to eq('no')
   end
+
   it 'turns off test mode with string false' do
     @mb_obj.test_mode('false')
 
     expect(@mb_obj.message['o:testmode'][0]).to eq('no')
   end
+
   it 'does not allow multiple values' do
     @mb_obj.test_mode('false')
     @mb_obj.test_mode('true')
@@ -365,38 +370,35 @@ describe 'The method test_mode' do
   end
 end
 
-describe 'The method set_dkim' do
-  it 'warns of set_dkim deprecation' do
-    @mb_obj = Mailgun::MessageBuilder.new
-    expect(@mb_obj).to receive :warn
-    @mb_obj.set_dkim 'Yes'
-  end
-end
-
 describe 'The method dkim' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'turns on dkim with boolean true' do
     @mb_obj.dkim(true)
 
     expect(@mb_obj.message['o:dkim'][0]).to eq('yes')
   end
+
   it 'turns on dkim with string true' do
     @mb_obj.dkim('true')
 
     expect(@mb_obj.message['o:dkim'][0]).to eq('yes')
   end
+
   it 'turns off dkim with boolean false' do
     @mb_obj.dkim(false)
 
     expect(@mb_obj.message['o:dkim'][0]).to eq('no')
   end
+
   it 'turns off dkim with string false' do
     @mb_obj.dkim('false')
 
     expect(@mb_obj.message['o:dkim'][0]).to eq('no')
   end
+
   it 'does not allow multiple values' do
     @mb_obj.dkim('false')
     @mb_obj.dkim('true')
@@ -408,14 +410,16 @@ describe 'The method dkim' do
 end
 
 describe 'The method add_campaign_id' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'adds a campaign ID to the message' do
     @mb_obj.add_campaign_id('My-Campaign-Id-1')
 
     expect(@mb_obj.message['o:campaign'][0]).to eq('My-Campaign-Id-1')
   end
+
   it 'adds a few more campaign IDs to the message' do
     @mb_obj.add_campaign_id('My-Campaign-Id-1')
     @mb_obj.add_campaign_id('My-Campaign-Id-2')
@@ -425,6 +429,7 @@ describe 'The method add_campaign_id' do
     expect(@mb_obj.message['o:campaign'][1]).to eq('My-Campaign-Id-2')
     expect(@mb_obj.message['o:campaign'][2]).to eq('My-Campaign-Id-3')
   end
+
   it 'adds too many campaign IDs to the message' do
     expect do
       10.times do
@@ -435,14 +440,16 @@ describe 'The method add_campaign_id' do
 end
 
 describe 'The method add_tag' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'adds a tag to the message' do
     @mb_obj.add_tag('My-Tag-1')
 
     expect(@mb_obj.message['o:tag'][0]).to eq('My-Tag-1')
   end
+
   it 'adds a few more tags to the message' do
     @mb_obj.add_tag('My-Tag-1')
     @mb_obj.add_tag('My-Tag-2')
@@ -452,6 +459,7 @@ describe 'The method add_tag' do
     expect(@mb_obj.message['o:tag'][1]).to eq('My-Tag-2')
     expect(@mb_obj.message['o:tag'][2]).to eq('My-Tag-3')
   end
+
   it 'adds too many tags to the message' do
     expect do
       12.times do
@@ -461,18 +469,11 @@ describe 'The method add_tag' do
   end
 end
 
-describe 'The method set_open_tracking' do
-  it 'warns of set_open_tracking deprecation' do
-    @mb_obj = Mailgun::MessageBuilder.new
-    expect(@mb_obj).to receive :warn
-    @mb_obj.set_open_tracking 'Yes'
-  end
-end
-
 describe 'The method track_opens' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'enables/disables open tracking on a per message basis.' do
     @mb_obj.track_opens('Yes')
 
@@ -493,18 +494,11 @@ describe 'The method track_opens' do
   end
 end
 
-describe 'The method set_click_tracking' do
-  it 'warns of set_click_tracking deprecation' do
-    @mb_obj = Mailgun::MessageBuilder.new
-    expect(@mb_obj).to receive :warn
-    @mb_obj.set_click_tracking 'Yes'
-  end
-end
-
 describe 'The method track_clicks' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'enables/disables click tracking on a per message basis.' do
     @mb_obj.track_clicks('Yes')
 
@@ -536,18 +530,11 @@ describe 'The method track_clicks' do
   end
 end
 
-describe 'The method set_delivery_time' do
-  it 'warns of set_delivery_time deprecation' do
-    @mb_obj = Mailgun::MessageBuilder.new
-    expect(@mb_obj).to receive :warn
-    @mb_obj.set_delivery_time 'October 25, 2013 10:00PM CST'
-  end
-end
-
 describe 'The method deliver_at' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'defines a time/date to deliver a message in RFC2822 format.' do
     @mb_obj.deliver_at('October 25, 2013 10:00PM CST')
 
@@ -564,48 +551,53 @@ describe 'The method set_custom_data' do
 end
 
 describe 'The method header' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'accepts valid JSON and appends as data to the message.' do
     @mb_obj.header('my-data', '{"key":"value"}')
 
-    expect(@mb_obj.message['h:my-data']).to be_kind_of(String)
+    expect(@mb_obj.message['h:my-data']).to be_a(String)
     expect(@mb_obj.message['h:my-data'].to_s).to eq('{"key":"value"}')
   end
 end
 
 describe 'The method variable' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'accepts valid JSON and stores it as message[param].' do
     @mb_obj.variable('my-data', '{"key":"value"}')
 
-    expect(@mb_obj.message['v:my-data']).to be_kind_of(String)
+    expect(@mb_obj.message['v:my-data']).to be_a(String)
     expect(@mb_obj.message['v:my-data'].to_s).to eq('{"key":"value"}')
   end
+
   it 'accepts a hash and appends as data to the message.' do
     data = { 'key' => 'value' }
     @mb_obj.variable('my-data', data)
 
-    expect(@mb_obj.message['v:my-data']).to be_kind_of(String)
+    expect(@mb_obj.message['v:my-data']).to be_a(String)
     expect(@mb_obj.message['v:my-data'].to_s).to eq('{"key":"value"}')
   end
+
   it 'accepts string values' do
     data = 'String Value.'
 
     @mb_obj.variable('my-data', data)
 
-    expect(@mb_obj.message['v:my-data']).to be_kind_of(String)
+    expect(@mb_obj.message['v:my-data']).to be_a(String)
     expect(@mb_obj.message['v:my-data'].to_s).to eq('String Value.')
   end
 end
 
 describe 'The method add_custom_parameter' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   it 'adds an undefined parameter to the message.' do
     @mb_obj.add_custom_parameter('h:my-sweet-header', 'datagoeshere')
 
@@ -622,35 +614,39 @@ describe 'The method set_message_id' do
 end
 
 describe 'The method message_id' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
     @the_message_id = '<20141014000000.11111.11111@example.com>'
   end
+
   it 'correctly sets the Message-Id header' do
     @mb_obj.message_id(@the_message_id)
 
     expect(@mb_obj.message['h:Message-Id']).to eq(@the_message_id)
   end
+
   it 'correctly clears the Message-Id header when passed nil' do
     @mb_obj.message_id(nil)
 
-    expect(@mb_obj.message.key?('h:Message-Id')).to eq(false)
+    expect(@mb_obj.message.key?('h:Message-Id')).to be(false)
   end
+
   it 'correctly sets the Message-Id header when passed an empty string' do
     @mb_obj.message_id(@the_message_id)
 
-    expect(@mb_obj.message.key?('h:Message-Id')).to eq(true)
+    expect(@mb_obj.message.key?('h:Message-Id')).to be(true)
 
     @mb_obj.message_id('')
 
-    expect(@mb_obj.message.key?('h:Message-Id')).to eq(false)
+    expect(@mb_obj.message.key?('h:Message-Id')).to be(false)
   end
 end
 
 describe 'The method template' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   context 'when template name is passed' do
     it 'sets `template` to the message' do
       template_name = 'template.name'
@@ -662,33 +658,34 @@ describe 'The method template' do
 
   context 'when multiple values are passed' do
     it 'sets the last value as message template' do
-      template_name_1 = 'template.name_1'
-      template_name_2 = 'template.name_2'
+      template_name1 = 'template.name_1'
+      template_name2 = 'template.name_2'
 
-      @mb_obj.template(template_name_1)
-      @mb_obj.template(template_name_2)
+      @mb_obj.template(template_name1)
+      @mb_obj.template(template_name2)
 
-      expect(@mb_obj.message['template']).to eq(template_name_2)
+      expect(@mb_obj.message['template']).to eq(template_name2)
     end
   end
 
   context 'when template name is not passed' do
-    it 'it deletes `template` key from the message' do
+    it 'deletes `template` key from the message' do
       @mb_obj.template('template.name')
 
-      expect(@mb_obj.message.key?('template')).to eq(true)
+      expect(@mb_obj.message.key?('template')).to be(true)
 
       @mb_obj.template
 
-      expect(@mb_obj.message.key?('template')).to eq(false)
+      expect(@mb_obj.message.key?('template')).to be(false)
     end
   end
 end
 
 describe 'The method template_version' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
+
   context 'when template version is passed' do
     it 'adds `t:version` key value to the message' do
       version = 'version_1'
@@ -700,31 +697,31 @@ describe 'The method template_version' do
 
   context 'when multiple values are passed' do
     it 'adds the last value as `t:version` key value to the message' do
-      version_1 = 'version_1'
-      version_2 = 'version_2'
+      version1 = 'version_1'
+      version2 = 'version_2'
 
-      @mb_obj.template_version(version_1)
-      @mb_obj.template_version(version_2)
+      @mb_obj.template_version(version1)
+      @mb_obj.template_version(version2)
 
-      expect(@mb_obj.message['t:version']).to eq(version_2)
+      expect(@mb_obj.message['t:version']).to eq(version2)
     end
   end
 
   context 'when version is not passed' do
-    it 'it deletes `t:version` key from the message' do
+    it 'deletes `t:version` key from the message' do
       @mb_obj.template_version('version')
 
-      expect(@mb_obj.message.key?('t:version')).to eq(true)
+      expect(@mb_obj.message.key?('t:version')).to be(true)
 
       @mb_obj.template_version
 
-      expect(@mb_obj.message.key?('t:version')).to eq(false)
+      expect(@mb_obj.message.key?('t:version')).to be(false)
     end
   end
 end
 
 describe 'The method template_text' do
-  before(:each) do
+  before do
     @mb_obj = Mailgun::MessageBuilder.new
   end
 

data/spec/unit/railgun/content_type_spec.rb

@@ -41,11 +41,11 @@ describe 'extract_body' do
   context 'with <Content-Type: text/plain>' do
     let(:sample_mail) { Mail.new(text_mail_option) }
 
-    it 'should return body text' do
+    it 'returns body text' do
       expect(Railgun.extract_body_text(sample_mail)).to eq(text_content)
     end
 
-    it 'should not return body html' do
+    it 'does not return body html' do
       expect(Railgun.extract_body_html(sample_mail)).to be_nil
     end
   end
@@ -53,11 +53,11 @@ describe 'extract_body' do
   context 'with <Content-Type: text/html>' do
     let(:sample_mail) { Mail.new(html_mail_option) }
 
-    it 'should not return body text' do
+    it 'does not return body text' do
       expect(Railgun.extract_body_text(sample_mail)).to be_nil
     end
 
-    it 'should return body html' do
+    it 'returns body html' do
       expect(Railgun.extract_body_html(sample_mail)).to eq(html_content)
     end
   end
@@ -74,15 +74,15 @@ describe 'extract_body' do
       @sample_mail.add_part html_mail
     end
 
-    it 'should return body text' do
+    it 'returns body text' do
       expect(Railgun.extract_body_text(@sample_mail)).to eq(text_content)
     end
 
-    it 'should return body html' do
+    it 'returns body html' do
       expect(Railgun.extract_body_html(@sample_mail)).to eq(html_content)
     end
 
-    it 'should return AMP html' do
+    it 'returns AMP html' do
       expect(Railgun.extract_amp_html(@sample_mail)).to eq(amp_content)
     end
   end

data/spec/unit/railgun/mailer_spec.rb

@@ -162,17 +162,20 @@ describe 'Railgun::Mailer' do
   end
 
   it 'properly handles headers that are passed as separate POST params' do
-    message = UnitTestMailer.plain_message('test@example.org', 'Test!', {
-                                             # `From`, `To`, and `Subject` are set on the envelope, so they should be ignored as headers
-                                             'From' => 'units@example.net',
-                                             'To' => 'user@example.com',
-                                             'Subject' => 'This should disappear',
-                                             # If `Bcc` or `Cc` are set as headers, they should be carried over as POST params, not headers
-                                             'Bcc' => ['list@example.org'],
-                                             'Cc' => ['admin@example.com'],
-                                             # This is an arbitrary header and should be carried over properly
-                                             'X-Source' => 'unit tests'
-                                           })
+    message = UnitTestMailer.plain_message(
+      'test@example.org', 'Test!',
+      {
+        # `From`, `To`, and `Subject` are set on the envelope, so they should be ignored as headers
+        'From' => 'units@example.net',
+        'To' => 'user@example.com',
+        'Subject' => 'This should disappear',
+        # If `Bcc` or `Cc` are set as headers, they should be carried over as POST params, not headers
+        'Bcc' => ['list@example.org'],
+        'Cc' => ['admin@example.com'],
+        # This is an arbitrary header and should be carried over properly
+        'X-Source' => 'unit tests'
+      }
+    )
 
     body = Railgun.transform_for_mailgun(message)
 
@@ -202,7 +205,7 @@ describe 'Railgun::Mailer' do
         }
       end
       body = Railgun.transform_for_mailgun(message)
-      expect(body['v:my-data']).to be_kind_of(String)
+      expect(body['v:my-data']).to be_a(String)
       expect(body['v:my-data'].to_s).to eq('{"key":"value"}')
     end
 
@@ -214,7 +217,7 @@ describe 'Railgun::Mailer' do
       end
       body = Railgun.transform_for_mailgun(message)
 
-      expect(body['v:my-data']).to be_kind_of(String)
+      expect(body['v:my-data']).to be_a(String)
       expect(body['v:my-data'].to_s).to eq('{"key":"value"}')
     end
 
@@ -226,7 +229,7 @@ describe 'Railgun::Mailer' do
       end
       body = Railgun.transform_for_mailgun(message)
 
-      expect(body['v:my-data']).to be_kind_of(String)
+      expect(body['v:my-data']).to be_a(String)
       expect(body['v:my-data'].to_s).to eq('String Value.')
     end
   end