mailgun-ruby 1.1.8 → 1.2.5

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/mailer_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'json'
+require 'logger'
+require 'railgun'
+require 'mailgun'
+require 'mailgun/exceptions/exceptions'
+
+ActionMailer::Base.raise_delivery_errors = true
+Rails.logger = Logger.new('/dev/null')
+Rails.logger.level = Logger::DEBUG
+
+class UnitTestMailer < ActionMailer::Base
+  default from: 'unittest@example.org'
+
+  def plain_message(address, from, subject, headers)
+    headers(headers)
+    mail(to: address, from: from, subject: subject) do |format|
+      format.text { render plain: 'Test!' }
+      format.html { render html: '<p>Test!</p>'.html_safe }
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => 'message_deliver' }
+
+describe 'Message deliver', vcr: vcr_opts do
+  let(:domain) { TESTDOMAIN }
+  let(:config) do
+    {
+      api_key: APIKEY,
+      domain: domain
+    }
+  end
+  let(:mail) { UnitTestMailer.plain_message("bob@#{domain}", "bob@#{domain}", 'subject', {}) }
+
+  it 'successfully delivers message' do
+    result = Railgun::Mailer.new(config).deliver!(mail)
+    result.to_h!
+
+    expect(result.body['message']).to eq('Queued. Thank you.')
+    expect(result.body).to include('id')
+    expect(result.code).to eq(200)
+  end
+end
+
+vcr_opts = { :cassette_name => 'mailer_invalid_domain' }
+
+describe 'Invalid domain', vcr: vcr_opts do
+  let(:domain) { 'not-our-doma.in' }
+  let(:config) do
+    {
+      api_key: APIKEY,
+      domain: domain
+    }
+  end
+  let(:mail) { UnitTestMailer.plain_message("bob@#{domain}", 'sally@not-our-doma.in' 'subject', {}) }
+
+  it 'raises expected error' do
+
+    Railgun::Mailer.new(config).deliver!(mail)
+  rescue Mailgun::CommunicationError => err
+    expect(err.message).to eq('401 Unauthorized: Forbidden - Invalid Domain or API key')
+  else
+    fail
+
+  end
+end

data/spec/integration/mailgun_spec.rb

@@ -63,6 +63,9 @@ describe 'The method send_message()', vcr: vcr_opts do
              :to => "bob@#{@domain}",
              :subject => "Test",
              :text => "Test Data" }
+    uuid = 'uuid'
+
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
 
     result = @mg_obj.send_message(@domain, data)
 
@@ -72,7 +75,7 @@ describe 'The method send_message()', vcr: vcr_opts do
     expect(result.body).to include("id")
 
     expect(result.code).to eq(200)
-    expect(result.body['id']).to eq("test-mode-mail@localhost")
+    expect(result.body['id']).to eq("test-mode-mail-#{uuid}@localhost")
     expect(result.body['message']).to eq("Queued. Thank you.")
   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/connection/test_client.rb

@@ -23,6 +23,7 @@ module Mailgun
     end
 
     def send_message(working_domain, data)
+      perform_data_validation(working_domain, data)
       case data
       when Hash
         if data.has_key?(:message)
@@ -75,6 +76,21 @@ module Mailgun
 
     private
 
+    def perform_data_validation(working_domain, data)
+      fail ParameterError.new('Missing working domain', working_domain) unless working_domain
+      return true unless data.is_a?(Hash) && data.present?
+      message = data.respond_to?(:message) ? data.message : data
+
+      fail ParameterError.new(
+        'Missing `to` recipient, message should containg at least 1 recipient',
+        working_domain
+      ) if message.fetch('to', []).empty? && message.fetch(:to, []).empty?
+      fail ParameterError.new(
+        'Missing a `from` sender, message should containg at least 1 `from` sender',
+        working_domain
+      ) if message.fetch('from', []).empty? && message.fetch(:from, []).empty?
+    end
+
     def response_generator(resource_endpoint)
       if resource_endpoint == "messages"
         t = Time.now

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/mailgun_spec.rb

@@ -37,8 +37,11 @@ describe 'The method send_message()' do
   end
 
   it 'opens the message MIME and sends the MIME message.' do
-    data = {'to' => 'joe@test.com',
-                    'message' => 'Sample Data/mime.txt'}
+    data = {
+      'to' => 'joe@test.com',
+      'message' => 'Sample Data/mime.txt',
+      'from' => 'joe@test.com'
+    }
     result = @mg_obj.send_message("testdomain.com", data)
 
     result.to_h!
@@ -46,6 +49,25 @@ describe 'The method send_message()' do
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
+
+  context 'when domain is missing' do
+    it 'shows failure message' do
+      expect(@mg_obj).to receive(:fail)
+      @mg_obj.send_message(nil, {})
+    end
+  end
+
+  context 'when to is missing' do
+    it 'shows failure message' do
+    data = {
+      'to' => '',
+      'message' => 'Sample Data/mime.txt',
+      'from' => 'joe@test.com'
+    }
+    expect(@mg_obj).to receive(:fail)
+    @mg_obj.send_message("testdomain.com", data)
+    end
+  end
 end
 
 describe 'The method post()' do

data/spec/unit/messages/batch_message_spec.rb

@@ -72,60 +72,76 @@ describe 'The method add_recipient' do
     @address_3   = 'sam@example.com'
     @variables_3 = {'first' => 'Sam', 'last' => 'Doe', 'tracking' => 'GHI123'}
   end
-
-  it 'adds 1,000 recipients to the message body and validates counter is incremented then reset' do
-    recipient_type = :to
-    1000.times do
-      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+  context 'when from is present' do
+    before(:each) do
+      @mb_obj.from('example@email.com')
     end
 
-    expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
-    
-    @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
-    
-    expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
-  end
+    it 'adds 1,000 recipients to the message body and validates counter is incremented then reset' do
+      recipient_type = :to
+      1000.times do
+        @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      end
 
-  it 'adds recipients to the message, calls finalize, and cleans up' do
-    recipient_type = :to
-    1000.times do
+      expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
+      
       @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      
+      expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1)
     end
 
-    expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
-    @mb_obj.finalize
+    it 'adds recipients to the message, calls finalize, and cleans up' do
+      recipient_type = :to
+      1000.times do
+        @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      end
 
-    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)
-  end
+      expect(@mb_obj.counters[:recipients][recipient_type]).to eq(1000)
+      @mb_obj.finalize
 
-  it 'adds 5,005 recipients to the message body and validates we receive message_ids back' do
-    recipient_type = :to
-    5005.times do
-      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      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)
     end
-    @mb_obj.finalize
 
-    expect(@mb_obj.message_ids.length).to eq(6)
-  end
+    it 'adds 5,005 recipients to the message body and validates we receive message_ids back' do
+      recipient_type = :to
+      5005.times do
+        @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      end
+      @mb_obj.finalize
 
-  it 'sets recipient-variables, for batch expansion' do
-    recipient_type = :to
-    @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      expect(@mb_obj.message_ids.length).to eq(6)
+    end
 
-    expect(@mb_obj.recipient_variables[@address_1]).to eq(@variables_1)
+    it 'sets recipient-variables, for batch expansion' do
+      recipient_type = :to
+      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+
+      expect(@mb_obj.recipient_variables[@address_1]).to eq(@variables_1)
+    end
+
+    it 'sets multiple recipient-variables, for batch expansion' do
+      recipient_type = :to
+      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      @mb_obj.add_recipient(recipient_type, @address_2, @variables_2)
+      @mb_obj.add_recipient(recipient_type, @address_3, @variables_3)
+      
+      expect(@mb_obj.recipient_variables[@address_1]).to eq(@variables_1)
+      expect(@mb_obj.recipient_variables[@address_2]).to eq(@variables_2)
+      expect(@mb_obj.recipient_variables[@address_3]).to eq(@variables_3)
+    end
   end
 
-  it 'sets multiple recipient-variables, for batch expansion' do
-    recipient_type = :to
-    @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
-    @mb_obj.add_recipient(recipient_type, @address_2, @variables_2)
-    @mb_obj.add_recipient(recipient_type, @address_3, @variables_3)
-    
-    expect(@mb_obj.recipient_variables[@address_1]).to eq(@variables_1)
-    expect(@mb_obj.recipient_variables[@address_2]).to eq(@variables_2)
-    expect(@mb_obj.recipient_variables[@address_3]).to eq(@variables_3)
+  context 'when from is empty' do
+    it 'shows error message' do
+      recipient_type = :to
+      @mb_obj.add_recipient(recipient_type, @address_1, @variables_1)
+      @mb_obj.add_recipient(recipient_type, @address_2, @variables_2)
+      expect(@mb_client).to receive(:fail)
+      @mb_obj.finalize
+    end
   end
 
 end