mailgun-ruby 1.4.5 → 1.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 330cf1e1b42d9cfeb06505375a0467c462b8d8270ba9c1156b5793063aba4d22
-  data.tar.gz: ee750bf59f4e0c1ba63d73aa0cd08b68e7f837f4f0ff84acba81c078a190bef4
+  metadata.gz: b32ba39f8e6d20a75cc9e870057edaf087efd9fabfcf0f73c5c30c389ff4c879
+  data.tar.gz: fb73166343d70aa79ec9dcaf4df73f2389abac47eedf63fcdcee8d62a7d5547c
 SHA512:
-  metadata.gz: 68d52c33e4703cc5b63ba256a7aef53b66cd9838477957b913c35741810fda047c1deb7ee33d381e48a717b5f1eae5184f2b871afb4d9ce03956e92ded7d3bd1
-  data.tar.gz: d78b0ea0f67ebb0413f197702673b33788c3a81a29120eb323bf95a52af59d0fb3e9ff5b4db46af0e7fb547859bca2c0958e14da827b97dab2bbf2e3b43d9078
+  metadata.gz: 3ac8f9977486740e5c4770d3e12c68be15bb47a7195d7681a09cf57f9cca8d0f13f278d29a908feea605f16581ed7145ea120289fee8cbd80c5c1b3ccc1bbc1b
+  data.tar.gz: 7d9ae8fd11a0db5c1e6a1b4a0d7ab0f15bcf98cae2ddf82940227cf4666498e8f0c03ebcadefa1803fc40738f0a1bf9a52586c9159bb538ad0671feed5d50293

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [v1.4.6](https://github.com/mailgun/mailgun-ruby/tree/v1.4.6) (2026-10-20)
+
+[Full Changelog](https://github.com/mailgun/mailgun-ruby/compare/v1.4.5...v1.4.6)
+
+**Merged pull requests:**
+
+- Deprecations - Warn on Domains\#get\_domain\_stats and use one warning format [\#405](https://github.com/mailgun/mailgun-ruby/pull/405) ([alex-leb](https://github.com/alex-leb))
+- ApiVersionChecker - Allow declarations before the methods [\#404](https://github.com/mailgun/mailgun-ruby/pull/404) ([alex-leb](https://github.com/alex-leb))
+- Specs - Scrub X-Mailgun-Key-Id from VCR cassettes [\#403](https://github.com/mailgun/mailgun-ruby/pull/403) ([alex-leb](https://github.com/alex-leb))
+- Routes - Add Mailgun::Routes wrapper [\#402](https://github.com/mailgun/mailgun-ruby/pull/402) ([alex-leb](https://github.com/alex-leb))
+- Mailing Lists - Add Mailgun::MailingLists wrapper [\#401](https://github.com/mailgun/mailgun-ruby/pull/401) ([alex-leb](https://github.com/alex-leb))
+- CI: skip the coverage check on fork PRs, don't fail fast [\#400](https://github.com/mailgun/mailgun-ruby/pull/400) ([alex-leb](https://github.com/alex-leb))
+- Various improvements [\#387](https://github.com/mailgun/mailgun-ruby/pull/387) ([n-rodriguez](https://github.com/n-rodriguez))
+
 ## [v1.4.5](https://github.com/mailgun/mailgun-ruby/tree/v1.4.5) (2026-09-29)
 
 [Full Changelog](https://github.com/mailgun/mailgun-ruby/compare/v1.4.4...v1.4.5)
@@ -7,15 +21,17 @@
 **Closed issues:**
 
 - Testmode not correctly initialized from global setting [\#394](https://github.com/mailgun/mailgun-ruby/issues/394)
+- Unable to make use of Postbin [\#337](https://github.com/mailgun/mailgun-ruby/issues/337)
+-  events abstraction issues [\#319](https://github.com/mailgun/mailgun-ruby/issues/319)
 
 **Merged pull requests:**
 
 - DE-10765: Client - Fix global test\_mode enabled when set to false [\#399](https://github.com/mailgun/mailgun-ruby/pull/399) ([alex-leb](https://github.com/alex-leb))
 - DE-1856: API Keys - Add docs and list filters [\#398](https://github.com/mailgun/mailgun-ruby/pull/398) ([alex-leb](https://github.com/alex-leb))
 - DE-1772: Domain Webhooks - Add v4 create, update and remove endpoints [\#397](https://github.com/mailgun/mailgun-ruby/pull/397) ([alex-leb](https://github.com/alex-leb))
-- fix\(webhooks\): re-introduce url parameter [\#393](https://github.com/mailgun/mailgun-ruby/pull/393) ([markokajzer](https://github.com/markokajzer))
 - DE-1786: Add github-changelog-generator gem [\#396](https://github.com/mailgun/mailgun-ruby/pull/396) ([alex-leb](https://github.com/alex-leb))
 - DE-1854: Add ApiKeys support [\#395](https://github.com/mailgun/mailgun-ruby/pull/395) ([alex-leb](https://github.com/alex-leb))
+- fix\(webhooks\): re-introduce url parameter [\#393](https://github.com/mailgun/mailgun-ruby/pull/393) ([markokajzer](https://github.com/markokajzer))
 
 ## [v1.4.4](https://github.com/mailgun/mailgun-ruby/tree/v1.4.4) (2026-05-26)
 

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.4.5'
+gem 'mailgun-ruby', '~>1.4.6'
 ```
 
 Usage
@@ -184,6 +184,8 @@ This SDK includes the following components:
 - [Message Builder](docs/MessageBuilder.md)
 - [Batch Message](docs/MessageBuilder.md#usage---batch-message)
 - [Opt-In Handler](docs/OptInHandler.md)
+- [Mailing Lists](docs/MailingLists.md)
+- [Routes](docs/Routes.md)
 - [Domains](docs/Domains.md)
 - [Webhooks](docs/Webhooks.md)
 - [Account Webhooks](docs/AccountWebhooks.md)

data/lib/mailgun/api_keys/api_keys.rb

@@ -6,6 +6,8 @@ module Mailgun
   class ApiKeys
     include ApiVersionChecker
 
+    enforces_api_version 'v1', :list, :create, :remove, :regenerate
+
     # Public creates a new Mailgun::ApiKeys instance.
     #   Defaults to Mailgun::Client
     def initialize(client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v1'))
@@ -59,7 +61,5 @@ module Mailgun
       res = @client.post('keys/public', {})
       res.to_h['key']
     end
-
-    enforces_api_version 'v1', :list, :create, :remove, :regenerate
   end
 end

data/lib/mailgun/client.rb

@@ -27,7 +27,7 @@ module Mailgun
           'Accept' => '*/*'
         }
       }
-      request_options.merge!(request: { timeout: timeout }) if timeout
+      request_options[:request] = { timeout: timeout } if timeout
 
       @http_client = build_http_client(api_key, request_options)
 

data/lib/mailgun/domains/domain_keys.rb

@@ -6,6 +6,11 @@ module Mailgun
   class DomainKeys
     include ApiVersionChecker
 
+    enforces_api_version 'v1', :list_domain_keys, :create_domain_key, :delete_domain_key
+    enforces_api_version 'v3', :update_domain_dkim_authority, :update_domain_dkim_selector
+    enforces_api_version 'v4', :activate_domain_key, :deactivate_domain_key
+    enforces_api_version 'v4', :get_domain_keys
+
     def initialize(client = Mailgun::Client.new)
       @client = client
     end
@@ -98,10 +103,5 @@ module Mailgun
     def update_domain_dkim_selector(domain, options = {})
       @client.put("domains/#{domain}/dkim_selector", options).to_h
     end
-
-    enforces_api_version 'v1', :list_domain_keys, :create_domain_key, :delete_domain_key
-    enforces_api_version 'v3', :update_domain_dkim_authority, :update_domain_dkim_selector
-    enforces_api_version 'v4', :activate_domain_key, :deactivate_domain_key
-    enforces_api_version 'v4', :get_domain_keys
   end
 end

data/lib/mailgun/domains/domains.rb

@@ -6,6 +6,15 @@ module Mailgun
   class Domains
     include ApiVersionChecker
 
+    enforces_api_version 'v1', :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_tracking_settings,
+                         :update_domain_tracking_open_settings, :update_domain_tracking_click_settings,
+                         :update_domain_tracking_unsubscribe_settings, :get_domain_stats
+    enforces_api_version 'v4', :list, :verify, :create, :update
+
     # Public: creates a new Mailgun::Domains instance.
     #   Defaults to Mailgun::Client
     def initialize(client = Mailgun::Client.new)
@@ -234,6 +243,7 @@ module Mailgun
     # ==== Reporting::Stat methods ====
 
     # Public: Returns total stats for a given domains
+    # Deprecated: the Stats API is deprecated in favor of the Metrics API. Use Mailgun::Metrics#account_metrics instead.
     #
     # domain    - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
@@ -245,20 +255,13 @@ module Mailgun
     #
     # Returns [Array] A list of domains (hash)
     def get_domain_stats(domain, options = {})
+      Deprecation.warn('Mailgun::Domains#get_domain_stats', 'Mailgun::Metrics#account_metrics',
+                       reason: 'Mailgun deprecated the Stats API')
       raise(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 ====
-
-    enforces_api_version 'v1', :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_tracking_settings,
-                         :update_domain_tracking_open_settings, :update_domain_tracking_click_settings,
-                         :update_domain_tracking_unsubscribe_settings, :get_domain_stats
-    enforces_api_version 'v4', :list, :verify, :create, :update
   end
 end

data/lib/mailgun/events/events.rb

@@ -75,7 +75,7 @@ module Mailgun
     #
     # Returns a Mailgun.Response object.
     def get_events(params = {}, paging = nil)
-      warn('WARN: This API is deprecated in favor of our Logs API')
+      Deprecation.warn('Mailgun::Events', 'Mailgun::Logs#account_logs', reason: 'Mailgun deprecated the Events API')
       response = @client.get(construct_url(paging), params)
       extract_paging(response)
       response

data/lib/mailgun/helpers/api_version_checker.rb

@@ -6,25 +6,36 @@ module Mailgun
       base.extend(ClassMethods)
     end
 
+    # Both declarations can be placed before or after the methods they name.
     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, **kwargs, &block|
-            warn_unless_api_version(version)
-            original_method.bind(self).call(*args, **kwargs, &block)
-          end
-        end
+        wrap_with_api_version_check(method_names) { warn_unless_api_version(version) }
       end
 
       def enforces_api_version(version, *method_names)
-        method_names.each do |method_name|
-          original_method = instance_method(method_name)
+        wrap_with_api_version_check(method_names) { require_api_version(version) }
+      end
 
+      private
+
+      def wrap_with_api_version_check(method_names, &check)
+        prepend(Check.new(method_names, &check))
+      end
+    end
+
+    # The module a declaration prepends. Its methods run the check and then the class's
+    # own method through super, so the class methods don't have to exist yet.
+    class Check < Module
+      # The methods this check wraps
+      attr_reader :method_names
+
+      def initialize(method_names, &check)
+        super(&nil) # keep Module#initialize from running the check block as module code
+        @method_names = method_names
+        method_names.each do |method_name|
           define_method(method_name) do |*args, **kwargs, &block|
-            require_api_version(version)
-            original_method.bind(self).call(*args, **kwargs, &block)
+            instance_exec(&check)
+            super(*args, **kwargs, &block)
           end
         end
       end

data/lib/mailgun/helpers/deprecation.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Mailgun
+  # Prints the gem's deprecation warnings in one format, e.g.
+  #
+  #   app/jobs/report.rb:12: warning: DEPRECATION: "Mailgun::Tags#get_tag" is deprecated
+  #   (Mailgun deprecated the Tags API) and will be removed in mailgun-ruby 1.5.
+  #   Please use "Mailgun::AnalyticsTags#list" instead.
+  #
+  # The location is the first caller outside the gem, so it points at the code to change.
+  module Deprecation
+    GEM_LIB_DIR = "#{File.expand_path('../..', __dir__)}/".freeze
+
+    # Public: Warn that a method or class is deprecated
+    #
+    # name        - [String] The deprecated method or class, e.g. "Mailgun::Tags#get_tag"
+    # replacement - [String] What to use instead, e.g. "Mailgun::AnalyticsTags#list"
+    # reason      - [String] Why, when Mailgun deprecated the API it calls (optional)
+    # removal     - [String] When it will be removed, e.g. "mailgun-ruby 1.5" (optional)
+    #
+    # Returns nil
+    def self.warn(name, replacement, reason: nil, removal: nil)
+      message = "DEPRECATION: \"#{name}\" is deprecated"
+      message += " (#{reason})" if reason
+      message += " and will be removed in #{removal}" if removal
+      message += ". Please use \"#{replacement}\" instead."
+
+      location = caller_locations.find { |loc| !(loc.absolute_path || loc.path).to_s.start_with?(GEM_LIB_DIR) }
+      Kernel.warn(location ? "#{location.path}:#{location.lineno}: warning: #{message}" : message)
+    end
+  end
+end

data/lib/mailgun/lists/mailing_lists.rb

@@ -0,0 +1,250 @@
+# frozen_string_literal: true
+
+module Mailgun
+  # A Mailgun::MailingLists object is a simple CRUD interface to Mailgun Mailing Lists
+  # and their members.
+  # Uses Mailgun
+  class MailingLists
+    include ApiVersionChecker
+
+    enforces_api_version 'v3', :list, :list_pages, :create, :get, :update, :remove,
+                         :list_members, :list_members_pages, :get_member, :create_member,
+                         :update_member, :remove_member, :create_members, :import_members
+
+    # Public: creates a new Mailgun::MailingLists instance.
+    # Defaults to Mailgun::Client
+    def initialize(client = Mailgun::Client.new)
+      @client = client
+    end
+
+    # Lists
+
+    # Public: Get mailing lists
+    #
+    # options - [Hash] of
+    #   limit   - [Integer] Maximum number of records to return. (100 by default)
+    #   skip    - [Integer] Number of records to skip. (0 by default)
+    #   address - [String] Return only the list with this address
+    #
+    # Returns [Array] A list of mailing lists (hash)
+    def list(options = {})
+      @client.get('lists', options).to_h['items']
+    end
+
+    # Public: Get mailing lists by page
+    #
+    # options - [Hash] of
+    #   limit   - [Integer] Maximum number of records to return. (100 by default)
+    #   page    - [String] Page to retrieve: first, last, next or prev
+    #   address - [String] Pivot list address the page starts from
+    #
+    # Returns [Hash] with the mailing lists in 'items' and page URLs in 'paging'
+    def list_pages(options = {})
+      @client.get('lists/pages', options).to_h
+    end
+
+    # Public: Create a mailing list
+    #
+    # address - [String] Email address of the list, e.g. developers@mg.example.com
+    # options - [Hash] of
+    #   name             - [String] List name
+    #   description      - [String] List description
+    #   access_level     - [String] Who can post: readonly, members or everyone. Defaults to readonly
+    #   reply_preference - [String] Where replies go: list or sender. Defaults to list
+    #
+    # Returns [Hash] of the created list
+    def create(address, options = {})
+      require_address!(address, 'No address given to create the mailing list')
+
+      @client.post('lists', options.merge(address: address)).to_h
+    end
+
+    # Public: Get a mailing list
+    #
+    # address - [String] Email address of the list
+    #
+    # Returns [Hash] Information on the requested list
+    def get(address)
+      require_address!(address, 'No address given to find the mailing list')
+
+      @client.get("lists/#{escape(address)}").to_h!
+    end
+
+    # Public: Update a mailing list
+    #
+    # address - [String] Email address of the list
+    # options - [Hash] of
+    #   address          - [String] New email address of the list
+    #   name             - [String] List name
+    #   description      - [String] List description
+    #   access_level     - [String] Who can post: readonly, members or everyone
+    #   reply_preference - [String] Where replies go: list or sender
+    #
+    # Returns [Hash] of the updated list
+    def update(address, options = {})
+      require_address!(address, 'No address given to update the mailing list')
+
+      @client.put("lists/#{escape(address)}", options).to_h
+    end
+
+    # Public: Delete a mailing list and all of its members
+    #
+    # address - [String] Email address of the list
+    #
+    # Returns [Boolean] if successful or not
+    def remove(address)
+      require_address!(address, 'No address given to remove the mailing list')
+
+      @client.delete("lists/#{escape(address)}").status == 200
+    end
+
+    # Members
+
+    # Public: Get the members of a mailing list
+    #
+    # list_address - [String] Email address of the list
+    # options - [Hash] of
+    #   subscribed - [Boolean] Return only subscribed (true) or unsubscribed (false) members
+    #   limit      - [Integer] Maximum number of records to return. (100 by default)
+    #   skip       - [Integer] Number of records to skip. (0 by default)
+    #   address    - [String] Return only the member with this address
+    #
+    # Returns [Array] A list of members (hash)
+    def list_members(list_address, options = {})
+      require_address!(list_address, 'No list address given to list members of')
+
+      @client.get("lists/#{escape(list_address)}/members", options).to_h['items']
+    end
+
+    # Public: Get the members of a mailing list by page
+    #
+    # list_address - [String] Email address of the list
+    # options - [Hash] of
+    #   subscribed - [Boolean] Return only subscribed (true) or unsubscribed (false) members
+    #   limit      - [Integer] Maximum number of records to return. (100 by default)
+    #   page       - [String] Page to retrieve: first, last, next or prev
+    #   address    - [String] Pivot member address the page starts from
+    #
+    # Returns [Hash] with the members in 'items' and page URLs in 'paging'
+    def list_members_pages(list_address, options = {})
+      require_address!(list_address, 'No list address given to list members of')
+
+      @client.get("lists/#{escape(list_address)}/members/pages", options).to_h
+    end
+
+    # Public: Get a mailing list member
+    #
+    # list_address   - [String] Email address of the list
+    # member_address - [String] Email address of the member
+    #
+    # Returns [Hash] Information on the requested member
+    def get_member(list_address, member_address)
+      require_address!(list_address, 'No list address given to find the member on')
+      require_address!(member_address, 'No member address given to find')
+
+      @client.get("lists/#{escape(list_address)}/members/#{escape(member_address)}").to_h!
+    end
+
+    # Public: Add a member to a mailing list
+    #
+    # list_address   - [String] Email address of the list
+    # member_address - [String] Email address of the member
+    # options - [Hash] of
+    #   name       - [String] Member name
+    #   vars       - [Hash, String] Custom member variables, a Hash or a JSON string
+    #   subscribed - [Boolean] Whether the member is subscribed. Defaults to true
+    #   upsert     - [Boolean] Update the member if it already exists instead of failing. Defaults to false
+    #
+    # Returns [Hash] of the created member
+    def create_member(list_address, member_address, options = {})
+      require_address!(list_address, 'No list address given to add the member to')
+      require_address!(member_address, 'No member address given to add')
+
+      @client.post("lists/#{escape(list_address)}/members",
+                   encode_vars(options).merge(address: member_address)).to_h
+    end
+
+    # Public: Update a mailing list member
+    #
+    # list_address   - [String] Email address of the list
+    # member_address - [String] Email address of the member
+    # options - [Hash] of
+    #   address    - [String] New email address of the member
+    #   name       - [String] Member name
+    #   vars       - [Hash, String] Custom member variables, a Hash or a JSON string
+    #   subscribed - [Boolean] Whether the member is subscribed
+    #
+    # Returns [Hash] of the updated member
+    def update_member(list_address, member_address, options = {})
+      require_address!(list_address, 'No list address given to update the member on')
+      require_address!(member_address, 'No member address given to update')
+
+      @client.put("lists/#{escape(list_address)}/members/#{escape(member_address)}", encode_vars(options)).to_h
+    end
+
+    # Public: Remove a member from a mailing list
+    #
+    # list_address   - [String] Email address of the list
+    # member_address - [String] Email address of the member
+    #
+    # Returns [Boolean] if successful or not
+    def remove_member(list_address, member_address)
+      require_address!(list_address, 'No list address given to remove the member from')
+      require_address!(member_address, 'No member address given to remove')
+
+      @client.delete("lists/#{escape(list_address)}/members/#{escape(member_address)}").status == 200
+    end
+
+    # Public: Add up to 1,000 members to a mailing list in one call
+    #
+    # list_address - [String] Email address of the list
+    # members      - [Array, String] Members as an Array of addresses or member hashes
+    #                (address, name, vars, subscribed), or a JSON string of the same
+    # options - [Hash] of
+    #   upsert - [Boolean] Update members that already exist instead of failing. Defaults to false
+    #
+    # Returns [Hash] with the list and a confirmation message
+    def create_members(list_address, members, options = {})
+      require_address!(list_address, 'No list address given to add members to')
+      raise(ParameterError, 'No members given to add', caller) if members.nil? || members.empty?
+
+      members = members.to_json unless members.is_a?(String)
+      @client.post("lists/#{escape(list_address)}/members.json", options.merge(members: members)).to_h
+    end
+
+    # Public: Add up to 1,000 members to a mailing list from a CSV file
+    #
+    # list_address - [String] Email address of the list
+    # csv          - [String, IO] Path to the CSV file, or an IO with its contents
+    # options - [Hash] of
+    #   subscribed - [Boolean] Subscription status for members without one in the file
+    #   upsert     - [Boolean] Update members that already exist instead of failing. Defaults to false
+    #
+    # Returns [Hash] with the list and a confirmation message
+    def import_members(list_address, csv, options = {})
+      require_address!(list_address, 'No list address given to import members to')
+      raise(ParameterError, 'No CSV file given to import members from', caller) if csv.nil? || csv == ''
+
+      file = Faraday::Multipart::FilePart.new(csv, 'text/csv', csv.is_a?(String) ? File.basename(csv) : 'members.csv')
+      @client.post("lists/#{escape(list_address)}/members.csv", options.merge(members: file)).to_h
+    end
+
+    private
+
+    def require_address!(address, message)
+      raise(ParameterError, message, caller) if address.nil? || address.to_s.empty?
+    end
+
+    # Percent-encodes the characters an email address may contain that would break a URL path,
+    # keeping '@' and '+' as they are.
+    def escape(address)
+      address.to_s.gsub(%r{[%/?#\s]}) { |char| format('%%%02X', char.ord) }
+    end
+
+    def encode_vars(options)
+      return options unless options[:vars].is_a?(Hash)
+
+      options.merge(vars: options[:vars].to_json)
+    end
+  end
+end

data/lib/mailgun/messages/message_builder.rb

@@ -30,7 +30,7 @@ module Mailgun
     # @return [void]
     def add_recipient(recipient_type, address, variables = nil)
       if recipient_type == 'h:reply-to'
-        warn 'DEPRECATION: "add_recipient("h:reply-to", ...)" is deprecated. Please use "reply_to" instead.'
+        warn_deprecated('add_recipient("h:reply-to", ...)', :reply_to)
         return reply_to(address, variables)
       end
 
@@ -56,7 +56,7 @@ module Mailgun
 
     # Deprecated: please use 'from' instead.
     def set_from_address(address, variables = nil)
-      warn 'DEPRECATION: "set_from_address" is deprecated. Please use "from" instead.'
+      warn_deprecated(__method__, :from)
       from(address, variables)
     end
 
@@ -83,7 +83,7 @@ module Mailgun
 
     # Deprecated: Please use "subject" instead.
     def set_subject(subj = nil)
-      warn 'DEPRECATION: "set_subject" is deprecated. Please use "subject" instead.'
+      warn_deprecated(__method__, :subject)
       subject(subj)
     end
 
@@ -97,7 +97,7 @@ module Mailgun
 
     # Deprecated: Please use "body_text" instead.
     def set_text_body(text_body = nil)
-      warn 'DEPRECATION: "set_text_body" is deprecated. Please use "body_text" instead.'
+      warn_deprecated(__method__, :body_text)
       body_text(text_body)
     end
 
@@ -111,7 +111,7 @@ module Mailgun
 
     # Deprecated: Please use "body_html" instead.
     def set_html_body(html_body = nil)
-      warn 'DEPRECATION: "set_html_body" is deprecated. Please use "body_html" instead.'
+      warn_deprecated(__method__, :body_html)
       body_html(html_body)
     end
 
@@ -243,7 +243,7 @@ module Mailgun
 
     # Deprecated: 'set_custom_data' is deprecated. Please use 'header' instead.
     def set_custom_data(name, data)
-      warn 'DEPRECATION: "set_custom_data" is deprecated. Please use "header" instead.'
+      warn_deprecated(__method__, :header)
       header name, data
     end
 
@@ -292,7 +292,7 @@ module Mailgun
 
     # Deprecated: 'set_message_id' is deprecated. Use 'message_id' instead.
     def set_message_id(data = nil)
-      warn 'DEPRECATION: "set_message_id" is deprecated. Please use "message_id" instead.'
+      warn_deprecated(__method__, :message_id)
       message_id data
     end
 
@@ -464,5 +464,15 @@ module Mailgun
       end
       add_faraday_attachment(disposition, attachment, filename)
     end
+
+    # Warns that a MessageBuilder method is deprecated.
+    #
+    # @param [String|Symbol] method_name The deprecated method.
+    # @param [Symbol] replacement The method to use instead.
+    # @return [void]
+    def warn_deprecated(method_name, replacement)
+      Deprecation.warn("Mailgun::MessageBuilder##{method_name}", "Mailgun::MessageBuilder##{replacement}",
+                       removal: 'a future version of mailgun-ruby')
+    end
   end
 end

data/lib/mailgun/response.rb

@@ -65,7 +65,7 @@ module Mailgun
     #
     # @return [Boolean] A boolean that binarizes the response status result.
     def success?
-      (200..299).include?(status)
+      (200..299).cover?(status)
     end
   end
 end