RubyGems - madmimi - Versions diffs - 1.0.6 → 1.0.8 - Mend

madmimi 1.0.6 → 1.0.8

Files changed (7) hide show

data/.gitignore CHANGED

@@ -1,2 +1,3 @@
 pkg
-*.gem
+*.gem
+tags

data/README.rdoc CHANGED

@@ -6,7 +6,7 @@ The power of Mad Mimi in your Ruby application. Deliver emails, track statistics
 gem install madmimi - or if you prefer to live on the edge, just clone this repository and build it from scratch.
-== A brief tutorial
+== Basic Usage
 Dependencies:
 active_support (I intend to remove this in the not too distant future, and build my own implementation.)
@@ -33,6 +33,53 @@ mimi.promotions -> returns a hash of your promotions
 mimi.mailing_stats('promotion_id', 'mailing_id') -> get stats on a specific mailing
+== Sending E-Mail (using the Mailer API)
+=== Replacing keys in your email body text:
+options = { 'promotion_name' => 'Test Promotion', 'recipients' => 'Nicholas Young <nicholas@madmimi.com>', 'from' => 'MadMimi Ruby <rubygem@madmimi.com>', 'subject' => 'Test Subject' }
+yaml_body = { 'greeting' => 'Hello', 'name' => 'Nicholas' }
+mimi.send_mail(options, yaml_body)
+=== Sending Raw HTML (presumably generated by your app)
+options = { 'promotion_name' => 'Test Promotion', 'recipients' => 'Nicholas Young <nicholas@madmimi.com>', 'from' => 'MadMimi Ruby <rubygem@madmimi.com>', 'subject' => 'Test Subject' }
+raw_html = "<html><head><title>My great promotion!</title></head><body>Body stuff[[tracking_beacon]]</body></html>"
+mimi.send_html(options, raw_html)
+=== Sending Plain Text
+options = { 'promotion_name' => 'Test Promotion', 'recipients' => 'Nicholas Young <nicholas@madmimi.com>', 'from' => 'MadMimi Ruby <rubygem@madmimi.com>', 'subject' => 'Test Subject' }
+plain_text = "Plain text email contents [[unsubscribe]]"
+mimi.send_plaintext(options, plain_text)
+=== Return values
+In most cases, a return value of a single space indicates success.
+On success, #send_mail, #send_html, and #send_plaintext return String with a numeric mailing_id. This mailing_id can be used to look up stats with #mailing_stats.
+Errors or issues preventing operation completing return a human-readable String.
+Therefore, if the return value is not a space, or is not a numeric String value, then
+there is probably an error or uncompleted operation.
+=== Specific options keys
+'raw_html': Must include at least one of the [[tracking_beacon]] or [[peek_image]] tags.
+'promotion_name': If a promotion doesn't exist under the given name, it will be created.
+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."
 == Note on Patches/Pull Requests
 * Fork the project.
@@ -43,6 +90,9 @@ mimi.mailing_stats('promotion_id', 'mailing_id') -> get stats on a specific mail
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
+== Contributors
+tuker
 == Copyright
 Copyright (c) 2010 Nicholas Young. See LICENSE for details.

data/Rakefile CHANGED

@@ -8,9 +8,10 @@ begin
     gem.summary = %Q{Mad Mimi API wrapper for Ruby}
     gem.description = %Q{Send emails, track statistics, and manage your subscriber base with ease.}
     gem.email = "nicholas@madmimi.com"
-    gem.homepage = "http://github.com/nicholaswyoung/mad_mimi_ruby"
-    gem.authors = ["Nicholas Young"]
-    gem.add_development_dependency "activesupport", ">= 2.3.5"
+    gem.homepage = "http://github.com/madmimi/madmimi-gem"
+    gem.authors = ["Nicholas Young", "Marc Heiligers"]
+    gem.add_development_dependency "crack", ">= 0.1.7"
+    gem.add_development_dependency "shoulda", "2.10.3"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 1.0.6
1	+ 1.0.8

data/lib/madmimi.rb CHANGED

@@ -1,4 +1,4 @@
-#   Mad Mimi - v.0.0.1 the incredibly basic, and barely usable version, in my opinion. (too many stinkin' dependencies!)
+#   Mad Mimi for Ruby
 #   License
@@ -29,186 +29,191 @@
 require 'uri'
 require 'net/http'
 require 'net/https'
-require 'active_support'
+require 'crack'
+require 'csv'
 class MadMimi
-  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"
-  PROMOTIONS_PATH = "/promotions.xml"
-  MAILING_STATS_PATH = "/promotions/%promotion_id%/mailings/%mailing_id%.xml"
-  SEARCH_PATH = "/audience_members/search.xml"
-  @@api_settings = {}
+  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'
+  PROMOTIONS_PATH = '/promotions.xml'
+  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'
   def initialize(username, api_key)
-    @@api_settings[:username] = username
-    @@api_settings[:api_key]  = api_key
+    @api_settings = { :username => username, :api_key => api_key }
   end
   def username
-    @@api_settings[:username]
+    @api_settings[:username]
   end
   def api_key
-    @@api_settings[:api_key]
+    @api_settings[:api_key]
   end
   def default_opt
-    { 'username' => username, 'api_key' => api_key }
+    { :username => username, :api_key => api_key }
   end
-  # Refactor this method asap
-  def do_request(path, req_type = :get, options = {}, transactional = false)
-    resp = href = "";
-    case req_type
-    when :get then
-      begin
-        http = Net::HTTP.new(BASE_URL, 80)
-        http.start do |http|
-          req = Net::HTTP::Get.new(path)
-          req.set_form_data(options)
-          response = http.request(req)
-          resp = response.body
-        end
-        resp
-      rescue SocketError
-        raise "Host unreachable."
-      end
-    when :post then
-      begin
-        if transactional == true
-          http = Net::HTTP.new(BASE_URL, 443)
-          http.use_ssl = true
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        else
-          http = Net::HTTP.new(BASE_URL, 80)
-        end
-        http.start do |http|
-          req = Net::HTTP::Post.new(path)
-          req.set_form_data(options)
-          response = http.request(req)
-          resp = response.body
-        end
-      rescue SocketError
-        raise "Host unreachable."
-      end
-    end
-  end
   def lists
-    request = do_request(AUDIENCE_LISTS_PATH, :get, default_opt)
-    Hash.from_xml(request)
+    request = do_request(AUDIENCE_LISTS_PATH, :get)
+    Crack::XML.parse(request)
   end
   def memberships(email)
-    request = do_request((MEMBERSHIPS_PATH.gsub('%email%', email)), :get, default_opt)
-    Hash.from_xml(request)
+    request = do_request(MEMBERSHIPS_PATH.gsub('%email%', email), :get)
+    Crack::XML.parse(request)
   end
   def new_list(list_name)
-    options = { 'name' => list_name }
-    do_request(NEW_LISTS_PATH, :post, options.merge(default_opt))
+    do_request(NEW_LISTS_PATH, :post, :name => list_name)
   end
   def delete_list(list_name)
-    options = { '_method' => 'delete' }
-    do_request(NEW_LISTS_PATH + "/" + URI.escape(list_name), :post, options.merge(default_opt))
+    do_request("#{NEW_LISTS_PATH}/#{URI.escape(list_name)}", :post, :'_method' => 'delete')
   end
   def csv_import(csv_string)
-    options = { 'csv_file' => csv_string }
-    do_request(AUDIENCE_MEMBERS_PATH, :post, options.merge(default_opt))
-  end
-  def build_csv(hash)
-    csv = ""
-    hash.keys.each do |key|
-      csv << "#{key},"
-    end
-    # strip out one char at the end
-    csv << "\n"
-    csv = csv[0..-1]
-    hash.values.each do |value|
-      csv << "#{value},"
-    end
-    csv = csv[0..-1]
-    csv << "\n"
+    do_request(AUDIENCE_MEMBERS_PATH, :post, :csv_file => csv_string)
   end
   def add_user(options)
     csv_data = build_csv(options)
-    opt = { 'csv_file' => csv_data }
-    do_request(AUDIENCE_MEMBERS_PATH, :post, opt.merge(default_opt))
+    do_request(AUDIENCE_MEMBERS_PATH, :post, :csv_file => csv_data)
   end
   def add_to_list(email, list_name)
-    options = { 'email' => email }
-    do_request(NEW_LISTS_PATH + "/" + URI.escape(list_name) + "/add", :post, options.merge(default_opt))
+    do_request("#{NEW_LISTS_PATH}/#{URI.escape(list_name)}/add", :post, :email => email)
   end
   def remove_from_list(email, list_name)
-    options = { 'email' => email }
-    do_request(NEW_LISTS_PATH + "/" + URI.escape(list_name) + "/remove", :post, options.merge(default_opt))
+    do_request("#{NEW_LISTS_PATH}/#{URI.escape(list_name)}/remove", :post, :email => email)
   end
   def suppressed_since(timestamp)
-    do_request((SUPPRESSED_SINCE_PATH.gsub('%timestamp%', timestamp)), :get, default_opt)
+    do_request(SUPPRESSED_SINCE_PATH.gsub('%timestamp%', timestamp), :get)
   end
   def promotions
-    request = do_request(PROMOTIONS_PATH, :get, default_opt)
-    Hash.from_xml(request)
+    request = do_request(PROMOTIONS_PATH, :get)
+    Crack::XML.parse(request)
   end
   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, default_opt)
-    Hash.from_xml(request)
+    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)
-    options = { 'raw' => raw, 'query' => query_string }
-    request = do_request(SEARCH_PATH, :get, options.merge(default_opt))
-    Hash.from_xml(request)
+    request = do_request(SEARCH_PATH, :get, :raw => raw, :query => query_string)
+    Crack::XML.parse(request)
   end
   def send_mail(opt, yaml_body)
-    opt['body'] = yaml_body.to_yaml
-    if opt['list_name']
-      do_request('/mailer/to_list', :post, opt.merge(default_opt), true)
+    options = opt.dup
+    options[:body] = yaml_body.to_yaml
+    if !options[:list_name].nil?
+      do_request(MAILER_TO_LIST_PATH, :post, options, true)
     else
-      do_request('/mailer', :post, opt.merge(default_opt), true)
+      do_request(MAILER_PATH, :post, options, true)
     end
   end
   def send_html(opt, html)
+    options = opt.dup
     if html.include?('[[tracking_beacon]]') || html.include?('[[peek_image]]')
-      opt['raw_html'] = html
-      if opt['list_name']
-        do_request('/mailer/to_list', :post, opt.merge(default_opt), true)
+      options[:raw_html] = html
+      if !options[:list_name].nil?
+        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)
       else
-        do_request('/mailer', :post, opt.merge(default_opt), true)
+        do_request(MAILER_PATH, :post, options, true)
       end
     else
-      raise StandardError, "You'll need to include either the [[tracking_beacon]] or [[peek_image]] tag in your HTML before sending."
+      raise MadMimiError, "You'll need to include either the [[tracking_beacon]] or [[peek_image]] macro in your HTML before sending."
     end
   end
   def send_plaintext(opt, plaintext)
-    if plaintext.include?('[[unsubscribe]]')
-      opt['raw_plain_text'] = plaintext
-      if opt['list_name']
-        do_request('/mailer/to_list', :post, opt.merge(default_opt), true)
+    options = opt.dup
+    options[:raw_plain_text] = plaintext
+    if !options[:list_name].nil?
+      if plaintext.include?('[[unsubscribe]]') || plaintext.include?('[[opt_out]]')
+        do_request(MAILER_TO_LIST_PATH, :post, options, true)
       else
-        do_request('/mailer', :post, opt.merge(default_opt), true)
+        raise MadMimiError, "You'll need to include either the [[unsubscribe]] or [[opt_out]] macro in your text before sending."
       end
     else
-      raise StandardError, "You'll need to include either the [[unsubscribe]] tag in your text before sending."
+      do_request(MAILER_PATH, :post, options, true)
+    end
+  end
+  private
+  # Refactor this method asap
+  def do_request(path, req_type = :get, options = {}, transactional = false)
+    options = options.merge(default_opt)
+    form_data = options.inject({}) { |m, (k, v)| m[k.to_s] = v; m }
+    resp = href = ""
+    case req_type
+    when :get then
+      begin
+        http = Net::HTTP.new(BASE_URL, 80)
+        http.start do |http|
+          req = Net::HTTP::Get.new(path)
+          req.set_form_data(form_data)
+          response = http.request(req)
+          resp = response.body.strip
+        end
+        resp
+      rescue SocketError
+        raise "Host unreachable."
+      end
+    when :post then
+      begin
+        if transactional == true
+          http = Net::HTTP.new(BASE_URL, 443)
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        else
+          http = Net::HTTP.new(BASE_URL, 80)
+        end
+        http.start do |http|
+          req = Net::HTTP::Post.new(path)
+          req.set_form_data(form_data)
+          response = http.request(req)
+          resp = response.body.strip
+        end
+      rescue SocketError
+        raise "Host unreachable."
+      end
     end
   end
-end
+  def build_csv(hash)
+    if CSV.respond_to?(:generate_row)   # before Ruby 1.9
+      buffer = ''
+      CSV.generate_row(hash.keys, hash.keys.size, buffer)
+      CSV.generate_row(hash.values, hash.values.size, buffer)
+      buffer
+    else                               # Ruby 1.9 and after
+      CSV.generate do |csv|
+        csv << hash.keys
+        csv << hash.values
+      end
+    end
+  end
+end

data/madmimi.gemspec CHANGED

@@ -5,11 +5,11 @@
 Gem::Specification.new do |s|
   s.name = %q{madmimi}
-  s.version = "1.0.6"
+  s.version = "1.0.8"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Nicholas Young"]
-  s.date = %q{2010-05-08}
+  s.authors = ["Nicholas Young", "Marc Heiligers"]
+  s.date = %q{2010-05-26}
   s.description = %q{Send emails, track statistics, and manage your subscriber base with ease.}
   s.email = %q{nicholas@madmimi.com}
   s.extra_rdoc_files = [
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
      "test/helper.rb",
      "test/test_madmimi.rb"
   ]
-  s.homepage = %q{http://github.com/nicholaswyoung/mad_mimi_ruby}
+  s.homepage = %q{http://github.com/madmimi/madmimi-gem}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
@@ -42,12 +42,15 @@ Gem::Specification.new do |s|
     s.specification_version = 3
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_development_dependency(%q<crack>, [">= 0.1.7"])
+      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
     else
-      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+      s.add_dependency(%q<crack>, [">= 0.1.7"])
+      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    s.add_dependency(%q<crack>, [">= 0.1.7"])
+    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
   end
 end

metadata CHANGED

@@ -5,32 +5,47 @@ version: !ruby/object:Gem::Version
   segments:
   - 1
   - 0
-  - 6
-  version: 1.0.6
+  - 8
+  version: 1.0.8
 platform: ruby
 authors:
 - Nicholas Young
+- Marc Heiligers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2010-05-08 00:00:00 -05:00
+date: 2010-05-26 00:00:00 -05:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: crack
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement
     requirements:
     - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        - 1
+        - 7
+        version: 0.1.7
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    requirements:
+    - - "="
       - !ruby/object:Gem::Version
         segments:
         - 2
+        - 10
         - 3
-        - 5
-        version: 2.3.5
+        version: 2.10.3
   type: :development
-  version_requirements: *id001
+  version_requirements: *id002
 description: Send emails, track statistics, and manage your subscriber base with ease.
 email: nicholas@madmimi.com
 executables: []
@@ -51,7 +66,7 @@ files:
 - test/helper.rb
 - test/test_madmimi.rb
 has_rdoc: true
-homepage: http://github.com/nicholaswyoung/mad_mimi_ruby
+homepage: http://github.com/madmimi/madmimi-gem
 licenses: []
 post_install_message: