madmimi 1.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nicholas Young
+
+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.rdoc

@@ -0,0 +1,44 @@
+= madmimi
+
+The power of Mad Mimi in your Ruby application. Deliver emails, track statistics, and manage your subscriber base with ease.
+
+== A brief tutorial
+
+Dependencies:
+active_support (I intend to remove this in the not too distant future, and build my own implementation.)
+
+mimi = MadMimi.new('emailaddress', 'api_key')
+
+mimi.lists -> get all of your Mad Mimi lists returned as a hash
+
+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
+
+mimi.delete_list('New list name') -> delete the list I just created
+
+mimi.csv_import("name,email\ndave,dave@example.com\n") -> import from a csv string
+
+mimi.add_to_list('dave@example.com', 'Test List') -> add this email address to a specific list
+
+mimi.remove_from_list('dave@example.com', 'Test List') -> remove this email address from a specific list
+
+mimi.suppressed_since('unix timestamp') -> get a TXT of all addresses that were suppressed since this timestamp
+
+mimi.promotions -> returns a hash of your promotions
+
+mimi.mailing_stats('promotion_id', 'mailing_id') -> get stats on a specific mailing
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (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.
+
+== Copyright
+
+Copyright (c) 2010 Nicholas Young. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "madmimi"
+    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 is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "madmimi #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.1

data/lib/madmimi.rb

@@ -0,0 +1,184 @@
+#   Mad Mimi - v.0.0.1 the incredibly basic, and barely usable version, in my opinion. (too many stinkin' dependencies!)
+
+#   License
+
+#   Copyright (c) 2010 Mad Mimi (nicholas@madmimi.com)
+
+#   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.
+
+#   Except as contained in this notice, the name(s) of the above copyright holder(s) 
+#   shall not be used in advertising or otherwise to promote the sale, use or other
+#   dealings in this Software without prior written authorization.
+
+#   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.
+
+require 'rubygems' # So I can actually have other gems... All I need to do is ditch activesupport, and I'm good to ditch this one
+require 'uri'
+require 'net/http'
+require 'net/https'
+require 'active_support' # I want to find a way to get away from this, yet I love the Hash.from_xml method!
+
+class MadMimi
+  
+  BASE_URL = "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 = {}
+
+  def initialize(username, api_key)
+    @@api_settings[:username] = username
+    @@api_settings[:api_key]  = api_key
+  end
+  
+  def username
+    @@api_settings[:username]
+  end
+  
+  def api_key
+    @@api_settings[:api_key]
+  end
+  
+  def default_opt
+    { '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)
+  end
+  
+  def memberships(email)
+    request = do_request((MEMBERSHIPS_PATH.gsub('%email%', email)), :get, default_opt)
+    Hash.from_xml(request)
+  end
+  
+  def new_list(list_name)
+    options = { 'name' => list_name }
+    do_request(NEW_LISTS_PATH, :post, options.merge(default_opt))
+  end
+  
+  def delete_list(list_name)
+    options = { '_method' => 'delete' }
+    do_request(NEW_LISTS_PATH + "/" + URI.escape(list_name), :post, options.merge(default_opt))
+  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"
+  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))
+  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))
+  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))
+  end
+  
+  def suppressed_since(timestamp)
+    do_request((SUPPRESSED_SINCE_PATH.gsub('%timestamp%', timestamp)), :get, default_opt)
+  end
+  
+  def promotions
+    request = do_request(PROMOTIONS_PATH, :get, default_opt)
+    Hash.from_xml(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)
+  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)
+  end
+  
+  def send_mail(opt)
+    do_request('/mailer', :post, opt.merge(default_opt), true)
+  end
+end

data/madmimi.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{madmimi}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nicholas Young"]
+  s.date = %q{2010-04-30}
+  s.description = %q{Send emails, track statistics, and manage your subscriber base with ease.}
+  s.email = %q{nicholas@madmimi.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/madmimi.rb",
+     "madmimi.gemspec",
+     "pkg/madmimi-1.0.0.gem",
+     "test/helper.rb",
+     "test/test_madmimi.rb"
+  ]
+  s.homepage = %q{http://github.com/nicholaswyoung/mad_mimi_ruby}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Mad Mimi API wrapper for Ruby}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_madmimi.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    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"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.5"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'madmimi'
+
+class Test::Unit::TestCase
+end

data/test/test_madmimi.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestMadmimi < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "Coming soon!"
+  end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: madmimi
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Nicholas Young
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-30 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id001
+description: Send emails, track statistics, and manage your subscriber base with ease.
+email: nicholas@madmimi.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/madmimi.rb
+- madmimi.gemspec
+- pkg/madmimi-1.0.0.gem
+- test/helper.rb
+- test/test_madmimi.rb
+has_rdoc: true
+homepage: http://github.com/nicholaswyoung/mad_mimi_ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Mad Mimi API wrapper for Ruby
+test_files: 
+- test/helper.rb
+- test/test_madmimi.rb