gibbon 0.2.1 → 0.3.0

data/Gemfile

@@ -14,4 +14,5 @@ group :development do
   gem "httparty", "> 0.6.0"
   gem "mocha", "> 0.9.11"
   gem "activesupport", ">= 3.0.0"
+  gem "ruby-debug19", :require => "ruby-debug"
 end

data/Gemfile.lock

@@ -3,6 +3,8 @@ GEM
   specs:
     activesupport (3.1.0)
       multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    columnize (0.3.2)
     crack (0.1.8)
     git (1.2.5)
     httparty (0.7.8)
@@ -12,10 +14,22 @@ GEM
       git (>= 1.2.5)
       rake
     json (1.5.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
     mocha (0.9.12)
     multi_json (1.0.3)
     rake (0.9.2)
     rcov (0.9.10)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
     shoulda (2.11.3)
 
 PLATFORMS
@@ -29,4 +43,5 @@ DEPENDENCIES
   json (> 1.4.0)
   mocha (> 0.9.11)
   rcov
+  ruby-debug19
   shoulda

data/README.markdown

@@ -17,7 +17,7 @@ There are a few ways to use Gibbon:
 You can create an instance of the API wrapper:
 
     gb = Gibbon.new("your_api_key")
-    
+
 You can set your api_key globally and call class methods:
 
     Gibbon.api_key = "your_api_key"
@@ -27,7 +27,10 @@ You can also set the environment variable 'MC_API_KEY' and Gibbon will use it wh
 
     u = Gibbon.new
 
-Fetching data is as simple as calling API methods directly on the wrapper object.
+Fetching data is as simple as calling API methods directly on the wrapper
+object.  The API calls may be made with either camelcase or  underscore
+separated formatting as you see in the "More Advanced Examples" section below.
+
 Check the API [documentation](http://apidocs.mailchimp.com/api/1.3/) for details.
 
 ### Fetching Campaigns
@@ -66,6 +69,24 @@ Gibbon defaults to a 30 second timeout. You can optionally set your own timeout
 
     gb.timeout = 5
 
+### Export API usage
+
+In addition to the standard API you can make calls to the
+[MailChimp Export API](http://apidocs.mailchimp.com/export/1.0/) using a GibbonExport object.  Given an existing
+Gibbon object you can request a new GibbonExporter object:
+
+    g = Gibbon.new(@api_key)
+    gibbon_export = g.get_exporter
+
+or you can construct a new object directly:
+
+    gibbon_export = GibbonExport.new(@api_key)
+
+Calling Export API functions is identical to making standard API calls but the
+return value is an Enumerator which loops over the lines returned from the
+Export API.  This is because the data returned from the Export API is a stream
+of JSON objects rather than a single JSON array.
+
 ### Notes
 
 As of 0.1.6, gibbon uses ActiveSupport::JSON.decode(). This means code that checked for weird API responses (like "true"
@@ -79,9 +100,11 @@ as opposed to the string the MailChimp API returns. I understand the extra depen
 * [jlxw](https://github.com/jlxw)
 * [Jon McCartie](https://github.com/jmccartie)
 * [Calvin Yu](https://github.com/cyu)
+* [Dave Worth](https://github.com/daveworth)
+* [Mike Skalnik](https://github.com/skalnik)
 * Rails for camelize gsub
 
 ##Copyrights
 
 * Copyright (c) 2010 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2010 The Rocket Science Group.
+* MailChimp (c) 2001-2010 The Rocket Science Group.

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/gibbon.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{gibbon}
-  s.version = "0.2.1"
+  s.name = "gibbon"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Amro Mousa}]
-  s.date = %q{2011-09-06}
-  s.description = %q{Gibbon is a simple API wrapper for interacting with MailChimp API version 1.3.}
-  s.email = %q{amromousa@gmail.com}
+  s.authors = ["Amro Mousa"]
+  s.date = "2011-10-02"
+  s.description = "Gibbon is a simple API wrapper for interacting with MailChimp API version 1.3."
+  s.email = "amromousa@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.markdown"
@@ -29,11 +29,11 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_gibbon.rb"
   ]
-  s.homepage = %q{http://github.com/amro/gibbon}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.9}
-  s.summary = %q{Gibbon is a simple API wrapper for interacting with MailChimp API 1.3}
+  s.homepage = "http://github.com/amro/gibbon"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Gibbon is a simple API wrapper for interacting with MailChimp API 1.3"
   s.test_files = [
     "test/helper.rb",
     "test/test_gibbon.rb"
@@ -51,6 +51,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<httparty>, ["> 0.6.0"])
       s.add_development_dependency(%q<mocha>, ["> 0.9.11"])
       s.add_development_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
       s.add_runtime_dependency(%q<httparty>, ["> 0.6.0"])
       s.add_runtime_dependency(%q<activesupport>, ["> 3.0.0"])
       s.add_runtime_dependency(%q<json>, ["> 1.4.0"])
@@ -66,6 +67,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<httparty>, ["> 0.6.0"])
       s.add_dependency(%q<mocha>, ["> 0.9.11"])
       s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<ruby-debug19>, [">= 0"])
       s.add_dependency(%q<httparty>, ["> 0.6.0"])
       s.add_dependency(%q<activesupport>, ["> 3.0.0"])
       s.add_dependency(%q<json>, ["> 1.4.0"])
@@ -82,6 +84,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<httparty>, ["> 0.6.0"])
     s.add_dependency(%q<mocha>, ["> 0.9.11"])
     s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<ruby-debug19>, [">= 0"])
     s.add_dependency(%q<httparty>, ["> 0.6.0"])
     s.add_dependency(%q<activesupport>, ["> 3.0.0"])
     s.add_dependency(%q<json>, ["> 1.4.0"])

data/lib/gibbon.rb

@@ -21,10 +21,10 @@ class Gibbon
   end
 
   def base_api_url
-    dc = @api_key.blank? ? '' : "#{@api_key.split("-").last}."
-    "https://#{dc}api.mailchimp.com/1.3/?method="
+    "https://#{dc_from_api_key}api.mailchimp.com/1.3/?method="
   end
 
+
   def call(method, params = {})
     url = base_api_url + method
     params = @default_params.merge(params)
@@ -46,6 +46,10 @@ class Gibbon
     call(method, args)
   end
 
+  def get_exporter
+    GibbonExport.new(@api_key, @default_params)
+  end
+
   class << self
     attr_accessor :api_key
 
@@ -53,4 +57,27 @@ class Gibbon
       new(self.api_key).send(sym, *args, &block)
     end
   end
-end
+
+  protected
+  def dc_from_api_key
+    (@api_key.blank? or @api_key !~ /-/) ? '' : "#{@api_key.split("-").last}."
+  end
+end
+
+class GibbonExport < Gibbon
+  def initialize(api_key = nil, extra_params = {})
+    super(api_key, extra_params)
+  end
+
+  def export_api_url
+    "http://#{dc_from_api_key}api.mailchimp.com/export/1.0/"
+  end
+
+  def call(method, params = {})
+    url = export_api_url + method + "/"
+    params = @default_params.merge(params)
+    response = self.class.post(url, :body => params, :timeout => @timeout)
+
+    response.body.lines
+  end
+end

data/test/test_gibbon.rb

@@ -1,29 +1,37 @@
 require 'helper'
+require 'cgi'
+require 'ruby-debug'
 
 class TestGibbon < Test::Unit::TestCase
 
   context "build api url" do
-
     setup do
-      @gibbon = Gibbon::API.new
+      @gibbon = Gibbon.new
+      @url = "https://api.mailchimp.com/1.3/?method=sayHello"
     end
 
     should "handle empty api key" do
-      expect_post("https://api.mailchimp.com/1.3/?method=sayHello", {"apikey" => nil})
+      expect_post(@url, {"apikey" => nil})
+      @gibbon.say_hello
+    end
 
+    should "handle malformed api key" do
+      @api_key = "123"
+      @gibbon.api_key = @api_key
+      expect_post(@url, {"apikey" => @api_key})
       @gibbon.say_hello
     end
 
     should "handle timeout" do
-      expect_post("https://api.mailchimp.com/1.3/?method=sayHello", {"apikey" => nil}, 120)
+      expect_post(@url, {"apikey" => nil}, 120)
       @gibbon.timeout=120
       @gibbon.say_hello
     end
 
     should "handle api key with dc" do
-      @gibbon.apikey="TESTKEY-us1"
-      expect_post("https://us1.api.mailchimp.com/1.3/?method=sayHello", {"apikey" => "TESTKEY-us1"})
-
+      @api_key = "TESTKEY-us1"
+      @gibbon.api_key = @api_key
+      expect_post("https://us1.api.mailchimp.com/1.3/?method=sayHello", {"apikey" => @api_key})
       @gibbon.say_hello
     end
   end
@@ -31,44 +39,88 @@ class TestGibbon < Test::Unit::TestCase
   context "build api body" do
     setup do
       @key = "TESTKEY-us1"
-      @gibbon = Gibbon::API.new(@key)
+      @gibbon = Gibbon.new(@key)
       @url = "https://us1.api.mailchimp.com/1.3/?method=sayHello"
+      @body = {"apikey" => @key}
     end
 
     should "escape string parameters" do
-      expect_post(@url, {"apikey" => @key, "message" => "simon+says"})
-      @gibbon.say_hello(:message => "simon says")
+      @message = "simon says"
+      expect_post(@url, @body.merge("message" => CGI::escape(@message)))
+      @gibbon.say_hello(:message => @message)
     end
 
     should "escape string parameters in an array" do
-      expect_post(@url, {"apikey" => @key, "messages" => ["simon+says", "do+this"]})
+      expect_post(@url, @body.merge("messages" => ["simon+says", "do+this"]))
       @gibbon.say_hello(:messages => ["simon says", "do this"])
     end
 
     should "escape string parameters in a hash" do
-      expect_post(@url, {"apikey" => @key, "messages" => {"simon+says" => "do+this"}})
+      expect_post(@url, @body.merge("messages" => {"simon+says" => "do+this"}))
       @gibbon.say_hello(:messages => {"simon says" => "do this"})
     end
 
     should "escape nested string parameters" do
-      expect_post(@url, {"apikey" => @key, "messages" => {"simon+says" => ["do+this", "and+this"]}})
+      expect_post(@url, @body.merge("messages" => {"simon+says" => ["do+this", "and+this"]}))
       @gibbon.say_hello(:messages => {"simon says" => ["do this", "and this"]})
     end
 
     should "pass through non string parameters" do
-      expect_post(@url, {"apikey" => @key, "fee" => 99})
+      expect_post(@url, @body.merge("fee" => 99))
       @gibbon.say_hello(:fee => 99)
     end
+  end
 
+  context "Gibbon instances" do
+    setup do
+      @key = "TESTKEY-us1"
+      @gibbon = Gibbon.new(@key)
+      @url = "https://us1.api.mailchimp.com/1.3/?method=sayHello"
+      @body = {"apikey" => @key}
+    end
+
+    should "produce a good exporter" do
+      @exporter = @gibbon.get_exporter
+      assert_equal(@exporter.api_key, @gibbon.api_key)
+    end
+  end
+
+  context "export API" do
+    setup do
+      @key = "TESTKEY-us1"
+      @gibbon = GibbonExport.new(@key)
+      @url = "http://us1.api.mailchimp.com/export/1.0/"
+      @body = {:apikey => @key}
+      @returns = Struct.new(:body).new("")
+    end
+
+    should "handle api key with dc" do
+      @api_key = "TESTKEY-us2"
+      @gibbon = GibbonExport.new(@api_key)
+
+      params = {:body => {:apikey => @api_key}, :timeout => nil}
+      url = @url.gsub('us1', 'us2') + "sayHello/"
+      GibbonExport.expects(:post).with(url, params).returns(@returns)
+      @gibbon.say_hello
+    end
+
+    should "not escape string parameters" do
+      @param = "list id"
+
+      params = {:body => @body.merge(:id => 'list id'), :timeout => nil}
+      GibbonExport.expects(:post).with(@url + 'sayHello/', params).returns(@returns)
+      @gibbon.say_hello(:id => @param)
+    end
   end
 
   private
 
   def expect_post(expected_url, expected_body, expected_timeout=nil)
-    Gibbon::API.expects(:post).with do |url, opts|
+    Gibbon.expects(:post).with do |url, opts|
       url == expected_url &&
       JSON.parse(URI::decode(opts[:body])) == expected_body &&
       opts[:timeout] == expected_timeout
     end.returns(Struct.new(:body).new("") )
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
+date: 2011-10-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70122094225940 !ruby/object:Gem::Requirement
+  requirement: &70158318240040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122094225940
+  version_requirements: *70158318240040
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70122094225420 !ruby/object:Gem::Requirement
+  requirement: &70158318239400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70122094225420
+  version_requirements: *70158318239400
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70122094224880 !ruby/object:Gem::Requirement
+  requirement: &70158318238680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.5.1
   type: :development
   prerelease: false
-  version_requirements: *70122094224880
+  version_requirements: *70158318238680
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70122094224380 !ruby/object:Gem::Requirement
+  requirement: &70158318237620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70122094224380
+  version_requirements: *70158318237620
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70122094223900 !ruby/object:Gem::Requirement
+  requirement: &70158318237040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -65,10 +65,10 @@ dependencies:
         version: 1.4.0
   type: :development
   prerelease: false
-  version_requirements: *70122094223900
+  version_requirements: *70158318237040
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70122094223420 !ruby/object:Gem::Requirement
+  requirement: &70158318236320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -76,10 +76,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70122094223420
+  version_requirements: *70158318236320
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70122094222840 !ruby/object:Gem::Requirement
+  requirement: &70158318235600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -87,10 +87,10 @@ dependencies:
         version: 0.9.11
   type: :development
   prerelease: false
-  version_requirements: *70122094222840
+  version_requirements: *70158318235600
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70122094222300 !ruby/object:Gem::Requirement
+  requirement: &70158318234720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,21 @@ dependencies:
         version: 3.0.0
   type: :development
   prerelease: false
-  version_requirements: *70122094222300
+  version_requirements: *70158318234720
+- !ruby/object:Gem::Dependency
+  name: ruby-debug19
+  requirement: &70158318233300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70158318233300
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70122094221800 !ruby/object:Gem::Requirement
+  requirement: &70158318232500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -109,10 +120,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *70122094221800
+  version_requirements: *70158318232500
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70122094221260 !ruby/object:Gem::Requirement
+  requirement: &70158318230780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -120,10 +131,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70122094221260
+  version_requirements: *70158318230780
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70122094220760 !ruby/object:Gem::Requirement
+  requirement: &70158318230220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -131,10 +142,10 @@ dependencies:
         version: 1.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70122094220760
+  version_requirements: *70158318230220
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70122094220240 !ruby/object:Gem::Requirement
+  requirement: &70158318229540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -142,10 +153,10 @@ dependencies:
         version: 0.6.0
   type: :development
   prerelease: false
-  version_requirements: *70122094220240
+  version_requirements: *70158318229540
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70122094219700 !ruby/object:Gem::Requirement
+  requirement: &70158318228620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -153,10 +164,10 @@ dependencies:
         version: 1.4.0
   type: :development
   prerelease: false
-  version_requirements: *70122094219700
+  version_requirements: *70158318228620
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70122094219140 !ruby/object:Gem::Requirement
+  requirement: &70158318227760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -164,7 +175,7 @@ dependencies:
         version: 0.9.11
   type: :development
   prerelease: false
-  version_requirements: *70122094219140
+  version_requirements: *70158318227760
 description: Gibbon is a simple API wrapper for interacting with MailChimp API version
   1.3.
 email: amromousa@gmail.com
@@ -200,7 +211,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2232969061797626309
+      hash: 1602919969016914231
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -209,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.9
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Gibbon is a simple API wrapper for interacting with MailChimp API 1.3