ruby-mailchimp 0.2.1 → 0.3.0

data/lib/mail_chimp.rb

@@ -1,6 +1,7 @@
 require 'net/http'
 require 'net/imap'
 require 'rubygems'
+require 'xmlrpc/client'
 gem 'actionmailer'
 require 'action_mailer'
 
@@ -10,45 +11,101 @@ require 'action_mailer'
 # ruby-mailchimp is designed to allow you to use Ruby to subscribe or unsubscribe
 # users to an existing MailChimp (http://www.mailchimp.com) account.  You will need the following:
 # - MailChimp Account: MailChimp is free to sign up for and only charges for sent messages
-# - MailChimp List ID: You can get this from the id field of MailChimp's signup form code.
 # 
+# The API is basically a wrapper on MailChimp's XML-RPC API.  For more details on what variables
+# mean, you can reference their API specification at: http://www.mailchimp.com/api/.
+#
+# I'm leaving the subscribe/unsubscribe mail processor code in for now, but it is deprecated and
+# will be removed in a future release.  The ability to query MailChimp using their XML-RPC API 
+# has eliminated the need to process mails to keep the lists in sync.
+#
 # Author:: C. G. Brown (mailto: cgbrown@projectlocker.com)
-# Copyright:: Copyright (c) 2007 One Percent Software/ProjectLocker
+# Copyright:: Copyright (c) 2007-8 One Percent Software/ProjectLocker
 # License:: Apache Software License
 # 
 # Example Usage:
-# - Subscribing a User: -
-#   bonobo = MailChimp.new
-#   bonobo.subscribe_user("MyListID", "testuser@nowhere.com")
-#   
-# - Subscribing a User with other data: -  
-#   bonobo = MailChimp.new
-#   bonobo.subscribe_user("MyListID", "otheruser@nowhere.com", {:FNAME=>'Barnaby', :LNAME=>'Jones'})
-#   
-# - Unsubscribing a User -   
+# - Logging In (required before all other functions): - 
 #   bonobo = MailChimp.new
-#   bonobo.unsubscribe_user("MyListID", "thirduser@nowhere.com")
-#   
-# - Checking for Incoming Subscribes/Unsubscribes -
-#   bonobo = MailChimp.new
-#   bonobo.initialize_inbox("my.mailserver.com", "myusername", "mypassword")
-#   subscribes, unsubscribes = bonobo.check_inbox()
-#   subscribes.each do |subscriber|
-#     email = subscriber[:email]
-#     ip = subscriber[:ip]
-#     signup_date = subscriber[:date]
-#     #Do what you like with the data here
-#   end
-#   unsubscribes.each do |unsubscriber|
-#     email = unsubscriber[:email]
-#     ip = unsubscriber[:ip]
-#     signup_date = unsubscriber[:date]
-#     #Do what you like with the data here
-#   end
-#   
+#   uid = bonobo.login("MailChimpUsername", "MailChimpPassword")
+#
+# - Obtaining a List ID - 
+#   list_id = bonobo.getListByName(uid, "My List on MailChimp")
+#
+# - Subscribing a User: - 
+#   bonobo.listSubscribe(uid, list_id, "testuser@nowhere.com", {})
+#
+# - Subscribing a User with Merge Data: - 
+#   bonobo.listSubscribe(uid, list_id, "testuser@nowhere.com", {"FNAME"=>'Barnaby', "LNAME"=>'Jones'}) 
+#
+# - Unsubscribing a User: - 
+#   bonobo.listUnsubscribe(uid, list_id, "testuser@nowhere.com")
+#
 class MailChimp
   
-  attr_accessor :email_server, :email_user, :email_password
+  attr_accessor :email_server, :email_user, :email_password, :client
+  
+  def login(username, password)
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("login", username, password)
+  end
+  
+  def lists(uid)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("lists", uid)    
+  end
+  
+  def getListByName(uid, listname)
+    listinfo = lists(uid)
+    listhash = {}
+    listinfo.each {|list|
+      listhash_key = list["name"]
+      listhash[listhash_key] = list
+    }
+    return list[listname]
+  end
+  
+  def listMergeVars(uid, list_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listMergeVars", uid, list_id)    
+  end
+  
+  def listInterestGroups(uid, list_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listInterestGroups", uid, list_id)    
+  end
+  
+  def listSubscribe(uid, list_id, email, merge_vars, email_type="html", double_optin=true)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listSubscribe", uid, list_id, email, merge_vars, email_type, double_optin)    
+  end
+  
+  def listUnsubscribe(uid, list_id, email, delete_member=false, send_goodbye=true, send_notify=true)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listUnsubscribe", uid, list_id, email, delete_member, send_goodbye, send_notify)    
+  end  
+  
+  def listUpdateMember(uid, list_id, email, merge_vars, email_type, replace_interests=true)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listUpdateMember", uid, list_id, email, merge_vars, email_type, replace_interests)    
+  end
+  
+  def listMembers(uid, list_id, status)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listMembers", uid, list_id, status)    
+  end
+  
+  def listMemberInfo(uid, list_id, email)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    client = XMLRPC::Client.new2("http://www.mailchimp.com/admin/api/1.0/index.phtml") if client.nil?
+    client.call("listMemberInfo", uid, list_id, email)        
+  end
   
   #
   # Stores the inbox attributes to allow connection by check_inbox

metadata

@@ -1,54 +1,61 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: ruby-mailchimp
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
-date: 2007-11-27 00:00:00 -05:00
-summary: Allows programmatic subscription and unsubscription to MailChimp.  Requires MailChimp account.
-require_paths: 
-- lib
-email: cgbrown@projectlocker.com
-homepage: http://www.projectlocker.com
-rubyforge_project: 
-description: 
-autorequire: mail_chimp
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.3.0
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - C. G. Brown
-files: 
-- lib/mail_chimp.rb
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
+autorequire: mail_chimp
+bindir: bin
+cert_chain: []
 
+date: 2008-02-11 00:00:00 -05:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 1.3.2
     version: 
+description: 
+email: cgbrown@projectlocker.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mail_chimp.rb
+has_rdoc: true
+homepage: http://www.projectlocker.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: Allows programmatic subscription and unsubscription to MailChimp.  Requires MailChimp account.
+test_files: []
+