mailgun-ruby 1.2.7 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6f8edf9d12225755a4ddaba5a1974b8ccc30f4b150d9880a5dc174d0612c619
-  data.tar.gz: c676969ade04f6b2e8d2322ff68922d5065e5ca1720eeb821aa429849fddc7b5
+  metadata.gz: f43539594603950ec212832426bd7755d2b61a466aa9a028eb54f1246687fa3d
+  data.tar.gz: 7c02110bf7e1aae3d6f18ad228e50954a058a36fc2e87b97bfc542ef71bb1a28
 SHA512:
-  metadata.gz: dac9ef370272bed2a8bd78080dbc8e322aae34fe4fa9639d5c35c1de008d088ab8845355c96bac3efd331f43803cf9834047e7843620cc8602efd380aa6b8ae4
-  data.tar.gz: 1cc92c4983c7f3e2b94e0ae577caf8b0010e5e08d6e453adba658acce942186c3b443dbca4930feeeea4bfdaab16a5cfb2bc245ffdd42571de323f4abbbc9c52
+  metadata.gz: 96a39b566bd9b58ad0d799e22742f30b35d6e5d20af43f867fb4412c11408aece5eada65e6bd4153d11028553a2275b0317243eab52c1159b572e508a5192918
+  data.tar.gz: d1ab619f72f158253a353e53416d03730c0d37f957757a8294580ddaa98cdf912aa0d384a69e55702658450d12922b43c0ef780be6a044edf73248246a253bb5

data/README.md

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

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/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'}
 ```
 
 

data/lib/mailgun/address.rb

@@ -4,45 +4,20 @@ module Mailgun
 
   # Mailgun::Address is a simple interface to the Email Validation API.
   class Address
-
-    # @param [String] api_key Mailgun API - public key
-    def initialize(api_key = "")
-      if api_key == "" then
-        fail ParameterError.new('Public API key is required for Mailgun::Address.initialize()', nil)
-      end
-
-      @api_key = api_key
-      @client = Mailgun::Client.new(api_key = api_key)
+    def initialize
+      @client = Mailgun::Client.new(Mailgun.api_key, Mailgun.api_host || 'api.mailgun.net', 'v4')
     end
 
     # Given an arbitrary address, validates it based on defined checks.
     #
     # @param [String] address Email address to validate (max 512 chars.)
     def validate(address, mailbox_verification = false)
-      params = {:address => address}
+      params = {address:  address}
       params[:mailbox_verification] = true if mailbox_verification
 
       res = @client.get "address/validate", params
       return res.to_h!
     end
-
-    # Parses a delimiter separated list of email addresses into two lists:
-    # parsed addresses and unparsable portions. The parsed addresses are a
-    # list of addresses that are syntactically valid (and optionally have
-    # DNS and ESP specific grammar checks) the unparsable list is a list
-    # of characters sequences that the parser was not able to understand.
-    # These often align with invalid email addresses, but not always.
-    # Delimiter characters are comma (,) and semicolon (;).
-    #
-    # @param [Array] addresses Addresses to parse
-    # @param [TrueClass|FalseClass] syntax_only Perform only syntax checks
-    def parse(addresses, syntax_only = true)
-      validate_addrs = addresses.join(";")
-
-      res = @client.get "address/parse", {:addresses => validate_addrs,
-                                          :syntax_only => syntax_only.to_s}
-      return res.to_h!
-    end
   end
 
 end

data/lib/mailgun/client.rb

@@ -205,7 +205,16 @@ module Mailgun
     #
     # @param [StandardException] e upstream exception object
     def communication_error(e)
-      return CommunicationError.new(e.message, e.response) if e.respond_to? :response
+      if e.respond_to?(:response)
+        return case e.response.code
+        when Unauthorized::CODE
+          Unauthorized.new(e.message, e.response)
+        when BadRequest::CODE
+          BadRequest.new(e.message, e.response)
+        else
+          CommunicationError.new(e.message, e.response)
+        end
+      end
       CommunicationError.new(e.message)
     end
 

data/lib/mailgun/domains/domains.rb

@@ -53,8 +53,9 @@ module Mailgun
     # domain  - [String] Name of the domain (ex. domain.com)
     # options - [Hash] of
     #     smtp_password - [String] Password for SMTP authentication
-    #     spam_action   - [String] disabled or tag
+    #     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.
     #     wildcard      - [Boolean] true or false Determines whether the domain will accept email for sub-domains.
     #
@@ -80,5 +81,22 @@ module Mailgun
     alias_method :delete, :remove
     alias_method :delete_domain, :remove
 
+    # Public: Update domain
+    #
+    # domain  - [String] Name of the domain (ex. domain.com)
+    # options - [Hash] of
+    #     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.
+    #     web_scheme    - [String] http or https
+    #       Set your open, click and unsubscribe URLs to use http or https
+    #     wildcard      - [Boolean] true or false Determines whether the domain will accept email for sub-domains.
+    #
+    # Returns [Hash] of updated domain
+    def update(domain, options = {})
+      fail(ParameterError, 'No domain given to add on Mailgun', caller) unless domain
+      @client.put("domains/#{domain}", options).to_h
+    end
   end
 end

data/lib/mailgun/exceptions/exceptions.rb

@@ -58,7 +58,6 @@ module Mailgun
       rescue
         api_message = 'Unknown API error'
       end
-      api_message = api_message + ' - Invalid Domain or API key' if api_message == FORBIDDEN
 
       message = message || ''
       message = message + ': ' + api_message
@@ -68,6 +67,26 @@ module Mailgun
       @code = NOCODE
       super(message, response)
     end
+  end
+
+  # Public: Class for managing unauthorized 401 errors
+  # Inherits from Mailgun::CommunicationError
+  class Unauthorized < CommunicationError
+    CODE = 401
 
+    def initialize(error_message, response)
+      error_message = error_message + ' - Invalid Domain or API key'
+      super(error_message, response)
+    end
+  end
+
+  # Public: Class for managing bad request 400 errors
+  # Inherits from Mailgun::CommunicationError
+  class BadRequest < CommunicationError
+    CODE = 400
+
+    def initialize(error_message, response)
+      super(error_message, response)
+    end
   end
 end

data/lib/mailgun/messages/message_builder.rb

@@ -406,7 +406,7 @@ module Mailgun
     def make_json(obj)
       return JSON.parse(obj).to_json if obj.is_a?(String)
       return obj.to_json if obj.is_a?(Hash)
-      return JSON.generate(obj).to_json
+      JSON.generate(obj).to_json
     rescue
       raise Mailgun::ParameterError, 'Provided data could not be made into JSON. Try a JSON string or Hash.', obj
     end
@@ -429,7 +429,7 @@ module Mailgun
         full_name = vars['full_name']
       elsif vars['first'] || vars['last']
         full_name = "#{vars['first']} #{vars['last']}".strip
-      end 
+      end
 
       return "'#{full_name}' <#{address}>" if full_name
       address

data/lib/mailgun/version.rb

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

data/lib/mailgun.rb

@@ -22,10 +22,12 @@ require 'mailgun/webhooks/webhooks'
 module Mailgun
 
   class << self
-    attr_accessor :api_key,
+    attr_accessor :api_host,
+                  :api_key,
                   :api_version,
                   :protocol,
                   :mailgun_host,
+                  :proxy_url,
                   :test_mode,
                   :domain
 

data/lib/railgun/mailer.rb

@@ -33,7 +33,7 @@ module Railgun
         config[:api_version] || 'v3',
         config[:api_ssl].nil? ? true : config[:api_ssl],
         false,
-        config[:timeout],
+        config[:timeout]
       )
       @domain = @config[:domain]
 

data/spec/integration/domains_spec.rb

@@ -36,4 +36,12 @@ describe 'For the domains endpoint', vcr: vcr_opts do
 
     expect(result).to be_truthy
   end
+
+  it 'updates the domain' do
+    result = @mg_obj.update(@domain, { spam_action: 'block', web_scheme: 'https', wildcard: true })
+
+    expect(result['domain']["spam_action"]).to eq('block')
+    expect(result['domain']["web_scheme"]).to eq('https')
+    expect(result['domain']["wildcard"]).to eq(true)
+  end
 end

data/spec/integration/email_validation_spec.rb

@@ -7,7 +7,7 @@ vcr_opts = { :cassette_name => "email_validation" }
 
 describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
-    @mg_obj = Mailgun::Address.new(PUB_APIKEY)
+    @mg_obj = Mailgun::Address.new
 
     @valid = ["Alice <alice@example.com>", "bob@example.com"]
     @invalid = ["example.org"]
@@ -15,13 +15,6 @@ 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["unparseable"]).to eq(@invalid)
-  end
-
   it 'validates alice@mailgun.net with info' do
     res = @mg_obj.validate("alice@mailgun.net")
 

data/spec/integration/mailgun_spec.rb

@@ -34,6 +34,78 @@ describe 'Client exceptions', vcr: vcr_opts do
   end
 end
 
+vcr_opts = { :cassette_name => "exceptions-invalid-api-key" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'displays error information that API key is invalid' do
+    begin
+      @mg_obj.send_message(@domain, {
+          :from => "sally@#{@domain}",
+          :to => "sally@#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::Unauthorized => err
+      expect(err.message).to eq('401 Unauthorized - Invalid Domain or API key: Forbidden')
+    else
+      fail
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => "exceptions-invalid-data" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'display useful error information' do
+    begin
+      @mg_obj.send_message(@domain, {
+          :from => "sally@#{@domain}",
+          :to => "sally#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::BadRequest => err
+      expect(err.message).to eq('400 Bad Request: to parameter is not a valid address. please check documentation')
+    else
+      fail
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => "exceptions-not-allowed" }
+
+describe 'Client exceptions', vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+  end
+
+  it 'display useful error information' do
+    begin
+      @mg_obj.send_message(@domain, {
+          :from => "invalid@#{@domain}",
+          :to => "invalid#{@domain}",
+          :subject => 'Exception Integration Test',
+          :text => 'INTEGRATION TESTING'
+      })
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to include('403 Forbidden')
+    else
+      fail
+    end
+  end
+end
+
 vcr_opts = { :cassette_name => "send_message" }
 
 describe 'The method send_message()', vcr: vcr_opts do

data/vcr_cassettes/domains.yml

@@ -357,4 +357,54 @@ http_interactions:
         }
     http_version: 
   recorded_at: Fri, 15 Jan 2016 20:12:54 GMT
-recorded_with: VCR 3.0.1
+- request:
+    method: put
+    uri: https://api.mailgun.net/v3/domains/integration-test.domain.invalid
+    body:
+      encoding: UTF-8
+      string: spam_action=block&web_scheme=https&wildcard=true
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin21.6.0 x86_64) ruby/2.5.1p57
+      Content-Length:
+      - '48'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.mailgun.net
+      Authorization:
+      - Basic YXBpOmQ5MTViNWNkYjlhNTgzNjg1ZDhmM2ZiMWJlYzBmMjBmLTA3YmM3YjA1LWZhNDgxNmEx
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '445'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Mon, 17 Apr 2023 13:03:16 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"Domain has been updated","domain":{"created_at":"Mon, 25
+        Jan 2021 10:11:26 GMT","id":"600e994e20b1a14a5990856d","is_disabled":false,"name":"integration-test.domain.invalid","require_tls":false,"skip_verification":false,"smtp_login":"postmaster@DOMAIN.TEST","spam_action":"block","state":"active","type":"sandbox","web_prefix":"email","web_scheme":"https","wildcard":true}}
+
+'
+    http_version: 
+  recorded_at: Mon, 17 Apr 2023 13:04:47 GMT
+recorded_with: VCR 3.0.3

data/vcr_cassettes/exceptions-invalid-api-key.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/messages
+    body:
+      encoding: UTF-8
+      string: from=sally%test.com&to=sally%test.com&subject=Exception+Integration+Test&text=INTEGRATION+TESTING
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin21.6.0 x86_64) ruby/2.5.1p57
+      Content-Length:
+      - '119'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.mailgun.net
+      Authorization:
+      - Basic YXBpOmQ5MTViNWNkYjlhNTgzNjg1ZDhmM2YwNS1mYTQ4MTZhMQ==
+  response:
+    status:
+      code: 401
+      message: Unauthorized
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '9'
+      Content-Type:
+      - text/plain; charset=utf-8
+      Date:
+      - Sun, 28 May 2023 11:29:25 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      Www-Authenticate:
+      - Basic realm="MG API"
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: Forbidden
+    http_version: 
+  recorded_at: Sun, 28 May 2023 11:29:25 GMT
+recorded_with: VCR 3.0.3

data/vcr_cassettes/exceptions-invalid-data.yml

@@ -0,0 +1,52 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/messages
+    body:
+      encoding: UTF-8
+      string: from=sally%40gmail.com&to=sallygmail.com&subject=Exception+Integration+Test&text=INTEGRATION+TESTING
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin21.6.0 x86_64) ruby/2.5.1p57
+      Content-Length:
+      - '116'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.mailgun.net
+      Authorization:
+      - Basic YXBpOmQ5MTViNWNkYjlhNTgzNjg1ZDhmM2ZiMWJlYzBmMjBmLTA3YmM3YjA1LWZhNDgxNmEx
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '78'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 28 May 2023 11:35:04 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"to parameter is not a valid address. please check documentation"}
+
+'
+    http_version: 
+  recorded_at: Sun, 28 May 2023 11:35:04 GMT
+recorded_with: VCR 3.0.3

data/vcr_cassettes/exceptions-not-allowed.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mailgun.net/v3/DOMAIN.TEST/messages
+    body:
+      encoding: UTF-8
+      string: from=sally%test.com&to=sally%test.com&subject=Exception+Integration+Test&text=INTEGRATION+TESTING
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin21.6.0 x86_64) ruby/2.5.1p57
+      Content-Length:
+      - '121'
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Host:
+      - api.mailgun.net
+      Authorization:
+      - Basic YXBpOmQ5MTViNWNkYjlhNTgzNjg1ZDhmM2ZiMWJlYzBmMjBmLTA3YmM3YjA1LWZhNDgxNmEx
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Allow-Origin:
+      - "*"
+      Cache-Control:
+      - no-store
+      Content-Length:
+      - '219'
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Sun, 28 May 2023 11:40:00 GMT
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains
+      X-Xss-Protection:
+      - 1; mode=block
+    body:
+      encoding: UTF-8
+      string: '{"message":"Domain DOMAIN.TEST is not allowed to send: Free accounts
+        are for test purposes only. Please upgrade or add the address to authorized
+        recipients in Account Settings."}
+
+'
+    http_version: 
+  recorded_at: Sun, 28 May 2023 11:40:00 GMT
+recorded_with: VCR 3.0.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.9
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,6 +220,9 @@ files:
 - vcr_cassettes/domains.yml
 - vcr_cassettes/email_validation.yml
 - vcr_cassettes/events.yml
+- vcr_cassettes/exceptions-invalid-api-key.yml
+- vcr_cassettes/exceptions-invalid-data.yml
+- vcr_cassettes/exceptions-not-allowed.yml
 - vcr_cassettes/exceptions.yml
 - vcr_cassettes/list_members.yml
 - vcr_cassettes/mailer_invalid_domain.yml
@@ -251,7 +254,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Mailgun's Official Ruby SDK