mailgun-ruby 1.1.9 → 1.2.13

data/lib/railgun/mailer.rb

@@ -1,4 +1,5 @@
 require 'action_mailer'
+require 'json'
 require 'mailgun'
 require 'rails'
 require 'railgun/errors'
@@ -9,6 +10,9 @@ module Railgun
   # Mailgun.
   class Mailer
 
+    # List of the headers that will be ignored when copying headers from `mail.header_fields`
+    IGNORED_HEADERS = %w[ to from subject reply-to mime-version template ]
+
     # [Hash] config ->
     #   Requires *at least* `api_key` and `domain` keys.
     attr_accessor :config, :domain, :settings
@@ -23,7 +27,14 @@ module Railgun
         raise Railgun::ConfigurationError.new("Config requires `#{k}` key", @config) unless @config.has_key?(k)
       end
 
-      @mg_client = Mailgun::Client.new(config[:api_key], config[:api_host] || 'api.mailgun.net', config[:api_version] || 'v3', config[:api_ssl].nil? ? true : config[:api_ssl])
+      @mg_client = Mailgun::Client.new(
+        config[:api_key],
+        config[:api_host] || 'api.mailgun.net',
+        config[:api_version] || 'v3',
+        config[:api_ssl].nil? ? true : config[:api_ssl],
+        false,
+        config[:timeout]
+      )
       @domain = @config[:domain]
 
       # To avoid exception in mail gem v2.6
@@ -36,8 +47,16 @@ module Railgun
     end
 
     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(@domain, mg_message)
+      response = @mg_client.send_message(@mg_domain, mg_message)
 
       if response.code == 200 then
         mg_id = response.to_h['id']
@@ -47,7 +66,15 @@ module Railgun
     end
 
     def mailgun_client
-      @mg_obj
+      @mg_client
+    end
+
+    private
+
+    # Set @mg_domain from mail[:domain] header if present, then remove it to prevent being sent.
+    def set_mg_domain(mail)
+      return mail[:domain].value if mail[:domain]
+      domain
     end
 
   end
@@ -58,24 +85,60 @@ module Railgun
   # After prefixing them with the proper option type, they are added to
   # the message hash where they will then be sent to the API as JSON.
   #
+  # It is important to note that headers set in `mailgun_headers` on the message
+  # WILL overwrite headers set via `mail.headers()`.
+  #
   # @param [Mail::Message] mail message to transform
   #
   # @return [Hash] transformed message hash
   def transform_for_mailgun(mail)
     message = build_message_object(mail)
 
-    # v:* attributes (variables)
-    mail.mailgun_variables.try(:each) do |k, v|
-      message["v:#{k}"] = v
-    end
-
     # o:* attributes (options)
     mail.mailgun_options.try(:each) do |k, v|
-      message["o:#{k}"] = v
+      message["o:#{k}"] = v.dup
     end
 
+    # t:* attributes (options)
+    mail.mailgun_template_variables.try(:each) do |k, v|
+      message["t:#{k}"] = v.dup
+    end
+
+    # support for using ActionMailer's `headers()` inside of the mailer
+    # note: this will filter out parameters such as `from`, `to`, and so forth
+    #       as they are accepted as POST parameters on the message endpoint.
+
+    msg_headers = Hash.new
+
     # h:* attributes (headers)
-    mail.mailgun_headers.try(:each) do |k, v|
+
+    # Let's set all of these headers on the [Mail::Message] so that
+    # the are created inside of a [Mail::Header] instance and processed there.
+    mail.headers(mail.mailgun_headers || {})
+    mail.header_fields.each do |field|
+      header = field.name.downcase
+      if msg_headers.include? header
+        msg_headers[header] = [msg_headers[header], field.value].flatten
+      else
+        msg_headers[header] = field.value
+      end
+    end
+
+    msg_headers.each do |k, v|
+      if Railgun::Mailer::IGNORED_HEADERS.include? k.downcase
+        Rails.logger.debug("[railgun] ignoring header (using envelope instead): #{k}")
+        next
+      end
+
+      # Cover cases like `cc`, `bcc` where parameters are valid
+      # headers BUT they are submitted as separate POST params
+      # and already exist on the message because of the call to
+      # `build_message_object`.
+      if message.include? k.downcase
+        Rails.logger.debug("[railgun] ignoring header (already set): #{k}")
+        next
+      end
+
       message["h:#{k}"] = v
     end
 
@@ -84,7 +147,12 @@ module Railgun
 
     # reject blank values
     message.delete_if do |k, v|
-      v.nil? or (v.respond_to?(:empty) and v.empty?)
+      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)
+
+      v.respond_to?(:empty?) && v.empty?
     end
 
     return message
@@ -101,6 +169,7 @@ module Railgun
 
     mb.from mail[:from]
     mb.reply_to(mail[:reply_to].to_s) if mail[:reply_to].present?
+    mb.template(mail[:template].to_s) if mail[:template].present?
     mb.subject mail.subject
     mb.body_html extract_body_html(mail)
     mb.body_text extract_body_text(mail)
@@ -120,6 +189,11 @@ module Railgun
       end
     end
 
+    # v:* attributes (variables)
+    mail.mailgun_variables.try(:each) do |name, value|
+      mb.variable(name, value)
+    end
+
     return mb.message if mail.attachments.empty?
 
     mail.attachments.each do |attach|
@@ -181,5 +255,4 @@ module Railgun
     return mail.html_part if mail.multipart?
     (mail.mime_type =~ /^text\/html$/i) && mail
   end
-
 end

data/lib/railgun/message.rb

@@ -11,7 +11,8 @@ module Mail
     attr_accessor :mailgun_variables,
                   :mailgun_options,
                   :mailgun_recipient_variables,
-                  :mailgun_headers
+                  :mailgun_headers,
+                  :mailgun_template_variables
 
   end
 end

data/lib/railgun/railtie.rb

@@ -2,8 +2,9 @@ require 'railgun/mailer'
 
 module Railgun
   class Railtie < ::Rails::Railtie
-    config.before_configuration do
-      ActionMailer::Base.add_delivery_method :mailgun, Railgun::Mailer
+    ActiveSupport.on_load(:action_mailer) do
+      add_delivery_method :mailgun, Railgun::Mailer
+      ActiveSupport.run_load_hooks(:mailgun_mailer, Railgun::Mailer)
     end
   end
 end

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,21 +17,24 @@ 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)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0.0'
-
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'webmock', '~> 1.22'
-  spec.add_development_dependency 'pry', '~> 0.9'
-  spec.add_development_dependency 'vcr', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.11'
-  spec.add_development_dependency "rails"
-  spec.add_dependency 'rest-client', '~> 2.0'
+  spec.required_ruby_version = '>= 2.2.2'
+
+  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.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'
+  spec.add_development_dependency 'rails'
+  spec.add_dependency 'rest-client', '>= 2.0.2'
 
 end

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"]
@@ -19,7 +19,7 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     res = @mg_obj.parse(@all_addrs)
 
     expect(res["parsed"]).to eq(@valid)
-    expect(res["unparseable"]).to eq(@invalid)
+    expect(res["unparsable"]).to eq(@invalid)
   end
 
   it 'validates alice@mailgun.net with info' do
@@ -28,7 +28,11 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     expected = {
         "address" => "alice@mailgun.net",
         "did_you_mean" => nil,
+        "is_disposable_address" => false,
+        "is_role_address" => false,
         "is_valid" => true,
+        "mailbox_verification" => "true",
+        "reason" => nil,
         "parts" => {
             "display_name" => nil,
             "domain" => "mailgun.net",
@@ -50,7 +54,11 @@ describe 'For the email validation endpoint', order: :defined, vcr: vcr_opts do
     expected = {
         "address" => "example.org",
         "did_you_mean" => nil,
+        "is_disposable_address" => false,
+        "is_role_address" => false,
         "is_valid" => false,
+        "mailbox_verification" => "unknown",
+        "reason" => "Validation failed for 'example.org', reason: 'malformed address; missing @ sign'",
         "parts" => {
             "display_name" => nil,
             "domain" => nil,

data/spec/integration/events_spec.rb

@@ -22,7 +22,7 @@ describe 'For the Events endpoint', vcr: vcr_opts do
 
   it 'can iterate over all events with `each`' do
     @events.each do |e|
-      expect(e.id).to eq("JAx9z641TuGGUyaJlD9sCQ")
+      expect(e["id"]).to eq("JAx9z641TuGGUyaJlD9sCQ")
     end
   end
 end

data/spec/integration/mailer_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require 'json'
+require 'logger'
+require 'railgun'
+require 'mailgun'
+require 'mailgun/exceptions/exceptions'
+
+ActionMailer::Base.raise_delivery_errors = true
+Rails.logger = Logger.new('/dev/null')
+Rails.logger.level = Logger::DEBUG
+
+class UnitTestMailer < ActionMailer::Base
+  default from: 'unittest@example.org'
+
+  def plain_message(address, from, subject, headers)
+    headers(headers)
+    mail(to: address, from: from, subject: subject) do |format|
+      format.text { render plain: 'Test!' }
+      format.html { render html: '<p>Test!</p>'.html_safe }
+    end
+  end
+end
+
+vcr_opts = { :cassette_name => 'message_deliver' }
+
+describe 'Message deliver', vcr: vcr_opts do
+  let(:domain) { TESTDOMAIN }
+  let(:config) do
+    {
+      api_key: APIKEY,
+      domain: domain
+    }
+  end
+  let(:mail) { UnitTestMailer.plain_message("bob@#{domain}", "bob@#{domain}", 'subject', {}) }
+
+  it 'successfully delivers message' do
+    result = Railgun::Mailer.new(config).deliver!(mail)
+    result.to_h!
+
+    expect(result.body['message']).to eq('Queued. Thank you.')
+    expect(result.body).to include('id')
+    expect(result.code).to eq(200)
+  end
+end
+
+vcr_opts = { :cassette_name => 'mailer_invalid_domain' }
+
+describe 'Invalid domain', vcr: vcr_opts do
+  let(:domain) { 'not-our-doma.in' }
+  let(:config) do
+    {
+      api_key: APIKEY,
+      domain: domain
+    }
+  end
+  let(:mail) { UnitTestMailer.plain_message("bob@#{domain}", 'sally@not-our-doma.in' 'subject', {}) }
+
+  it 'raises expected error' do
+
+    Railgun::Mailer.new(config).deliver!(mail)
+  rescue Mailgun::CommunicationError => err
+    expect(err.message).to eq('401 Unauthorized: Forbidden - Invalid Domain or API key')
+  else
+    fail
+
+  end
+end

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
@@ -63,6 +135,9 @@ describe 'The method send_message()', vcr: vcr_opts do
              :to => "bob@#{@domain}",
              :subject => "Test",
              :text => "Test Data" }
+    uuid = 'uuid'
+
+    allow(SecureRandom).to receive(:uuid).and_return(uuid)
 
     result = @mg_obj.send_message(@domain, data)
 
@@ -72,7 +147,7 @@ describe 'The method send_message()', vcr: vcr_opts do
     expect(result.body).to include("id")
 
     expect(result.code).to eq(200)
-    expect(result.body['id']).to eq("test-mode-mail@localhost")
+    expect(result.body['id']).to eq("test-mode-mail-#{uuid}@localhost")
     expect(result.body['message']).to eq("Queued. Thank you.")
   end
 
@@ -117,5 +192,21 @@ Testing some Mailgun awesomness!'
     expect(result.body).to include("message")
     expect(result.body).to include("id")
   end
+  
+  it 'receives success response code' do
+    @mg_obj.enable_test_mode!
+
+    expect(@mg_obj.test_mode?).to eq(true)
+
+    data = { :from => "joe@#{@domain}",
+             :to => "bob@#{@domain}",
+             :subject => "Test",
+             :text => "Test Data" }
+
+    result = @mg_obj.send_message(@domain, data)
+    result.to_h!
+    
+    expect(result.success?).to be(true)
+  end
 end
 

data/spec/integration/subaccounts_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "subaccounts" }
+
+describe 'For the subaccounts endpoints', vcr: vcr_opts do
+  let(:name) { 'test.subaccount' }
+  let(:subaccount_id) { 'xxx' }
+
+  before(:all) do
+    mg_client = Mailgun::Client.new(APIKEY, APIHOST, 'v5')
+    @mg_obj = Mailgun::Subaccounts.new mg_client
+  end
+
+  describe '#list' do
+    it 'returns a list of templates' do
+      result = @mg_obj.list
+
+      expect(result).to eq({"subaccounts"=>[{"id"=>"xxx", "name"=>"test-ruby-lib", "status"=>"open"}], "total"=>1})
+    end
+  end
+
+  describe '#create' do
+    it 'creates the subaccount' do
+      result = @mg_obj.create(name)
+
+      expect(result).to eq({"subaccount"=>{"id"=>"xxx", "name"=>"test.subaccount", "status"=>"open"}})
+    end
+  end
+
+
+  describe '#info' do
+    it 'gets the templates info' do
+      result = @mg_obj.info(subaccount_id)
+
+      expect(result).to eq({"subaccount"=>{"id"=>"xxx", "name"=>"test-ruby-lib", "status"=>"open"}})
+    end
+  end
+
+
+
+  describe '#enable' do
+    it 'enables the subaccount' do
+      result = @mg_obj.enable(subaccount_id)
+
+      expect(result).to eq({"subaccount"=>{"id"=>"xxx", "name"=>"test-ruby-lib", "status"=>"open"}})
+    end
+  end
+
+  describe '#disable' do
+    it 'disables the subaccount' do
+      result = @mg_obj.disable(subaccount_id)
+
+      expect(result).to eq({"subaccount"=>{"id"=>"xxx", "name"=>"test-ruby-lib", "status"=>"disabled"}})
+    end
+  end
+
+end

data/spec/integration/suppressions_spec.rb

@@ -52,7 +52,7 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
     end
   end
 
-  it 'can batch-add unsubscribes' do
+  it 'can batch-add unsubscribes with tags as string' do
     unsubscribes = []
     @addresses.each do |addr|
       unsubscribes.push({
@@ -69,6 +69,23 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
     expect(nested.length).to eq(0)
   end
 
+  it 'can batch-add unsubscribes with tags as array' do
+    unsubscribes = []
+    @addresses.each do |addr|
+      unsubscribes.push({
+        :address => addr,
+        :tags => ['integration'],
+      })
+    end
+
+    response, nested = @suppress.create_unsubscribes unsubscribes
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the unsubscribes table')
+    expect(nested.length).to eq(0)
+  end
+
   it 'raises ParameterError if no unsubscribe[:address] is present' do
     unsubscribes = []
     unsubscribes.push({
@@ -123,4 +140,3 @@ describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts d
 
   # TODO: Add tests for pagination support.
 end
-