mailgun-ruby 1.4.5 → 1.4.6

data/spec/integration/domain_keys_spec.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'domains' }
-
-describe 'DomainKeys', vcr: vcr_opts do
-  let(:api_version) { APIVERSION }
-  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
-  let(:mg_obj) { Mailgun::DomainKeys.new(mg_client) }
-  let(:domain) { 'integration-test.domain.invalid' }
-
-  describe '#list_domain_keys' do
-    let(:api_version) { 'v1' }
-
-    it 'lists all domain keys' do
-      result = mg_obj.list_domain_keys(
-        {
-          signing_domain: domain
-        }
-      )
-
-      expect(result).to include('items')
-      expect(result['items'].first['selector']).to eq('k1')
-    end
-  end
-
-  describe '#create_domain_key' do
-    let(:api_version) { 'v1' }
-
-    it 'creates a domain key' do
-      result = mg_obj.create_domain_key(
-        {
-          signing_domain: domain,
-          selector: 'test'
-        }
-      )
-
-      expect(result['signing_domain']).to eq(domain)
-      expect(result['selector']).to eq('test')
-    end
-  end
-
-  describe '#delete_domain_key' do
-    let(:api_version) { 'v1' }
-
-    it 'deletes a domain key' do
-      result = mg_obj.delete_domain_key(
-        {
-          signing_domain: domain,
-          selector: 'test'
-        }
-      )
-
-      expect(result['message']).to eq('success')
-    end
-  end
-
-  describe '#activate_domain_key' do
-    let(:api_version) { 'v4' }
-
-    it 'activates a domain key' do
-      result = mg_obj.activate_domain_key(
-        domain,
-        'mailo1'
-      )
-
-      expect(result['message']).to eq('domain key activated')
-    end
-  end
-
-  describe '#get_domain_keys' do
-    let(:api_version) { 'v4' }
-
-    it 'lists the domain keys for a specified signing domain' do
-      result = mg_obj.get_domain_keys(
-        domain
-      )
-
-      expect(result).to include('items')
-      expect(result['items'].first['selector']).to eq('mailo1')
-    end
-  end
-
-  describe '#deactivate_domain_key' do
-    let(:api_version) { 'v4' }
-
-    it 'deactivates a domain key' do
-      result = mg_obj.deactivate_domain_key(
-        domain,
-        'tetetet'
-      )
-
-      expect(result['message']).to eq('domain key deactivated')
-    end
-  end
-
-  describe '#update_domain_dkim_authority' do
-    it 'updates the DKIM authority for a domain' do
-      result = mg_obj.update_domain_dkim_authority(
-        domain,
-        {
-          self: true
-        }
-      )
-
-      expect(result['message']).to eq('Domain DKIM authority has not been changed')
-    end
-  end
-
-  describe '#update_domain_dkim_selector' do
-    it 'updates the DKIM selector for a domain' do
-      result = mg_obj.update_domain_dkim_selector(
-        domain,
-        {
-          dkim_selector: 'mailo1'
-        }
-      )
-
-      expect(result['message']).to eq('DKIM selector changed')
-    end
-  end
-end

data/spec/integration/domains_spec.rb

@@ -1,201 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'domains' }
-
-describe 'For the domains endpoint', vcr: vcr_opts do
-  let(:api_version) { APIVERSION }
-  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
-  let(:mg_obj) { Mailgun::Domains.new(mg_client) }
-  let(:domain) { 'integration-test.domain.invalid' }
-
-  context 'Core Domains methods' do
-    describe '#list' do
-      let(:api_version) { 'v4' }
-
-      it 'returns a list of domains' do
-        response = mg_obj.list
-
-        expect(response.size).to be > 0
-      end
-    end
-
-    describe '#create' do
-      let(:api_version) { 'v4' }
-
-      it 'creates a domain' do
-        response = mg_obj.create(domain, { spam_action: 'tag' })
-
-        expect(response['domain']['name']).to eq(domain)
-        expect(response['domain']['spam_action']).to eq('tag')
-      end
-    end
-
-    describe '#get' do
-      let(:api_version) { 'v4' }
-
-      it 'returns the domain' do
-        response = mg_obj.get(domain)
-
-        expect(response).to include('domain')
-        expect(response['domain']['name']).to eq(domain)
-      end
-    end
-
-    describe '#update' do
-      let(:api_version) { 'v4' }
-
-      it 'updates the domain' do
-        response = mg_obj.update(domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
-
-        expect(response['domain']['spam_action']).to eq('block')
-        expect(response['domain']['web_scheme']).to eq('https')
-        expect(response['domain']['wildcard']).to be(true)
-      end
-    end
-
-    describe '#verify' do
-      let(:api_version) { 'v4' }
-
-      it 'verifies the domain' do
-        response = mg_obj.verify(domain)
-
-        expect(response['message']).to eq('Domain DNS records have been updated')
-      end
-    end
-
-    context 'delete a domain' do
-      subject(:response) { mg_obj.remove(domain) }
-
-      it { is_expected.to be_falsey }
-    end
-  end
-
-  context 'Domain::Tracking methods' do
-    # TODO: add missing:
-    # get_domain_tracking_certificate
-    # regenerate_domain_tracking_certificate
-    # generate_domain_tracking_certificate
-
-    describe '#get_domain_tracking_settings' do
-      it 'returns tracking settings for the defined domain' do
-        result = mg_obj.get_domain_tracking_settings(
-          domain
-        )
-
-        expect(result).to include('tracking')
-        expect(result['tracking']['click']['active']).to be(false)
-      end
-    end
-
-    describe '#update_domain_tracking_click_settings' do
-      it 'updates the specified tracking click settings' do
-        result = mg_obj.update_domain_tracking_click_settings(
-          domain,
-          {
-            active: false
-          }
-        )
-
-        expect(result['click']['active']).to be(false)
-      end
-    end
-
-    describe '#update_domain_tracking_open_settings' do
-      it 'updates the specified tracking open settings' do
-        result = mg_obj.update_domain_tracking_open_settings(
-          domain,
-          {
-            active: false
-          }
-        )
-
-        expect(result['open']['active']).to be(false)
-      end
-    end
-
-    describe '#update_domain_tracking_unsubscribe_settings' do
-      it 'updates the specified tracking unsubscribe settings' do
-        result = mg_obj.update_domain_tracking_unsubscribe_settings(
-          domain,
-          {
-            active: false
-          }
-        )
-
-        expect(result['unsubscribe']['active']).to be(false)
-      end
-    end
-  end
-
-  context 'Credentials methods' do
-    # TODO: to be moved to the dedicated module
-
-    describe '#create_smtp_credentials' do
-      it 'creates smtp credentials for domain' do
-        result = mg_obj.create_smtp_credentials(
-          domain,
-          {
-            login: 'test_login'
-          }
-        )
-
-        expect(result['message']).to eq('Created 1 credentials pair(s)')
-      end
-    end
-
-    describe '#update_smtp_credentials' do
-      it 'updates smtp credentials for domain' do
-        result = mg_obj.update_smtp_credentials(
-          domain,
-          'test_login',
-          {
-            spec: 'abc'
-          }
-        )
-
-        expect(result['message']).to eq('Password changed')
-      end
-    end
-
-    describe '#delete_smtp_credentials' do
-      it 'deletes smtp credentials for domain' do
-        result = mg_obj.delete_smtp_credentials(
-          domain,
-          'test_login'
-        )
-
-        expect(result['message']).to eq('Credentials have been deleted')
-      end
-    end
-  end
-
-  context 'Reporting::Stat methods' do
-    # TODO: to be moved to the dedicated module
-
-    describe '#get_domain_stats' do
-      it 'returns total stats for a given domain' do
-        result = mg_obj.get_domain_stats(
-          domain,
-          {
-            event: 'clicked'
-          }
-        )
-
-        expect(result).to include('stats')
-      end
-    end
-  end
-
-  def create_mg_object(version)
-    mg_client = Mailgun::Client.new(APIKEY, APIHOST, version, SSL)
-    Mailgun::Domains.new(mg_client)
-  end
-
-  def create_domain
-    mg_obj = create_mg_object('v4')
-    mg_obj.add_domain(domain)
-  end
-end

data/spec/integration/email_validation_spec.rb

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-require 'mailgun'
-require 'mailgun/address'
-
-vcr_opts = { cassette_name: 'email_validation' }
-
-describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Address.new
-
-    @valid = ['Alice <alice@example.com>', 'bob@example.com']
-    @invalid = ['example.org']
-
-    @all_addrs = @valid + @invalid
-  end
-
-  it 'returns parsed and unparsable lists' do
-    skip 'is parse method removed?'
-    res = @mg_obj.parse(@all_addrs)
-
-    expect(res['parsed']).to eq(@valid)
-    expect(res['unparsable']).to eq(@invalid)
-  end
-
-  it 'validates alice@mailgun.net with info' do
-    res = @mg_obj.validate('alice@mailgun.net')
-
-    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 'performs mailbox validation for alice@mailgun.net' do
-    res = @mg_obj.validate('alice@mailgun.net', true)
-
-    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,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-require 'mailgun/events/events'
-
-vcr_opts = { cassette_name: 'events' }
-
-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 'can get an event.' do
-    result = @mg_obj.get("#{@domain}/events", { limit: 1 })
-
-    result.to_h!
-    expect(result.body['items'].length).to be_within(1).of(1)
-    expect(result.body['paging']).to include('next')
-    expect(result.body['paging']).to include('previous')
-  end
-
-  it 'can iterate over all events with `each`' do
-    expect(@events).to all(have_key('event'))
-  end
-end

data/spec/integration/list_members_spec.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'list_members' }
-
-describe 'For the Mailing Lists Members endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN
-    @ml_address = "integration_test_list@#{@domain}"
-    @ml_member = "integration_test_member_member@#{@domain}"
-  end
-
-  it 'creates a list' do
-    result = @mg_obj.post('lists', { address: @ml_address,
-                                     name: 'Integration Test List',
-                                     description: 'This list should be deleted automatically.',
-                                     access_level: 'members' })
-    result.to_h!
-    expect(result.body['message']).to eq('Mailing list has been created')
-    expect(result.body['list']['address']).to eq(@ml_address)
-    expect(result.body['list']['name']).to eq('Integration Test List')
-  end
-
-  it 'adds a list member' do
-    result = @mg_obj.post("lists/#{@ml_address}/members",
-                          { address: @ml_member,
-                            name: 'Jane Doe',
-                            subscribed: true,
-                            upsert: 'no' })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Mailing list member has been created')
-    expect(result.body['member']['address']).to eq(@ml_member)
-    expect(result.body['member']['name']).to eq('Jane Doe')
-  end
-
-  it 'gets a list member.' do
-    result = @mg_obj.get("lists/#{@ml_address}/members/#{@ml_member}")
-
-    result.to_h!
-    expect(result.body['member']['address']).to eq(@ml_member)
-    expect(result.body['member']['name']).to eq('Jane Doe')
-  end
-
-  it 'updates a list member.' do
-    result = @mg_obj.put("lists/#{@ml_address}/members/#{@ml_member}",
-                         { name: 'Jane Doe Update',
-                           subscribed: false })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Mailing list member has been updated')
-    expect(result.body['member']['address']).to eq(@ml_member)
-    expect(result.body['member']['name']).to eq('Jane Doe Update')
-    expect(result.body['member']['subscribed']).to be(false)
-  end
-
-  it 'removes a list member' do
-    @mg_obj.delete("lists/#{@ml_address}/members/#{@ml_member}")
-    @mg_obj.delete("lists/#{@ml_address}")
-  end
-end

data/spec/integration/list_spec.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'mailing_list' }
-
-describe 'For the Mailing Lists endpoint', vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-    @ml_address = "integration_test_list@#{@domain}"
-  end
-
-  it 'creates a list' do
-    result = @mg_obj.post('lists', { address: @ml_address,
-                                     name: 'Integration Test List',
-                                     description: 'This list should be deleted automatically.',
-                                     access_level: 'members' })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Mailing list has been created')
-    expect(result.body['list']['address']).to eq(@ml_address)
-    expect(result.body['list']['name']).to eq('Integration Test List')
-  end
-
-  it 'gets a list.' do
-    result = @mg_obj.get("lists/#{@ml_address}")
-
-    result.to_h!
-    expect(result.body['list']['address']).to eq(@ml_address)
-    expect(result.body['list']['name']).to eq('Integration Test List')
-  end
-
-  it 'gets a list of all lists.' do
-    result = @mg_obj.get('lists', { limit: 50 })
-
-    result.to_h!
-    expect(result.body['total_count']).to be > 0
-  end
-
-  it 'updates a list.' do
-    result = @mg_obj.put("lists/#{@ml_address}",
-                         { address: @ml_address,
-                           name: 'Integration Test List Update',
-                           description: 'This list should be deleted automatically.',
-                           access_level: 'readonly' })
-
-    result.to_h!
-    expect(result.body['message']).to eq('Mailing list has been updated')
-    expect(result.body['list']['address']).to eq(@ml_address)
-    expect(result.body['list']['name']).to eq('Integration Test List Update')
-    expect(result.body['list']['access_level']).to eq('readonly')
-  end
-
-  it 'deletes a list' do
-    @mg_obj.delete("lists/#{@ml_address}")
-  end
-end

data/spec/integration/logs_spec.rb

@@ -1,105 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'logs' }
-
-describe Mailgun::Logs, vcr: vcr_opts do
-  let(:logs) { described_class.new(Mailgun::Client.new(APIKEY, APIHOST, 'v1')) }
-
-  describe '#account_logs' do
-    let(:options) do
-      {
-        start: 'Wed, 25 Jun 2025 00:00:00 -0000',
-        end: 'Wed, 25 Jun 2025 23:00:00 -0000',
-        filter: {
-          AND: [
-            {
-              attribute: 'domain',
-              comparator: '!=',
-              values: [
-                {
-                  label: 'example.com',
-                  value: 'example.com'
-                }
-              ]
-            }
-          ]
-        },
-        include_subaccounts: true,
-        pagination: {
-          sort: 'timestamp:asc',
-          token: '123',
-          limit: 50
-        }
-      }
-    end
-
-    it 'responds with account logs' do
-      expect(logs.account_logs(options)).to eq(
-        {
-          'start' => 'Wed, 25 Jun 2025 00:00:00 -0000',
-          'end' => 'Wed, 25 Jun 2025 23:00:00 -0000',
-          'items' => [
-            {
-              'id' => '123',
-              'event' => 'accepted',
-              '@timestamp' => '2025-06-25T17:19:51.166Z',
-              'account' => {
-                'id' => '123'
-              },
-              'method' => 'HTTP',
-              'originating-ip' => '123.123.12.123',
-              'api-key-id' => 'xxx',
-              'domain' => {
-                'name' => 'example.mailgun.org'
-              },
-              'recipient' => 'alex@example.com',
-              'recipient-domain' => 'example.com',
-              'envelope' => {
-                'sender' => 'example.mailgun.org',
-                'transport' => 'smtp',
-                'targets' => 'alex@example.com'
-              },
-              'storage' => {
-                'region' => 'us-east4',
-                'env' => 'production',
-                'key' => 'xxx',
-                'url' => ['https://storage.api.mailgun.net/v3/domains/example.mailgun.org/messages/123']
-              },
-              'log-level' => 'info',
-              'user-variables' => '{}',
-              'message' => {
-                'headers' => {
-                  'to' => 'alex@example.com',
-                  'message-id' => '123@example.mailgun.org',
-                  'from' => 'bob@sending_domain.com+4',
-                  'subject' => 'The Ruby SDK is awesome!'
-                },
-                'attachments' => [
-                  {
-                    'filename' => 'image.jpg',
-                    'content-type' => 'image/jpeg',
-                    'size' => 16_712
-                  }
-                ],
-                'size' => 23_476
-              },
-              'flags' => {
-                'is-authenticated' => true,
-                'is-system-test' => false,
-                'is-routed' => false,
-                'is-test-mode' => false,
-                'is-delayed-bounce' => false,
-                'is-callback' => false
-              }
-            }
-          ],
-          'pagination' => {},
-          'aggregates' => {}
-        }
-      )
-    end
-  end
-end