mail_male_mail 0.0.1 → 0.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mail_male_mail.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    mail_male_mail (0.0.2)
+      actionmailer (>= 3.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
+    actionpack (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    builder (3.0.4)
+    columnize (0.3.6)
+    debugger (1.5.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.0)
+    diff-lcs (1.2.3)
+    erubis (2.7.0)
+    hike (1.2.2)
+    i18n (0.6.1)
+    journey (1.0.4)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.7)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  mail_male_mail!
+  rspec

data/README.md

@@ -1,4 +1,70 @@
 MailMaleMail
 ==============
 
-Manage mail configurations using configuration instead of code. This allows you to cleanly and easily swap mail settings.
+Manage mail configurations using configuration instead of code. This allows you to cleanly and easily swap mail settings.
+
+
+## Usage
+
+### Config File
+
+Create a config in config/mail_male_mail.yml file and specify your settings
+
+```
+#config/mail_male_mail.yml
+production: &production
+  mailman_1:
+    delivery_method: smtp
+    smtp_settings:
+      address: "smtp.gmail.com"
+      port: 587
+development:
+  <%= "<<: *production" if ENV['SEND_REAL_EMAILS'] == '1' %>
+  default:
+    delivery_method: letter_opener
+test:
+  default:
+    delivery_method: test
+```
+
+### Mailman
+
+In your mailer specify the 'mailman' to deliever the mail:
+
+```
+class MainMailer < ActionMailer::Base
+  mailman :mailman_1
+end
+```
+
+### Categories/Variables
+
+MailMaleMale supports Sendgrid Categories/UniqArgs and Mailgun Tags/Varibales
+
+<table>
+<tr><th>MailMaleMail</th><th>Sendgrid</th><th>Mailgun</th></tr>
+<tr><td>category</td><td>category</td><td>tag</td></tr>
+<tr><td>variables</td><td>unique args</td><td>variables</td></tr>
+</table>
+
+```
+class MainMailer < ActionMailer::Base
+  def test_email
+    set_mail_male_mail_category("CategoryName")
+    set_mail_male_mail_variables(:key1 => "value1", :key2 => "value2")
+    mail(...)
+  end
+end
+```
+
+To add this functionality, add sendgrid/mailgun to the provider in your config
+
+```
+#config/mail_male_mail.yml
+production:
+  sendgrid_mailman:
+    provider: sendgrid
+  mailgun_mailman:
+    provider: mailgun
+```
+

data/lib/mail_male_mail.rb

@@ -1,13 +1,19 @@
 require "yaml"
+require 'json'
 require "action_mailer"
+require "mail_male_mail/sendgrid"
+require "mail_male_mail/mailgun"
+require "mail_male_mail/configuration"
 
 module MailMaleMail
-  autoload :Configuration, "mail_male_mail/configuration"
-
+  PROVIDERS = %w(sendgrid mailgun)
 
   if defined? Rails::Railtie
     class MailMaleMailRailtie < Rails::Railtie
       initializer "mail_male_mail_initializer" do |app|
+        unless File.exist? MailMaleMail::Configuration.filepath
+          raise LoadError, "#{MailMaleMail::Configuration.filepath} is required for MailMaleMail and does not exist"
+        end
         ActionMailer::Base.send(:include, MailMaleMail)
       end
     end
@@ -17,16 +23,46 @@ module MailMaleMail
     base.extend(ClassMethods)
     base.class_eval do
       Configuration.load
+      include(Sendgrid)
+      include(Mailgun)
+      class << self
+        attr_accessor :mmm_provider
+      end
+      attr_accessor :mmm_category, :mmm_variables
+      alias_method_chain :mail, :mmm_headers
+
       mailman('default')
     end
   end
 
+  def mail_with_mmm_headers(headers={}, &block)
+    mail_without_mmm_headers(headers, &block).tap do |m|
+      send("write_#{self.class.mmm_provider}_headers") if self.class.mmm_provider
+    end
+  end
+
+  def mail_male_mail_category(category)
+    self.mmm_category = category
+  end
+
+  def mail_male_mail_variables(variables)
+    if variables.is_a?(Hash)
+      self.mmm_variables = variables
+    else
+      raise TypeError, "variables must be a Hash"
+    end
+  end
+
   module ClassMethods
     def mailman(name)
-      config = Configuration.get(name)
-      if config
+      if config = Configuration.get(name)
         self.delivery_method = config['delivery_method'].to_sym if config.key?('delivery_method')
-        self.smtp_settings = config['smtp_settings'].symbolize_keys if config.key?('smtp_settings') && config['smtp_settings'].is_a?(Hash)
+        if config.key?('smtp_settings') && config['smtp_settings'].is_a?(Hash)
+          self.smtp_settings = config['smtp_settings'].symbolize_keys
+        end
+        if config.key?('provider') && PROVIDERS.include?(config['provider'])
+          self.mmm_provider = config['provider']
+        end
       end
     end
   end

data/lib/mail_male_mail/configuration.rb

@@ -3,8 +3,11 @@ require "yaml"
 module MailMaleMail
   class Configuration
     class <<self
+      def filepath
+        @filepath ||= Rails.root.join("config/mail_male_mail.yml")
+      end
       def load
-        @configurations ||= YAML.load(ERB.new(File.read(Rails.root.join("config/mail_male_mail.yml"))).result)[Rails.env]
+        @configurations ||= YAML.load(ERB.new(File.read(filepath)).result)[Rails.env]
       end
 
       def get(name)

data/lib/mail_male_mail/mailgun.rb

@@ -0,0 +1,12 @@
+module MailMaleMail
+  module Mailgun
+    def write_mailgun_headers
+      if mmm_category == :use_subject_lines
+        self.headers['X-Mailgun-Tag'] = message.subject
+      elsif mmm_category
+        self.headers['X-Mailgun-Tag'] = mmm_category
+      end
+      self.headers['X-Mailgun-Variables'] = mmm_variables.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3') if mmm_variables
+    end
+  end
+end

data/lib/mail_male_mail/sendgrid.rb

@@ -0,0 +1,22 @@
+module MailMaleMail
+  module Sendgrid
+    def write_sendgrid_headers
+      self.headers['X-SMTPAPI'] = build_sendgrid_json
+    end
+
+    private
+
+    def build_sendgrid_json
+      header_opts = {}
+
+      if mmm_category == :use_subject_lines
+        header_opts[:category] = message.subject
+      elsif mmm_category
+        header_opts[:category] = mmm_category
+      end
+      header_opts[:unique_args] = mmm_variables if mmm_variables
+
+      header_opts.to_json.gsub(/(["\]}])([,:])(["\[{])/, '\\1\\2 \\3')
+    end
+  end
+end

data/lib/mail_male_mail/version.rb

@@ -1,3 +1,3 @@
 module MailMaleMail
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/mail_male_mail.gemspec

@@ -14,5 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = MailMaleMail::VERSION
 
-  gem.add_development_dependency "actionmailer"
+  gem.add_dependency "actionmailer", ">= 3.0.0"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "debugger"
 end

data/spec/config/mail_male_mail.yml

@@ -0,0 +1,32 @@
+production:
+  default: &default
+    delivery_method: test
+    smtp_settings:
+      address: 'smtp.gmail.com'
+      port: 587
+
+  invalid_provider:
+    <<: *default
+    provider: "google"
+  sendgrid:
+    <<: *default
+    provider: sendgrid
+    smtp_settings:
+      address: "smtp.sendgrid.net"
+      port: '587'
+      enable_starttls_auto: true
+      domain: "example.com"
+      authentication: 'plain'
+      user_name: "test@example.com"
+      password: "superamazingpasswordforsendgrid"
+  mailgun:
+    <<: *default
+    provider: mailgun
+    smtp_settings:
+      address: "smtp.mailgun.org"
+      port: '587'
+      enable_starttls_auto: true
+      user_name: "test@example.com"
+      password: "superamazingpasswordformailgun"
+
+

data/spec/mail_male_mail/mailgun_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+class MMMMailgunMailer < MMMailer
+  mailman :mailgun
+  def test_mail
+    set_mmm_cateogry("MailgunCategory1")
+    set_mmm_variables(:color => "green", :sound => "bark")
+    mail(:subject => "Mailgun Testing", :from => "test@example.com", :to => "test2@example.com")
+  end
+end
+
+module MailMaleMail
+  describe Sendgrid do
+    it "should set the X-SMTPAPI header with category unique_args" do
+      mail = MMMMailgunMailer.test_mail
+      mail.header['X-Mailgun-Tag'].to_s.should == "MailgunCategory1"
+      mail.header['X-Mailgun-Variables'].to_s.should == "{\"color\": \"green\", \"sound\": \"bark\"}"
+    end
+  end
+end
+

data/spec/mail_male_mail/sendgrid_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+class MMMSendGridMailer < MMMailer
+  mailman :sendgrid
+  def test_mail
+    set_mmm_cateogry("SendgridCategory1")
+    set_mmm_variables(:color => "blue", sound: "meow")
+    mail(:subject => "Sengrid Testing", :from => "test@example.com", :to => "test2@example.com")
+  end
+end
+
+module MailMaleMail
+  describe Sendgrid do
+    it "should set the X-SMTPAPI header with category unique_args" do
+      mail = MMMSendGridMailer.test_mail
+      mail.header['X-SMTPAPI'].to_s.should == "{\"category\": \"SendgridCategory1\", \"unique_args\": {\"color\": \"blue\", \"sound\": \"meow\"}}"
+    end
+  end
+end
+

data/spec/mail_male_mail_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe MailMaleMail do
+  it "should not ignore invalid providers" do
+    MMMailer.class_eval {mailman :default}
+    MMMailer.mmm_provider.should be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'rspec'
+require 'debugger'
+
+class Rails
+  def self.root
+    Pathname.new(__FILE__).dirname
+  end
+
+  def self.env
+    "production"
+  end
+end
+
+require "mail_male_mail"
+ActionMailer::Base.send(:include, MailMaleMail)
+class MMMailer < ActionMailer::Base
+end
+
+RSpec.configure do |config|
+  config.after :each do
+    MMMailer.class_eval do
+      mailman :default
+      self.mmm_provider = nil
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail_male_mail
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,42 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-17 00:00:00.000000000 Z
+date: 2013-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -35,12 +67,21 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - README.md
 - Rakefile
 - lib/mail_male_mail.rb
 - lib/mail_male_mail/configuration.rb
+- lib/mail_male_mail/mailgun.rb
+- lib/mail_male_mail/sendgrid.rb
 - lib/mail_male_mail/version.rb
 - mail_male_mail.gemspec
+- spec/config/mail_male_mail.yml
+- spec/mail_male_mail/mailgun_spec.rb
+- spec/mail_male_mail/sendgrid_spec.rb
+- spec/mail_male_mail_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/carlallen/mail_male_mail
 licenses: []
 post_install_message: 
@@ -65,4 +106,9 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: extend actionmailer to work with multiple mail providers
-test_files: []
+test_files:
+- spec/config/mail_male_mail.yml
+- spec/mail_male_mail/mailgun_spec.rb
+- spec/mail_male_mail/sendgrid_spec.rb
+- spec/mail_male_mail_spec.rb
+- spec/spec_helper.rb