mailgun-ruby 1.4.1 → 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Mailgun
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.16.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 0.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.13.0
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,47 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 13.3.1
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -123,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.16.1
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.4.0
 - !ruby/object:Gem::Dependency
-  name: mini_mime
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '3.7'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: mini_mime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -200,14 +214,13 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
 - ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-env.yml.example"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- docs/AnalyticsTags.md
 - docs/Domains.md
 - docs/EmailValidation.md
 - docs/Events.md
@@ -251,6 +264,7 @@ files:
 - lib/railgun/mailer.rb
 - lib/railgun/railtie.rb
 - mailgun.gemspec
+- spec/integration/analytics_tags_spec.rb
 - spec/integration/bounces_spec.rb
 - spec/integration/campaign_spec.rb
 - spec/integration/complaints_spec.rb
@@ -285,6 +299,7 @@ files:
 - spec/unit/messages/sample_data/unknown.type
 - spec/unit/railgun/content_type_spec.rb
 - spec/unit/railgun/mailer_spec.rb
+- vcr_cassettes/analytics_tags.yml
 - vcr_cassettes/bounces.yml
 - vcr_cassettes/complaints.yml
 - vcr_cassettes/domains.todo.yml
@@ -334,6 +349,7 @@ rubygems_version: 4.0.3
 specification_version: 4
 summary: Mailgun's Official Ruby SDK
 test_files:
+- spec/integration/analytics_tags_spec.rb
 - spec/integration/bounces_spec.rb
 - spec/integration/campaign_spec.rb
 - spec/integration/complaints_spec.rb

data/.rubocop.yml

@@ -1,8 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-Metrics/LineLength:
-  Enabled: false
-Style/EmptyLinesAroundModuleBody:
-  Enabled: false
-Style/EmptyLinesAroundClassBody:
-  Enabled: false