mailgun-ruby 1.0.0

data/spec/unit/messages/message_builder_spec.rb

@@ -0,0 +1,359 @@
+require 'spec_helper'
+
+describe 'MessageBuilder attribute readers' do
+  it 'should be readable' do
+    @mb_obj = Mailgun::MessageBuilder.new()
+    @mb_obj.should respond_to(:message)
+    @mb_obj.should respond_to(:counters)
+  end
+end
+
+describe 'The instantiation of MessageBuilder' do
+
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new()
+  end
+
+  it 'contains Message, which should be of type Multimap and empty' do
+    @mb_obj.message.should be_a(Multimap)
+    @mb_obj.message.length.should eq(0)
+  end
+
+  it 'contains counters, which should be of type hash and contain several important counters' do
+    @mb_obj.counters.should be_a(Hash)
+    @mb_obj.counters.should include(:recipients)
+  end
+
+  it 'contains counters, which should be of type hash and contain several important counters' do
+    @mb_obj.counters.should be_a(Hash)
+    @mb_obj.counters.should include(:recipients)
+    @mb_obj.counters[:recipients].should include(:to)
+    @mb_obj.counters[:recipients].should include(:cc)
+    @mb_obj.counters[:recipients].should include(:bcc)
+    @mb_obj.counters.should include(:attributes)
+    @mb_obj.counters[:attributes].should include(:attachment)
+    @mb_obj.counters[:attributes].should include(:campaign_id)
+    @mb_obj.counters[:attributes].should include(:custom_option)
+    @mb_obj.counters[:attributes].should include(:tag)
+  end
+end
+
+describe 'The method add_recipient' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+    @address = 'jane@example.com'
+    @variables = {'first' => 'Jane', 'last' => 'Doe'}
+  end
+
+  it 'adds a "to" recipient type to the message body and counter is incremented' do
+    recipient_type = :to
+    @mb_obj.add_recipient(recipient_type, @address, @variables)
+    @mb_obj.message[recipient_type][0].should eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+    @mb_obj.counters[:recipients][recipient_type].should eq(1)
+  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)
+    @mb_obj.message[recipient_type][0].should eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+    @mb_obj.counters[:recipients][recipient_type].should eq(1)
+  end
+
+  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)
+    @mb_obj.message[recipient_type][0].should eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+    @mb_obj.counters[:recipients][recipient_type].should eq(1)
+  end
+
+  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)
+    @mb_obj.message[recipient_type][0].should eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+    @mb_obj.counters[:recipients].each_value{|value| value.should 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)
+    @mb_obj.message[recipient_type][0].should eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+    @mb_obj.counters[:recipients].each_value{|value| value.should 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)
+    end }.to raise_error(Mailgun::ParameterError)
+  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)
+    end }.to raise_error(Mailgun::ParameterError)
+  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)
+    end }.to raise_error(Mailgun::ParameterError)
+  end
+end
+
+describe 'The method set_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.set_subject
+    @mb_obj.message[:subject][0].should eq('')
+  end
+  it 'sets the message subject if called with the subject parameter' do
+    the_subject = 'This is my subject!'
+    @mb_obj.set_subject(the_subject)
+    @mb_obj.message[:subject][0].should eq(the_subject)
+  end
+  it 'ensures no duplicate subjects can exist and last setter is stored' do
+    the_first_subject = 'This is my first subject!'
+    the_second_subject = 'This is my second subject!'
+    @mb_obj.set_subject(the_first_subject)
+    @mb_obj.set_subject(the_second_subject)
+    @mb_obj.message[:subject].length.should eq(1)
+    @mb_obj.message[:subject][0].should eq(the_second_subject)
+  end
+end
+
+describe 'The method set_text_body' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'sets the text_body to blank if called and no parameters are provided' do
+    @mb_obj.set_text_body
+    @mb_obj.message[:text] = ''
+  end
+  it 'sets the message text if called with the text_body parameter' do
+    the_text = 'Don\'t mess with Texas!'
+    @mb_obj.set_text_body(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!'
+    @mb_obj.set_text_body(the_first_text)
+    @mb_obj.set_text_body(the_second_text)
+    @mb_obj.message[:text].length.should eq(1)
+    @mb_obj.message[:text][0].should eq(the_second_text)
+  end
+end
+
+describe 'The method add_attachment' do
+  before(:each) 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"
+
+    file_paths = [file1, file2]
+
+    file_paths.each {|item| @mb_obj.add_attachment(item)}
+    @mb_obj.message[:attachment].length.should eq(2)
+  end
+end
+
+describe 'The method add_inline_image' do
+  before(:each) 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"
+
+    file_paths = [file1, file2]
+
+    file_paths.each {|item| @mb_obj.add_inline_image(item)}
+    @mb_obj.message[:inline].length.should eq(2)
+  end
+end
+
+describe 'The method set_test_mode' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'turns on test mode with boolean true' do
+    @mb_obj.set_test_mode(true)
+    @mb_obj.message["o:testmode"][0].should eq ("yes")
+  end
+  it 'turns on test mode with string true' do
+    @mb_obj.set_test_mode("true")
+    @mb_obj.message["o:testmode"][0].should eq ("yes")
+  end
+  it 'turns off test mode with boolean false' do
+    @mb_obj.set_test_mode(false)
+    @mb_obj.message["o:testmode"][0].should eq ("no")
+  end
+  it 'turns off test mode with string false' do
+    @mb_obj.set_test_mode("false")
+    @mb_obj.message["o:testmode"][0].should eq ("no")
+  end
+  it 'does not allow multiple values' do
+    @mb_obj.set_test_mode("false")
+    @mb_obj.set_test_mode("true")
+    @mb_obj.set_test_mode("false")
+    @mb_obj.message["o:testmode"].length.should eq(1)
+    @mb_obj.message["o:testmode"][0].should eq ("no")
+  end
+end
+
+describe 'The method set_dkim' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'turns on dkim with boolean true' do
+    @mb_obj.set_dkim(true)
+    @mb_obj.message["o:dkim"][0].should eq ("yes")
+  end
+  it 'turns on dkim with string true' do
+    @mb_obj.set_dkim("true")
+    @mb_obj.message["o:dkim"][0].should eq ("yes")
+  end
+  it 'turns off dkim with boolean false' do
+    @mb_obj.set_dkim(false)
+    @mb_obj.message["o:dkim"][0].should eq ("no")
+  end
+  it 'turns off dkim with string false' do
+    @mb_obj.set_dkim("false")
+    @mb_obj.message["o:dkim"][0].should eq ("no")
+  end
+  it 'does not allow multiple values' do
+    @mb_obj.set_dkim("false")
+    @mb_obj.set_dkim("true")
+    @mb_obj.set_dkim("false")
+    @mb_obj.message["o:dkim"].length.should eq(1)
+    @mb_obj.message["o:dkim"][0].should eq ("no")
+  end
+end
+
+describe 'The method add_campaign_id' do
+  before(:each) 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')
+    @mb_obj.message["o:campaign"][0].should 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')
+    @mb_obj.message["o:campaign"][0].should eq ("My-Campaign-Id-1")
+    @mb_obj.message["o:campaign"][1].should eq ("My-Campaign-Id-2")
+    @mb_obj.message["o:campaign"][2].should eq ("My-Campaign-Id-3")
+  end
+  it 'adds too many campaign IDs to the message' do
+    expect{
+      10.times do
+        @mb_obj.add_campaign_id('Test-Campaign-ID')
+    end }.to raise_error(Mailgun::ParameterError)
+  end
+end
+
+describe 'The method add_tag' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'adds a tag to the message' do
+    @mb_obj.add_tag('My-Tag-1')
+    @mb_obj.message["o:tag"][0].should 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')
+    @mb_obj.message["o:tag"][0].should eq ("My-Tag-1")
+    @mb_obj.message["o:tag"][1].should eq ("My-Tag-2")
+    @mb_obj.message["o:tag"][2].should eq ("My-Tag-3")
+  end
+  it 'adds too many tags to the message' do
+    expect{
+      10.times do
+        @mb_obj.add_tag('My-Tag')
+    end }.to raise_error(Mailgun::ParameterError)
+  end
+end
+
+describe 'The method set_open_tracking' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'enables/disables open tracking on a per message basis.' do
+    @mb_obj.set_open_tracking('Yes')
+    @mb_obj.message["o:tracking-opens"][0].should eq ("yes")
+    @mb_obj.set_open_tracking('No')
+    @mb_obj.message["o:tracking-opens"][0].should eq ("no")
+    @mb_obj.set_open_tracking(true)
+    @mb_obj.message["o:tracking-opens"][0].should eq ("yes")
+    @mb_obj.set_open_tracking(false)
+    @mb_obj.message["o:tracking-opens"][0].should eq ("no")
+  end
+end
+
+describe 'The method set_click_tracking' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'enables/disables click tracking on a per message basis.' do
+    @mb_obj.set_click_tracking('Yes')
+    @mb_obj.message["o:tracking-clicks"][0].should eq ("yes")
+    @mb_obj.set_click_tracking('No')
+    @mb_obj.message["o:tracking-clicks"][0].should eq ("no")
+    @mb_obj.set_click_tracking(true)
+    @mb_obj.message["o:tracking-clicks"][0].should eq ("yes")
+    @mb_obj.set_click_tracking(false)
+    @mb_obj.message["o:tracking-clicks"][0].should eq ("no")
+    @mb_obj.set_click_tracking('html')
+    @mb_obj.message["o:tracking-clicks"][0].should eq ("html")
+  end
+end
+
+describe 'The method set_delivery_time' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'defines a time/date to deliver a message in RFC2822 format.' do
+    @mb_obj.set_delivery_time('October 25, 2013 10:00PM CST')
+    @mb_obj.message["o:deliverytime"][0].should eq ("Fri, 25 Oct 2013 22:00:00 -0600")
+  end
+end
+
+describe 'The method set_custom_data' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'accepts valid JSON and appends as data to the message.' do
+    @mb_obj.set_custom_data('my-data', '{"key":"value"}')
+    @mb_obj.message["v:my-data"][0].should eq ("{\"key\":\"value\"}")
+  end
+  it 'accepts a hash and appends as data to the message.' do
+    data = {'key'=> 'value'}
+    @mb_obj.set_custom_data('my-data', data)
+    @mb_obj.message["v:my-data"][0].should eq ("{\"key\":\"value\"}")
+  end
+  it 'throws an exception on broken JSON.' do
+    data = 'This is some crappy JSON.'
+    expect {@mb_obj.set_custom_data('my-data', data)}.to raise_error(Mailgun::ParameterError)
+  end
+end
+
+describe 'The method add_custom_parameter' do
+  before(:each) 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')
+    @mb_obj.message["h:my-sweet-header"][0].should eq ("datagoeshere")
+  end
+end

data/spec/unit/messages/sample_data/mime.txt

@@ -0,0 +1,38 @@
+X-SBRS: 5.6
+X-SenderGroup: WHITELIST
+X-MailFlowPolicy: $TRUSTED
+DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=trstx.com; q=dns/txt; s=mx;
+ t=1381182797; h=Mime-Version: Content-Type: Subject: From: To:
+ Message-Id: Date: Sender: Content-Transfer-Encoding;
+ bh=r6P1omjKL3m7gDuZC6dZEJU6trgWm1IRwAJb8h4wtfg=; b=UPFaFGiuDx2yZjCmiMEji0fIXvGMNwXUsuaX4Ss9p5EUkqE25eYjeJaJZ5w5FK+t0jsUPZqu
+ FIH6sftQv7GBEbSktY6sv7dgv5q2yVlY8YNG7CXvUZdWmvwfQVvfL9j1RHJo9H3QpXT9c8bZ
+ p9rpYmqZtZEz2ZesPj4kzUaB0lU=
+DomainKey-Signature: a=rsa-sha1; c=nofws; d=trstx.com; s=mx; q=dns;
+ h=Mime-Version: Content-Type: Subject: From: To: Message-Id: Date:
+ Sender: Content-Transfer-Encoding;
+ b=QUYQf9OP16DphNAjeF95+G7V6DaqL4FA+m1sjIEWHdLzrGTQkiYTpzJdne3lzSypB0DwaG
+ AT9zOhjjN64DWFOkJD2Ce5t6vfHa/GC3FCUMq3xz/Big94g+kOciawkHyUhCrmPyh/D7kWx1
+ J75UIAdmE9XQ9bCSPhZ2MRaOv7b8c=
+Received: by luna.mailgun.net with HTTP; Mon, 07 Oct 2013 21:53:16 +0000
+Content-Type: text/plain; charset="ascii"
+Subject: Test Subject
+From: <joe@example.com>
+To: <bob@sample.com>
+Message-ID: <20131007215316.27052.7818@example.com>
+X-Mailgun-Sid: WyI4MzY1OSIsICJ0cmF2aXMuc3dpZW50ZWtAcmFja3NwYWasdfewNvbSIsICJjZjQ4Il0=
+Date: Mon, 7 Oct 2013 21:53:17 +0000
+Sender: <joe@example.com>
+Content-Transfer-Encoding: 7bit
+MIME-Version: 1.0
+
+--3a8c26e9f23c4ac193606295aa17fa6f
+Content-Type: text/plain; charset="ascii"
+Content-Transfer-Encoding: 7bit
+
+Testing some Mailgun awesomness!
+--3a8c26e9f23c4ac193606295aa17fa6f
+Content-Type: text/html; charset="ascii"
+Content-Transfer-Encoding: 7bit
+
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">Test
+--3a8c26e9f23c4ac193606295aa17fa6f--

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: mailgun-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mailgun
+- Travis Swientek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: multimap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: This Gem allows you to interact with Mailgun's API. A few utilities are
+  included!
+email: support@mailgunhq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- MessageBuilder.md
+- Messages.md
+- OptInHandler.md
+- README.md
+- Rakefile
+- Snippets.md
+- lib/mailgun.rb
+- lib/mailgun/exceptions/exceptions.rb
+- lib/mailgun/lists/opt_in_handler.rb
+- lib/mailgun/messages/batch_message.rb
+- lib/mailgun/messages/message_builder.rb
+- lib/mailgun/version.rb
+- mailgun.gemspec
+- spec/integration/mailgun_spec.rb
+- spec/integration/messages/sample_data/mime.txt
+- spec/spec_helper.rb
+- spec/unit/connection/test_client.rb
+- spec/unit/lists/opt_in_handler_spec.rb
+- spec/unit/mailgun_spec.rb
+- spec/unit/messages/batch_message_spec.rb
+- spec/unit/messages/message_builder_spec.rb
+- spec/unit/messages/sample_data/mailgun_icon.png
+- spec/unit/messages/sample_data/mime.txt
+- spec/unit/messages/sample_data/rackspace_logo.jpg
+homepage: http://www.mailgun.com
+licenses:
+- Apache
+metadata: {}
+post_install_message: "\n    ---------------------------------------------------------------\n
+  \   Congrats, you've successfully installed the Mailgun SDK! \n    Check out our
+  documentation at http://documentation.mailgun.com\n\n    Contact us at support@mailgunhq.com
+  with any questions.\n    ----------------------------------------------------------------\n
+  \ "
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Mailgun's Official Ruby SDK
+test_files:
+- spec/integration/mailgun_spec.rb
+- spec/integration/messages/sample_data/mime.txt
+- spec/spec_helper.rb
+- spec/unit/connection/test_client.rb
+- spec/unit/lists/opt_in_handler_spec.rb
+- spec/unit/mailgun_spec.rb
+- spec/unit/messages/batch_message_spec.rb
+- spec/unit/messages/message_builder_spec.rb
+- spec/unit/messages/sample_data/mailgun_icon.png
+- spec/unit/messages/sample_data/mime.txt
+- spec/unit/messages/sample_data/rackspace_logo.jpg