mailgun-ruby 1.4.5 → 1.4.6

data/spec/integration/mailer_spec.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-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 IntegrationUnitTestMailer < 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 || 'DOMAIN.TEST' }
-  let(:config) do
-    {
-      api_key: APIKEY,
-      domain: domain
-    }
-  end
-  let!(:mail) { IntegrationUnitTestMailer.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) { IntegrationUnitTestMailer.plain_message('sally@not-our-doma.in', "bob@#{domain}", 'subject', {}) }
-
-  it 'raises expected error' do
-    expect do
-      Railgun::Mailer.new(config).deliver!(mail)
-    end.to raise_error Mailgun::Unauthorized, /Invalid Domain or API key/
-  end
-end

data/spec/integration/mailgun_spec.rb

@@ -1,198 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-require 'mailgun/exceptions/exceptions'
-
-describe 'Mailgun instantiation', vcr: { cassette_name: 'instance' } do
-  it 'instantiates an HttpClient object' do
-    expect { @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL) }.not_to raise_error
-  end
-end
-
-describe 'Client exceptions', vcr: { cassette_name: 'exceptions' } do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-  end
-
-  it 'display useful error information' do
-    @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 => e
-    expect(e.message).to include('404')
-    expect(e.message).to include('Domain not found: not-our-doma.in')
-  else
-    raise
-  end
-end
-
-describe 'Client exceptions', vcr: { cassette_name: 'exceptions-invalid-api-key' } do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-  end
-
-  it 'displays error information that API key is invalid' do
-    @mg_obj.send_message(@domain, {
-                           from: "sally@#{@domain}",
-                           to: "sally@#{@domain}",
-                           subject: 'Exception Integration Test',
-                           text: 'INTEGRATION TESTING'
-                         })
-  rescue Mailgun::Unauthorized => e
-    expect(e.message).to include('401')
-    expect(e.message).to include('Invalid Domain or API key')
-  else
-    raise
-  end
-end
-
-describe 'Client exceptions', vcr: { cassette_name: 'exceptions-invalid-data' } do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-  end
-
-  it 'display useful error information' do
-    @mg_obj.send_message(@domain, {
-                           from: "sally@#{@domain}",
-                           to: "sally#{@domain}",
-                           subject: 'Exception Integration Test',
-                           text: 'INTEGRATION TESTING'
-                         })
-  rescue Mailgun::BadRequest => e
-    expect(e.message).to include('400')
-    expect(e.message).to include('to parameter is not a valid address. please check documentation')
-  else
-    raise
-  end
-end
-
-describe 'Client exceptions', vcr: { cassette_name: 'exceptions-not-allowed' } do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-  end
-
-  it 'display useful error information' do
-    @mg_obj.send_message(@domain, {
-                           from: "invalid@#{@domain}",
-                           to: "invalid#{@domain}",
-                           subject: 'Exception Integration Test',
-                           text: 'INTEGRATION TESTING'
-                         })
-  rescue Mailgun::CommunicationError => e
-    expect(e.message).to include('403')
-  else
-    raise
-  end
-end
-
-describe 'The method send_message()', vcr: { cassette_name: 'send_message' } do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-  end
-
-  it 'sends a standard message in test mode.' do
-    @mg_obj.enable_test_mode!
-    result = @mg_obj.send_message(@domain, { :from => "bob@#{@domain}",
-                                             :to => "sally@#{@domain}",
-                                             :subject => 'Hash Integration Test',
-                                             :text => 'INTEGRATION TESTING',
-                                             'o:testmode' => true })
-    result.to_h!
-    expect(result.body).to include('message')
-    expect(result.body).to include('id')
-    expect(Mailgun::Client.deliveries.size).to eq(1)
-  end
-
-  it 'fakes message send while in *client* test mode' do
-    @mg_obj.enable_test_mode!
-
-    expect(@mg_obj.test_mode?).to be(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' })
-    mb_obj.add_recipient(:to, "recipient@#{@domain}", { 'first' => 'Recipient', 'last' => 'User' })
-    mb_obj.subject('Message Builder Integration Test')
-    mb_obj.body_text('This is the text body.')
-    mb_obj.test_mode(true)
-
-    result = @mg_obj.send_message(@domain, mb_obj)
-
-    result.to_h!
-    expect(result.body).to include('message')
-    expect(result.body).to include('id')
-  end
-
-  it 'sends a custom MIME message in test mode.' do
-    mime_string = 'Delivered-To: mgbox01@gmail.com
-Received: by luna.mailgun.net with HTTP; Tue, 26 Nov 2013 17:59:11 +0000
-Mime-Version: 1.0
-Content-Type: text/plain; charset="ascii"
-Subject: Hello
-From: Excited User <me@samples.mailgun.org>
-To: sally@example.com
-Message-Id: <20131126175911.25310.92289@samples.mailgun.org>
-Content-Transfer-Encoding: 7bit
-X-Mailgun-Sid: WyI2NTU4MSIsICJtZ2JveDAxQGdtYWlsLmNvbSIsICIxZmYiXQ==
-Date: Tue, 26 Nov 2013 17:59:22 +0000
-X-Mailgun-Drop-Message: yes
-Sender: me@samples.mailgun.org
-
-Testing some Mailgun awesomness!'
-
-    message_params = { from: "bobby@#{@domain}",
-                       to: "sally@#{@domain}",
-                       message: mime_string }
-
-    result = @mg_obj.send_message(@domain, message_params)
-
-    result.to_h!
-    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 be(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/messages/sample_data/mime.txt

@@ -1,38 +0,0 @@
-X-SBRS: 5.6
-X-SenderGroup: WHITELIST
-X-MailFlowPolicy: $TRUSTED
-DKIM-Signature: a=rsa-sha256; v=1; c=relaxed/relaxed; d=trstx.com; q=dns/txt; s=mx;
- t=1381182797; h=Mime-Version: Content-Type: Subject: From: To:
- Message-Id: Date: Sender: Content-Transfer-Encoding;
- bh=r6P1omjKL3m7gDuZC6dZEJU6trgWm1IRwAJb8h4wtfg=; b=UPFaFGiuDx2yZjCmiMEji0fIXvGMNwXUsuaX4Ss9p5EUkqE25eYjeJaJZ5w5FK+t0jsUPZqu
- FIH6sftQv7GBEbSktY6sv7dgv5q2yVlY8YNG7CXvUZdWmvwfQVvfL9j1RHJo9H3QpXT9c8bZ
- p9rpYmqZtZEz2ZesPj4kzUaB0lU=
-DomainKey-Signature: a=rsa-sha1; c=nofws; d=trstx.com; s=mx; q=dns;
- h=Mime-Version: Content-Type: Subject: From: To: Message-Id: Date:
- Sender: Content-Transfer-Encoding;
- b=QUYQf9OP16DphNAjeF95+G7V6DaqL4FA+m1sjIEWHdLzrGTQkiYTpzJdne3lzSypB0DwaG
- AT9zOhjjN64DWFOkJD2Ce5t6vfHa/GC3FCUMq3xz/Big94g+kOciawkHyUhCrmPyh/D7kWx1
- J75UIAdmE9XQ9bCSPhZ2MRaOv7b8c=
-Received: by luna.mailgun.net with HTTP; Mon, 07 Oct 2013 21:53:16 +0000
-Content-Type: text/plain; charset="ascii"
-Subject: Test Subject
-From: <joe@example.com>
-To: <bob@sample.com>
-Message-ID: <20131007215316.27052.7818@example.com>
-X-Mailgun-Sid: WyI4MzY1OSIsICJ0cmF2aXMuc3dpZW50ZWtAcmFja3NwYWasdfewNvbSIsICJjZjQ4Il0=
-Date: Mon, 7 Oct 2013 21:53:17 +0000
-Sender: <joe@example.com>
-Content-Transfer-Encoding: 7bit
-MIME-Version: 1.0
-
---3a8c26e9f23c4ac193606295aa17fa6f
-Content-Type: text/plain; charset="ascii"
-Content-Transfer-Encoding: 7bit
-
-Testing some Mailgun awesomness!
---3a8c26e9f23c4ac193606295aa17fa6f
-Content-Type: text/html; charset="ascii"
-Content-Transfer-Encoding: 7bit
-
-<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">Test
---3a8c26e9f23c4ac193606295aa17fa6f--

data/spec/integration/metrics_spec.rb

@@ -1,224 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'metrics' }
-
-describe Mailgun::Metrics, vcr: vcr_opts do
-  let(:metrics) { described_class.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
-
-  describe '#account_metrics' do
-    let(:options) do
-      {
-        resolution: 'hour',
-        metrics: %w[
-          accepted_count
-          delivered_count
-          clicked_rate
-          opened_rate
-        ],
-        include_aggregates: true,
-        start: 'Tue, 26 Nov 2024 20:56:50 -0500',
-        duration: '1m',
-        filter: {
-          AND: [
-            {
-              attribute: 'domain',
-              comparator: '!=',
-              values: [
-                {
-                  label: 'example.com',
-                  value: 'example.com'
-                }
-              ]
-            }
-          ]
-        },
-        dimensions: ['time'],
-        end: 'Tue, 30 Nov 2024 20:56:50 -0500',
-        include_subaccounts: true
-      }
-    end
-
-    it 'responds with account metrics' do
-      expect(metrics.account_metrics(options)).to eq(
-        {
-          'start' => 'Fri, 01 Nov 2024 01:00:00 +0000',
-          'end' => 'Sun, 01 Dec 2024 01:00:00 +0000',
-          'resolution' => 'hour',
-          'duration' => '1m',
-          'dimensions' => ['time'],
-          'pagination' => {
-            'sort' => '', 'skip' => 0, 'limit' => 1500, 'total' => 3
-          },
-          'items' => [{
-            'dimensions' => [{
-              'dimension' => 'time',
-              'value' => 'Wed, 27 Nov 2024 12:00:00 +0000',
-              'display_value' => 'Wed, 27 Nov 2024 12:00:00 +0000'
-            }],
-            'metrics' => {
-              'accepted_count' => 1, 'delivered_count' => 1, 'opened_rate' => '0.0000', 'clicked_rate' => '0.0000'
-            }
-          },
-                      {
-                        'dimensions' => [{
-                          'dimension' => 'time',
-                          'value' => 'Wed, 27 Nov 2024 13:00:00 +0000',
-                          'display_value' => 'Wed, 27 Nov 2024 13:00:00 +0000'
-                        }],
-                        'metrics' => {
-                          'accepted_count' => 1,
-                          'delivered_count' => 1,
-                          'opened_rate' => '0.0000',
-                          'clicked_rate' => '0.0000'
-                        }
-                      },
-                      {
-                        'dimensions' => [{
-                          'dimension' => 'time',
-                          'value' => 'Thu, 28 Nov 2024 15:00:00 +0000',
-                          'display_value' => 'Thu, 28 Nov 2024 15:00:00 +0000'
-                        }],
-                        'metrics' => {
-                          'accepted_count' => 1,
-                          'delivered_count' => 1,
-                          'opened_rate' => '0.0000',
-                          'clicked_rate' => '0.0000'
-                        }
-                      }],
-          'aggregates' => {
-            'metrics' => {
-              'accepted_count' => 3, 'delivered_count' => 3, 'opened_rate' => '0.0000', 'clicked_rate' => '0.0000'
-            }
-          }
-        }
-      )
-    end
-  end
-
-  describe '#account_usage_metrics' do
-    let(:options) do
-      {
-        resolution: 'hour',
-        metrics: %w[
-          email_preview_count
-          email_preview_failed_count
-          email_validation_bulk_count
-          email_validation_count
-          email_validation_list_count
-          email_validation_mailgun_count
-          email_validation_mailjet_count
-          email_validation_public_count
-          email_validation_single_count
-          email_validation_valid_count
-          link_validation_count
-          link_validation_failed_count
-          processed_count
-          seed_test_count
-        ],
-        include_aggregates: true,
-        start: 'Tue, 26 Nov 2024 20:56:50 -0500',
-        duration: '1m',
-        filter: {
-          AND: [
-            {
-              attribute: 'subaccount',
-              comparator: '!=',
-              values: [
-                {
-                  label: '12345',
-                  value: '12345'
-                }
-              ]
-            }
-          ]
-        },
-        dimensions: ['time'],
-        end: 'Tue, 28 Nov 2024 20:56:50 -0500',
-        include_subaccounts: true
-      }
-    end
-
-    it 'responds with account usage metrics' do
-      expect(metrics.account_usage_metrics(options)).to eq(
-        {
-          'start' => 'Tue, 29 Oct 2024 01:00:00 +0000',
-          'end' => 'Fri, 29 Nov 2024 01:00:00 +0000',
-          'resolution' => 'hour',
-          'duration' => '1m',
-          'dimensions' => ['time'],
-          'pagination' => {
-            'sort' => '', 'skip' => 0, 'limit' => 1500, 'total' => 2
-          },
-          'items' => [{
-            'dimensions' => [{
-              'dimension' => 'time',
-              'value' => 'Wed, 27 Nov 2024 00:00:00 +0000',
-              'display_value' => 'Wed, 27 Nov 2024 00:00:00 +0000'
-            }],
-            'metrics' => {
-              'processed_count' => 2,
-              'email_validation_count' => 0,
-              'email_validation_public_count' => 0,
-              'email_validation_valid_count' => 0,
-              'email_validation_single_count' => 0,
-              'email_validation_bulk_count' => 0,
-              'email_validation_list_count' => 0,
-              'email_validation_mailgun_count' => 0,
-              'email_validation_mailjet_count' => 0,
-              'email_preview_count' => 0,
-              'email_preview_failed_count' => 0,
-              'link_validation_count' => 0,
-              'link_validation_failed_count' => 0,
-              'seed_test_count' => 0
-            }
-          },
-                      {
-                        'dimensions' => [{
-                          'dimension' => 'time',
-                          'value' => 'Thu, 28 Nov 2024 00:00:00 +0000',
-                          'display_value' => 'Thu, 28 Nov 2024 00:00:00 +0000'
-                        }],
-                        'metrics' => {
-                          'processed_count' => 1,
-                          'email_validation_count' => 0,
-                          'email_validation_public_count' => 0,
-                          'email_validation_valid_count' => 0,
-                          'email_validation_single_count' => 0,
-                          'email_validation_bulk_count' => 0,
-                          'email_validation_list_count' => 0,
-                          'email_validation_mailgun_count' => 0,
-                          'email_validation_mailjet_count' => 0,
-                          'email_preview_count' => 0,
-                          'email_preview_failed_count' => 0,
-                          'link_validation_count' => 0,
-                          'link_validation_failed_count' => 0,
-                          'seed_test_count' => 0
-                        }
-                      }],
-          'aggregates' => {
-            'metrics' => {
-              'permanent_failed_count' => 0,
-              'processed_count' => 3,
-              'email_validation_count' => 0,
-              'email_validation_public_count' => 0,
-              'email_validation_valid_count' => 0,
-              'email_validation_single_count' => 0,
-              'email_validation_bulk_count' => 0,
-              'email_validation_list_count' => 0,
-              'email_validation_mailgun_count' => 0,
-              'email_validation_mailjet_count' => 0,
-              'email_preview_count' => 0,
-              'email_preview_failed_count' => 0,
-              'link_validation_count' => 0,
-              'link_validation_failed_count' => 0,
-              'seed_test_count' => 0
-            }
-          }
-        }
-      )
-    end
-  end
-end

data/spec/integration/routes_spec.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'routes', match_requests_on: %i[uri method body] }
-
-describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
-    @forward_to = "alice@#{@domain}"
-    @recipient = ".*@#{@domain}"
-  end
-
-  it 'creates a route' do
-    result = @mg_obj.post('routes', { priority: 10,
-                                      description: 'Integration Test Route',
-                                      expression: "match_recipient(\"#{@forward_to}\")",
-                                      action: "forward(\"#{@recipient}\")" })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Route has been created')
-    expect(result.body['route']['description']).to eq('Integration Test Route')
-    expect(result.body['route']['actions']).to include("forward(\"#{@recipient}\")")
-    expect(result.body['route']['expression']).to include("match_recipient(\"#{@forward_to}\")")
-    expect(result.body['route']['priority']).to eq(10)
-  end
-
-  it 'creates a route with multiple actions' do
-    result = @mg_obj.post('routes', { priority: 10,
-                                      description: 'Integration Test Route',
-                                      expression: "match_recipient(\"#{@forward_to}\")",
-                                      action: ["forward(\"#{@recipient}\")", 'stop()'] })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Route has been created')
-    expect(result.body['route']['description']).to eq('Integration Test Route')
-    expect(result.body['route']['actions'].count).to eq 2
-    expect(result.body['route']['actions'][0]).to include("forward(\"#{@recipient}\")")
-    expect(result.body['route']['actions'][1]).to include('stop()')
-    expect(result.body['route']['expression']).to include("match_recipient(\"#{@forward_to}\")")
-    expect(result.body['route']['priority']).to eq(10)
-  end
-
-  it 'gets a list of all routes.' do
-    result = @mg_obj.get('routes', { limit: 50 })
-
-    result.to_h!
-    expect(result.body['total_count']).to be > 0
-  end
-
-  it 'gets the route.' do
-    result = @mg_obj.get('routes', { limit: 1 })
-    route_id = result.to_h['items'].first['id']
-
-    result = @mg_obj.get("routes/#{route_id}")
-
-    result.to_h!
-    expect(result.body['route']['description']).to eq('Integration Test Route')
-    expect(result.body['route']['actions']).to include("forward(\"#{@recipient}\")")
-    expect(result.body['route']['expression']).to include("match_recipient(\"#{@forward_to}\")")
-    expect(result.body['route']['priority']).to eq(10)
-  end
-
-  it 'updates the route.' do
-    result = @mg_obj.get('routes', { limit: 1 })
-    route_id = result.to_h['items'].first['id']
-
-    result = @mg_obj.put("routes/#{route_id}", { priority: 10,
-                                                 description: 'Integration Test Route Update',
-                                                 expression: "match_recipient(\"#{@forward_to}\")",
-                                                 action: "forward(\"#{@recipient}\")" })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Route has been updated')
-    expect(result.body['description']).to eq('Integration Test Route Update')
-    expect(result.body['actions']).to include("forward(\"#{@recipient}\")")
-    expect(result.body['expression']).to include("match_recipient(\"#{@forward_to}\")")
-    expect(result.body['priority']).to eq(10)
-  end
-
-  it 'removes a route' do
-    result = @mg_obj.get('routes', { limit: 1 })
-    route_id = result.to_h['items'].first['id']
-
-    @mg_obj.delete("routes/#{route_id}")
-
-    result.to_h!
-  end
-end

data/spec/integration/stats_spec.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'stats' }
-
-describe 'For the Stats endpoint', vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-  end
-
-  it 'get some stats.' do
-    @mg_obj.get("#{@domain}/stats", { limit: 50, skip: 10, event: 'sent' })
-  end
-end