gibbon 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b314077a25462ff39bc051da9964e8d059e8adc9
-  data.tar.gz: 6da6d33d428f4dca0f45cff51a1e05912470c17c
+  metadata.gz: 50f6e393e4d3bca4e56673db5f615de6f45008d4
+  data.tar.gz: 36eb3eee9d7a618fd29a4d5de4d0f8facd3a7563
 SHA512:
-  metadata.gz: 684701c680aa61b443a25c550cf3a8e2df935d1cd35ffd25137cd3114fca3eca28f1611bc90a96933f81110f9d65688f546f79896783e0a545729222f7329770
-  data.tar.gz: 4aff56999fb044b547e7647e1adb75d9c3b5eca995d1844ea144c72aafede155a53692b98feb85752e0c168efc40a1962ed8c3d5190d1c7b135e1faaa0213644
+  metadata.gz: 97c4755405474f78cb0674f4caf23389786d22aafa351b7ba2fc08e4666ada7f33c6fa8709d071ee2d83b451a5b6426748993593f40a7705c2a63abb8fc7c1f9
+  data.tar.gz: e426ee592429a2fe4c919ed11f2ecbdef11fcb5017fd721712a4c5beff67cd3e7a59fac98de95c085be1a700a994cb8973222c8b03b5bade6b4cbaccb9f29fbe

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased][unreleased]
 
+## [2.2.4] - 2016-05-21
+- Add debug logging
+
 ## [2.2.3] - 2016-03-16
 - Capture status code and raw body when response is not json.
 

data/Gemfile

@@ -6,7 +6,7 @@ platforms :rbx do
 end
 
 group :development, :test do
-  gem 'webmock'
+  gem 'webmock', '~>1.24.0'
 end
 
 gemspec

data/README.markdown

@@ -66,8 +66,17 @@ You can also set the environment variable `MAILCHIMP_API_KEY` and Gibbon will us
 gibbon = Gibbon::Request.new
 ```
 
-MailChimp's [resource documentation](http://kb.mailchimp.com/api/resources) is a list of available resources. Substitute an underscore if
-a resource name contains a hyphen.
+***Note*** Substitute an underscore if a resource name contains a hyphen.
+
+MailChimp's [resource documentation](http://kb.mailchimp.com/api/resources) is a list of available resources.
+
+##Debug Logging
+
+Pass `debug: true` to enable debug logging to STDOUT.
+
+```ruby
+gibbon = Gibbon::Request.new(api_key: "your_api_key", debug: true)
+```
 
 ## Examples
 
@@ -111,6 +120,12 @@ And to retrieve the next 50 members:
 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"})
+```
+
 Subscribe a member to a list:
 
 ```ruby
@@ -129,6 +144,48 @@ You can also unsubscribe a member from a list:
 gibbon.lists(list_id).members(lower_case_md5_hashed_email_address).update(body: { status: "unsubscribed" })
 ```
 
+### 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.
+
+```ruby
+# Create a new batch job that will create new list members
+gibbon.batches.create(body: {
+  operations: [
+    {
+      method: "POST",
+      path: "lists/#{ list_id }/members",
+      body: "{...}" # The JSON payload for PUT, POST, or PATCH
+    },
+    ...
+  ]
+})
+```
+
+This will create a new batch job and return a Batch response. The response will include an `id` attribute which can be used to check the status of a particular batch job.
+
+##### Checking on a Batch Job
+```ruby
+gibbon.batches(batch_id).retrieve
+```
+
+###### Response
+```ruby
+{
+  "id"=>"0ca62e43cc",
+  "status"=>"started",
+  "total_operations"=>1,
+  "finished_operations"=>1,
+  "errored_operations"=>0,
+  "submitted_at"=>"2016-04-19T01:16:58+00:00",
+  "completed_at"=>"",
+  "response_body_url"=>""
+}
+```
+
+**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
 
 Only retrieve ids and names for fetched lists:

data/lib/gibbon/api_request.rb

@@ -134,6 +134,9 @@ module Gibbon
       client = Faraday.new(self.api_url, proxy: self.proxy) do |faraday|
         faraday.response :raise_error
         faraday.adapter adapter
+        if @request_builder.debug
+          faraday.response :logger, ::Logger.new(STDOUT), bodies: true
+        end
       end
       client.basic_auth('apikey', self.api_key)
       client

data/lib/gibbon/request.rb

@@ -1,10 +1,10 @@
 module Gibbon
   class Request
-    attr_accessor :api_key, :api_endpoint, :timeout, :proxy, :faraday_adapter
+    attr_accessor :api_key, :api_endpoint, :timeout, :proxy, :faraday_adapter, :debug
 
     DEFAULT_TIMEOUT = 30
 
-    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, proxy: nil, faraday_adapter: nil)
+    def initialize(api_key: nil, api_endpoint: nil, timeout: nil, proxy: nil, faraday_adapter: nil, debug: false)
       @path_parts = []
       @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
       @api_key = @api_key.strip if @api_key
@@ -12,6 +12,7 @@ module Gibbon
       @timeout = timeout || self.class.timeout || DEFAULT_TIMEOUT
       @proxy = proxy || self.class.proxy || ENV['MAILCHIMP_PROXY']
       @faraday_adapter = faraday_adapter || Faraday.default_adapter
+      @debug = debug
     end
 
     def method_missing(method, *args)

data/lib/gibbon/version.rb

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

data/spec/gibbon/api_request_spec.rb

@@ -29,4 +29,18 @@ describe Gibbon::APIRequest do
     stub_request(:get, "#{@api_root}/lists").to_raise(exception)
     expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
   end
+
+  context "handle_error" 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
+      begin
+        api_request.send :handle_error, exception
+      rescue => boom
+        expect(boom.status_code).to eq 503
+        expect(boom.raw_body).to eq "A non JSON response"
+      end
+    end
+  end
 end

data/spec/gibbon/gibbon_spec.rb

@@ -76,6 +76,16 @@ describe Gibbon do
       @gibbon = Gibbon::Request.new(faraday_adapter: adapter)
       expect(@gibbon.faraday_adapter).to eq(adapter)
     end
+
+    it "debug false by default" do
+      @gibbon = Gibbon::Request.new
+      expect(@gibbon.debug).to be false
+    end
+
+    it "sets debug in the constructor" do
+      @gibbon = Gibbon::Request.new(debug: true)
+      expect(@gibbon.debug).to be true
+    end
   end
 
   describe "build api url" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.2.4
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday