gibbon 0.4.6 → 0.5.0

data/lib/gibbon/api_category.rb

@@ -0,0 +1,83 @@
+require 'gibbon/api'
+
+module Gibbon
+  class APICategory
+    include HTTParty
+    format :plain
+    default_timeout 30
+
+    attr_accessor :category_name, :api_key, :api_endpoint, :timeout, :throws_exceptions, :default_params
+  
+    def initialize(category_name, api_key, timeout, throws_exceptions, api_endpoint, default_params)
+      @category_name = category_name
+      @api_key = api_key
+      @api_endpoint = api_endpoint
+      @default_params = default_params
+      @throws_exceptions = throws_exceptions
+      @timeout = timeout
+
+      set_instance_defaults
+    end
+
+    def call(method, params = {})
+      api_url = base_api_url + method
+      params = @default_params.merge(params).merge({apikey: @api_key})
+      response = self.class.post(api_url, body: MultiJson.dump(params), timeout: @timeout)
+      
+      parsed_response = nil
+      
+      if (response.body)
+        parsed_response = MultiJson.load(response.body)
+
+        if should_raise_for_response?(parsed_response)
+          error = MailChimpError.new("MailChimp API Error: #{parsed_response["error"]} (code #{parsed_response["code"]})")
+          error.code = parsed_response["code"]
+          raise error
+        end
+      end
+
+      parsed_response
+    end
+  
+    def method_missing(method, *args)
+      # To support underscores, we replace them with hyphens when calling the API
+      method = method.to_s.gsub("_", "-").downcase
+      call("#{@category_name}/#{method}", *args)
+    end
+  
+    def set_instance_defaults
+      @timeout = (API.timeout || 30) if @timeout.nil?
+      # Two lines because the class variable could be false and (false || true) is always true
+      @throws_exceptions = API.throws_exceptions if @throws_exceptions.nil?
+      @throws_exceptions = true if @throws_exceptions.nil?
+    end
+
+    def api_key=(value)
+      @api_key = value.strip if value
+    end
+    
+    def should_raise_for_response?(response)
+      @throws_exceptions && response.is_a?(Hash) && response["error"]
+    end
+
+    def base_api_url
+      "#{@api_endpoint || get_api_endpoint}/2.0/"
+    end
+
+    def get_api_endpoint
+      "https://#{get_data_center_from_api_key}api.mailchimp.com"
+    end
+
+    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
+end

data/lib/gibbon/export.rb

@@ -0,0 +1,64 @@
+module Gibbon
+  class Export < APICategory
+    
+    def initialize(api_key = nil, default_params = {})
+      @api_key = api_key
+      @default_params = default_params
+
+      set_instance_defaults
+    end
+
+    protected
+
+    def export_api_url
+      "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).merge({apikey: @api_key})
+      response = self.class.post(api_url, body: MultiJson.dump(params), timeout: @timeout)
+
+      lines = response.body.lines
+      if @throws_exceptions
+        first_line = MultiJson.load(lines.first) if lines.first
+    
+        if should_raise_for_response?(first_line)
+          error = MailChimpError.new("MailChimp Export API Error: #{first_line["error"]} (code #{first_line["code"]})")
+          error.code = first_line["code"]
+          raise error
+        end
+      end
+
+      lines
+    end
+        
+    def set_instance_defaults
+      super
+      @api_key = self.class.api_key if @api_key.nil?
+      @timeout = self.class.timeout if @timeout.nil?
+    end
+
+    def method_missing(method, *args)
+      # 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')
+
+      call(method, *args)
+    end
+
+    class << self
+      attr_accessor :api_key, :timeout, :throws_exceptions
+
+      def method_missing(sym, *args, &block)
+        new(self.api_key, {timeout: self.timeout, throws_exceptions: self.throws_exceptions}).send(sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/gibbon/mailchimp_error.rb

@@ -0,0 +1,5 @@
+module Gibbon
+  class MailChimpError < StandardError
+    attr_accessor :code
+  end
+end

data/spec/gibbon/gibbon_spec.rb

@@ -0,0 +1,247 @@
+require 'spec_helper'
+require 'cgi'
+
+describe Gibbon do
+
+  describe "attributes" do
+
+    before do
+      @api_key = "123-us1"
+    end
+
+    it "have no API by default" do
+      @gibbon = Gibbon::API.new
+      expect(@gibbon.api_key).to be_nil
+    end
+
+    it "set an API key in constructor" do
+      @gibbon = Gibbon::API.new(@api_key)
+      expect(@gibbon.api_key).to eq(@api_key)
+    end
+
+    it "set an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
+      ENV['MAILCHIMP_API_KEY'] = @api_key
+      @gibbon = Gibbon::API.new
+      expect(@gibbon.api_key).to eq(@api_key)
+      ENV.delete('MAILCHIMP_API_KEY')
+    end
+
+    it "set an API key via setter" do
+      @gibbon = Gibbon::API.new
+      @gibbon.api_key = @api_key
+      expect(@gibbon.api_key).to eq(@api_key)
+    end
+
+    it "set timeout and get" do
+      @gibbon = Gibbon::API.new
+      timeout = 30
+      @gibbon.timeout = timeout
+      expect(timeout).to eq(@gibbon.timeout)
+    end
+
+    it "detect api endpoint from initializer parameters" do
+      api_endpoint = 'https://us6.api.mailchimp.com'
+      @gibbon = Gibbon::API.new(@api_key, :api_endpoint => api_endpoint)
+      expect(api_endpoint).to eq(@gibbon.api_endpoint)
+    end
+  end
+
+  describe "build api url" do
+    before do
+      @gibbon = Gibbon::API.new
+      @url = "https://api.mailchimp.com/2.0/say/hello"
+    end
+
+    it "handle empty api key" do
+      expect_post(@url, {"apikey" => nil})
+      @gibbon.say.hello
+    end
+
+    it "handle malformed api key" do
+      @api_key = "123"
+      @gibbon.api_key = @api_key
+      expect_post(@url, {"apikey" => @api_key})
+      @gibbon.say.hello
+    end
+
+    it "handle timeout" do
+      expect_post(@url, {"apikey" => nil}, 120)
+      @gibbon.timeout=120
+      @gibbon.say.hello
+    end
+
+    it "handle api key with dc" do
+      @api_key = "TESTKEY-us1"
+      @gibbon.api_key = @api_key
+      expect_post("https://us1.api.mailchimp.com/2.0/say/hello", {"apikey" => @api_key})
+      @gibbon.say.hello
+    end
+
+    # when the end user has signed in via oauth, api_key and endpoint it be supplied separately
+    it "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/2.0/say/hello", {"apikey" => @api_key})
+      @gibbon.say.hello
+    end
+  end
+
+  describe "Gibbon class variables" do
+    before do
+      Gibbon::API.api_key = "123-us1"
+      Gibbon::API.timeout = 15
+      Gibbon::API.throws_exceptions = false
+      Gibbon::API.api_endpoint = 'https://us6.api.mailchimp.com'
+    end
+
+    after do
+      Gibbon::API.api_key = nil
+      Gibbon::API.timeout = nil
+      Gibbon::API.throws_exceptions = nil
+      Gibbon::API.api_endpoint = nil
+    end
+
+    it "set api key on new instances" do
+      expect(Gibbon::API.new.api_key).to eq(Gibbon::API.api_key)
+    end
+
+    it "set timeout on new instances" do
+      expect(Gibbon::API.new.timeout).to eq(Gibbon::API.timeout)
+    end
+
+    it "set throws_exceptions on new instances" do
+      expect(Gibbon::API.new.throws_exceptions).to eq(Gibbon::API.throws_exceptions)
+    end
+
+    it "set api_endpoint on new instances" do
+      expect(Gibbon::API.api_endpoint).not_to be_nil
+      expect(Gibbon::API.new.api_endpoint).to eq(Gibbon::API.api_endpoint)
+    end
+  end
+
+  describe "build api body" do
+    before do
+      @key = "TESTKEY-us1"
+      @gibbon = Gibbon::API.new(@key)
+      @url = "https://us1.api.mailchimp.com/2.0/say/hello"
+      @body = {"apikey" => @key}
+    end
+
+    it "works for string parameters" do
+      @message = "simon says"
+      expect_post(@url, @body.merge("message" => @message))
+      @gibbon.say.hello(:message => @message)
+    end
+
+    it "works for string parameters in an array" do
+      expect_post(@url, @body.merge("messages" => ["simon says", "do this"]))
+      @gibbon.say.hello(:messages => ["simon says", "do this"])
+    end
+
+    it "works for string parameters in a hash" do
+      expect_post(@url, @body.merge("messages" => {"simon says" => "do this"}))
+      @gibbon.say.hello(:messages => {"simon says" => "do this"})
+    end
+
+    it "works for nested string parameters" do
+      expect_post(@url, @body.merge("messages" => {"simon says" => ["do this", "and this"]}))
+      @gibbon.say.hello(:messages => {"simon says" => ["do this", "and this"]})
+    end
+
+    it "pass through non string parameters" do
+      expect_post(@url, @body.merge("fee" => 99))
+      @gibbon.say.hello(:fee => 99)
+    end
+  end
+
+  describe "Gibbon instances" do
+    before do
+      @key = "TESTKEY-us1"
+      @gibbon = Gibbon::API.new(@key)
+      @url = "https://us1.api.mailchimp.com/2.0/say/hello"
+      @body = {"apikey" => @key}
+      @returns = Struct.new(:body).new(MultiJson.dump(["array", "entries"]))
+    end
+
+    it "produce a good exporter" do
+      @exporter = @gibbon.get_exporter
+      expect(@exporter.api_key).to eq(@gibbon.api_key)
+    end
+
+    it "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::APICategory.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+
+      @gibbon.say.hello
+    end
+
+    it "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
+      @gibbon.throws_exceptions = true
+      Gibbon::APICategory.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+      expect(->{
+        @gibbon.say.hello
+      }).to raise_error(Gibbon::MailChimpError)
+    end
+
+    it "not raise exception if the api returns no response body" do
+      Gibbon::APICategory.stub(:post).and_return(Struct.new(:body).new(nil))
+      expect(@gibbon.say.hello).to be_nil
+    end
+  end
+
+  describe "export API" do
+    before do
+      @key = "TESTKEY-us1"
+      @gibbon = Gibbon::Export.new(@key)
+      @url = "http://us1.api.mailchimp.com/export/1.0/"
+      @body = {:apikey => @key, :id => "listid"}
+      @returns = Struct.new(:body).new(MultiJson.dump(["array", "entries"]))
+    end
+
+    it "handle api key with dc" do
+      @api_key = "TESTKEY-us2"
+      @gibbon = Gibbon::Export.new(@api_key)
+
+      @body[:apikey] = @api_key
+      params = {:body => MultiJson.dump(@body), :timeout => 30}
+
+      url = @url.gsub('us1', 'us2') + "sayHello/"
+      Gibbon::Export.should_receive(:post).with(url, params).and_return(@returns)
+      @gibbon.say_hello(@body)
+    end
+
+    it "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
+      @gibbon.throws_exceptions = false
+      Gibbon::Export.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+
+      @gibbon.say_hello(@body)
+    end
+
+    it "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 => 30}
+      reply = Struct.new(:body).new MultiJson.dump({'error' => 'bad things', 'code' => '123'})
+      Gibbon::Export.stub(:post).and_return reply
+
+      expect(->{
+        @gibbon.say_hello(@body)
+      }).to raise_error(Gibbon::MailChimpError)
+    end
+
+  end
+
+  private
+
+  def expect_post(expected_url, expected_body, expected_timeout=30)
+    Gibbon::APICategory.should_receive(:post).with do |url, opts|
+      expect(url).to            eq expected_url
+      expect(expected_body).to  eq MultiJson.load(URI::decode(opts[:body]))
+      expect(opts[:timeout]).to eq expected_timeout
+    end.and_return(Struct.new(:body).new("[]"))
+  end
+
+  # def expect_post(expected_url, expected_body, expected_timeout=30)
+  #   Gibbon::APICategory.should_receive(:post).and_return(Struct.new(:body).new(""))
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :development)
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gibbon'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end

metadata

@@ -1,113 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 0.4.6
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: A simple wrapper for MailChimp's primary and export APIs
+        version: 2.13.0
+description: A wrapper for MailChimp API 2.0 and Export API 1.0
 email:
 - amromousa@gmail.com
 executables: []
@@ -123,42 +82,39 @@ files:
 - Rakefile
 - gibbon.gemspec
 - lib/gibbon.rb
-- test/helper.rb
-- test/test_gibbon.rb
+- lib/gibbon/api.rb
+- lib/gibbon/api_category.rb
+- lib/gibbon/export.rb
+- lib/gibbon/mailchimp_error.rb
+- spec/gibbon/gibbon_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/amro/gibbon
 licenses:
 - MIT
-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!'
+metadata: {}
+post_install_message: |-
+  IMPORTANT: Gibbon now targets MailChimp API 2.0, which is substantially different from API 1.3.
+                               Please use Gibbon 0.4.6 if you need to use API 1.3.
+  If you're upgrading from <0.5.0 your code WILL break.
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2273673627394400762
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2273673627394400762
 requirements: []
 rubyforge_project: gibbon
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: A simple wrapper for MailChimp's primary and export APIs
+specification_version: 4
+summary: A wrapper for MailChimp API 2.0 and Export API 1.0
 test_files:
-- test/helper.rb
-- test/test_gibbon.rb
+- spec/gibbon/gibbon_spec.rb
+- spec/spec_helper.rb