mad_mimi_two 0.0.5

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2010-05-23
+
+* First Draft
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/mad_mimi_two.rb
+lib/mad_mimi_two/mad_mimi_mailer.rb
+lib/mad_mimi_two/mad_mimi_message.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_mad_mimi_two.rb

data/PostInstall.txt

@@ -0,0 +1,4 @@
+For more information on mad_mimi_two, see 
+http://github.com/semdinsp/mad_mimi_two
+
+

data/README.rdoc

@@ -0,0 +1,99 @@
+= mad_mimi_two
+
+* http://github.com/semdinsp/mad_mimi_two
+
+courtesy scott sproule
+www.estormtech.com
+
+Why use Mad Mimi rather than action mailer?  Primarily since it allows you to separate the design of your emails from the code. Create nice designs on  mad mimi, add analytics tracking urls, and update the contents of promotions via the mad mimi interface rather than trying to do it all in your code.
+
+== DESCRIPTION:
+
+Using Mad Mimi on rails 3.  All of the elegant portions of the code are based on the original http://github.com/redsquirrel/mad_mimi_mailer by ethangunderson.
+
+All of the terrible stuff is by me.  Apologies for taking an elegant solution and just crafting something that works.
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+This has only been tested on Ruby 1.8.7.
+Testing on Ruby 1.9 required.
+Currently against rails 3 beta
+
+
+== SYNOPSIS:
+== API CONFIG 
+Setup your api key in application.rb  (at the end of the file, after the end for the config)
+ MadMimiTwo::MadMimiMessage.api_settings = {
+    :username => 'your_username@xys.com',
+    :api_key => 'your api key'
+  }
+
+== GEMFILE:
+gem 'mad_mimi_two'
+
+== MIMI MODEL
+set up model  in your rails model directory (something like the following)
+class MadMimi <  MadMimiTwo::MadMimiMessage
+  def self.mimi_promotion(tpromotion,tuser,thashvalues,cclist, tsubj)
+    msg=MadMimiTwo::MadMimiMessage.new do
+      	  subject    tsubj
+     to tuser
+     cc          cclist
+     promotion   tpromotion  #[MAD MIMI PROMOTION NAME]
+     from       'support@estormtech.com'
+     bcc        ["xyze@estormtech.com", "abc@estormtech.com"]
+     email_placeholders        thashvalues  # [VALUES THAT NEED TO BE INSERTED AT MAD MIMI EMAIL  these are the values in {} in the mad mimi email that you want replaced  eg {:url='www.estormtech.com'}]
+     content_type "text/html" 
+   end
+   msg.deliver_mimi_message  # will return the mimi id -like 1151306886 if all ok.
+  end
+end
+
+to use it:
+MadMimi.mimi_promotion('promoname','test@email.com',{:url=>'www.estormtech.com'},'cc@email.com','demo subject')
+this will return a ID from mad mimi like 1151260526
+
+IGNORE: warning: peer certificate won't be verified in this SSL session
+
+== Mail::Message
+As this is subclassed from Mail::Message I believe that other ways to create the message will also work (such as passing in hash, etc (see the documentation))
+
+== REQUIREMENTS:
+
+gem activesupport
+gem mail
+(but both of these needed for rails)
+
+== INSTALL:
+
+gem install mad_mimi_two   (it is now up on rubygems.org)
+
+== RAILS TESTING:
+
+Apologies but this needs work.  I have simple tests in my application but nothing spectaculre.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 FIXME full name
+
+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/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/mad_mimi_two'
+
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'mad_mimi_two' do
+  self.developer 'scott sproule', 'scott.sproule@ficonab.com'
+  self.post_install_message = 'For more information on mad_mimi_two, see 
+  http://github.com/semdinsp/mad_mimi_two' # TODO remove if post-install message not required
+  self.rubyforge_name       = self.name # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "mad_mimi_two"
+    gemspec.summary = "Use MadMimi with Rails 3"
+    gemspec.description = "Use MadMimi with Rails 3"
+    gemspec.email = "scott.sproule@estormtech.com"
+    gemspec.homepage = "http://github.com/semdinsp/mad-mimi-on-rails-3"
+    gemspec.authors = ["Scott Sproule","and others from original gem"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+

data/lib/mad_mimi_two/mad_mimi_mailer.rb

@@ -0,0 +1,191 @@
+module MadMimiTwo
+  module MadMimiMailer
+  SINGLE_SEND_URL = 'https://api.madmimi.com/mailer'
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  # Custom Mailer attributes
+
+  def promotion(promo = nil)
+    if promo.nil?
+      @promotion
+    else
+      @promotion = promo #promotion
+    end
+  end
+
+  def use_erb(use_erb = nil)
+    if use_erb.nil?
+      @use_erb
+    else
+      @use_erb = use_erb
+    end
+  end
+  def email_placeholders(ep = nil)
+     if ep.nil?
+       @email_placeholders
+     else
+       @email_placeholders = ep
+     end
+   end
+
+  def hidden(hidden = nil)
+    if hidden.nil?
+      @hidden
+    else
+      @hidden = hidden
+    end
+  end
+  
+  def unconfirmed(value = nil)
+    if value.nil?
+      @unconfirmed
+    else
+      @unconfirmed = value
+    end
+  end
+   def deliver_mimi_message()
+      mail = self
+      return unless perform_deliveries
+
+      if delivery_method == :test
+        deliveries << (mail.mail ? mail.mail : mail)
+      else
+        if (all_recipients = mail[:to]).is_a? Array
+          all_recipients.each do |recipient|
+            mail.recipients = recipient
+            call_api!()
+          end
+        else
+          call_api!()
+        end
+      end
+    end
+      def call_api!()
+        params = {
+          'username' => MadMimiTwo::MadMimiMessage.api_settings[:username],
+          'api_key' =>  MadMimiTwo::MadMimiMessage.api_settings[:api_key],
+          'promotion_name' => self.promotion, # scott || method.to_s.sub(/^#{method_prefix}_/, ''),
+          'recipients' =>     serialize(self[:to].to_s.split(',')),   #removed to_a, needs comma
+          'subject' =>        self[:subject].to_s,
+          'bcc' =>            serialize(self[:bcc].to_s.split(',') || MadMimiMailer.default_parameters[:bcc]),
+          'from' =>           (self[:from].to_s || MadMimiMailer.default_parameters[:from]),
+          'hidden' =>         serialize(self.hidden)
+        }
+        params['body']= self.email_placeholders.to_yaml
+puts "params: #{params.inspect} to string #{params.to_s}"
+       #scott  params['unconfirmed'] = '1' if mail.unconfirmed
+
+      #scott)  if use_erb?(mail)
+      #scott    if mail.parts.any?
+         #scott   params['raw_plain_text'] = content_for(mail, "text/plain")
+         #scott   params['raw_html'] = content_for(mail, "text/html") { |html| validate(html.body) }
+      #scott    else
+      #scott      validate(mail.body)
+      #scott      params['raw_html'] = mail.body
+      #scott    end
+       #scott else
+       #scott   stringified_default_body = (MadMimiMailer.default_parameters[:body] || {}).stringify_keys!
+       #scott   stringified_mail_body = (mail.body || {}).stringify_keys!
+       #scott   body_hash = stringified_default_body.merge(stringified_mail_body)
+      #scott    params['body'] = body_hash.to_yaml
+      #scott  end
+
+        response = post_request do |request|
+          request.set_form_data(params)
+        end
+
+        case response
+        when Net::HTTPSuccess
+          response.body
+        else
+          response.error!
+        end
+      end
+
+      def content_for( content_type)
+        part = self.parts.detect {|p| p.content_type == content_type }
+        if part
+          yield(part) if block_given?
+          part.body
+        end
+      end
+
+      def validate(content)
+        unless content.include?("[[peek_image]]") || content.include?("[[tracking_beacon]]")
+          raise MadMimiMailer::ValidationError, "You must include a web beacon in your Mimi email: [[peek_image]]"
+        end
+      end
+
+      def post_request
+        url = URI.parse(SINGLE_SEND_URL)
+        request = Net::HTTP::Post.new(url.path)
+        yield(request)
+        http = Net::HTTP.new(url.host, url.port)
+        http.use_ssl = true
+        http.start do |http|
+          http.request(request)
+        end
+      end
+
+      def serialize(recipients)
+        case recipients
+        when String
+          recipients
+        when Array
+          recipients.join(", ")
+        when NilClass
+          nil
+        else
+          raise "Please provide a String or an Array for recipients or bcc."
+        end
+      end
+
+      def use_erb?()
+        self.use_erb || use_erb
+      end
+    end
+
+  module ClassMethods
+    attr_accessor :method_prefix, :use_erb
+    
+    def method_missing(method_symbol, *parameters)
+      if method_prefix && method_symbol.id2name.match(/^deliver_(#{method_prefix}_[_a-z]\w*)/)
+        deliver_mimi_mail($1, *parameters)
+      elsif method_prefix.nil? && method_symbol.id2name.match(/^deliver_([_a-z]\w*)/)
+        deliver_mimi_mail($1, *parameters)
+      else
+        super
+      end
+    end
+   
+    def deliver_mimi_mail(method, *parameters)
+      mail = new
+      mail.__send__(method, *parameters)
+
+      if use_erb?(mail)
+        mail.create!(method, *parameters)
+      end
+
+      return unless perform_deliveries
+
+      if delivery_method == :test
+        deliveries << (mail.mail ? mail.mail : mail)
+      else
+        if (all_recipients = mail.recipients).is_a? Array
+          all_recipients.each do |recipient|
+            mail.recipients = recipient
+            call_api!(mail, method)
+          end
+        else
+          call_api!(mail, method)
+        end
+      end
+    end
+
+  
+
+end
+end  #module

data/lib/mad_mimi_two/mad_mimi_message.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+gem 'mail'
+require "mail"
+require "net/https"
+require 'mad_mimi_mailer'
+gem 'activesupport'
+require 'active_support/core_ext/class/attribute_accessors'
+
+
+module MadMimiTwo
+class MadMimiMessage < Mail::Message
+ 
+
+  @@api_settings = {}
+  cattr_accessor :api_settings
+  
+  @@default_parameters = {}
+  cattr_accessor :default_parameters
+  #promotion =Mail::Field.new('promotion')
+
+  include MadMimiTwo::MadMimiMailer
+  self.method_prefix = "mimi"
+
+  class ValidationError < StandardError; end
+end
+end #module
+
+# Adding the response body to HTTPResponse errors to provide better error messages.
+module Net
+  class HTTPResponse
+    def error!
+      message = @code + ' ' + @message.dump + ' ' + body
+      raise error_type().new(message, self)
+    end
+  end
+end

data/lib/mad_mimi_two.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+Dir[File.join(File.dirname(__FILE__), 'mad_mimi_two/**/*.rb')].sort.each { |lib| require lib }
+
+module MadMimiTwo
+  VERSION = '0.0.5'
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/mad_mimi_two'

data/test/test_mad_mimi_two.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestMadMimiTwo < Test::Unit::TestCase
+
+  def setup
+    MadMimiTwo::MadMimiMessage.api_settings = {
+        :username => 'scott.sproule@estormtech.com',
+        :api_key => '662b407ded7138f10ea7b41561f25694'
+      }
+  end
+  
+  def test_initial_class
+    t=MadMimiTwo::MadMimiMessage.new
+    puts t.inspect
+    assert t.headers.size==0, "headers not empty"
+  end
+  def test_header_setup
+    t=MadMimiTwo::MadMimiMessage.new do
+      subject    'tsubj test subject'
+      to 'scott.sproule@ficonab.com'
+    #  cc          admin
+      promotion   'new_crm'
+      from       'support@estormtech.com'
+      bcc        ["scott.sproule@estormtech.com", "eka.mardiarti@estormtech.com"]
+     # sent_on    Time.now
+      body       "body thashvalues"  # :user => tuser, :url => turl 
+      content_type "text/html"
+    end
+    puts t.inspect
+    assert t.headers.size==0, "headers not empty"
+    assert t[:to].to_s=='scott.sproule@ficonab.com', "to person not correct #{t[:to]}"
+    assert t.promotion.to_s=='new_crm', 'promotion first wrong'
+    #assert t[:promotion].to_s=='new_crm', 'promotion wrong'
+  end
+  def test_sending_mesage
+    thash={:user => 'test', :url => 'test.estormtech.com' } 
+    t=MadMimiTwo::MadMimiMessage.new do
+      subject    'tsubj test subject'
+      to 'scott.sproule@ficonab.com'
+    #  cc          admin
+      promotion   'new_crm'
+      from       'support@estormtech.com'
+      bcc        ["scott.sproule@estormtech.com", "eka.mardiarti@estormtech.com"]
+     # sent_on    Time.now
+      email_placeholders       thash  # :user => tuser, :url => turl 
+      content_type "text/html"
+    end
+ #   t.email_placeholders(thash)
+    r=t.deliver_mimi_message
+    puts "result: #{r} message:  t.inspect"
+    assert t.headers.size==0, "headers not empty"
+    assert t.headers.size==0, "headers not empty"
+    assert t[:to].to_s=='scott.sproule@ficonab.com', "to person not correct #{t[:to]}"
+    assert t.promotion.to_s=='new_crm', 'promotion first wrong'
+    #assert t[:promotion].to_s=='new_crm', 'promotion wrong'
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: mad_mimi_two
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Scott Sproule
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-23 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: Update to the original madmimimailer gem to support the new actionmailer of rails3
+email: scott.sproule@estormtech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mad_mimi_two/mad_mimi_mailer.rb
+- lib/mad_mimi_two/mad_mimi_message.rb
+- lib/mad_mimi_two.rb
+- test/test_helper.rb
+- test/test_mad_mimi_two.rb
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/semdinsp/mad-mimi-on-rails-3
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: mad_mimi_two
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Use MadMimi with Rails 3
+test_files: []
+