mailgun-ruby 1.2.11 → 1.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17aa99cf0b68c595bdc9a923368c206da53c5eb2798d4a4faf9def78d9216129
-  data.tar.gz: ede5046e9ddb743b5eadff56da85a7b32049c6c6451895442f4356675c946cc9
+  metadata.gz: 63fbab3c08481c2364ca4fef89def410a12672507954764103e900bb0f081858
+  data.tar.gz: e2fed301bb806d720b6e7f9f8707d415756ed92f5b841592ebc100eb53a71d74
 SHA512:
-  metadata.gz: a9b57eb3df8f031b360871555f05681f4f585df44973844369f54f4acc0331e34977813275a36dab485d3b3c3268ce2a56d456c4b292bfd90399d226da1c66f5
-  data.tar.gz: 99d18ff767e314c436891d4a56aa05e7037618c7aa03f3fc28d6be69ad41e49a58744f02024f94376ab9e69f0250ae3455e54d41f9b939da80cba64550ec71ea
+  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/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/README.md

@@ -19,7 +19,7 @@ gem install mailgun-ruby
 Gemfile:
 
 ```ruby
-gem 'mailgun-ruby', '~>1.2.11'
+gem 'mailgun-ruby', '~>1.2.12'
 ```
 
 Usage
@@ -183,13 +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/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/Subaccounts.md

@@ -0,0 +1,68 @@
+Mailgun - [Subaccounts](https://help.mailgun.com/hc/en-us/articles/16380043681435-Subaccounts)
+====================
+
+Rails
+-----
+
+The library can be initialized with a Rails initializer containing similar:
+```ruby
+Mailgun.configure do |config|
+  config.api_key = 'your-secret-api-key'
+end
+```
+Or have the initializer read your environment setting if you prefer.
+
+```ruby
+  Mailgun.api_key = 'your-secret-api-key'
+```
+
+```ruby
+  mb_obj = Mailgun::Subaccounts.new
+
+  # Get subaccounts list
+  mb_obj.get_subaccounts(limit: 10, skip: 0, sort: 'ask', enabled: true)
+  => {"subaccounts"=>[{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}, {"id"=>"YYY", "name"=>"test.subaccount2", "status"=>"open"}], "total"=>2}
+
+  # Get subaccount information
+  mb_obj.info(subaccount_id)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}
+
+  # Add Subaccount
+  mb_obj.create(name)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}}
+
+  # Disable
+  mb_obj.disable(subaccount_id)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"disabled"}}
+
+  # Enable
+  mb_obj.enable(subaccount_id)
+  => {"subaccount"=>{"id"=>"XYZ", "name"=>"test.subaccount1", "status"=>"open"}}
+```
+
+Primary accounts can make API calls on behalf of their subaccounts.
+```ruby
+# First, instantiate the Mailgun Client with your API key
+mg_client = Mailgun::Client.new 'your-api-key'
+mg_client.set_subaccount('SUBACCOUNT_ID')
+
+# Define your message parameters
+message_params = {  from: 'bob@SUBACCOUNT_DOMAIN',
+                    to: 'sally@example.com',
+                    subject: 'The Ruby SDK is awesome!',
+                    text: 'It is really easy to send a message!'
+                  }
+
+# Send your message through the client
+# Note: This will not actually hit the API, and will return a generic OK response.
+mg_client.send_message('SUBACCOUNT_DOMAIN', message_params)
+
+# Reset subaccount for primary usage
+mg_client.reset_subaccount
+```
+
+
+More Documentation
+------------------
+See the official [Mailgun Docs](https://documentation.mailgun.com/en/latest/subaccounts.html#subaccounts)
+for more information.

data/docs/Suppressions.md

@@ -38,6 +38,16 @@ supp_client.list_complaints
 
 ----
 
+To get the next or previous suppressions page:
+
+```ruby
+supp_client.list_bounces # returns first *limit* records + next, previous pages urls
+supp_client.next # returns next *limit* records
+supp_client.prev # returns previous *limit* records
+```
+
+----
+
 To batch-add a set of bounces:
 
 ```ruby

data/docs/railgun/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/lib/mailgun/client.rb

@@ -9,6 +9,7 @@ module Mailgun
   #
   # See the Github documentation for full examples.
   class Client
+    SUBACCOUNT_HEADER = 'X-Mailgun-On-Behalf-Of'.freeze
 
     def initialize(api_key = Mailgun.api_key,
                    api_host = Mailgun.api_host || 'api.mailgun.net',
@@ -50,6 +51,16 @@ module Mailgun
       @http_client.options[:password] = api_key
     end
 
+    # Add subaccount id to headers
+    def set_subaccount(subaccount_id)
+      @http_client.options[:headers] = { SUBACCOUNT_HEADER => subaccount_id }
+    end
+
+    # Reset subaccount for primary usage
+    def reset_subaccount
+      @http_client.options[:headers].delete(SUBACCOUNT_HEADER)
+    end
+
     # Client is in test mode?
     #
     # @return [Boolean] Is the client set in test mode?

data/lib/mailgun/domains/domains.rb

@@ -56,7 +56,7 @@ module Mailgun
     #     spam_action   - [String] disabled, blocked or tag
     #       Disable, no spam filtering will occur for inbound messages.
     #       Block, inbound spam messages will not be delivered.
-    #       Tag, messages will be tagged wtih a spam header. See Spam Filter.
+    #       Tag, messages will be tagged with a spam header. See Spam Filter.
     #     wildcard      - [Boolean] true or false Determines whether the domain will accept email for sub-domains.
     #
     # Returns [Hash] of created domain

data/lib/mailgun/events/events.rb

@@ -88,7 +88,7 @@ module Mailgun
     # Return is irrelevant.
     def extract_paging(response)
       paging            = response.to_h['paging']
-      next_page_url     = paging && paging['next']      # gives nil when any one of the keys doens't exist
+      next_page_url     = paging && paging['next']      # gives nil when any one of the keys doesn't exist
       previous_page_url = paging && paging['previous']  # can be replaced with Hash#dig for ruby >= 2.3.0
       @paging_next      = extract_endpoint_from(next_page_url)
       @paging_previous  = extract_endpoint_from(previous_page_url)

data/lib/mailgun/messages/message_builder.rb

@@ -125,7 +125,7 @@ module Mailgun
       add_file(:attachment, attachment, filename)
     end
 
-    # Adds an inline image to the mesage object.
+    # Adds an inline image to the message object.
     #
     # @param [String|File] inline_image A file object for attaching an inline image.
     # @param [String] filename The filename you wish the inline image to be.
@@ -383,7 +383,7 @@ module Mailgun
     def bool_lookup(value)
       return 'yes' if %w(true yes yep).include? value.to_s.downcase
       return 'no' if %w(false no nope).include? value.to_s.downcase
-      warn 'WARN: for bool type actions next values are prefered: true yes yep | false no nope | htmlonly'
+      warn 'WARN: for bool type actions next values are preferred: true yes yep | false no nope | htmlonly'
       value
     end
 

data/lib/mailgun/response.rb

@@ -58,5 +58,12 @@ module Mailgun
     rescue => err
       raise ParseError.new(err), err
     end
+    
+    # Returns true if response code is 2xx
+    # 
+    # @return [Boolean] A boolean that binarizes the response code result.
+    def success?
+      (200..299).include?(code)
+    end
   end
 end

data/lib/mailgun/subaccounts/subaccounts.rb

@@ -0,0 +1,84 @@
+require 'mailgun/exceptions/exceptions'
+
+module Mailgun
+
+  # A Mailgun::Subaccounts object is a simple CRUD interface to Mailgun Subaccounts.
+  # Uses Mailgun
+  class Subaccounts
+    attr_reader :client
+
+    # Public: creates a new Mailgun::Subaccounts instance.
+    # Defaults to Mailgun::Client
+    def initialize(client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v5'))
+      @client = client
+    end
+
+    # Public: Get subaccounts
+    # options - [Hash] of
+    #     limit  - [Integer] Maximum number of records to return. (10 by default)
+    #     skip     [Integer] Number of records to skip
+    #     sort     [Array] “asc” or “desc”
+    #     enabled  [boolean] (Optional) Returns all enabled/disabled subaccounts, defaults to all if omitted
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the subaccount.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Array] A list of subaccounts (hash)
+    def list(options = {})
+      client.get("accounts/subaccounts", options).to_h!
+    end
+    alias_method :get_subaccounts, :list
+
+    # Public: Get subaccount information
+    #
+    # subaccount_id - [String] subaccount name to lookup for
+    # options - [Hash] of
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the subaccount.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] Information on the requested subaccount.
+    def info(subaccount_id, options = {})
+      fail(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+      client.get("accounts/subaccounts/#{subaccount_id}", options).to_h!
+    end
+
+    # Public: Add Subaccount
+    #
+    # name  - [String] Name of the subaccount being created
+    # options - [Hash] of
+    #     name - [String] Name of the subaccount being created.
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the subaccount.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] of created subaccount
+    def create(name, options = {})
+      fail(ParameterError, 'No name given to create subaccount', caller) unless name
+      client.post("accounts/subaccounts", options.merge!(name: name)).to_h!
+    end
+
+    # Public: Disable a subaccount
+    #
+    # subaccount_id - [String] subaccount name to disable
+    # options - [Hash] of
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the subaccount.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] Information on the requested subaccount.
+    def disable(subaccount_id, options = {})
+      fail(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+      client.post("accounts/subaccounts/#{subaccount_id}/disable", options).to_h!
+    end
+
+    # Public: Enable a subaccount
+    #
+    # subaccount_id - [String] subaccount name to enable
+    # options - [Hash] of
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the subaccount.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] Information on the requested subaccount.
+    def enable(subaccount_id, options = {})
+      fail(ParameterError, 'No Id of subaccount specified', caller) unless subaccount_id
+      client.post("accounts/subaccounts/#{subaccount_id}/enable", options).to_h!
+    end
+  end
+end

data/lib/mailgun/templates/templates.rb

@@ -0,0 +1,187 @@
+require 'mailgun/exceptions/exceptions'
+
+module Mailgun
+
+  # A Mailgun::Templates object is a simple CRUD interface to Mailgun Templates.
+  # Uses Mailgun
+  class Templates
+
+    # Public: creates a new Mailgun::Templates instance.
+    # Defaults to Mailgun::Client
+    def initialize(client = Mailgun::Client.new)
+      @client = client
+    end
+
+    # Public: Add template
+    #
+    # domain  - [String] Name of the domain for new template(ex. domain.com)
+    # options - [Hash] of
+    #     name - [String] Name of the template being stored.
+    #     description   - [String] Description of the template being stored
+    #     template      - [String] (Optional) Content of the template
+    #     tag           - [String] (Optional) Initial tag of the created version.
+    #     comment       - [String] (Optional) Version comment.
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the template.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] of created template
+    def create(domain, options = {})
+      fail(ParameterError, 'No domain given to store template on', caller) unless domain
+      @client.post("#{domain}/templates", options).to_h
+    end
+
+    # Public: Get template information
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    # options - [Hash] of
+    #     active - [Boolean] (Optional) If this flag is set to yes the active version
+    #               of the template is included in the response.
+    #
+    # Returns [Hash] Information on the requested template.
+    def info(domain, template_name, options = {})
+      fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain', caller) unless template_name
+      @client.get("#{domain}/templates/#{template_name}", options).to_h!
+    end
+
+    # Public: Update the metadata information of the template
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    # options - [Hash] of
+    #     description - [String] Updated description of the template
+    #
+    # Returns [Hash] of updated domain
+    def update(domain, template_name, options = {})
+      fail(ParameterError, 'No domain given to add on Mailgun', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain', caller) unless template_name
+      @client.put("#{domain}/templates/#{template_name}", options).to_h
+    end
+
+    # Public: Delete Template
+    # NOTE: This method deletes all versions of the specified template.
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    #
+    # Returns [Boolean] if successful or not
+    def remove(domain, template_name)
+      fail(ParameterError, 'No domain given to remove on Mailgun', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain', caller) unless template_name
+      @client.delete("#{domain}/templates/#{template_name}").to_h['message'] == 'template has been deleted'
+    end
+    alias_method :delete, :remove
+    alias_method :delete_template, :remove
+
+    # Public: Get Templates
+    #
+    # domain - [String] Domain name where template is stored
+    # page   - [String] Name of a page to retrieve. first, last, next, prev
+    # limit  - [Integer] Maximum number of records to return. (100 by default)
+    # p      - [Integer] Pivot is used to retrieve records in chronological order
+    #
+    # Returns [Array] A list of templates (hash)
+    def list(domain, options = {})
+      fail(ParameterError, 'No domain given.', caller) unless domain
+      @client.get("#{domain}/templates", options).to_h['items']
+    end
+    alias_method :get_templates, :list
+
+    # Public: Delete Templates
+    # NOTE: This method deletes all stored templates for the domain.
+    #
+    # domain        - [String] Domain name where template is stored
+    #
+    # Returns [Boolean] if successful or not
+    def remove_all(domain)
+      fail(ParameterError, 'No domain given to remove on Mailgun', caller) unless domain
+      @client.delete("#{domain}/templates").to_h['message'] == 'templates have been deleted'
+    end
+    alias_method :delete_templates, :remove_all
+
+    # Public: Create a new version of a template
+    #
+    # domain        - [String] Name of the domain for new template(ex. domain.com)
+    # template_name - [String] Template name to lookup for
+    # options - [Hash] of
+    #     template      - [String] Content of the template
+    #     tag           - [String] Initial tag of the created version.
+    #     comment       - [String] (Optional) Version comment.
+    #     active        - [Boolean] (Optional) If this flag is set to yes, this version becomes active
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the template.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] of updated template
+    def create_version(domain, template_name, options = {})
+      fail(ParameterError, 'No domain given.', caller) unless domain
+      fail(ParameterError, 'No template name given.', caller) unless template_name
+      @client.post("#{domain}/templates/#{template_name}/versions", options).to_h
+    end
+
+    # Public: Get template version information
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    # tag           - [String] Version tag to lookup for
+    #
+    # Returns [Hash] Information on the requested template + version.
+    def info_version(domain, template_name, tag)
+      fail(ParameterError, 'No domain given to find on Mailgun', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain', caller) unless template_name
+      fail(ParameterError, 'No version tag given.', caller) unless tag
+      @client.get("#{domain}/templates/#{template_name}/versions/#{tag}").to_h!
+    end
+
+    # Public: Update the version of the template
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    # tag           - [String] Version tag to lookup for
+    # options - [Hash] of
+    #     template      - [String] Content of the template
+    #     comment       - [String] (Optional) Version comment.
+    #     active        - [Boolean] (Optional) If this flag is set to yes, this version becomes active
+    #     headers       - [String] (Optional) Key Value json dictionary of headers to be stored with the template.
+    #                     ex.('{"Subject": "{{subject}}"}')
+    #
+    # Returns [Hash] of updated template's version
+    def update_version(domain, template_name, tag, options = {})
+      fail(ParameterError, 'No domain given.', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain.', caller) unless template_name
+      fail(ParameterError, 'No version tag given.', caller) unless tag
+      @client.put("#{domain}/templates/#{template_name}/versions/#{tag}", options).to_h
+    end
+
+    # Public: Delete the version of the template
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    # tag           - [String] Version tag to lookup for
+    #
+    # Returns [Boolean] if successful or not
+    def delete_version(domain, template_name, tag)
+      fail(ParameterError, 'No domain given.', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain.', caller) unless template_name
+      fail(ParameterError, 'No version tag given.', caller) unless tag
+      @client.delete("#{domain}/templates/#{template_name}/versions/#{tag}")
+        .to_h['message'] == 'version has been deleted'
+    end
+
+    # Public: Get Template's Versions list
+    #
+    # domain        - [String] Domain name where template is stored
+    # template_name - [String] Template name to lookup for
+    # options - [Hash] of
+    # page   - [String] Name of a page to retrieve. first, last, next, prev
+    # limit  - [Integer] Maximum number of records to return. (100 by default)
+    # p      - [Integer] Pivot is used to retrieve records in chronological order
+    #
+    # Returns [Array] A list of template's versions (hash)
+    def template_versions_list(domain, template_name, options = {})
+      fail(ParameterError, 'No domain given.', caller) unless domain
+      fail(ParameterError, 'No template name given to find on provided domain.', caller) unless template_name
+      @client.get("#{domain}/templates/#{template_name}/versions", options).to_h
+    end
+  end
+end

data/lib/mailgun/version.rb

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

data/lib/mailgun.rb

@@ -15,6 +15,8 @@ require 'mailgun/events/events'
 require 'mailgun/exceptions/exceptions'
 require 'mailgun/domains/domains'
 require 'mailgun/webhooks/webhooks'
+require 'mailgun/templates/templates'
+require 'mailgun/subaccounts/subaccounts'
 
 # Module for interacting with the sweet Mailgun API.
 #

data/lib/railgun/mailer.rb

@@ -49,9 +49,11 @@ module Railgun
     def deliver!(mail)
       @mg_domain = set_mg_domain(mail)
       @mg_client.set_api_key(mail[:api_key].value) if mail[:api_key].present?
+      @mg_client.set_subaccount(mail[:subaccount_id].value) if mail[:subaccount_id].present?
 
       mail[:domain] = nil if mail[:domain].present?
       mail[:api_key] = nil if mail[:api_key].present?
+      mail[:subaccount_id] = nil if mail[:subaccount_id].present?
 
       mg_message = Railgun.transform_for_mailgun(mail)
       response = @mg_client.send_message(@mg_domain, mg_message)
@@ -145,7 +147,7 @@ module Railgun
 
     # reject blank values
     message.delete_if do |k, v|
-      return true if v.nil?
+      next true if v.nil?
 
       # if it's an array remove empty elements
       v.delete_if { |i| i.respond_to?(:empty?) && i.empty? } if v.is_a?(Array)

data/mailgun.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
 
   spec.name             = 'mailgun-ruby'
   spec.version          = Mailgun::VERSION
-  spec.homepage         = 'http://www.mailgun.com'
+  spec.homepage         = 'https://www.mailgun.com/'
   spec.platform         = Gem::Platform::RUBY
   spec.license          = 'Apache-2.0'
 
@@ -17,6 +17,9 @@ Gem::Specification.new do |spec|
   spec.authors          = ['Mailgun', 'Travis Swientek']
   spec.email            = 'support@mailgunhq.com'
 
+  spec.metadata['documentation_uri'] = 'https://documentation.mailgun.com/'
+  spec.metadata['source_code_uri'] = 'https://github.com/mailgun/mailgun-ruby'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
@@ -27,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 1.16.2'
   spec.add_development_dependency 'rspec', '~> 3.8.0'
   spec.add_development_dependency 'rake', '~> 12.3.2'
-  spec.add_development_dependency 'webmock', '~> 3.4.2'
+  spec.add_development_dependency 'webmock', '~> 3.7'
   spec.add_development_dependency 'pry', '~> 0.11.3'
   spec.add_development_dependency 'vcr', '~> 3.0.3'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'

data/spec/integration/email_validation_spec.rb

@@ -15,6 +15,13 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     @all_addrs = @valid + @invalid
   end
 
+  it 'returns parsed and unparsable lists' do
+    res = @mg_obj.parse(@all_addrs)
+
+    expect(res["parsed"]).to eq(@valid)
+    expect(res["unparsable"]).to eq(@invalid)
+  end
+
   it 'validates alice@mailgun.net with info' do
     res = @mg_obj.validate("alice@mailgun.net")