mailgun-ruby 1.4.0 → 1.4.2

data/spec/unit/railgun/mailer_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'logger'
 require 'spec_helper'
@@ -15,42 +17,40 @@ class UnitTestMailer < ActionMailer::Base
   def plain_message(address, subject, headers)
     headers(headers)
     mail(to: address, subject: subject) do |format|
-      format.text { render plain: "Test!" }
-      format.html { render html: "<p>Test!</p>".html_safe }
+      format.text { render plain: 'Test!' }
+      format.html { render html: '<p>Test!</p>'.html_safe }
     end
   end
 
   def message_with_attachment(address, subject)
     attachments['info.txt'] = {
-      :content => File.read('docs/railgun/Overview.md'),
-      :mime_type => 'text/plain',
+      content: File.read('docs/railgun/Overview.md'),
+      mime_type: 'text/plain'
     }
     mail(to: address, subject: subject) do |format|
-      format.text { render plain: "Test!" }
-      format.html { render html: "<p>Test!</p>".html_safe }
+      format.text { render plain: 'Test!' }
+      format.html { render html: '<p>Test!</p>'.html_safe }
     end
   end
 
   def message_with_template(address, subject, template_name)
     mail(to: address, subject: subject, template: template_name) do |format|
-      format.text { render plain: "Test!" }
+      format.text { render plain: 'Test!' }
     end
   end
 
   def message_with_domain(address, subject, domain)
     mail(to: address, subject: subject, domain: domain) do |format|
-      format.text { render plain: "Test!" }
+      format.text { render plain: 'Test!' }
     end
   end
-
 end
 
 describe 'Railgun::Mailer' do
-
   it 'has a mailgun_client property which returns a Mailgun::Client' do
     config = {
-      api_key:  {},
-      domain:   {}
+      api_key: {},
+      domain: {}
     }
     @mailer_obj = Railgun::Mailer.new(config)
 
@@ -60,18 +60,18 @@ describe 'Railgun::Mailer' do
   context 'when config does not have api_key or domain' do
     it 'raises configuration error' do
       config = {
-        api_key:  {}
+        api_key: {}
       }
 
-    expect { Railgun::Mailer.new(config) }.to raise_error(Railgun::ConfigurationError)
+      expect { Railgun::Mailer.new(config) }.to raise_error(Railgun::ConfigurationError)
     end
   end
 
   context 'when fake_message_send is present in config' do
     it 'enables test mode' do
       config = {
-        api_key:  {},
-        domain:   {},
+        api_key: {},
+        domain: {},
         fake_message_send: true
       }
       client_double = double(Mailgun::Client)
@@ -100,7 +100,7 @@ describe 'Railgun::Mailer' do
   it 'adds options to message body' do
     message = UnitTestMailer.plain_message('test@example.org', '', {})
     message.mailgun_options ||= {
-      'tracking-opens' => 'true',
+      'tracking-opens' => 'true'
     }
 
     body = Railgun.transform_for_mailgun(message)
@@ -124,14 +124,14 @@ describe 'Railgun::Mailer' do
   it 'adds variables to message body' do
     message = UnitTestMailer.plain_message('test@example.org', '', {})
     message.mailgun_variables ||= {
-      'user' => {:id => '1', :name => 'tstark'},
+      'user' => { id: '1', name: 'tstark' }
     }
 
     body = Railgun.transform_for_mailgun(message)
 
     expect(body).to include('v:user')
 
-    var_body = JSON.load(body['v:user'])
+    var_body = JSON.parse(body['v:user'])
     expect(var_body).to include('id')
     expect(var_body).to include('name')
     expect(var_body['id']).to eq('1')
@@ -141,7 +141,7 @@ describe 'Railgun::Mailer' do
   it 'adds headers to message body' do
     message = UnitTestMailer.plain_message('test@example.org', '', {})
     message.mailgun_headers ||= {
-      'x-unit-test' => 'true',
+      'x-unit-test' => 'true'
     }
 
     body = Railgun.transform_for_mailgun(message)
@@ -152,8 +152,8 @@ describe 'Railgun::Mailer' do
 
   it 'adds headers to message body from mailer' do
     message = UnitTestMailer.plain_message('test@example.org', '', {
-      'x-unit-test-2' => 'true',
-    })
+                                             'x-unit-test-2' => 'true'
+                                           })
 
     body = Railgun.transform_for_mailgun(message)
 
@@ -163,20 +163,20 @@ describe 'Railgun::Mailer' do
 
   it 'properly handles headers that are passed as separate POST params' do
     message = UnitTestMailer.plain_message('test@example.org', 'Test!', {
-      # `From`, `To`, and `Subject` are set on the envelope, so they should be ignored as headers
-      'From' => 'units@example.net',
-      'To' => 'user@example.com',
-      'Subject' => 'This should disappear',
-      # If `Bcc` or `Cc` are set as headers, they should be carried over as POST params, not headers
-      'Bcc' => ['list@example.org'],
-      'Cc' => ['admin@example.com'],
-      # This is an arbitrary header and should be carried over properly
-      'X-Source' => 'unit tests',
-    })
+                                             # `From`, `To`, and `Subject` are set on the envelope, so they should be ignored as headers
+                                             'From' => 'units@example.net',
+                                             'To' => 'user@example.com',
+                                             'Subject' => 'This should disappear',
+                                             # If `Bcc` or `Cc` are set as headers, they should be carried over as POST params, not headers
+                                             'Bcc' => ['list@example.org'],
+                                             'Cc' => ['admin@example.com'],
+                                             # This is an arbitrary header and should be carried over properly
+                                             'X-Source' => 'unit tests'
+                                           })
 
     body = Railgun.transform_for_mailgun(message)
 
-    ['From', 'To', 'Subject'].each do |header|
+    %w[From To Subject].each do |header|
       expect(body).not_to include("h:#{header}")
     end
 
@@ -202,20 +202,20 @@ describe 'Railgun::Mailer' do
         }
       end
       body = Railgun.transform_for_mailgun(message)
-      expect(body["v:my-data"]).to be_kind_of(String)
-      expect(body["v:my-data"].to_s).to eq('{"key":"value"}')
+      expect(body['v:my-data']).to be_kind_of(String)
+      expect(body['v:my-data'].to_s).to eq('{"key":"value"}')
     end
 
     it 'accepts a hash and appends as data to the message.' do
       message = UnitTestMailer.plain_message('test@example.org', '', {}).tap do |message|
         message.mailgun_variables = {
-          'my-data' => {'key' => 'value'}
+          'my-data' => { 'key' => 'value' }
         }
       end
       body = Railgun.transform_for_mailgun(message)
 
-      expect(body["v:my-data"]).to be_kind_of(String)
-      expect(body["v:my-data"].to_s).to eq('{"key":"value"}')
+      expect(body['v:my-data']).to be_kind_of(String)
+      expect(body['v:my-data'].to_s).to eq('{"key":"value"}')
     end
 
     it 'accepts string values' do
@@ -226,8 +226,8 @@ describe 'Railgun::Mailer' do
       end
       body = Railgun.transform_for_mailgun(message)
 
-      expect(body["v:my-data"]).to be_kind_of(String)
-      expect(body["v:my-data"].to_s).to eq('String Value.')
+      expect(body['v:my-data']).to be_kind_of(String)
+      expect(body['v:my-data'].to_s).to eq('String Value.')
     end
   end
 
@@ -251,13 +251,13 @@ describe 'Railgun::Mailer' do
 
   it 'ignores `reply-to` in headers' do
     message = UnitTestMailer.plain_message('test@example.org', '', {
-      'reply-to' => 'user@example.com',
-    })
+                                             'reply-to' => 'user@example.com'
+                                           })
     message.mailgun_headers = {
-      'Reply-To' => 'administrator@example.org',
+      'Reply-To' => 'administrator@example.org'
     }
-    message.headers({'REPLY-TO' => 'admin@example.net'})
-    message.reply_to = "dude@example.com.au"
+    message.headers({ 'REPLY-TO' => 'admin@example.net' })
+    message.reply_to = 'dude@example.com.au'
 
     body = Railgun.transform_for_mailgun(message)
     expect(body).to include('h:reply-to')
@@ -267,12 +267,12 @@ describe 'Railgun::Mailer' do
 
   it 'ignores `mime-version` in headers' do
     message = UnitTestMailer.plain_message('test@example.org', '', {
-      'mime-version' => '1.0',
-    })
+                                             'mime-version' => '1.0'
+                                           })
     message.mailgun_headers = {
-      'Mime-Version' => '1.1',
+      'Mime-Version' => '1.1'
     }
-    message.headers({'MIME-VERSION' => '1.2'})
+    message.headers({ 'MIME-VERSION' => '1.2' })
 
     body = Railgun.transform_for_mailgun(message)
     expect(body).not_to include('h:mime-version')
@@ -280,32 +280,32 @@ describe 'Railgun::Mailer' do
 
   it 'treats `headers()` names as case-insensitve' do
     message = UnitTestMailer.plain_message('test@example.org', '', {
-      'X-BIG-VALUE' => 1,
-    })
+                                             'X-BIG-VALUE' => 1
+                                           })
 
     body = Railgun.transform_for_mailgun(message)
     expect(body).to include('h:x-big-value')
-    expect(body['h:x-big-value']).to eq("1")
+    expect(body['h:x-big-value']).to eq('1')
   end
 
   it 'treats `mailgun_headers` names as case-insensitive' do
     message = UnitTestMailer.plain_message('test@example.org', '', {})
     message.mailgun_headers = {
-      'X-BIG-VALUE' => 1,
+      'X-BIG-VALUE' => 1
     }
 
     body = Railgun.transform_for_mailgun(message)
     expect(body).to include('h:x-big-value')
-    expect(body['h:x-big-value']).to eq("1")
+    expect(body['h:x-big-value']).to eq('1')
   end
 
   it 'handles multi-value, mixed case headers correctly' do
     message = UnitTestMailer.plain_message('test@example.org', '', {})
     message.headers({
-      'x-neat-header' => 'foo',
-      'X-Neat-Header' => 'bar',
-      'X-NEAT-HEADER' => 'zoop',
-    })
+                      'x-neat-header' => 'foo',
+                      'X-Neat-Header' => 'bar',
+                      'X-NEAT-HEADER' => 'zoop'
+                    })
 
     body = Railgun.transform_for_mailgun(message)
     expect(body).to include('h:x-neat-header')

data/vcr_cassettes/analytics_tags.yml

@@ -0,0 +1,187 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mailgun.net/v1/analytics/tags
+    body:
+      encoding: UTF-8
+      string: include_subaccounts=true&pagination=%7Bsort%3A+%22lastseen%3Adesc%22%2C+limit%3A+10%7D
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.1
+      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:
+      - '317'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 28 Jan 2026 18:49:42 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"account_id":"test","parent_account_id":"test","tag":"test1","description":"","first_seen":"Wed,
+        28 Jan 2026 18:27:11 +0000","last_seen":"Wed, 28 Jan 2026 18:00:00 +0000","metrics":{},"account_name":"Alex
+        Lebedev"}],"pagination":{"sort":"lastseen:desc","limit":10}}
+
+        '
+  recorded_at: Wed, 28 Jan 2026 18:49:42 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v1/analytics/tags/limits
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.1
+      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:
+      - '49'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 28 Jan 2026 18:55:47 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"limit":100000,"count":1,"limit_reached":false}
+
+        '
+  recorded_at: Wed, 28 Jan 2026 18:55:47 GMT
+- request:
+    method: put
+    uri: https://api.mailgun.net/v1/analytics/tags
+    body:
+      encoding: UTF-8
+      string: '{"tag":"test1","description":"test_description"}'
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.2
+      Accept:
+      - "*/*"
+      Content-Type:
+      - application/json
+      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:
+      - '26'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 28 Jan 2026 20:04:23 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"Tag updated"}
+
+        '
+  recorded_at: Wed, 28 Jan 2026 20:04:23 GMT
+- request:
+    method: delete
+    uri: https://api.mailgun.net/v1/analytics/tags
+    body:
+      encoding: UTF-8
+      string: '{"tag":"test1"}'
+    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:
+      - '26'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Wed, 28 Jan 2026 20:05:54 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"Tag deleted"}
+
+        '
+  recorded_at: Wed, 28 Jan 2026 20:05:54 GMT
+recorded_with: VCR 6.4.0

data/vcr_cassettes/domains.yml

@@ -1088,4 +1088,156 @@ http_interactions:
         '
     http_version:
   recorded_at: Thu, 28 Aug 2025 14:47:08 GMT
+- request:
+    method: put
+    uri: https://api.mailgun.net/v4/domains/integration-test.domain.invalid/verify
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx
+      Content-Length:
+      - '0'
+      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:
+      - '1752'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sat, 27 Dec 2025 23:47:46 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Request-Limit:
+      - '10'
+      X-Request-Remaining:
+      - '9'
+      X-Request-Reset:
+      - '1766879267069'
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"Domain DNS records have been updated","domain":{"created_at":"Thu,
+        27 Nov 2025 22:42:06 GMT","id":"xxx","is_disabled":false,"name":"integration-test.domain.invalid","require_tls":false,"skip_verification":false,"smtp_login":"","spam_action":"tag","state":"unverified","type":"custom","use_automatic_sender_security":false,"web_prefix":"email","web_scheme":"http","wildcard":false,"encrypt_incoming_message":false,"message_ttl":0},"sending_dns_records":[{"is_active":false,"cached":[],"name":"k1._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx+xxx+xxx"},{"is_active":false,"cached":[],"name":"string._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx/xxx+xx+xxx+xxx+xxx/xxx/xxx"},{"is_active":true,"cached":[],"name":"integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"v=spf1
+        include:mailgun.org ~all"},{"is_active":true,"cached":[],"name":"email.integration-test.domain.invalid","record_type":"CNAME","valid":"unknown","value":"mailgun.org"}],"receiving_dns_records":[{"is_active":true,"cached":[],"priority":"10","record_type":"MX","valid":"unknown","value":"mxa.mailgun.org"},{"is_active":true,"cached":[],"priority":"10","record_type":"MX","valid":"unknown","value":"mxb.mailgun.org"}]}
+
+        '
+    http_version:
+  recorded_at: Sat, 27 Dec 2025 23:47:46 GMT
+- request:
+    method: post
+    uri: https://api.mailgun.net/v1/dkim/keys
+    body:
+      encoding: UTF-8
+      string: selector=test&signing_domain=integration-test.domain.invalid
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.0
+      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:
+      - '447'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 28 Dec 2025 00:07:03 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"signing_domain":"integration-test.domain.invalid","selector":"test","dns_record":{"is_active":false,"cached":[],"name":"test._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx"}}
+
+        '
+    http_version:
+  recorded_at: Sun, 28 Dec 2025 00:07:03 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v1/dkim/keys?signing_domain=integration-test.domain.invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.4.0
+      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:
+      - '1767'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 28 Dec 2025 00:12:23 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - xxx
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"signing_domain":"integration-test.domain.invalid","selector":"k1","dns_record":{"is_active":false,"cached":[],"name":"k1._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx"}},{"signing_domain":"integration-test.domain.invalid","selector":"test","dns_record":{"is_active":false,"cached":[],"name":"test._domainkey.integration-test.domain.invalid","record_type":"TXT","valid":"unknown","value":"k=rsa;
+        p=xxx"}}],"paging":{"previous":"https://api.mailgun.net/v1/dkim/keys?page=xxx","first":"https://api.mailgun.net/v1/dkim/keys?page=xxx","next":"https://api.mailgun.net/v1/dkim/keys?page=xxx","last":"https://api.mailgun.net/v1/dkim/keys?page=xxx"}}
+
+        '
+    http_version:
+  recorded_at: Sun, 28 Dec 2025 00:12:23 GMT
 recorded_with: VCR 3.0.3