mailgun-ruby 1.1.9 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a161608ec972823219220afcff04f3f8ddf959190ab747a03983ebe108ccaba5
-  data.tar.gz: 21f81c2a51f0b4e2c18f7ad309cd884561cb60120787d3cbe7140962d5fc717a
+  metadata.gz: 63fbab3c08481c2364ca4fef89def410a12672507954764103e900bb0f081858
+  data.tar.gz: e2fed301bb806d720b6e7f9f8707d415756ed92f5b841592ebc100eb53a71d74
 SHA512:
-  metadata.gz: d24993f138c611967f0cf77498fedb464858e93afddb7d6e7e1288ca5351aee6902bd7bb4c449a738f55a775f1fd1849aec91323145a068e64b0bca79ca6db1e
-  data.tar.gz: ea24ee662ee9c4dd91f5b73609cc4ae884c692a4876dfd96c30e4b1fdd18c213d37088db96936d3aba493e5eecf5fad66a73d1eb53fcee9831bfeeca4f6fefa0
+  metadata.gz: 69ad70a850bdb1cbc859647509315b118aa7508747c8af281eeb7ec4514156f1416aa16b4d0e10e07fa168adc705ba110d20b28aae3137b26c454cdf9115b191
+  data.tar.gz: e5f30539ca1dfd25ab6bd489c7544febd7b54ae00b407c3378e9ecd3c7166efd961d76f73943e931015436880eab72b607cea5629bf26fda811cbfec1dc1e787

data/.ruby-env.yml.example

@@ -10,3 +10,4 @@
 MAILGUN_APIKEY : '<MAILGUN_APIKEY>'
 MAILGUN_PUB_APIKEY : '<MAILGUN_PUBLIC_APIKEY>'
 MAILGUN_TESTDOMAIN : '<MAILGUN_SANDBOX_DOMAIN>'
+

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 sudo: false
 rvm:
-- 2.0.0
-- 2.1
-- 2.2
-- 2.3.1
+- 2.2.2
+- 2.2.10
+- 2.3.7
+- 2.4.4
+- 2.5.1
 script:
 - bundle install
 - bundle exec rake spec
@@ -17,7 +18,7 @@ deploy:
   gemspec: mailgun.gemspec
   on:
     tags: true
-    condition: "$TRAVIS_RUBY_VERSION == 2.3.1"
+    condition: "$TRAVIS_RUBY_VERSION == 2.5.1"
 notifications:
   slack:
     rooms:

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [1.2.13] - 2023-11-25
+
+### Added
+
+- Subaccounts API support (https://github.com/mailgun/mailgun-ruby/pull/300).
+
+### Fixed
+
+- transform_for_mailgun block iteration issue (https://github.com/mailgun/mailgun-ruby/pull/298).
+- Typos in several files (https://github.com/mailgun/mailgun-ruby/pull/297).

data/Gemfile

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

data/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.1.6'
+gem 'mailgun-ruby', '~>1.2.12'
 ```
 
 Usage
@@ -27,7 +27,7 @@ Usage
 Here's how to send a message using the library:
 
 ```ruby
-require 'mailgun'
+require 'mailgun-ruby'
 
 # First, instantiate the Mailgun Client with your API key
 mg_client = Mailgun::Client.new 'your-api-key'
@@ -56,6 +56,12 @@ domain = 'example.com'
 result = mg_client.get("#{domain}/events", {:event => 'delivered'})
 ```
 
+If you're using the EU domains, make sure you specify it when creating the client:
+
+```
+mg_client = Mailgun::Client.new 'your-api-key', 'api.eu.mailgun.net'
+```
+
 Rails
 -----
 
@@ -74,9 +80,26 @@ and replace `api-myapikey` and `mydomain.com` with your secret API key and domai
   config.action_mailer.mailgun_settings = {
     api_key: 'api-myapikey',
     domain: 'mydomain.com',
+    # api_host: 'api.eu.mailgun.net'  # Uncomment this line for EU region domains
+    # timeout: 20 # Default depends on rest-client, whose default is 60s. Added in 1.2.3.
   }
 ```
 
+To specify Mailgun options such as campaign or tags:
+```ruby
+class UserMailer < ApplicationMailer
+  def welcome_email
+    mail(to: params[:to], subject: "Welcome!").tap do |message|
+      message.mailgun_options = {
+        "tag" => ["abtest-option-a", "beta-user"],
+        "tracking-opens" => true,
+        "tracking-clicks" => "htmlonly"
+      }
+    end
+  end
+end
+```
+
 To get the Mailgun `message_id` after ActionMailer has successfully delivered the email:
 
 ```ruby
@@ -160,12 +183,16 @@ 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)
+- [Batch Message](docs/MessageBuilder.md#usage---batch-message)
 - [Opt-In Handler](docs/OptInHandler.md)
 - [Domains](docs/Domains.md)
 - [Webhooks](docs/Webhooks.md)
 - [Events](docs/Events.md)
+- [Snippets](docs/Snippets.md)
+- [Subaccounts](docs/Subaccounts.md)
 - [Suppressions](docs/Suppressions.md)
+- [Templates](docs/Templates.md)
+- [EmailValidation](docs/EmailValidation.md)
 
 Message Builder allows you to quickly create the array of parameters, required
 to send a message, by calling a methods for each parameter.

data/docs/Domains.md

@@ -28,6 +28,9 @@ domainer.create 'my.new.moreness', { some: 'options' }
 
 # Remove a domain
 domainer.remove 'this.one.is.not.needed.'
+
+# Update a domain
+domainer.update 'my.new.moreness', { some: 'options' }
 ```
 
 Suppressions for a Domain

data/docs/EmailValidation.md

@@ -0,0 +1,34 @@
+Mailgun - Email Validation
+====================
+
+This is the Mailgun Ruby *Email Validation* 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.
+
+Usage - Email Validation
+-----------------------
+
+```ruby
+# First, instantiate the Mailgun Address. It pulls api key for Client from Mailgun.api_key variable.
+email_validator = Mailgun::Address.new
+
+# Given an arbitrary address, validates address based off defined checks.
+# Response Example:
+# {
+#     "address": "existingemail@realdomain.com",
+#     "is_disposable_address": false,
+#     "is_role_address": false,
+#     "reason": [],
+#     "result": "deliverable",
+#     "risk": "low"
+# }
+email_validator.validate('email@example.com')
+
+
+```
+
+More Documentation
+------------------
+See the official [Mailgun Email Validation Docs](https://documentation.mailgun.com/en/latest/api-email-validation.html)
+for more information

data/docs/OptInHandler.md

@@ -100,4 +100,4 @@ Available Functions
 
 More Documentation
 ------------------
-See the official [Mailgun Docs](https://documentation.mailgun.com/api-sending.html) for more information.
+See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/api-sending.html) for more information.

data/docs/Snippets.md

@@ -110,7 +110,7 @@ bm_obj.set_text_body "This is the text body."
 bm_obj.add_recipient :to, "a_user@example.com"
 
 # All message IDs returned in finalize method return
-message_ids = @bm_obj.finalize
+message_ids = bm_obj.finalize
 ```
 
 ### Domains:
@@ -118,57 +118,57 @@ ____________________________________________________
 **Get a list of all domains:**
 
 ```ruby
-result = @mg_client.get "domains", {:limit => 5, :skip => 0}
+result = mg_client.get "domains", {:limit => 5, :skip => 0}
 ```
 
 **Get a single domain:**
 
 ```ruby
-result = @mg_client.get "domains/#{domain}"
+result = mg_client.get "domains/#{domain}"
 ```
 
 **Add a domain:**
 
 ```ruby
-result = @mg_client.post "domains", {:name => 'anothersample.mailgun.org',
+result = mg_client.post "domains", {:name => 'anothersample.mailgun.org',
                                      :smtp_password => 'super_secret',
                                      :spam_action => 'tag'}
 ```
 **Delete a Domain: **
 
 ```ruby
-result = @mg_client.delete "domains/#{domain}"
+result = mg_client.delete "domains/#{domain}"
 ```
 ### Unsubscribes:
 ____________________________________________________
 **Get List of Unsubscribes: **
 
 ```ruby
-result = @mg_client.get "#{domain}/unsubscribes", {:limit => 50, :skip => 10}
+result = mg_client.get "#{domain}/unsubscribes", {:limit => 50, :skip => 10}
 ```
 
 **Get Single Unsubscribe: **
 
 ```ruby
-result = @mg_client.get "#{domain}/unsubscribes/#{email_address}"
+result = mg_client.get "#{domain}/unsubscribes/#{email_address}"
 ```
 
 **Unsubscribe a Recipient: **
 
 ```ruby
-result = @mg_client.post "#{domain}/unsubscribes", {:address => 'bob@example.com', :tag => 'mypromotion'}
+result = mg_client.post "#{domain}/unsubscribes", {:address => 'bob@example.com', :tag => 'mypromotion'}
 ```
 
 **Unsubscribe from all messages for a domain: **
 
 ```ruby
-result = @mg_client.post "#{domain}/unsubscribes", {:address => 'bob@example.com', :tag => '*'}
+result = mg_client.post "#{domain}/unsubscribes", {:address => 'bob@example.com', :tag => '*'}
 ```
 
 **Remove an unsubscribe: **
 
 ```ruby
-result = @mg_client.delete "#{domain}/unsubscribes/#{email_address}"
+result = mg_client.delete "#{domain}/unsubscribes/#{email_address}"
 ```
 
 ### Complaints:
@@ -176,24 +176,24 @@ ____________________________________________________
 **Get List of Complaints: **
 
 ```ruby
-result = @mg_client.get "#{domain}/complaints", {:limit => 50, :skip => 10}
+result = mg_client.get "#{domain}/complaints", {:limit => 50, :skip => 10}
 ```
 
 **Get a Single Complaint: **
 
 ```ruby
-result = @mg_client.get "#{domain}/complaints/#{email_address}"
+result = mg_client.get "#{domain}/complaints/#{email_address}"
 ```
 **Create a complaint: **
 
 ```ruby
-result = @mg_client.post "#{domain}/complaint", {:address => 'bob@example.com'}
+result = mg_client.post "#{domain}/complaint", {:address => 'bob@example.com'}
 ```
 
 **Remove a complaint: **
 
 ```ruby
-result = @mg_client.delete "#{domain}/complaint/#{email_address}"
+result = mg_client.delete "#{domain}/complaint/#{email_address}"
 ```
 
 ### Bounces:
@@ -201,19 +201,19 @@ ____________________________________________________
 **Get List of Bounces: **
 
 ```ruby
-result = @mg_client.get "#{domain}/bounces", {:limit => 50, :skip => 10}
+result = mg_client.get "#{domain}/bounces", {:limit => 50, :skip => 10}
 ```
 
 **Get a Single Bounce Event: **
 
 ```ruby
-result = @mg_client.get "#{domain}/bounces/#{email_address}"
+result = mg_client.get "#{domain}/bounces/#{email_address}"
 ```
 
 **Create a Bounce: **
 
 ```ruby
-result = @mg_client.post "#{domain}/bounces", {:address => 'bob@example.com',
+result = mg_client.post "#{domain}/bounces", {:address => 'bob@example.com',
                                                :code => 550,
                                                :error => 'Mailbox does not exist.'}
 ```
@@ -221,7 +221,7 @@ result = @mg_client.post "#{domain}/bounces", {:address => 'bob@example.com',
 **Remove a Bounced Address: **
 
 ```ruby
-result = @mg_client.delete "#{domain}/bounces/#{email_address}"
+result = mg_client.delete "#{domain}/bounces/#{email_address}"
 ```
 
 ### Statistics:
@@ -229,7 +229,7 @@ ____________________________________________________
 **Get Statistics: **
 
 ```ruby
-result = @mg_client.get "#{domain}/stats", {:limit => 50,
+result = mg_client.get "#{domain}/stats", {:limit => 50,
                                             :skip => 10,
                                             :event => 'sent',
                                             "start-date" => 'Mon, 13 Feb 2015 00:00:00 GMT'}
@@ -238,14 +238,14 @@ result = @mg_client.get "#{domain}/stats", {:limit => 50,
 **Remove a Tag: **
 
 ```ruby
-result = @mg_client.delete "#{domain}/tags/#{tag}"
+result = mg_client.delete "#{domain}/tags/#{tag}"
 ```
 ### Events:
 ____________________________________________________
 **Get Event: **
 
 ```ruby
-result = @mg_client.get "#{domain}/events", {:event => 'rejected'}
+result = mg_client.get "#{domain}/events", {:event => 'rejected'}
 ```
 
 ### Routes:
@@ -253,18 +253,18 @@ ____________________________________________________
 **Get List of Routes: **
 
 ```ruby
-result = @mg_client.get "routes", {:limit => 50, :skip => 10}
+result = mg_client.get "routes", {:limit => 50, :skip => 10}
 ```
 
 **Get a Single Route by ID: **
 
 ```ruby
-result = @mg_client.get "routes/#{route_id}"
+result = mg_client.get "routes/#{route_id}"
 ```
 **Create a Route: **
 
 ```ruby
-result = @mg_client.post "routes",  {:priority => 10,
+result = mg_client.post "routes",  {:priority => 10,
                                      :description => 'This is a test route',
                                      :expression => 'match_recipient(".*@gmail.com")',
                                      :action => 'forward("alice@example.com")'}
@@ -272,7 +272,7 @@ result = @mg_client.post "routes",  {:priority => 10,
 **Update a Route: **
 
 ```ruby
-result = @mg_client.put "routes/#{route_id}",  {:priority => 10,
+result = mg_client.put "routes/#{route_id}",  {:priority => 10,
                                                 :description => 'This is a test route',
                                                 :expression => 'match_recipient(".*@gmail.com")',
                                                 :action => 'forward("alice@example.com")'}
@@ -280,46 +280,46 @@ result = @mg_client.put "routes/#{route_id}",  {:priority => 10,
 **Remove a Route: **
 
 ```ruby
-result = @mg_client.delete "routes/#{route_id}"
+result = mg_client.delete "routes/#{route_id}"
 ```
 ### Campaigns:
 ____________________________________________________
 **Get List of Campaigns: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns", {:limit => 50, :skip => 10}
+result = mg_client.get "#{domain}/campaigns", {:limit => 50, :skip => 10}
 ```
 
 **Get a Single Campaign: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}"
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}"
 ```
 
 **Create a Campaign: **
 
 ```ruby
-result = @mg_client.post "#{domain}/campaigns", {:name => 'My Campaign',
+result = mg_client.post "#{domain}/campaigns", {:name => 'My Campaign',
                                                  :id => 'campaign_123_2014'}
 ```
 
 **Update a Campaign: **
 
 ```ruby
-result = @mg_client.put "#{domain}/campaigns/#{campaign_id}", {:name => 'My Campaign',
+result = mg_client.put "#{domain}/campaigns/#{campaign_id}", {:name => 'My Campaign',
                                                                :id => 'campaign_123_2014'}
 ```
 
 **Remove a Campaign: **
 
 ```ruby
-result = @mg_client.delete "#{domain}/campaigns/#{campaign_id}"
+result = mg_client.delete "#{domain}/campaigns/#{campaign_id}"
 ```
 
 **Get Campaign Events: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/events", {:event => 'clicked',
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}/events", {:event => 'clicked',
                                                                       :recipient => 'test@example.com',
                                                                       :country => 'US',
                                                                       :region => 'TX',
@@ -331,13 +331,13 @@ result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/events", {:event =>
 **Get a Single Campaign's Stats: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/stats", {:groupby => 'domain'}
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}/stats", {:groupby => 'domain'}
 ```
 
 **Get a Single Campaign's Click Stats: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/clicks", {:groupby => 'hour',
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}/clicks", {:groupby => 'hour',
                                                                       :country => 'US',
                                                                       :region => 'TX',
                                                                       :city => 'Austin',
@@ -349,7 +349,7 @@ result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/clicks", {:groupby =
 **Get a Single Campaign's Click Opens: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/opens", {:groupby => 'hour',
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}/opens", {:groupby => 'hour',
                                                                      :country => 'US',
                                                                      :region => 'TX',
                                                                      :city => 'Austin',
@@ -361,7 +361,7 @@ result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/opens", {:groupby =>
 **Get a Single Campaign's Click Unsubscribes: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/unsubscribes", {:groupby => 'hour',
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}/unsubscribes", {:groupby => 'hour',
                                                                             :country => 'US',
                                                                             :region => 'TX',
                                                                             :city => 'Austin',
@@ -373,7 +373,7 @@ result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/unsubscribes", {:gro
 **Get a Single Campaign's Click Complaints: **
 
 ```ruby
-result = @mg_client.get "#{domain}/campaigns/#{campaign_id}/complaints", {:groupby => 'hour',
+result = mg_client.get "#{domain}/campaigns/#{campaign_id}/complaints", {:groupby => 'hour',
                                                                           :limit => 100,
                                                                           :page => 1,
                                                                           :count => true}
@@ -385,33 +385,33 @@ ____________________________________________________
 **Get List of Webhooks: **
 
 ```ruby
-result = @mg_client.get "domains/#{domain}/webhooks"
+result = mg_client.get "domains/#{domain}/webhooks"
 ```
 
 **Get a Webhook Properties: **
 
 ```ruby
-result = @mg_client.get "domains/#{domain}/webhooks/#{webhook_id}"
+result = mg_client.get "domains/#{domain}/webhooks/#{webhook_id}"
 ```
 
 **Create a Webhook: **
 
 ```ruby
-result = @mg_client.post "domains/#{domain}/webhooks", {:id => 'bounce',
+result = mg_client.post "domains/#{domain}/webhooks", {:id => 'bounce',
                                                         :url => 'http://example.com/mailgun/events/bounce'}
 ```
 
 **Update a Webhook: **
 
 ```ruby
-result = @mg_client.put "domains/#{domain}/webhooks/#{webhook_id}", {:id => 'bounce',
+result = mg_client.put "domains/#{domain}/webhooks/#{webhook_id}", {:id => 'bounce',
                                                                      :url => 'http://example.com/mailgun/events/bounce'}
 ```
 
 **Remove a Webhook: **
 
 ```ruby
-result = @mg_client.delete "domains/#{domain}/webhooks/#{webhook_id}"
+result = mg_client.delete "domains/#{domain}/webhooks/#{webhook_id}"
 ```
 
 ### Mailing Lists:
@@ -420,19 +420,19 @@ ____________________________________________________
 **Get list of Lists: **
 
 ```ruby
-result = @mg_client.get "lists"
+result = mg_client.get "lists"
 ```
 
 **Get List Properties: **
 
 ```ruby
-result = @mg_client.get "lists/#{list_address}"
+result = mg_client.get "lists/#{list_address}"
 ```
 
 **Create a List: **
 
 ```ruby
-result = @mg_client.post "lists", {:address => 'dev.group@samples.mailgun.org',
+result = mg_client.post "lists", {:address => 'dev.group@samples.mailgun.org',
                                    :name => 'Development Group List',
                                    :description => 'List of all developers.',
                                    :access_level => 'members'}
@@ -441,7 +441,7 @@ result = @mg_client.post "lists", {:address => 'dev.group@samples.mailgun.org',
 **Update a List: **
 
 ```ruby
-result = @mg_client.put "lists/#{list_address}", {:address => 'dev.group@samples.mailgun.org',
+result = mg_client.put "lists/#{list_address}", {:address => 'dev.group@samples.mailgun.org',
                                                   :name => 'Development Group List',
                                                   :description => 'List of all developers.',
                                                   :access_level => 'members'}
@@ -450,25 +450,25 @@ result = @mg_client.put "lists/#{list_address}", {:address => 'dev.group@samples
 **Remove a List: **
 
 ```ruby
-result = @mg_client.delete "lists/#{list_address}"
+result = mg_client.delete "lists/#{list_address}"
 ```
 
 **Get List Members: **
 
 ```ruby
-result = @mg_client.get "lists/#{list_address}/members"
+result = mg_client.get "lists/#{list_address}/members"
 ```
 
 **Get List Member Properties: **
 
 ```ruby
-result = @mg_client.get "lists/#{list_address}/members/#{member_address}"
+result = mg_client.get "lists/#{list_address}/members/#{member_address}"
 ```
 
 **Add Member to List: **
 
 ```ruby
-result = @mg_client.post "lists/#{list_address}/members/#{member_address}", {:address => 'jane@samples.mailgun.org',
+result = mg_client.post "lists/#{list_address}/members/#{member_address}", {:address => 'jane@samples.mailgun.org',
                                                                              :name => 'Jane Doe',
                                                                              :vars => '{"first": "Jane", "last": "Doe"}',
                                                                              :subscribed => true,
@@ -478,7 +478,7 @@ result = @mg_client.post "lists/#{list_address}/members/#{member_address}", {:ad
 **Update Member on List: **
 
 ```ruby
-result = @mg_client.put "lists/#{list_address}/members/#{member_address}", {:address => 'jane@samples.mailgun.org',
+result = mg_client.put "lists/#{list_address}/members/#{member_address}", {:address => 'jane@samples.mailgun.org',
                                                                              :name => 'Jane Doe',
                                                                              :vars => '{"first": "Jane", "last": "Doe"}',
                                                                              :subscribed => true}
@@ -487,13 +487,13 @@ result = @mg_client.put "lists/#{list_address}/members/#{member_address}", {:add
 **Delete a Member from List: **
 
 ```ruby
-result = @mg_client.delete "lists/#{list_address}/members/#{member_address}"
+result = mg_client.delete "lists/#{list_address}/members/#{member_address}"
 ```
 
 **Get Stats for List: **
 
 ```ruby
-result = @mg_client.get "lists/#{list_address}/stats"
+result = mg_client.get "lists/#{list_address}/stats"
 ```
 
 ### Email Validation:
@@ -501,14 +501,7 @@ ____________________________________________________
 **Validate Single Address: **
 
 ```ruby
-result = @mg_client.get "address/validate", {:address => 'test@example.com'}
-```
-
-**Parse Addresses: **
-
-```ruby
-result = @mg_client.get "address/parse", {:addresses => 'test@example.com, "First Last <first.last@example.com>',
-                                          :syntax_only => true}
+result = mg_client.get "address/validate", {:address => 'test@example.com'}
 ```