RubyGems - mailgun-ruby - Versions diffs - 1.3.1 → 1.3.2 - Mend

mailgun-ruby 1.3.1 → 1.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +27 -0
data/README.md +1 -2
data/docs/MessageBuilder.md +12 -0
data/lib/mailgun/client.rb +1 -0
data/lib/mailgun/domains/domains.rb +19 -0
data/lib/mailgun/version.rb +1 -1
data/spec/integration/routes_spec.rb +17 -1
data/vcr_cassettes/routes.yml +90 -398
metadata +3 -4
data/docs/Messages.md +0 -107

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cd509b2c1f407b43b66a9ef400bb94845be7bf358ee0516dfc64f8ef9f139b7
-  data.tar.gz: aad61052482bfb86b04ef0111a4495346d2b48cf046543c1c2fb600ca06916db
+  metadata.gz: 58558189e49961ad39adc2090139cfe44158ec4ef56386ce2af0ea1eee0fdaeb
+  data.tar.gz: 82445ca2c1f030e2721c49a0a9226ee39b655ca9864a146d95fb0db303a2e6cf
 SHA512:
-  metadata.gz: 452423c6da36c0f23ec08d3a613002027fa80c41f48c3b0a8072ccc35df1230d16512273bce584ea470dc9ba05f557e8a5a617a95efe5305e663d2de4f18b54b
-  data.tar.gz: 5b28c5065060bcff51c7711b0a4b32796fa2c79ef83251fff5a11fbd0a573c80f4d7018b289c42d9a3c273d21941ffd7fa8eee3dcd317bf7463a45fd4131899d
+  metadata.gz: d7de45e9c8f998fff873aae0c659e0c67a1cd3e59f5fcb9c28c36cbf0c5d52a798f50fc841b8b704837f9e4981dd41f55e9dc7991ada76ccbb1259aeffdcb7f9
+  data.tar.gz: 0dc6b85bcb6517f33c55ee353943e695856d99f2a6b0c7fe956f0f30ecfea3bc436ad962ba676f9780e7bf9959d748ab962f9e6d1c6e9e1a63ae1bb006092f0f

data/CHANGELOG.md CHANGED Viewed

@@ -4,6 +4,33 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
+## [1.3.2] - 2025-01-30
+### Fixed
+- Use Faraday::FlatParamsEncoder (https://github.com/mailgun/mailgun-ruby/pull/334)
+- Update Message Builder doc (https://github.com/mailgun/mailgun-ruby/pull/338)
+- Add Domain api version warnings (https://github.com/mailgun/mailgun-ruby/pull/339)
+## [1.3.1] - 2025-01-26
+### Fixed
+- Fix mock mailgun responds (https://github.com/mailgun/mailgun-ruby/pull/331)
+- Change mime-types to runtime dependency (https://github.com/mailgun/mailgun-ruby/pull/332)
+## [1.3.0] - 2025-01-26
+### Added
+- Faraday as http client (https://github.com/mailgun/mailgun-ruby/pull/330)
+### Fixed
+- Added documentation for updating webhook (https://github.com/mailgun/mailgun-ruby/pull/325)
+- Remove duplicated entry from CHANGELOG (https://github.com/mailgun/mailgun-ruby/pull/318)
+- Update template and metrics docs (https://github.com/mailgun/mailgun-ruby/pull/329)
 ## [1.2.16] - 2024-11-29
 ### Added

data/README.md CHANGED Viewed

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 ```ruby
-gem 'mailgun-ruby', '~>1.2.16'
+gem 'mailgun-ruby', '~>1.3.2'
 ```
 Usage
@@ -181,7 +181,6 @@ For usage examples on each API endpoint, head over to our official documentation
 pages. Or the [Snippets](docs/Snippets.md) file.
 This SDK includes the following components:
-- [Messages](docs/Messages.md)
 - [Message Builder](docs/MessageBuilder.md)
 - [Batch Message](docs/MessageBuilder.md#usage---batch-message)
 - [Opt-In Handler](docs/OptInHandler.md)

data/docs/MessageBuilder.md CHANGED Viewed

@@ -31,12 +31,18 @@ mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" =>
 # Define a cc recipient.
 mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"});
+# Define the reply-to address.
+mb_obj.reply_to("bob.doe@example.com", {"first" => "Bob", "last" => "Doe"});
 # Define the subject.
 mb_obj.subject("A message from the Ruby SDK using Message Builder!");
 # Define the body of the message.
 mb_obj.body_text("This is the text body of the message!");
+# Define the HTML text of the message
+mb_obj.body_html("<html><body><p>This is the text body of the message</p></body></html>");
 # Set the Message-Id header, provide a valid Message-Id.
 mb_obj.message_id("<20141014000000.11111.11111@example.com>")
@@ -63,6 +69,12 @@ mb_obj.add_inline_image "/path/to/file/header.png"
 # Schedule message in the future
 mb_obj.deliver_at("tomorrow 8:00AM PST");
+# Turn Click Tracking on
+mb_obj.track_clicks(true)
+# Turn Click Tracking off
+mb_obj.track_clicks(false)
 # Finally, send your message using the client
 result = mg_client.send_message("sending_domain.com", mb_obj)

data/lib/mailgun/client.rb CHANGED Viewed

@@ -37,6 +37,7 @@ module Mailgun
         conn.request :url_encoded
         conn.response :raise_error, include_request: true
         conn.adapter Faraday.default_adapter
+        conn.options.params_encoder = Faraday::FlatParamsEncoder
       end
       @test_mode = test_mode

data/lib/mailgun/domains/domains.rb CHANGED Viewed

@@ -19,6 +19,7 @@ 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
@@ -29,6 +30,7 @@ module Mailgun
     #
     # 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
@@ -43,6 +45,7 @@ module Mailgun
     #
     # 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!
     end
@@ -61,6 +64,7 @@ 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
@@ -75,6 +79,7 @@ module Mailgun
     #
     # 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'
     end
@@ -95,6 +100,7 @@ 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
@@ -108,6 +114,7 @@ module Mailgun
     #
     # 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
     end
@@ -121,6 +128,7 @@ module Mailgun
     #
     # 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
@@ -133,6 +141,7 @@ module Mailgun
     #
     # 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
@@ -144,6 +153,7 @@ module Mailgun
     #
     # 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
     end
@@ -158,6 +168,7 @@ module Mailgun
     #
     # 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
     end
@@ -168,6 +179,7 @@ module Mailgun
     #
     # 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
@@ -181,6 +193,7 @@ module Mailgun
     #
     # 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
     end
@@ -193,6 +206,7 @@ module Mailgun
     #
     # 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
     end
@@ -207,6 +221,7 @@ 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
@@ -220,6 +235,7 @@ module Mailgun
     #
     # 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
     end
@@ -232,6 +248,7 @@ module Mailgun
     #
     # 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
     end
@@ -244,6 +261,7 @@ module Mailgun
     #
     # 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
     end
@@ -323,6 +341,7 @@ 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

data/lib/mailgun/version.rb CHANGED Viewed

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

data/spec/integration/routes_spec.rb CHANGED Viewed

@@ -1,7 +1,7 @@
 require 'spec_helper'
 require 'mailgun'
-vcr_opts = { :cassette_name => "routes" }
+vcr_opts = { :cassette_name => "routes", :match_requests_on => [:uri, :method, :body] }
 describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
@@ -25,6 +25,22 @@ describe 'For the Routes endpoint', order: :defined, vcr: vcr_opts do
     expect(result.body["route"]["priority"]).to eq(10)
   end
+  it 'creates a route with multiple actions' do
+    result = @mg_obj.post("routes",  { priority: 10,
+                                       description: 'Integration Test Route',
+                                       expression: "match_recipient(\"#{@forward_to}\")",
+                                       action: ["forward(\"#{@recipient}\")", "stop()"] })
+    result.to_h!
+    expect(result.body["message"]).to eq("Route has been created")
+    expect(result.body["route"]["description"]).to eq("Integration Test Route")
+    expect(result.body["route"]["actions"].count).to eq 2
+    expect(result.body["route"]["actions"][0]).to include("forward(\"#{@recipient}\")")
+    expect(result.body["route"]["actions"][1]).to include("stop()")
+    expect(result.body["route"]["expression"]).to include("match_recipient(\"#{@forward_to}\")")
+    expect(result.body["route"]["priority"]).to eq(10)
+  end
   it 'gets a list of all routes.' do
     result = @mg_obj.get("routes", {:limit => 50})

data/vcr_cassettes/routes.yml CHANGED Viewed

@@ -2,375 +2,69 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/routes
-    body:
-      encoding: US-ASCII
-      string: priority=10&description=Integration%20Test%20Route&expression=match_recipient(%22alice%40DOMAIN.TEST%22)&action=forward(%22.*%40DOMAIN.TEST%22)
-    headers:
-      Accept:
-      - "*/*; q=0.5, application/xml"
-      Accept-Encoding:
-      - gzip, deflate
-      Content-Length:
-      - '213'
-      Content-Type:
-      - application/x-www-form-urlencoded
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Fri, 08 Jan 2016 20:08:18 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '402'
-      Connection:
-      - keep-alive
-      Content-Disposition:
-      - inline
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Max-Age:
-      - '600'
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Headers:
-      - Content-Type, x-requested-with
+    uri: https://api.mailgun.net/v3/routes
     body:
       encoding: UTF-8
-      string: |-
-        {
-          "message": "Route has been created",
-          "route": {
-            "actions": [
-              "forward(\".*@DOMAIN.TEST\")"
-            ],
-            "created_at": "Fri, 08 Jan 2016 20:08:18 GMT",
-            "description": "Integration Test Route",
-            "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-            "id": "5690173212573000be30671e",
-            "priority": 10
-          }
-        }
-    http_version:
-  recorded_at: Fri, 08 Jan 2016 20:08:19 GMT
-- request:
-    method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/routes?limit=50
-    body:
-      encoding: US-ASCII
-      string: ''
+      string: action=forward%28%22.%2A%40%22%29&description=Integration+Test+Route&expression=match_recipient%28%22alice%40%22%29&priority=10
     headers:
-      Accept:
-      - "*/*"
-      Accept-Encoding:
-      - gzip, deflate
       User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Fri, 08 Jan 2016 20:08:18 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '1155'
-      Connection:
-      - keep-alive
-      Content-Disposition:
-      - inline
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Max-Age:
-      - '600'
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Headers:
-      - Content-Type, x-requested-with
-    body:
-      encoding: UTF-8
-      string: |-
-        {
-          "items": [
-            {
-              "actions": [
-                "forward(\".*@DOMAIN.TEST\")"
-              ],
-              "created_at": "Fri, 08 Jan 2016 20:08:18 GMT",
-              "description": "Integration Test Route",
-              "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-              "id": "5690173212573000be30671e",
-              "priority": 10
-            },
-            {
-              "actions": [
-                "forward(\".*@DOMAIN.TEST\")"
-              ],
-              "created_at": "Fri, 08 Jan 2016 19:55:02 GMT",
-              "description": "Integration Test Route",
-              "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-              "id": "5690141612573000b69c0e35",
-              "priority": 10
-            },
-            {
-              "actions": [
-                "forward(\".*@DOMAIN.TEST\")"
-              ],
-              "created_at": "Fri, 08 Jan 2016 19:53:50 GMT",
-              "description": "Integration Test Route",
-              "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-              "id": "569013ce11e2bdcea3fbcd1d",
-              "priority": 10
-            }
-          ],
-          "total_count": 3
-        }
-    http_version:
-  recorded_at: Fri, 08 Jan 2016 20:08:19 GMT
-- request:
-    method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/routes?limit=1
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
+      - mailgun-sdk-ruby/1.3.2
       Accept:
       - "*/*"
+      Authorization:
+      - Basic xxx==
+      Content-Type:
+      - application/x-www-form-urlencoded
       Accept-Encoding:
-      - gzip, deflate
-      User-Agent:
-      - Ruby
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
   response:
     status:
       code: 200
       message: OK
     headers:
-      Server:
-      - nginx
-      Date:
-      - Fri, 08 Jan 2016 20:08:19 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '411'
-      Connection:
-      - keep-alive
-      Content-Disposition:
-      - inline
+      Access-Control-Allow-Credentials:
+      - 'true'
       Access-Control-Allow-Origin:
       - "*"
-      Access-Control-Max-Age:
-      - '600'
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Headers:
-      - Content-Type, x-requested-with
-    body:
-      encoding: UTF-8
-      string: |-
-        {
-          "items": [
-            {
-              "actions": [
-                "forward(\".*@DOMAIN.TEST\")"
-              ],
-              "created_at": "Fri, 08 Jan 2016 20:08:18 GMT",
-              "description": "Integration Test Route",
-              "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-              "id": "5690173212573000be30671e",
-              "priority": 10
-            }
-          ],
-          "total_count": 3
-        }
-    http_version:
-  recorded_at: Fri, 08 Jan 2016 20:08:19 GMT
-- request:
-    method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/routes/5690173212573000be30671e
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Accept:
-      - "*/*"
-      Accept-Encoding:
-      - gzip, deflate
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Fri, 08 Jan 2016 20:08:19 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '363'
-      Connection:
-      - keep-alive
+      Cache-Control:
+      - no-store
       Content-Disposition:
       - inline
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Max-Age:
-      - '600'
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Headers:
-      - Content-Type, x-requested-with
-    body:
-      encoding: UTF-8
-      string: |-
-        {
-          "route": {
-            "actions": [
-              "forward(\".*@DOMAIN.TEST\")"
-            ],
-            "created_at": "Fri, 08 Jan 2016 20:08:18 GMT",
-            "description": "Integration Test Route",
-            "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-            "id": "5690173212573000be30671e",
-            "priority": 10
-          }
-        }
-    http_version:
-  recorded_at: Fri, 08 Jan 2016 20:08:19 GMT
-- request:
-    method: put
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/routes/5690173212573000be30671e
-    body:
-      encoding: US-ASCII
-      string: priority=10&description=Integration%20Test%20Route%20Update&expression=match_recipient(%22alice%40DOMAIN.TEST%22)&action=forward(%22.*%40DOMAIN.TEST%22)
-    headers:
-      Accept:
-      - "*/*; q=0.5, application/xml"
-      Accept-Encoding:
-      - gzip, deflate
       Content-Length:
-      - '222'
-      Content-Type:
-      - application/x-www-form-urlencoded
-      User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Fri, 08 Jan 2016 20:08:19 GMT
+      - '251'
       Content-Type:
       - application/json
-      Content-Length:
-      - '376'
-      Connection:
-      - keep-alive
-      Content-Disposition:
-      - inline
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Max-Age:
-      - '600'
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Headers:
-      - Content-Type, x-requested-with
+      Date:
+      - Mon, 27 Jan 2025 17:45:19 GMT
+      Server:
+      - TwistedWeb/22.10.0
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - c02fd0ba-d8dbad66
+      X-Xss-Protection:
+      - 1; mode=block
     body:
       encoding: UTF-8
-      string: |-
-        {
-          "actions": [
-            "forward(\".*@DOMAIN.TEST\")"
-          ],
-          "created_at": "Fri, 08 Jan 2016 20:08:18 GMT",
-          "description": "Integration Test Route Update",
-          "expression": "match_recipient(\"alice@DOMAIN.TEST\")",
-          "id": "5690173212573000be30671e",
-          "message": "Route has been updated",
-          "priority": 10
-        }
+      string: '{"message":"Route has been created","route":{"actions":["forward(\".*@\")"],"created_at":"Mon,
+        27 Jan 2025 17:45:19 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@\")","id":"6797c62f6ee0a9fcb1ec5eee","priority":10}}
+        '
     http_version:
-  recorded_at: Fri, 08 Jan 2016 20:08:19 GMT
+  recorded_at: Mon, 27 Jan 2025 17:45:19 GMT
 - request:
-    method: delete
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/routes/5690173212573000be30671e
+    method: get
+    uri: https://api.mailgun.net/v3/routes?limit=50
     body:
       encoding: US-ASCII
       string: ''
     headers:
-      Accept:
-      - "*/*; q=0.5, application/xml"
-      Accept-Encoding:
-      - gzip, deflate
       User-Agent:
-      - Ruby
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Server:
-      - nginx
-      Date:
-      - Fri, 08 Jan 2016 20:08:19 GMT
-      Content-Type:
-      - application/json
-      Content-Length:
-      - '77'
-      Connection:
-      - keep-alive
-      Content-Disposition:
-      - inline
-      Access-Control-Allow-Origin:
-      - "*"
-      Access-Control-Max-Age:
-      - '600'
-      Access-Control-Allow-Methods:
-      - GET, POST, PUT, DELETE, OPTIONS
-      Access-Control-Allow-Headers:
-      - Content-Type, x-requested-with
-    body:
-      encoding: UTF-8
-      string: |-
-        {
-          "id": "5690173212573000be30671e",
-          "message": "Route has been deleted"
-        }
-    http_version:
-  recorded_at: Fri, 08 Jan 2016 20:08:20 GMT
-- request:
-    method: post
-    uri: https://api.mailgun.net/v3/routes
-    body:
-      encoding: UTF-8
-      string: action=forward%28%22.%2A%40DOMAIN.TEST%22%29&description=Integration+Test+Route&expression=match_recipient%28%22alice%40DOMAIN.TEST%22%29&priority=10
-    headers:
-      User-Agent:
-      - mailgun-sdk-ruby/1.3.0
+      - mailgun-sdk-ruby/1.3.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:
@@ -387,36 +81,36 @@ http_interactions:
       Content-Disposition:
       - inline
       Content-Length:
-      - '353'
+      - '234'
       Content-Type:
       - application/json
       Date:
-      - Sun, 26 Jan 2025 07:29:31 GMT
+      - Mon, 27 Jan 2025 17:45:20 GMT
       Server:
       - TwistedWeb/22.10.0
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       X-Mailgun-Key-Id:
-      - 90b59dea-f2d12a53
+      - c02fd0ba-d8dbad66
       X-Xss-Protection:
       - 1; mode=block
     body:
       encoding: UTF-8
-      string: '{"message":"Route has been created","route":{"actions":["forward(\".*@DOMAIN.TEST\")"],"created_at":"Sun,
-        26 Jan 2025 07:29:31 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@DOMAIN.TEST\")","id":"6795e45ba0be5b9e2e38da98","priority":10}}
+      string: '{"items":[{"actions":["forward(\".*@\")"],"created_at":"Mon, 27 Jan
+        2025 17:45:19 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@\")","id":"6797c62f6ee0a9fcb1ec5eee","priority":10}],"total_count":1}
         '
     http_version:
-  recorded_at: Sun, 26 Jan 2025 07:29:31 GMT
+  recorded_at: Mon, 27 Jan 2025 17:45:20 GMT
 - request:
     method: get
-    uri: https://api.mailgun.net/v3/routes?limit=50
+    uri: https://api.mailgun.net/v3/routes?limit=1
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - mailgun-sdk-ruby/1.3.0
+      - mailgun-sdk-ruby/1.3.2
       Accept:
       - "*/*"
       Authorization:
@@ -437,40 +131,36 @@ http_interactions:
       Content-Disposition:
       - inline
       Content-Length:
-      - '1398'
+      - '234'
       Content-Type:
       - application/json
       Date:
-      - Sun, 26 Jan 2025 07:29:32 GMT
+      - Mon, 27 Jan 2025 17:45:20 GMT
       Server:
       - TwistedWeb/22.10.0
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       X-Mailgun-Key-Id:
-      - 90b59dea-f2d12a53
+      - c02fd0ba-d8dbad66
       X-Xss-Protection:
       - 1; mode=block
     body:
       encoding: UTF-8
-      string: '{"items":[{"actions":[],"created_at":"Mon, 24 Jul 2023 11:28:49 GMT","description":"Sample
-        route","expression":"match_recipient(''.*@sandbox8a33e7ac5fb74b4186ba64b030e88904.mailgun.org'')","id":"64be607123bfc82c0c79c6b5","priority":0},{"actions":[],"created_at":"Mon,
-        24 Jul 2023 11:28:21 GMT","description":"Sample route","expression":"match_recipient(''.*@sandbox8a33e7ac5fb74b4186ba64b030e88904.mailgun.org'')","id":"64be60550916aca1ab9b554a","priority":0},{"actions":["forward(\".*@DOMAIN.TEST\")"],"created_at":"Sun,
-        26 Jan 2025 07:29:31 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@DOMAIN.TEST\")","id":"6795e45ba0be5b9e2e38da98","priority":10},{"actions":["forward(\".*@DOMAIN.TEST\")"],"created_at":"Sun,
-        26 Jan 2025 07:21:17 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@DOMAIN.TEST\")","id":"6795e26d5dddff0a1558835c","priority":10},{"actions":["forward(\".*@DOMAIN.TEST\")"],"created_at":"Sun,
-        26 Jan 2025 07:16:55 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@DOMAIN.TEST\")","id":"6795e167182d2aff87d9263c","priority":10}],"total_count":5}
+      string: '{"items":[{"actions":["forward(\".*@\")"],"created_at":"Mon, 27 Jan
+        2025 17:45:19 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@\")","id":"6797c62f6ee0a9fcb1ec5eee","priority":10}],"total_count":1}
         '
     http_version:
-  recorded_at: Sun, 26 Jan 2025 07:29:32 GMT
+  recorded_at: Mon, 27 Jan 2025 17:45:20 GMT
 - request:
     method: get
-    uri: https://api.mailgun.net/v3/routes?limit=1
+    uri: https://api.mailgun.net/v3/routes/6797c62f6ee0a9fcb1ec5eee
     body:
       encoding: US-ASCII
       string: ''
     headers:
       User-Agent:
-      - mailgun-sdk-ruby/1.3.0
+      - mailgun-sdk-ruby/1.3.2
       Accept:
       - "*/*"
       Authorization:
@@ -491,40 +181,42 @@ http_interactions:
       Content-Disposition:
       - inline
       Content-Length:
-      - '251'
+      - '216'
       Content-Type:
       - application/json
       Date:
-      - Sun, 26 Jan 2025 07:29:33 GMT
+      - Mon, 27 Jan 2025 17:45:21 GMT
       Server:
       - TwistedWeb/22.10.0
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       X-Mailgun-Key-Id:
-      - 90b59dea-f2d12a53
+      - c02fd0ba-d8dbad66
       X-Xss-Protection:
       - 1; mode=block
     body:
       encoding: UTF-8
-      string: '{"items":[{"actions":[],"created_at":"Mon, 24 Jul 2023 11:28:49 GMT","description":"Sample
-        route","expression":"match_recipient(''.*@sandbox8a33e7ac5fb74b4186ba64b030e88904.mailgun.org'')","id":"64be607123bfc82c0c79c6b5","priority":0}],"total_count":5}
+      string: '{"route":{"actions":["forward(\".*@\")"],"created_at":"Mon, 27 Jan
+        2025 17:45:19 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@\")","id":"6797c62f6ee0a9fcb1ec5eee","priority":10}}
         '
     http_version:
-  recorded_at: Sun, 26 Jan 2025 07:29:33 GMT
+  recorded_at: Mon, 27 Jan 2025 17:45:21 GMT
 - request:
-    method: get
-    uri: https://api.mailgun.net/v3/routes/64be607123bfc82c0c79c6b5
+    method: put
+    uri: https://api.mailgun.net/v3/routes/6797c62f6ee0a9fcb1ec5eee
     body:
-      encoding: US-ASCII
-      string: ''
+      encoding: UTF-8
+      string: action=forward%28%22.%2A%40%22%29&description=Integration+Test+Route+Update&expression=match_recipient%28%22alice%40%22%29&priority=10
     headers:
       User-Agent:
-      - mailgun-sdk-ruby/1.3.0
+      - mailgun-sdk-ruby/1.3.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:
@@ -541,42 +233,41 @@ http_interactions:
       Content-Disposition:
       - inline
       Content-Length:
-      - '233'
+      - '248'
       Content-Type:
       - application/json
       Date:
-      - Sun, 26 Jan 2025 07:29:34 GMT
+      - Mon, 27 Jan 2025 17:45:22 GMT
       Server:
       - TwistedWeb/22.10.0
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       X-Mailgun-Key-Id:
-      - 90b59dea-f2d12a53
+      - c02fd0ba-d8dbad66
       X-Xss-Protection:
       - 1; mode=block
     body:
       encoding: UTF-8
-      string: '{"route":{"actions":[],"created_at":"Mon, 24 Jul 2023 11:28:49 GMT","description":"Sample
-        route","expression":"match_recipient(''.*@sandbox8a33e7ac5fb74b4186ba64b030e88904.mailgun.org'')","id":"64be607123bfc82c0c79c6b5","priority":0}}
+      string: '{"actions":["forward(\".*@\")"],"created_at":"Mon, 27 Jan 2025 17:45:19
+        GMT","description":"Integration Test Route Update","expression":"match_recipient(\"alice@\")","id":"6797c62f6ee0a9fcb1ec5eee","message":"Route
+        has been updated","priority":10}
         '
     http_version:
-  recorded_at: Sun, 26 Jan 2025 07:29:34 GMT
+  recorded_at: Mon, 27 Jan 2025 17:45:22 GMT
 - request:
-    method: put
-    uri: https://api.mailgun.net/v3/routes/64be607123bfc82c0c79c6b5
+    method: delete
+    uri: https://api.mailgun.net/v3/routes/6797c62f6ee0a9fcb1ec5eee
     body:
-      encoding: UTF-8
-      string: action=forward%28%22.%2A%40DOMAIN.TEST%22%29&description=Integration+Test+Route+Update&expression=match_recipient%28%22alice%40DOMAIN.TEST%22%29&priority=10
+      encoding: US-ASCII
+      string: ''
     headers:
       User-Agent:
-      - mailgun-sdk-ruby/1.3.0
+      - mailgun-sdk-ruby/1.3.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:
@@ -593,41 +284,41 @@ http_interactions:
       Content-Disposition:
       - inline
       Content-Length:
-      - '350'
+      - '69'
       Content-Type:
       - application/json
       Date:
-      - Sun, 26 Jan 2025 07:29:34 GMT
+      - Mon, 27 Jan 2025 17:45:22 GMT
       Server:
       - TwistedWeb/22.10.0
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       X-Mailgun-Key-Id:
-      - 90b59dea-f2d12a53
+      - c02fd0ba-d8dbad66
       X-Xss-Protection:
       - 1; mode=block
     body:
       encoding: UTF-8
-      string: '{"actions":["forward(\".*@DOMAIN.TEST\")"],"created_at":"Mon, 24 Jul
-        2023 11:28:49 GMT","description":"Integration Test Route Update","expression":"match_recipient(\"alice@DOMAIN.TEST\")","id":"64be607123bfc82c0c79c6b5","message":"Route
-        has been updated","priority":10}
+      string: '{"id":"6797c62f6ee0a9fcb1ec5eee","message":"Route has been deleted"}
         '
     http_version:
-  recorded_at: Sun, 26 Jan 2025 07:29:35 GMT
+  recorded_at: Mon, 27 Jan 2025 17:45:23 GMT
 - request:
-    method: delete
-    uri: https://api.mailgun.net/v3/routes/64be607123bfc82c0c79c6b5
+    method: post
+    uri: https://api.mailgun.net/v3/routes
     body:
-      encoding: US-ASCII
-      string: ''
+      encoding: UTF-8
+      string: action=forward%28%22.%2A%40%22%29&action=stop%28%29&description=Integration+Test+Route&expression=match_recipient%28%22alice%40%22%29&priority=10
     headers:
       User-Agent:
-      - mailgun-sdk-ruby/1.3.0
+      - mailgun-sdk-ruby/1.3.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:
@@ -644,24 +335,25 @@ http_interactions:
       Content-Disposition:
       - inline
       Content-Length:
-      - '69'
+      - '260'
       Content-Type:
       - application/json
       Date:
-      - Sun, 26 Jan 2025 07:29:35 GMT
+      - Mon, 27 Jan 2025 18:13:42 GMT
       Server:
       - TwistedWeb/22.10.0
       Strict-Transport-Security:
       - max-age=63072000; includeSubDomains
       X-Mailgun-Key-Id:
-      - 90b59dea-f2d12a53
+      - c02fd0ba-d8dbad66
       X-Xss-Protection:
       - 1; mode=block
     body:
       encoding: UTF-8
-      string: '{"id":"64be607123bfc82c0c79c6b5","message":"Route has been deleted"}
+      string: '{"message":"Route has been created","route":{"actions":["forward(\".*@\")","stop()"],"created_at":"Mon,
+        27 Jan 2025 18:13:42 GMT","description":"Integration Test Route","expression":"match_recipient(\"alice@\")","id":"6797ccd69440716211d9df05","priority":10}}
         '
     http_version:
-  recorded_at: Sun, 26 Jan 2025 07:29:35 GMT
+  recorded_at: Mon, 27 Jan 2025 18:13:42 GMT
 recorded_with: VCR 3.0.3

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,7 +171,6 @@ files:
 - docs/EmailValidation.md
 - docs/Events.md
 - docs/MessageBuilder.md
-- docs/Messages.md
 - docs/Metrics.md
 - docs/OptInHandler.md
 - docs/Snippets.md
@@ -288,7 +287,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Mailgun's Official Ruby SDK

data/docs/Messages.md DELETED Viewed

@@ -1,107 +0,0 @@
-Mailgun - Messages
-====================
-This is the Mailgun Ruby *Message* utilities.
-The below assumes you've already installed the Mailgun Ruby SDK in to your
-project. If not, go back to the master README for instructions.
-There are two utilities included, Message Builder and Batch Message.
-Message Builder: Allows you to build a message object by calling methods for
-each MIME attribute.
-Batch Message: Inherits Message Builder and allows you to iterate through
-recipients from a list. Messages will fire after the 1,000th recipient has been
-added.
-Usage - Message Builder
------------------------
-Here's how to use Message Builder to build your Message.
-```ruby
-# First, instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new("your-api-key")
-mb_obj = Mailgun::MessageBuilder.new
-# Define the from address.
-mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"})
-# Define a to recipient.
-mb_obj.add_recipient(:to, "john.doe@example.com", {"first" => "John", "last" => "Doe"})
-# Define a cc recipient.
-mb_obj.add_recipient(:cc, "sally.doe@example.com", {"first" => "Sally", "last" => "Doe"})
-# Define the subject.
-mb_obj.set_subject("A message from the Ruby SDK using Message Builder!")
-# Define the body of the message.
-mb_obj.set_text_body("This is the text body of the message!")
-# Define the HTML text of the message
-mb_obj.set_html_body("<html><body><p>This is the text body of the message</p></body></html>")
-# Set the Message-Id header. Pass in a valid Message-Id.
-mb_obj.set_message_id("<20141014000000.11111.11111@example.com>")
-# Clear the Message-Id header. Pass in nil or empty string.
-mb_obj.set_message_id(nil)
-mb_obj.set_message_id('')
-# Other Optional Parameters.
-mb_obj.add_campaign_id("My-Awesome-Campaign")
-mb_obj.header("Customer-Id", "12345")
-mb_obj.add_attachment("./tron.jpg")
-mb_obj.set_delivery_time("tomorrow 8:00AM PST")
-mb_obj.set_click_tracking(true)
-# Send your message through the client
-mg_client.send_message("sending_domain.com", mb_obj)
-```
-Usage - Batch Message
----------------------
-Here's how to use Batch Message to easily handle batch sending jobs.
-```ruby
-# First, instantiate the Mailgun Client with your API key
-mg_client = Mailgun::Client.new("your-api-key")
-mb_obj = Mailgun::BatchMessage.new(mg_client, "example.com")
-# Define the from address.
-mb_obj.set_from_address("me@example.com", {"first"=>"Ruby", "last" => "SDK"})
-# Define the subject.
-mb_obj.set_subject("A message from the Ruby SDK using Message Builder!")
-# Define the body of the message.
-mb_obj.set_text_body("Hello %recipient.first%,
-                     This is the text body of the message
-                     using recipient variables!
-                     If you need to include custom data,
-                     you could do it like this: %recipient.account-id%.")
-mb_obj.add_recipient(:to, "john.doe@example.com", {"first"      => "John",
-                                                   "last"       => "Doe",
-                                                   "account-id" => 1234})
-mb_obj.add_recipient(:to, "jane.doe@example.com", {"first"      => "Jane",
-                                                   "last"       => "Doe",
-                                                   "account-id" => 5678})
-mb_obj.add_recipient(:to, "bob.doe@example.com", {"first"       => "Bob",
-                                                  "last"        => "Doe",
-                                                  "account-id"  => 91011})
-...
-mb_obj.add_recipient(:to, "sally.doe@example.com", {"first"      => "Sally",
-                                                    "last"       => "Doe",
-                                                    "account-id" => 121314})
-# Send your message through the client
-message_ids = mb_obj.finalize
-```
-More Documentation
-------------------
-See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/api-sending.html)
-for more information.