mailgun-ruby 1.4.5 → 1.4.6

data/spec/unit/response_spec.rb

@@ -1,225 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-require 'json'
-require 'yaml'
-require 'mailgun/response'
-require 'mailgun/exceptions/exceptions'
-
-describe Mailgun::Response do
-  subject(:response) { described_class.new(http_response) }
-
-  let(:json_body) { '{"id":"<message-id@example.com>","message":"Queued. Thank you."}' }
-  let(:status200) { 200 }
-
-  # Minimal double that mimics a RestClient::Response
-  let(:http_response) do
-    double('http_response', body: json_body, status: status200)
-  end
-
-  # ---------------------------------------------------------------------------
-  # .new
-  # ---------------------------------------------------------------------------
-  describe '#initialize' do
-    it 'sets body from the underlying response' do
-      expect(response.body).to eq(json_body)
-    end
-
-    it 'sets status from the underlying response' do
-      expect(response.status).to eq(status200)
-    end
-
-    it 'aliases code to status' do
-      expect(response.code).to eq(status200)
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # .from_hash
-  # ---------------------------------------------------------------------------
-  describe '.from_hash' do
-    subject(:from_hash_response) do
-      described_class.from_hash(body: json_body, status: status200)
-    end
-
-    it 'returns a Response instance' do
-      expect(from_hash_response).to be_a(described_class)
-    end
-
-    it 'sets body from the hash' do
-      expect(from_hash_response.body).to eq(json_body)
-    end
-
-    it 'sets status from the hash' do
-      expect(from_hash_response.status).to eq(status200)
-    end
-
-    it 'aliases code to status' do
-      expect(from_hash_response.code).to eq(status200)
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # #to_h
-  # ---------------------------------------------------------------------------
-  describe '#to_h' do
-    it 'returns a Hash' do
-      expect(response.to_h).to be_a(Hash)
-    end
-
-    it 'correctly parses the JSON body' do
-      result = response.to_h
-      expect(result['id']).to eq('<message-id@example.com>')
-      expect(result['message']).to eq('Queued. Thank you.')
-    end
-
-    it 'does not mutate the body attribute' do
-      expect { response.to_h }.not_to(change(response, :body))
-    end
-
-    context 'when the body is invalid JSON' do
-      let(:http_response) { double('http_response', body: 'not-json', status: 200) }
-
-      it 'raises a Mailgun::ParseError' do
-        expect { response.to_h }.to raise_error(Mailgun::ParseError)
-      end
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # #to_h!
-  # ---------------------------------------------------------------------------
-  describe '#to_h!' do
-    it 'returns a Hash' do
-      expect(response.to_h!).to be_a(Hash)
-    end
-
-    it 'correctly parses the JSON body' do
-      result = response.to_h!
-      expect(result['message']).to eq('Queued. Thank you.')
-    end
-
-    it 'replaces body with the parsed Hash' do
-      response.to_h!
-      expect(response.body).to be_a(Hash)
-      expect(response.body['id']).to eq('<message-id@example.com>')
-    end
-
-    context 'when the body is invalid JSON' do
-      let(:http_response) { double('http_response', body: 'not-json', status: 200) }
-
-      it 'raises a Mailgun::ParseError' do
-        expect { response.to_h! }.to raise_error(Mailgun::ParseError)
-      end
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # #to_yaml
-  # ---------------------------------------------------------------------------
-  describe '#to_yaml' do
-    it 'returns a String' do
-      expect(response.to_yaml).to be_a(String)
-    end
-
-    it 'returns valid YAML that round-trips back to the expected hash' do
-      parsed = YAML.safe_load(response.to_yaml)
-      expect(parsed['id']).to eq('<message-id@example.com>')
-      expect(parsed['message']).to eq('Queued. Thank you.')
-    end
-
-    it 'does not mutate the body attribute' do
-      expect { response.to_yaml }.not_to(change(response, :body))
-    end
-
-    context 'when the body is invalid JSON' do
-      let(:http_response) { double('http_response', body: 'not-json', status: 200) }
-
-      it 'raises a Mailgun::ParseError' do
-        expect { response.to_yaml }.to raise_error(Mailgun::ParseError)
-      end
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # #to_yaml!
-  # ---------------------------------------------------------------------------
-  describe '#to_yaml!' do
-    it 'returns a String' do
-      expect(response.to_yaml!).to be_a(String)
-    end
-
-    it 'returns valid YAML that round-trips back to the expected hash' do
-      yaml_str = response.to_yaml!
-      parsed = YAML.safe_load(yaml_str)
-      expect(parsed['message']).to eq('Queued. Thank you.')
-    end
-
-    it 'replaces body with the YAML string' do
-      response.to_yaml!
-      expect(response.body).to be_a(String)
-      expect(response.body).to include('Queued. Thank you.')
-    end
-
-    context 'when the body is invalid JSON' do
-      let(:http_response) { double('http_response', body: 'not-json', status: 200) }
-
-      it 'raises a Mailgun::ParseError' do
-        expect { response.to_yaml! }.to raise_error(Mailgun::ParseError)
-      end
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # #success?
-  # ---------------------------------------------------------------------------
-  describe '#success?' do
-    context 'with a 2xx status code' do
-      [200, 201, 204, 299].each do |code|
-        it "returns true for status #{code}" do
-          allow(http_response).to receive(:status).and_return(code)
-          expect(described_class.new(http_response).success?).to be(true)
-        end
-      end
-    end
-
-    context 'with a non-2xx status code' do
-      [400, 401, 403, 404, 422, 500, 503].each do |code|
-        it "returns false for status #{code}" do
-          allow(http_response).to receive(:status).and_return(code)
-          expect(described_class.new(http_response).success?).to be(false)
-        end
-      end
-    end
-
-    it 'returns false for status 199 (just below 2xx range)' do
-      allow(http_response).to receive(:status).and_return(199)
-      expect(described_class.new(http_response).success?).to be(false)
-    end
-
-    it 'returns false for status 300 (just above 2xx range)' do
-      allow(http_response).to receive(:status).and_return(300)
-      expect(described_class.new(http_response).success?).to be(false)
-    end
-  end
-
-  # ---------------------------------------------------------------------------
-  # attr_accessor sanity checks
-  # ---------------------------------------------------------------------------
-  describe 'attribute accessors' do
-    it 'allows body to be overwritten' do
-      response.body = 'new body'
-      expect(response.body).to eq('new body')
-    end
-
-    it 'allows status to be overwritten' do
-      response.status = 404
-      expect(response.status).to eq(404)
-    end
-
-    it 'allows code to be overwritten' do
-      response.code = 500
-      expect(response.code).to eq(500)
-    end
-  end
-end

data/spec/unit/webhooks_spec.rb

@@ -1,121 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe Mailgun::Webhooks do
-  let(:client) { double(:client) }
-  let(:webhooks) { described_class.new(client) }
-  let(:domain) { 'example.com' }
-  let(:url) { 'https://example.com/mailgun/events' }
-
-  %i[create_all add_all_webhooks].each do |method|
-    describe "##{method}" do
-      it 'creates every webhook action with the provided URL' do
-        described_class::ACTIONS.each do |action|
-          expect(webhooks).to receive(:create).with(domain, action, url).ordered
-        end
-
-        expect { webhooks.public_send(method, domain, url) }
-          .to output(/`#{method}` method will be deprecated/).to_stderr
-      end
-    end
-  end
-
-  context 'with v3 endpoints' do
-    let(:client) { instance_double(Mailgun::Client, api_version: 'v3') }
-
-    describe '#create' do
-      let(:urls) { [url, 'https://example.com/other'] }
-      let(:response) do
-        instance_double(Mailgun::Response,
-                        to_h: { 'message' => 'Webhook has been created', 'webhook' => { 'urls' => urls } })
-      end
-
-      before { allow(client).to receive(:post).and_return(response) }
-
-      it 'returns true when a single url was created' do
-        expect(webhooks.create(domain, 'delivered', url)).to be(true)
-      end
-
-      it 'returns true when multiple urls were created' do
-        expect(webhooks.create(domain, 'delivered', urls)).to be(true)
-      end
-
-      it 'returns false when a url is missing from the response' do
-        expect(webhooks.create(domain, 'delivered', [url, 'https://example.com/missing'])).to be(false)
-      end
-    end
-
-    describe 'parameter validation' do
-      it 'raises a ParameterError when the domain is missing' do
-        [nil, ''].each do |blank|
-          expect { webhooks.update(blank, 'delivered', url) }
-            .to raise_error(Mailgun::ParameterError, 'Domain not provided to update webhooks')
-          expect { webhooks.remove(blank, 'delivered') }
-            .to raise_error(Mailgun::ParameterError, 'Domain not provided to remove webhook from')
-        end
-      end
-
-      it 'raises a ParameterError when the action is missing' do
-        [nil, ''].each do |blank|
-          expect { webhooks.update(domain, blank, url) }
-            .to raise_error(Mailgun::ParameterError, 'Action not provided to identify webhook to update')
-          expect { webhooks.remove(domain, blank) }
-            .to raise_error(Mailgun::ParameterError, 'Action not provided to identify webhook to remove')
-        end
-      end
-    end
-  end
-
-  context 'with v4 endpoints' do
-    let(:api_version) { 'v4' }
-    let(:client) { instance_double(Mailgun::Client, api_version: api_version) }
-    let(:response) { instance_double(Mailgun::Response, to_h: { 'webhooks' => { 'accepted' => { 'urls' => [url] } } }) }
-
-    describe '#create_v4' do
-      it 'posts the url and event types to the domain webhooks endpoint' do
-        expect(client).to receive(:post)
-          .with("domains/#{domain}/webhooks", { url: url, event_types: %w[accepted delivered] })
-          .and_return(response)
-
-        expect(webhooks.create_v4(domain, url: url, event_types: %w[accepted delivered]))
-          .to eq('accepted' => { 'urls' => [url] })
-      end
-    end
-
-    describe '#update_v4' do
-      it 'puts the url and event types to the domain webhooks endpoint' do
-        expect(client).to receive(:put)
-          .with("domains/#{domain}/webhooks", { url: url, event_types: 'accepted' })
-          .and_return(response)
-
-        expect(webhooks.update_v4(domain, url: url, event_types: 'accepted'))
-          .to eq('accepted' => { 'urls' => [url] })
-      end
-    end
-
-    describe '#remove_v4' do
-      it 'sends the urls as query params' do
-        urls = [url, 'https://example.com/other']
-        expect(client).to receive(:delete)
-          .with("domains/#{domain}/webhooks", { url: urls })
-          .and_return(response)
-
-        webhooks.remove_v4(domain, url: urls)
-      end
-    end
-
-    context 'when the client api version is not v4' do
-      let(:api_version) { 'v3' }
-
-      it 'raises a ParameterError' do
-        expect { webhooks.create_v4(domain, url: url, event_types: 'accepted') }
-          .to raise_error(Mailgun::ParameterError, /must be v4/)
-        expect { webhooks.update_v4(domain, url: url, event_types: 'accepted') }
-          .to raise_error(Mailgun::ParameterError, /must be v4/)
-        expect { webhooks.remove_v4(domain, url: url) }
-          .to raise_error(Mailgun::ParameterError, /must be v4/)
-      end
-    end
-  end
-end

data/vcr_cassettes/For_the_suppressions_handling_class/creates_a_single_bounce.yml

@@ -1,55 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.mailgun.net/bounces
-    body:
-      encoding: UTF-8
-      string: address=test5%40example.info&code=500&error=integration+testing
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.2
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic XXX
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Content-Length:
-      - '89'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Wed, 25 Mar 2026 18:09:17 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - XXX
-      X-Request-Limit:
-      - '2500'
-      X-Request-Remaining:
-      - '2498'
-      X-Request-Reset:
-      - '1774462171770'
-      X-Xss-Protection:
-      - 1; mode=block
-    body:
-      encoding: UTF-8
-      string: '{"message":"Address has been added to the bounces table","address":"test5@example.info"}
-
-        '
-  recorded_at: Wed, 25 Mar 2026 18:09:17 GMT
-recorded_with: VCR 6.4.0

data/vcr_cassettes/account_webhooks.yml

@@ -1,269 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.mailgun.net/v1/webhooks
-    body:
-      encoding: UTF-8
-      string: description=test&event_types=accepted&url=http%3A%2F%2Fexample.com%2Fmailgun%2Fevents
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.4
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic xxx
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Content-Length:
-      - '42'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Mon, 25 May 2026 09:11:02 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - xxx
-      X-Xss-Protection:
-      - 1; mode=block
-      Server-Timing:
-      - cfReqDur;dur=382.358
-      Cf-Team:
-      - xxx
-    body:
-      encoding: UTF-8
-      string: '{"webhook_id":"test"}
-
-        '
-  recorded_at: Mon, 25 May 2026 09:11:02 GMT
-- request:
-    method: get
-    uri: https://api.mailgun.net/v1/webhooks?webhook_ids=
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.4
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic xxx
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Content-Length:
-      - '183'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Mon, 25 May 2026 09:16:27 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - xxx
-      X-Xss-Protection:
-      - 1; mode=block
-      Server-Timing:
-      - cfReqDur;dur=201.477
-      Cf-Team:
-      - xxx
-    body:
-      encoding: UTF-8
-      string: '{"webhooks":[{"webhook_id":"test","description":"test","url":"http://example.com/mailgun/events","event_types":["accepted"],"created_at":"2026-05-25T09:11:02Z"}]}
-
-        '
-  recorded_at: Mon, 25 May 2026 09:16:27 GMT
-- request:
-    method: get
-    uri: https://api.mailgun.net/v1/webhooks/test
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.4
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic xxx
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Content-Length:
-      - '168'
-      Content-Type:
-      - application/json; charset=utf-8
-      Date:
-      - Mon, 25 May 2026 09:22:12 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - xxx
-      X-Xss-Protection:
-      - 1; mode=block
-      Server-Timing:
-      - cfReqDur;dur=234.628
-      Cf-Team:
-      - xxx
-    body:
-      encoding: UTF-8
-      string: '{"webhook_id":"test","description":"test","url":"http://example.com/mailgun/events","event_types":["accepted"],"created_at":"2026-05-25T09:11:02Z"}
-
-        '
-  recorded_at: Mon, 25 May 2026 09:22:12 GMT
-- request:
-    method: put
-    uri: https://api.mailgun.net/v1/webhooks/test
-    body:
-      encoding: UTF-8
-      string: description=test2&event_types=accepted&url=http%3A%2F%2Fexample.com%2Fmailgun%2Fevents
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.4
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic xxx
-      Content-Type:
-      - application/x-www-form-urlencoded
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 204
-      message: No Content
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Date:
-      - Mon, 25 May 2026 12:03:17 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - xxx
-      X-Xss-Protection:
-      - 1; mode=block
-    body:
-      encoding: UTF-8
-      string: ''
-  recorded_at: Mon, 25 May 2026 12:03:17 GMT
-- request:
-    method: delete
-    uri: https://api.mailgun.net/v1/webhooks/test
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.4
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic xxx
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 204
-      message: No Content
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Date:
-      - Mon, 25 May 2026 12:08:15 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - xxx
-      X-Xss-Protection:
-      - 1; mode=block
-    body:
-      encoding: UTF-8
-      string: ''
-  recorded_at: Mon, 25 May 2026 12:08:15 GMT
-- request:
-    method: delete
-    uri: https://api.mailgun.net/v1/webhooks?all=true
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.4.4
-      Accept:
-      - "*/*"
-      Authorization:
-      - Basic xxx
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-  response:
-    status:
-      code: 204
-      message: No Content
-    headers:
-      Access-Control-Allow-Credentials:
-      - 'true'
-      Access-Control-Allow-Origin:
-      - "*"
-      Cache-Control:
-      - no-store
-      Date:
-      - Mon, 25 May 2026 20:28:16 GMT
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - xxx
-      X-Xss-Protection:
-      - 1; mode=block
-      Server-Timing:
-      - cfReqDur;dur=246.503
-      Cf-Team:
-      - xxx
-    body:
-      encoding: UTF-8
-      string: ''
-  recorded_at: Mon, 25 May 2026 20:28:16 GMT
-recorded_with: VCR 6.4.0