mailgunner 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16c8da4bf004d3e8b0ce0b398815294a6d5e801d
-  data.tar.gz: c2fa0a69df8ec9a64648dd3a8979d0bef4bbb593
+  metadata.gz: c1e24be43e9330f9378bbd977baabea868042090
+  data.tar.gz: 812d150cb717e63be9e99b66c2c695981d711a7f
 SHA512:
-  metadata.gz: 7a6464e5137f28e412ba186dab76d85927b12e59362896a4e7cf9da57cffa02aa575d020221ab3f37154204432a4f03eb99c2390425a664d95d0c9bb0ccc645f
-  data.tar.gz: b7ca7c319178f0c893111a14778e1c4266d12d14b49fe514e47152489a61ed5e1328fc00e7cecc4fe578110cd3edbd4819b554782b9cc41b3644705fd52e5e89
+  metadata.gz: 00d1306a5501800bfdc87ec29c9244dd232cd126c87ce7c35a5773100336be0afc4d3cf2c166bfc2b31189e59c71d280328be005b24c83ebda8c2163db2d4ee0
+  data.tar.gz: 06664445a8ece38b1dee4bc92850867ac1a098f2aa212ce6be0341ba962dec6838e9d04783157325f7a7838d04cefbe02a7d31def684c3da6a2e52e69c43630a

data/README.md

@@ -26,8 +26,8 @@ response = mailgun.get_stats(limit: 5)
 ```
 
 
-Environment variables
----------------------
+Storing the API key
+-------------------
 
 Best practice for storing credentials for external services is to use environment
 variables, as described by [12factor.net/config](http://www.12factor.net/config).
@@ -36,10 +36,24 @@ from the MAILGUN_API_KEY and MAILGUN_SMTP_LOGIN environment variables. These wil
 exist if you are using Mailgun on Heroku, or you can set them manually.
 
 
+ActionMailer integration
+------------------------
+
+Mailgunner integrates with [ActionMailer](https://rubygems.org/gems/actionmailer).
+If you are using Rails, you can use Mailgunner to send mail via Mailgun by adding
+the following line to `config/environments/production.rb`:
+
+```ruby
+config.action_mailer.delivery_method = :mailgun
+````
+
+Outside of Rails you can set `ActionMailer::Base.delivery_method` directly.
+
+
 Email validation
 ----------------
 
-If you only need [email validation](http://documentation.mailgun.com/api-email-validation.html),
+If you only need to use Mailgun's [email address validation service](http://documentation.mailgun.com/api-email-validation.html),
 you can instead use your Mailgun public key to authenticate like this:
 
 ```ruby

data/lib/mailgunner.rb

@@ -1,16 +1,28 @@
 require 'net/http'
 require 'json'
 require 'cgi'
-require 'mailgunner/delivery_method' if defined?(ActionMailer)
+require 'mailgunner/delivery_method' if defined?(Mail)
 
 module Mailgunner
   class Error < StandardError; end
 
+  module NoDomainProvided
+    def self.to_s
+      raise Error, 'No domain provided'
+    end
+  end
+
   class Client
     attr_accessor :domain, :api_key, :http
 
     def initialize(options = {})
-      @domain = options.fetch(:domain) { ENV['MAILGUN_SMTP_LOGIN'].to_s.split('@').last }
+      @domain = if options.key?(:domain)
+        options.fetch(:domain)
+      elsif ENV.key?('MAILGUN_SMTP_LOGIN')
+        ENV['MAILGUN_SMTP_LOGIN'].to_s.split('@').last
+      else
+        NoDomainProvided
+      end
 
       @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
 

data/lib/mailgunner/delivery_method.rb

@@ -7,13 +7,7 @@ module Mailgunner
     attr_accessor :settings
 
     def initialize(values)
-      @settings = values
-
-      @client = if @settings.has_key?(:domain)
-        Client.new(domain: @settings[:domain])
-      else
-        Client.new
-      end
+      @client = Client.new(values)
     end
 
     def deliver!(mail)
@@ -23,5 +17,7 @@ module Mailgunner
     end
   end
 
-  ActionMailer::Base.add_delivery_method :mailgun, DeliveryMethod
+  if defined?(ActionMailer)
+    ActionMailer::Base.add_delivery_method :mailgun, DeliveryMethod
+  end
 end

data/mailgunner.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'mailgunner'
-  s.version = '2.0.0'
+  s.version = '2.1.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']

data/spec/mailgunner_delivery_method_spec.rb

@@ -24,9 +24,7 @@ describe 'Mailgunner::DeliveryMethod' do
 
     ActionMailer::Base.delivery_method = :mailgun
 
-    ENV['MAILGUN_API_KEY'] = @api_key
-
-    ENV['MAILGUN_SMTP_LOGIN'] = "postmaster@#@domain"
+    ActionMailer::Base.mailgun_settings = {api_key: @api_key, domain: @domain}
   end
 
   it 'delivers the mail to mailgun in mime format' do
@@ -46,14 +44,4 @@ describe 'Mailgunner::DeliveryMethod' do
 
     exception.message.must_include('Invalid API key')
   end
-
-  it 'allows the domain to be specified explicitly via the delivery method settings' do
-    stub_request(:post, "#@base_url/app123.mailgun.org/messages.mime")
-
-    ActionMailer::Base.mailgun_settings = {domain: 'app123.mailgun.org'}
-
-    ExampleMailer.registration_confirmation(email: @address).deliver
-
-    ActionMailer::Base.mailgun_settings = {}
-  end
 end

data/spec/mailgunner_spec.rb

@@ -42,12 +42,8 @@ describe 'Mailgunner::Client' do
       ENV['MAILGUN_SMTP_LOGIN'] = 'postmaster@samples.mailgun.org'
 
       Mailgunner::Client.new(api_key: @api_key).domain.must_equal(@domain)
-    end
 
-    it 'defaults to nil if the MAILGUN_SMTP_LOGIN environment variable does not exist' do
       ENV.delete('MAILGUN_SMTP_LOGIN')
-
-      Mailgunner::Client.new(api_key: @api_key).domain.must_be_nil
     end
   end
 
@@ -60,6 +56,8 @@ describe 'Mailgunner::Client' do
       ENV['MAILGUN_API_KEY'] = @api_key
 
       Mailgunner::Client.new(domain: @domain).api_key.must_equal(@api_key)
+
+      ENV.delete('MAILGUN_API_KEY')
     end
   end
 
@@ -92,6 +90,13 @@ describe 'Mailgunner::Client' do
       @client.send_message({to: @address})
     end
 
+    it 'raises an exception if the domain is not provided' do
+      @client = Mailgunner::Client.new(api_key: @api_key)
+
+      exception = proc { @client.send_message({}) }.must_raise(Mailgunner::Error)
+      exception.message.must_include('No domain provided')
+    end
+
     it 'encodes the message attributes as multipart form data when sending attachments' do
       # TODO
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailgunner
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Tim Craft
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2015-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake