gibbon 2.2.4 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50f6e393e4d3bca4e56673db5f615de6f45008d4
-  data.tar.gz: 36eb3eee9d7a618fd29a4d5de4d0f8facd3a7563
+  metadata.gz: 4264e8ea898f75f9239b7d03d6c5dcb1cadc915d
+  data.tar.gz: c5e810141d2a9767d6e754128cd2b7d395e62bd1
 SHA512:
-  metadata.gz: 97c4755405474f78cb0674f4caf23389786d22aafa351b7ba2fc08e4666ada7f33c6fa8709d071ee2d83b451a5b6426748993593f40a7705c2a63abb8fc7c1f9
-  data.tar.gz: e426ee592429a2fe4c919ed11f2ecbdef11fcb5017fd721712a4c5beff67cd3e7a59fac98de95c085be1a700a994cb8973222c8b03b5bade6b4cbaccb9f29fbe
+  metadata.gz: aefbdbd257c1483028840b02bfd1e8952e25f185cdea4cd14b4adc8f6dd928826312605f7d66d264f2856e5a376ecfb841e218488361ab63d400b34bbf9e3d0d
+  data.tar.gz: 4f789cb640563d3979b5b498852ea8b3552429b17a601eb6c1aab87f9d38c5650b7b55d09cac227fc47f232ea5d940ffdb5682c43c9a332ed642e5ab635d2892

data/.travis.yml

@@ -4,5 +4,5 @@ cache: bundler
 rvm:
   - 2.0.0
   - 2.1.5
-  - 2.2.0
-  - rbx-2
+  - 2.2.2
+  - 2.3.3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased][unreleased]
 
+## [2.2.5] - 2016-12-23
+- Adds open_timeout
+- Adds symbolize_keys
+- Change default timeout from 30 to 60 seconds
+
 ## [2.2.4] - 2016-05-21
 - Add debug logging
 

data/README.markdown

@@ -20,22 +20,27 @@ A MailChimp account and API key. You can see your API keys [here](http://admin.m
 
 ##Usage
 
-First, create an instance Gibbon::Request:
+First, create a *one-time use instance* of Gibbon::Request:
 
 ```ruby
 gibbon = Gibbon::Request.new(api_key: "your_api_key")
 ```
 
-You can set an individual request's timeout like this:
+***Note*** Only reuse instances of Gibbon after terminating a call with a verb, which makes a request. Requests are light weight objects that update an internal path based on your call chain. When you terminate a call chain with a verb, a request instance makes a request an resets the path.
+
+You can set an individual request's `timeout` and `open_timeout` like this:
 
 ```ruby
-gibbon.timeout = 10
+gibbon.timeout = 30
+gibbon.open_timeout = 30
 ```
 
+You can read about `timeout` and `open_timeout` in the [Net::HTTP](https://ruby-doc.org/stdlib-2.3.3/libdoc/net/http/rdoc/Net/HTTP.html) doc.
+
 Now you can make requests using the resources defined in [MailChimp's docs](http://kb.mailchimp.com/api/resources). Resource IDs
 are specified inline and a `CRUD` (`create`, `retrieve`, `update`, `upsert`, or `delete`) verb initiates the request. `upsert` lets you update a record, if it exists, or insert it otherwise where supported by MailChimp's API.
 
-*Please note that `upsert` requires Gibbon version 2.1.0 or newer!*
+***Note*** `upsert` requires Gibbon version 2.1.0 or newer!
 
 You can specify `headers`, `params`, and `body` when calling a `CRUD` method. For example:
 
@@ -45,11 +50,12 @@ 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` and `timeout` globally:
+You can set `api_key`, `timeout`, and `open_timeout` globally:
 
 ```ruby
 Gibbon::Request.api_key = "your_api_key"
 Gibbon::Request.timeout = 15
+Gibbon::Request.open_timeout = 15
 ```
 
 For example, you could set the values above in an `initializer` file in your `Rails` app (e.g. your\_app/config/initializers/gibbon.rb).
@@ -68,6 +74,12 @@ gibbon = Gibbon::Request.new
 
 ***Note*** Substitute an underscore if a resource name contains a hyphen.
 
+Pass `symbolize_keys: true` to use symbols (instead of strings) as hash keys in API responses.
+
+```ruby
+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
@@ -78,6 +90,20 @@ Pass `debug: true` to enable debug logging to STDOUT.
 gibbon = Gibbon::Request.new(api_key: "your_api_key", debug: true)
 ```
 
+### Custom logger
+
+Ruby `Logger.new` is used by default, but it can be overrided using:
+
+```ruby
+gibbon = Gibbon::Request.new(api_key: "your_api_key", debug: true, logger: MyLogger.new)
+```
+
+Logger can be also set by globally:
+
+```ruby
+Gibbon::Request.logger = MyLogger.new
+```
+
 ## Examples
 
 ### Lists
@@ -117,13 +143,13 @@ gibbon.lists(list_id).members.retrieve(params: {"count": "50"})
 And to retrieve the next 50 members:
 
 ```ruby
-gibbon.lists(list_id).members.retrieve(params: {"count": "50", "offset: "50"})
+gibbon.lists(list_id).members.retrieve(params: {"count": "50", "offset": "50"})
 ```
 
 And to retrieve only subscribed members
 
 ```ruby
-gibbon.lists(list_id).members.retrieve(params: {"count": "50", "offset: "50", "status": "subscribed"})
+gibbon.lists(list_id).members.retrieve(params: {"count": "50", "offset": "50", "status": "subscribed"})
 ```
 
 Subscribe a member to a list:
@@ -144,6 +170,12 @@ You can also unsubscribe a member from a list:
 gibbon.lists(list_id).members(lower_case_md5_hashed_email_address).update(body: { status: "unsubscribed" })
 ```
 
+Get a specific member's information (open/click rates etc.) from MailChimp:
+
+```ruby
+gibbon.lists(list_id).members(lower_case_md5_hashed_email_address).retrieve
+```
+
 ### Batch Operations
 
 Any API call that can be made directly can also be organized into batch operations. Performing batch operations requires you to generate a hash for each individual API call and pass them as an `Array` to the Batch endpoint.
@@ -183,7 +215,7 @@ gibbon.batches(batch_id).retrieve
 }
 ```
 
-**NOTE** This response truncated for brevity. Reference the MailChimp
+***Note*** This response truncated for brevity. Reference the MailChimp
 [API documentation for Batch Operations](http://developer.mailchimp.com/documentation/mailchimp/reference/batches/) for more details.
 
 ### Fields
@@ -266,6 +298,18 @@ Send a campaign:
 gibbon.campaigns(campaign_id).actions.send.create
 ```
 
+Schedule a campaign:
+
+```ruby
+body = {
+  schedule_time: "2016-06-27 20:00:00"
+}
+```
+
+```ruby
+gibbon.campaigns(campaign_id).actions.schedule.create(body: body)
+```
+
 ### Interests
 
 Interests are a little more complicated than other parts of the API, so here's an example of how you would set interests during at subscription time or update them later. The ID of the interests you want to opt in or out of must be known ahead of time so an example of how to find interest IDs is also included.
@@ -273,7 +317,7 @@ Interests are a little more complicated than other parts of the API, so here's a
 Subscribing a member to a list with specific interests up front:
 
 ```ruby
-g.lists(list_id).members.create(body: {email_address: user_email_address, status: "subscribed", interests: {some_interest_id: true, another_interest_id: true}})
+gibbon.lists(list_id).members.create(body: {email_address: user_email_address, status: "subscribed", interests: {some_interest_id: true, another_interest_id: true}})
 ```
 
 Updating a list member's interests:
@@ -285,7 +329,7 @@ gibbon.lists(list_id).members(member_id).update(body: {interests: {some_interest
 So how do we get the interest IDs? When you query the API for a specific list member's information:
 
 ```ruby
-g.lists(list_id).members(member_id).retrieve
+gibbon.lists(list_id).members(member_id).retrieve
 ```
 
 The response looks someting like this (unrelated things removed):
@@ -297,7 +341,7 @@ The response looks someting like this (unrelated things removed):
 The API returns a map of interest ID to boolean value. Now we to get interest details so we know what these interest IDs map to. Looking at [this doc page](http://kb.mailchimp.com/api/resources/lists/interest-categories/interests/lists-interests-collection), we need to do this:
 
 ```ruby
-g.lists(list_id).interest_categories.retrieve
+gibbon.lists(list_id).interest_categories.retrieve
 ```
 
 To get a list of interest categories. That gives us something like:
@@ -309,7 +353,7 @@ To get a list of interest categories. That gives us something like:
 In this case, we're interested in the ID of the "Food Preferences" interest, which is `0ace7aa498`. Now we can fetch the details for this interest group:
 
 ```ruby
-g.lists(list_id).interest_categories("0ace7aa498").interests.retrieve
+gibbon.lists(list_id).interest_categories("0ace7aa498").interests.retrieve
 ```
 
 That response gives the interest data, including the ID for the interests themselves, which we can use to update a list member's interests or set them when we call the API to subscribe her or him to a list.
@@ -323,7 +367,7 @@ available depending on the nature of the error. For example:
 
 ```ruby
 begin
-  gibbon.lists(list_id)members.create(body: body)
+  gibbon.lists(list_id).members.create(body: body)
 rescue Gibbon::MailChimpError => e
   puts "Houston, we have a problem: #{e.message} - #{e.raw_body}"
 end

data/gibbon.gemspec

@@ -13,8 +13,6 @@ Gem::Specification.new do |s|
   s.description = %q{A wrapper for MailChimp API 3.0}
   s.license     = "MIT"
 
-  s.post_install_message = "IMPORTANT: Gibbon now targets MailChimp API 3.0, which is very different from API 2.0. Use Gibbon 1.x if you need to target API 2.0."
-
   s.rubyforge_project = "gibbon"
 
   s.files         = `git ls-files`.split("\n")
@@ -27,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency('multi_json', '>= 1.11.0')
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency "rspec", "3.2.0"
+  s.add_development_dependency "rspec", "3.5.0"
   s.add_development_dependency 'webmock', '~> 1.21.0'
 
 end

data/lib/gibbon.rb

@@ -1,6 +1,7 @@
 require 'faraday'
 require 'multi_json'
 require 'cgi'
+require 'logger'
 
 require 'gibbon/gibbon_error'
 require 'gibbon/mailchimp_error'

data/lib/gibbon/api_request.rb

@@ -85,6 +85,10 @@ module Gibbon
       @request_builder.timeout
     end
 
+    def open_timeout
+      @request_builder.open_timeout
+    end
+
     def proxy
       @request_builder.proxy
     end
@@ -93,6 +97,10 @@ module Gibbon
       @request_builder.faraday_adapter
     end
 
+    def symbolize_keys
+      @request_builder.symbolize_keys
+    end
+
     # Helpers
 
     def handle_error(error)
@@ -102,8 +110,8 @@ module Gibbon
         if error.is_a?(Faraday::Error::ClientError) && error.response
           error_params[:status_code] = error.response[:status]
           error_params[:raw_body] = error.response[:body]
-          
-          parsed_response = MultiJson.load(error.response[:body])
+
+          parsed_response = MultiJson.load(error.response[:body], symbolize_keys: symbolize_keys)
 
           if parsed_response
             error_params[:body] = parsed_response
@@ -127,6 +135,7 @@ module Gibbon
         request.headers.merge!(headers) if headers
         request.body = body if body
         request.options.timeout = self.timeout
+        request.options.open_timeout = self.open_timeout
       end
     end
 
@@ -135,7 +144,7 @@ module Gibbon
         faraday.response :raise_error
         faraday.adapter adapter
         if @request_builder.debug
-          faraday.response :logger, ::Logger.new(STDOUT), bodies: true
+          faraday.response :logger, @request_builder.logger, bodies: true
         end
       end
       client.basic_auth('apikey', self.api_key)
@@ -147,7 +156,7 @@ module Gibbon
 
       if response_body && !response_body.empty?
         begin
-          parsed_response = MultiJson.load(response_body)
+          parsed_response = MultiJson.load(response_body, symbolize_keys: symbolize_keys)
         rescue MultiJson::ParseError
           error = MailChimpError.new("Unparseable response: #{response_body}")
           error.title = "UNPARSEABLE_RESPONSE"

data/lib/gibbon/request.rb

@@ -1,17 +1,21 @@
 module Gibbon
   class Request
-    attr_accessor :api_key, :api_endpoint, :timeout, :proxy, :faraday_adapter, :debug
+    attr_accessor :api_key, :api_endpoint, :timeout, :open_timeout, :proxy, :faraday_adapter, :symbolize_keys, :debug, :logger
 
-    DEFAULT_TIMEOUT = 30
+    DEFAULT_TIMEOUT = 60
+    DEFAULT_OPEN_TIMEOUT = 60
 
-    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, proxy: nil, faraday_adapter: nil, debug: false)
+    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, open_timeout: nil, proxy: nil, faraday_adapter: nil, symbolize_keys: false, debug: false, logger: nil)
       @path_parts = []
       @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
       @api_key = @api_key.strip if @api_key
       @api_endpoint = api_endpoint || self.class.api_endpoint
       @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
+      @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
+      @logger = logger || self.class.logger || ::Logger.new(STDOUT)
       @debug = debug
     end
 
@@ -72,10 +76,10 @@ module Gibbon
     end
 
     class << self
-      attr_accessor :api_key, :timeout, :api_endpoint, :proxy
+      attr_accessor :api_key, :timeout, :open_timeout, :api_endpoint, :proxy, :logger
 
       def method_missing(sym, *args, &block)
-        new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, proxy: self.proxy).send(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)
       end
     end
   end

data/lib/gibbon/version.rb

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

data/spec/gibbon/api_request_spec.rb

@@ -34,7 +34,7 @@ describe Gibbon::APIRequest do
     it "includes status and raw body even when json can't be parsed" do
       response_values = {:status => 503, :headers => {}, :body => 'A non JSON response'}
       exception = Faraday::Error::ClientError.new("the server responded with status 503", response_values)
-      api_request = Gibbon::APIRequest.new
+      api_request = Gibbon::APIRequest.new(builder: Gibbon::Request)
       begin
         api_request.send :handle_error, exception
       rescue => boom

data/spec/gibbon/gibbon_spec.rb

@@ -39,6 +39,13 @@ describe Gibbon do
       expect(timeout).to eq(@gibbon.timeout)
     end
 
+    it "sets the open_timeout and get" do
+      @gibbon = Gibbon::Request.new
+      open_timeout = 30
+      @gibbon.open_timeout = open_timeout
+      expect(open_timeout).to eq(@gibbon.open_timeout)
+    end
+
     it "timeout properly passed to APIRequest" do
       @gibbon = Gibbon::Request.new
       timeout = 30
@@ -47,6 +54,14 @@ describe Gibbon do
       expect(timeout).to eq(@request.timeout)
     end
 
+    it "timeout properly based on open_timeout passed to APIRequest" do
+      @gibbon = Gibbon::Request.new
+      open_timeout = 30
+      @gibbon.open_timeout = open_timeout
+      @request = Gibbon::APIRequest.new(builder: @gibbon)
+      expect(open_timeout).to eq(@request.open_timeout)
+    end
+
     it "detect api endpoint from initializer parameters" do
       api_endpoint = 'https://us6.api.mailchimp.com'
       @gibbon = Gibbon::Request.new(api_key: @api_key, api_endpoint: api_endpoint)
@@ -77,6 +92,16 @@ describe Gibbon do
       expect(@gibbon.faraday_adapter).to eq(adapter)
     end
 
+    it "symbolize_keys false by default" do
+      @gibbon = Gibbon::Request.new
+      expect(@gibbon.symbolize_keys).to be false
+    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
@@ -86,6 +111,19 @@ describe Gibbon do
       @gibbon = Gibbon::Request.new(debug: true)
       expect(@gibbon.debug).to be true
     end
+
+    it "sets logger in constructor" do
+      logger = double(:logger)
+      @gibbon = Gibbon::Request.new(logger: logger)
+      expect(@gibbon.logger).to eq(logger)
+    end
+
+    it "is a Logger instance by default" do
+      @gibbon = Gibbon::Request.new
+      expect(@gibbon.logger).to be_a Logger
+    end
+
+
   end
 
   describe "build api url" do
@@ -125,16 +163,20 @@ describe Gibbon do
   end
 
   describe "class variables" do
+    let(:logger) { double(:logger) }
+
     before do
       Gibbon::Request.api_key = "123-us1"
       Gibbon::Request.timeout = 15
       Gibbon::Request.api_endpoint = 'https://us6.api.mailchimp.com'
+      Gibbon::Request.logger = logger
     end
 
     after do
       Gibbon::Request.api_key = nil
       Gibbon::Request.timeout = nil
       Gibbon::Request.api_endpoint = nil
+      Gibbon::Request.logger = nil
     end
 
     it "set api key on new instances" do
@@ -149,5 +191,9 @@ describe Gibbon do
       expect(Gibbon::Request.api_endpoint).not_to be_nil
       expect(Gibbon::Request.new.api_endpoint).to eq(Gibbon::Request.api_endpoint)
     end
+
+    it "set logger on new instances" do
+      expect(Gibbon::Request.new.logger).to eq(logger)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.2.5
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-22 00:00:00.000000000 Z
+date: 2016-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -110,8 +110,7 @@ homepage: http://github.com/amro/gibbon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 'IMPORTANT: Gibbon now targets MailChimp API 3.0, which is very
-  different from API 2.0. Use Gibbon 1.x if you need to target API 2.0.'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib