mailgun-ruby 1.2.5 → 1.2.11

data/lib/mailgun/client.rb

@@ -11,12 +11,12 @@ module Mailgun
   class Client
 
     def initialize(api_key = Mailgun.api_key,
-                   api_host = 'api.mailgun.net',
-                   api_version = 'v3',
+                   api_host = Mailgun.api_host || 'api.mailgun.net',
+                   api_version = Mailgun.api_version  || 'v3',
                    ssl = true,
                    test_mode = false,
                    timeout = nil,
-                   proxy_url = nil)
+                   proxy_url = Mailgun.proxy_url)
 
       rest_client_params = {
         user: 'api',
@@ -45,6 +45,11 @@ module Mailgun
       @test_mode = false
     end
 
+    # Change API key
+    def set_api_key(api_key)
+      @http_client.options[:password] = api_key
+    end
+
     # Client is in test mode?
     #
     # @return [Boolean] Is the client set in test mode?
@@ -200,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) && e.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
 
@@ -208,11 +222,11 @@ module Mailgun
       message = data.respond_to?(:message) ? data.message : data
       fail ParameterError.new('Missing working domain', working_domain) unless working_domain
       fail ParameterError.new(
-        'Missing `to` recipient, message should containg at least 1 recipient',
+        'Missing `to` recipient, message should contain at least 1 recipient',
         working_domain
       ) if message.fetch('to', []).empty? && message.fetch(:to, []).empty?
       fail ParameterError.new(
-        'Missing a `from` sender, message should containg at least 1 `from` sender',
+        'Missing a `from` sender, message should contain at least 1 `from` sender',
         working_domain
       ) if message.fetch('from', []).empty? && message.fetch(:from, []).empty?
     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

@@ -43,7 +43,11 @@ module Mailgun
     #
     def initialize(message = nil, response = nil)
       @response = response
-      @code = response.code || NOCODE
+      @code = if response.nil?
+                NOCODE
+              else
+                response.code
+              end
 
       begin
         api_message = JSON.parse(response.body)['message']
@@ -51,8 +55,9 @@ module Mailgun
         api_message = response.body
       rescue NoMethodError
         api_message = "Unknown API error"
+      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
@@ -62,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/suppressions.rb

@@ -45,11 +45,11 @@ module Mailgun
     end
 
     def get_bounce(address)
-      @client.get("#{@domain}/bounces/#{address}", nil)
+      @client.get("#{@domain}/bounces/#{escape_address(address)}", nil)
     end
 
     def create_bounce(params = {})
-      @client.post("#{@domain/bounces}", params)
+      @client.post("#{@domain}/bounces", params)
     end
 
     # Creates multiple bounces on the Mailgun API.
@@ -100,7 +100,7 @@ module Mailgun
     end
 
     def delete_bounce(address)
-      @client.delete("#{@domain}/bounces/#{address}")
+      @client.delete("#{@domain}/bounces/#{escape_address(address)}")
     end
 
     def delete_all_bounces
@@ -118,7 +118,7 @@ module Mailgun
     end
 
     def get_unsubscribe(address)
-      @client.get("#{@domain}/unsubscribes/#{address}")
+      @client.get("#{@domain}/unsubscribes/#{escape_address(address)}")
     end
 
     def create_unsubscribe(params = {})
@@ -173,7 +173,7 @@ module Mailgun
     end
 
     def delete_unsubscribe(address, params = {})
-      @client.delete("#{@domain}/unsubscribes/#{address}")
+      @client.delete("#{@domain}/unsubscribes/#{escape_address(address)}")
     end
 
     ####
@@ -187,7 +187,7 @@ module Mailgun
     end
 
     def get_complaint(address)
-      @client.get("#{@domain}/complaints/#{address}", nil)
+      @client.get("#{@domain}/complaints/#{escape_address(address)}", nil)
     end
 
     def create_complaint(params = {})
@@ -239,11 +239,15 @@ module Mailgun
     end
 
     def delete_complaint(address)
-      @client.delete("#{@domain}/complaints/#{address}")
+      @client.delete("#{@domain}/complaints/#{escape_address(address)}")
     end
 
     private
 
+    def escape_address(address)
+      CGI.escape address
+    end
+
     def get_from_paging(uri, params = {})
       @client.get(uri, params)
     end

data/lib/mailgun/version.rb

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

data/lib/mailgun/webhooks/webhooks.rb

@@ -58,7 +58,7 @@ module Mailgun
     #
     # Returns true or false
     def create_all(domain, url = '')
-      %w(bounce click deliver drop open spam unsubscribe).each do |action|
+      %w(accepted clicked complained delivered opened permanent_fail temporary_fail unsubscribed).each do |action|
         add_webhook domain, action, url
       end
       true
@@ -90,7 +90,7 @@ module Mailgun
     # Returns a Boolean on the success
     def remove_all(domain)
       fail Mailgun::ParameterError('Domain not provided to remove webhooks from') unless domain
-      %w(bounce click deliver drop open spam unsubscribe).each do |action|
+      %w(accepted clicked complained delivered opened permanent_fail temporary_fail unsubscribed).each do |action|
         delete_webhook domain, action
       end
     end

data/lib/mailgun-ruby.rb

@@ -1,2 +1,2 @@
 require 'mailgun'
-require 'railgun' if defined?(Rails)
+require 'railgun' if defined?(Rails) && defined?(ActionMailer)

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]
 
@@ -48,7 +48,10 @@ 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?
+
       mail[:domain] = nil if mail[:domain].present?
+      mail[:api_key] = nil if mail[:api_key].present?
 
       mg_message = Railgun.transform_for_mailgun(mail)
       response = @mg_client.send_message(@mg_domain, mg_message)

data/spec/integration/bounces_spec.rb

@@ -7,7 +7,7 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
-    @email = "integration-test-email@#{TESTDOMAIN}"
+    @email = "integration-test+email@#{TESTDOMAIN}"
   end
 
   it 'creates a bounce' do
@@ -22,7 +22,7 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   end
 
   it 'get a bounce.' do
-    result = @mg_obj.get("#{@domain}/bounces/#{@email}")
+    result = @mg_obj.get("#{@domain}/bounces/#{CGI.escape(@email)}")
 
     result.to_h!
     expect(result.body["code"]).to eq("550")
@@ -38,7 +38,7 @@ describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
   end
 
   it 'deletes a bounce' do
-    @mg_obj.delete("#{@domain}/bounces/#{@email}")
+    @mg_obj.delete("#{@domain}/bounces/#{CGI.escape(@email)}")
   end
 
 end

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/spec/unit/connection/test_client.rb

@@ -46,7 +46,8 @@ module Mailgun
         Mailgun::Response.new(response_generator(@endpoint))
       rescue => e
         p e
-        raise CommunicationError.new(e), e.response
+        raise CommunicationError.new(e), e.response if e.respond_to? :response
+        raise CommunicationError.new(e.message)
       end
     end
 
@@ -82,11 +83,11 @@ module Mailgun
       message = data.respond_to?(:message) ? data.message : data
 
       fail ParameterError.new(
-        'Missing `to` recipient, message should containg at least 1 recipient',
+        'Missing `to` recipient, message should contain at least 1 recipient',
         working_domain
       ) if message.fetch('to', []).empty? && message.fetch(:to, []).empty?
       fail ParameterError.new(
-        'Missing a `from` sender, message should containg at least 1 `from` sender',
+        'Missing a `from` sender, message should contain at least 1 `from` sender',
         working_domain
       ) if message.fetch('from', []).empty? && message.fetch(:from, []).empty?
     end

data/spec/unit/mailgun_spec.rb

@@ -87,6 +87,25 @@ describe 'The method post()' do
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
+
+  context 'when Unknown API error is raised' do
+    before do
+      allow(Mailgun::Response).to receive(:new).and_raise(StandardError, "message")
+      allow(JSON).to receive(:parse).and_raise('Unknown')
+    end
+
+    it 'adds Unknown API error to message' do
+      data = {'from' => 'joe@test.com',
+                    'to' => 'bob@example.com',
+                    'subject' => 'Test',
+                    'text' => 'Test Data'}
+      @mg_obj.post("#{@domain}/messages", data)
+    rescue Mailgun::CommunicationError => err
+      expect(err.message).to eq('message: Unknown API error')
+    else
+      fail
+    end
+  end
 end
 
 describe 'The method put()' do

data/vcr_cassettes/bounces.yml

@@ -5,7 +5,7 @@ http_interactions:
     uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces
     body:
       encoding: US-ASCII
-      string: address=integration-test-email%40DOMAIN.TEST&code=550&error=Integration%20Test
+      string: address=integration-test%2Bemail%40DOMAIN.TEST&code=550&error=Integration%20Test
     headers:
       Accept:
       - "*/*; q=0.5, application/xml"
@@ -42,13 +42,13 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Address
+      string: '{"address":"integration-test+email@DOMAIN.TEST","message":"Address
         has been added to the bounces table"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:29 GMT
 - request:
     method: get
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test-email@DOMAIN.TEST
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test+email@DOMAIN.TEST
     body:
       encoding: US-ASCII
       string: ''
@@ -84,9 +84,9 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"address":"integration-test-email@DOMAIN.TEST","code":"550","error":"Integration
+      string: '{"address":"integration-test+email@DOMAIN.TEST","code":"550","error":"Integration
         Test","created_at":"Fri, 08 Jan 2016 20:33:28 UTC"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:29 GMT
 - request:
     method: get
@@ -126,13 +126,13 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"items":[{"address":"integration-test-email@DOMAIN.TEST","code":"550","error":"Integration
-        Test","created_at":"Fri, 08 Jan 2016 20:33:28 UTC"}],"paging":{"first":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?limit=100","last":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=last\u0026limit=100","next":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=next\u0026address=integration-test-email%40DOMAIN.TEST\u0026limit=100","previous":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=previous\u0026address=integration-test-email%40DOMAIN.TEST\u0026limit=100"}}'
-    http_version: 
+      string: '{"items":[{"address":"integration-test+email@DOMAIN.TEST","code":"550","error":"Integration
+        Test","created_at":"Fri, 08 Jan 2016 20:33:28 UTC"}],"paging":{"first":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?limit=100","last":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=last\u0026limit=100","next":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=next\u0026address=integration-test%2Bemaill%40DOMAIN.TEST\u0026limit=100","previous":"https://api.mailgun.net/v3/DOMAIN.TEST/bounces?page=previous\u0026address=integration-test%2Bemail%40DOMAIN.TEST\u0026limit=100"}}'
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:29 GMT
 - request:
     method: delete
-    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test-email@DOMAIN.TEST
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/bounces/integration-test+email@DOMAIN.TEST
     body:
       encoding: US-ASCII
       string: ''
@@ -168,8 +168,8 @@ http_interactions:
       - Content-Type, x-requested-with
     body:
       encoding: UTF-8
-      string: '{"address":"integration-test-email@DOMAIN.TEST","message":"Bounced
+      string: '{"address":"integration-test+email@DOMAIN.TEST","message":"Bounced
         address has been removed"}'
-    http_version: 
+    http_version:
   recorded_at: Fri, 08 Jan 2016 20:33:30 GMT
 recorded_with: VCR 3.0.1

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