monkey_party 0.2.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+features/support/mailchimp/account.yml

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Dan Pickett
+
+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,26 @@
+= monkey_party
+
+An extremely young API for interacting with the MailChimp API
+
+Uses the excellent HTTParty and HappyMapper tools and is well tested
+
+Currently only supports 
+
+* adding api keys
+* finding lists by name
+* batch subscribing 
+* unsubscribing
+
+== Example Usage
+
+  account = MonkeyParty::Account.login("monkey_username", "party_password")
+  list = MonkeyParty::List.find_by_name("list_name")
+  list.create_subscribers([MonkeyParty::Subscriber.new("user@example.com")])
+
+== TODO
+ * Batch subscribe does not allow you to resubscribe members - implement individual subscribe method
+ * Clean up after cucumber features are run
+
+== Copyright
+
+Copyright (c) 2009 Dan Pickett. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,63 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "monkey_party"
+    gem.summary = %Q{mailchimp wrapper}
+    gem.email = "dpickett@enlightsolutions.com"
+    gem.homepage = "http://github.com/dpickett/monkey_party"
+    gem.authors = ["Dan Pickett"]
+    gem.add_dependency("httparty", ">= 0.5.2")
+    gem.add_dependency("happymapper", ">= 0.3.0")
+    gem.add_dependency("configatron", ">= 2.6.3")
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:cucumber) do |t|
+    t.cucumber_opts = "--format pretty" # Any valid command line option can go here.
+  end
+
+rescue LoadError
+  puts "Cucumber not installed. You will not be able to run features"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'monkey_party'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+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 :default => :test

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:patch: 0
+:major: 0
+:build: 
+:minor: 2

data/features/create_and_add_api_key.feature

@@ -0,0 +1,21 @@
+Feature: Create an api key
+In order to interact with the MailChimp Service
+As a developer
+I want to login and generate an api key
+
+  Scenario: Successful Login
+    Given I have a valid mailchimp account
+    When I attempt to login with the proper credentials
+    Then I should get an api key
+
+  Scenario: Failed Login
+    Given I have a valid mailchimp account
+    When I attempt to login with incorrect credentials
+    Then I should get an error
+
+  Scenario: Add a key
+    Given I have a valid mailchimp account
+    And I have logged in
+    When I attempt to add an api key
+    Then I should be successful
+

data/features/list_subscribe.feature

@@ -0,0 +1,13 @@
+Feature: Subscribe to a list
+In order to send mass mailings in the future
+As a developer
+I want to subscribe given email addresses to a list
+And I also want to potentially pass merge variables
+
+Scenario: Email subscription
+  Given I have a valid mailchimp account
+  And a list named "Testing"
+  And I have logged in
+  When I attempt to subscribe "user@enlightsolutions.com" to the "Testing" list
+  Then the subscription should submit successfully
+

data/features/list_unsubscribe.feature

@@ -0,0 +1,14 @@
+Feature: Unsubscription from a list
+In order to comply with policies 
+And to provide a pleasurable experience for users
+As a developer
+I want to unsubscribe given email addresses from a list
+
+Scenario: Email unsubscription
+  Given I have a valid mailchimp account
+  And a list named "Testing"
+  And I have logged in
+  And "user@enlightsolutions.com" is a subscriber to the "Testing" list
+  When I attempt to unsubscribe "user@enlightsolutions.com" from the "Testing" list
+  Then the unsubscription should be successful
+

data/features/step_definitions/create_and_add_api_key_steps.rb

@@ -0,0 +1,45 @@
+Given /^I have a valid mailchimp account$/ do
+  assert_not_nil configatron.mailchimp.user_name
+  assert_not_nil configatron.mailchimp.password
+
+  @mailchimp_user_name = configatron.mailchimp.user_name
+  @mailchimp_password  = configatron.mailchimp.password
+end
+
+When /^I attempt to login with the proper credentials$/ do
+  @account = MonkeyParty::Account.login(@mailchimp_user_name, 
+    @mailchimp_password)
+end
+
+When /^I attempt to login with incorrect credentials$/ do
+  begin
+    @account = MonkeyParty::Account.login(@mailchimp_user_name,
+      "FAIL")
+  rescue MonkeyParty::Error => @exception
+  end
+end
+
+Then /^I should get an error$/ do
+  assert_not_nil @exception
+end
+
+Then /^I should get an api key$/ do
+  assert @account.keys.size == 1
+end
+
+Given /^I have logged in$/ do
+  @mailchimp_user_name = configatron.mailchimp.user_name
+  @mailchimp_password  = configatron.mailchimp.password
+
+  @account = MonkeyParty::Account.login(@mailchimp_user_name,
+    @mailchimp_password)
+end
+
+When /^I attempt to add an api key$/ do
+  @additional_api_key = @account.add_api_key
+end
+
+Then /^I should be successful$/ do
+  assert @account.keys.include?(@additional_api_key) 
+end
+

data/features/step_definitions/list_steps.rb

@@ -0,0 +1,17 @@
+Given /^a list named "([^\"]*)"$/ do |name|
+  assert_not_nil MonkeyParty::List.find_by_name(name)
+end
+
+When /^I attempt to subscribe "([^\"]*)" to the "([^\"]*)" list$/ do |email, list|
+  @subscribers = MonkeyParty::List.find_by_name(list).create_subscribers(
+    [MonkeyParty::Subscriber.new(email,
+      :first_name => "John",
+      :last_name  => "Smith"
+    )], :update_existing => true, :double_optin => true)
+end
+
+Then /^the subscription should submit successfully$/ do
+  assert @subscribers[0].valid?
+end
+
+

data/features/step_definitions/list_unsubscribe_steps.rb

@@ -0,0 +1,17 @@
+Given /^"([^\"]*)" is a subscriber to the "([^\"]*)" list$/ do |email, list|
+  @list = MonkeyParty::List.find_by_name(list)
+  @subscriber = MonkeyParty::Subscriber.new(email)
+  @subscriber = @list.create_subscribers([@subscriber], 
+    :update_existing => true)[0]
+  assert @subscriber.valid?
+end
+
+When /^I attempt to unsubscribe "([^\"]*)" from the "([^\"]*)" list$/ do |email, list|
+  @subscriber = @list.destroy_subscribers([@subscriber],
+    :delete_member => true)[0]
+end
+
+Then /^the unsubscription should be successful$/ do
+  assert @subscriber.valid?
+end
+

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'test/unit/assertions'
+require "monkey_party"
+
+World(Test::Unit::Assertions)

data/features/support/mailchimp/account.rb

@@ -0,0 +1,8 @@
+#load account settings from a yaml file
+
+require "configatron"
+require "ruby-debug"
+
+configatron.mailchimp.configure_from_yaml(
+  File.join(File.dirname(__FILE__), "account.yml"))
+

data/features/support/mailchimp/account.yml.example

@@ -0,0 +1,2 @@
+user_name: <user name>
+password: <password>

data/features/support/mailchimp/cleaner.rb

@@ -0,0 +1,3 @@
+#call in The Wolf to clean up after the party
+
+

data/lib/monkey_party.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "httparty"
+require "happymapper"
+
+require "configatron"
+
+require "monkey_party/error"
+
+require "monkey_party/base"
+
+require "monkey_party/subscriber"
+require "monkey_party/account"
+require "monkey_party/list"
+

data/lib/monkey_party/account.rb

@@ -0,0 +1,48 @@
+module MonkeyParty
+  class Account < Base
+    attr_accessor :user_name, :password, :keys
+    
+    def initialize(attrs = {})
+      self.keys ||= []
+      self.keys << attrs.delete(:api_key) if attrs[:api_key]
+      super
+    end
+
+    def api_key
+      self.keys[0]
+    end
+
+    class << self
+      def login(user_name, password)
+        response = get("", :query => {
+          :method   => "login", 
+          :username => user_name, 
+          :password => password
+        })["MCAPI"]
+
+        account = new
+        
+        account.keys << response
+        account.user_name = user_name
+        account.password = password
+
+        #set a global api key
+        configatron.mailchimp.api_key = response
+
+        account
+      end
+    end
+
+    def add_api_key
+      response = self.class.get("", :query => {
+        :method   => "apikeyAdd",
+        :username => self.user_name,
+        :password => self.password,
+        :apikey   => self.api_key
+      })["MCAPI"]
+
+      self.keys << response
+      response
+    end
+  end
+end

data/lib/monkey_party/base.rb

@@ -0,0 +1,30 @@
+require "ruby-debug"
+module MonkeyParty
+  class Base
+    include HTTParty
+    base_uri 'http://api.mailchimp.com/1.2/'
+    default_params :output => "xml"
+
+    def initialize(attrs = {})
+      attrs.each{ |key, value| self.send("#{key}=", value) }
+    end
+
+    class << self
+      def get(path, options = {})
+        #fix the format because Mail Chimp doesn't pass the proper header
+        options[:format] = :xml
+        result = super
+        
+        if result.body =~ /<error /i
+          raise MonkeyParty::Error.parse(result.body)
+        end
+        result
+      end
+
+      def api_key
+        configatron.mailchimp.api_key
+      end
+
+    end
+  end
+end

data/lib/monkey_party/error.rb

@@ -0,0 +1,9 @@
+module MonkeyParty
+  class Error < Exception
+    include HappyMapper
+
+    tag 'MCAPI'
+    element :message, String, :tag => "error"
+    element :code, Integer
+  end
+end

data/lib/monkey_party/list.rb

@@ -0,0 +1,99 @@
+module MonkeyParty
+  class List < Base
+    include HappyMapper
+    tag "struct"
+
+    element :id, String
+    element :web_id, String
+    element :name, String
+    element :date_created, Time
+    element :member_count, Integer
+
+    def create_subscribers(array_of_subscribers, options = {})
+      options = {
+        :double_optin => true,
+        :update_existing => false,
+        :replace_interests => true
+      }.merge(options)
+      
+      batch_hash = {}
+      index = 0
+      array_of_subscribers.each do |s|
+        batch_hash["batch[#{index}]"] = s.to_mailchimp_hash
+        index += 1
+      end
+
+      response = self.class.get("", :query => {
+         :apikey            => self.class.api_key,
+         :id                => self.id,
+         :method            => "listBatchSubscribe",
+      }.merge(options).merge(batch_hash))
+
+      #response[1] is the error count
+      if !response["MCAPI"].nil? && response["MCAPI"][1] > 0
+        attach_errors_to_subscribers(array_of_subscribers, response.body)
+      end
+
+      array_of_subscribers
+    end
+
+    def destroy_subscribers(array_of_unsubscribers, options = {})
+      options = {
+        :delete_member => false,
+        :send_goodbye  => true,
+        :send_notify   => false
+      }.merge(options)
+
+      batch_hash = {}
+      index = 0
+      array_of_unsubscribers.each do |s|
+        batch_hash["emails[#{index}]"] = s.email
+      end
+
+      response = self.class.get("", :query => {
+        :apikey => self.class.api_key,
+        :id => self.id,
+        :method => "listBatchUnsubscribe"
+      }.merge(options).merge(batch_hash))
+
+      if !response["MCAPI"].nil? && response["MCAPI"][1] > 0
+        attach_errors_to_subscribers(array_of_unsubscribers, response.body)
+      end
+
+      array_of_unsubscribers
+    end
+
+    class << self
+      def all
+        response = get("", :query => {
+          :apikey => api_key,
+          :method => "lists"
+        })
+      
+        parse(response.body)
+      end
+
+      def find_by_name(name)
+        all.each do |list|
+          return list if list.name.downcase == name.downcase
+        end
+
+        return nil
+      end
+    end
+
+    private
+    def attach_errors_to_subscribers(subscribers, response)
+      #parse errors and update subscriber 
+      error_nodes = XML::Parser.string(response).parse.root.find("/MCAPI/errors/struct")
+      error_nodes.each do |n|
+
+        sub_error = MonkeyParty::Error.new
+        sub_error.message = n.find_first("message").content
+        sub_error.code    = n.find_first("code").content
+
+        subscribers[n.attributes["key"].to_i].error = sub_error
+      end
+    end
+  end
+end

data/lib/monkey_party/subscriber.rb

@@ -0,0 +1,30 @@
+module MonkeyParty
+  class Subscriber
+    attr_accessor :email, :merge_fields, :error
+
+    def initialize(email, merge_fields = {})
+      self.email = email
+      self.merge_fields = merge_fields
+      self.error = nil
+    end
+
+    def to_h
+      {
+        :email => self.email
+      }.merge(self.merge_fields)
+    end
+
+    def to_mailchimp_hash
+      chimp_hash = {}
+      self.to_h.each do |key, value|
+        chimp_hash[key.to_s.upcase[0..9]] = value
+      end
+
+      chimp_hash
+    end
+
+    def valid?
+      self.error.nil?
+    end
+  end
+end

data/monkey_party.gemspec

@@ -0,0 +1,87 @@
+# 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{monkey_party}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Pickett"]
+  s.date = %q{2010-06-07}
+  s.email = %q{dpickett@enlightsolutions.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "features/create_and_add_api_key.feature",
+     "features/list_subscribe.feature",
+     "features/list_unsubscribe.feature",
+     "features/step_definitions/create_and_add_api_key_steps.rb",
+     "features/step_definitions/list_steps.rb",
+     "features/step_definitions/list_unsubscribe_steps.rb",
+     "features/support/env.rb",
+     "features/support/mailchimp/account.rb",
+     "features/support/mailchimp/account.yml.example",
+     "features/support/mailchimp/cleaner.rb",
+     "lib/monkey_party.rb",
+     "lib/monkey_party/account.rb",
+     "lib/monkey_party/base.rb",
+     "lib/monkey_party/error.rb",
+     "lib/monkey_party/list.rb",
+     "lib/monkey_party/subscriber.rb",
+     "monkey_party.gemspec",
+     "test/fixtures/batch_subscribe_failed.xml",
+     "test/fixtures/batch_subscribe_successful.xml",
+     "test/fixtures/batch_unsubscribe_failed.xml",
+     "test/fixtures/batch_unsubscribe_successful.xml",
+     "test/fixtures/lists_failed.xml",
+     "test/fixtures/lists_successful.xml",
+     "test/fixtures/login_failed.xml",
+     "test/fixtures/login_successful.xml",
+     "test/monkey_party/account_test.rb",
+     "test/monkey_party/error_test.rb",
+     "test/monkey_party/list_test.rb",
+     "test/monkey_party/subscriber_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/dpickett/monkey_party}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{mailchimp wrapper}
+  s.test_files = [
+    "test/monkey_party/account_test.rb",
+     "test/monkey_party/error_test.rb",
+     "test/monkey_party/list_test.rb",
+     "test/monkey_party/subscriber_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_runtime_dependency(%q<happymapper>, [">= 0.3.0"])
+      s.add_runtime_dependency(%q<configatron>, [">= 2.6.3"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<happymapper>, [">= 0.3.0"])
+      s.add_dependency(%q<configatron>, [">= 2.6.3"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<happymapper>, [">= 0.3.0"])
+    s.add_dependency(%q<configatron>, [">= 2.6.3"])
+  end
+end
+

data/test/fixtures/batch_subscribe_failed.xml

@@ -0,0 +1,28 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<MCAPI type="array">
+<success_count type="integer">0</success_count>
+<error_count type="integer">2</error_count>
+<errors type="array">
+<struct key="0" type="array">
+<code type="integer">214</code>
+<message type="string">user@example.com is already subscribed to list Testing</message>
+<row type="array">
+<EMAIL type="string">user@example.com</EMAIL>
+</row>
+</struct>
+<struct key="1" type="array">
+
+<code type="integer">214</code>
+<message type="string">user@3example.com is already subscribed to list Testing</message>
+<row type="array">
+<EMAIL type="string">user@3example.com</EMAIL>
+</row>
+</struct>
+</errors>
+</MCAPI>
+

data/test/fixtures/batch_subscribe_successful.xml

@@ -0,0 +1,12 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<mcapi type="array">
+<success_count type="integer">2</success_count>
+<error_count type="integer">0</error_count>
+<errors type="array">
+</errors></mcapi>
+

data/test/fixtures/batch_unsubscribe_failed.xml

@@ -0,0 +1,19 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<MCAPI type="array">
+<success_count type="integer">0</success_count>
+<error_count type="integer">1</error_count>
+<errors type="array">
+<struct key="0" type="array">
+<code type="integer">232</code>
+<message type="string">There is no record of &quot;user3@example.com&quot; in the database</message>
+<email type="string">user3@example.com</email>
+</struct>
+
+</errors>
+</MCAPI>
+

data/test/fixtures/batch_unsubscribe_successful.xml

@@ -0,0 +1,12 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<mcapi type="array">
+<success_count type="integer">1</success_count>
+<error_count type="integer">0</error_count>
+<errors type="array">
+</errors></mcapi>
+

data/test/fixtures/lists_failed.xml

@@ -0,0 +1,11 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<MCAPI type="array">
+<error type="string">Invalid Mailchimp API Key: fdasf</error>
+<code type="integer">104</code>
+</MCAPI>
+

data/test/fixtures/lists_successful.xml

@@ -0,0 +1,16 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<MCAPI type="array">
+<struct key="0" type="array">
+  <id type="string">d40bbc3056</id>
+  <web_id type="integer">63816</web_id>
+  <name type="string">Testing</name>
+  <date_created type="string">Mar 27, 2009 07:00 pm</date_created>
+  <member_count type="double">0</member_count>
+</struct>
+</MCAPI>
+

data/test/fixtures/login_failed.xml

@@ -0,0 +1,11 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<MCAPI type="array">
+<error type="string">I&apos;m sorry, that username/password could not be found</error>
+<code type="integer">100</code>
+</MCAPI>
+

data/test/fixtures/login_successful.xml

@@ -0,0 +1,8 @@
+HTTP/1.1 200 OK
+Date: Wed, 04 Feb 2009 03:42:26 GMT
+Server: Apache/2.2.3 (Debian) mod_python/3.2.10 Python/2.4.4 PHP/5.2.0-8+etch11
+Content-Type: application/xml
+Transfer-Encoding: chunked
+
+<MCAPI type="string">2491541245g978jkasf</MCAPI>
+

data/test/monkey_party/account_test.rb

@@ -0,0 +1,91 @@
+require "test_helper"
+
+class MonkeyParty::AccountTest < Test::Unit::TestCase
+  context "successfully logging in" do
+    setup do
+      configatron.mailchimp.api_key
+
+      mock_login_response(true)
+      
+      @account = MonkeyParty::Account.login(@user_name, @password)
+    end
+
+    should "return an api key" do
+      assert_not_nil @account.api_key
+    end
+
+    should "set the user_name" do
+      assert_not_nil @account.user_name
+    end
+
+    should "set the global api key" do
+      assert_not_nil configatron.mailchimp.api_key
+    end
+  end
+
+  context "logging in with invalid credentials" do
+    setup do
+      mock_login_response(false)
+    end
+
+    should "raise an error" do
+      assert_raises MonkeyParty::Error do 
+        MonkeyParty::Account.login(@user_name, @password)
+      end
+    end
+  end
+
+  context "adding an api key" do
+    setup do
+      @account = MonkeyParty::Account.new(
+        :user_name => "test",
+        :password  => "password",
+        :api_key   => "api_key")
+    end
+
+    context "with proper credentials" do
+      setup do
+        mock_response("password=#{@account.password}&" +
+          "apikey=#{@account.api_key}&method=apikeyAdd&" + 
+          "output=xml&username=#{@account.user_name}",
+          "login_successful")
+      end
+
+      should "return an api key" do
+        response = @account.add_api_key
+        assert_kind_of String, response
+      end
+
+      should "add the resulting api key to extra keys" do
+        response = @account.add_api_key
+        assert @account.keys.include?(response)
+      end
+    end
+
+    context "with improper credentials" do
+      setup do
+       mock_response("password=#{@account.password}&" +
+        "apikey=#{@account.api_key}&method=apikeyAdd&" + 
+        "output=xml&username=#{@account.user_name}",
+        "login_failed")
+      end
+      
+      should "raise an error if I don't have the right credentials" do
+        assert_raise MonkeyParty::Error do
+          @account.add_api_key
+        end
+      end
+    end
+  end
+
+  private
+  def mock_login_response(successful = true)
+    @user_name = "test_user"
+    @password = "password"
+      
+    mock_response("method=login&username=#{@user_name}" + 
+      "&password=#{@password}&output=xml",
+    successful ? "login_successful" : "login_failed")
+
+  end
+end

data/test/monkey_party/error_test.rb

@@ -0,0 +1,18 @@
+require "test_helper"
+
+class MonkeyParty::ErrorTest < Test::Unit::TestCase
+  context "An error" do
+    setup do
+      error_body = File.read(xml_fixture_path("login_failed")).gsub(/.*<MCAPI/m, "<MCAPI")
+      @error = MonkeyParty::Error.parse(error_body)
+    end
+
+    should "have a code" do
+      assert_not_nil @error.code
+    end
+
+    should "have an error message" do
+      assert_not_nil @error.message
+    end
+  end
+end

data/test/monkey_party/list_test.rb

@@ -0,0 +1,173 @@
+require "test_helper"
+
+class MonkeyParty::ListTest < Test::Unit::TestCase
+  context "a list" do
+    should "have a set of members" do
+
+    end
+    
+    should "allow me to add members to the list" do
+    end
+
+    should "allow me to unsubscribe members from the list" do
+
+    end
+
+    should "have an id" do
+
+    end
+
+    should "have a web_id" do
+
+    end
+
+    should "have a name" do
+
+    end
+
+    should "have a date of creation" do
+
+    end
+
+    should "have a member count" do
+
+    end
+    
+  end
+
+  context "when subscribing" do
+
+    setup do
+      mock_all_response
+
+      @list = MonkeyParty::List.all[0]
+      
+      @subscribers = []
+      @subscribers << MonkeyParty::Subscriber.new("user@example.com", 
+        {:fname => "A User"})
+      @subscribers << MonkeyParty::Subscriber.new("user3@example.com", 
+        {:fname => "Another User"})
+      
+
+    end
+
+    context "successfully" do
+      setup do
+        mock_subscription
+        @resultant_subscribers = @list.create_subscribers(@subscribers)
+      end
+
+      should "return an array of subscribers" do
+        assert_kind_of MonkeyParty::Subscriber, @resultant_subscribers[0]
+      end
+
+      should "indicate that each subscription was valid" do
+        @resultant_subscribers.each do |s|
+          assert s.valid?
+        end
+      end
+    end
+
+    context "resulting in error(s)" do
+      setup do
+        mock_subscription(false)
+        @resultant_subscribers = @list.create_subscribers(@subscribers)
+      end
+
+      should "have invalid subscribers" do
+        assert !@resultant_subscribers[0].valid?
+      end
+
+      should "have a subscriber with an error" do
+        assert_not_nil @resultant_subscribers[0].error
+        assert_kind_of MonkeyParty::Error, @resultant_subscribers[0].error
+      end
+    end
+  end
+
+  context "when unsubscribing" do
+    setup do
+      mock_all_response
+      @list = MonkeyParty::List.all[0]
+      @unsubscribers = [
+        MonkeyParty::Subscriber.new("user@example.com"),
+        MonkeyParty::Subscriber.new("user3@example.com")
+      ]
+    end
+
+    context "successfully" do
+      setup do
+        mock_unsubscription
+
+        @resultant_unsubscribers = @list.destroy_subscribers(@unsubscribers)
+      end
+
+      should "have all valid subscribers" do
+        @resultant_unsubscribers.each do |s|
+          assert s.valid?
+        end
+      end
+    end
+
+    context "resulting in errors(s)" do
+      setup do
+        mock_unsubscription(false)
+        @resultant_unsubscribers = @list.destroy_subscribers(@unsubscribers)
+      end
+
+      should "have an invalid subscriber" do
+        assert !@resultant_unsubscribers[0].valid?
+      end
+
+      should "have a usable error for the invalid subscriber" do
+        assert_not_nil @resultant_unsubscribers[0].error.message
+      end
+    end
+  end
+
+  context "lists" do
+    should "retrieving all of the lists" do
+      mock_all_response
+      lists = MonkeyParty::List.all
+      assert_kind_of Array, lists
+      assert_not_nil lists[0]
+      assert_not_nil lists[0].name
+    end
+
+    should "raise an error if something goes wrong" do
+      mock_all_response(false)
+      assert_raises MonkeyParty::Error do 
+        lists = MonkeyParty::List.all
+      end
+    end
+
+    should "find by name" do
+      mock_all_response
+      assert_equal "Testing", MonkeyParty::List.find_by_name("Testing").name
+    end
+  end
+
+  private
+  def mock_all_response(success = true)
+    mock_response("apikey=2491541245g978jkasf&method=lists&output=xml",
+      success ? "lists_successful" : "lists_failed")
+  end
+
+  def mock_subscription(success = true)
+    mock_response(
+    "double_optin=true&update_existing=false&replace_interests=true&" +
+    "method=listBatchSubscribe&batch[1][EMAIL]=user3%40example.com&" +
+    "batch[1][FNAME]=Another%20User&output=xml&" +
+    "batch[0][EMAIL]=user%40example.com&batch[0][FNAME]=A%20User&"+
+    "apikey=2491541245g978jkasf&id=d40bbc3056",
+    success ? "batch_subscribe_successful" : "batch_subscribe_failed")
+  end
+
+  def mock_unsubscription(success = true)
+    mock_response(
+      "delete_member=false&send_goodbye=true&method=listBatchUnsubscribe&" +
+      "send_notify=false&output=xml&apikey=2491541245g978jkasf&id=d40bbc3056&" +
+      "emails[0]=user3%40example.com",
+      success ? "batch_unsubscribe_successful" : "batch_unsubscribe_failed")
+  end
+end

data/test/monkey_party/subscriber_test.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+
+class MonkeyParty::SubscriberTest < Test::Unit::TestCase
+  context "A subscriber" do
+    setup do
+      @merge_vars = {:merge_var => "MERGE VAR 1"}
+      @email = "user@example.com"
+      @subscriber = MonkeyParty::Subscriber.new(@email, @merge_vars)
+    end
+
+    should "have an email" do
+      assert_equal @email, @subscriber.email
+    end
+
+    should "have a list of merge fields" do
+      assert_equal @merge_vars, @subscriber.merge_fields
+    end
+
+    should "have a hashed version of all the attributes" do
+      intended_hash = {
+        :email => @email
+      }.merge(@merge_vars)
+
+      assert_equal intended_hash, @subscriber.to_h
+    end
+
+    should "have a mailchimp style hash of all the attributes" do
+      intended_hash = {}
+      intended_hash["EMAIL"] = @email
+      @merge_vars.each do |key, value|
+        intended_hash[key.to_s.upcase] = value
+      end
+
+      assert_equal intended_hash, @subscriber.to_mailchimp_hash
+    end
+
+    should "limit merge vars to 10 characters" do
+      @merge_vars = {:a_really_long_merge_var => "LONG ONE"}
+      @subscriber = MonkeyParty::Subscriber.new(@email, @merge_vars)
+      assert @subscriber.to_mailchimp_hash.keys.include?("A_REALLY_L")
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+begin 
+  require "redgreen"
+rescue LoadError; end
+
+require 'fake_web'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'monkey_party'
+
+FakeWeb.allow_net_connect = false
+
+configatron.mailchimp.api_key = "api_key"
+
+class Test::Unit::TestCase
+  protected
+  def mock_response(path, fixture)
+    FakeWeb.register_uri(
+      "http://api.mailchimp.com/1.2?#{path}",
+      :response => xml_fixture_path(fixture))
+  end
+
+  def xml_fixture_path(fixture)
+    File.join(File.dirname(__FILE__), "fixtures", "#{fixture}.xml")
+  end
+
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: monkey_party
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dan Pickett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: happymapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: configatron
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 2
+        - 6
+        - 3
+        version: 2.6.3
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: dpickett@enlightsolutions.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- features/create_and_add_api_key.feature
+- features/list_subscribe.feature
+- features/list_unsubscribe.feature
+- features/step_definitions/create_and_add_api_key_steps.rb
+- features/step_definitions/list_steps.rb
+- features/step_definitions/list_unsubscribe_steps.rb
+- features/support/env.rb
+- features/support/mailchimp/account.rb
+- features/support/mailchimp/account.yml.example
+- features/support/mailchimp/cleaner.rb
+- lib/monkey_party.rb
+- lib/monkey_party/account.rb
+- lib/monkey_party/base.rb
+- lib/monkey_party/error.rb
+- lib/monkey_party/list.rb
+- lib/monkey_party/subscriber.rb
+- monkey_party.gemspec
+- test/fixtures/batch_subscribe_failed.xml
+- test/fixtures/batch_subscribe_successful.xml
+- test/fixtures/batch_unsubscribe_failed.xml
+- test/fixtures/batch_unsubscribe_successful.xml
+- test/fixtures/lists_failed.xml
+- test/fixtures/lists_successful.xml
+- test/fixtures/login_failed.xml
+- test/fixtures/login_successful.xml
+- test/monkey_party/account_test.rb
+- test/monkey_party/error_test.rb
+- test/monkey_party/list_test.rb
+- test/monkey_party/subscriber_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/dpickett/monkey_party
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: mailchimp wrapper
+test_files: 
+- test/monkey_party/account_test.rb
+- test/monkey_party/error_test.rb
+- test/monkey_party/list_test.rb
+- test/monkey_party/subscriber_test.rb
+- test/test_helper.rb