monkey_wrench 0.1.0

data/lib/monkey_wrench/member.rb

@@ -0,0 +1,33 @@
+module MonkeyWrench
+  class Member
+    def initialize(list_member_info)
+      @list_member_info = list_member_info
+    end
+
+    def interests
+      if @list_member_info['merges']['INTERESTS']
+        @list_member_info['merges']['INTERESTS'].split(', ')
+      end
+    end
+    
+    def method_missing(method, *args)
+      if responds_to?(method)
+        key_name = method.to_s
+        @list_member_info[key_name] || @list_member_info['merges'][key_name] || @list_member_info['merges'][key_name.upcase]
+      else
+        super
+      end
+    end
+    
+    def responds_to?(method)
+      key_name = method.to_s
+      @list_member_info.has_key?(key_name) || 
+        @list_member_info['merges'].has_key?(key_name) ||
+        @list_member_info['merges'].has_key?(key_name.upcase)
+    end
+    
+    def ==(other_member)
+      !@list_member_info.keys.detect{|key| send(key) != other_member.send(key)}
+    end
+  end
+end

data/test/fixtures/api_fail.json

@@ -0,0 +1 @@
+{"error":"Invalid Mailchimp API Key: foada . You are accessing the wrong datacenter - your client library may not properly support our datacenter mapping scheme.","code":104}

data/test/fixtures/campaigns_success.json

@@ -0,0 +1,24 @@
+[{
+  "id":"ed7838c182",
+  "web_id":534402,
+  "list_id":null,
+  "folder_id":0,
+  "title":"Untitled",
+  "type":"regular",
+  "create_time":"2009-10-06 16:18:52",
+  "send_time":null,
+  "status":"save","from_name":null,
+  "from_email":null,
+  "subject":null,
+  "to_email":null,
+  "archive_url":"http:\/\/eepurl.com\/d2JN",
+  "emails_sent":0,
+  "inline_css":"N",
+  "analytics":"N",
+  "analytics_tag":"",
+  "track_clicks_text":false,
+  "track_clicks_html":true,
+  "track_opens":true,
+  "segment_opts":[]
+ }
+]

data/test/fixtures/listBatchSubscribe10_success.json

@@ -0,0 +1 @@
+{"success_count":10,"error_count":0,"errors":[]}

data/test/fixtures/listBatchSubscribe5_success.json

@@ -0,0 +1 @@
+{"success_count":5,"error_count":0,"errors":[]}

data/test/fixtures/listBatchSubscribe_success.json

@@ -0,0 +1 @@
+{"success_count":1,"error_count":0,"errors":[]}

data/test/fixtures/listBatchSubscribe_with_error_success.json

@@ -0,0 +1 @@
+{"success_count":1,"error_count":1,"errors":[{"code":502,"message":"Invalid Email Address: bademail@badmail","row":{"EMAIL_TYPE":"html","EMAIL":"bademail@badmail"}}]}

data/test/fixtures/listBatchUnsubscribe_success.json

@@ -0,0 +1 @@
+{"success_count":1,"error_count":0,"errors":[]}

data/test/fixtures/listMemberInfo_fail.json

@@ -0,0 +1 @@
+{"error":"There is no record of \"asdiojasdojas@foo.com\" in the database","code":232}

data/test/fixtures/listMemberInfo_success.json

@@ -0,0 +1 @@
+{"id":"a58cbece83","email":"david@email.com","email_type":"html","ip_opt":"66.132.220.59","ip_signup":null,"member_rating":4,"merges":{"EMAIL":"david@email.com","MERGE0":"david@email.com","FNAME":"David","MERGE1":"David","LNAME":"Heath","MERGE2":"Heath","EXPIRYDATE":"2008-02-04","MERGE5":"2008-02-04","USERNAME":"Test1","MERGE6":"Test1","DURATION":"1","MERGE3":"1","PRODUCT":"One week subscription","MERGE4":"One week subscription","CURRENCY":"GBP","MERGE7":"GBP","ROLLING":"false","MERGE8":"false","EXPIRED":"true","MERGE9":"true","TRIAL":"","MERGE10":"","MMERGE11":"","MERGE11":"","MMERGE12":"","MERGE12":"","MMERGE13":"","MERGE13":"","MMERGE14":"","MERGE14":"","TRACKER":"","MERGE15":"","SUBSTYPE":"","MERGE16":"","FIRSTEBOOK":"","MERGE17":"","MMERGE18":"","MERGE18":"","INTERESTS":"freetrial, tutorials"},"status":"subscribed","timestamp":"2009-11-16 14:11:57","lists":{"699791bff9":"unsubscribed"}}

data/test/fixtures/listMembers_none_success.json

@@ -0,0 +1 @@
+[]

data/test/fixtures/listMembers_success.json

@@ -0,0 +1,8 @@
+[{
+  "timestamp":"2009-11-12 15:46:20", 
+  "email":"david@email.com"
+ },
+ {"timestamp":"2009-11-12 15:52:52",
+  "email":"julie@email.com"
+ }
+]

data/test/fixtures/listSubscribe_success.json

@@ -0,0 +1 @@
+true

data/test/fixtures/listUpdateMember_success.json

@@ -0,0 +1 @@
+[1]

data/test/fixtures/lists_success.json

@@ -0,0 +1,14 @@
+[
+  {"id":"my-list-id",
+   "web_id":12345  ,
+   "name":"A test list",
+   "date_created":"2009-09-10 14:14:06",
+   "member_count":5,
+   "unsubscribe_count":0,
+   "cleaned_count":0,
+   "email_type_option":false,
+   "default_from_name":"John Smith",
+   "default_from_email":"johnsmith@acmecorp.com",
+   "default_subject":"",
+   "default_language":"eng"}
+]

data/test/monkey_wrench/hash_test.rb

@@ -0,0 +1,47 @@
+$:.unshift File.expand_path("..", File.dirname(__FILE__))
+require "test_helper"
+
+class MonkeyWrench::ListTest < Test::Unit::TestCase
+  context "converting a flat hash to a Mailchimp structured array" do
+    setup do
+      @example_hash = { :email_address => "mail@chimp.com", :type => :html }
+    end
+    
+    should "include index keys" do
+      assert @example_hash.to_mailchimp(0).keys.include?("%5B0%5D%5BEMAIL_ADDRESS%5D")
+    end
+    
+    should "include parent parameter name in keys" do
+      assert @example_hash.to_mailchimp(0, "batch").keys.include?("batch%5B0%5D%5BEMAIL_ADDRESS%5D")
+    end
+  end
+  
+  context "converting a hash with array values to a Mailchimp structured array" do
+    setup do
+      @example_hash = { :batch => [{ :email_address => "mail@chimp.com", :type => :html },
+                                   { :email_address => "foo@bar.com", :type => :text }]}
+    end
+    
+    should "flatten all nested values" do
+      chimped = @example_hash.to_mailchimp
+      assert chimped.keys.include?("batch%5B0%5D%5BEMAIL_ADDRESS%5D")
+      assert chimped.keys.include?("batch%5B1%5D%5BEMAIL_ADDRESS%5D")
+      
+      chimp = chimped["batch%5B0%5D%5BEMAIL_ADDRESS%5D"]
+      bar = chimped["batch%5B1%5D%5BEMAIL_ADDRESS%5D"]
+      assert_equal "mail@chimp.com", chimp
+      assert_equal "foo@bar.com", bar
+    end
+  end
+  
+  context "converting a nested hash" do
+    setup do
+      @example_hash = { :vars => { :email_address =>"mail@chimp.com", :type => :html } }
+    end
+    
+    should "include index keys" do
+      assert @example_hash.to_mailchimp.keys.include?("vars%5BEMAIL_ADDRESS%5D")
+      assert @example_hash.to_mailchimp.keys.include?("vars%5BTYPE%5D")
+    end
+  end
+end

data/test/monkey_wrench/list_test.rb

@@ -0,0 +1,310 @@
+$:.unshift File.expand_path("..", File.dirname(__FILE__))
+require "test_helper"
+
+class MonkeyWrench::ListTest < Test::Unit::TestCase
+  context "subscribing to a list" do
+    setup do
+      setup_config
+      mock_chimp_post(:lists)
+      @list = MonkeyWrench::List.find_by_name("A test list")
+      clear_fakeweb
+    end
+    
+    context "multiple subscribers at once" do
+      should "subscribe users" do
+        form_params = {"batch[0][EMAIL]" => "mail@chimp.com", 
+                  "batch[0][TYPE]" => "html", 
+                  :id => "my-list-id"}
+        mock_chimp_post(:listBatchSubscribe, form_params)
+
+        subscribers = [{:email => "mail@chimp.com", :type => :html}]    
+        expected = {:success => 1, :errors => []}      
+        assert_equal expected, @list.subscribe(subscribers)
+      end
+      
+      should "split more than ten subscribers into batches" do
+        first_batch = {:id => "my-list-id"}
+        subscribers = []
+        10.times do |i|
+          first_batch["batch[#{i}][EMAIL]"] = "mail#{i}@chimp.com"
+          first_batch["batch[#{i}][TYPE]"] = "html"
+          subscribers << {:email => "mail#{i}@chimp.com", :type => :html}
+        end
+        mock_chimp_post(:listBatchSubscribe, first_batch,
+                        true, 'listBatchSubscribe10')
+
+        second_batch = {:id => "my-list-id"}
+        5.times do |i|
+          second_batch["batch[#{i}][EMAIL]"] = "mail1#{i}@chimp.com"
+          second_batch["batch[#{i}][TYPE]"] = "html"
+          subscribers << {:email => "mail1#{i}@chimp.com", :type => :html}
+        end
+        mock_chimp_post(:listBatchSubscribe, second_batch,
+                        true, 'listBatchSubscribe5')
+
+        expected = {:success => 15, :errors => []}      
+        assert_equal expected, @list.subscribe(subscribers)
+      end
+      
+      should "send welcome email" do
+        form_params = {"merge_vars[FOO]" => "bar", :id => "my-list-id", 
+                       :email => "mail@chimp.com", :type => :html,
+                       :send_welcome => true}
+        mock_chimp_post(:listSubscribe, form_params)
+
+        subscribers = [{:email => "mail@chimp.com", :type => :html, :foo => "bar"}]    
+        expected = {:success => 1, :errors => []}      
+        assert_equal expected, @list.subscribe(subscribers, :send_welcome => true)
+      end
+      
+      should "opt-out from list" do
+      end
+
+      should "collate errors" do
+        form_params = {
+          "batch[0][EMAIL]" => "mail@chimp.com", 
+          "batch[0][TYPE]" => "html", 
+          "batch[1][EMAIL]" => "bademail@badmail", 
+          "batch[1][TYPE]" => "html", 
+          :id => "my-list-id"}
+        mock_chimp_post(:listBatchSubscribe, form_params, true, 'listBatchSubscribe_with_error')
+
+        subscribers = [
+                       {:email => "mail@chimp.com", :type => :html},
+                       {:email => "bademail@badmail", :type => :html}
+                      ]
+        actual = @list.subscribe(subscribers)
+        assert_equal 1, actual[:success]
+        assert_equal 'Invalid Email Address: bademail@badmail', actual[:errors][0].message
+        assert_equal 502, actual[:errors][0].code
+        assert_equal 'Invalid_Email', actual[:errors][0].type
+        assert_equal({"EMAIL_TYPE"=>"html", "EMAIL"=>"bademail@badmail"}, actual[:errors][0].row)
+      end
+    end
+    
+    context "a single subscriber" do
+      should "subsbscibe a user" do
+        form_params = { :type=>:html, 
+                        :update_existing=>true, 
+                        "merge_vars[MY_DATE]"=>"20090101", 
+                        :replace_interests=>false, 
+                        :double_optin=>false, 
+                        "merge_vars[FNAME]"=>"Joe", 
+                        :id => "my-list-id",
+                        :send_welcome=>true,
+                        :email => "mail@chimp.com" }
+        mock_chimp_post(:listSubscribe, form_params)
+
+        params = { :type => :html,
+                   :double_optin => false,
+                   :update_existing => true,
+                   :replace_interests => false,
+                   :send_welcome => true,
+                   :fname => "Joe",
+                   :my_date => "20090101" 
+                   }
+        
+        expected = {:success => 1, :errors => []}      
+        assert_equal expected, @list.subscribe("mail@chimp.com", params)
+      end
+    end    
+  end
+
+  context "unsubscribing to a list" do
+    setup do
+      setup_config
+      mock_chimp_post(:lists)
+      @list = MonkeyWrench::List.find_by_name("A test list")
+    end
+    
+    context "multiple subscribers at once" do
+      should "unsubscribe" do
+        form_params = {"emails[0]" => "mail@chimp.com", :id => "my-list-id"}      
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+        subscribers = ["mail@chimp.com"]
+      
+        expected = {:success => 1, :errors => []}
+        assert_equal expected, @list.unsubscribe(subscribers)
+      end
+      
+      should "delete subscriber" do
+        form_params = {"emails[0]" => "mail@chimp.com", :id => "my-list-id",
+                       :delete_member => true}
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+        subscribers = ["mail@chimp.com"]
+      
+        expected = {:success => 1, :errors => []}
+        assert_equal expected, @list.unsubscribe(subscribers, :delete_member => true)
+      end
+      
+      should "send goodbye" do
+        form_params = {"emails[0]" => "mail@chimp.com", :id => "my-list-id",
+                       :send_goodbye => true}
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+        subscribers = ["mail@chimp.com"]
+      
+        expected = {:success => 1, :errors => []}
+        assert_equal expected, @list.unsubscribe(subscribers, :send_goodbye => true)
+      end
+      
+      should "send unsubscribe notification" do
+        form_params = {"emails[0]" => "mail@chimp.com", :id => "my-list-id",
+                       :send_notify => true}
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+        subscribers = ["mail@chimp.com"]
+      
+        expected = {:success => 1, :errors => []}
+        assert_equal expected, @list.unsubscribe(subscribers, :send_notify => true)
+      end
+    end
+    
+    context "a single subscriber" do
+      should "unsubscribe" do
+        form_params = { "emails[0]" => "mail@chimp.com", :id => "my-list-id" }
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+
+        expected = {:success => 1, :errors => []}      
+        assert_equal expected, @list.unsubscribe("mail@chimp.com")
+      end
+    end
+  end
+  
+  context "opting out of a list" do
+    setup do
+      setup_config
+      mock_chimp_post(:lists)
+      @list = MonkeyWrench::List.find_by_name("A test list")
+    end
+    
+    context "multiple subscribers at once" do
+      should "opt out" do
+        form_params = { "batch[0][EMAIL]" => "mail@chimp.com", :id => "my-list-id",
+                        "batch[1][EMAIL]" => "foo@bar.com"}
+        mock_chimp_post(:listBatchSubscribe, form_params)
+        form_params = { "emails[0]" => "mail@chimp.com", :id => "my-list-id",
+                        "emails[1]" => "foo@bar.com",
+                        :send_goodbye => false, :send_notify => false }
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+        subscribers = ["mail@chimp.com", "foo@bar.com"]
+      
+        expected = {:success => 1, :errors => []}
+        assert_equal expected, @list.opt_out(subscribers)
+      end
+    end
+    
+    context "a single subscriber" do
+      should "opt out" do
+        form_params = { "batch[0][EMAIL]" => "mail@chimp.com", :id => "my-list-id" }
+        mock_chimp_post(:listBatchSubscribe, form_params)
+        form_params = { "emails[0]" => "mail@chimp.com", :id => "my-list-id", 
+                        :send_goodbye => false, :send_notify => false}
+        mock_chimp_post(:listBatchUnsubscribe, form_params)
+
+        expected = {:success => 1, :errors => []}      
+        assert_equal expected, @list.opt_out("mail@chimp.com")
+      end
+    end
+  end
+
+  context "retrieving member information" do
+    setup do
+      setup_config
+      mock_chimp_post(:lists)
+      @list = MonkeyWrench::List.find_by_name("A test list")
+    end
+
+    should "list members" do
+      mock_chimp_post(:listMembers, :id => "my-list-id")
+
+      expected = [
+        MonkeyWrench::Member.new({"timestamp"=>"2009-11-12 15:46:20", "email"=>"david@email.com"}),
+        MonkeyWrench::Member.new({"timestamp"=>"2009-11-12 15:52:52", "email"=>"julie@email.com"}) ]
+      assert_equal expected, @list.members
+    end
+
+    should "iterate over all members" do
+      mock_chimp_post(:listMembers, {:id => "my-list-id", :start => 0, :limit => 15000 }, true, 'listMembers')
+      mock_chimp_post(:listMembers, {:id => "my-list-id", :start => 1, :limit => 15000 }, true, 'listMembers')
+      mock_chimp_post(:listMembers, {:id => "my-list-id", :start => 2, :limit => 15000 }, true, 'listMembers_none')
+
+      expected = [ 
+                  MonkeyWrench::Member.new({"timestamp"=>"2009-11-12 15:46:20", "email"=>"david@email.com"}), 
+                  MonkeyWrench::Member.new({"timestamp"=>"2009-11-12 15:52:52", "email"=>"julie@email.com"}),
+                  MonkeyWrench::Member.new({"timestamp"=>"2009-11-12 15:46:20", "email"=>"david@email.com"}), 
+                  MonkeyWrench::Member.new({"timestamp"=>"2009-11-12 15:52:52", "email"=>"julie@email.com"})
+                 ]
+      actual = []
+      @list.each_member { |m| actual << m }
+      assert_equal expected, actual
+    end
+  end
+
+  context "updating members" do
+    setup do
+      setup_config
+      mock_chimp_post(:lists)
+      @list = MonkeyWrench::List.find_by_name("A test list")
+    end
+
+    should "accept single member's email address change as hash" do
+      member = {:email => "foo@bar.com", :new_email => "bar@foo.com"}
+      form_params = {:email_address => "foo@bar.com", 
+                     "merge_vars[EMAIL]" => 'bar@foo.com', 
+                     :replace_interests => true, :id => "my-list-id"}
+      mock_chimp_post(:listUpdateMember, form_params)
+      @list.update_members(member, :replace_interests => true)
+    end
+
+    should "accept single member's email address change as list" do
+      members = [{:email => "foo@bar.com", :new_email => "bar@foo.com"}]
+      form_params = {:email_address => "foo@bar.com", 
+                     "merge_vars[EMAIL]" => 'bar@foo.com', 
+                     :replace_interests => true, :id => "my-list-id"}
+      mock_chimp_post(:listUpdateMember, form_params)
+      @list.update_members(members, :replace_interests => true)
+    end
+
+    should "update multiple members emails addresses" do
+      members = [{:email => "foo@bar.com", :new_email => "bar@foo.com"},
+                 {:email => "spock@vulcan.com", :new_email => "sylar@heroes.com"}
+                ]
+      form_params = {:email_address => "foo@bar.com", 
+                     "merge_vars[EMAIL]" => 'bar@foo.com', 
+                     :replace_interests => true, :id => "my-list-id"}
+      mock_chimp_post(:listUpdateMember, form_params)
+      form_params = {:email_address => "spock@vulcan.com", 
+                     "merge_vars[EMAIL]" => 'sylar@heroes.com', 
+                     :replace_interests => true, :id => "my-list-id"}
+      mock_chimp_post(:listUpdateMember, form_params)
+      @list.update_members(members, :replace_interests => true)
+    end
+  end
+
+  context "retrieving a members info" do
+    setup do
+      setup_config
+      mock_chimp_post(:lists)
+      @list = MonkeyWrench::List.find_by_name("A test list")
+    end
+
+    should "return the info" do
+      form_params = {:email_address => "david@email.com", :id => "my-list-id"}
+      mock_chimp_post(:listMemberInfo, form_params)
+      member = @list.member("david@email.com")
+      assert_equal "david@email.com", member.email
+      assert_equal "html", member.email_type
+      assert_equal "David", member.fname
+      assert_equal ["freetrial", "tutorials"], member.interests
+    end
+
+   should "raise on error" do
+     form_params = {:email_address => "david@email.com", :id => "my-list-id"}
+     mock_chimp_post(:listMemberInfo, form_params, false)
+     assert_raises(MonkeyWrench::Error) do
+       @list.member("david@email.com")
+     end
+   end
+
+  end
+
+end