mailgun-ruby 1.1.10 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e88262b939edf330c91ac551b2f5945e4f4e5825f734bef28a7455cc2ec2dcc
-  data.tar.gz: 4bfffa2ae623704dcef2754a040fccc3a5efbbe8ee6e761e473215fbfcade5b8
+  metadata.gz: 3e1995893ce0728f97a28d1b563b4169169d3e871b6c315da1dc0d76cec17d6a
+  data.tar.gz: 383bea571efa4bde52d6c6204ee2b3f477aa3d90ed1eef54a483d98b62a081e4
 SHA512:
-  metadata.gz: c8b5a20d3cf98827f101e5e06f563e605a80a626f2d4e5f4147f908d955e13926e3f2995db6bfbeb26b8ff343618104f2d83f298c808416362f4c0cae7a2d9ec
-  data.tar.gz: 7bb9a9085b738d2cb0bd8bc57f176928d7eb54bf09a190bfd6fc0d21ae526a0f72b70970c2bd19a9aa899401cc3bce1d591089a14aa7ec324b94758b2ed3caa0
+  metadata.gz: b6e4b5d442810888c03ec4ad214fd896d1198ef8d36f1ad2f92ff3895a02eff39e27fc9b78f8c6050bff75e374fe1e29595d86a50258fad778de766bfef15ec9
+  data.tar.gz: 4665963f9b08fc5ff8143d3eda4618825c7abf9dfc2ced3ff4962618cfcd98125fc809e326c9a45ad0517b08ed711ee62f82ffce38baac205be9b87b59085bbd

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -77,6 +77,21 @@ and replace `api-myapikey` and `mydomain.com` with your secret API key and domai
   }
 ```
 
+To specify Mailgun options such as campaign or tags:
+```ruby
+class UserMailer < ApplicationMailer
+  def welcome_email
+    mail(to: params[:to], subject: "Welcome!").tap do |message|
+      message.mailgun_options = {
+        "tag" => ["abtest-option-a", "beta-user"],
+        "tracking-opens" => true,
+        "tracking-clicks" => "htmlonly"
+      }
+    end
+  end
+end   
+```
+
 To get the Mailgun `message_id` after ActionMailer has successfully delivered the email:
 
 ```ruby

data/docs/railgun/Overview.md

@@ -0,0 +1,11 @@
+Overview
+========
+
+Railgun is a Rails add-on that allows ActionMailer to send via the Mailgun API.
+
+See [railgun-sample](https://github.com/pirogoeth/railgun-sample/) for examples of integrating Railgun with your Rails app.
+
+
+## Table of Contents
+
+- [Parameters](/docs/railgun/Parameters.md)

data/docs/railgun/Parameters.md

@@ -0,0 +1,83 @@
+Parameters
+==========
+
+When sending messages via Railgun, it is often useful to set options, headers, and variables
+that should be added to the `POST` request against the messages endpoint.
+
+
+## Options
+
+See [Mailgun Docs | Sending](https://documentation.mailgun.com/en/latest/api-sending.html#sending) for available options.
+
+---
+
+To set options on a message:
+
+```ruby
+# app/controllers/some_controller.rb
+
+message = YourMailer.your_message(@args)
+
+message.mailgun_options ||= {
+  "tracking-opens" => "true",
+  "tracking-clicks" => "htmlonly",
+  "tag" => "some,tags",
+}
+```
+
+
+## Variables
+
+See [Mailgun Docs | Attaching Data to Messages](https://documentation.mailgun.com/en/latest/user_manual.html#attaching-data-to-messages) for more information.
+
+---
+
+To set variables on a message:
+
+```ruby
+# app/controllers/some_controller.rb
+
+message = YourMailer.your_message(@args)
+
+message.mailgun_variables ||= {
+  "user_info" => {"id" => "1", "name" => "tstark"},
+}
+```
+
+
+## Headers
+
+See [Mailgun Docs | Sending](https://documentation.mailgun.com/en/latest/api-sending.html#sending) for more information.
+
+---
+
+To set headers on a message *from a controller*:
+
+```ruby
+# app/controllers/some_controller.rb
+
+message = YourMailer.your_message(@args)
+
+message.mailgun_headers ||= {
+  "X-Sent-From-Rails" => "true",
+}
+```
+
+To set headers on a message *from a mailer*:
+
+```ruby
+# app/mailers/your_mailer.rb
+
+class YourMailer < ApplicationMailer
+  # ...
+
+  def your_message(args)
+    headers({
+      "X-Sent-From-Rails" => "true",
+    })
+
+    mail to: "some-address@example.org", ...
+  end
+
+end
+```

data/lib/mailgun/client.rb

@@ -14,13 +14,15 @@ module Mailgun
                    api_host = 'api.mailgun.net',
                    api_version = 'v3',
                    ssl = true,
-                   test_mode = false)
+                   test_mode = false,
+                   timeout = nil)
 
       endpoint = endpoint_generator(api_host, api_version, ssl)
       @http_client = RestClient::Resource.new(endpoint,
                                               user: 'api',
                                               password: api_key,
-                                              user_agent: "mailgun-sdk-ruby/#{Mailgun::VERSION}")
+                                              user_agent: "mailgun-sdk-ruby/#{Mailgun::VERSION}",
+                                              timeout: timeout)
       @test_mode = test_mode
     end
 

data/lib/mailgun/version.rb

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

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 ]
+
     # [Hash] config ->
     #   Requires *at least* `api_key` and `domain` keys.
     attr_accessor :config, :domain, :settings
@@ -47,7 +51,7 @@ module Railgun
     end
 
     def mailgun_client
-      @mg_obj
+      @mg_client
     end
 
   end
@@ -66,7 +70,7 @@ module Railgun
 
     # v:* attributes (variables)
     mail.mailgun_variables.try(:each) do |k, v|
-      message["v:#{k}"] = v
+      message["v:#{k}"] = JSON.dump(v)
     end
 
     # o:* attributes (options)
@@ -74,8 +78,36 @@ module Railgun
       message["o:#{k}"] = v
     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|
+      msg_headers[k] = v
+    end
+
+    mail.header_fields.each do |field|
+      msg_headers[field.name] = field.value
+    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 +116,12 @@ module Railgun
 
     # reject blank values
     message.delete_if do |k, v|
-      v.nil? or (v.respond_to?(:empty) and v.empty?)
+      return 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

data/mailgun.gemspec

@@ -22,16 +22,16 @@ Gem::Specification.new do |spec|
   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.1'
+  spec.add_development_dependency 'webmock', '~> 3.4.2'
+  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/email_validation_spec.rb

@@ -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/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'base64'
 require 'bundler'
 require 'bundler/setup'
 Bundler.setup(:development)
@@ -37,9 +38,10 @@ TESTDOMAIN = envs['MAILGUN_TESTDOMAIN']
 VCR.configure do |c|
   c.cassette_library_dir = 'vcr_cassettes'
   c.hook_into :webmock
-  c.configure_rspec_metadata!
   c.default_cassette_options = { record: :new_episodes }
   c.filter_sensitive_data('<APIKEY>') { APIKEY }
   c.filter_sensitive_data('DOMAIN.TEST') { TESTDOMAIN }
   c.filter_sensitive_data('<PUBKEY>') { PUB_APIKEY }
+
+  c.configure_rspec_metadata!
 end

data/spec/unit/railgun/mailer_spec.rb

@@ -0,0 +1,166 @@
+require 'json'
+require 'logger'
+require 'spec_helper'
+require 'mailgun'
+require 'railgun'
+
+ActionMailer::Base.raise_delivery_errors = true
+ActionMailer::Base.delivery_method = :test
+Rails.logger = Logger.new('/dev/null')
+Rails.logger.level = Logger::DEBUG
+
+class UnitTestMailer < ActionMailer::Base
+  default from: 'unittest@example.org'
+
+  def plain_message(address, subject, headers)
+    headers(headers)
+    mail(to: address, subject: subject) do |format|
+      format.text { render plain: "Test!" }
+      format.html { render html: "<p>Test!</p>".html_safe }
+    end
+  end
+
+  def message_with_attachment(address, subject)
+    attachments['info.txt'] = {
+      :content => File.read('docs/railgun/Overview.md'),
+      :mime_type => 'text/plain',
+    }
+    mail(to: address, subject: subject) do |format|
+      format.text { render plain: "Test!" }
+      format.html { render html: "<p>Test!</p>".html_safe }
+    end
+  end
+
+end
+
+describe 'Railgun::Mailer' do
+
+  it 'has a mailgun_client property which returns a Mailgun::Client' do
+    config = {
+      api_key:  {},
+      domain:   {}
+    }
+    @mailer_obj = Railgun::Mailer.new(config)
+
+    expect(@mailer_obj.mailgun_client).to be_a(Mailgun::Client)
+  end
+
+  it 'properly creates a message body' do
+    message = UnitTestMailer.plain_message('test@example.org', 'Test!', {})
+    body = Railgun.transform_for_mailgun(message)
+
+    [:from, :subject, :text, :html, 'to'].each do |param|
+      expect(body).to include(param)
+    end
+
+    expect(body[:from][0].value).to eq('unittest@example.org')
+    expect(body['to']).to eq(['test@example.org'])
+    expect(body[:subject]).to eq(['Test!'])
+    expect(body[:text]).to eq(['Test!'])
+    expect(body[:html]).to eq(['<p>Test!</p>'.html_safe])
+  end
+
+  it 'adds options to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_options ||= {
+      'tracking-opens' => 'true',
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('o:tracking-opens')
+    expect(body['o:tracking-opens']).to eq('true')
+  end
+
+  it 'adds variables to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_variables ||= {
+      'user' => {:id => '1', :name => 'tstark'},
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('v:user')
+
+    var_body = JSON.load(body['v:user'])
+    expect(var_body).to include('id')
+    expect(var_body).to include('name')
+    expect(var_body['id']).to eq('1')
+    expect(var_body['name']).to eq('tstark')
+  end
+
+  it 'adds headers to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_headers ||= {
+      'X-Unit-Test' => 'true',
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('h:X-Unit-Test')
+    expect(body['h:X-Unit-Test']).to eq('true')
+  end
+
+  it 'adds headers to message body from mailer' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'X-Unit-Test-2' => 'true',
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('h:X-Unit-Test-2')
+    expect(body['h:X-Unit-Test-2']).to eq('true')
+  end
+
+  it 'properly handles headers that are passed as separate POST params' do
+    message = UnitTestMailer.plain_message('test@example.org', 'Test!', {
+      # `From`, `To`, and `Subject` are set on the envelope, so they should be ignored as headers
+      'From' => 'units@example.net',
+      'To' => 'user@example.com',
+      'Subject' => 'This should disappear',
+      # If `Bcc` or `Cc` are set as headers, they should be carried over as POST params, not headers
+      'Bcc' => ['list@example.org'],
+      'Cc' => ['admin@example.com'],
+      # This is an arbitrary header and should be carried over properly
+      'X-Source' => 'unit tests',
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+
+    ['From', 'To', 'Subject'].each do |header|
+      expect(body).not_to include("h:#{header}")
+    end
+
+    ['bcc', 'cc', 'to', 'h:X-Source'].each do |param|
+      expect(body).to include(param)
+    end
+
+    expect(body[:from][0].value).to eq('unittest@example.org')
+    expect(body['to']).to eq(['test@example.org'])
+    expect(body[:subject]).to eq(['Test!'])
+    expect(body[:text]).to eq(['Test!'])
+    expect(body[:html]).to eq(['<p>Test!</p>'.html_safe])
+    expect(body['bcc']).to eq(['list@example.org'])
+    expect(body['cc']).to eq(['admin@example.com'])
+    expect(body['h:X-Source']).to eq('unit tests')
+  end
+
+  it 'properly adds attachments' do
+    message = UnitTestMailer.message_with_attachment('test@example.org', '')
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include(:attachment)
+    attachment = body[:attachment][0]
+
+    expect(attachment.filename).to eq('info.txt')
+    expect(attachment.content_type).to eq('text/plain')
+  end
+
+  it 'delivers!' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.deliver_now
+
+    expect(ActionMailer::Base.deliveries).to include(message)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mailgun-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.11
 platform: ruby
 authors:
 - Mailgun
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-11 00:00:00.000000000 Z
+date: 2018-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,98 +17,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.16.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.16.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.1
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: 3.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.22'
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.11.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.11.3
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.16.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.16.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -129,14 +129,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.2
 description: Mailgun's Official Ruby SDK for interacting with the Mailgun API.
 email: support@mailgunhq.com
 executables: []
@@ -160,6 +160,8 @@ files:
 - docs/Snippets.md
 - docs/Suppressions.md
 - docs/Webhooks.md
+- docs/railgun/Overview.md
+- docs/railgun/Parameters.md
 - lib/mailgun-ruby.rb
 - lib/mailgun.rb
 - lib/mailgun/address.rb
@@ -207,7 +209,8 @@ files:
 - spec/unit/messages/sample_data/mailgun_icon.png
 - spec/unit/messages/sample_data/mime.txt
 - spec/unit/messages/sample_data/rackspace_logo.jpg
-- spec/unit/railgun_spec.rb
+- spec/unit/railgun/content_type_spec.rb
+- spec/unit/railgun/mailer_spec.rb
 - vcr_cassettes/bounces.yml
 - vcr_cassettes/complaints.yml
 - vcr_cassettes/domains.todo.yml
@@ -236,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -274,4 +277,5 @@ test_files:
 - spec/unit/messages/sample_data/mailgun_icon.png
 - spec/unit/messages/sample_data/mime.txt
 - spec/unit/messages/sample_data/rackspace_logo.jpg
-- spec/unit/railgun_spec.rb
+- spec/unit/railgun/content_type_spec.rb
+- spec/unit/railgun/mailer_spec.rb