mailgun-ruby 1.2.0 → 1.2.10

data/spec/unit/railgun/mailer_spec.rb

@@ -31,6 +31,18 @@ class UnitTestMailer < ActionMailer::Base
     end
   end
 
+  def message_with_template(address, subject, template_name)
+    mail(to: address, subject: subject, template: template_name) do |format|
+      format.text { render plain: "Test!" }
+    end
+  end
+
+  def message_with_domain(address, subject, domain)
+    mail(to: address, subject: subject, domain: domain) do |format|
+      format.text { render plain: "Test!" }
+    end
+  end
+
 end
 
 describe 'Railgun::Mailer' do
@@ -45,6 +57,31 @@ describe 'Railgun::Mailer' do
     expect(@mailer_obj.mailgun_client).to be_a(Mailgun::Client)
   end
 
+  context 'when config does not have api_key or domain' do
+    it 'raises configuration error' do
+      config = {
+        api_key:  {}
+      }
+
+    expect { Railgun::Mailer.new(config) }.to raise_error(Railgun::ConfigurationError)
+    end
+  end
+
+  context 'when fake_message_send is present in config' do
+    it 'enables test mode' do
+      config = {
+        api_key:  {},
+        domain:   {},
+        fake_message_send: true
+      }
+      client_double = double(Mailgun::Client)
+      allow(Mailgun::Client).to receive(:new).and_return(client_double)
+      expect(client_double).to receive(:enable_test_mode!)
+
+      Railgun::Mailer.new(config)
+    end
+  end
+
   it 'properly creates a message body' do
     message = UnitTestMailer.plain_message('test@example.org', 'Test!', {})
     body = Railgun.transform_for_mailgun(message)
@@ -72,6 +109,18 @@ describe 'Railgun::Mailer' do
     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 ||= {
@@ -145,6 +194,43 @@ describe 'Railgun::Mailer' do
     expect(body['h:x-source']).to eq('unit tests')
   end
 
+  context 'when mailgun_variables are present' do
+    it 'accepts valid JSON and stores it as message[param].' do
+      message = UnitTestMailer.plain_message('test@example.org', '', {}).tap do |message|
+        message.mailgun_variables = {
+          'my-data' => '{"key":"value"}'
+        }
+      end
+      body = Railgun.transform_for_mailgun(message)
+      expect(body["v:my-data"]).to be_kind_of(String)
+      expect(body["v:my-data"].to_s).to eq('{"key":"value"}')
+    end
+
+    it 'accepts a hash and appends as data to the message.' do
+      message = UnitTestMailer.plain_message('test@example.org', '', {}).tap do |message|
+        message.mailgun_variables = {
+          'my-data' => {'key' => 'value'}
+        }
+      end
+      body = Railgun.transform_for_mailgun(message)
+
+      expect(body["v:my-data"]).to be_kind_of(String)
+      expect(body["v:my-data"].to_s).to eq('{"key":"value"}')
+    end
+
+    it 'accepts string values' do
+      message = UnitTestMailer.plain_message('test@example.org', '', {}).tap do |message|
+        message.mailgun_variables = {
+          'my-data' => 'String Value.'
+        }
+      end
+      body = Railgun.transform_for_mailgun(message)
+
+      expect(body["v:my-data"]).to be_kind_of(String)
+      expect(body["v:my-data"].to_s).to eq('String Value.')
+    end
+  end
+
   it 'properly adds attachments' do
     message = UnitTestMailer.message_with_attachment('test@example.org', '')
     body = Railgun.transform_for_mailgun(message)
@@ -179,6 +265,19 @@ describe 'Railgun::Mailer' do
     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,
@@ -214,4 +313,76 @@ describe 'Railgun::Mailer' do
     expect(body['h:x-neat-header']).to include('bar')
     expect(body['h:x-neat-header']).to include('zoop')
   end
+
+  context 'when message with template' do
+    it 'adds template header to message from mailer params' do
+      template_name = 'template.name'
+      message = UnitTestMailer.message_with_template('test@example.org', '', template_name)
+
+      body = Railgun.transform_for_mailgun(message)
+
+      expect(body).to include('template')
+      expect(body['template']).to eq(template_name)
+    end
+
+    context 'when mailgun_template_variables are assigned' do
+      it 'adds template variables to message body' do
+        message = UnitTestMailer.message_with_template('test@example.org', '', 'template.name')
+        version = 'version_1'
+        message.mailgun_template_variables ||= {
+          'version' => version,
+          'text' => 'yes'
+        }
+
+        body = Railgun.transform_for_mailgun(message)
+
+        expect(body).to include('t:version')
+        expect(body['t:version']).to eq('version_1')
+        expect(body).to include('t:text')
+        expect(body['t:text']).to eq('yes')
+      end
+    end
+  end
+
+  describe 'deliver!' do
+    let(:config) do
+      {
+        api_key: 'api_key',
+        domain: 'domain'
+      }
+    end
+    let(:mail) { UnitTestMailer.plain_message('test@example.org', '', {}) }
+    let(:response) do
+      response = Struct.new(:code, :id)
+      response.new(200, rand(50..100))
+    end
+
+    it 'initiates client message send' do
+      result = { from: 'test@example.org' }
+      allow(Railgun).to receive(:transform_for_mailgun).and_return(result)
+
+      expect_any_instance_of(Mailgun::Client).to receive(:send_message)
+        .with(config[:domain], result)
+        .and_return(response)
+      Railgun::Mailer.new(config).deliver!(mail)
+    end
+
+    it 'returns response' do
+      expect_any_instance_of(Mailgun::Client).to receive(:send_message).and_return(response)
+      expect(Railgun::Mailer.new(config).deliver!(mail)).to eq(response)
+    end
+
+    context 'when domain is provided in arguments' do
+      let(:new_domain) { 'new_domain' }
+      let(:mail) { UnitTestMailer.message_with_domain('test@example.org', '', new_domain) }
+
+      it 'uses provided domain' do
+        result = { from: 'test@example.org' }
+        allow(Railgun).to receive(:transform_for_mailgun).and_return(result)
+        expect_any_instance_of(Mailgun::Client).to receive(:send_message)
+          .with(new_domain, result).and_return(response)
+        Railgun::Mailer.new(config).deliver!(mail)
+      end
+    end
+  end
 end

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

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

data/vcr_cassettes/mailer_invalid_domain.yml

@@ -0,0 +1,109 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mailgun.net/v3/not-our-doma.in/messages
+    body:
+      encoding: US-ASCII
+      string: from[]=sally%40not-our-doma.in&subject[]=subject&html[]=%3Cp%3ETest%21%3C%2Fp%3E&text[]=Test%21&to[]=bob%40DOMAIN.TEST&h%3Acontent-type=multipart%2Falternative%3B+boundary%3D%22--%3D%3D_mimepart_6098fb5a12edf_78633ff4e00521889696a%22%3B+charset%3DUTF-8
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin18.7.0 x86_64) ruby/2.2.2p95
+      Content-Length:
+      - '262'
+      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: 401
+      message: UNAUTHORIZED
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type, x-requested-with, Authorization
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '600'
+      Cache-Control:
+      - no-store
+      Content-Type:
+      - text/html; charset=utf-8
+      Date:
+      - Mon, 10 May 2021 09:22:34 GMT
+      Server:
+      - nginx
+      Www-Authenticate:
+      - Basic realm="MG API"
+      Content-Length:
+      - '9'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Forbidden
+    http_version:
+  recorded_at: Mon, 10 May 2021 09:22:34 GMT
+- request:
+    method: post
+    uri: https://api.mailgun.net/v3/not-our-doma.in/messages
+    body:
+      encoding: US-ASCII
+      string: from[]=sally%40not-our-doma.in&subject[]=subject&html[]=%3Cp%3ETest%21%3C%2Fp%3E&text[]=Test%21&to[]=bob%40DOMAIN.TEST&h%3Acontent-type=multipart%2Falternative%3B+boundary%3D%22--%3D%3D_mimepart_6098fb5a12edf_78633ff4e00521889696a%22%3B+charset%3DUTF-8
+    headers:
+      Accept:
+      - "*/*"
+      User-Agent:
+      - rest-client/2.1.0 (darwin18.7.0 x86_64) ruby/2.2.2p95
+      Content-Length:
+      - '262'
+      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: 401
+      message: UNAUTHORIZED
+    headers:
+      Access-Control-Allow-Headers:
+      - Content-Type, x-requested-with, Authorization
+      Access-Control-Allow-Methods:
+      - GET, POST, PUT, DELETE, OPTIONS
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Max-Age:
+      - '600'
+      Cache-Control:
+      - no-store
+      Content-Type:
+      - text/html; charset=utf-8
+      Date:
+      - Mon, 10 May 2021 09:22:40 GMT
+      Server:
+      - nginx
+      Www-Authenticate:
+      - Basic realm="MG API"
+      Content-Length:
+      - '9'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: Forbidden
+    http_version:
+  recorded_at: Mon, 10 May 2021 09:22:40 GMT
+recorded_with: VCR 3.0.3