madmimi 1.0.14 → 1.0.15

data/README.rdoc

@@ -15,6 +15,8 @@ mimi = MadMimi.new('emailaddress', 'api_key')
 
 mimi.lists -> get all of your Mad Mimi lists returned as a hash
 
+=== Audience Members and Lists
+
 mimi.memberships('email') -> returns a hash of the lists that specific email address is subscribed to
 
 mimi.new_list('New list name') -> make a new list
@@ -29,8 +31,12 @@ mimi.remove_from_list('dave@example.com', 'Test List') -> remove this email addr
 
 mimi.suppressed_since('unix timestamp') -> get a TXT of all addresses that were suppressed since this timestamp
 
+=== Promotions
+
 mimi.promotions -> returns a hash of your promotions
 
+mimi.save_promotion('promotion_name', 'raw_html', 'plain_text') -> saves a promotion (creates the promotion if it does not exist)
+
 mimi.mailing_stats('promotion_id', 'mailing_id') -> get stats on a specific mailing
 
 == Sending E-Mail (using the Mailer API)
@@ -84,6 +90,8 @@ If it exists and you specify raw_html, the promotion body will be replaced.
 'list_name': For all of the #send methods, if 'list_name' is provided, the recipients
 will be those for an already-existing "audience."
 
+'to_all': Set to true to send a promotion, plain_text or raw_html to all your audience members
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-1.0.14
+1.0.15

data/lib/madmimi.rb

@@ -37,17 +37,23 @@ class MadMimi
   class MadMimiError < StandardError; end
 
   BASE_URL = 'api.madmimi.com'
+  
   NEW_LISTS_PATH = '/audience_lists'
   AUDIENCE_MEMBERS_PATH = '/audience_members'
   AUDIENCE_LISTS_PATH = '/audience_lists/lists.xml'
   MEMBERSHIPS_PATH = '/audience_members/%email%/lists.xml'
   SUPPRESSED_SINCE_PATH = '/audience_members/suppressed_since/%timestamp%.txt'
   SUPPRESS_USER_PATH = ' /audience_members/%email%/suppress_email'
+  SEARCH_PATH = '/audience_members/search.xml'
+  
   PROMOTIONS_PATH = '/promotions.xml'
+  PROMOTION_SAVE_PATH = '/promotions/save'
+  
   MAILING_STATS_PATH = '/promotions/%promotion_id%/mailings/%mailing_id%.xml'
-  SEARCH_PATH = '/audience_members/search.xml'
+  
   MAILER_PATH = '/mailer'
   MAILER_TO_LIST_PATH = '/mailer/to_list'
+  MAILER_TO_ALL_PATH = '/mailer/to_all'
   MAILER_STATUS_PATH = '/mailers/status'
 
   def initialize(username, api_key)
@@ -66,6 +72,7 @@ class MadMimi
     { :username => username, :api_key => api_key }
   end
 
+  # Audience and lists
   def lists
     request = do_request(AUDIENCE_LISTS_PATH, :get)
     Crack::XML.parse(request)
@@ -109,49 +116,69 @@ class MadMimi
     do_request(SUPPRESS_USER_PATH.gsub('%email%', email), :post)
   end
 
+  def audience_search(query_string, raw = false)
+    request = do_request(SEARCH_PATH, :get, :raw => raw, :query => query_string)
+    Crack::XML.parse(request)
+  end
+
+  # Not the most elegant, but it works for now. :)
+  def add_users_to_list(list_name, arr)
+    arr.each do |a|
+      a[:add_list] = list_name
+      add_user(a)
+    end
+  end
+  
+  # Promotions
   def promotions
     request = do_request(PROMOTIONS_PATH, :get)
     Crack::XML.parse(request)
   end
-
+  
+  def save_promotion(promotion_name, raw_html, plain_text = nil)
+    options = { :promotion_name => promotion_name }
+    
+    unless raw_html.nil?
+      check_for_tracking_beacon raw_html
+      check_for_opt_out raw_html
+      options[:raw_html] = raw_html
+    end
+    
+    unless plain_text.nil?
+      check_for_opt_out plain_text
+      options[:raw_plain_text] = plain_text
+    end
+    
+    do_request PROMOTION_SAVE_PATH, :post, options
+  end
+  
+  # Stats
   def mailing_stats(promotion_id, mailing_id)
     path = MAILING_STATS_PATH.gsub('%promotion_id%', promotion_id).gsub('%mailing_id%', mailing_id)
     request = do_request(path, :get)
     Crack::XML.parse(request)
   end
 
-  def audience_search(query_string, raw = false)
-    request = do_request(SEARCH_PATH, :get, :raw => raw, :query => query_string)
-    Crack::XML.parse(request)
-  end
-
+  # Mailer API
   def send_mail(opt, yaml_body)
     options = opt.dup
     options[:body] = yaml_body.to_yaml
-    if !options[:list_name].nil?
-      do_request(MAILER_TO_LIST_PATH, :post, options, true)
+    if !options[:list_name].nil? || options[:to_all]
+      do_request(options[:to_all] ? MAILER_TO_ALL_PATH : MAILER_TO_LIST_PATH, :post, options, true)
     else
       do_request(MAILER_PATH, :post, options, true)
     end
   end
   
-  # Not the most elegant, but it works for now. :)
-  def add_users_to_list(list_name, arr)
-    arr.each do |a|
-      a[:add_list] = list_name
-      add_user(a)
-    end
-  end
-
   def send_html(opt, html)
     options = opt.dup
     if html.include?('[[tracking_beacon]]') || html.include?('[[peek_image]]')
       options[:raw_html] = html
-      if !options[:list_name].nil?
+      if !options[:list_name].nil? || options[:to_all]
         unless html.include?('[[unsubscribe]]') || html.include?('[[opt_out]]')
           raise MadMimiError, "When specifying list_name, include the [[unsubscribe]] or [[opt_out]] macro in your HTML before sending."
         end
-        do_request(MAILER_TO_LIST_PATH, :post, options, true)
+        do_request(options[:to_all] ? MAILER_TO_ALL_PATH : MAILER_TO_LIST_PATH, :post, options, true)
       else
         do_request(MAILER_PATH, :post, options, true)
       end
@@ -163,9 +190,9 @@ class MadMimi
   def send_plaintext(opt, plaintext)
     options = opt.dup
     options[:raw_plain_text] = plaintext
-    if !options[:list_name].nil?
+    if !options[:list_name].nil? || options[:to_all]
       if plaintext.include?('[[unsubscribe]]') || plaintext.include?('[[opt_out]]')
-        do_request(MAILER_TO_LIST_PATH, :post, options, true)
+        do_request(options[:to_all] ? MAILER_TO_ALL_PATH : MAILER_TO_LIST_PATH, :post, options, true)
       else
         raise MadMimiError, "You'll need to include either the [[unsubscribe]] or [[opt_out]] macro in your text before sending."
       end
@@ -235,4 +262,18 @@ class MadMimi
       end
     end
   end
+  
+  def check_for_tracking_beacon(content)
+    unless content.include?('[[tracking_beacon]]') || content.include?('[[peek_image]]')
+      raise MadMimiError, "You'll need to include either the [[tracking_beacon]] or [[peek_image]] macro in your HTML before sending."
+    end
+    true
+  end
+  
+  def check_for_opt_out(content)
+    unless content.include?('[[opt_out]]') || content.include?('[[unsubscribe]]')
+      raise MadMimiError, "When specifying list_name or sending to all, include the [[unsubscribe]] or [[opt_out]] macro in your HTML before sending."
+    end
+    true
+  end
 end

data/madmimi.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{madmimi}
-  s.version = "1.0.14"
+  s.version = "1.0.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nicholas Young", "Marc Heiligers"]
-  s.date = %q{2011-03-18}
+  s.date = %q{2011-03-21}
   s.description = %q{Send emails, track statistics, and manage your subscriber base with ease.}
   s.email = %q{nicholas@madmimi.com}
   s.extra_rdoc_files = [

data/test/helper.rb

@@ -33,7 +33,7 @@ def stub_get(url, options = {})
   FakeWeb.register_uri(:get, madmimi_url(url, https), options)
 end
 
-def stub_post(url, filename = nil, status = nil)
+def stub_post(url, options)
   https = options.delete(:https)
   
   filename = options.delete(:filename)

data/test/test_madmimi.rb

@@ -1,4 +1,4 @@
-require 'helper'
+require "#{File.dirname(__FILE__)}/helper"
 
 class TestMadmimi < Test::Unit::TestCase
   context "An API call" do
@@ -24,6 +24,36 @@ class TestMadmimi < Test::Unit::TestCase
       flunk "No users found." unless response.kind_of?(Hash) || !response.empty?
     end
     
+    should "save a raw html promotion" do
+      response_body = 'Saved test_promotion (1)'
+      stub_post('/promotions/save', { :body =>  response_body })
+      response = @mimi.save_promotion('test_promotion', '<html><body>Hi there!<br>[[unsubscribe]][[tracking_beacon]]</body></html>')
+      assert_equal response_body, response
+    end
+    
+    should "save a text promotion" do
+      response_body = 'Saved test_promotion (1)'
+      stub_post('/promotions/save', { :body =>  response_body })
+      response = @mimi.save_promotion('test_promotion', nil, "Hi there!\n\n[[unsubscribe]]")
+      assert_equal response_body, response
+    end
+    
+    should "raise exception on saving a raw html promotion without the required macros" do
+      assert_raises MadMimi::MadMimiError do
+        @mimi.save_promotion('test_promotion', '<html><body>Hi there!<br>[[tracking_beacon]]</body></html>')
+      end
+      
+      assert_raises MadMimi::MadMimiError do
+        @mimi.save_promotion('test_promotion', '<html><body>Hi there!<br>[[unsubscribe]]</body></html>')
+      end
+    end
+
+    should "raise exception on saving a plain text promotion without the required macro" do
+      assert_raises MadMimi::MadMimiError do
+        @mimi.save_promotion('test_promotion', 'Hi there')
+      end
+    end
+
     should "get a transactional mailing status" do
       stub_get('/mailers/status/1234', { :https => true, :body => "sent" })
       response = @mimi.status(1234)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: madmimi
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 1
   - 0
-  - 14
-  version: 1.0.14
+  - 15
+  version: 1.0.15
 platform: ruby
 authors: 
 - Nicholas Young
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 +02:00
+date: 2011-03-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency