gibbon 0.3.5 → 0.4.0

data/.gitignore

@@ -0,0 +1,49 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp
+
+bin
+cache
+gems
+specifications
+Gemfile.lock
+.rvmrc

data/.travis.yml

@@ -1 +1 @@
-rvm: 1.9.2
+rvm: 1.9.3

data/Gemfile

@@ -1,15 +1,3 @@
 source "http://rubygems.org"
 
-gem "json", "> 1.4.0"
-gem "httparty", "> 0.6.0"
-gem "rdoc"
-
-group :development, :test do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.1"
-  gem "rcov", ">= 0"
-  gem "mocha", "> 0.9.11"
-  gem "ruby-debug19", :require => "ruby-debug", :platforms => [:ruby_19]
-  gem "ruby-debug", :platforms => [:ruby_18]
-end
+gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Amro Mousa
+Copyright (c) 2010-2012 Amro Mousa
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.markdown

@@ -1,9 +1,17 @@
 # gibbon
 
-Gibbon is a simple API wrapper for interacting with [MailChimp API](http://www.mailchimp.com/api) 1.3.
+Gibbon is a simple wrapper for MailChimp's [Primary and Export APIs](http://www.mailchimp.com/api).
 
 [![Build Status](https://secure.travis-ci.org/amro/gibbon.png)](http://travis-ci.org/amro/gibbon)
 
+##Important Notes About Version 0.4.0+
+
+* Ruby 1.9.x+
+* Errors are now raised by default
+* Timeouts can be specified per request during initialization
+* The environment variable 'MC_API_KEY' no longer works. Please use 'MAILCHIMP_API_KEY' instead.
+* The code has been cleaned up a bit and a few more comments have been added
+
 ##Installation
 
     $ gem install gibbon
@@ -20,15 +28,24 @@ 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:
+You can set `api_key`, `timeout` and `throws_exceptions` globally:
 
     Gibbon.api_key = "your_api_key"
+    Gibbon.timeout = 15
+    Gibbon.throws_exceptions = false
+		
+For example, you could set the values above in an `initializer` file in your `Rails` app (e.g. your\_app/config/initializers/gibbon.rb).
+
+Assuming you've set an `api_key` on Gibbon, you can conveniently make API calls on the class itself:
+
     Gibbon.lists
 
-You can also set the environment variable 'MC_API_KEY' and Gibbon will use it when you create an instance:
+You can also set the environment variable `MAILCHIMP_API_KEY` and Gibbon will use it when you create an instance:
 
     u = Gibbon.new
 
+> Note: In an effort to simplify Gibbon, the environment variable 'MC_API_KEY' is no longer available as of version 0.4.0. Please use 'MAILCHIMP_API_KEY' instead.
+
 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.
@@ -47,6 +64,10 @@ Similarly, to fetch your first 100 lists:
 
     lists = gb.lists({:start => 0, :limit=> 100})
 
+Or, to fetch a list by name:
+
+    list = gb.lists({:filters => {:list_name => list_name}})
+
 ### More Advanced Examples
 
 Getting batch member information for subscribers looks like this:
@@ -57,6 +78,29 @@ or
 
     info = gb.listMemberInfo({:id => list_id, :email_address => email_array})
 
+List subscribers for a list:
+
+    gb.list_members({:id => list_id})
+
+or
+
+List unsubscribed members for a list
+
+    gb.list_members({:id => list_id, :status => "unsubscribed"})
+
+Subscribe a member to a list:
+
+    gb.list_subscribe({:id => list_id, :email_address => "email_address", :merge_vars => {:FNAME => "First Name", :LNAME => "Last Name"}})
+> Note: This will send a welcome email to the new subscriber
+
+or
+
+Batch subscribe members to a list:
+
+    gb.list_batch_subscribe(:id => list_id, :batch => [{:EMAIL => "email1", :FNAME => "FirstName1", :LNAME => "LastName1"},{:EMAIL => "email2", :FNAME => "FirstName2", :LNAME => "LastName2"}])
+
+> Note: This will send welcome emails to the new subscribers
+
 Fetch open and click detail for recipients of a particular campaign:
 
     email_stats = gb.campaign_email_stats_aim({:cid => campaign_id, :email_address => email_array})
@@ -65,41 +109,47 @@ or
 
     email_stats = gb.campaignEmailStatsAIM({:cid => campaign_id, :email_address => email_array})
 
-### Other Stuff
+### Setting timeouts
 
 Gibbon defaults to a 30 second timeout. You can optionally set your own timeout (in seconds) like so:
 
-    gb.timeout = 5
+    gb = Gibbon.new("your_api_key", {:timeout => 5})
+
+or
+
+		gb.timeout = 5
+
+### Error handling
+
+By default Gibbon will attempt to raise errors returned by the API automatically.
+
+If you set the `throws_exceptions` boolean attribute to false, for a given instance,
+then Gibbon will not raise exceptions. This allows you to handle errors manually. The
+APIs will return a Hash with two keys "errors", a string containing some textual
+information about the error, and "code", the numeric code of the error.
+
+> Note: In an effort to make Gibbon easier to use, errors are raised automatically as of version 0.4.0.
 
 ### 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:
+In addition to the primary API, you can make calls to the [Export API](http://apidocs.mailchimp.com/export/1.0/) using an instance of GibbonExport.  Given an existing instance of Gibbon, you can request a new GibbonExporter object:
 
-    g = Gibbon.new(@api_key)
+    g = Gibbon.new("your_api_key")
     gibbon_export = g.get_exporter
 
 or you can construct a new object directly:
 
-    gibbon_export = GibbonExport.new(@api_key)
+    gibbon_export = GibbonExport.new("your_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.
 
-### Error handling
-
-By default you are expected to handle errors returned by the APIs manually.  The
-APIs will return a Hash with two keys "errors", a string containing some textual
-information about the error, and "code", the numeric code of the error.
-
-If you set the `throws_exceptions` boolean attribute for a given instance then
-Gibbon will attempt to intercept the errors and raise an exception.
-
 ##Thanks
 
+The following people have contributed to Gibbon's development in some way:
+
 * [Justin Ip](https://github.com/ippy04)
 * [elshimone](https://github.com/elshimone)
 * [jlxw](https://github.com/jlxw)
@@ -108,9 +158,10 @@ Gibbon will attempt to intercept the errors and raise an exception.
 * [Dave Worth](https://github.com/daveworth)
 * [Mike Skalnik](https://github.com/skalnik)
 * [Kristopher Murata](https://github.com/krsmurata)
+* [Michael Klishin](https://github.com/michaelklishin)
 * Rails for camelize gsub
 
-##Copyrights
+##Copyright
 
-* Copyright (c) 2010 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2010 The Rocket Science Group.
+* Copyright (c) 2010-2012 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2012 The Rocket Science Group.

data/Rakefile

@@ -1,54 +1,10 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "gibbon"
-  gem.homepage = "http://github.com/amro/gibbon"
-  gem.license = "MIT"
-  gem.summary = %Q{Gibbon is a simple API wrapper for interacting with MailChimp API 1.3}
-  gem.description = %Q{Gibbon is a simple API wrapper for interacting with MailChimp API version 1.3.}
-  gem.email = "amromousa@gmail.com"
-  gem.authors = ["Amro Mousa"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_runtime_dependency 'httparty', '> 0.6.0'
-  gem.add_runtime_dependency 'json', '> 1.4.0'
-  gem.add_development_dependency 'mocha', '> 0.9.11'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rake/testtask'
+require 'bundler/gem_tasks'
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/test_*.rb'
   test.verbose = true
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "gibbon #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task default: [:test]

data/gibbon.gemspec

@@ -1,90 +1,32 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = "gibbon"
-  s.version = "0.3.5"
+  s.name        = "gibbon"
+  s.version     = "0.4.0"
+  s.authors     = ["Amro Mousa"]
+  s.email       = ["amromousa@gmail.com"]
+  s.homepage    = "http://github.com/amro/gibbon"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Amro Mousa"]
-  s.date = "2011-12-09"
-  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"
-  ]
-  s.files = [
-    ".document",
-    ".travis.yml",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "gibbon.gemspec",
-    "lib/gibbon.rb",
-    "test/helper.rb",
-    "test/test_gibbon.rb"
-  ]
-  s.homepage = "http://github.com/amro/gibbon"
-  s.licenses = ["MIT"]
+  s.summary     = %q{A simple wrapper for MailChimp's primary and export APIs}
+  s.description = %q{A simple wrapper for MailChimp's primary and export APIs}
+  s.license     = "MIT"
+
+  s.post_install_message = "Warning: Gibbon versions 0.4.0 and newer include breaking changes like throwing exceptions by default!\n" +
+                           "Please read more at http://github.com/amro/gibbon before upgrading from 0.3.x!"
+  
+  s.rubyforge_project = "gibbon"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   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"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_dependency('httparty')
+  s.add_dependency('json')
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<json>, ["> 1.4.0"])
-      s.add_runtime_dependency(%q<httparty>, ["> 0.6.0"])
-      s.add_runtime_dependency(%q<rdoc>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, ["> 0.9.11"])
-      s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
-      s.add_development_dependency(%q<ruby-debug>, [">= 0"])
-      s.add_runtime_dependency(%q<httparty>, ["> 0.6.0"])
-      s.add_runtime_dependency(%q<json>, ["> 1.4.0"])
-      s.add_development_dependency(%q<mocha>, ["> 0.9.11"])
-    else
-      s.add_dependency(%q<json>, ["> 1.4.0"])
-      s.add_dependency(%q<httparty>, ["> 0.6.0"])
-      s.add_dependency(%q<rdoc>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<mocha>, ["> 0.9.11"])
-      s.add_dependency(%q<ruby-debug19>, [">= 0"])
-      s.add_dependency(%q<ruby-debug>, [">= 0"])
-      s.add_dependency(%q<httparty>, ["> 0.6.0"])
-      s.add_dependency(%q<json>, ["> 1.4.0"])
-      s.add_dependency(%q<mocha>, ["> 0.9.11"])
-    end
-  else
-    s.add_dependency(%q<json>, ["> 1.4.0"])
-    s.add_dependency(%q<httparty>, ["> 0.6.0"])
-    s.add_dependency(%q<rdoc>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<mocha>, ["> 0.9.11"])
-    s.add_dependency(%q<ruby-debug19>, [">= 0"])
-    s.add_dependency(%q<ruby-debug>, [">= 0"])
-    s.add_dependency(%q<httparty>, ["> 0.6.0"])
-    s.add_dependency(%q<json>, ["> 1.4.0"])
-    s.add_dependency(%q<mocha>, ["> 0.9.11"])
-  end
+  s.add_development_dependency('rake')
+  s.add_development_dependency('debugger')
+  s.add_development_dependency('shoulda')
+  s.add_development_dependency('mocha')
 end
-

data/lib/gibbon.rb

@@ -6,126 +6,135 @@ class Gibbon
   include HTTParty
   format :plain
   default_timeout 30
+  disable_rails_query_string_format
 
   attr_accessor :api_key, :timeout, :throws_exceptions
 
-  def initialize(api_key = nil, extra_params = {})
-    @api_key = api_key || ENV['MC_API_KEY'] || ENV['MAILCHIMP_API_KEY'] || self.class.api_key
-    @default_params = {:apikey => @api_key}.merge(extra_params)
-    @throws_exceptions = false
-  end
+  MailChimpError = Class.new(StandardError)
+
+  def initialize(api_key = nil, default_parameters = {})
+    @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
 
+    @timeout = default_parameters.delete(:timeout)
+    @throws_exceptions = default_parameters.delete(:throws_exceptions)
+  
+    @default_params = {apikey: @api_key}.merge(default_parameters)
+    
+    set_instance_defaults
+  end
+  
   def api_key=(value)
     @api_key = value
-    @default_params = @default_params.merge({:apikey => @api_key})
+    @default_params = @default_params.merge({apikey: @api_key})
   end
 
   def get_exporter
     GibbonExport.new(@api_key, @default_params)
   end
 
+  protected
+
   def base_api_url
     "https://#{dc_from_api_key}api.mailchimp.com/1.3/?method="
   end
-
-protected
-
+  
   def call(method, params = {})
     api_url = base_api_url + method
     params = @default_params.merge(params)
-    response = self.class.post(api_url, :body => CGI::escape(params.to_json), :timeout => @timeout)
-
-    begin
-      response = JSON.parse(response.body)
-    rescue
-      response = JSON.parse('['+response.body+']').first
+    response = self.class.post(api_url, body: CGI::escape(params.to_json), timeout: @timeout)
+    
+    # MailChimp API sometimes returns JSON fragments (e.g. true from listSubscribe)
+    # so we parse after adding brackets to create a JSON array so 
+    # JSON.parse succeeds in those cases.
+    parsed_response = JSON.parse('[' + response.body + ']').first
+
+    if should_raise_for_response?(parsed_response)
+      raise MailChimpError.new("MailChimp API Error: #{parsed_response["error"]} (code #{parsed_response["code"]})")
     end
 
-    if @throws_exceptions && response.is_a?(Hash) && response["error"]
-      raise "Error from MailChimp API: #{response["error"]} (code #{response["code"]})"
-    end
+    # Some calls (e.g. listSubscribe) return json fragments
+    # (e.g. true) so wrap in an array prior to parsing
+    response = JSON.parse('['+response.body+']').first
 
-    response
+    parsed_response
   end
-
+  
   def method_missing(method, *args)
-    method = method.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } #Thanks for the gsub, Rails
+    # To support underscores, we camelize the method name
+
+    # Thanks for the camelize gsub, Rails
+    method = method.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+
+    # We need to downcase the first letter of every API method
+    # and MailChimp has a few of API methods that end in "AIM," which
+    # must be upcased (See "Campaign Report Data Methods" in their API docs).
     method = method[0].chr.downcase + method[1..-1].gsub(/aim$/i, 'AIM')
-    args = {} unless args.length > 0
-    args = args[0] if args.is_a?(Array)
-    call(method, args)
+
+    call(method, *args)
+  end
+  
+  def set_instance_defaults
+    @timeout = (self.class.timeout || 30) if @timeout.nil?
+
+    # Two lines because the class variable could be false and (false || true) is always true
+    @throws_exceptions = self.class.throws_exceptions if @throws_exceptions.nil?
+    @throws_exceptions = true if @throws_exceptions.nil?
+  end
+
+  def should_raise_for_response?(response)
+    @throws_exceptions && response.is_a?(Hash) && response["error"]
+  end
+
+  def base_api_url
+    "https://#{get_data_center_from_api_key}api.mailchimp.com/1.3/?method="
   end
 
   class << self
-    attr_accessor :api_key
+    attr_accessor :api_key, :timeout, :throws_exceptions
 
     def method_missing(sym, *args, &block)
-      new(self.api_key).send(sym, *args, &block)
+      new(self.api_key, {timeout: self.timeout, throws_exceptions: self.throws_exceptions}).send(sym, *args, &block)
     end
   end
 
-  def dc_from_api_key
-    (@api_key.nil? || @api_key.length == 0 || @api_key !~ /-/) ? '' : "#{@api_key.split("-").last}."
+  def get_data_center_from_api_key
+    # Return an empty string for invalid API keys so Gibbon hits the main endpoint
+    data_center = ""
+
+    if (@api_key && @api_key["-"])
+      # Add a period since the data_center is a subdomain and it keeps things dry
+      data_center = "#{@api_key.split('-').last}."
+    end
+
+    data_center
   end
 end
-
+  
 class GibbonExport < Gibbon
-  def initialize(api_key = nil, extra_params = {})
-    super(api_key, extra_params)
+  def initialize(api_key = nil, default_parameters = {})
+    super(api_key, default_parameters)
   end
 
-protected
+  protected
 
   def export_api_url
-    "http://#{dc_from_api_key}api.mailchimp.com/export/1.0/"
+    "http://#{get_data_center_from_api_key}api.mailchimp.com/export/1.0/"
   end
 
   def call(method, params = {})
     api_url = export_api_url + method + "/"
     params = @default_params.merge(params)
-    response = self.class.post(api_url, :body => params, :timeout => @timeout)
+    response = self.class.post(api_url, body: params, timeout: @timeout)
 
     lines = response.body.lines
     if @throws_exceptions
-      first_line_object = JSON.parse(lines.first) if lines.first
-      raise "Error from MailChimp Export API: #{first_line_object["error"]} (code #{first_line_object["code"]})" if first_line_object.is_a?(Hash) && first_line_object["error"]
+      first_line = JSON.parse(lines.first) if lines.first
+      
+      if should_raise_for_response?(first_line)
+        raise MailChimpError.new("MailChimp Export API Error: #{first_line["error"]} (code #{first_line["code"]})")
+      end
     end
 
     lines
   end
-end
-  
-module HTTParty
-  module HashConversions
-    # @param key<Object> The key for the param.
-    # @param value<Object> The value for the param.
-    #
-    # @return <String> This key value pair as a param
-    #
-    # @example normalize_param(:name, "Bob Jones") #=> "name=Bob%20Jones&"
-    def self.normalize_param(key, value)
-      param = ''
-      stack = []
-
-      if value.is_a?(Array)
-        param << Hash[*(0...value.length).to_a.zip(value).flatten].map {|i,element| normalize_param("#{key}[#{i}]", element)}.join
-      elsif value.is_a?(Hash)
-        stack << [key,value]
-      else
-        param << "#{key}=#{URI.encode(value.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))}&"
-      end
-
-      stack.each do |parent, hash|
-        hash.each do |key, value|
-          if value.is_a?(Hash)
-            stack << ["#{parent}[#{key}]", value]
-          else
-            param << normalize_param("#{parent}[#{key}]", value)
-          end
-        end
-      end
-
-      param
-    end
-  end
-end
+end

data/test/test_gibbon.rb

@@ -1,6 +1,6 @@
 require 'helper'
 require 'cgi'
-require 'ruby-debug'
+require 'ruby-debug' unless ENV["CI"]
 
 class TestGibbon < Test::Unit::TestCase
 
@@ -20,13 +20,6 @@ class TestGibbon < Test::Unit::TestCase
       assert_equal(@api_key, @gibbon.api_key)
     end
 
-    should "set an API key from the 'MC_API_KEY' ENV variable" do
-      ENV['MC_API_KEY'] = @api_key
-      @gibbon = Gibbon.new
-      assert_equal(@api_key, @gibbon.api_key)
-      ENV.delete('MC_API_KEY')
-    end
-
     should "set an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
       ENV['MAILCHIMP_API_KEY'] = @api_key
       @gibbon = Gibbon.new
@@ -79,6 +72,32 @@ class TestGibbon < Test::Unit::TestCase
       @gibbon.say_hello
     end
   end
+  
+  context "Gibbon class variables" do
+    setup do
+      Gibbon.api_key = "123-us1"
+      Gibbon.timeout = 15
+      Gibbon.throws_exceptions = false
+    end
+    
+    teardown do
+      Gibbon.api_key = nil
+      Gibbon.timeout = nil
+      Gibbon.throws_exceptions = nil
+    end
+    
+    should "set api key on new instances" do
+      assert_equal(Gibbon.new.api_key, Gibbon.api_key)
+    end
+
+    should "set timeout on new instances" do
+      assert_equal(Gibbon.new.timeout, Gibbon.timeout)
+    end
+    
+    should "set throws_exceptions on new instances" do
+      assert_equal(Gibbon.new.throws_exceptions, Gibbon.throws_exceptions)
+    end
+  end
 
   context "build api body" do
     setup do
@@ -129,19 +148,18 @@ class TestGibbon < Test::Unit::TestCase
       assert_equal(@exporter.api_key, @gibbon.api_key)
     end
 
-    should "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
+    should "not throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
+      @gibbon.throws_exceptions = false
       Gibbon.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
       assert_nothing_raised do
-        result = @gibbon.say_hello
+        @gibbon.say_hello
       end
-
-      ap result
     end
 
     should "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = true
       Gibbon.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
-      assert_raise RuntimeError do
+      assert_raise Gibbon::MailChimpError do
         @gibbon.say_hello
       end
     end
@@ -160,7 +178,7 @@ class TestGibbon < Test::Unit::TestCase
       @api_key = "TESTKEY-us2"
       @gibbon = GibbonExport.new(@api_key)
 
-      params = {:body => @body, :timeout => nil}
+      params = {:body => @body, :timeout => 30}
     
       url = @url.gsub('us1', 'us2') + "sayHello/"
       GibbonExport.expects(:post).with(url, params).returns(@returns)
@@ -168,6 +186,7 @@ class TestGibbon < Test::Unit::TestCase
     end
 
     should "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
+      @gibbon.throws_exceptions = false
       GibbonExport.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
 
       assert_nothing_raised do
@@ -177,10 +196,10 @@ class TestGibbon < Test::Unit::TestCase
 
     should "throw exception if configured to and the Export API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = true
-      params = {:body => @body, :timeout => nil}
+      params = {:body => @body, :timeout => 30}
       GibbonExport.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things', 'code' => '123'}.to_json))
 
-      assert_raise RuntimeError do
+      assert_raise Gibbon::MailChimpError do
         @gibbon.say_hello(@body)
       end
     end
@@ -189,12 +208,11 @@ class TestGibbon < Test::Unit::TestCase
 
   private
 
-  def expect_post(expected_url, expected_body, expected_timeout=nil)
+  def expect_post(expected_url, expected_body, expected_timeout=30)
     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.3.5
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,110 +9,75 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000Z
+date: 2012-11-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: &70215916804420 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>'
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70215916804420
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70215916803880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70215916803880
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &70215916803380 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70215916803380
 - !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: &70215916802860 !ruby/object:Gem::Requirement
+  name: json
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
-  version_requirements: *70215916802860
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70215916802360 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: *70215916802360
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
-  requirement: &70215916801880 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215916801880
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &70215916801380 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70215916801380
 - !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70215916800900 !ruby/object:Gem::Requirement
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215916800900
-- !ruby/object:Gem::Dependency
-  name: ruby-debug19
-  requirement: &70215916800320 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70215916800320
 - !ruby/object:Gem::Dependency
-  name: ruby-debug
-  requirement: &70215916799820 !ruby/object:Gem::Requirement
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,56 +85,42 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215916799820
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: &70215916799260 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70215916799260
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
-  requirement: &70215916798760 !ruby/object:Gem::Requirement
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.4.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *70215916798760
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70215916798280 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>'
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: *70215916798280
-description: Gibbon is a simple API wrapper for interacting with MailChimp API version
-  1.3.
-email: amromousa@gmail.com
+        version: '0'
+description: A simple wrapper for MailChimp's primary and export APIs
+email:
+- amromousa@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.markdown
+extra_rdoc_files: []
 files:
 - .document
+- .gitignore
 - .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.markdown
 - Rakefile
-- VERSION
 - gibbon.gemspec
 - lib/gibbon.rb
 - test/helper.rb
@@ -177,7 +128,10 @@ files:
 homepage: http://github.com/amro/gibbon
 licenses:
 - MIT
-post_install_message: 
+post_install_message: ! 'Warning: Gibbon versions 0.4.0 and newer include breaking
+  changes like throwing exceptions by default!
+
+  Please read more at http://github.com/amro/gibbon before upgrading from 0.3.x!'
 rdoc_options: []
 require_paths:
 - lib
@@ -189,19 +143,22 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2484681847014778233
+      hash: -1069299748253036727
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1069299748253036727
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.10
+rubyforge_project: gibbon
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Gibbon is a simple API wrapper for interacting with MailChimp API 1.3
+summary: A simple wrapper for MailChimp's primary and export APIs
 test_files:
 - test/helper.rb
 - test/test_gibbon.rb

data/VERSION

@@ -1 +0,0 @@
-0.3.5