mailgun-ruby 1.2.15 → 1.3.5

data/vcr_cassettes/unsubscribes.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
     body:
       encoding: US-ASCII
       string: address=integration-test-email%40DOMAIN.TEST&tag=*
@@ -48,11 +48,11 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Address
         has been added to the unsubscribes table"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 18:55:05 GMT
 - request:
     method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/unsubscribes/integration-test-email@DOMAIN.TEST
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes/integration-test-email@DOMAIN.TEST
     body:
       encoding: US-ASCII
       string: ''
@@ -94,11 +94,11 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"integration-test-email@DOMAIN.TEST","tags":["*"],"created_at":"Fri,
         08 Jan 2016 18:55:04 UTC"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 18:55:05 GMT
 - request:
     method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
     body:
       encoding: US-ASCII
       string: ''
@@ -140,11 +140,11 @@ http_interactions:
       encoding: UTF-8
       string: '{"items":[{"address":"integration-test-email@DOMAIN.TEST","tags":["*"],"created_at":"Fri,
         08 Jan 2016 18:55:04 UTC"}],"paging":{"first":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?limit=100","last":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?page=last\u0026limit=100","next":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?page=next\u0026address=integration-test-email%40DOMAIN.TEST\u0026limit=100","previous":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?page=previous\u0026address=integration-test-email%40DOMAIN.TEST\u0026limit=100"}}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 18:55:28 GMT
 - request:
     method: delete
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/unsubscribes/integration-test-email@DOMAIN.TEST
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes/integration-test-email@DOMAIN.TEST
     body:
       encoding: US-ASCII
       string: ''
@@ -186,6 +186,216 @@ http_interactions:
       encoding: UTF-8
       string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Unsubscribe
         event has been removed"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 18:55:28 GMT
-recorded_with: VCR 3.0.1
+- request:
+    method: post
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
+    body:
+      encoding: UTF-8
+      string: address=integration-test-email%40DOMAIN.TEST&tag=%2A
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.3.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx==
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '150'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 26 Jan 2025 07:29:46 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - 90b59dea-f2d12a53
+      X-Request-Limit:
+      - '2500'
+      X-Request-Remaining:
+      - '2484'
+      X-Request-Reset:
+      - '1737876591950'
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Address
+        has been added to the unsubscribes table"}
+
+        '
+    http_version:
+  recorded_at: Sun, 26 Jan 2025 07:29:46 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes/integration-test-email@DOMAIN.TEST
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.3.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx==
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '147'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 26 Jan 2025 07:29:46 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - 90b59dea-f2d12a53
+      X-Request-Limit:
+      - '2500'
+      X-Request-Remaining:
+      - '2483'
+      X-Request-Reset:
+      - '1737876591950'
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"address":"integration-test-email@DOMAIN.TEST","tags":["*"],"created_at":"Sun,
+        26 Jan 2025 07:29:46 UTC"}
+
+        '
+    http_version:
+  recorded_at: Sun, 26 Jan 2025 07:29:47 GMT
+- request:
+    method: get
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.3.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx==
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '847'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 26 Jan 2025 07:29:47 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - 90b59dea-f2d12a53
+      X-Request-Limit:
+      - '2500'
+      X-Request-Remaining:
+      - '2482'
+      X-Request-Reset:
+      - '1737876591950'
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"items":[{"address":"integration-test-email@DOMAIN.TEST","tags":["*"],"created_at":"Sun,
+        26 Jan 2025 07:29:46 UTC"}],"paging":{"first":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?limit=100&term=","last":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?page=last&limit=100&term=","next":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?page=next&address=integration-test-email%40DOMAIN.TEST&limit=100&term=","previous":"https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes?page=previous&address=integration-test-email%40DOMAIN.TEST&limit=100&term="}}
+
+        '
+    http_version:
+  recorded_at: Sun, 26 Jan 2025 07:29:47 GMT
+- request:
+    method: delete
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/unsubscribes/integration-test-email@DOMAIN.TEST
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - mailgun-sdk-ruby/1.3.0
+      Accept:
+      - "*/*"
+      Authorization:
+      - Basic xxx==
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '136'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 26 Jan 2025 07:29:48 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Mailgun-Key-Id:
+      - 90b59dea-f2d12a53
+      X-Request-Limit:
+      - '2500'
+      X-Request-Remaining:
+      - '2481'
+      X-Request-Reset:
+      - '1737876591950'
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Unsubscribe
+        event has been removed"}
+
+        '
+    http_version:
+  recorded_at: Sun, 26 Jan 2025 07:29:48 GMT
+recorded_with: VCR 3.0.3

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.15
+  version: 1.3.5
 platform: ruby
 authors:
 - Mailgun
 - Travis Swientek
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 0.15.2
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -124,19 +137,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: Mailgun's Official Ruby SDK for interacting with the Mailgun API.
 email: support@mailgunhq.com
 executables: []
@@ -157,16 +198,16 @@ files:
 - docs/EmailValidation.md
 - docs/Events.md
 - docs/MessageBuilder.md
-- docs/Messages.md
+- docs/Metrics.md
 - docs/OptInHandler.md
 - docs/Snippets.md
 - docs/Subaccounts.md
 - docs/Suppressions.md
+- docs/Templates.md
 - docs/Webhooks.md
 - docs/railgun/EmailValidation.md
 - docs/railgun/Overview.md
 - docs/railgun/Parameters.md
-- docs/railgun/Templates.md
 - lib/mailgun-ruby.rb
 - lib/mailgun.rb
 - lib/mailgun/address.rb
@@ -178,6 +219,7 @@ files:
 - lib/mailgun/lists/opt_in_handler.rb
 - lib/mailgun/messages/batch_message.rb
 - lib/mailgun/messages/message_builder.rb
+- lib/mailgun/metrics/metrics.rb
 - lib/mailgun/response.rb
 - lib/mailgun/subaccounts/subaccounts.rb
 - lib/mailgun/suppressions.rb
@@ -203,6 +245,7 @@ files:
 - spec/integration/mailer_spec.rb
 - spec/integration/mailgun_spec.rb
 - spec/integration/messages/sample_data/mime.txt
+- spec/integration/metrics_spec.rb
 - spec/integration/routes_spec.rb
 - spec/integration/stats_spec.rb
 - spec/integration/subaccounts_spec.rb
@@ -240,6 +283,7 @@ files:
 - vcr_cassettes/mailing_list.todo.yml
 - vcr_cassettes/mailing_list.yml
 - vcr_cassettes/message_deliver.yml
+- vcr_cassettes/metrics.yml
 - vcr_cassettes/routes.yml
 - vcr_cassettes/send_message.yml
 - vcr_cassettes/stats.yml
@@ -255,7 +299,6 @@ licenses:
 metadata:
   documentation_uri: https://documentation.mailgun.com/
   source_code_uri: https://github.com/mailgun/mailgun-ruby
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -270,8 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Mailgun's Official Ruby SDK
 test_files:
@@ -286,6 +328,7 @@ test_files:
 - spec/integration/mailer_spec.rb
 - spec/integration/mailgun_spec.rb
 - spec/integration/messages/sample_data/mime.txt
+- spec/integration/metrics_spec.rb
 - spec/integration/routes_spec.rb
 - spec/integration/stats_spec.rb
 - spec/integration/subaccounts_spec.rb

data/docs/Messages.md

@@ -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.