mailgun-ruby 1.3.10 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3824447d13539969e56a4f92c0758acaa3ed8d83107d32400158e86cef25ca7b
-  data.tar.gz: efb48ecdc22f5beeff51484a2e5453797cd7d8f66c3913009d9e614cb37ecb91
+  metadata.gz: 0f7b6ece85b0a809a90ea79e6836b55bc5a97cfe8cd036c1567acff92b8053c5
+  data.tar.gz: 277f0def30a104f86beef2c8ef3012b877fa94e35e415a9beff328cc76247280
 SHA512:
-  metadata.gz: 32bf21cc891b61b3afb61f89648d3f000068d81c0edd0b2a9b928b0ce748a9224fa3ce86a28eeabb73247f1762a689fc93b957dfaa85f8f3b976a5bb070eddd5
-  data.tar.gz: b74850e669c2b90b8e7433a390a7a69aa0db9b9ae73758cc743a72040137f629246bbd11cf29234273d13ae833392c3890047601532689756201ad702dd3ae84
+  metadata.gz: 3a419c6c2c8fbb7efa2ed08ad51da87441befe54e00e3a70db6626b82f353932827c5ebdd933f32edfe06ba043ea2dcba99cacd93a445f078ff089ad58af96ea
+  data.tar.gz: c910105de443193207c67c5afaa24b2d423dfb7b7e995466a95b8192d967f244f36e45142d78f97a46fb893809a633e793d75366ea206f83338b8f138a4ed3af

data/.github/workflows/ci.yml

@@ -11,14 +11,13 @@ permissions:
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [ '2.6', '2.7', '3.0', '3.1', '3.4' ]
+        ruby-version: [ '3.0', '3.1', '3.2', '3.3', '3.4', '4.0' ]
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/CHANGELOG.md

@@ -2,10 +2,19 @@
 
 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 by @alex-leb in (https://github.com/mailgun/mailgun-ruby/pull/361)
- - Fix BatchMessage modifies stored test deliveries by @alex-leb in (https://github.com/mailgun/mailgun-ruby/pull/362)
+ - 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
 

data/README.md

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

data/docs/Domains.md

@@ -9,49 +9,102 @@ all calls except credentials.
 
 Usage - Domains
 -----------------------
-
+First, instantiate the Mailgun Client with your API key
 ```ruby
-# First, instantiate the Mailgun Client with your API key
 mg_client = Mailgun::Client.new('your-api-key')
 domainer = Mailgun::Domains.new(mg_client)
+```
+
+Core Domain methods:
 
+```ruby
 # Get a list of current domains.
 domainer.list
 
-# View details of a domain
-domainer.info 'my.perfect.domain'
-
 # Add a new domain
 domainer.create 'my.new.moreness'
 # or with options
 domainer.create 'my.new.moreness', { some: 'options' }
 
-# Remove a domain
-domainer.remove 'this.one.is.not.needed.'
+# View details of a domain
+domainer.get 'my.perfect.domain'
 
 # Update a domain
 domainer.update 'my.new.moreness', { some: 'options' }
+
+# Verify a domain
+domainer.verify 'my.perfect.domain'
+
+# Remove a domain
+domainer.remove 'this.one.is.not.needed.'
+
+
 ```
 
-Suppressions for a Domain
--------------------------
+Domain Keys methods:
+
+```ruby
+# List keys for all domains
+domainer.list_domain_keys { some: 'options' }
+
+# Create a domain key
+domainer.create_domain_key { some: 'options' }
+
+# Delete a domain key
+domainer.delete_domain_key { some: 'options' }
+
+# Activate a domain key
+domainer.activate_domain_key 'my.perfect.domain', 'selector'
+
+# List domain keys
+domainer.get_domain_keys 'my.perfect.domain'
+
+# Deactivate a domain key
+domainer.deactivate_domain_key 'my.perfect.domain', 'selector'
 
-You can manage domain suppressions (bounces, unsubscribes, complaints) using the
-[`Mailgun::Suppressions`](/docs/Suppressions.md) client:
+# Update DKIM authority
+domainer.update_domain_dkim_authority 'my.perfect.domain', { some: 'options' }
+
+# Update a DKIM selector
+domainer.update_domain_dkim_selector 'my.perfect.domain', { some: 'options' }
+```
+
+Domain Tracking methods:
 
 ```ruby
-# Instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new('your-api-key')
-supp_client = mg_client.suppressions('example.org')
+# Get tracking settings
+domainer.get_domain_tracking_settings 'my.perfect.domain'
 
-# ...
+# Update click tracking settings
+domainer.update_domain_tracking_click_settings 'my.perfect.domain', { some: 'options' }
+
+# Update open tracking settings
+domainer.update_domain_tracking_open_settings 'my.perfect.domain', { some: 'options' }
+
+# Update unsubscribe tracking settings
+domainer.update_domain_tracking_unsubscribe_settings  'my.perfect.domain', { some: 'options' }
+
+# Tracking Certificate: Get certificate and status
+domainer.get_domain_tracking_certificate 'my.perfect.domain'
+
+# Tracking Certificate: Regenerate expired certificate
+domainer.regenerate_domain_tracking_certificate 'my.perfect.domain', { some: 'options' }
+
+# Tracking Certificate: Generate
+domainer.generate_domain_tracking_certificate 'my.perfect.domain', { some: 'options' }
 ```
 
-See the [Suppressions](/docs/Suppressions.md) for usage samples and
-[suppressions.rb](/lib/mailgun/suppressions.rb) for suppressions client API.
+DKIM Security methods:
+
+```ruby
+# Update Automatic Sender Security DKIM key rotation for a domain
+domainer.dkim_rotation 'my.perfect.domain', true, { some: 'options' }
 
+# Rotate Automatic Sender Security DKIM key for a domain
+domainer.dkim_rotate 'my.perfect.domain'
+```
 
 More Documentation
 ------------------
-See the official [Mailgun Domain Docs](https://documentation.mailgun.com/en/latest/api-domains.html)
+See the official [Mailgun Domain Docs](https://documentation.mailgun.com/docs/mailgun/api-reference/send/mailgun/domains)
 for more information

data/docs/MessageBuilder.md

@@ -50,7 +50,7 @@ mb_obj.message_id("<20141014000000.11111.11111@example.com>")
 mb_obj.message_id(nil)
 mb_obj.message_id('')
 
-# Set the Message-tags at most 3.
+# Set the Message-tags at most 10.
 mb_obj.add_tag("You can track mails as tag-units!")
 
 # Campaigns and headers.

data/lib/mailgun/address.rb

@@ -1,5 +1,3 @@
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
 
   # Mailgun::Address is a simple interface to the Email Validation API.

data/lib/mailgun/client.rb

@@ -1,7 +1,3 @@
-require 'mailgun/chains'
-require 'mailgun/suppressions'
-require 'mailgun/exceptions/exceptions'
-
 module Mailgun
   # A Mailgun::Client object is used to communicate with the Mailgun API. It is a
   # wrapper around Faraday so you don't have to worry about the HTTP aspect
@@ -15,7 +11,7 @@ module Mailgun
                    api_host = Mailgun.api_host || 'api.mailgun.net',
                    api_version = Mailgun.api_version  || 'v3',
                    ssl = true,
-                   test_mode = false,
+                   test_mode = !!Mailgun.test_mode,
                    timeout = nil,
                    proxy_url = Mailgun.proxy_url)
 
@@ -32,14 +28,7 @@ module Mailgun
       }
       request_options.merge!(request: {timeout: timeout}) if timeout
 
-      @http_client =  Faraday.new(request_options) do |conn|
-        conn.request :multipart
-        conn.request :authorization, :basic, 'api', api_key
-        conn.request :url_encoded
-        conn.response :raise_error, include_request: true
-        conn.adapter Faraday.default_adapter
-        conn.options.params_encoder = Faraday::FlatParamsEncoder
-      end
+      @http_client = build_http_client(api_key, request_options)
 
       @test_mode = test_mode
       @api_version = api_version
@@ -173,8 +162,16 @@ module Mailgun
     # @param [Hash] data This should be a standard Hash
     # containing required parameters for the requested resource.
     # @return [Mailgun::Response] A Mailgun::Response object.
-    def put(resource_path, data)
-      response = @http_client.put(resource_path, data)
+    def put(resource_path, params, body_params = false)
+      response =
+        if body_params
+          @http_client.put(resource_path) do |request|
+            request['Content-Type'] = 'application/json'
+            request.params = params.to_json
+          end
+        else
+          @http_client.put(resource_path, params)
+        end
       Response.new(response)
     rescue => err
       raise communication_error err
@@ -185,12 +182,19 @@ module Mailgun
     # @param [String] resource_path This is the API resource you wish to interact
     # with. Be sure to include your domain, where necessary.
     # @return [Mailgun::Response] A Mailgun::Response object.
-    def delete(resource_path, params = nil)
-      if params
-        response = @http_client.delete(resource_path, params: params)
-      else
-        response = @http_client.delete(resource_path)
-      end
+    def delete(resource_path, params = nil, body_params = false)
+      response =
+        if params
+          if body_params
+            @http_client.delete(resource_path) do |request|
+              request.body = params.to_json
+            end
+          else
+            @http_client.delete(resource_path, params: params)
+          end
+        else
+          @http_client.delete(resource_path)
+        end
       Response.new(response)
     rescue => err
       raise communication_error err
@@ -262,5 +266,16 @@ module Mailgun
         working_domain
       ) if message.fetch('from', []).empty? && message.fetch(:from, []).empty?
     end
+
+    def build_http_client(api_key, request_options)
+      Faraday.new(request_options) do |conn|
+        conn.request :multipart
+        conn.request :authorization, :basic, 'api', api_key
+        conn.request :url_encoded
+        conn.response :raise_error, include_request: true
+        conn.adapter Faraday.default_adapter
+        conn.options.params_encoder = Faraday::FlatParamsEncoder
+      end
+    end
   end
 end