ruby-mailchimp 0.4.2 → 0.5.0

data/lib/mail_chimp.rb

@@ -1,7 +1,7 @@
 require 'net/http'
 require 'net/imap'
 require 'rubygems'
-require 'xmlrpc/client'
+require 'xmlrpc/@client'
 gem 'actionmailer'
 require 'action_mailer'
 
@@ -41,20 +41,31 @@ require 'action_mailer'
 #   bonobo.listUnsubscribe(uid, list_id, "testuser@nowhere.com")
 #
 class MailChimp
-  API_URL = "http://api.mailchimp.com/1.0/"  
-  attr_accessor :email_server, :email_user, :email_password, :client
+  API_URL = "http://api.mailchimp.com/1.1/"  
+  attr_accessor :email_server, :email_user, :email_password, :@client
+  @client = nil
   
   def login(username, password)
-    client = XMLRPC::Client.new2(API_URL) if client.nil?
-    client.call("login", username, password)
+    @client = XMLRPC::Client.new2(API_URL) 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(API_URL) if client.nil?
-    client.call("lists", uid)    
+  def apikeyAdd(username, password, new_key)
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("apikeyAdd", username, password, new_key)
+  end
+  
+  def apikeyExpire(username, password, new_key)
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("apikeyExpire", username, password, new_key)
   end
   
+  def apikeys(username, password, uid, include_expired=false)
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("apikeys", username, password, uid, include_expired)  
+  end
+  
+  
   def getListByName(uid, listname)
     listinfo = lists(uid)
     listhash = {}
@@ -70,48 +81,264 @@ class MailChimp
     return list["id"]
   end
   
+  def listBatchSubscribe(uid, list_id, email_array, double_optin=true, update_existing=true, replace_interests=true) 
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listBatchSubscribe", uid, list_id, email_array, double_optin, update_existing, replace_interests)
+  end
+  
+  def listBatchUnsubscribe(uid, list_id, email_array, delete_member=false, send_goodbye=true, send_notify=true) 
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listBatchSubscribe", uid, list_id, email_array, delete_member, send_goodbye, send_notify)
+  end
+  
+  def listInterestGroupAdd(uid, list_id, group_name)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listInterestGroupAdd", uid, list_id, group_name)
+  end
+  
+  def listInterestGroupDel(uid, list_id, group_name)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listInterestGroupDel", uid, list_id, group_name)
+  end
+  
+  def listInterestGroups(uid, list_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listInterests", uid, list_id)
+  end
+  
+  def listMemberInfo(uid, list_id, email)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listMemberInfo", uid, list_id, email)        
+  end
+  
+  def listMembers(uid, list_id, status, start=0, limit=100)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listMembers", uid, list_id, status, start, limit)    
+  end
+  
+  def listMergeVarAdd(uid, list_id, merge_tag, description, required=false)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listMergeVarAdd", uid, list_id, merge_tag, description, required)      
+  end
+
+  def listMergeVarDel(uid, list_id, merge_tag)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listMergeVarDel", uid, list_id, merge_tag)      
+  end
+
   def listMergeVars(uid, list_id)
     raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
-    client = XMLRPC::Client.new2(API_URL) if client.nil?
-    client.call("listMergeVars", uid, list_id)    
+    @client = XMLRPC::Client.new2(API_URL) 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(API_URL) if client.nil?
-    client.call("listInterestGroups", uid, list_id)    
+    @client = XMLRPC::Client.new2(API_URL) 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(API_URL) if client.nil?
-    client.call("listSubscribe", uid, list_id, email, merge_vars, email_type, double_optin)    
+    @client = XMLRPC::Client.new2(API_URL) 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(API_URL) if client.nil?
-    client.call("listUnsubscribe", uid, list_id, email, delete_member, send_goodbye, send_notify)    
+    @client = XMLRPC::Client.new2(API_URL) 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(API_URL) if client.nil?
-    client.call("listUpdateMember", uid, list_id, email, merge_vars, email_type, replace_interests)    
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("listUpdateMember", uid, list_id, email, merge_vars, email_type, replace_interests)    
   end
   
-  def listMembers(uid, list_id, status, start=0, limit=100)
+  def lists(uid)
     raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
-    client = XMLRPC::Client.new2(API_URL) if client.nil?
-    client.call("listMembers", uid, list_id, status, start, limit)    
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("lists", uid)    
   end
   
-  def listMemberInfo(uid, list_id, email)
+  #######################
+  # HELPER METHODS
+  #######################
+  def generateText(uid, mime_type, content)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("generateText", uid, mime_type, content)  
+  end
+  
+  def getAffiliateInfo(uid)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("generateText", uid, mime_type, content)  
+  end
+  
+  def inlineCss(uid, html, strip_css=false)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("inlineCss", uid, html, strip_css)  
+  end
+  
+  def ping(uid)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("ping", uid)
+  end
+  
+  #######################
+  # CAMPAIGN AIM METHODS
+  ####################### 
+  def campaignClickDetailAIM(uid, campaign_id, url, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignClickDetailAIM", uid, campaign_id, url, start, limit)  
+  end
+  
+  def campaignEmailStatsAIM(uid, campaign_id, email_address)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignEmailStatsAIM", uid, campaign_id, email_address)      
+  end
+  
+  def campaignEmailStatsAIMAll(uid, campaign_id, start, limit)
     raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
-    client = XMLRPC::Client.new2(API_URL) if client.nil?
-    client.call("listMemberInfo", uid, list_id, email)        
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignEmailStatsAIMAll", uid, campaign_id, start, limit)      
   end
   
+  def campaignNotOpenedAIM(uid, campaign_id, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignNotOpenedAIM", uid, campaign_id, start, limit)      
+  end
+  
+  def campaignOpenedAIM(uid, campaign_id, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignOpenedAIM", uid, campaign_id, start, limit)      
+  end
+  
+  
+  #######################
+  # CAMPAIGN STATS METHODS
+  #######################    
+  def campaignAbuseReports(uid, campaign_id, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignAbuseReports", uid, campaign_id, start, limit)      
+  end
+  
+  def campaignClickStats(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignClickStats", uid, campaign_id)      
+  end
+  
+  def campaignHardBounces(uid, campaign_id, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignHardBounces", uid, campaign_id, start, limit)      
+  end
+
+  def campaignSoftBounces(uid, campaign_id, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignSoftBounces", uid, campaign_id, start, limit)      
+  end
+
+  def campaignStats(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignStats", uid, campaign_id)      
+  end  
+
+  def campaignUnsubscribes(uid, campaign_id, start, limit)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignUnsubscribes", uid, campaign_id, start, limit)      
+  end
+  
+  
+  #######################
+  # CAMPAIGN METHODS
+  #######################
+  def campaignContent(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignContent", uid, campaign_id)      
+  end
+  
+  def campaignCreate(uid, campaign_type, options, content, segment_options, type_options)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    raise StandardError("Unknown campaign type #{campaign_type}") unless %w(regular plaintext absplit rss trans).include?(campaign_type)
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignCreate", uid, campaign_type, options, content, segment_options, type_options)      
+  end
+  
+  def campaignEcommAddOrder(uid, order_info, campaign_id, plugin_info)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignEcommAddOrder", uid, order_info, campaign_id, plugin_info)    
+  end
+  
+  def campaignFolders(uid)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignFolders", uid)        
+  end
+  
+  def campaignPause(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignPause", uid, campaign_id)      
+  end
+  
+  def campaignResume(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignResume", uid, campaign_id)      
+  end
+  
+  def campaignSchedule(uid, campaign_id, schedule_time, schedule_time_b)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignSchedule", uid, campaign_id, schedule_time, schedule_time_b)      
+  end
+  
+  def campaignSegmentTest(uid, list_id, options)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignSegmentTest", uid, campaign_id, options)      
+  end
+  
+  def campaignSendNow(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignSendNow", uid, campaign_id)      
+  end
+    
+  def campaignUnschedule(uid, campaign_id)
+    raise StandardError("Not Loggged in or invalid UID.") if (uid.nil?) 
+    @client = XMLRPC::Client.new2(API_URL) if @client.nil?
+    @client.call("campaignUnschedule", uid, campaign_id)      
+  end
+  
+  
+  
+  
   #
   # Stores the inbox attributes to allow connection by check_inbox
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-mailchimp
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - C. G. Brown
@@ -9,11 +9,12 @@ autorequire: mail_chimp
 bindir: bin
 cert_chain: []
 
-date: 2008-05-21 00:00:00 -04:00
+date: 2008-11-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: actionmailer
+  type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -53,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 0.9.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: Allows programmatic subscription and unsubscription to MailChimp.  Requires MailChimp account.