mailgun-ruby 1.1.8 → 1.2.3

data/mailgun.gemspec

@@ -22,16 +22,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'webmock', '~> 1.22'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.11'
-
-  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_development_dependency 'bundler', '>= 1.16.2'
+  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'rake', '~> 12.3.2'
+  spec.add_development_dependency 'webmock', '~> 3.4.2'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'vcr', '~> 3.0.3'
+  spec.add_development_dependency 'simplecov', '~> 0.16.1'
+  spec.add_development_dependency 'rails'
+  spec.add_dependency 'rest-client', '>= 2.0.2'
 
 end

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",
@@ -50,7 +54,11 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     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

@@ -22,7 +22,7 @@ describe 'For the Events endpoint', vcr: vcr_opts do
 
   it 'can iterate over all events with `each`' do
     @events.each do |e|
-      expect(e.id).to eq("JAx9z641TuGGUyaJlD9sCQ")
+      expect(e["id"]).to eq("JAx9z641TuGGUyaJlD9sCQ")
     end
   end
 end

data/spec/integration/suppressions_spec.rb

@@ -52,7 +52,7 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
     end
   end
 
-  it 'can batch-add unsubscribes' do
+  it 'can batch-add unsubscribes with tags as string' do
     unsubscribes = []
     @addresses.each do |addr|
       unsubscribes.push({
@@ -69,6 +69,23 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
     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({
@@ -123,4 +140,3 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
 
   # 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

@@ -11,6 +11,25 @@ describe 'The method get' do
   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

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)
@@ -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
@@ -425,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
 
@@ -456,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
 

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

data/spec/unit/railgun/mailer_spec.rb

@@ -0,0 +1,229 @@
+require 'json'
+require 'logger'
+require 'spec_helper'
+require 'mailgun'
+require 'railgun'
+
+ActionMailer::Base.raise_delivery_errors = true
+ActionMailer::Base.delivery_method = :test
+Rails.logger = Logger.new('/dev/null')
+Rails.logger.level = Logger::DEBUG
+
+class UnitTestMailer < ActionMailer::Base
+  default from: 'unittest@example.org'
+
+  def plain_message(address, subject, headers)
+    headers(headers)
+    mail(to: address, subject: subject) do |format|
+      format.text { render plain: "Test!" }
+      format.html { render html: "<p>Test!</p>".html_safe }
+    end
+  end
+
+  def message_with_attachment(address, subject)
+    attachments['info.txt'] = {
+      :content => File.read('docs/railgun/Overview.md'),
+      :mime_type => 'text/plain',
+    }
+    mail(to: address, subject: subject) do |format|
+      format.text { render plain: "Test!" }
+      format.html { render html: "<p>Test!</p>".html_safe }
+    end
+  end
+
+end
+
+describe 'Railgun::Mailer' do
+
+  it 'has a mailgun_client property which returns a Mailgun::Client' do
+    config = {
+      api_key:  {},
+      domain:   {}
+    }
+    @mailer_obj = Railgun::Mailer.new(config)
+
+    expect(@mailer_obj.mailgun_client).to be_a(Mailgun::Client)
+  end
+
+  it 'properly creates a message body' do
+    message = UnitTestMailer.plain_message('test@example.org', 'Test!', {})
+    body = Railgun.transform_for_mailgun(message)
+
+    [:from, :subject, :text, :html, 'to'].each do |param|
+      expect(body).to include(param)
+    end
+
+    expect(body[:from][0].value).to eq('unittest@example.org')
+    expect(body['to']).to eq(['test@example.org'])
+    expect(body[:subject]).to eq(['Test!'])
+    expect(body[:text]).to eq(['Test!'])
+    expect(body[:html]).to eq(['<p>Test!</p>'.html_safe])
+  end
+
+  it 'adds options to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_options ||= {
+      'tracking-opens' => 'true',
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('o:tracking-opens')
+    expect(body['o:tracking-opens']).to eq('true')
+  end
+
+  it 'accepts frozen options to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_options ||= {
+      'tags' => ['some-tag']
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('o:tags')
+    expect(body['o:tags']).to eq(['some-tag'])
+  end
+
+  it 'adds variables to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_variables ||= {
+      'user' => {:id => '1', :name => 'tstark'},
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('v:user')
+
+    var_body = JSON.load(body['v:user'])
+    expect(var_body).to include('id')
+    expect(var_body).to include('name')
+    expect(var_body['id']).to eq('1')
+    expect(var_body['name']).to eq('tstark')
+  end
+
+  it 'adds headers to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_headers ||= {
+      'x-unit-test' => 'true',
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('h:x-unit-test')
+    expect(body['h:x-unit-test']).to eq('true')
+  end
+
+  it 'adds headers to message body from mailer' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'x-unit-test-2' => 'true',
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('h:x-unit-test-2')
+    expect(body['h:x-unit-test-2']).to eq('true')
+  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',
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+
+    ['From', 'To', 'Subject'].each do |header|
+      expect(body).not_to include("h:#{header}")
+    end
+
+    ['bcc', 'cc', 'to', 'h:x-source'].each do |param|
+      expect(body).to include(param)
+    end
+
+    expect(body[:from][0].value).to eq('unittest@example.org')
+    expect(body['to']).to eq(['test@example.org'])
+    expect(body[:subject]).to eq(['Test!'])
+    expect(body[:text]).to eq(['Test!'])
+    expect(body[:html]).to eq(['<p>Test!</p>'.html_safe])
+    expect(body['bcc']).to eq(['list@example.org'])
+    expect(body['cc']).to eq(['admin@example.com'])
+    expect(body['h:x-source']).to eq('unit tests')
+  end
+
+  it 'properly adds attachments' do
+    message = UnitTestMailer.message_with_attachment('test@example.org', '')
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include(:attachment)
+    attachment = body[:attachment][0]
+
+    expect(attachment.filename).to eq('info.txt')
+    expect(attachment.content_type).to eq('text/plain')
+  end
+
+  it 'delivers!' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.deliver_now
+
+    expect(ActionMailer::Base.deliveries).to include(message)
+  end
+
+  it 'ignores `reply-to` in headers' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'reply-to' => 'user@example.com',
+    })
+    message.mailgun_headers = {
+      'Reply-To' => 'administrator@example.org',
+    }
+    message.headers({'REPLY-TO' => 'admin@example.net'})
+    message.reply_to = "dude@example.com.au"
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:reply-to')
+    expect(body).not_to include('h:Reply-To')
+    expect(body['h:reply-to']).to eq('dude@example.com.au')
+  end
+
+  it 'treats `headers()` names as case-insensitve' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'X-BIG-VALUE' => 1,
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:x-big-value')
+    expect(body['h:x-big-value']).to eq("1")
+  end
+
+  it 'treats `mailgun_headers` names as case-insensitive' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_headers = {
+      'X-BIG-VALUE' => 1,
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:x-big-value')
+    expect(body['h:x-big-value']).to eq("1")
+  end
+
+  it 'handles multi-value, mixed case headers correctly' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.headers({
+      'x-neat-header' => 'foo',
+      'X-Neat-Header' => 'bar',
+      'X-NEAT-HEADER' => 'zoop',
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:x-neat-header')
+    expect(body['h:x-neat-header']).to include('foo')
+    expect(body['h:x-neat-header']).to include('bar')
+    expect(body['h:x-neat-header']).to include('zoop')
+  end
+end