mailgun-ruby 1.1.2 → 1.1.6

data/lib/railgun/mailer.rb

@@ -0,0 +1,158 @@
+require 'action_mailer'
+require 'mailgun'
+require 'rails'
+require 'railgun/errors'
+
+module Railgun
+
+  # Railgun::Mailer is an ActionMailer provider for sending mail through
+  # Mailgun.
+  class Mailer
+
+    # [Hash] config ->
+    #   Requires *at least* `api_key` and `domain` keys.
+    attr_accessor :config, :domain
+
+    # Initialize the Railgun mailer.
+    #
+    # @param [Hash] config Hash of config values, typically from `app_config.action_mailer.mailgun_config`
+    def initialize(config)
+      @config = config
+
+      [:api_key, :domain].each do |k|
+        raise Railgun::ConfigurationError.new("Config requires `#{k}` key", @config) unless @config.has_key?(k)
+      end
+
+      @mg_client = Mailgun::Client.new(config[:api_key])
+      @domain = @config[:domain]
+
+      if (@config[:fake_message_send] || false)
+        Rails.logger.info "NOTE: fake message sending has been enabled for mailgun-ruby!"
+        @mg_client.enable_test_mode!
+      end
+    end
+
+    def deliver!(mail)
+      mg_message = Railgun.transform_for_mailgun(mail)
+      response = @mg_client.send_message(@domain, mg_message)
+
+      if response.code == 200 then
+        mg_id = response.body['id']
+        mail.message_id = mg_id
+      end
+      response
+    end
+
+    def mailgun_client
+      @mg_obj
+    end
+
+  end
+
+  module_function
+
+  # Performs a series of transformations on the `mailgun*` attributes.
+  # After prefixing them with the proper option type, they are added to
+  # the message hash where they will then be sent to the API as JSON.
+  #
+  # @param [Mail::Message] mail message to transform
+  #
+  # @return [Hash] transformed message hash
+  def transform_for_mailgun(mail)
+    message = build_message_object(mail)
+
+    # v:* attributes (variables)
+    mail.mailgun_variables.try(:each) do |k, v|
+      message["v:#{k}"] = v
+    end
+
+    # o:* attributes (options)
+    mail.mailgun_options.try(:each) do |k, v|
+      message["o:#{k}"] = v
+    end
+
+    # h:* attributes (headers)
+    mail.mailgun_headers.try(:each) do |k, v|
+      message["h:#{k}"] = v
+    end
+
+    # recipient variables
+    message['recipient-variables'] = mail.mailgun_recipient_variables.to_json if mail.mailgun_recipient_variables
+
+    # reject blank values
+    message.delete_if do |k, v|
+      v.nil? or (v.respond_to?(:empty) and v.empty?)
+    end
+
+    return message
+  end
+
+  # Acts on a Rails/ActionMailer message object and uses Mailgun::MessageBuilder
+  # to construct a new message.
+  #
+  # @param [Mail::Message] mail message to transform
+  #
+  # @returns [Hash] Message hash from Mailgun::MessageBuilder
+  def build_message_object(mail)
+    mb = Mailgun::MessageBuilder.new
+
+    mb.from mail[:from]
+    mb.reply_to(mail[:reply_to].to_s) if mail[:reply_to].present?
+    mb.subject mail.subject
+    mb.body_html extract_body_html(mail)
+    mb.body_text extract_body_text(mail)
+
+    [:to, :cc, :bcc].each do |rcpt_type|
+      addrs = mail[rcpt_type] || nil
+      case addrs
+      when String
+        # Likely a single recipient
+        mb.add_recipient rcpt_type.to_s, addrs
+      when Array
+        addrs.each do |addr|
+          mb.add_recipient rcpt_type.to_s, addr
+        end
+      when Mail::Field
+        mb.add_recipient rcpt_type.to_s, addrs.to_s
+      end
+    end
+
+    return mb.message if mail.attachments.empty?
+
+    mail.attachments.each do |attach|
+      attach = Attachment.new(attach, encoding: 'ascii-8bit', inline: attach.inline?)
+      attach.attach_to_message! mb
+    end
+
+    return mb.message
+  end
+
+  # Returns the decoded HTML body from the Mail::Message object if available,
+  # otherwise nil.
+  #
+  # @param [Mail::Message] mail message to transform
+  #
+  # @return [String]
+  def extract_body_html(mail)
+    begin
+      (mail.html_part || mail).body.decoded || nil
+    rescue
+      nil
+    end
+  end
+
+  # Returns the decoded text body from the Mail::Message object if it is available,
+  # otherwise nil.
+  #
+  # @param [Mail::Message] mail message to transform
+  #
+  # @return [String]
+  def extract_body_text(mail)
+    begin
+      (mail.text_part || mail).body.decoded || nil
+    rescue
+      nil
+    end
+  end
+
+end

data/lib/railgun/message.rb

@@ -0,0 +1,17 @@
+require 'mail'
+require 'mailgun/messages/message_builder'
+require 'railgun/attachment'
+require 'railgun/errors'
+
+module Mail
+
+  class Message
+
+    # Attributes to hold Mailgun-specific information
+    attr_accessor :mailgun_variables,
+                  :mailgun_options,
+                  :mailgun_recipient_variables,
+                  :mailgun_headers
+
+  end
+end

data/lib/railgun/railtie.rb

@@ -0,0 +1,9 @@
+require 'railgun/mailer'
+
+module Railgun
+  class Railtie < ::Rails::Railtie
+    config.before_configuration do
+      ActionMailer::Base.add_delivery_method :mailgun, Railgun::Mailer
+    end
+  end
+end

data/lib/railgun.rb

@@ -0,0 +1,8 @@
+require 'railgun/railtie'
+require 'railgun/attachment'
+require 'railgun/errors'
+require 'railgun/mailer'
+require 'railgun/message'
+
+module Railgun
+end

data/mailgun.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.version          = Mailgun::VERSION
   spec.homepage         = 'http://www.mailgun.com'
   spec.platform         = Gem::Platform::RUBY
-  spec.license          = 'Apache'
+  spec.license          = 'Apache-2.0'
 
   spec.summary          = "Mailgun's Official Ruby SDK"
   spec.description      = "Mailgun's Official Ruby SDK for interacting with the Mailgun API."

data/spec/integration/events_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'mailgun'
+require 'mailgun/events/events'
 
 vcr_opts = { :cassette_name => "events" }
 
@@ -7,9 +8,10 @@ describe 'For the Events endpoint', vcr: vcr_opts do
   before(:all) do
     @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
     @domain = TESTDOMAIN
+    @events = Mailgun::Events.new(@mg_obj, @domain)
   end
 
-  it 'get an event.' do
+  it 'can get an event.' do
     result = @mg_obj.get("#{@domain}/events", {:limit => 1})
 
     result.to_h!
@@ -17,4 +19,10 @@ describe 'For the Events endpoint', vcr: vcr_opts do
     expect(result.body["paging"]).to include("next")
     expect(result.body["paging"]).to include("previous")
   end
+
+  it 'can iterate over all events with `each`' do
+    @events.each do |e|
+      expect(e.id).to eq("JAx9z641TuGGUyaJlD9sCQ")
+    end
+  end
 end

data/spec/integration/suppressions_spec.rb

@@ -0,0 +1,126 @@
+require 'spec_helper'
+
+require 'mailgun'
+require 'mailgun/suppressions'
+
+vcr_opts = { :cassette_name => 'suppressions' }
+
+describe 'For the suppressions handling class', order: :defined, vcr: vcr_opts do
+
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY)
+    @suppress = Mailgun::Suppressions.new(@mg_obj, TESTDOMAIN)
+
+    @addresses = ['test1@example.com', 'test2@example.org', 'test3@example.net', 'test4@example.info']
+  end
+
+  it 'can batch-add bounces' do
+    bounces = []
+    @addresses.each do |addr|
+      bounces.push({
+        :address => addr,
+        :code => 500,
+        :error => 'integration testing',
+      })
+    end
+
+    response, nested = @suppress.create_bounces bounces
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the bounces table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no bounce[:address] is present' do
+    bounces = []
+    bounces.push({
+      :code => 500,
+      :error => 'integration testing',
+    })
+
+    expect { @suppress.create_bounces bounces }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single bounce address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_bounce addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Bounced address has been removed')
+    end
+  end
+
+  it 'can batch-add unsubscribes' do
+    unsubscribes = []
+    @addresses.each do |addr|
+      unsubscribes.push({
+        :address => addr,
+        :tag => 'integration',
+      })
+    end
+
+    response, nested = @suppress.create_unsubscribes unsubscribes
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 addresses have been added to the unsubscribes table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no unsubscribe[:address] is present' do
+    unsubscribes = []
+    unsubscribes.push({
+      :tag => 'integration',
+    })
+
+    expect { @suppress.create_unsubscribes unsubscribes }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single unsubscribe address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_unsubscribe addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Unsubscribe event has been removed')
+    end
+  end
+
+  it 'can batch-add complaints' do
+    complaints = []
+    @addresses.each do |addr|
+      complaints.push :address => addr
+    end
+
+    response, nested = @suppress.create_complaints complaints
+    response.to_h!
+
+    expect(response.code).to eq(200)
+    expect(response.body['message']).to eq('4 complaint addresses have been added to the complaints table')
+    expect(nested.length).to eq(0)
+  end
+
+  it 'raises ParameterError if no complaint[:address] is present' do
+    complaints = []
+    complaints.push({
+      :tag => 'integration',
+    })
+
+    expect { @suppress.create_complaints complaints }.to raise_error(Mailgun::ParameterError)
+  end
+
+  it 'removes a single complaint address' do
+    @addresses.each do |addr|
+      response = @suppress.delete_complaint addr
+      response.to_h!
+
+      expect(response.code).to eq(200)
+      expect(response.body['message']).to eq('Spam complaint has been removed')
+    end
+  end
+
+  # TODO: Add tests for pagination support.
+end
+

data/spec/unit/events/events_spec.rb

@@ -5,7 +5,7 @@ describe 'The method get' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.get()
-    
+
     expect(result.body).to include("items")
     expect(result.body).to include("paging")
   end
@@ -17,7 +17,7 @@ describe 'The method next' do
     @mg_obj = Mailgun::UnitClient.new('events')
     events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
     result = events.next()
-    
+
     expect(result.body).to include("items")
     expect(result.body).to include("paging")
   end
@@ -33,3 +33,18 @@ describe 'The method previous' do
     expect(result.body).to include("paging")
   end
 end
+
+describe 'The method each' do
+  it 'should iterate over all event items.' do
+    @mg_obj = Mailgun::UnitClient.new('events')
+    events = Mailgun::Events.new(@mg_obj, "samples.mailgun.org")
+    # Events from the UnitClient are actually empty.
+    count = 0
+    events.each do |e|
+      count = count + 1
+    end
+
+    # Better than nothing..
+    expect(count).to eq(0)
+  end
+end

data/spec/unit/messages/message_builder_spec.rb

@@ -70,7 +70,7 @@ describe 'The method add_recipient' do
     recipient_type = 'h:reply-to'
     @mb_obj.add_recipient(recipient_type, @address, @variables)
 
-    expect(@mb_obj.message[recipient_type][0]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
+    expect(@mb_obj.message[recipient_type]).to eq("'#{@variables['first']} #{@variables['last']}' <#{@address}>")
     @mb_obj.counters[:recipients].each_value{|value| expect(value).to eq(0)}
   end
 
@@ -249,6 +249,31 @@ describe 'The method add_inline_image' do
   end
 end
 
+describe 'The method list_unsubscribe' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+
+  it 'sets the message list_unsubscribe to blank if called and no parameters are provided' do
+    @mb_obj.list_unsubscribe
+    expect(@mb_obj.message['h:List-Unsubscribe']).to eq('')
+  end
+
+  it 'sets the message list_unsubscribe if called with one list_unsubscribe parameter' do
+    unsubscribe_to = 'http://example.com/stop-hassle'
+    @mb_obj.list_unsubscribe(unsubscribe_to)
+    expect(@mb_obj.message['h:List-Unsubscribe']).to eq("<#{unsubscribe_to}>")
+  end
+
+  it 'sets the message list_unsubscribe if called with many list_unsubscribe parameters' do
+    unsubscribe_to = %w(http://example.com/stop-hassle mailto:stop-hassle@example.com)
+    @mb_obj.list_unsubscribe(*unsubscribe_to)
+    expect(@mb_obj.message['h:List-Unsubscribe']).to eq(
+      unsubscribe_to.map { |var| "<#{var}>" }.join(',')
+    )
+  end
+end
+
 describe 'The method set_test_mode' do
   it 'warns of set_test_mode deprecation' do
     @mb_obj = Mailgun::MessageBuilder.new
@@ -485,19 +510,31 @@ describe 'The method header' do
   it 'accepts valid JSON and appends as data to the message.' do
     @mb_obj.header('my-data', '{"key":"value"}')
 
-    expect(@mb_obj.message["v:my-data"][0]).to be_kind_of(String)
-    expect(@mb_obj.message["v:my-data"][0].to_s).to eq('{"key"=>"value"}')
+    expect(@mb_obj.message["h:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["h:my-data"].to_s).to eq('{"key":"value"}')
+  end
+end
+
+describe 'The method variable' do
+  before(:each) do
+    @mb_obj = Mailgun::MessageBuilder.new
+  end
+  it 'accepts valid JSON and stores it as message[param].' do
+    @mb_obj.variable('my-data', '{"key":"value"}')
+
+    expect(@mb_obj.message["v:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["v:my-data"].to_s).to eq('{"key":"value"}')
   end
   it 'accepts a hash and appends as data to the message.' do
     data = {'key' => 'value'}
-    @mb_obj.header('my-data', data)
+    @mb_obj.variable('my-data', data)
 
-    expect(@mb_obj.message["v:my-data"][0]).to be_kind_of(String)
-    expect(@mb_obj.message["v:my-data"][0].to_s).to eq('{"key"=>"value"}')
+    expect(@mb_obj.message["v:my-data"]).to be_kind_of(String)
+    expect(@mb_obj.message["v:my-data"].to_s).to eq('{"key":"value"}')
   end
   it 'throws an exception on broken JSON.' do
     data = 'This is some crappy JSON.'
-    expect {@mb_obj.header('my-data', data)}.to raise_error(Mailgun::ParameterError)
+    expect {@mb_obj.variable('my-data', data)}.to raise_error(Mailgun::ParameterError)
   end
 end
 

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