mailgun-ruby 1.1.2 → 1.2.4

data/spec/unit/railgun/mailer_spec.rb

@@ -0,0 +1,242 @@
+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 'accepts frozen options to message body' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_options ||= {
+      'tags' => ['some-tag']
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+
+    expect(body).to include('o:tags')
+    expect(body['o:tags']).to eq(['some-tag'])
+  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
+
+  it 'ignores `reply-to` in headers' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'reply-to' => 'user@example.com',
+    })
+    message.mailgun_headers = {
+      'Reply-To' => 'administrator@example.org',
+    }
+    message.headers({'REPLY-TO' => 'admin@example.net'})
+    message.reply_to = "dude@example.com.au"
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:reply-to')
+    expect(body).not_to include('h:Reply-To')
+    expect(body['h:reply-to']).to eq('dude@example.com.au')
+  end
+
+  it 'ignores `mime-version` in headers' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'mime-version' => '1.0',
+    })
+    message.mailgun_headers = {
+      'Mime-Version' => '1.1',
+    }
+    message.headers({'MIME-VERSION' => '1.2'})
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).not_to include('h:mime-version')
+  end
+
+  it 'treats `headers()` names as case-insensitve' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {
+      'X-BIG-VALUE' => 1,
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:x-big-value')
+    expect(body['h:x-big-value']).to eq("1")
+  end
+
+  it 'treats `mailgun_headers` names as case-insensitive' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.mailgun_headers = {
+      'X-BIG-VALUE' => 1,
+    }
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:x-big-value')
+    expect(body['h:x-big-value']).to eq("1")
+  end
+
+  it 'handles multi-value, mixed case headers correctly' do
+    message = UnitTestMailer.plain_message('test@example.org', '', {})
+    message.headers({
+      'x-neat-header' => 'foo',
+      'X-Neat-Header' => 'bar',
+      'X-NEAT-HEADER' => 'zoop',
+    })
+
+    body = Railgun.transform_for_mailgun(message)
+    expect(body).to include('h:x-neat-header')
+    expect(body['h:x-neat-header']).to include('foo')
+    expect(body['h:x-neat-header']).to include('bar')
+    expect(body['h:x-neat-header']).to include('zoop')
+  end
+end

data/vcr_cassettes/email_validation.yml

@@ -2,13 +2,13 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api:<PUBKEY>@api.mailgun.net/v3/address/parse?addresses=Alice%20%3Calice@example.com%3E%3Bbob@example.com%3Bexample.org&syntax_only=true
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/parse?addresses=Alice%20%3Calice@example.com%3E%3Bbob@example.com%3Bexample.org&syntax_only=true
     body:
       encoding: US-ASCII
       string: ''
     headers:
       Accept:
-      - "*/*"
+      - '*/*'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -33,7 +33,7 @@ http_interactions:
       Content-Disposition:
       - inline
       Access-Control-Allow-Origin:
-      - "*"
+      - '*'
       Access-Control-Max-Age:
       - '600'
       Access-Control-Allow-Methods:
@@ -56,13 +56,13 @@ http_interactions:
   recorded_at: Wed, 26 Oct 2016 22:44:50 GMT
 - request:
     method: get
-    uri: https://api:<PUBKEY>@api.mailgun.net/v3/address/validate?address=alice@mailgun.net
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/validate?address=alice@mailgun.net
     body:
       encoding: US-ASCII
       string: ''
     headers:
       Accept:
-      - "*/*"
+      - '*/*'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -87,7 +87,7 @@ http_interactions:
       Content-Disposition:
       - inline
       Access-Control-Allow-Origin:
-      - "*"
+      - '*'
       Access-Control-Max-Age:
       - '600'
       Access-Control-Allow-Methods:
@@ -111,13 +111,13 @@ http_interactions:
   recorded_at: Wed, 26 Oct 2016 22:44:50 GMT
 - request:
     method: get
-    uri: https://api:<PUBKEY>@api.mailgun.net/v3/address/validate?address=example.org
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/validate?address=example.org
     body:
       encoding: US-ASCII
       string: ''
     headers:
       Accept:
-      - "*/*"
+      - '*/*'
       Accept-Encoding:
       - gzip, deflate
       User-Agent:
@@ -142,7 +142,7 @@ http_interactions:
       Content-Disposition:
       - inline
       Access-Control-Allow-Origin:
-      - "*"
+      - '*'
       Access-Control-Max-Age:
       - '600'
       Access-Control-Allow-Methods:
@@ -164,4 +164,52 @@ http_interactions:
         }
     http_version: 
   recorded_at: Wed, 26 Oct 2016 22:44:50 GMT
+- request:
+    method: get
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/address/validate?address=alice@mailgun.net&mailbox_verification=true
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - '*/*'
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin16.7.0 x86_64) ruby/2.0.0p0
+      Host:
+      - api.mailgun.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type, x-requested-with
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Max-Age:
+      - '600'
+      Content-Disposition:
+      - inline
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 12 Sep 2017 16:55:09 GMT
+      Server:
+      - nginx
+      Content-Length:
+      - '243'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: '{"address": "alice@mailgun.net", "did_you_mean": null, "is_disposable_address":
+        false, "is_role_address": false, "is_valid": true, "mailbox_verification":
+        "true", "parts": {"display_name": null, "domain": "mailgun.net", "local_part":
+        "alice"}}'
+    http_version: 
+  recorded_at: Tue, 12 Sep 2017 16:55:09 GMT
 recorded_with: VCR 3.0.3

data/vcr_cassettes/events.yml

@@ -58,4 +58,51 @@ http_interactions:
         \ }\n}"
     http_version: 
   recorded_at: Thu, 07 Jan 2016 22:08:06 GMT
-recorded_with: VCR 3.0.1
+- request:
+    method: get
+    uri: https://api:<APIKEY>@api.mailgun.net/v3/DOMAIN.TEST/events
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.1 (linux-gnu x86_64) ruby/2.3.3p222
+      Host:
+      - api.mailgun.net
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type, x-requested-with
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '600'
+      Content-Type:
+      - application/json
+      Date:
+      - Wed, 10 May 2017 20:06:54 GMT
+      Server:
+      - nginx
+      Content-Length:
+      - '2060'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "{\n  \"items\": [], \n  \"paging\": {\n    \"next\": \"https://api.mailgun.net/v3/DOMAIN.TEST/events/W3siYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIHsiYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIFsiZiJdLCBudWxsLCBbWyJhY2NvdW50LmlkIiwgIjU4MDUyMTg2NzhmYTE2MTNjNzkwYjUwZiJdLCBbImRvbWFpbi5uYW1lIiwgInNhbmRib3gyOTcwMTUyYWYzZDM0NTU5YmZjN2U3MTcwM2E2Y2YyNC5tYWlsZ3VuLm9yZyJdXSwgMTAwLCBudWxsXQ==\",
+        \n    \"last\": \"https://api.mailgun.net/v3/DOMAIN.TEST/events/W3siYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIHsiYiI6ICIyMDE3LTA1LTA4VDIwOjA2OjU0LjU3NyswMDowMCIsICJlIjogIjIwMTctMDUtMTBUMjA6MDY6NTQuNTc2KzAwOjAwIn0sIFsicCIsICJmIl0sIG51bGwsIFtbImFjY291bnQuaWQiLCAiNTgwNTIxODY3OGZhMTYxM2M3OTBiNTBmIl0sIFsiZG9tYWluLm5hbWUiLCAic2FuZGJveDI5NzAxNTJhZjNkMzQ1NTliZmM3ZTcxNzAzYTZjZjI0Lm1haWxndW4ub3JnIl1dLCAxMDAsIG51bGxd\",
+        \n    \"first\": \"https://api.mailgun.net/v3/DOMAIN.TEST/events/W3siYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIHsiYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIFsiZiJdLCBudWxsLCBbWyJhY2NvdW50LmlkIiwgIjU4MDUyMTg2NzhmYTE2MTNjNzkwYjUwZiJdLCBbImRvbWFpbi5uYW1lIiwgInNhbmRib3gyOTcwMTUyYWYzZDM0NTU5YmZjN2U3MTcwM2E2Y2YyNC5tYWlsZ3VuLm9yZyJdXSwgMTAwLCBudWxsXQ==\",
+        \n    \"previous\": \"https://api.mailgun.net/v3/DOMAIN.TEST/events/W3siYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMDhUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIHsiYiI6ICIyMDE3LTA1LTEwVDIwOjA2OjU0LjU3NiswMDowMCIsICJlIjogIjIwMTctMDUtMTBUMjA6MDY6NTQuNTc3KzAwOjAwIn0sIFsicCIsICJmIl0sIG51bGwsIFtbImFjY291bnQuaWQiLCAiNTgwNTIxODY3OGZhMTYxM2M3OTBiNTBmIl0sIFsiZG9tYWluLm5hbWUiLCAic2FuZGJveDI5NzAxNTJhZjNkMzQ1NTliZmM3ZTcxNzAzYTZjZjI0Lm1haWxndW4ub3JnIl1dLCAxMDAsIG51bGxd\"\n
+        \ }\n}"
+    http_version: 
+  recorded_at: Wed, 10 May 2017 20:06:54 GMT
+recorded_with: VCR 3.0.3