mailgun-ruby 1.3.9 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e49ed622ba4de1537cb0cce86e10625246d662647775395b90b8474d9a9851b
-  data.tar.gz: fa6b6dc8b656f7019b99d1d9acda02d83f2ff341ff117872489e016d5bbdacc4
+  metadata.gz: 56b457f9a512474de60aebfe220b4cb31bcfcfcc032972ce2c5a1aa0ad1322c2
+  data.tar.gz: 916852ea7483fe046b0d4c3c7883c79013b4378af43b2e6e978bf30f4dc9ef16
 SHA512:
-  metadata.gz: aaca70334ed6dfd48266275f8cb31b0e6a48897a7ab92c16212aa3d2e767963a80458375b26dcf4e2bcb0307752dce4c70332c8cbc965d983bceb17ddf8b86f3
-  data.tar.gz: c431cdf136b5cec3af1bbbd282c44ba599882f8b7e0ada6dace5db9a9584e77b7ffff78251e5681ed155233ea948af89900e4b80895ed2d2254673303f9c138c
+  metadata.gz: 7d43f29a5a245d06253ae97e44830c9768f494597506ce6ff4e87f28cc9071f12a959d0d3102f2d6f85140e5f373c2eefdd491064f804c12669618feef929594
+  data.tar.gz: 3bbd64c03a2bad22f6d0853607e3bc97358ef7c55c35b2e0420c000fe7166422319c4a0f6bc80ddec2c6ad8aa99ba7a0bb5b6cd54e023de3a0491a0774e36143

data/.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.4']
+        ruby-version: [ '2.6', '2.7', '3.0', '3.1', '3.4' ]
 
     steps:
     - uses: actions/checkout@v4
@@ -25,4 +25,4 @@ jobs:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true 
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rake spec:all

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.4.0] - 2025-09-22
+
+ - Domains - Add missing endpoints and refactor existing ones in (https://github.com/mailgun/mailgun-ruby/pull/365)
+
+## [1.3.10] - 2025-08-28
+
+ - Switch to mini_mime for memory savings in (https://github.com/mailgun/mailgun-ruby/pull/363)
+ - Add backwards compatibility for previous ruby versions in (https://github.com/mailgun/mailgun-ruby/pull/364)
+
+## [1.3.9] - 2025-07-28
+
+ - Fix messages.mime broken in (https://github.com/mailgun/mailgun-ruby/pull/361)
+ - Fix BatchMessage modifies stored test deliveries in (https://github.com/mailgun/mailgun-ruby/pull/362)
+
 ## [1.3.8] - 2025-07-23
 
 - Respond with error message for 400 Bad Request

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in mailgun.gemspec
 gemspec
 
-gem 'mime-types'
+gem 'mini_mime'
 gem 'json', '~> 2.1', platform: :mri_19

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.3.9'
+gem 'mailgun-ruby', '~>1.4.0'
 ```
 
 Usage

data/lib/mailgun/domains/domains.rb

@@ -1,10 +1,12 @@
 require 'mailgun/exceptions/exceptions'
+require 'mailgun/helpers/api_version_checker'
 
 module Mailgun
 
   # A Mailgun::Domains object is a simple CRUD interface to Mailgun Domains.
   # Uses Mailgun
   class Domains
+    include ApiVersionChecker
 
     # Public: creates a new Mailgun::Domains instance.
     #   Defaults to Mailgun::Client
@@ -12,6 +14,8 @@ module Mailgun
       @client = client
     end
 
+    # ==== Core Domains methods ====
+
     # Public: Get Domains
     #
     # limit - [Integer] Maximum number of records to return. (100 by default)
@@ -19,37 +23,13 @@ module Mailgun
     #
     # Returns [Array] A list of domains (hash)
     def list(options = {})
-      warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
       @client.get('domains', options).to_h['items']
     end
-    alias_method :get_domains, :list
-
-    # Public: Get domain information
-    #
-    # domain - [String] Domain name to lookup
-    #
-    # Returns [Hash] Information on the requested domains.
-    def info(domain)
-      warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
-      @client.get("domains/#{domain}").to_h!
-    end
-    alias_method :get, :info
-    alias_method :get_domain, :info
 
-    # Public: Verify domain, update domain records
-    #   Unknown status - this is not in the current Mailgun API
-    #   Do no rely on this being available in future releases.
-    #
-    # domain - [String] Domain name
-    #
-    # Returns [Hash] Information on the updated/verified domains
-    def verify(domain)
-      warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to verify on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/verify", nil).to_h!
+    def get_domains
+      warn('The `get_domains` method will be deprecated in future versions of Mailgun. Please use `list` instead.')
+      list
     end
-    alias_method :verify_domain, :verify
 
     # Public: Add domain
     #
@@ -64,27 +44,39 @@ module Mailgun
     #
     # Returns [Hash] of created domain
     def create(domain, options = {})
-      warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to add on Mailgun', caller) unless domain
       options = { smtp_password: nil, spam_action: 'disabled', wildcard: false }.merge(options)
       options[:name] = domain
       @client.post('domains', options).to_h
     end
-    alias_method :add, :create
-    alias_method :add_domain, :create
 
-    # Public: Delete Domain
+    def add(domain, options = {})
+      warn('The `add` method will be deprecated in future versions of Mailgun. Please use `create` instead.')
+      create(domain, options)
+    end
+
+    def add_domain(domain, options = {})
+      warn('The `add_domain` method will be deprecated in future versions of Mailgun. Please use `create` instead.')
+      create(domain, options)
+    end
+
+    # Public: Get domain information
     #
-    # domain - [String] domain name to delete (ex. domain.com)
+    # domain - [String] Domain name to lookup
     #
-    # Returns [Boolean] if successful or not
-    def remove(domain)
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to remove on Mailgun', caller) unless domain
-      @client.delete("domains/#{domain}").to_h['message'] == 'Domain has been deleted'
+    # Returns [Hash] Information on the requested domains.
+    def get(domain)
+      @client.get("domains/#{domain}").to_h!
+    end
+
+    def info(domain)
+      warn('The `info` method will be deprecated in future versions of Mailgun. Please use `get` instead.')
+      get(domain)
+    end
+
+    def get_domain(domain)
+      warn('The `get_domain` method will be deprecated in future versions of Mailgun. Please use `get` instead.')
+      get(domain)
     end
-    alias_method :delete, :remove
-    alias_method :delete_domain, :remove
 
     # Public: Update domain
     #
@@ -100,115 +92,173 @@ module Mailgun
     #
     # Returns [Hash] of updated domain
     def update(domain, options = {})
-      warn('WARN: Client api version must be v4') unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to update on Mailgun', caller) unless domain
       @client.put("domains/#{domain}", options).to_h
     end
 
-    # Public: Creates a new set of SMTP credentials for the defined domain.
+
+    # Public: Verify domain, update domain records
+    #   Unknown status - this is not in the current Mailgun API
+    #   Do no rely on this being available in future releases.
     #
-    # domain  - [String] Name of the domain (ex. domain.com)
+    # domain - [String] Domain name
+    #
+    # Returns [Hash] Information on the updated/verified domains
+    def verify(domain)
+      @client.put("domains/#{domain}/verify", nil).to_h!
+    end
+
+    def verify_domain(domain)
+      warn('The `verify_domain` method will be deprecated in future versions of Mailgun. Please use `verify` instead.')
+      verify(domain)
+    end
+
+    # Public: Delete Domain
+    #
+    # domain - [String] domain name to delete (ex. domain.com)
+    #
+    # Returns [Boolean] if successful or not
+    def remove(domain)
+      @client.delete("domains/#{domain}").to_h['message'] == 'Domain has been deleted'
+    end
+
+    def delete(domain)
+      warn('The `delete` method will be deprecated in future versions of Mailgun. Please use `remove` instead.')
+      remove(domain)
+    end
+
+    def delete_domain(domain)
+      warn('The `delete_domain` method will be deprecated in future versions of Mailgun. Please use `remove` instead.')
+      remove(domain)
+    end
+
+    # ==== End of Core Domains methods ====
+
+    # ==== Domain::Keys methods ====
+
+    # Public: List keys for all domains
+    #
+
     # options - [Hash] of
-    #   login  - [String] The user name (ex. bob.bar)
-    #   password  - [String] A password for the SMTP credentials. (Length Min 5, Max 32)
+    #   page - [String] Encoded paging information, provided via 'next', 'previous' links
+    #   limit - [Integer] Limits the number of items returned in a request
+    #   signing_domain  - [String] Filter by signing domain
+    #   selector - [String] Filter by selector
     #
     # Returns [Hash] with message key
-    def create_smtp_credentials(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to create credentials on Mailgun', caller) unless domain
-      @client.post("domains/#{domain}/credentials", options).to_h
+    def list_domain_keys(options = {})
+      @client.get("dkim/keys", options).to_h
     end
 
-    # Public: Updates the specified SMTP credentials.
+    # Public: Create a domain key
     #
-    # domain  - [String] Name of the domain (ex. domain.com)
-    # login  - [String] The user name (ex. bob.bar)
     # options - [Hash] of
-    #   password  - [String] A password for the SMTP credentials. (Length Min 5, Max 32)
+    #   signing_domain  - [String] Name of the domain (ex. domain.com)
+    #   selector - [String] Selector to be used for the new domain key
+    #   bits - [Integer] Key size, can be 1024 or 2048
+    #   pem - [String] Private key PEM
     #
     # Returns [Hash] with message key
-    def update_smtp_credentials(domain, login, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update credentials on Mailgun', caller) unless domain
-      fail(ParameterError, 'No login given to update credentials on Mailgun', caller) unless login
-      @client.put("domains/#{domain}/credentials/#{login}", options).to_h
+    def create_domain_key(options = {})
+      @client.post("dkim/keys", options).to_h
     end
 
-    # Public: Deletes the defined SMTP credentials.
+    # Public: Delete a domain key.
+    #
+    # options - [Hash] of
+    #   signing_domain - [Integer] Name of the domain (ex. domain.com)
+    #   selector - [String] Name of the selector
+    #
+    # Returns [Hash] with message key
+    def delete_domain_key(options = {})
+      @client.delete("dkim/keys", options).to_h
+    end
+
+    # Public: Activate a domain key for a specified authority and selector.
+    #
+    # domain    - [String] Name of the domain (ex. domain.com)
+    # selector  - [String] The selector you want to activate for the domain key
+    #
+    # Returns [Hash] with message key and autority + selector data
+    def activate_domain_key(domain, selector)
+      @client.put("domains/#{domain}/keys/#{selector}/activate", {}).to_h
+    end
+
+    # Public: Lists the domain keys for a specified signing domain / authority
     #
     # domain  - [String] Name of the domain (ex. domain.com)
-    # login  - [String] The user name (ex. bob.bar)
     #
-    # Returns [Hash] with message and spec keys
-    def delete_smtp_credentials(domain, login)
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to delete credentials on Mailgun', caller) unless domain
-      fail(ParameterError, 'No login given to delete credentials on Mailgun', caller) unless login
-      @client.delete("domains/#{domain}/credentials/#{login}").to_h
+    # Returns [Hash] with domain keys data
+    def get_domain_keys(domain)
+      @client.get("domains/#{domain}/keys").to_h
     end
 
-    # Public: Returns delivery connection settings for the defined domain.
+    # Public: Deactivate a domain key for a specified authority and selector
+    #
+    # domain    - [String] Name of the domain (ex. domain.com)
+    # selector  - [String] The selector you want to activate for the domain key
+    #
+    # Returns [Hash] with message key and autority + selector data
+    def deactivate_domain_key(domain, selector)
+      @client.put("domains/#{domain}/keys/#{selector}/deactivate", {}).to_h
+    end
+
+    # Public: Change the DKIM authority for a domain.
     #
     # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   self  - [Boolean] true - the domain will be the DKIM authority for itself even
+    #           if the root domain is registered on the same mailgun account
     #
-    # Returns [Hash] Information on the delivery connection settings
-    def get_domain_connection_settings(domain)
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to retrieve connections on Mailgun', caller) unless domain
-      @client.get("domains/#{domain}/connection").to_h
+    # Returns [Hash] Information on the DKIM authority
+    def update_domain_dkim_authority(domain, options = {})
+      @client.put("domains/#{domain}/dkim_authority", options).to_h
     end
 
-    # Public: Updates the specified delivery connection settings for the defined domain.d
+    # Public: Update the DKIM selector for a domains
     #
     # domain  - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
-    #   require_tls  - [Boolean] true or false. If true - requires the message only be sent over a TLS connection
-    #   skip_verification  - [Boolean] true or false. If true - the certificate and hostname will not be verified
-    #     when trying to establish a TLS connection
+    #   dkim_selector  - [String] change the DKIM selector for a domain.
     #
-    # Returns [Hash] Information on the delivery connection settings
-    def update_domain_connection_settings(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update connections on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/connection", options).to_h
+    # Returns [Hash] with message key
+    def update_domain_dkim_selector(domain, options = {})
+      @client.put("domains/#{domain}/dkim_selector", options).to_h
     end
 
+    # ==== End of Domain::Keys methods ====
+
+    # ==== Domain::Tracking methods ====
+
     # Public: Returns tracking settings for the defined domain.
     #
     # domain  - [String] Name of the domain (ex. domain.com)
     #
     # Returns [Hash] Information on the tracking settings
     def get_domain_tracking_settings(domain)
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to retrieve tracking settings on Mailgun', caller) unless domain
       @client.get("domains/#{domain}/tracking").to_h
     end
 
-    # Public: Updates the open tracking settings for a domain.
+    # Public: Updates the click tracking settings for a domain.
     #
     # domain  - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
-    #   active  - [Boolean] yes or no. If set to yes, a tracking pixel will be inserted below your HTML content.
-    #   place_at_the_top  - [Boolean] yes or no. If set to yes, tracking pixel will be moved to top of your HTML content.
+    #   active  - [Boolean] yes or no. If set to yes, links will be overwritten and pointed to our servers so we can track clicks.
     #
-    # Returns [Hash] Information on the tracking open settings
-    def update_domain_tracking_open_settings(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/tracking/open", options).to_h
+    # Returns [Hash] Information on the tracking click settings
+    def update_domain_tracking_click_settings(domain, options = {})
+      @client.put("domains/#{domain}/tracking/click", options).to_h
     end
 
-    # Public: Updates the click tracking settings for a domain.
+    # Public: Updates the open tracking settings for a domain.
     #
     # domain  - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
-    #   active  - [Boolean] yes or no. If set to yes, links will be overwritten and pointed to our servers so we can track clicks.
+    #   active  - [Boolean] yes or no. If set to yes, a tracking pixel will be inserted below your HTML content.
+    #   place_at_the_top  - [Boolean] yes or no. If set to yes, tracking pixel will be moved to top of your HTML content.
     #
-    # Returns [Hash] Information on the tracking click settings
-    def update_domain_tracking_click_settings(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/tracking/click", options).to_h
+    # Returns [Hash] Information on the tracking open settings
+    def update_domain_tracking_open_settings(domain, options = {})
+      @client.put("domains/#{domain}/tracking/open", options).to_h
     end
 
     # Public: Updates unsubscribe tracking settings for a domain.
@@ -221,114 +271,106 @@ module Mailgun
     #
     # Returns [Hash] Information on the tracking unsubscribe settings
     def update_domain_tracking_unsubscribe_settings(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
       @client.put("domains/#{domain}/tracking/unsubscribe", options).to_h
     end
 
-    # Public: Change the DKIM authority for a domain.
+    # Public: Tracking Certificate: Get certificate and status
     #
-    # domain  - [String] Name of the domain (ex. domain.com)
-    # options - [Hash] of
-    #   self  - [Boolean] true - the domain will be the DKIM authority for itself even
-    #           if the root domain is registered on the same mailgun account
+    # domain - [String] The tracking domain of the TLS certificate, formatted as web_prefix.domain_name
     #
-    # Returns [Hash] Information on the DKIM authority
-    def update_domain_dkim_authority(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/dkim_authority", options).to_h
+    # Returns [Hash] Status of certificate. Either 'expired' 'processing' 'active' or 'error'
+    def get_domain_tracking_certificate(domain)
+      @client.get("x509/#{domain}/status").to_h
     end
 
-    # Public: Update the DKIM selector for a domains
+    # Tracking Certificate: Regenerate expired certificate
     #
-    # domain  - [String] Name of the domain (ex. domain.com)
-    # options - [Hash] of
-    #   dkim_selector  - [String] change the DKIM selector for a domain.
+    # domain - [String] The tracking domain of the TLS certificate, formatted as web_prefix.domain_name
     #
-    # Returns [Hash] with message key
-    def update_domain_dkim_selector(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/dkim_selector", options).to_h
+    # Returns [Hash] A message indicating the status of the request.
+    def regenerate_domain_tracking_certificate(domain, options = {})
+      @client.put("x509/#{domain}", options).to_h
     end
 
-    # Public: Update the CNAME used for tracking opens and clicks
+    # Public: Tracking Certificate: Generate
     #
-    # domain  - [String] Name of the domain (ex. domain.com)
-    # options - [Hash] of
-    #   web_prefix  - [String] change the tracking CNAME for a domain.
+    # domain - [String] The tracking domain of the TLS certificate, formatted as web_prefix.domain_name
     #
-    # Returns [Hash] with message key
-    def update_domain_web_prefix(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      @client.put("domains/#{domain}/web_prefix", options).to_h
+    # Returns [Hash] A message indicating the status of the request.
+    def generate_domain_tracking_certificate(domain, options = {})
+      @client.post("x509/#{domain}", options).to_h
     end
 
-    # Public: Lists the domain keys for a specified signing domain / authority
+    # ==== End of Domain::Tracking methods ====
+
+
+    # ==== Domain::DKIM_Security methods ====
+
+    # Public: Tracking Certificate: Generate
     #
-    # domain  - [String] Name of the domain (ex. domain.com)
+    # domain - [String] The Domain name
+    # rotation_enabled - [Boolean] If true, enables DKIM Auto-Rotation. If false, disables it
     #
-    # Returns [Hash] with domain keys data
-    def get_domain_keys(domain)
-      fail(ParameterError, 'Client api version must be v4', caller) unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to retrieve keys on Mailgun', caller) unless domain
-      @client.get("domains/#{domain}/keys").to_h
+    # options - [Hash] of
+    #   rotation_interval - [String] The interval at which to rotate keys. Example, '5d' for five days
+    #
+    # Returns [Hash] domain object
+    def dkim_rotation(domain, rotation_enabled, options = {})
+      options = { rotation_enabled: rotation_enabled }.merge(options)
+      @client.put("dkim_management/domains/#{domain}/rotation", options)
     end
 
-    # Public: Activate a domain key for a specified authority and selector.
+    # Public: Rotate Automatic Sender Security DKIM key for a domain
     #
-    # domain    - [String] Name of the domain (ex. domain.com)
-    # selector  - [String] The selector you want to activate for the domain key
+    # domain - [String] The Domain name
     #
-    # Returns [Hash] with message key and autority + selector data
-    def activate_domain_key(domain, selector)
-      fail(ParameterError, 'Client api version must be v4', caller) unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      fail(ParameterError, 'No selector given to activate key on Mailgun', caller) unless selector
-      @client.put("domains/#{domain}/keys/#{selector}/activate", {}).to_h
+    # Returns [Hash] Response message
+    def dkim_rotate(domain)
+      @client.post("dkim_management/domains/#{domain}/rotate", {})
     end
 
-    # Public: Deactivate a domain key for a specified authority and selector
+    # ==== End of Domain::DKIM_Security methods ====
+
+    # ==== Credentials methods ====
+
+    # Public: Creates a new set of SMTP credentials for the defined domain.
     #
-    # domain    - [String] Name of the domain (ex. domain.com)
-    # selector  - [String] The selector you want to activate for the domain key
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   login  - [String] The user name (ex. bob.bar)
+    #   password  - [String] A password for the SMTP credentials. (Length Min 5, Max 32)
     #
-    # Returns [Hash] with message key and autority + selector data
-    def deactivate_domain_key(domain, selector)
-      fail(ParameterError, 'Client api version must be v4', caller) unless @client.api_version == 'v4'
-      fail(ParameterError, 'No domain given to update tracking settings on Mailgun', caller) unless domain
-      fail(ParameterError, 'No selector given to activate key on Mailgun', caller) unless selector
-      @client.put("domains/#{domain}/keys/#{selector}/deactivate", {}).to_h
+    # Returns [Hash] with message key
+    def create_smtp_credentials(domain, options = {})
+      @client.post("domains/#{domain}/credentials", options).to_h
     end
 
-    # Public: Create a domain key
+    # Public: Updates the specified SMTP credentials.
     #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # login  - [String] The user name (ex. bob.bar)
     # options - [Hash] of
-    #   signing_domain  - [String] Name of the domain (ex. domain.com)
-    #   selector - [String] Selector to be used for the new domain key
-    #   bits - [Integer] Key size, can be 1024 or 2048
-    #   pem - [String] Private key PEM
+    #   password  - [String] A password for the SMTP credentials. (Length Min 5, Max 32)
     #
     # Returns [Hash] with message key
-    def create_domain_key(options = {})
-      fail(ParameterError, 'Client api version must be v1', caller) unless @client.api_version == 'v1'
-      @client.post("dkim/keys", options).to_h
+    def update_smtp_credentials(domain, login, options = {})
+      @client.put("domains/#{domain}/credentials/#{login}", options).to_h
     end
 
-    # Public: Delete a domain key.
+    # Public: Deletes the defined SMTP credentials.
     #
-    # options - [Hash] of
-    #   signing_domain - [Integer] Name of the domain (ex. domain.com)
-    #   selector - [String] Name of the selector
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # login  - [String] The user name (ex. bob.bar)
     #
-    # Returns [Hash] with message key
-    def delete_domain_key(options = {})
-      fail(ParameterError, 'Client api version must be v1', caller) unless @client.api_version == 'v1'
-      @client.delete("dkim/keys", options).to_h
+    # Returns [Hash] with message and spec keys
+    def delete_smtp_credentials(domain, login)
+      @client.delete("domains/#{domain}/credentials/#{login}").to_h
     end
 
+    # ==== End of Credentials methods ====
+
+    # ==== Reporting::Stat methods ====
+
     # Public: Returns total stats for a given domains
     #
     # domain    - [String] Name of the domain (ex. domain.com)
@@ -341,9 +383,63 @@ module Mailgun
     #
     # Returns [Array] A list of domains (hash)
     def get_domain_stats(domain, options = {})
-      warn('WARN: Client api version must be v3') unless @client.api_version == 'v3'
       fail(ParameterError, 'No domain given to list stats on Mailgun', caller) unless domain
       @client.get("#{domain}/stats/total", options).to_h
     end
+
+    # ==== End of Reporting::Stats methods ====
+
+    # ==== Deprecated methods ====
+
+    # Public: Returns delivery connection settings for the defined domain.
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    #
+    # Returns [Hash] Information on the delivery connection settings
+    def get_domain_connection_settings(domain)
+      @client.get("domains/#{domain}/connection").to_h
+    end
+
+    # Public: Updates the specified delivery connection settings for the defined domain.d
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   require_tls  - [Boolean] true or false. If true - requires the message only be sent over a TLS connection
+    #   skip_verification  - [Boolean] true or false. If true - the certificate and hostname will not be verified
+    #     when trying to establish a TLS connection
+    #
+    # Returns [Hash] Information on the delivery connection settings
+    def update_domain_connection_settings(domain, options = {})
+      @client.put("domains/#{domain}/connection", options).to_h
+    end
+
+    # Public: Update the CNAME used for tracking opens and clicks
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #   web_prefix  - [String] change the tracking CNAME for a domain.
+    #
+    # Returns [Hash] with message key
+    def update_domain_web_prefix(domain, options = {})
+      @client.put("domains/#{domain}/web_prefix", options).to_h
+    end
+
+    # ==== End of Deprecated methods ====
+
+
+
+
+    enforces_api_version 'v1', :list_domain_keys, :create_domain_key, :delete_domain_key, :dkim_rotation,
+                         :dkim_rotate
+    enforces_api_version 'v2', :get_domain_tracking_certificate, :regenerate_domain_tracking_certificate,
+                         :generate_domain_tracking_certificate
+    enforces_api_version 'v3', :remove, :create_smtp_credentials, :update_smtp_credentials,
+                         :delete_smtp_credentials, :get_domain_connection_settings,
+                         :update_domain_connection_settings, :get_domain_tracking_settings,
+                         :update_domain_tracking_open_settings, :update_domain_tracking_click_settings,
+                         :update_domain_tracking_unsubscribe_settings, :update_domain_dkim_authority,
+                         :update_domain_dkim_selector, :update_domain_web_prefix, :get_domain_stats
+    enforces_api_version 'v4', :get_domain_keys, :activate_domain_key, :deactivate_domain_key,
+                         :list, :info, :verify, :create, :update
   end
 end

data/lib/mailgun/helpers/api_version_checker.rb

@@ -0,0 +1,41 @@
+module Mailgun
+  module ApiVersionChecker
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def requires_api_version(version, *method_names)
+        method_names.each do |method_name|
+          original_method = instance_method(method_name)
+
+          define_method(method_name) do |*args, &block|
+            warn_unless_api_version(version)
+            original_method.bind(self).call(*args, &block)
+          end
+        end
+      end
+
+      def enforces_api_version(version, *method_names)
+        method_names.each do |method_name|
+          original_method = instance_method(method_name)
+
+          define_method(method_name) do |*args, &block|
+            require_api_version(version)
+            original_method.bind(self).call(*args, &block)
+          end
+        end
+      end
+    end
+
+    private
+
+    def warn_unless_api_version(expected_version)
+      warn("WARN: Client api version must be #{expected_version}") unless @client.api_version == expected_version
+    end
+
+    def require_api_version(expected_version)
+      fail(ParameterError, "Client api version must be #{expected_version}", caller) unless @client.api_version == expected_version
+    end
+  end
+end

data/lib/mailgun/messages/message_builder.rb

@@ -1,4 +1,4 @@
-require 'mime/types'
+require 'mini_mime'
 require 'time'
 require 'faraday/multipart'
 
@@ -472,8 +472,8 @@ module Mailgun
       ) unless attachment.respond_to?(:read)
 
       if attachment.respond_to?(:path) && !attachment.respond_to?(:content_type)
-        mime_types = MIME::Types.type_for(attachment.path)
-        content_type = mime_types.empty? ? 'application/octet-stream' : mime_types[0].content_type
+        mime_types = MiniMime.lookup_by_filename(attachment.path)
+        content_type = mime_types.nil? ? 'application/octet-stream' : mime_types.content_type
         attachment.instance_eval "def content_type; '#{content_type}'; end"
       end
 

data/lib/mailgun/version.rb

@@ -1,4 +1,4 @@
 # It's the version. Yeay!
 module Mailgun
-  VERSION = '1.3.9'
+  VERSION = '1.4.0'
 end

data/mailgun.gemspec

@@ -25,18 +25,18 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.2.2'
+  spec.required_ruby_version = '>= 2.6.10'
 
   spec.add_development_dependency 'bundler', '>= 1.16.2'
   spec.add_development_dependency 'rspec', '~> 3.13.0'
-  spec.add_development_dependency 'rspec-its', '~> 2.0.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.3.1'
   spec.add_development_dependency 'rake', '~> 12.3.2'
   spec.add_development_dependency 'webmock', '~> 3.7'
   spec.add_development_dependency 'pry', '~> 0.15.2'
   spec.add_development_dependency 'vcr', '~> 3.0.3'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
   spec.add_development_dependency 'rails'
-  spec.add_dependency 'mime-types'
+  spec.add_dependency 'mini_mime'
   spec.add_dependency 'faraday', "~> 2.1"
   spec.add_dependency 'faraday-multipart', '~> 1.1.0'
 

data/spec/integration/mailgun_spec.rb

@@ -2,17 +2,13 @@ require 'spec_helper'
 require 'mailgun'
 require 'mailgun/exceptions/exceptions'
 
-vcr_opts = { :cassette_name => "instance" }
-
-describe 'Mailgun instantiation', vcr: vcr_opts do
+describe 'Mailgun instantiation', vcr: { :cassette_name => "instance" } do
   it 'instantiates an HttpClient object' do
     expect {@mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)}.not_to raise_error
   end
 end
 
-vcr_opts = { :cassette_name => "exceptions" }
-
-describe 'Client exceptions', vcr: vcr_opts do
+describe 'Client exceptions', vcr: { :cassette_name => "exceptions" } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
@@ -27,16 +23,15 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::CommunicationError => err
-      expect(err.message).to eq('the server responded with status 404: Domain not found: not-our-doma.in')
+      expect(err.message).to include('404')
+      expect(err.message).to include('Domain not found: not-our-doma.in')
     else
       fail
     end
   end
 end
 
-vcr_opts = { :cassette_name => "exceptions-invalid-api-key" }
-
-describe 'Client exceptions', vcr: vcr_opts do
+describe 'Client exceptions', vcr: { :cassette_name => "exceptions-invalid-api-key" } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
@@ -51,16 +46,15 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::Unauthorized => err
-      expect(err.message).to eq('the server responded with status 401 - Invalid Domain or API key')
+      expect(err.message).to include('401')
+      expect(err.message).to include('Invalid Domain or API key')
     else
       fail
     end
   end
 end
 
-vcr_opts = { :cassette_name => "exceptions-invalid-data" }
-
-describe 'Client exceptions', vcr: vcr_opts do
+describe 'Client exceptions', vcr: { :cassette_name => "exceptions-invalid-data" } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
@@ -75,16 +69,15 @@ describe 'Client exceptions', vcr: vcr_opts do
           :text => 'INTEGRATION TESTING'
       })
     rescue Mailgun::BadRequest => err
-      expect(err.message).to eq('the server responded with status 400: to parameter is not a valid address. please check documentation')
+      expect(err.message).to include('400')
+      expect(err.message).to include('to parameter is not a valid address. please check documentation')
     else
       fail
     end
   end
 end
 
-vcr_opts = { :cassette_name => "exceptions-not-allowed" }
-
-describe 'Client exceptions', vcr: vcr_opts do
+describe 'Client exceptions', vcr: { :cassette_name => "exceptions-not-allowed" } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'
@@ -106,9 +99,7 @@ describe 'Client exceptions', vcr: vcr_opts do
   end
 end
 
-vcr_opts = { :cassette_name => "send_message" }
-
-describe 'The method send_message()', vcr: vcr_opts do
+describe 'The method send_message()', vcr: { :cassette_name => "send_message" } do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN || 'DOMAIN.TEST'

data/vcr_cassettes/domains.yml

@@ -998,6 +998,51 @@ http_interactions:
         '
     http_version:
   recorded_at: Wed, 26 Feb 2025 21:54:43 GMT
+- request:
+    method: delete
+    uri: https://api.mailgun.net/v1/dkim/keys?params=%7B:signing_domain=%3E%22integration-test.domain.invalid%22,%20:selector=%3E%22test%22%7D
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.3.10
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic YXBpOg==
+      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:
+      - '39'
+      Content-Type:
+      - application/json
+      Date:
+      - Thu, 28 Aug 2025 12:45:35 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Www-Authenticate:
+      - Basic realm="MG API"
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"success"}
+
+        '
+    http_version:
+  recorded_at: Thu, 28 Aug 2025 12:45:35 GMT
 - request:
     method: delete
     uri: https://api.mailgun.net/v1/dkim/keys?params=%7Bsigning_domain:%20%22integration-test.domain.invalid%22,%20selector:%20%22test%22%7D
@@ -1006,11 +1051,11 @@ http_interactions:
       string: ''
     headers:
       User-Agent:
-      - mailgun-sdk-ruby/1.3.2
+      - mailgun-sdk-ruby/1.3.10
       Accept:
       - "*/*"
       Authorization:
-      - Basic xxx
+      - Basic YXBpOg==
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
   response:
@@ -1025,15 +1070,15 @@ http_interactions:
       Cache-Control:
       - no-store
       Content-Length:
-      - '58'
+      - '39'
       Content-Type:
-      - application/json; charset=utf-8
+      - application/json
       Date:
-      - Wed, 26 Feb 2025 21:57:39 GMT
+      - Thu, 28 Aug 2025 14:47:08 GMT
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
-      X-Mailgun-Key-Id:
-      - c02fd0ba-d8dbad66
+      Www-Authenticate:
+      - Basic realm="MG API"
       X-Xss-Protection:
       - 1; mode=block
     body:
@@ -1042,5 +1087,5 @@ http_interactions:
 
         '
     http_version:
-  recorded_at: Wed, 26 Feb 2025 21:57:39 GMT
+  recorded_at: Thu, 28 Aug 2025 14:47:08 GMT
 recorded_with: VCR 3.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.9
+  version: 1.4.0
 platform: ruby
 authors:
 - Mailgun
 - Travis Swientek
 bindir: bin
 cert_chain: []
-date: 2025-07-28 00:00:00.000000000 Z
+date: 2025-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mime-types
+  name: mini_mime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -217,6 +217,7 @@ files:
 - lib/mailgun/domains/domains.rb
 - lib/mailgun/events/events.rb
 - lib/mailgun/exceptions/exceptions.rb
+- lib/mailgun/helpers/api_version_checker.rb
 - lib/mailgun/lists/opt_in_handler.rb
 - lib/mailgun/logs/logs.rb
 - lib/mailgun/messages/batch_message.rb
@@ -310,7 +311,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: 2.6.10
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="