mailgunner 1.2.0 → 1.3.0

data/README.md

@@ -37,7 +37,23 @@ Environment variables
 
 Best practice for storing credentials for external services is to use environment
 variables, as described by [12factor.net/config](http://www.12factor.net/config).
-
 Mailgunner::Client defaults to extracting the domain and api_key values it needs
 from the MAILGUN_API_KEY and MAILGUN_SMTP_LOGIN environment variables. These will
 exist if you are using Mailgun on Heroku, or you can set them manually.
+
+
+Email validation
+----------------
+
+If you only need [email validation](http://documentation.mailgun.com/api-email-validation.html),
+you can instead use your Mailgun public key to authenticate like this:
+
+```ruby
+require 'mailgunner'
+
+public_key = 'pubkey-5ogiflzbnjrljiky49qxsiozqef5jxp7'
+
+mailgun = Mailgunner::Client.new(api_key: public_key)
+
+response = mailgun.validate_address('john@gmail.com')
+```

data/lib/mailgunner.rb

@@ -1,14 +1,15 @@
 require 'net/http'
 require 'json'
 require 'cgi'
-require 'uri'
+require 'mailgunner/response'
+require 'mailgunner/delivery_method' if defined?(ActionMailer)
 
 module Mailgunner
   class Client
     attr_accessor :domain, :api_key, :http
 
     def initialize(options = {})
-      @domain = options.fetch(:domain) { ENV.fetch('MAILGUN_SMTP_LOGIN').split('@').last }
+      @domain = options.fetch(:domain) { ENV['MAILGUN_SMTP_LOGIN'].to_s.split('@').last }
 
       @api_key = options.fetch(:api_key) { ENV.fetch('MAILGUN_API_KEY') }
 
@@ -25,18 +26,6 @@ module Mailgunner
       @http.use_ssl = true
     end
 
-    def json
-      Kernel.warn 'Mailgunner::Client#json is deprecated'
-
-      @json
-    end
-
-    def json=(json)
-      Kernel.warn 'Mailgunner::Client#json= is deprecated'
-
-      @json = json
-    end
-
     def validate_address(value)
       get('/v2/address/validate', address: value)
     end
@@ -49,6 +38,14 @@ module Mailgunner
       post("/v2/#{escape @domain}/messages", attributes)
     end
 
+    def send_mime(mail)
+      to = ['to', Array(mail.to).join(',')]
+
+      message = ['message', mail.encoded, {filename: 'message.mime'}]
+
+      multipart_post("/v2/#{escape @domain}/messages.mime", [to, message])
+    end
+
     def get_domains(params = {})
       get('/v2/domains', params)
     end
@@ -113,12 +110,6 @@ module Mailgunner
       get("/v2/#{escape @domain}/stats", params)
     end
 
-    def get_log(params = {})
-      Kernel.warn 'Mailgunner::Client#get_log is deprecated'
-
-      get("/v2/#{escape @domain}/log", params)
-    end
-
     def get_events(params = {})
       get("/v2/#{escape @domain}/events", params)
     end
@@ -143,30 +134,6 @@ module Mailgunner
       delete("/v2/routes/#{escape id}")
     end
 
-    def get_mailboxes(params = {})
-      Kernel.warn 'Mailgunner::Client#get_mailboxes is deprecated'
-
-      get("/v2/#{escape @domain}/mailboxes", params)
-    end
-
-    def add_mailbox(attributes = {})
-      Kernel.warn 'Mailgunner::Client#add_mailbox is deprecated'
-
-      post("/v2/#{escape @domain}/mailboxes", attributes)
-    end
-
-    def update_mailbox(name, attributes = {})
-      Kernel.warn 'Mailgunner::Client#update_mailbox is deprecated'
-
-      put("/v2/#{escape @domain}/mailboxes/#{escape name}", attributes)
-    end
-
-    def delete_mailbox(name)
-      Kernel.warn 'Mailgunner::Client#delete_mailbox is deprecated'
-
-      delete("/v2/#{escape @domain}/mailboxes/#{escape name}")
-    end
-
     def get_campaigns(params = {})
       get("/v2/#{escape @domain}/campaigns", params)
     end
@@ -258,25 +225,29 @@ module Mailgunner
     private
 
     def get(path, params = {})
-      transmit(Net::HTTP::Get, request_uri(path, params))
+      transmit(Net::HTTP::Get.new(request_uri(path, params)))
     end
 
     def post(path, attributes = {})
-      transmit(Net::HTTP::Post, path, attributes)
+      transmit(Net::HTTP::Post.new(path)) { |message| message.set_form_data(attributes) }
+    end
+
+    def multipart_post(path, data)
+      transmit(Net::HTTP::Post.new(path)) { |message| message.set_form(data, 'multipart/form-data') }
     end
 
     def put(path, attributes = {})
-      transmit(Net::HTTP::Put, path, attributes)
+      transmit(Net::HTTP::Put.new(path)) { |message| message.set_form_data(attributes) }
     end
 
     def delete(path)
-      transmit(Net::HTTP::Delete, path)
+      transmit(Net::HTTP::Delete.new(path))
     end
 
-    def transmit(subclass, path, attributes = nil)
-      message = subclass.new(path)
+    def transmit(message)
       message.basic_auth('api', @api_key)
-      message.body = URI.encode_www_form(attributes) if attributes
+
+      yield message if block_given?
 
       Response.new(@http.request(message), :json => @json)
     end
@@ -301,40 +272,4 @@ module Mailgunner
       CGI.escape(component.to_s)
     end
   end
-
-  class Response
-    def initialize(http_response, options = {})
-      @http_response = http_response
-
-      @json = options.fetch(:json) { JSON }
-    end
-
-    def method_missing(name, *args, &block)
-      @http_response.send(name, *args, &block)
-    end
-
-    def respond_to_missing?(name, include_private = false)
-      @http_response.respond_to?(name)
-    end
-
-    def ok?
-      code.to_i == 200
-    end
-
-    def client_error?
-      (400 .. 499).include?(code.to_i)
-    end
-
-    def server_error?
-      (500 .. 599).include?(code.to_i)
-    end
-
-    def json?
-      self['Content-Type'].split(';').first == 'application/json'
-    end
-
-    def object
-      @object ||= @json.parse(body)
-    end
-  end
 end

data/lib/mailgunner/delivery_method.rb

@@ -0,0 +1,38 @@
+require 'mail/check_delivery_params'
+
+module Mailgunner
+  class DeliveryFailed < StandardError
+  end
+
+  class DeliveryMethod
+    include Mail::CheckDeliveryParams
+
+    attr_accessor :settings
+
+    def initialize(values)
+      @settings = values
+
+      @client = if @settings.has_key?(:domain)
+        Client.new(domain: @settings[:domain])
+      else
+        Client.new
+      end
+    end
+
+    def deliver!(mail)
+      check_delivery_params(mail)
+
+      response = @client.send_mime(mail)
+
+      if response.ok?
+        return response
+      elsif response.json? && response.object.has_key?('message')
+        raise DeliveryFailed, response.object['message']
+      else
+        raise DeliveryFailed, "#{response.code} #{response.message}"
+      end
+    end
+  end
+
+  ActionMailer::Base.add_delivery_method :mailgun, DeliveryMethod
+end

data/lib/mailgunner/response.rb

@@ -0,0 +1,37 @@
+module Mailgunner
+  class Response
+    def initialize(http_response, options = {})
+      @http_response = http_response
+
+      @json = options.fetch(:json) { JSON }
+    end
+
+    def method_missing(name, *args, &block)
+      @http_response.send(name, *args, &block)
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      @http_response.respond_to?(name)
+    end
+
+    def ok?
+      code.to_i == 200
+    end
+
+    def client_error?
+      (400 .. 499).include?(code.to_i)
+    end
+
+    def server_error?
+      (500 .. 599).include?(code.to_i)
+    end
+
+    def json?
+      self['Content-Type'].split(';').first == 'application/json'
+    end
+
+    def object
+      @object ||= @json.parse(body)
+    end
+  end
+end

data/mailgunner.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'mailgunner'
-  s.version = '1.2.0'
+  s.version = '1.3.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Tim Craft']
   s.email = ['mail@timcraft.com']
@@ -10,6 +10,8 @@ Gem::Specification.new do |s|
   s.files = Dir.glob('{lib,spec}/**/*') + %w(README.md mailgunner.gemspec)
   s.add_development_dependency('rake', '>= 0.9.3')
   s.add_development_dependency('mocha', '~> 0.13.2')
-  s.add_development_dependency('faux', '~> 1.1.0')
+  s.add_development_dependency('webmock', '~> 1.13.0')
+  s.add_development_dependency('mail', '~> 2.5.4')
+  s.add_development_dependency('actionmailer', '~> 4.0.0')
   s.require_path = 'lib'
 end

data/spec/mailgunner_delivery_method_spec.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'action_mailer'
+require 'mailgunner'
+require 'mailgunner/delivery_method'
+
+class ExampleMailer < ActionMailer::Base
+  default from: 'testing@localhost'
+
+  def registration_confirmation(user)
+    mail to: user[:email], subject: 'Welcome!', body: 'Hello!'
+  end
+end
+
+describe 'Mailgunner::DeliveryMethod' do
+  before do
+    @api_key = 'xxx'
+
+    @domain = 'samples.mailgun.org'
+
+    @base_url = "https://api:#@api_key@api.mailgun.net/v2"
+
+    @address = 'user@example.com'
+
+    ActionMailer::Base.delivery_method = :mailgun
+
+    ENV['MAILGUN_API_KEY'] = @api_key
+
+    ENV['MAILGUN_SMTP_LOGIN'] = "postmaster@#@domain"
+  end
+
+  it 'delivers the mail to mailgun in mime format' do
+    stub_request(:post, "#@base_url/#@domain/messages.mime")
+
+    ExampleMailer.registration_confirmation(email: @address).deliver
+  end
+
+  it 'raises an exception if the api returns an error' do
+    stub_request(:post, "#@base_url/#@domain/messages.mime").to_return({
+      status: 403,
+      headers: {'Content-Type' => 'application/json'},
+      body: '{"message": "Invalid API key"}'
+    })
+
+    proc { ExampleMailer.registration_confirmation(email: @address).deliver }.must_raise(Mailgunner::DeliveryFailed)
+  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_response_spec.rb

@@ -0,0 +1,101 @@
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'mailgunner'
+
+describe 'Mailgunner::Response' do
+  before do
+    @http_response = mock()
+
+    @response = Mailgunner::Response.new(@http_response)
+  end
+
+  it 'delegates missing methods to the http response object' do
+    @http_response.stubs(:code).returns('200')
+
+    @response.code.must_equal('200')
+  end
+
+  describe 'ok query method' do
+    it 'returns true if the status code is 200' do
+      @http_response.expects(:code).returns('200')
+
+      @response.ok?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.expects(:code).returns('400')
+
+      @response.ok?.must_equal(false)
+    end
+  end
+
+  describe 'client_error query method' do
+    it 'returns true if the status code is 4xx' do
+      @http_response.stubs(:code).returns(%w(400 401 402 404).sample)
+
+      @response.client_error?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.stubs(:code).returns('200')
+
+      @response.client_error?.must_equal(false)
+    end
+  end
+
+  describe 'server_error query method' do
+    it 'returns true if the status code is 5xx' do
+      @http_response.stubs(:code).returns(%w(500 502 503 504).sample)
+
+      @response.server_error?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.stubs(:code).returns('200')
+
+      @response.server_error?.must_equal(false)
+    end
+  end
+
+  describe 'json query method' do
+    it 'returns true if the response has a json content type' do
+      @http_response.expects(:[]).with('Content-Type').returns('application/json;charset=utf-8')
+
+      @response.json?.must_equal(true)
+    end
+
+    it 'returns false otherwise' do
+      @http_response.expects(:[]).with('Content-Type').returns('text/html')
+
+      @response.json?.must_equal(false)
+    end
+  end
+
+  describe 'object method' do
+    it 'decodes the response body as json and returns a hash' do
+      @http_response.expects(:body).returns('{"foo":"bar"}')
+
+      @response.object.must_equal({'foo' => 'bar'})
+    end
+  end
+end
+
+describe 'Mailgunner::Response initialized with an alternative json implementation' do
+  before do
+    @json = mock()
+
+    @http_response = stub
+
+    @response = Mailgunner::Response.new(@http_response, :json => @json)
+  end
+
+  describe 'object method' do
+    it 'uses the alternative json implementation to parse the response body' do
+      @http_response.stubs(:body).returns(response_body = '{"foo":"bar"}')
+
+      @json.expects(:parse).with(response_body)
+
+      @response.object
+    end
+  end
+end