mailgun-ruby 1.1.0 → 1.2.5

data/spec/unit/messages/message_builder_spec.rb

@@ -1,9 +1,10 @@
 require 'spec_helper'
+require 'stringio'
 
 describe 'MessageBuilder attribute readers' do
   it 'should be readable' do
     @mb_obj = Mailgun::MessageBuilder.new()
-    
+
     expect(@mb_obj).to respond_to(:message)
     expect(@mb_obj).to respond_to(:counters)
   end
@@ -49,10 +50,20 @@ describe 'The method add_recipient' do
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
   end
 
+  context 'when variables is empty and recepeint type - "to"' do
+    it 'adds email address as "to" recipient type and increments counter' do
+      recipient_type = :to
+      @mb_obj.add_recipient(recipient_type, @address, {})
+
+      expect(@mb_obj.message[recipient_type][0]).to eq("#{@address}")
+      expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
+    end
+  end
+
   it 'adds a "cc" recipient type to the message body and counter is incremented' do
     recipient_type = :cc
     @mb_obj.add_recipient(recipient_type, @address, @variables)
-    
+
     expect(@mb_obj.message[recipient_type][0]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
   end
@@ -60,7 +71,7 @@ describe 'The method add_recipient' do
   it 'adds a "bcc" recipient type to the message body and counter is incremented' do
     recipient_type = :bcc
     @mb_obj.add_recipient(recipient_type, @address, @variables)
-    
+
     expect(@mb_obj.message[recipient_type][0]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
   end
@@ -68,21 +79,21 @@ describe 'The method add_recipient' do
   it 'adds a "h:reply-to" recipient type to the message body and counters are not incremented' do
     recipient_type = 'h:reply-to'
     @mb_obj.add_recipient(recipient_type, @address, @variables)
-    
-    expect(@mb_obj.message[recipient_type][0]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+
+    expect(@mb_obj.message[recipient_type]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
     @mb_obj.counters[:recipients].each_value{|value| expect(value).to eq(0)}
   end
 
   it 'ensures a random recipient type is added to the message body and counters are not incremented' do
     recipient_type = 'im-not-really-real'
     @mb_obj.add_recipient(recipient_type, @address, @variables)
-    
+
     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
-    
+
     expect{
       1001.times do
         @mb_obj.add_recipient(recipient_type, @address, @variables)
@@ -90,7 +101,7 @@ describe 'The method add_recipient' do
   end
   it 'adds too many cc recipients and raises an exception.' do
     recipient_type = :cc
-    
+
     expect{
       1001.times do
         @mb_obj.add_recipient(recipient_type, @address, @variables)
@@ -98,7 +109,7 @@ describe 'The method add_recipient' do
   end
   it 'adds too many bcc recipients and raises an exception.' do
     recipient_type = :bcc
-    
+
     expect{
       1001.times do
         @mb_obj.add_recipient(recipient_type, @address, @variables)
@@ -118,17 +129,17 @@ describe 'The method subject' do
   before(:each) do
     @mb_obj = Mailgun::MessageBuilder.new
   end
-  
+
   it 'sets the message subject to blank if called and no parameters are provided' do
     @mb_obj.subject
-    
+
     expect(@mb_obj.message[:subject][0]).to eq('')
   end
-  
+
   it 'sets the message subject if called with the subject parameter' do
     the_subject = 'This is my subject!'
     @mb_obj.subject(the_subject)
-    
+
     expect(@mb_obj.message[:subject][0]).to eq(the_subject)
   end
 
@@ -137,7 +148,7 @@ describe 'The method subject' do
     the_second_subject = 'This is my second subject!'
     @mb_obj.subject(the_first_subject)
     @mb_obj.subject(the_second_subject)
-    
+
     expect(@mb_obj.message[:subject].length).to eq(1)
     expect(@mb_obj.message[:subject][0]).to eq(the_second_subject)
   end
@@ -169,7 +180,7 @@ describe 'The method body_text' do
     the_second_text = 'Don\'t mess with Texas!'
     @mb_obj.body_text(the_first_text)
     @mb_obj.body_text(the_second_text)
-    
+
     expect(@mb_obj.message[:text].length).to eq(1)
     expect(@mb_obj.message[:text][0]).to eq(the_second_text)
   end
@@ -187,22 +198,37 @@ describe 'The method from' do
   before(:each) do
     @mb_obj = Mailgun::MessageBuilder.new
   end
-  
+
   it 'sets the from address' do
     the_from_address = 'test@mailgun.com'
     @mb_obj.from(the_from_address)
-    
+
     expect(@mb_obj.message[:from]).to eq([the_from_address])
   end
 
-  it 'sets the from address with metadata' do
+  it 'sets the from address with first/last metadata' do
     the_from_address = 'test@mailgun.com'
     the_first_name = 'Magilla'
     the_last_name = 'Gorilla'
     @mb_obj.from(the_from_address, {'first' => the_first_name, 'last' => the_last_name})
-    
+
     expect(@mb_obj.message[:from]).to eq(["'#{the_first_name} #{the_last_name}' <#{the_from_address}>"])
   end
+
+  it 'sets the from address with full name metadata' do
+    the_from_address = 'test@mailgun.com'
+    full_name = 'Magilla Gorilla'
+    @mb_obj.from(the_from_address, {'full_name' => full_name})
+
+    expect(@mb_obj.message[:from]).to eq(["'#{full_name}' <#{the_from_address}>"])
+  end
+
+  it 'fails when first/last and full_name are used' do
+    the_from_address = 'test@mailgun.com'
+    full_name = 'Magilla Gorilla'
+    first_name = 'Magilla'
+    expect{@mb_obj.from(the_from_address, {'full_name' => full_name, 'first' => first_name})}.to raise_error(Mailgun::ParameterError)
+  end
 end
 
 describe 'The method add_attachment' do
@@ -217,7 +243,7 @@ describe 'The method add_attachment' do
     file_paths = [file1, file2]
 
     file_paths.each {|item| @mb_obj.add_attachment(item)}
-    
+
     expect(@mb_obj.message[:attachment].length).to eq(2)
   end
 
@@ -230,6 +256,16 @@ describe 'The method add_attachment' do
     expect(@mb_obj.message[:attachment].length).to eq(1)
     expect(@mb_obj.message[:attachment].first.original_filename).to eq 'mailgun_icon.png'
   end
+
+  context 'when attachment has unknown type' do
+    it 'sets content type application/octet-stream for attachment' do
+      file = File.dirname(__FILE__) + "/sample_data/unknown.type"
+
+      @mb_obj.add_attachment(file)
+
+      expect(@mb_obj.message[:attachment][0].content_type).to eq('application/octet-stream')
+    end
+  end
 end
 
 describe 'The method add_inline_image' do
@@ -243,16 +279,41 @@ describe 'The method add_inline_image' do
     file_paths = [file1, file2]
 
     file_paths.each {|item| @mb_obj.add_inline_image(item)}
-    
+
     expect(@mb_obj.message[:inline].length).to eq(2)
   end
 end
 
+describe 'The method list_unsubscribe' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+
+  it 'sets the message list_unsubscribe to blank if called and no parameters are provided' do
+    @mb_obj.list_unsubscribe
+    expect(@mb_obj.message['h:List-Unsubscribe']).to eq('')
+  end
+
+  it 'sets the message list_unsubscribe if called with one list_unsubscribe parameter' do
+    unsubscribe_to = 'http://example.com/stop-hassle'
+    @mb_obj.list_unsubscribe(unsubscribe_to)
+    expect(@mb_obj.message['h:List-Unsubscribe']).to eq("<#{unsubscribe_to}>")
+  end
+
+  it 'sets the message list_unsubscribe if called with many list_unsubscribe parameters' do
+    unsubscribe_to = %w(http://example.com/stop-hassle mailto:stop-hassle@example.com)
+    @mb_obj.list_unsubscribe(*unsubscribe_to)
+    expect(@mb_obj.message['h:List-Unsubscribe']).to eq(
+      unsubscribe_to.map { |var| "<#{var}>" }.join(',')
+    )
+  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 'warn on set_test_mode'
+    @mb_obj.set_test_mode 'Yes'
   end
 end
 
@@ -262,29 +323,29 @@ describe 'The method test_mode' do
   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")
     @mb_obj.test_mode("false")
-    
+
     expect(@mb_obj.message["o:testmode"].length).to eq(1)
     expect(@mb_obj.message["o:testmode"][0]).to eq("no")
   end
@@ -294,7 +355,7 @@ 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 'warn on set_dkim'
+    @mb_obj.set_dkim 'Yes'
   end
 end
 
@@ -304,29 +365,29 @@ describe 'The method dkim' do
   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")
     @mb_obj.dkim("false")
-    
+
     expect(@mb_obj.message["o:dkim"].length).to eq(1)
     expect(@mb_obj.message["o:dkim"][0]).to eq("no")
   end
@@ -338,14 +399,14 @@ describe 'The method add_campaign_id' do
   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')
     @mb_obj.add_campaign_id('My-Campaign-Id-3')
-    
+
     expect(@mb_obj.message["o:campaign"][0]).to eq("My-Campaign-Id-1")
     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")
@@ -364,14 +425,14 @@ describe 'The method add_tag' do
   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')
     @mb_obj.add_tag('My-Tag-3')
-    
+
     expect(@mb_obj.message["o:tag"][0]).to eq("My-Tag-1")
     expect(@mb_obj.message["o:tag"][1]).to eq("My-Tag-2")
     expect(@mb_obj.message["o:tag"][2]).to eq("My-Tag-3")
@@ -388,7 +449,7 @@ 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 'warn on set_open_tracking'
+    @mb_obj.set_open_tracking 'Yes'
   end
 end
 
@@ -398,20 +459,21 @@ describe 'The method track_opens' do
   end
   it 'enables/disables open tracking on a per message basis.' do
     @mb_obj.track_opens('Yes')
-    
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("yes")
-    
+
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("yes")
+    expect(@mb_obj.message["o:tracking"]).to eq(["yes"])
+
     @mb_obj.track_opens('No')
-    
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("no")
-    
+
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("no")
+
     @mb_obj.track_opens(true)
-    
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("yes")
-    
+
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("yes")
+
     @mb_obj.track_opens(false)
-    
-    expect(@mb_obj.message["o:tracking-opens"][0]).to eq("no")
+
+    expect(@mb_obj.message["o:tracking-opens"]).to eq("no")
   end
 end
 
@@ -419,7 +481,7 @@ 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 'warn on set_click_tracking'
+    @mb_obj.set_click_tracking 'Yes'
   end
 end
 
@@ -429,24 +491,32 @@ describe 'The method track_clicks' do
   end
   it 'enables/disables click tracking on a per message basis.' do
     @mb_obj.track_clicks('Yes')
-    
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("yes")
-    
+
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("yes")
+    expect(@mb_obj.message["o:tracking"]).to eq(["yes"])
+
     @mb_obj.track_clicks('No')
-    
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("no")
-    
+
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("no")
+
     @mb_obj.track_clicks(true)
-    
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("yes")
-    
+
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("yes")
+
     @mb_obj.track_clicks(false)
-    
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("no")
-    
+
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("no")
+
     @mb_obj.track_clicks('html')
-    
-    expect(@mb_obj.message["o:tracking-clicks"][0]).to eq("html")
+
+    expect(@mb_obj.message["o:tracking-clicks"]).to eq("html")
+  end
+
+  context 'when unexpected value is provided' do
+    it 'warns about prefered values' do
+      expect(@mb_obj).to receive :warn
+      @mb_obj.track_clicks('random')
+    end
   end
 end
 
@@ -464,7 +534,7 @@ describe 'The method deliver_at' do
   end
   it 'defines a time/date to deliver a message in RFC2822 format.' do
     @mb_obj.deliver_at('October 25, 2013 10:00PM CST')
-    
+
     expect(@mb_obj.message["o:deliverytime"][0]).to eq("Fri, 25 Oct 2013 22:00:00 -0600")
   end
 end
@@ -483,20 +553,36 @@ describe 'The method header' do
   end
   it 'accepts valid JSON and appends as data to the message.' do
     @mb_obj.header('my-data', '{"key":"value"}')
-    
-    expect(@mb_obj.message["v:my-data"][0]).to be_kind_of(String)
-    expect(@mb_obj.message["v:my-data"][0].to_s).to eq('{"key"=>"value"}')
+
+    expect(@mb_obj.message["h:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["h:my-data"].to_s).to eq('{"key":"value"}')
+  end
+end
+
+describe 'The method variable' do
+  before(:each) 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_s).to eq('{"key":"value"}')
   end
   it 'accepts a hash and appends as data to the message.' do
     data = {'key' => 'value'}
-    @mb_obj.header('my-data', data)
-    
-    expect(@mb_obj.message["v:my-data"][0]).to be_kind_of(String)
-    expect(@mb_obj.message["v:my-data"][0].to_s).to eq('{"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_s).to eq('{"key":"value"}')
   end
-  it 'throws an exception on broken JSON.' do
-    data = 'This is some crappy JSON.'
-    expect {@mb_obj.header('my-data', data)}.to raise_error(Mailgun::ParameterError)
+  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_s).to eq('String Value.')
   end
 end
 
@@ -506,7 +592,7 @@ describe 'The method add_custom_parameter' do
   end
   it 'adds an undefined parameter to the message.' do
     @mb_obj.add_custom_parameter('h:my-sweet-header', 'datagoeshere')
-    
+
     expect(@mb_obj.message["h:my-sweet-header"][0]).to eq("datagoeshere")
   end
 end
@@ -526,21 +612,121 @@ describe 'The method message_id' do
   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.has_key?('h:Message-Id')).to eq(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.has_key?('h:Message-Id')).to eq(true)
-    
+
     @mb_obj.message_id('')
-    
+
     expect(@mb_obj.message.has_key?('h:Message-Id')).to eq(false)
   end
 end
+
+describe 'The method template' do
+  before(:each) 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'
+      @mb_obj.template(template_name)
+
+      expect(@mb_obj.message['template']).to eq(template_name)
+    end
+  end
+
+  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'
+
+      @mb_obj.template(template_name_1)
+      @mb_obj.template(template_name_2)
+
+      expect(@mb_obj.message['template']).to eq(template_name_2)
+    end
+  end
+
+  context 'when template name is not passed' do
+    it 'it deletes `template` key from the message' do
+      @mb_obj.template('template.name')
+
+      expect(@mb_obj.message.has_key?('template')).to eq(true)
+
+      @mb_obj.template
+
+      expect(@mb_obj.message.has_key?('template')).to eq(false)
+    end
+  end
+end
+
+describe 'The method template_version' do
+  before(:each) 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'
+      @mb_obj.template_version(version)
+
+      expect(@mb_obj.message['t:version']).to eq(version)
+    end
+  end
+
+  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'
+
+      @mb_obj.template_version(version_1)
+      @mb_obj.template_version(version_2)
+
+      expect(@mb_obj.message['t:version']).to eq(version_2)
+    end
+  end
+
+  context 'when version is not passed' do
+    it 'it deletes `t:version` key from the message' do
+      @mb_obj.template_version('version')
+
+      expect(@mb_obj.message.has_key?('t:version')).to eq(true)
+
+      @mb_obj.template_version
+
+      expect(@mb_obj.message.has_key?('t:version')).to eq(false)
+    end
+  end
+end
+
+describe 'The method template_text' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+
+  it 'enables/disables rendering in the text part of the message in case of template sending' do
+    @mb_obj.template_text('Yes')
+
+    expect(@mb_obj.message["t:text"]).to eq("yes")
+
+    @mb_obj.template_text('No')
+
+    expect(@mb_obj.message["t:text"]).to eq("no")
+
+    @mb_obj.template_text(true)
+
+    expect(@mb_obj.message["t:text"]).to eq("yes")
+
+    @mb_obj.template_text(false)
+
+    expect(@mb_obj.message["t:text"]).to eq("no")
+  end
+end