gibbon 0.4.2 → 0.4.3

data/README.markdown

@@ -109,6 +109,11 @@ or
 
     email_stats = gb.campaignEmailStatsAIM({:cid => campaign_id, :email_address => email_array})
 
+Overriding Gibbon's API endpoint (i.e. if using an access token from OAuth and have the `api_endpoint` from the [metadata](http://apidocs.mailchimp.com/oauth2/)):
+
+    Gibbon.api_endpoint = "https://us1.api.mailchimp.com"
+    Gibbon.api_key = your_access_token_or_api_key
+
 ### Setting timeouts
 
 Gibbon defaults to a 30 second timeout. You can optionally set your own timeout (in seconds) like so:
@@ -159,9 +164,11 @@ The following people have contributed to Gibbon's development in some way:
 * [Mike Skalnik](https://github.com/skalnik)
 * [Kristopher Murata](https://github.com/krsmurata)
 * [Michael Klishin](https://github.com/michaelklishin)
+* [Adam Loving](https://github.com/adamloving)
+* [Kelly Dunn](https://github.com/kellydunn)
 * Rails for camelize gsub
 
 ##Copyright
 
-* Copyright (c) 2010-2012 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2012 The Rocket Science Group.
+* Copyright (c) 2010-2013 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2013 The Rocket Science Group.

data/gibbon.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "gibbon"
-  s.version     = "0.4.2"
+  s.version     = "0.4.3"
   s.authors     = ["Amro Mousa"]
   s.email       = ["amromousa@gmail.com"]
   s.homepage    = "http://github.com/amro/gibbon"
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency('httparty')
-  s.add_dependency('json')
+  s.add_dependency('multi_json')
 
   s.add_development_dependency('rake')
   s.add_development_dependency('debugger')

data/lib/gibbon.rb

@@ -7,7 +7,7 @@ class Gibbon
   format :plain
   default_timeout 30
 
-  attr_accessor :api_key, :timeout, :throws_exceptions
+  attr_accessor :api_key, :api_endpoint, :timeout, :throws_exceptions
 
   MailChimpError = Class.new(StandardError)
 
@@ -15,6 +15,7 @@ class Gibbon
     @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
     @api_key = @api_key.strip if @api_key
 
+    @api_endpoint = default_parameters.delete(:api_endpoint)
     @timeout = default_parameters.delete(:timeout)
     @throws_exceptions = default_parameters.delete(:throws_exceptions)
   
@@ -42,7 +43,7 @@ class Gibbon
     # 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
+    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"]})")
@@ -67,7 +68,7 @@ class Gibbon
   
   def set_instance_defaults
     @timeout = (self.class.timeout || 30) if @timeout.nil?
-
+    @api_endpoint = self.class.api_endpoint if @api_endpoint.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?
@@ -78,14 +79,18 @@ class Gibbon
   end
 
   def base_api_url
-    "https://#{get_data_center_from_api_key}api.mailchimp.com/1.3/?method="
+    "#{@api_endpoint || get_api_endpoint}/1.3/?method="
+  end
+
+  def get_api_endpoint
+    "https://#{get_data_center_from_api_key}api.mailchimp.com"
   end
 
   class << self
-    attr_accessor :api_key, :timeout, :throws_exceptions
+    attr_accessor :api_key, :timeout, :throws_exceptions, :api_endpoint
 
     def method_missing(sym, *args, &block)
-      new(self.api_key, {timeout: self.timeout, throws_exceptions: self.throws_exceptions}).send(sym, *args, &block)
+      new(self.api_key, {api_endpoint: self.api_endpoint, timeout: self.timeout, throws_exceptions: self.throws_exceptions}).send(sym, *args, &block)
     end
   end
 
@@ -129,4 +134,4 @@ class GibbonExport < Gibbon
 
     lines
   end
-end
+end

data/test/test_gibbon.rb

@@ -39,6 +39,12 @@ class TestGibbon < Test::Unit::TestCase
       @gibbon.timeout = timeout
       assert_equal(timeout, @gibbon.timeout)
     end
+
+    should "detect api endpoint from initializer parameters" do
+      api_endpoint = 'https://us6.api.mailchimp.com'
+      @gibbon = Gibbon.new(@api_key, :api_endpoint => api_endpoint)
+      assert_equal api_endpoint, @gibbon.api_endpoint
+    end
   end
 
   context "build api url" do
@@ -71,6 +77,15 @@ class TestGibbon < Test::Unit::TestCase
       expect_post("https://us1.api.mailchimp.com/1.3/?method=sayHello", {"apikey" => @api_key})
       @gibbon.say_hello
     end
+
+    # when the end user has signed in via oauth, api_key and endpoint should be supplied separately
+    should "not require datacenter in api key" do
+      @api_key = "TESTKEY"
+      @gibbon.api_key = @api_key
+      @gibbon.api_endpoint = "https://us6.api.mailchimp.com"
+      expect_post("https://us6.api.mailchimp.com/1.3/?method=sayHello", {"apikey" => @api_key})
+      @gibbon.say_hello      
+    end
   end
   
   context "Gibbon class variables" do
@@ -78,12 +93,14 @@ class TestGibbon < Test::Unit::TestCase
       Gibbon.api_key = "123-us1"
       Gibbon.timeout = 15
       Gibbon.throws_exceptions = false
+      Gibbon.api_endpoint = 'https://us6.api.mailchimp.com'
     end
     
     teardown do
       Gibbon.api_key = nil
       Gibbon.timeout = nil
       Gibbon.throws_exceptions = nil
+      Gibbon.api_endpoint = nil
     end
     
     should "set api key on new instances" do
@@ -97,6 +114,11 @@ class TestGibbon < Test::Unit::TestCase
     should "set throws_exceptions on new instances" do
       assert_equal(Gibbon.new.throws_exceptions, Gibbon.throws_exceptions)
     end
+
+    should "set api_endpoint on new instances" do
+      assert Gibbon.api_endpoint
+      assert_equal(Gibbon.new.api_endpoint, Gibbon.api_endpoint)
+    end
   end
 
   context "build api body" do
@@ -163,6 +185,11 @@ class TestGibbon < Test::Unit::TestCase
         @gibbon.say_hello
       end
     end
+    
+    should "not raise exception if the api returns no response body" do
+      Gibbon.stubs(:post).returns(Struct.new(:body).new(nil))
+      assert_nil @gibbon.say_hello
+    end
   end
 
   context "export API" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2013-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -28,7 +28,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3179845678375072173
+      hash: 2873655008867381541
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3179845678375072173
+      hash: 2873655008867381541
 requirements: []
 rubyforge_project: gibbon
 rubygems_version: 1.8.24