gibbon 2.2.5 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4264e8ea898f75f9239b7d03d6c5dcb1cadc915d
-  data.tar.gz: c5e810141d2a9767d6e754128cd2b7d395e62bd1
+  metadata.gz: 3cadf43e229868a253bae8af2b7e609db5ffd11b
+  data.tar.gz: 95049f9c9ce5f1d3b9cde18f4650d5be52b13947
 SHA512:
-  metadata.gz: aefbdbd257c1483028840b02bfd1e8952e25f185cdea4cd14b4adc8f6dd928826312605f7d66d264f2856e5a376ecfb841e218488361ab63d400b34bbf9e3d0d
-  data.tar.gz: 4f789cb640563d3979b5b498852ea8b3552429b17a601eb6c1aab87f9d38c5650b7b55d09cac227fc47f232ea5d940ffdb5682c43c9a332ed642e5ab635d2892
+  metadata.gz: 58ab02cdd0ebd1cff4c0211b3a6674484db6a50b52aa34dc7efc746e1c75792dca7a4dedd58e8efc7e38fef73fc285f4859c809bba1f1b5cf1d674bc89cca436
+  data.tar.gz: 15459d6835355d637505ffc34c3aecbac0a6232a271d1481952c60028f30bd7264c35bd5e922d12ec12717b36a83df59046c808f43b02c19dda60d9f60f2f33f

data/CHANGELOG.md

@@ -1,8 +1,20 @@
 ## [Unreleased][unreleased]
 
+## [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 +66,21 @@
 ## [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.0.1...HEAD
+[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/README.markdown

@@ -6,10 +6,10 @@ Gibbon is an API wrapper for MailChimp's [API](http://kb.mailchimp.com/api/).
 [![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.
-
 Please read MailChimp's [Getting Started Guide](http://kb.mailchimp.com/api/article/api-3-overview).
 
+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
@@ -20,7 +20,7 @@ A MailChimp account and API key. You can see your API keys [here](http://admin.m
 
 ##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 +50,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).
@@ -201,7 +203,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 +334,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 +346,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 +398,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 +408,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 +424,7 @@ Gibbon 1.x:
 gibbon.lists.list
 ```
 
-Gibbon 2.x:
+Gibbon 2.x+:
 
 ```ruby
 gibbon.lists.retrieve
@@ -436,7 +438,7 @@ Gibbon 1.x:
 gibbon.lists.members({:id => list_id})
 ```
 
-Gibbon 2.x:
+Gibbon 2.x+:
 
 ```ruby
 gibbon.lists(list_id).members.retrieve
@@ -450,7 +452,7 @@ 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"}})
@@ -462,5 +464,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/lib/gibbon.rb

@@ -3,10 +3,12 @@ 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'
 
 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
@@ -100,7 +102,7 @@ module Gibbon
     def symbolize_keys
       @request_builder.symbolize_keys
     end
-
+    
     # Helpers
 
     def handle_error(error)
@@ -151,14 +153,16 @@ 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 = MailChimpError.new("Unparseable response: #{response.body}")
           error.title = "UNPARSEABLE_RESPONSE"
           error.status_code = 500
           raise error
@@ -180,20 +184,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/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)
@@ -76,10 +76,10 @@ 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
     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.0.1"
 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,6 +202,22 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 3.0.1
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-24 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -99,8 +99,10 @@ files:
 - lib/gibbon.rb
 - lib/gibbon/api_request.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/gibbon_spec.rb