mailgun-ruby 1.4.5 → 1.4.6

data/spec/integration/subaccounts_spec.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'subaccounts' }
-
-describe 'For the subaccounts endpoints', vcr: vcr_opts do
-  let(:name) { 'test.subaccount' }
-  let(:subaccount_id) { 'xxx' }
-
-  before(:all) do
-    mg_client = Mailgun::Client.new(APIKEY, APIHOST, 'v5')
-    @mg_obj = Mailgun::Subaccounts.new mg_client
-  end
-
-  describe '#list' do
-    it 'returns a list of templates' do
-      result = @mg_obj.list
-
-      expect(result).to eq({ 'subaccounts' => [{ 'id' => 'xxx', 'name' => 'test-ruby-lib', 'status' => 'open' }],
-                             'total' => 1 })
-    end
-  end
-
-  describe '#create' do
-    it 'creates the subaccount' do
-      result = @mg_obj.create(name)
-
-      expect(result).to eq({ 'subaccount' => { 'id' => 'xxx', 'name' => 'test.subaccount', 'status' => 'open' } })
-    end
-  end
-
-  describe '#info' do
-    it 'gets the templates info' do
-      result = @mg_obj.info(subaccount_id)
-
-      expect(result).to eq({ 'subaccount' => { 'id' => 'xxx', 'name' => 'test-ruby-lib', 'status' => 'open' } })
-    end
-  end
-
-  describe '#enable' do
-    it 'enables the subaccount' do
-      result = @mg_obj.enable(subaccount_id)
-
-      expect(result).to eq({ 'subaccount' => { 'id' => 'xxx', 'name' => 'test-ruby-lib', 'status' => 'open' } })
-    end
-  end
-
-  describe '#disable' do
-    it 'disables the subaccount' do
-      result = @mg_obj.disable(subaccount_id)
-
-      expect(result).to eq({ 'subaccount' => { 'id' => 'xxx', 'name' => 'test-ruby-lib', 'status' => 'disabled' } })
-    end
-  end
-end

data/spec/integration/suppressions_spec.rb

@@ -1,320 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-require 'mailgun'
-require 'mailgun/suppressions'
-
-vcr_opts = { cassette_name: 'suppressions', match_requests_on: %i[uri method body] }
-
-describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts do
-  let(:mg_obj) { Mailgun::Client.new(APIKEY, APIHOST, 'v3') }
-  let(:suppress) { Mailgun::Suppressions.new(mg_obj, TESTDOMAIN) }
-  let(:addresses) { %w[test1@example.com test2@example.org test3@example.net test4@example.info] }
-
-  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 'returns nil if no bounces passed' do
-    response = suppress.create_bounces({})
-
-    expect(response[0]).to be_nil
-  end
-
-  it 'creates a single bounce' do
-    bounce = {
-      address: 'test777@example.info',
-      code: 777,
-      error: 'integration testing123'
-    }
-
-    response = suppress.create_bounce bounce
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['message']).to eq('Address has been added to the bounces table')
-  end
-
-  it 'fetches a single bounce' do
-    response = suppress.get_bounce('test777@example.info')
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['address']).to eq('test777@example.info')
-  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 'removes all bounces' do
-    response = suppress.delete_all_bounces
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['message']).to eq('Bounced addresses for this domain have been removed')
-  end
-
-  it 'can batch-add unsubscribes with tags as string' do
-    unsubscribes = []
-    addresses.each do |addr|
-      unsubscribes.push({
-                          address: addr,
-                          tag: '123'
-                        })
-    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 'can batch-add unsubscribes with tags as digits' do
-    unsubscribes = []
-    addresses.each do |addr|
-      unsubscribes.push({
-                          address: addr,
-                          tag: 123
-                        })
-    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 'returns nil if no unsubscribes passed' do
-    response = suppress.create_unsubscribes({})
-
-    expect(response[0]).to be_nil
-  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 'creates a single unsubscribe' do
-    response = suppress.create_unsubscribe({
-                                             address: 'test777@example.com',
-                                             tags: ['integration']
-                                           })
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['message']).to eq('Address has been added to the unsubscribes table')
-  end
-
-  it 'returns a single unsubscribe' do
-    response = suppress.get_unsubscribe('test777@example.com')
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['address']).to eq('test777@example.com')
-  end
-
-  it 'returns all unsubscribers' do
-    response = suppress.list_unsubscribes
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['items'][0]['address']).to eq('test777@example.com')
-  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 'returns nil if no complaints passed' do
-    response = suppress.create_complaints({})
-
-    expect(response[0]).to be_nil
-  end
-
-  it 'creates a single complaint' do
-    response = suppress.create_complaint({ address: 'test777@example.com' })
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['message']).to eq('Address has been added to the complaints table')
-  end
-
-  it 'returns a single complaint' do
-    response = suppress.get_complaint('test777@example.com')
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['address']).to eq('test777@example.com')
-  end
-
-  it 'returns all complaints' do
-    response = suppress.list_complaints
-    response.to_h!
-
-    expect(response.code).to eq(200)
-    expect(response.body['items'][0]['address']).to eq('test1@example.com')
-  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
-
-  describe 'paging' do
-    before do
-      suppress.list_bounces
-    end
-
-    describe '#next' do
-      it 'returns the response' do
-        resp = suppress.next
-        expect(resp.status).to eq(200)
-        expect(JSON.parse(resp.body)).to include('items')
-      end
-    end
-
-    describe '#prev' do
-      it 'returns the response' do
-        resp = suppress.prev
-        expect(resp.status).to eq(200)
-        expect(JSON.parse(resp.body)).to include('items')
-      end
-    end
-  end
-
-  context 'with 1000 or more entries' do
-    subject(:suppressions) { Mailgun::Suppressions.new(client, domain) }
-
-    let(:large_list) { Array.new(1000) { |i| { address: "user#{i}@example.com" } } }
-    let(:client)  { double(:client) }
-    let(:domain)  { 'example.com' }
-
-    def stub_response(body = {})
-      double(:response).tap do |r|
-        allow(r).to receive_messages(to_h: body, to_h!: body, code: 200, body: body)
-      end
-    end
-
-    it 'splits bounces list and makes two POST requests' do
-      expect(client).to receive(:post)
-        .with('example.com/bounces', anything, { 'Content-Type' => 'application/json' })
-        .twice
-        .and_return(stub_response)
-
-      _resp, split = suppressions.create_bounces(large_list)
-      expect(split).not_to be_empty
-    end
-
-    it 'splits unsubscribes list and makes two POST requests' do
-      expect(client).to receive(:post)
-        .with('example.com/unsubscribes', anything, { 'Content-Type' => 'application/json' })
-        .twice
-        .and_return(stub_response)
-
-      _resp, split = suppressions.create_unsubscribes(large_list)
-      expect(split).not_to be_empty
-    end
-
-    it 'splits complaints list and makes two POST requests' do
-      expect(client).to receive(:post)
-        .with('example.com/complaints', anything, { 'Content-Type' => 'application/json' })
-        .twice
-        .and_return(stub_response)
-
-      _resp, split = suppressions.create_complaints(large_list)
-      expect(split).not_to be_empty
-    end
-  end
-end

data/spec/integration/templates_spec.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-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/integration/unsubscribes_spec.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'unsubscribes' }
-
-describe 'For the Unsubscribes endpoint', order: :defined, vcr: vcr_opts do
-  before(:all) do
-    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
-    @domain = TESTDOMAIN || 'DOMAIN.TEST'
-    @email = "integration-test-email@#{@domain}"
-  end
-
-  it 'adds an unsubscriber' do
-    result = @mg_obj.post "#{@domain}/unsubscribes", address: @email, tag: '*'
-
-    result.to_h!
-    expect(result.body['message']).to eq('Address has been added to the unsubscribes table')
-    expect(result.body['address']).to eq(@email)
-  end
-
-  it 'get an unsubscribee.' do
-    result = @mg_obj.get "#{@domain}/unsubscribes/#{@email}"
-
-    result.to_h!
-    expect(result.body['address']).to eq(@email)
-  end
-
-  it 'gets a list of unsubscribes.' do
-    result = @mg_obj.get "#{@domain}/unsubscribes"
-
-    result.to_h!
-    expect(result.body['items'].length).to be > 0
-  end
-
-  it 'removes an unsubscribee' do
-    result = @mg_obj.delete "#{@domain}/unsubscribes/#{@email}"
-
-    result.to_h!
-    expect(result.body['address']).to eq(@email)
-    expect(result.body['message']).to eq('Unsubscribe event has been removed')
-  end
-end

data/spec/integration/webhook_spec.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'mailgun'
-
-vcr_opts = { cassette_name: 'webhooks' }
-
-describe 'For the webhooks endpoint', order: :defined, vcr: vcr_opts do
-  let(:api_version) { 'v3' }
-  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, api_version, SSL) }
-  let(:mg_obj) { Mailgun::Webhooks.new(mg_client) }
-  let(:domain) { 'DOMAIN.TEST' }
-  let(:testhook) { 'accepted' }
-  let(:testhookup) { 'accepted' }
-
-  it 'creates a webhook' do
-    result = mg_obj.create(domain, testhook, "http://example.com/mailgun/events/#{testhook}")
-
-    expect(result).to be_truthy
-  end
-
-  it 'gets a webhook' do
-    result = mg_obj.get(domain, testhook)
-
-    expect(result).to include("http://example.com/mailgun/events/#{testhook}")
-  end
-
-  it 'gets a list of all webhooks' do
-    result = mg_obj.list(domain)
-
-    expect(result['accepted']['urls'][0]).to include("http://example.com/mailgun/events/#{testhook}")
-  end
-
-  it 'updates a webhook' do
-    result = mg_obj.update(domain, testhook, "http://example.com/mailgun/events/#{testhookup}")
-
-    expect(result).to be_truthy
-  end
-
-  it 'removes a webhook' do
-    result = mg_obj.remove(domain, testhook)
-
-    expect(result).to be_truthy
-  end
-end
-
-describe 'For the v4 webhooks endpoint', vcr: { cassette_name: 'webhooks_v4' } do
-  let(:mg_client) { Mailgun::Client.new(APIKEY, APIHOST, 'v4', SSL) }
-  let(:mg_obj) { Mailgun::Webhooks.new(mg_client) }
-  let(:domain) { 'DOMAIN.TEST' }
-  let(:url) { 'http://example.com/mailgun/events/v4' }
-
-  describe '#create_v4' do
-    it 'creates webhooks for multiple event types' do
-      result = mg_obj.create_v4(domain, url: url, event_types: %w[accepted delivered])
-
-      expect(result.keys).to contain_exactly('accepted', 'delivered')
-      expect(result['accepted']['urls']).to include(url)
-      expect(result['delivered']['urls']).to include(url)
-    end
-  end
-
-  describe '#update_v4' do
-    it 'replaces the event types associated with a url' do
-      result = mg_obj.update_v4(domain, url: url, event_types: %w[clicked opened])
-
-      expect(result.keys).to contain_exactly('clicked', 'opened')
-      expect(result['clicked']['urls']).to include(url)
-    end
-  end
-
-  describe '#remove_v4' do
-    it 'removes the urls from all event types' do
-      result = mg_obj.remove_v4(domain, url: [url, 'http://example.com/mailgun/events/v4-other'])
-
-      expect(result).to eq({})
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-require 'simplecov'
-require 'simplecov-json'
-SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
-  [
-    SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::JSONFormatter
-  ]
-)
-
-SimpleCov.start do
-  add_filter '/spec/'
-end
-
-require 'mailgun'
-
-require 'vcr'
-require 'webmock/rspec'
-# Keep repeated query keys (e.g. ?url=a&url=b) instead of collapsing them to the last value
-WebMock::Config.instance.query_values_notation = :flat_array
-require 'rspec/its'
-
-# WebMock.disable_net_connect!(allow_localhost: true)
-require_relative 'unit/connection/test_client'
-
-RSpec.configure(&:raise_errors_for_deprecations!)
-
-APIHOST = 'api.mailgun.net'
-APIVERSION = 'v3'
-SSL = true
-
-# For integration tests modify .ruby-env.yml
-# use .ruby-env.yml.example for an example
-# alternatively
-# set environment variables as named in .ruby-env.yml.example
-envfile = File.join(File.dirname(__FILE__), '..', '.ruby-env.yml')
-envs = File.exist?(envfile) ? YAML.load_file(envfile) : ENV
-APIKEY = envs['MAILGUN_APIKEY']
-PUB_APIKEY = envs['MAILGUN_PUB_APIKEY']
-TESTDOMAIN = envs['MAILGUN_TESTDOMAIN']
-
-VCR.configure do |c|
-  c.cassette_library_dir = 'vcr_cassettes'
-  c.hook_into :webmock
-  c.default_cassette_options = { record: :new_episodes }
-  c.filter_sensitive_data('<APIKEY>') { APIKEY }
-  c.filter_sensitive_data('<BASIC_AUTH>') { ["api:#{APIKEY}"].pack('m0') } if APIKEY
-  c.filter_sensitive_data('DOMAIN.TEST') { TESTDOMAIN }
-  c.filter_sensitive_data('<PUBKEY>') { PUB_APIKEY }
-
-  c.configure_rspec_metadata!
-end