hominid 2.1.7 → 2.1.9

data/VERSION

@@ -1 +1 @@
-2.1.7
+2.1.9

data/hominid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hominid}
-  s.version = "2.1.7"
+  s.version = "2.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Getting", "Michael Str\303\274der"]
-  s.date = %q{2010-08-18}
+  s.date = %q{2010-09-07}
   s.description = %q{Hominid is a Ruby gem that provides a wrapper for interacting with the Mailchimp email marketing service API.}
   s.email = %q{brian@terra-firma-design.com}
   s.extra_rdoc_files = [

data/lib/hominid.rb

@@ -1,3 +1,4 @@
+require 'json'
 require 'xmlrpc/client'
 require 'ostruct'
 

data/lib/hominid/base.rb

@@ -4,9 +4,11 @@ module Hominid
     include Hominid::Helper
     include Hominid::List
     include Hominid::Security
-    
+
     # MailChimp API Documentation: http://www.mailchimp.com/api/1.2/
     MAILCHIMP_API_VERSION = "1.2"
+    MAILCHIMP_EXPORT_API_VERSION = "1.0"
+    MAILCHIMP_EXPORT_PATH = "/export/#{MAILCHIMP_EXPORT_API_VERSION}/list/"
 
     def initialize(config = {})
       raise StandardError.new('Please provide your Mailchimp API key.') unless config[:api_key]
@@ -25,15 +27,17 @@ module Hominid
       @config = defaults.merge(config).freeze
       if config[:secure]
         @chimpApi = XMLRPC::Client.new2("https://#{dc}.api.mailchimp.com/#{MAILCHIMP_API_VERSION}/")
+        @exportApi = Net::HTTP.new("#{dc}.api.mailchimp.com", 443)
       else
         @chimpApi = XMLRPC::Client.new2("http://#{dc}.api.mailchimp.com/#{MAILCHIMP_API_VERSION}/")
+        @exportApi = Net::HTTP.new("#{dc}.api.mailchimp.com", 80)
       end
     end
-    
+
     def apply_defaults_to(options) # :nodoc:
       @config.merge(options)
     end
-    
+
     def call(method, *args) # :nodoc:
       @chimpApi.call(method, @config[:api_key], *args)
     rescue XMLRPC::FaultException => error
@@ -61,7 +65,30 @@ module Hominid
     rescue Exception => error
       raise CommunicationError.new(error.message)
     end
-    
+
+    def call_export(list_id, status)
+      uri = "#{MAILCHIMP_EXPORT_PATH}?apikey=#{@config[:api_key]}&id=#{list_id}"
+
+      !status.nil? && uri += "&status=#{status}"
+
+      # Don't parse the whole thing since there could be thousands of records
+      out, keys = [], []
+      body = @exportApi.request_get(uri).body
+      lines = body.send(body.respond_to?(:lines) ? :lines : :to_s).to_a
+
+      lines.each_with_index do |l, i|
+        if i == 0
+          keys = JSON.parse(l).map { |k| k.gsub(" ", "_") }
+        else
+          # Magic! http://snippets.dzone.com/posts/show/302
+          out << Hash[*keys.zip(JSON.parse(l)).flatten]
+        end
+      end
+      out
+    rescue Exception => error
+      raise CommunicationError.new(error.message)
+    end
+
     def clean_merge_tags(merge_tags) # :nodoc:
       return {} unless merge_tags.is_a? Hash
       merge_tags.each do |key, value|
@@ -72,7 +99,7 @@ module Hominid
         end
       end
     end
-    
+
     def hash_to_object(object) # :nodoc:
       return case object
       when Hash
@@ -90,4 +117,5 @@ module Hominid
     end
 
   end
-end
+end
+

data/lib/hominid/list.rb

@@ -287,6 +287,19 @@ module Hominid
     def members(list_id, status = "subscribed", since = "2000-01-01 00:00:00", start = 0, limit = 100)
       call("listMembers", list_id, status, since, start, limit)
     end
+
+    # Use the Mailchimp Export API to get all list members for a list
+    # 
+    # Parameters:
+    # * list_id (String)    = The mailing list ID value.
+    # * status  (String)    = One of subscribed, unsubscribed, cleaned, updated. Defaults to subscribed.
+    #
+    # Returns:
+    # An array of user record structs, keyed by the merge field name
+    #
+    def export(list_id, status=nil)
+      call_export(list_id, status)
+    end
     
     # Get the list of merge tags for a given list, including their name, tag, and required setting.
     #

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hominid
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 25
   prerelease: false
   segments: 
   - 2
   - 1
-  - 7
-  version: 2.1.7
+  - 9
+  version: 2.1.9
 platform: ruby
 authors: 
 - Brian Getting
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 -07:00
+date: 2010-09-07 00:00:00 -07:00
 default_executable: 
 dependencies: []