mail-madmimi 0.0.1

data/.arcconfig

@@ -0,0 +1,8 @@
+{
+    "project_id": "mail-madmimi",
+    "conduit_uri": "http://phabricator.tagview.com.br",
+    "load": [
+        "libphutil/src"
+    ],
+    "base": "git:merge-base(origin/master)"
+}

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: bundle exec rspec spec
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mail-mad_mimi.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    mail-madmimi (0.0.1)
+      actionmailer (>= 4.0.0)
+      httparty (~> 0.13.0)
+      mail (>= 2.5.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.3)
+      actionpack (= 4.0.3)
+      mail (~> 2.5.4)
+    actionpack (4.0.3)
+      activesupport (= 4.0.3)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activesupport (4.0.3)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    builder (3.1.4)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    httparty (0.13.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.9)
+    json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    polyglot (0.3.4)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.5)
+    thread_safe (0.1.3)
+      atomic
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mail-madmimi!
+  rspec (~> 2.14.1)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Guilherme Otranto Aulicino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+mail-madmimi
+==============
+[![Build Status](https://travis-ci.org/guilherme-otran/mail-madmimi.png?branch=master)](https://travis-ci.org/guilherme-otran/mail-madmimi)
+[![Dependency Status](https://gemnasium.com/guilherme-otran/mail-madmimi.png)](https://gemnasium.com/guilherme-otran/mail-madmimi)
+
+Integration of Mad Mimi with ActionMailer (Tested with Rails 4)
+
+## Gemfile
+    gem "mail-madmimi"
+
+## Config
+environments/production.rb, and/or development.rb if you want use it
+
+    config.action_mailer.delivery_method = :mad_mimi
+    config.action_mailer.mad_mimi_settings = {
+      :username => "someuser@example.org",
+      :api_key  => "123456789012347890"
+    }
+
+You might enable this inside production.rb / development
+Remember, the MadMimi API uses HTTP POST requests that may fail
+
+    config.action_mailer.raise_delivery_errors = true
+
+## Mailers
+
+Inside the mailer you can put the promotion_name [required for Mad Mimi]:
+
+    mail to: the_email_addresses, promotion_name: 'Promo 1', track_links: :off
+
+1. Required params
+  * to [String]
+  * promotion_name [String]
+  * view to be rendered [only html format supported]
+
+2. Optional params
+  ** Use only :on or :off for boolean params **
+  * subject [String]
+    The subject of the message, if this is omitted, Action Mailer will ask the Rails I18n class for a translated :subject in the scope of [mailer_scope, action_name] or if this is missing, will translate the humanized version of the action_name
+  * bcc [String]
+  * check_suppressed [:on or :off]
+    Checks if the recipient is suppressed and does not send if so (default: :off)
+    WARNING: This parameter must still be included if the transactional email includes an unsubscribe link.
+  * track_links [:on or :off]
+    Enable or disable link tracking in HTML promotions (default: :on).
+  * hidden [:on or :off]
+    Creates the promotion as a hidden promotion so as not to clutter up your web interface (default: :off).
+  * skip_placeholders [:on or :off]
+    If you would like Mimi to ignore any {placeholders} you can add this optional parameter (default: :off).
+  * remove_unsubscribe [:on or :off]
+    If you created the promotion using custom HTML on the website and would like Mimi to remove the unsubscribe link (default: :off).
+
+
+## Mailer view
+And don't forget to place the mimi macros inside the view:
+
+You must include either the [[tracking_beacon]] or [[peek_image]] macro (they are aliases). This is used for tracking opens.
+
+You can also include a [[confirmation_link]] macro in the body of the mail. When it is used, the audience member you’re sending to will be suppressed until they click on the confirmation link in the mail.
+
+---
+# That's all you need :)

data/lib/mail/madmimi/sender.rb

@@ -0,0 +1,64 @@
+require 'httparty'
+
+module Mail
+  module Madmimi
+    class Sender
+      class MadmimiError < StandardError; end
+      attr_accessor :settings
+
+      include ::HTTParty
+      base_uri 'https://api.madmimi.com'
+
+      def initialize(settings = {})
+        unless settings[:username] && settings[:api_key]
+          raise MadmimiError, "Missing username or api_key"
+        end
+
+        self.settings = settings
+      end
+
+      def deliver!(mail)
+        resp = self.class.post '/mailer', body: email_post_body(mail)
+        parse_response(resp)
+      end
+
+      def parse_response(resp)
+        case resp.headers["status"]
+          when 200..299 then resp.parsed_response
+          else raise MadmimiError.new "status=#{resp.headers["status"]}; " + resp.parsed_response
+        end
+      end
+
+      def email_post_body(mail)
+        options = settings.merge(
+          recipients:     mail[:to].to_s.gsub(",", ";"),
+          promotion_name: mail[:promotion_name].to_s,
+          subject:        mail.subject.to_s,
+          raw_html:       html_data(mail).to_s
+        )
+
+        options.merge!(from: mail[:from].to_s) unless mail[:from].to_s.empty?
+        options.merge!(bcc:  mail[:bcc].to_s)  unless mail[:bcc].to_s.empty?
+
+        boolean_params = [:check_suppressed, :track_links, :hidden,
+          :skip_placeholders, :remove_unsubscribe]
+
+        boolean_params.each do |param|
+          options.merge!(param => mail[param].to_s) unless mail[param].to_s.empty?
+        end
+
+        options
+      end
+
+      def html_data(mail)
+        html_data = mail.find_first_mime_type('text/html')
+
+        if html_data
+          html_data.body
+        else
+          mail.mime_type == 'text/html' ? mail.body : nil
+        end
+      end
+    end
+  end
+end

data/lib/mail/madmimi/version.rb

@@ -0,0 +1,5 @@
+module Mail
+  module Madmimi
+    VERSION = "0.0.1"
+  end
+end

data/lib/mail/madmimi.rb

@@ -0,0 +1,8 @@
+require 'mail/madmimi/version'
+require 'mail/madmimi/sender'
+
+module Mail
+  module Madmimi
+    ActionMailer::Base.add_delivery_method :mad_mimi, Mail::Madmimi::Sender
+  end
+end

data/mail-madmimi.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mail/madmimi/version'
+
+Gem::Specification.new do |s|
+  s.name        = "mail-madmimi"
+  s.version     = Mail::Madmimi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Guilherme Otranto"]
+  s.email       = ["guilherme_otran@hotmail.com"]
+  s.summary     = "A Mad Mimi Mail delivery for ActionMailer, Rails 4."
+  s.description = "ActionMailer send method for madmimi api"
+  s.homepage    = "https://github.com/guilherme-otran/madmimi-rails4"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # This gem will work with 1.9.3 or greater...
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_runtime_dependency "httparty", "~> 0.13.0"
+  s.add_runtime_dependency "mail", ">= 2.5.4"
+  s.add_runtime_dependency "actionmailer", ">= 4.0.0"
+  s.add_development_dependency "rspec", "~> 2.14.1"
+end

data/spec/mail/madmimi/sender_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+
+describe Mail::Madmimi::Sender do
+  let(:valid_settings) { { username: "none@example.com", api_key: "1234567890" } }
+  let(:mimi_sender) { described_class.new valid_settings }
+  let(:email_basic_options) { { to: "somebody@example.org", promotion_name: "Promo", subject: "Hi" } }
+  let(:email) { TestMailer.test_mail(email_basic_options) }
+
+  context "Create without api key or username" do
+    it "raises an error" do
+      expect { described_class.new }.to raise_error Mail::Madmimi::Sender::MadmimiError
+    end
+  end
+
+  describe "#email_post_body" do
+    context "return a hash with mimi required attributes" do
+      it "promotion_name" do
+        mimi_sender.email_post_body(email)[:promotion_name].should == "Promo"
+      end
+
+      it "recipients" do
+        mimi_sender.email_post_body(email)[:recipients].should == "somebody@example.org"
+      end
+
+      it "raw_html" do
+        mimi_sender.email_post_body(email)[:raw_html].should == "Oi :P"
+      end
+
+      it "subject" do
+        mimi_sender.email_post_body(email)[:subject].should == "Hi"
+      end
+    end
+
+    context "optional string attributes" do
+      [:from, :bcc].each do |attribute|
+        it "include the #{attribute}" do
+          my_mail_options = email_basic_options.merge(attribute => attribute.to_s)
+          my_email = TestMailer.test_mail(my_mail_options)
+          mimi_sender.email_post_body(my_email)[attribute].should == attribute.to_s
+        end
+
+        it "not include #{attribute}" do
+          mimi_sender.email_post_body(email).should_not have_key(attribute)
+        end
+      end
+    end
+
+    context "optional boolean params" do
+      booleans = [:check_suppressed, :track_links, :hidden,
+          :skip_placeholders, :remove_unsubscribe]
+
+      booleans.each do |attribute|
+        [:on, :off].each do |boolean|
+          it "include the #{attribute} with #{boolean}" do
+            my_mail_options = email_basic_options.merge(attribute => boolean)
+            my_email = TestMailer.test_mail(my_mail_options)
+            mimi_sender.email_post_body(my_email)[attribute].should == boolean.to_s
+          end
+        end
+
+        it "not include #{attribute}" do
+          mimi_sender.email_post_body(email).should_not have_key(attribute)
+        end
+      end
+    end
+  end
+
+  describe "#parse_response" do
+    context "Received a ok response" do
+      let(:ok_reponse) { CorrectResponse.new }
+
+      it { mimi_sender.parse_response(ok_reponse).should == "1234567890" }
+    end
+
+    context "Received a non ok response" do
+      let(:invalid_response) { IncorrectResponse.new }
+
+      it "raises an error" do
+        expect { mimi_sender.parse_response(invalid_response) }
+          .to raise_error Mail::Madmimi::Sender::MadmimiError
+      end
+    end
+  end
+
+  describe "#deliver!" do
+    it "posted the email" do
+      Mail::Madmimi::Sender.should_receive(:post).and_return(CorrectResponse.new)
+      mimi_sender.deliver!(email)
+    end
+
+    it "posted with correct path" do
+      Mail::Madmimi::Sender.should_receive(:post)
+        .with('/mailer', anything)
+        .and_return(CorrectResponse.new)
+      mimi_sender.deliver!(email)
+    end
+
+    it "posted with correct body" do
+      Mail::Madmimi::Sender.should_receive(:post)
+        .with(anything, body: mimi_sender.email_post_body(email))
+        .and_return(CorrectResponse.new)
+      mimi_sender.deliver!(email)
+    end
+  end
+end

data/spec/mail/madmimi_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Mail::Madmimi, "ActionMailer load process" do
+  it "registers as delivery method" do
+    ActionMailer::Base.delivery_methods[:mad_mimi].should == Mail::Madmimi::Sender
+  end
+end
+
+describe Mail::Madmimi, "ActionMailer integration process" do
+  let(:email) { TestMailer.test_mail(promotion_name: "Bla", to: "hi@hi.com") }
+  let(:valid_settings) { { username: "none@example.com", api_key: "1234567890" } }
+
+  before do
+    ActionMailer::Base.delivery_method = :mad_mimi
+    ActionMailer::Base.mad_mimi_settings = valid_settings
+  end
+
+  it "Madmimi::Sender instance receives the mail to send after delivering it" do
+    Mail::Madmimi::Sender.any_instance.should_receive(:deliver!).with(email)
+    email.deliver
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'action_mailer'
+require 'mail/madmimi'
+
+class TestMailer < ActionMailer::Base
+  def test_mail(params_to_test)
+    mail(params_to_test) do |format|
+        format.html { render(text: "Oi :P") }
+      end
+  end
+end
+
+class CorrectResponse
+  def headers
+    { "status" => 200 }
+  end
+
+  def parsed_response
+    # Transaction ID
+    "1234567890"
+  end
+end
+
+class IncorrectResponse
+  def headers
+    { "status" => 403 }
+  end
+
+  def parsed_response
+    "Not authorized"
+  end
+end
+

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: mail-madmimi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Guilherme Otranto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.5.4
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: ActionMailer send method for madmimi api
+email:
+- guilherme_otran@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .arcconfig
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/mail/madmimi.rb
+- lib/mail/madmimi/sender.rb
+- lib/mail/madmimi/version.rb
+- mail-madmimi.gemspec
+- spec/mail/madmimi/sender_spec.rb
+- spec/mail/madmimi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/guilherme-otran/madmimi-rails4
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Mad Mimi Mail delivery for ActionMailer, Rails 4.
+test_files:
+- spec/mail/madmimi/sender_spec.rb
+- spec/mail/madmimi_spec.rb
+- spec/spec_helper.rb