mailgun-ruby 1.1.0 → 1.2.5

data/mailgun.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version          = Mailgun::VERSION
   spec.homepage         = 'http://www.mailgun.com'
   spec.platform         = Gem::Platform::RUBY
-  spec.license          = 'Apache'
+  spec.license          = 'Apache-2.0'
 
   spec.summary          = "Mailgun's Official Ruby SDK"
   spec.description      = "Mailgun's Official Ruby SDK for interacting with the Mailgun API."
@@ -22,17 +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 = '>= 1.9.3'
-
-  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', '~> 1.6'
-  spec.add_dependency 'json', '~> 1.8'
+  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

@@ -1,29 +1,71 @@
 require 'spec_helper'
+
 require 'mailgun'
+require 'mailgun/address'
 
 vcr_opts = { :cassette_name => "email_validation" }
 
-describe 'For the Email Validation endpoint', vcr: vcr_opts do
+describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
-    @mg_obj = Mailgun::Client.new(PUB_APIKEY)
+    @mg_obj = Mailgun::Address.new(PUB_APIKEY)
+
+    @valid = ["Alice <alice@example.com>", "bob@example.com"]
+    @invalid = ["example.org"]
+
+    @all_addrs = @valid + @invalid
+  end
+
+  it 'returns parsed and unparsable lists' do
+    res = @mg_obj.parse(@all_addrs)
+
+    expect(res["parsed"]).to eq(@valid)
+    expect(res["unparseable"]).to eq(@invalid)
   end
 
-  it 'validates an address.' do
-    result = @mg_obj.get("address/validate",
-                         {:address => "test@#{TESTDOMAIN}"})
+  it 'validates alice@mailgun.net with info' do
+    res = @mg_obj.validate("alice@mailgun.net")
 
-    result.to_h!
-    expect(result.body["is_valid"]).to eq(true)
-    expect(result.body["address"]).to eq("test@#{TESTDOMAIN}")
+    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",
+            "local_part" => "alice",
+        },
+    }
+    expect(res).to eq(expected)
   end
 
-  it 'parses an address.' do
-    result = @mg_obj.get("address/parse",
-                         {:addresses => "Alice <alice@#{TESTDOMAIN}>,bob@#{TESTDOMAIN},#{TESTDOMAIN}"})
+  it 'performs mailbox validation for alice@mailgun.net' do
+    res = @mg_obj.validate("alice@mailgun.net", true)
 
-    result.to_h!
-    expect(result.body["parsed"]).to include("Alice <alice@#{TESTDOMAIN}>")
-    expect(result.body["parsed"]).to include("bob@#{TESTDOMAIN}")
-    expect(result.body["unparseable"]).to include("#{TESTDOMAIN}")
+    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,
+            "local_part" => nil,
+        },
+    }
+    expect(res).to eq(expected)
+  end
+
 end

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/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

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'mailgun'
+require 'mailgun/exceptions/exceptions'
 
 vcr_opts = { :cassette_name => "instance" }
 
@@ -9,6 +10,30 @@ describe 'Mailgun instantiation', vcr: vcr_opts do
   end
 end
 
+vcr_opts = { :cassette_name => "exceptions" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'display useful error information' do
+    begin
+      @mg_obj.send_message("not-our-doma.in", {
+          :from => "sally@not-our-doma.in",
+          :to => "bob@#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to eq('404 Not Found: Domain not found: not-our-doma.in')
+    else
+      fail
+    end
+  end
+end
+
 vcr_opts = { :cassette_name => "send_message" }
 
 describe 'The method send_message()', vcr: vcr_opts do
@@ -16,7 +41,7 @@ describe 'The method send_message()', vcr: vcr_opts do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
   end
-  
+
   it 'sends a standard message in test mode.' do
     result = @mg_obj.send_message(@domain, {:from => "bob@#{@domain}",
                                     :to => "sally@#{@domain}",
@@ -29,6 +54,31 @@ describe 'The method send_message()', vcr: vcr_opts do
     expect(result.body).to include("id")
   end
 
+  it 'fakes message send while in *client* test mode' do
+    @mg_obj.enable_test_mode!
+
+    expect(@mg_obj.test_mode?).to eq(true)
+
+    data = { :from => "joe@#{@domain}",
+             :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)
+
+    result.to_h!
+
+    expect(result.body).to include("message")
+    expect(result.body).to include("id")
+
+    expect(result.code).to eq(200)
+    expect(result.body['id']).to eq("test-mode-mail-#{uuid}@localhost")
+    expect(result.body['message']).to eq("Queued. Thank you.")
+  end
+
   it 'sends a message builder message in test mode.' do
     mb_obj = Mailgun::MessageBuilder.new()
     mb_obj.from("sender@#{@domain}", {'first' => 'Sending', 'last' => 'User'})

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/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

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

@@ -25,9 +25,9 @@ describe 'The method send_message()' do
 
   it 'sends a message' do
     data = { 'from' => 'joe@test.com',
-                    'to' => 'bob@example.com',
-                    'subject' => 'Test',
-                    'text' => 'Test Data'}
+             'to' => 'bob@example.com',
+             'subject' => 'Test',
+             'text' => 'Test Data' }
     result = @mg_obj.send_message("testdomain.com", data)
 
     result.to_h!
@@ -37,15 +37,37 @@ 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!
-    
+
     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
@@ -61,7 +83,7 @@ describe 'The method post()' do
     result = @mg_obj.post("#{@domain}/messages", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
@@ -81,7 +103,7 @@ describe 'The method put()' do
     result = @mg_obj.put("lists/#{@list_address}/members#{@member_address}", data)
 
     result.to_h!
-    
+
     expect(result.body).to include("member")
     expect(result.body["member"]).to include("vars")
     expect(result.body["member"]["vars"]).to include("age")
@@ -104,7 +126,7 @@ describe 'The method get()' do
     result = @mg_obj.get("#{@domain}/bounces", query_string)
 
     result.to_h!
-    
+
     expect(result.body).to include("total_count")
     expect(result.body).to include("items")
   end
@@ -120,7 +142,7 @@ describe 'The method delete()' do
     result = @mg_obj.delete("#{@domain}/campaigns/ABC123")
 
     result.to_h!
-    
+
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end