mailgun-ruby 1.1.2 → 1.2.4

data/spec/integration/email_validation_spec.rb

@@ -28,7 +28,11 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     expected = {
         "address" => "alice@mailgun.net",
         "did_you_mean" => nil,
+        "is_disposable_address" => false,
+        "is_role_address" => false,
         "is_valid" => true,
+        "mailbox_verification" => "true",
+        "reason" => nil,
         "parts" => {
             "display_name" => nil,
             "domain" => "mailgun.net",
@@ -38,13 +42,23 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     expect(res).to eq(expected)
   end
 
+  it 'performs mailbox validation for alice@mailgun.net' do
+    res = @mg_obj.validate("alice@mailgun.net", true)
+
+    expect(res["mailbox_verification"]).to eq("true")
+  end
+
   it 'fails to validate example.org' do
     res = @mg_obj.validate("example.org")
 
     expected = {
         "address" => "example.org",
         "did_you_mean" => nil,
+        "is_disposable_address" => false,
+        "is_role_address" => false,
         "is_valid" => false,
+        "mailbox_verification" => "unknown",
+        "reason" => "Validation failed for 'example.org', reason: 'malformed address; missing @ sign'",
         "parts" => {
             "display_name" => nil,
             "domain" => nil,

data/spec/integration/events_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'mailgun'
+require 'mailgun/events/events'
 
 vcr_opts = { :cassette_name => "events" }
 
@@ -7,9 +8,10 @@ describe 'For the Events endpoint', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
+    @events = Mailgun::Events.new(@mg_obj, @domain)
   end
 
-  it 'get an event.' do
+  it 'can get an event.' do
     result = @mg_obj.get("#{@domain}/events", {:limit => 1})
 
     result.to_h!
@@ -17,4 +19,10 @@ describe 'For the Events endpoint', vcr: vcr_opts do
     expect(result.body["paging"]).to include("next")
     expect(result.body["paging"]).to include("previous")
   end
+
+  it 'can iterate over all events with `each`' do
+    @events.each do |e|
+      expect(e["id"]).to eq("JAx9z641TuGGUyaJlD9sCQ")
+    end
+  end
 end

data/spec/integration/suppressions_spec.rb

@@ -0,0 +1,142 @@
+require 'spec_helper'
+
+require 'mailgun'
+require 'mailgun/suppressions'
+
+vcr_opts = { :cassette_name => 'suppressions' }
+
+describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts do
+
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY)
+    @suppress = Mailgun::Suppressions.new(@mg_obj, TESTDOMAIN)
+
+    @addresses = ['test1@example.com', 'test2@example.org', 'test3@example.net', 'test4@example.info']
+  end
+
+  it 'can batch-add bounces' do
+    bounces = []
+    @addresses.each do |addr|
+      bounces.push({
+        :address => addr,
+        :code => 500,
+        :error => 'integration testing',
+      })
+    end
+
+    response, nested = @suppress.create_bounces bounces
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the bounces table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no bounce[:address] is present' do
+    bounces = []
+    bounces.push({
+      :code => 500,
+      :error => 'integration testing',
+    })
+
+    expect { @suppress.create_bounces bounces }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single bounce address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_bounce addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Bounced address has been removed')
+    end
+  end
+
+  it 'can batch-add unsubscribes with tags as string' do
+    unsubscribes = []
+    @addresses.each do |addr|
+      unsubscribes.push({
+        :address => addr,
+        :tag => 'integration',
+      })
+    end
+
+    response, nested = @suppress.create_unsubscribes unsubscribes
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the unsubscribes table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'can batch-add unsubscribes with tags as array' do
+    unsubscribes = []
+    @addresses.each do |addr|
+      unsubscribes.push({
+        :address => addr,
+        :tags => ['integration'],
+      })
+    end
+
+    response, nested = @suppress.create_unsubscribes unsubscribes
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the unsubscribes table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no unsubscribe[:address] is present' do
+    unsubscribes = []
+    unsubscribes.push({
+      :tag => 'integration',
+    })
+
+    expect { @suppress.create_unsubscribes unsubscribes }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single unsubscribe address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_unsubscribe addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Unsubscribe event has been removed')
+    end
+  end
+
+  it 'can batch-add complaints' do
+    complaints = []
+    @addresses.each do |addr|
+      complaints.push :address => addr
+    end
+
+    response, nested = @suppress.create_complaints complaints
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 complaint addresses have been added to the complaints table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no complaint[:address] is present' do
+    complaints = []
+    complaints.push({
+      :tag => 'integration',
+    })
+
+    expect { @suppress.create_complaints complaints }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single complaint address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_complaint addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Spam complaint has been removed')
+    end
+  end
+
+  # TODO: Add tests for pagination support.
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'base64'
 require 'bundler'
 require 'bundler/setup'
 Bundler.setup(:development)
@@ -37,9 +38,10 @@ TESTDOMAIN = envs['MAILGUN_TESTDOMAIN']
 VCR.configure do |c|
   c.cassette_library_dir = 'vcr_cassettes'
   c.hook_into :webmock
-  c.configure_rspec_metadata!
   c.default_cassette_options = { record: :new_episodes }
   c.filter_sensitive_data('<APIKEY>') { APIKEY }
   c.filter_sensitive_data('DOMAIN.TEST') { TESTDOMAIN }
   c.filter_sensitive_data('<PUBKEY>') { PUB_APIKEY }
+
+  c.configure_rspec_metadata!
 end

data/spec/unit/events/events_spec.rb

@@ -5,19 +5,38 @@ describe 'The method get' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.get()
-    
+
     expect(result.body).to include("items")
     expect(result.body).to include("paging")
   end
 end
 
+describe 'Pagination' do
+  it 'should return a proper hash of log data.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    result = events.get()
+
+    json = JSON.parse(result.body)
+    expect(json).to include("paging")
+    expect(json["paging"]).to include("next")
+    expect(json["paging"]).to include{"previous"}
+  end
+
+  it 'should calculate proper next-page url' do
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    output = events.send(:extract_endpoint_from, '/v3/samples.mailgun.org/events/W3siYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIHsiYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIFsiZiJdLCBudWxsLCBbWyJhY2NvdW50LmlkIiwgIjU4MDUyMTg2NzhmYTE2MTNjNzkwYjUwZiJdLCBbImRvbWFpbi5uYW1lIiwgInNhbmRib3gyOTcwMTUyYWYzZDM0NTU5YmZjN2U3MTcwM2E2Y2YyNC5tYWlsZ3VuLm9yZyJdXSwgMTAwLCBudWxsXQ==')
+
+    expect(output).to eq 'W3siYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIHsiYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIFsiZiJdLCBudWxsLCBbWyJhY2NvdW50LmlkIiwgIjU4MDUyMTg2NzhmYTE2MTNjNzkwYjUwZiJdLCBbImRvbWFpbi5uYW1lIiwgInNhbmRib3gyOTcwMTUyYWYzZDM0NTU5YmZjN2U3MTcwM2E2Y2YyNC5tYWlsZ3VuLm9yZyJdXSwgMTAwLCBudWxsXQ=='
+  end
+end
 
 describe 'The method next' do
   it 'should return the next series of data.' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.next()
-    
+
     expect(result.body).to include("items")
     expect(result.body).to include("paging")
   end
@@ -33,3 +52,18 @@ describe 'The method previous' do
     expect(result.body).to include("paging")
   end
 end
+
+describe 'The method each' do
+  it 'should iterate over all event items.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    # Events from the UnitClient are actually empty.
+    count = 0
+    events.each do |e|
+      count = count + 1
+    end
+
+    # Better than nothing..
+    expect(count).to eq(0)
+  end
+end

data/spec/unit/messages/batch_message_spec.rb

@@ -95,6 +95,7 @@ describe 'The method add_recipient' do
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
     @mb_obj.finalize
 
+    expect(@mb_obj.recipient_variables).to eq({})
     expect(@mb_obj.message['recipient-variables'].length).to eq(0)
     expect(@mb_obj.message[:to].length).to eq(0)
     expect(@mb_obj.counters[:recipients][recipient_type]).to eq(0)

data/spec/unit/messages/message_builder_spec.rb

@@ -50,6 +50,16 @@ 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)
@@ -70,7 +80,7 @@ describe 'The method add_recipient' 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
 
@@ -196,7 +206,7 @@ describe 'The method from' do
     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'
@@ -204,6 +214,21 @@ describe 'The method from' do
 
     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
@@ -231,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
@@ -249,6 +284,31 @@ describe 'The method add_inline_image' do
   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
@@ -400,19 +460,19 @@ describe 'The method track_opens' do
   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")
 
     @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
 
@@ -431,23 +491,23 @@ describe 'The method track_clicks' do
   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")
 
     @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
 end
 
@@ -485,19 +545,35 @@ describe 'The method header' do
   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)
+    @mb_obj.variable('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"}')
+    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
 

data/spec/unit/railgun/content_type_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'mailgun'
+require 'railgun'
+
+describe 'extract_body' do
+
+  let(:text_mail_option) {
+    {
+      from:        'bob@example.com',
+      to:          'sally@example.com',
+      subject:     'RAILGUN TEST SAMPLE',
+      body:         text_content,
+      content_type: 'text/plain',
+    }
+  }
+  let(:text_content) { '[TEST] Hello, world.' }
+
+  let(:html_mail_option) {
+    {
+      from:        'bob@example.com',
+      to:          'sally@example.com',
+      subject:     'RAILGUN TEST SAMPLE',
+      body:         html_content,
+      content_type: 'text/html',
+    }
+  }
+  let(:html_content) { '<h3> [TEST] </h3> <br/> Hello, world!' }
+
+  context 'with <Content-Type: text/plain>' do
+    let(:sample_mail) { Mail.new(text_mail_option) }
+
+    it 'should return body text' do
+      expect(Railgun.extract_body_text(sample_mail)).to eq(text_content)
+    end
+
+    it 'should not return body html' do
+      expect(Railgun.extract_body_html(sample_mail)).to be_nil
+    end
+  end
+
+  context 'with <Content-Type: text/html>' do
+    let(:sample_mail) { Mail.new(html_mail_option) }
+
+    it 'should not return body text' do
+      expect(Railgun.extract_body_text(sample_mail)).to be_nil
+    end
+
+    it 'should return body html' do
+      expect(Railgun.extract_body_html(sample_mail)).to eq(html_content)
+    end
+  end
+
+  context 'with <Content-Type: multipart/alternative>' do
+    let(:text_mail) { Mail.new(text_mail_option) }
+    let(:html_mail) { Mail.new(html_mail_option) }
+
+    before do
+      @sample_mail = Mail::Part.new(content_type: "multipart/alternative")
+      @sample_mail.add_part text_mail
+      @sample_mail.add_part html_mail
+    end
+
+    it 'should return body text' do
+      expect(Railgun.extract_body_text(@sample_mail)).to eq(text_content)
+    end
+
+    it 'should return body html' do
+      expect(Railgun.extract_body_html(@sample_mail)).to eq(html_content)
+    end
+  end
+end