mad_mimi_two 0.04 → 0.5.0

data/README.rdoc

@@ -5,11 +5,11 @@
 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.
+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. (MadMimiTwo also runs in Rails 2)
 
 All of the terrible stuff is by me.  Apologies for taking an elegant solution and just crafting something that works.
 
@@ -18,13 +18,11 @@ All of the terrible stuff is by me.  Apologies for taking an elegant solution an
 * 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
+Currently tested and working with rails 3 beta and Rails 2 (same code works)
 
-If someone could suggest how to get rid of this I would be grateful:
-./lib/mad_mimi_two/mad_mimi_mailer.rb:71: warning: default `to_a' will be obsolete
 
 == SYNOPSIS:
-== API CONFIG
+== 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',
@@ -35,7 +33,7 @@ Setup your api key in application.rb  (at the end of the file, after the end for
 gem 'mad_mimi_two'
 
 == MIMI MODEL
-set up model  (something like this)
+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
@@ -44,7 +42,7 @@ class MadMimi <  MadMimiTwo::MadMimiMessage
      cc          cclist
      promotion   tpromotion  #[MAD MIMI PROMOTION NAME]
      from       'support@estormtech.com'
-     bcc        ["scott.sproule@estormtech.com", "eka.mardiarti@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
@@ -58,6 +56,20 @@ 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))
+
+== Check Status of sent message
+ 		t=MadMimiTwo::MadMimiMessage.new
+		r=t.check_status('1159748168')   # this is value from ID
+		 r is 'Sent'	
+
+== RAILS 2:
+NOTE, The same code works in Rails 2 as well.
+except that you need to change environment.rb 
+  config.gem 'mad_mimi_two'
+and at the end of the environment.rb file:
+insert the api settings.
 
 == REQUIREMENTS:
 
@@ -67,8 +79,11 @@ gem mail
 
 == INSTALL:
 
-loading on gem server is a todo...
-download from github to start with :) sorry.
+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 spectacular.
 
 == LICENSE:
 

data/Rakefile

@@ -16,7 +16,7 @@ $hoe = Hoe.spec 'mad_mimi_two' do
   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']]
+  #self.add_dependency("httpclient")     
 
 end
 

data/lib/mad_mimi_two/mad_mimi_mailer.rb

@@ -1,3 +1,14 @@
+require 'cgi'
+require 'rubygems'
+gem 'httpclient'
+require 'httpclient'
+class Hash
+  def madmimiurlencode
+    to_a.map do |name_value|
+      name_value.map { |e| CGI.escape e.to_s }.join '='
+    end.join '&'
+  end
+end
 module MadMimiTwo
   module MadMimiMailer
   SINGLE_SEND_URL = 'https://api.madmimi.com/mailer'
@@ -5,6 +16,17 @@ module MadMimiTwo
   def self.included(base)
     base.extend(ClassMethods)
   end
+  # check the status of a sent email
+  def check_status(msg_id)
+    url = "#{SINGLE_SEND_URL}s/status/#{msg_id}?#{MadMimiTwo::MadMimiMessage.api_settings.madmimiurlencode}"
+    begin
+      client= HTTPClient.new
+      res=client.get_content(url)
+    rescue HTTPClient::BadResponseError
+      res="problem retrieving status"
+    end
+    res
+  end
   
   # Custom Mailer attributes
 
@@ -68,9 +90,9 @@ module MadMimiTwo
           '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_a),
+          'recipients' =>     serialize(self[:to].to_s.split(',')),   #removed to_a, needs comma
           'subject' =>        self[:subject].to_s,
-          'bcc' =>            serialize(self[:bcc].to_a || MadMimiMailer.default_parameters[:bcc]),
+          'bcc' =>            serialize(self[:bcc].to_s.split(',') || MadMimiMailer.default_parameters[:bcc]),
           'from' =>           (self[:from].to_s || MadMimiMailer.default_parameters[:from]),
           'hidden' =>         serialize(self.hidden)
         }

data/lib/mad_mimi_two.rb

@@ -3,5 +3,5 @@ $:.unshift(File.dirname(__FILE__)) unless
 Dir[File.join(File.dirname(__FILE__), 'mad_mimi_two/**/*.rb')].sort.each { |lib| require lib }
 
 module MadMimiTwo
-  VERSION = '0.0.3'
+  VERSION = '0.0.6'
 end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/mad_mimi_two.rb'}"
+puts "Loading mad_mimi_two gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_mad_mimi_two.rb

@@ -14,7 +14,9 @@ class TestMadMimiTwo < Test::Unit::TestCase
     puts t.inspect
     assert t.headers.size==0, "headers not empty"
   end
-  def test_header_setup
+  def test_header
+     test="hello there"
+    hashv={ :body => test, :user => 'string'}
     t=MadMimiTwo::MadMimiMessage.new do
       subject    'tsubj test subject'
       to 'scott.sproule@ficonab.com'
@@ -23,13 +25,33 @@ class TestMadMimiTwo < Test::Unit::TestCase
       from       'support@estormtech.com'
       bcc        ["scott.sproule@estormtech.com", "eka.mardiarti@estormtech.com"]
      # sent_on    Time.now
-      body       "body thashvalues"  # :user => tuser, :url => turl 
+      email_placeholders       hashv  # :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.email_placeholders.has_key?(:body), "placeholders seem wrong #{t.email_placeholders}"
+     assert t.email_placeholders.value?("hello there"), "placeholders seem wrong #{t.email_placeholders}"
+    #assert t[:promotion].to_s=='new_crm', 'promotion wrong'
+  end
+  def test_header_setup2
+    test="hello there"
+    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      :body => test, :user => 'string'
+      content_type "text/html"
+    end
+    puts t.inspect
+    assert t.email_placeholders.has_key?(:body), "placeholders seem wrong #{t.email_placeholders}"
+     assert t.email_placeholders.value?("hello there"), "placeholders seem wrong #{t.email_placeholders}"
     #assert t[:promotion].to_s=='new_crm', 'promotion wrong'
   end
   def test_sending_mesage
@@ -47,11 +69,19 @@ class TestMadMimiTwo < Test::Unit::TestCase
     end
  #   t.email_placeholders(thash)
     r=t.deliver_mimi_message
-    puts "result: #{r} message:  t.inspect"
-    assert t.headers.size==0, "headers not empty"
+    puts "result: #{r} message:  #{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_check_status
+   # puts "message id: 1159748168"   (old message id)
+    t=MadMimiTwo::MadMimiMessage.new
+    r=t.check_status('1159748168')
+    puts "'r is ' #{r}"
+    assert r.class==String, "response is not string r is: #{r} #{r.class}"
+    assert r=='sent', "message response not correct: #{r}"
+     
+  end
 end

metadata

@@ -1,49 +1,93 @@
 --- !ruby/object:Gem::Specification 
 name: mad_mimi_two
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 4
-  version: "0.04"
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
-- Scott Sproule
+- scott sproule
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-23 00:00:00 +08:00
+date: 2010-05-26 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
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 2
+        - 0
+        - 3
+        version: 2.0.3
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+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. (MadMimiTwo also runs in Rails 2)
+  
+  All of the terrible stuff is by me.  Apologies for taking an elegant solution and just crafting something that works.
+email: 
+- scott.sproule@ficonab.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
 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
+- 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
 has_rdoc: true
-homepage: http://github.com/semdinsp/mad-mimi-on-rails-3
+homepage: http://github.com/semdinsp/mad_mimi_two
 licenses: []
 
-post_install_message: 
-rdoc_options: []
-
+post_install_message: |-
+  For more information on mad_mimi_two, see 
+    http://github.com/semdinsp/mad_mimi_two
+rdoc_options: 
+- --main
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -60,18 +104,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 19
+      hash: 3
       segments: 
-      - 1
-      - 3
-      - 4
-      version: 1.3.4
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: mad_mimi_two
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Use MadMimi with Rails 3
-test_files: []
-
+summary: Using Mad Mimi on rails 3
+test_files: 
+- test/test_helper.rb
+- test/test_mad_mimi_two.rb