wj-mailgun-ruby 1.1.7

data/lib/railgun/attachment.rb

@@ -0,0 +1,56 @@
+module Railgun
+
+  class Attachment < StringIO
+
+    attr_reader :filename, :content_type, :path,
+                :original_filename, :overwritten_filename
+
+    def initialize(attachment, *args)
+      @path = ''
+      @inline = args.detect { |opt| opt[:inline] }
+
+      if @inline
+        @filename = attachment.cid
+      else
+        @filename = attachment.filename
+      end
+
+      @original_filename = @filename
+
+      if args.detect { |opt| opt[:filename] }
+        @filename = opt[:filename]
+      end
+
+      @overwritten_filename = @filename
+
+      @content_type = attachment.content_type.split(';')[0]
+
+      super attachment.body.decoded
+    end
+
+    def inline?
+      @inline
+    end
+
+    def is_original_filename
+      @original_filename == @overwritten_filename
+    end
+
+    def source_filename
+      @filename
+    end
+
+    def attach_to_message!(mb)
+      if mb.nil?
+        nil
+      end
+
+      if inline?
+        mb.add_inline_image self, @filename
+      else
+        mb.add_attachment self, @filename
+      end
+    end
+
+  end
+end

data/lib/railgun/errors.rb

@@ -0,0 +1,27 @@
+module Railgun
+
+  class Error < StandardError
+
+    attr_reader :object
+
+    def initialize(message = nil, object = nil)
+      super(message)
+
+      @object = object
+    end
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class InternalError < Error
+
+    attr_reader :source_exception
+
+    def initialize(source_exc, message = nil, object = nil)
+      super(message, object)
+
+      @source_exception = source_exc
+    end
+  end
+end

data/lib/railgun/mailer.rb

@@ -0,0 +1,161 @@
+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, :settings
+
+    # 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]
+
+      # To avoid exception in mail gem v2.6
+      @settings = { return_response: true }
+
+      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.to_h['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/mailgun.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailgun/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name             = 'wj-mailgun-ruby'
+  spec.version          = Mailgun::VERSION
+  spec.homepage         = 'http://www.mailgun.com'
+  spec.platform         = Gem::Platform::RUBY
+  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."
+
+  spec.authors          = ['Mailgun', 'Travis Swientek',"greatmanta111"]
+  spec.email            = 'support@mailgunhq.com'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'webmock', '~> 1.22'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+
+  spec.add_dependency 'rest-client', '~> 2.0'
+
+end

data/spec/integration/bounces_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "bounces" }
+
+describe 'For the Bounces endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @email = "integration-test-email@#{TESTDOMAIN}"
+  end
+
+  it 'creates a bounce' do
+    @result = @mg_obj.post("#{@domain}/bounces",
+                           {:address => @email,
+                            :code => 550,
+                            :error => "Integration Test"})
+
+    @result.to_h!
+    expect(@result.body["message"]).to eq("Address has been added to the bounces table")
+    expect(@result.body["address"]).to eq(@email)
+  end
+
+  it 'get a bounce.' do
+    result = @mg_obj.get("#{@domain}/bounces/#{@email}")
+
+    result.to_h!
+    expect(result.body["code"]).to eq("550")
+    expect(result.body["address"]).to eq(@email)
+    expect(result.body["error"]).to eq("Integration Test")
+  end
+
+  it 'gets a list of bounces.' do
+    result = @mg_obj.get("#{@domain}/bounces")
+
+    result.to_h!
+    expect(result.body["items"].length).to be > 0
+  end
+
+  it 'deletes a bounce' do
+    @mg_obj.delete("#{@domain}/bounces/#{@email}")
+  end
+
+end

data/spec/integration/campaign_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "campaigns" }
+
+describe 'For the campaigns endpoint', vcr: vcr_opts do
+  before(:all) do
+    skip 'pending removal'
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @campaign_id = "integration_test_campaign"
+  end
+
+  it 'creates a campaign' do
+    result = @mg_obj.post("#{@domain}/campaigns", {:name => 'My Campaign',
+                                                   :id => @campaign_id})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Campaign created")
+    expect(result.body["campaign"]["id"]).to eq(@campaign_id)
+    expect(result.body["campaign"]["name"]).to eq('My Campaign')
+  end
+
+  it 'get a campaign.' do
+    result = @mg_obj.get("#{@domain}/campaigns/#{@campaign_id}")
+
+    result.to_h!
+    expect(result.body["id"]).to eq(@campaign_id)
+    expect(result.body["name"]).to eq('My Campaign')
+  end
+
+  it 'gets a list of all campaigns.' do
+    result = @mg_obj.get("#{@domain}/campaigns", {:limit => 50})
+
+    result.to_h!
+    expect(result.body["total_count"]).to be > 0
+  end
+
+  it 'update a campaign.' do
+    result = @mg_obj.put("#{@domain}/campaigns/#{@campaign_id}", {:name => 'My Updated Campaign',
+                                                                  :id => @campaign_id})
+
+    result.to_h!
+    expect(result.body["message"]).to eq("Campaign updated")
+    expect(result.body["campaign"]["id"]).to eq(@campaign_id)
+    expect(result.body["campaign"]["name"]).to eq('My Updated Campaign')
+  end
+
+  it 'get campaign events.' do
+    expect{@mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/events", {:groupby => "clicked"})}.not_to raise_error
+  end
+
+  it 'get campaign stats.' do
+    expect{@mg_obj.get("#{@domain}/campaigns/#{@campaign_id}/stats", {:groupby => "domain"})}.not_to raise_error
+  end
+
+  it 'removes a campaign' do
+    @mg_obj.delete("#{@domain}/campaigns/#{@campaign_id}")
+  end
+end

data/spec/integration/complaints_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'mailgun'
+
+vcr_opts = { :cassette_name => "complaints" }
+
+describe 'For the Complaints endpoint', order: :defined, vcr: vcr_opts do
+  before(:all) do
+    @mg_obj = Mailgun::Client.new(APIKEY, APIHOST, APIVERSION, SSL)
+    @domain = TESTDOMAIN
+    @email = "integration-test-email@#{TESTDOMAIN}"
+  end
+
+  it 'creates a complaint' do
+    @result = @mg_obj.post("#{@domain}/complaints", {:address => @email})
+
+    @result.to_h!
+    expect(@result.body["message"]).to eq("Address has been added to the complaints table")
+    expect(@result.body["address"]).to eq(@email)
+  end
+
+  it 'get a complaint.' do
+    result = @mg_obj.get("#{@domain}/complaints/#{@email}")
+
+    result.to_h!
+    expect(result.body["address"]).to eq(@email)
+  end
+
+  it 'gets a list of complaints.' do
+    result = @mg_obj.get("#{@domain}/complaints")
+
+    result.to_h!
+    expect(result.body["items"].length).to be > 0
+  end
+
+  it 'removes a complaint' do
+    @mg_obj.delete("#{@domain}/complaints/#{@email}")
+  end
+end