mailgun-ruby 1.1.9 → 1.2.12

data/spec/integration/mailgun_spec.rb

@@ -34,6 +34,78 @@ describe 'Client exceptions', vcr: vcr_opts do
   end
 end
 
+vcr_opts = { :cassette_name => "exceptions-invalid-api-key" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'displays error information that API key is invalid' do
+    begin
+      @mg_obj.send_message(@domain, {
+          :from => "sally@#{@domain}",
+          :to => "sally@#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::Unauthorized => err
+      expect(err.message).to eq('401 Unauthorized - Invalid Domain or API key: Forbidden')
+    else
+      fail
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => "exceptions-invalid-data" }
+
+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(@domain, {
+          :from => "sally@#{@domain}",
+          :to => "sally#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::BadRequest => err
+      expect(err.message).to eq('400 Bad Request: to parameter is not a valid address. please check documentation')
+    else
+      fail
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => "exceptions-not-allowed" }
+
+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(@domain, {
+          :from => "invalid@#{@domain}",
+          :to => "invalid#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to include('403 Forbidden')
+    else
+      fail
+    end
+  end
+end
+
 vcr_opts = { :cassette_name => "send_message" }
 
 describe 'The method send_message()', vcr: vcr_opts do
@@ -63,6 +135,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 +147,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
 
@@ -117,5 +192,21 @@ Testing some Mailgun awesomness!'
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
+  
+  it 'receives success response code' 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" }
+
+    result = @mg_obj.send_message(@domain, data)
+    result.to_h!
+    
+    expect(result.success?).to be(true)
+  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/integration/templates_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "templates" }
+
+describe 'For the templates endpoints', vcr: vcr_opts do
+  let(:template_name) { 'test.template' }
+  let(:domain) { "integration-test.domain.invalid" }
+  let(:tag) { 'v2' }
+
+  before(:all) do
+    @mg_client = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @mg_obj = Mailgun::Templates.new(@mg_client)
+  end
+
+  describe '#create' do
+    it 'creates the template' do
+      result = @mg_obj.create(
+        domain,
+        {
+          name: template_name,
+          description: 'Test',
+          template: '{{fname}} {{lname}}',
+            comment: 'test comment',
+            headers: '{"Subject": "{{subject}}"}',
+            tag: 'V1'
+        }
+      )
+
+      expect(result['template']["name"]).to eq('test.template')
+      expect(result['template']["description"]).to eq("Test")
+    end
+  end
+
+  describe '#info' do
+    it 'gets the templates info' do
+      result = @mg_obj.info(domain, 'test.template')
+
+      expect(result).to include("template")
+      expect(result["template"]["name"]).to eq(template_name)
+    end
+  end
+
+  describe '#update' do
+    it 'updates the template' do
+      result = @mg_obj.update(domain, template_name, { description: 'Updated Description' })
+
+      expect(result['message']).to eq('template has been updated')
+    end
+  end
+
+  describe '#list' do
+    it 'returns a list of templates' do
+      result = @mg_obj.list(domain)
+
+      expect(result.first).to have_key('name')
+      expect(result.first).to have_key('description')
+    end
+  end
+
+  describe '#delete' do
+    it 'deletes a template' do
+      result = @mg_obj.delete(domain, template_name)
+
+      expect(result).to be_truthy
+    end
+  end
+
+  describe '#remove_all' do
+    it 'deletes all templates from domain' do
+      result = @mg_obj.remove_all(domain)
+
+      expect(result).to be_truthy
+    end
+  end
+
+  describe '#create_version' do
+    it 'creates the version for the template' do
+      result = @mg_obj.create_version(
+        domain,
+        template_name,
+        {
+          template: '{{fname}} {{lname}}',
+          comment: 'test comment',
+          headers: '{"Subject": "{{subject}}"}',
+          tag: tag,
+          active: 'yes'
+        }
+      )
+
+      expect(result['template']["version"]['tag']).to eq(tag)
+    end
+  end
+
+  describe '#info_version' do
+    it "gets the template's version info" do
+      result = @mg_obj.info_version(domain, template_name, tag)
+
+      expect(result["template"]["version"]['tag']).to eq(tag)
+    end
+  end
+
+  describe '#update_version' do
+    it 'updates the template' do
+      result = @mg_obj.update_version(
+        domain,
+        template_name,
+        tag,
+        {
+          template: '{{fname}} {{lname}}',
+          comment: 'test comment 2',
+          headers: '{"Subject": "{{subject}}"}'
+        }
+      )
+
+      expect(result['message']).to eq('version has been updated')
+    end
+  end
+
+  describe '#template_versions_list' do
+    it "returns template's versions" do
+      result = @mg_obj.template_versions_list(domain, template_name)
+
+      expect(result["template"]["versions"].first).to include('tag')
+    end
+  end
+
+  describe '#delete_version' do
+    it "deletes template's version" do
+      result = @mg_obj.delete_version(domain, template_name, tag)
+
+      expect(result).to be_truthy
+    end
+  end
+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)
@@ -45,7 +46,8 @@ module Mailgun
         Mailgun::Response.new(response_generator(@endpoint))
       rescue => e
         p e
-        raise CommunicationError.new(e), e.response
+        raise CommunicationError.new(e), e.response if e.respond_to? :response
+        raise CommunicationError.new(e.message)
       end
     end
 
@@ -75,6 +77,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 contain at least 1 recipient',
+        working_domain
+      ) if message.fetch('to', []).empty? && message.fetch(:to, []).empty?
+      fail ParameterError.new(
+        'Missing a `from` sender, message should contain 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
@@ -65,6 +87,25 @@ describe 'The method post()' do
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
+
+  context 'when Unknown API error is raised' do
+    before do
+      allow(Mailgun::Response).to receive(:new).and_raise(StandardError, "message")
+      allow(JSON).to receive(:parse).and_raise('Unknown')
+    end
+
+    it 'adds Unknown API error to message' do
+      data = {'from' => 'joe@test.com',
+                    'to' => 'bob@example.com',
+                    'subject' => 'Test',
+                    'text' => 'Test Data'}
+      @mg_obj.post("#{@domain}/messages", data)
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to eq('message: Unknown API error')
+    else
+      fail
+    end
+  end
 end
 
 describe 'The method put()' 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