gibbon 2.2.5 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4264e8ea898f75f9239b7d03d6c5dcb1cadc915d
-  data.tar.gz: c5e810141d2a9767d6e754128cd2b7d395e62bd1
+  metadata.gz: 12a6fecb32704fd28e939c71d68d04b002daa26b
+  data.tar.gz: b203c08f25fab5920c4714448709cf16c1297a74
 SHA512:
-  metadata.gz: aefbdbd257c1483028840b02bfd1e8952e25f185cdea4cd14b4adc8f6dd928826312605f7d66d264f2856e5a376ecfb841e218488361ab63d400b34bbf9e3d0d
-  data.tar.gz: 4f789cb640563d3979b5b498852ea8b3552429b17a601eb6c1aab87f9d38c5650b7b55d09cac227fc47f232ea5d940ffdb5682c43c9a332ed642e5ab635d2892
+  metadata.gz: 049a905ad6d6ccb68ed25d76e3192ab38e2342405c57aa89070817e79ad64a3d0d635129821b44cc69da778381134f9cada53480644defc8350c9da065851fc2
+  data.tar.gz: 15b2cc277b73e3e9b6af78045061d16924cdf677547e82e96ec5c04f37a966f359bbb8e1b589d12f6493e82c5d02b3884dac82328ee92560fab6487d4cf3ce26

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 sudo: false
 cache: bundler
+before_install:
+  - gem install bundler # -v 1.7.14 if a specific version is needed
 rvm:
   - 2.0.0
   - 2.1.5

data/CHANGELOG.md

@@ -1,8 +1,33 @@
 ## [Unreleased][unreleased]
 
+## [3.2.0] - 2017-11-08
+- Force TLS version 1.2
+
+## [3.1.1] - 2017-09-25
+- Fix MailChimpError initialization
+
+## [3.1.0] - 2017-07-27
+- Add back support for Export API until MailChimp stops supporting it
+- Implement `responds_to_missing`
+
+## [3.0.2] - 2017-05-08
+- Fix subtle bug in `symbolize_keys` when parsing error
+
+## [3.0.1] - 2017-01-13
+- Gibbon::Request (API 3.0) now returns a `Gibbon::Response` object that exposes `headers` and the parsed response `body`
+- Remove Export API support (this is deprected after all)
+- Adds `symbolize_keys`, `debug`, and `faraday_adapter` as class vars
+- Bump version to 3.0.1 (not sticking to semver here so folks who downloaded 3.0.0 have a way to easily move forward)
+
+## [3.0.0] - 2017-01-13
+- Gibbon::Request (API 3.0) now returns a `Gibbon::Response` object that exposes `headers` and the parsed response `body`
+- Adds Export API support
+- Adds `symbolize_keys`, `debug`, and `faraday_adapter` as class vars
+- Bump version to 3.0.0 due to breaking API change
+
 ## [2.2.5] - 2016-12-23
 - Adds open_timeout
-- Adds symbolize_keys
+- Adds `symbolize_keys`
 - Change default timeout from 30 to 60 seconds
 
 ## [2.2.4] - 2016-05-21
@@ -54,8 +79,23 @@
 ## [1.1.4] - 2012-11-04
 - Fix JSON::ParserError on export calls that return blank results
 
-[unreleased]: https://github.com/amro/gibbon/compare/v2.0.0...HEAD
+[unreleased]: https://github.com/amro/gibbon/compare/v3.1.0...HEAD
+[3.1.0]: https://github.com/amro/gibbon/compare/v3.0.2...v3.1.0
+[3.0.2]: https://github.com/amro/gibbon/compare/v3.0.1...v3.0.2
+[3.0.1]: https://github.com/amro/gibbon/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/amro/gibbon/compare/v2.2.5...v3.0.0
+[2.2.5]: https://github.com/amro/gibbon/compare/v2.2.4...v2.2.5
+[2.2.4]: https://github.com/amro/gibbon/compare/v2.2.2...v2.2.4
+[2.2.3]: https://github.com/amro/gibbon/compare/v2.2.2...v2.2.3
+[2.2.2]: https://github.com/amro/gibbon/compare/v2.2.1...v2.2.2
+[2.2.1]: https://github.com/amro/gibbon/compare/v2.2.0...v2.2.1
+[2.2.0]: https://github.com/amro/gibbon/compare/v2.1.3...v2.2.0
+[2.1.3]: https://github.com/amro/gibbon/compare/v2.1.2...v2.1.3
+[2.1.2]: https://github.com/amro/gibbon/compare/v2.1.1...v2.1.2
+[2.1.1]: https://github.com/amro/gibbon/compare/v2.1.0...v2.1.1
+[2.1.0]: https://github.com/amro/gibbon/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/amro/gibbon/compare/v1.2.0...v2.0.0
 [1.2.0]: https://github.com/amro/gibbon/compare/v1.1.5...v1.2.0
-[1.1.5]: https://github.com/amro/gibbon/compare/v1.1.5...v1.1.4
+[1.1.6]: https://github.com/amro/gibbon/compare/v1.1.5...v1.1.6
+[1.1.5]: https://github.com/amro/gibbon/compare/v1.1.4...v1.1.5
 [1.1.4]: https://github.com/amro/gibbon/compare/v1.1.3...v1.1.4

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2015 Amro Mousa
+Copyright (c) 2010-2017 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

@@ -4,23 +4,24 @@ Gibbon is an API wrapper for MailChimp's [API](http://kb.mailchimp.com/api/).
 
 [![Build Status](https://secure.travis-ci.org/amro/gibbon.svg)](http://travis-ci.org/amro/gibbon)
 [![Dependency Status](https://gemnasium.com/amro/gibbon.svg)](https://gemnasium.com/amro/gibbon)
-##Important Notes
 
-Gibbon now targets MailChimp API 3.0, which is substantially different from the previous API. Please use Gibbon 1.1.x if you need to use API 2.0.
+## Important Notes
 
 Please read MailChimp's [Getting Started Guide](http://kb.mailchimp.com/api/article/api-3-overview).
 
-##Installation
+Gibbon 3.0.0+ returns a `Gibbon::Response` instead of the response body directly. `Gibbon::Response` exposes the parsed response `body` and `headers`.
+
+## Installation
 
     $ gem install gibbon
 
-##Requirements
+## Requirements
 
 A MailChimp account and API key. You can see your API keys [here](http://admin.mailchimp.com/account/api).
 
-##Usage
+## Usage
 
-First, create a *one-time use instance* of Gibbon::Request:
+First, create a *one-time use instance* of `Gibbon::Request`:
 
 ```ruby
 gibbon = Gibbon::Request.new(api_key: "your_api_key")
@@ -50,12 +51,14 @@ gibbon.lists.retrieve(headers: {"SomeHeader": "SomeHeaderValue"}, params: {"quer
 
 Of course, `body` is only supported on `create`, `update`, and `upsert` calls. Those map to HTTP `POST`, `PATCH`, and `PUT` verbs respectively.
 
-You can set `api_key`, `timeout`, and `open_timeout` globally:
+You can set `api_key`, `timeout`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, and `debug` globally:
 
 ```ruby
 Gibbon::Request.api_key = "your_api_key"
 Gibbon::Request.timeout = 15
 Gibbon::Request.open_timeout = 15
+Gibbon::Request.symbolize_keys = true
+Gibbon::Request.debug = 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).
@@ -82,7 +85,7 @@ gibbon = Gibbon::Request.new(api_key: "your_api_key", symbolize_keys: true)
 
 MailChimp's [resource documentation](http://kb.mailchimp.com/api/resources) is a list of available resources.
 
-##Debug Logging
+## Debug Logging
 
 Pass `debug: true` to enable debug logging to STDOUT.
 
@@ -201,7 +204,7 @@ This will create a new batch job and return a Batch response. The response will
 gibbon.batches(batch_id).retrieve
 ```
 
-###### Response
+###### Response Body (i.e. `response.body`)
 ```ruby
 {
   "id"=>"0ca62e43cc",
@@ -332,7 +335,7 @@ So how do we get the interest IDs? When you query the API for a specific list me
 gibbon.lists(list_id).members(member_id).retrieve
 ```
 
-The response looks someting like this (unrelated things removed):
+The response body (i.e. `response.body`) looks someting like this (unrelated things removed):
 
 ```ruby
 {"id"=>"...", "email_address"=>"...", ..., "interests"=>{"3def637141"=>true, "f7cc4ee841"=>false, "fcdc951b9f"=>false, "3daf3cf27d"=>true, "293a3703ed"=>false, "72370e0d1f"=>false, "d434d21a1c"=>false, "bdb1ff199f"=>false, "a54e78f203"=>false, "c4527fd018"=>false} ...}
@@ -344,7 +347,7 @@ The API returns a map of interest ID to boolean value. Now we to get interest de
 gibbon.lists(list_id).interest_categories.retrieve
 ```
 
-To get a list of interest categories. That gives us something like:
+To get a list of interest categories. That gives us something like (again, this is the `response.body`):
 
 ```ruby
 {"list_id"=>"...", "categories"=>[{"list_id"=>"...", "id"=>"0ace7aa498", "title"=>"Food Preferences", ...}] ...}
@@ -396,7 +399,7 @@ gibbon = Gibbon::Request.new(api_key: "your_api_key", faraday_adapter: :net_http
 
 ### Migrating from Gibbon 1.x
 
-Gibbon 2.x has different syntax from version 1.x. This is because Gibbon maps to MailChimp's API and because version 3 of the API is quite different from version 2. First, the name of the primary class has changed from `API` to `Request`. And the way you pass an API key during initialization is different. A few examples below.
+Gibbon 2.x+ exposes a different API from version 1.x. This is because Gibbon maps to MailChimp's API and because version 3 of the API is quite different from version 2. First, the name of the primary class has changed from `API` to `Request`. And the way you pass an API key during initialization is different. A few examples below.
 
 #### Initialization
 
@@ -406,7 +409,7 @@ Gibbon 1.x:
 gibbon = Gibbon::API.new("your_api_key")
 ```
 
-Gibbon 2.x:
+Gibbon 2.x+:
 
 ```ruby
 gibbon = Gibbon::Request.new(api_key: "your_api_key")
@@ -422,7 +425,7 @@ Gibbon 1.x:
 gibbon.lists.list
 ```
 
-Gibbon 2.x:
+Gibbon 2.x+:
 
 ```ruby
 gibbon.lists.retrieve
@@ -436,7 +439,7 @@ Gibbon 1.x:
 gibbon.lists.members({:id => list_id})
 ```
 
-Gibbon 2.x:
+Gibbon 2.x+:
 
 ```ruby
 gibbon.lists(list_id).members.retrieve
@@ -450,11 +453,38 @@ Gibbon 1.x:
 gibbon.lists.subscribe({:id => list_id, :email => {:email => "foo@bar.com"}, :merge_vars => {:FNAME => "Bob", :LNAME => "Smith"}})
 ```
 
-Gibbon 2.x:
+Gibbon 2.x+:
 
 ```ruby
 gibbon.lists(list_id).members.create(body: {email_address: "foo@bar.com", status: "subscribed", merge_fields: {FNAME: "Bob", LNAME: "Smith"}})
 ```
+## Export API 1.0
+
+Gibbon 3.0.0+ supports MailChimp's [Export API 1.0](https://apidocs.mailchimp.com/export/1.0/). You can choose to handle the API response all at
+once or line by line by passing a block. To access the Export API with Gibbon, you must first create an instance of `Gibbon::Export`:
+
+```ruby
+export = Gibbon::Export.new(api_key: "your_api_key")
+```
+
+Next, call the method corresponding to the API endpoint you'd like to query:
+
+```ruby
+export.list(id: list_id)
+```
+
+This fetches and returns all of the results at once. Pass a block if you'd like to handle the response as individual lines:
+
+```ruby
+export = Gibbon::Export.new(api_key: "your_api_key", timeout: 1200)
+export.list(id: list_id) do |row| 
+  puts row
+end
+```
+
+This is useful when handling large sets of data. Setting the `timeout` here is optional, but a high value is recommended given the nature of the Export API. The default timeout is 600 seconds.
+
+Gibbon supports all current Export API endpoints: `/list`, `/ecommOrders`, and `/campaignSubscriberActivity`. They're mapped onto Ruby methods with similar names: `list()`, `ecomm_orders()`, and `campaign_subscriber_activity()` respectively. Please see [MailChimp's API documentation](https://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-the-export-api/) for supported parameters.
 
 ## Thanks
 
@@ -462,5 +492,5 @@ Thanks to everyone who has [contributed](https://github.com/amro/gibbon/contribu
 
 ## Copyright
 
-* Copyright (c) 2010-2016 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2016 The Rocket Science Group.
+* Copyright (c) 2010-2017 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2017 The Rocket Science Group.

data/gibbon.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.email       = ["amromousa@gmail.com"]
   s.homepage    = "http://github.com/amro/gibbon"
 
-  s.summary     = %q{A wrapper for MailChimp API 3.0}
-  s.description = %q{A wrapper for MailChimp API 3.0}
+  s.summary     = %q{A wrapper for MailChimp API 3.0 and Export API}
+  s.description = %q{A wrapper for MailChimp API 3.0 and Export API}
   s.license     = "MIT"
 
   s.rubyforge_project = "gibbon"

data/lib/gibbon.rb

@@ -3,10 +3,13 @@ require 'multi_json'
 require 'cgi'
 require 'logger'
 
+require 'gibbon/gibbon_helpers'
 require 'gibbon/gibbon_error'
 require 'gibbon/mailchimp_error'
 require 'gibbon/request'
 require 'gibbon/api_request'
+require 'gibbon/response'
+require 'gibbon/export'
 
 module Gibbon
 end

data/lib/gibbon/api_request.rb

@@ -1,5 +1,7 @@
 module Gibbon
   class APIRequest
+    include Helpers
+
     def initialize(builder: nil)
       @request_builder = builder
     end
@@ -11,7 +13,7 @@ module Gibbon
         response = self.rest_client.post do |request|
           configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
         end
-        parse_response(response.body)
+        parse_response(response)
       rescue => e
         handle_error(e)
       end
@@ -24,7 +26,7 @@ module Gibbon
         response = self.rest_client.patch do |request|
           configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
         end
-        parse_response(response.body)
+        parse_response(response)
       rescue => e
         handle_error(e)
       end
@@ -37,7 +39,7 @@ module Gibbon
         response = self.rest_client.put do |request|
           configure_request(request: request, params: params, headers: headers, body: MultiJson.dump(body))
         end
-        parse_response(response.body)
+        parse_response(response)
       rescue => e
         handle_error(e)
       end
@@ -50,7 +52,7 @@ module Gibbon
         response = self.rest_client.get do |request|
           configure_request(request: request, params: params, headers: headers)
         end
-        parse_response(response.body)
+        parse_response(response)
       rescue => e
         handle_error(e)
       end
@@ -63,7 +65,7 @@ module Gibbon
         response = self.rest_client.delete do |request|
           configure_request(request: request, params: params, headers: headers)
         end
-        parse_response(response.body)
+        parse_response(response)
       rescue => e
         handle_error(e)
       end
@@ -115,8 +117,12 @@ module Gibbon
 
           if parsed_response
             error_params[:body] = parsed_response
-            error_params[:title] = parsed_response["title"] if parsed_response["title"]
-            error_params[:detail] = parsed_response["detail"] if parsed_response["detail"]
+
+            title_key = symbolize_keys ? :title : "title"
+            detail_key = symbolize_keys ? :detail : "detail"
+
+            error_params[:title] = parsed_response[title_key] if parsed_response[title_key]
+            error_params[:detail] = parsed_response[detail_key] if parsed_response[detail_key]
           end
 
         end
@@ -140,7 +146,7 @@ module Gibbon
     end
 
     def rest_client
-      client = Faraday.new(self.api_url, proxy: self.proxy) do |faraday|
+      client = Faraday.new(self.api_url, proxy: self.proxy, ssl: { version: "TLSv1_2" }) do |faraday|
         faraday.response :raise_error
         faraday.adapter adapter
         if @request_builder.debug
@@ -151,16 +157,17 @@ module Gibbon
       client
     end
 
-    def parse_response(response_body)
+    def parse_response(response)
       parsed_response = nil
 
-      if response_body && !response_body.empty?
+      if response.body && !response.body.empty?
         begin
-          parsed_response = MultiJson.load(response_body, symbolize_keys: symbolize_keys)
+          headers = response.headers
+          body = MultiJson.load(response.body, symbolize_keys: symbolize_keys)
+          parsed_response = Response.new(headers: headers, body: body)
         rescue MultiJson::ParseError
-          error = MailChimpError.new("Unparseable response: #{response_body}")
-          error.title = "UNPARSEABLE_RESPONSE"
-          error.status_code = 500
+          error_params = { title: "UNPARSEABLE_RESPONSE", status_code: 500 }
+          error = MailChimpError.new("Unparseable response: #{response.body}", error_params)
           raise error
         end
       end
@@ -180,20 +187,8 @@ module Gibbon
     end
 
     def base_api_url
-      computed_api_endpoint = "https://#{get_data_center_from_api_key}api.mailchimp.com"
+      computed_api_endpoint = "https://#{get_data_center_from_api_key(self.api_key)}api.mailchimp.com"
       "#{self.api_endpoint || computed_api_endpoint}/3.0/"
     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 self.api_key && self.api_key["-"]
-        # Add a period since the data_center is a subdomain and it keeps things dry
-        data_center = "#{self.api_key.split('-').last}."
-      end
-
-      data_center
-    end
   end
 end

data/lib/gibbon/export.rb

@@ -0,0 +1,93 @@
+require 'net/https'
+
+module Gibbon
+  class Export
+    include Helpers
+
+    attr_accessor :api_key, :timeout
+
+    def initialize(api_key: nil, timeout: nil)
+      @api_key = api_key || self.class.api_key
+      @timeout = timeout || self.class.timeout || 600
+    end
+
+    def list(params = {}, &block)
+      call("list", params, &block)
+    end
+
+    def ecomm_orders(params = {}, &block)
+      call("ecommOrders", params, &block)
+    end
+
+    def campaign_subscriber_activity(params = {}, &block)
+      call("campaignSubscriberActivity", params, &block)
+    end
+
+    protected
+
+    def export_api_url
+      "https://#{get_data_center_from_api_key(@api_key)}api.mailchimp.com/export/1.0/"
+    end
+
+    def call(method, params = {}, &block)
+      rows = []
+
+      api_url = export_api_url + method + "/"
+      params = params.merge({ apikey: @api_key })
+      block = Proc.new { |row| rows << row } unless block_given?
+
+      ensure_api_key(params)
+
+      url = URI.parse(api_url)
+      req = Net::HTTP::Post.new(url.path, initheader = {'Content-Type' => 'application/json'})
+      req.body = MultiJson.dump(params)
+      Net::HTTP.start(url.host, url.port, read_timeout: @timeout, use_ssl: true, ssl_version: :TLSv1_2) do |http|
+        # http://stackoverflow.com/questions/29598196/ruby-net-http-read-body-nethttpokread-body-called-twice-ioerror
+        http.request req do |response|
+          i = -1
+          last = ''
+          response.read_body do |chunk|
+            next if chunk.nil? or chunk.strip.empty?
+            infix = "\n" if last[-1, 1]==']'
+            lines, last = try_parse_line("#{last}#{infix}#{chunk}")
+            lines.each { |line| block.call(line, i += 1) }
+          end
+          block.call(parse_line(last), i += 1) unless last.nil? or last.empty?
+        end
+      end
+      rows unless block_given?
+    end
+
+    def try_parse_line(res)
+      lines = res.split("\n")
+      last = lines.pop || ''
+      lines.map! { |line| parse_line(line) }
+      [lines.compact, last]
+    rescue MultiJson::ParseError
+      [[], last]
+    end
+     
+     
+    def parse_line(line)
+      parsed_response = MultiJson.load(line)
+    rescue MultiJson::ParseError
+      return []
+    end
+
+    private
+
+    def ensure_api_key(params)
+      unless params[:apikey] && (get_data_center_from_api_key(params[:apikey]) != "")
+        raise Gibbon::GibbonError, "You must set an api_key prior to making a call"
+      end
+    end
+
+    class << self
+      attr_accessor :api_key, :timeout
+
+      def method_missing(sym, *args, &block)
+        new(api_key: self.api_key, timeout: self.timeout).send(sym, *args, &block)
+      end
+    end
+  end
+end

data/lib/gibbon/gibbon_helpers.rb

@@ -0,0 +1,15 @@
+module Gibbon
+  module Helpers
+    def get_data_center_from_api_key(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/request.rb

@@ -14,9 +14,9 @@ module Gibbon
       @open_timeout = open_timeout || self.class.open_timeout || DEFAULT_OPEN_TIMEOUT
       @proxy = proxy || self.class.proxy || ENV['MAILCHIMP_PROXY']
       @faraday_adapter = faraday_adapter || Faraday.default_adapter
-      @symbolize_keys = symbolize_keys
+      @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
+      @debug = debug || self.class.debug || false
       @logger = logger || self.class.logger || ::Logger.new(STDOUT)
-      @debug = debug
     end
 
     def method_missing(method, *args)
@@ -27,6 +27,10 @@ module Gibbon
       self
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+
     def send(*args)
       if args.length == 0
         method_missing(:send, args)
@@ -76,10 +80,14 @@ module Gibbon
     end
 
     class << self
-      attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :logger
+      attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
 
       def method_missing(sym, *args, &block)
-        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
+        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
       end
     end
   end

data/lib/gibbon/response.rb

@@ -0,0 +1,10 @@
+module Gibbon
+  class Response
+    attr_accessor :body, :headers
+    
+    def initialize(body: {}, headers: {})
+      @body = body
+      @headers = headers
+    end 
+  end
+end

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "2.2.5"
+  VERSION = "3.2.0"
 end

data/spec/gibbon/api_request_spec.rb

@@ -42,5 +42,19 @@ describe Gibbon::APIRequest do
         expect(boom.raw_body).to eq "A non JSON response"
       end
     end
+
+    context "when symbolize_keys is true" do
+      it "sets title and detail on the error params" do
+        response_values = {:status => 422, :headers => {}, :body => '{"title": "foo", "detail": "bar"}'}
+        exception = Faraday::Error::ClientError.new("the server responded with status 422", response_values)
+        api_request = Gibbon::APIRequest.new(builder: Gibbon::Request.new(symbolize_keys: true))
+        begin
+          api_request.send :handle_error, exception
+        rescue => boom
+          expect(boom.title).to eq "foo"
+          expect(boom.detail).to eq "bar"
+        end
+      end
+    end
   end
 end

data/spec/gibbon/export_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+describe Gibbon::Export do
+  before do
+    Gibbon::Export.send(:public, *Gibbon::Export.protected_instance_methods)
+    @export = Gibbon::Export.new
+  end
+
+  it "doesn't allow empty api key" do
+    expect {@export.list(id: "123456")}.to raise_error(Gibbon::GibbonError)
+  end
+
+  it "doesn't allow api key without data center" do
+    @api_key = "123"
+    @export.api_key = @api_key
+    expect {@export.list(id: "123456")}.to raise_error(Gibbon::GibbonError)
+  end
+
+  it "sets correct endpoint from api key" do
+    @api_key = "TESTKEY-us1"
+    @export.api_key = @api_key
+    expect(@export.export_api_url).to eq("https://us1.api.mailchimp.com/export/1.0/")
+  end
+
+  it "sets correct timeout" do
+    @api_key = "TESTKEY-us1"
+    @export.api_key = @api_key
+    @export.timeout = 9
+    expect(@export.timeout).to eq(9)
+  end
+end

data/spec/gibbon/gibbon_spec.rb

@@ -102,6 +102,10 @@ describe Gibbon do
       expect(@gibbon.symbolize_keys).to be true
     end
 
+    it "sets symbolize_keys in the constructor" do
+      @gibbon = Gibbon::Request.new(symbolize_keys: true)
+      expect(@gibbon.symbolize_keys).to be true
+    end
     it "debug false by default" do
       @gibbon = Gibbon::Request.new
       expect(@gibbon.debug).to be false
@@ -123,7 +127,6 @@ describe Gibbon do
       expect(@gibbon.logger).to be_a Logger
     end
 
-
   end
 
   describe "build api url" do
@@ -131,7 +134,6 @@ describe Gibbon do
       Gibbon::APIRequest.send(:public, *Gibbon::APIRequest.protected_instance_methods)
 
       @gibbon = Gibbon::Request.new
-      @url = "https://api.mailchimp.com/3.0/lists/"
     end
 
     it "doesn't allow empty api key" do
@@ -170,6 +172,10 @@ describe Gibbon do
       Gibbon::Request.timeout = 15
       Gibbon::Request.api_endpoint = 'https://us6.api.mailchimp.com'
       Gibbon::Request.logger = logger
+      Gibbon::Request.proxy = "http://1234.com"
+      Gibbon::Request.symbolize_keys = true
+      Gibbon::Request.faraday_adapter = :net_http
+      Gibbon::Request.debug = true
     end
 
     after do
@@ -177,6 +183,10 @@ describe Gibbon do
       Gibbon::Request.timeout = nil
       Gibbon::Request.api_endpoint = nil
       Gibbon::Request.logger = nil
+      Gibbon::Request.proxy = nil
+      Gibbon::Request.symbolize_keys = nil
+      Gibbon::Request.faraday_adapter = nil
+      Gibbon::Request.debug = nil
     end
 
     it "set api key on new instances" do
@@ -192,8 +202,33 @@ describe Gibbon do
       expect(Gibbon::Request.new.api_endpoint).to eq(Gibbon::Request.api_endpoint)
     end
 
+    it "set proxy on new instances" do
+      expect(Gibbon::Request.new.proxy).to eq(Gibbon::Request.proxy)
+    end
+
+    it "set symbolize_keys on new instances" do
+      expect(Gibbon::Request.new.symbolize_keys).to eq(Gibbon::Request.symbolize_keys)
+    end
+
+    it "set debug on new instances" do
+      expect(Gibbon::Request.new.debug).to eq(Gibbon::Request.debug)
+    end
+    
+    it "set faraday_adapter on new instances" do
+      expect(Gibbon::Request.new.faraday_adapter).to eq(Gibbon::Request.faraday_adapter)
+    end
+
     it "set logger on new instances" do
       expect(Gibbon::Request.new.logger).to eq(logger)
     end
   end
+
+  describe "missing methods" do
+    it "respond to .method call on class" do
+      expect(Gibbon::Request.method(:lists)).to be_a(Method)
+    end
+    it "respond to .method call on instance" do
+      expect(Gibbon::Request.new.method(:lists)).to be_a(Method)
+    end
+  end
 end

data/spec/gibbon/mailchimp_error_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Gibbon::MailChimpError do
+  let(:message) { 'Foo' }
+  let(:params) do
+    {
+      title: 'error_title',
+      detail: 'error_detail',
+      body: 'error_body',
+      raw_body: 'error_raw_body',
+      status_code: 'error_status_code'
+    }
+  end
+
+  before do
+    @gibbon = Gibbon::MailChimpError.new(message, params)
+  end
+
+  it "adds the error params to the error message" do
+    expected_message = "Foo "                               \
+                       "@title=\"error_title\", "           \
+                       "@detail=\"error_detail\", "         \
+                       "@body=\"error_body\", "             \
+                       "@raw_body=\"error_raw_body\", "     \
+                       "@status_code=\"error_status_code\""
+
+    expect(@gibbon.message).to eq(expected_message)
+  end
+
+  it 'sets the title attribute' do
+    expect(@gibbon.title).to eq(params[:title])
+  end
+
+  it 'sets the detail attribute' do
+    expect(@gibbon.detail).to eq(params[:detail])
+  end
+
+  it 'sets the body attribute' do
+    expect(@gibbon.body).to eq(params[:body])
+  end
+
+  it 'sets the raw_body attribute' do
+    expect(@gibbon.raw_body).to eq(params[:raw_body])
+  end
+
+  it 'sets the status_code attribute' do
+    expect(@gibbon.status_code).to eq(params[:status_code])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 3.2.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.21.0
-description: A wrapper for MailChimp API 3.0
+description: A wrapper for MailChimp API 3.0 and Export API
 email:
 - amromousa@gmail.com
 executables: []
@@ -98,12 +98,17 @@ files:
 - gibbon.gemspec
 - lib/gibbon.rb
 - lib/gibbon/api_request.rb
+- lib/gibbon/export.rb
 - lib/gibbon/gibbon_error.rb
+- lib/gibbon/gibbon_helpers.rb
 - lib/gibbon/mailchimp_error.rb
 - lib/gibbon/request.rb
+- lib/gibbon/response.rb
 - lib/gibbon/version.rb
 - spec/gibbon/api_request_spec.rb
+- spec/gibbon/export_spec.rb
 - spec/gibbon/gibbon_spec.rb
+- spec/gibbon/mailchimp_error_spec.rb
 - spec/gibbon/upsert_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/amro/gibbon
@@ -129,9 +134,11 @@ rubyforge_project: gibbon
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: A wrapper for MailChimp API 3.0
+summary: A wrapper for MailChimp API 3.0 and Export API
 test_files:
 - spec/gibbon/api_request_spec.rb
+- spec/gibbon/export_spec.rb
 - spec/gibbon/gibbon_spec.rb
+- spec/gibbon/mailchimp_error_spec.rb
 - spec/gibbon/upsert_spec.rb
 - spec/spec_helper.rb