gibbon 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 12a6fecb32704fd28e939c71d68d04b002daa26b
-  data.tar.gz: b203c08f25fab5920c4714448709cf16c1297a74
+SHA256:
+  metadata.gz: 9948496f6f0ccccd5c2796b5d6ad2e1c656e3fd4db624bbb36a24e81d9161be7
+  data.tar.gz: 16ae83c4ec4af77425a9534b0c8c037fde234e694f21e77aa3572cad035867b4
 SHA512:
-  metadata.gz: 049a905ad6d6ccb68ed25d76e3192ab38e2342405c57aa89070817e79ad64a3d0d635129821b44cc69da778381134f9cada53480644defc8350c9da065851fc2
-  data.tar.gz: 15b2cc277b73e3e9b6af78045061d16924cdf677547e82e96ec5c04f37a966f359bbb8e1b589d12f6493e82c5d02b3884dac82328ee92560fab6487d4cf3ce26
+  metadata.gz: 6e68e1c2b1e77f738e48a6a7256fb35c0904ae1d7f487daaeccd9b65cfc98ab57d3244f5f3fa1e699cd424fbaf36561ae83d3891f02029317595831c031c65d0
+  data.tar.gz: 443c2f49c096106061887b29d052d05064a23b508740da354aea4f49bbed3201366c9a548155da051664906fc40b39e4bf9611571707db82bcb542859e7402c2

data/.travis.yml

@@ -4,7 +4,8 @@ cache: bundler
 before_install:
   - gem install bundler # -v 1.7.14 if a specific version is needed
 rvm:
-  - 2.0.0
   - 2.1.5
   - 2.2.2
-  - 2.3.3
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased][unreleased]
 
+## [3.2.1] - 2019-10-02
+- Fixed compatibility with Faraday 0.16.2+
+- Set minimum Ruby to 2.3.8
+
+## [3.2.1] - 2017-11-08
+- Set minimum Ruby to 2.1
+
 ## [3.2.0] - 2017-11-08
 - Force TLS version 1.2
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at amromousa@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/README.markdown

@@ -3,7 +3,6 @@
 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
 
@@ -27,7 +26,7 @@ First, create a *one-time use instance* of `Gibbon::Request`:
 gibbon = Gibbon::Request.new(api_key: "your_api_key")
 ```
 
-***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.
+***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 and resets the path.
 
 You can set an individual request's `timeout` and `open_timeout` like this:
 
@@ -111,7 +110,7 @@ Gibbon::Request.logger = MyLogger.new
 
 ### Lists
 
-Fetch all lists:
+Fetch first page of lists:
 
 ```ruby
 gibbon.lists.retrieve
@@ -131,7 +130,7 @@ gibbon.lists(list_id).members.retrieve
 
 ### Subscribers
 
-Get all subscribers for a list:
+Get first page of subscribers for a list:
 
 ```ruby
 gibbon.lists(list_id).members.retrieve
@@ -179,6 +178,21 @@ Get a specific member's information (open/click rates etc.) from MailChimp:
 gibbon.lists(list_id).members(lower_case_md5_hashed_email_address).retrieve
 ```
 
+### Tags
+
+[Tags](https://mailchimp.com/help/getting-started-tags/) are a flexible way to organize (slice and dice) your list: for example, you can send a campaign directly to one or more tags.
+
+Add tags to a subscriber:
+
+```ruby
+gibbon.lists(list_id).members(Digest::MD5.hexdigest(email)).tags.create(
+  body: {
+    tags: [{name:"referred-from-xyz", status:"active"},{name:"pro-plan",status:"active"}]
+  }
+)
+```
+
+
 ### 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.
@@ -237,7 +251,7 @@ gibbon.lists(list_id).members.retrieve(params: {"fields": "members.email_address
 
 ### Campaigns
 
-Get all campaigns:
+Get first page of campaigns:
 
 ```ruby
 campaigns = gibbon.campaigns.retrieve
@@ -477,7 +491,7 @@ This fetches and returns all of the results at once. Pass a block if you'd like
 
 ```ruby
 export = Gibbon::Export.new(api_key: "your_api_key", timeout: 1200)
-export.list(id: list_id) do |row| 
+export.list(id: list_id) do |row|
   puts row
 end
 ```
@@ -492,5 +506,5 @@ Thanks to everyone who has [contributed](https://github.com/amro/gibbon/contribu
 
 ## Copyright
 
-* Copyright (c) 2010-2017 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2017 The Rocket Science Group.
+* Copyright (c) 2010-2018 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2018 The Rocket Science Group.

data/gibbon.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.3.8'
 
   s.add_dependency('faraday', '>= 0.9.1')
   s.add_dependency('multi_json', '>= 1.11.0')

data/lib/gibbon/api_request.rb

@@ -109,7 +109,10 @@ module Gibbon
       error_params = {}
 
       begin
-        if error.is_a?(Faraday::Error::ClientError) && error.response
+        # Faraday::ClientError is used in Faraday 0.16.0+
+        # Faraday::Error::ClientError was used before 0.16.0
+        client_error = error.is_a?(Faraday::ClientError) || error.is_a?(Faraday::Error::ClientError)
+        if client_error && error.response
           error_params[:status_code] = error.response[:status]
           error_params[:raw_body] = error.response[:body]
 

data/lib/gibbon/version.rb

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

data/spec/gibbon/api_request_spec.rb

@@ -9,52 +9,66 @@ describe Gibbon::APIRequest do
     @api_root = "https://apikey:#{api_key}@us1.api.mailchimp.com/3.0"
   end
 
-  it "surfaces client request exceptions as a Gibbon::MailChimpError" do
-    exception = Faraday::Error::ClientError.new("the server responded with status 503")
-    stub_request(:get, "#{@api_root}/lists").to_raise(exception)
-    expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
-  end
-
-  it "surfaces an unparseable client request exception as a Gibbon::MailChimpError" do
-    exception = Faraday::Error::ClientError.new(
-      "the server responded with status 503")
-    stub_request(:get, "#{@api_root}/lists").to_raise(exception)
-    expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
-  end
+  shared_examples_for 'client error handling' do
+    it "surfaces client request exceptions as a Gibbon::MailChimpError" do
+      exception = error_class.new("the server responded with status 503")
+      stub_request(:get, "#{@api_root}/lists").to_raise(exception)
+      expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
+    end
 
-  it "surfaces an unparseable response body as a Gibbon::MailChimpError" do
-    response_values = {:status => 503, :headers => {}, :body => '[foo]'}
-    exception = Faraday::Error::ClientError.new("the server responded with status 503", response_values)
+    it "surfaces an unparseable client request exception as a Gibbon::MailChimpError" do
+      exception = error_class.new(
+        "the server responded with status 503")
+      stub_request(:get, "#{@api_root}/lists").to_raise(exception)
+      expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
+    end
 
-    stub_request(:get, "#{@api_root}/lists").to_raise(exception)
-    expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
-  end
+    it "surfaces an unparseable response body as a Gibbon::MailChimpError" do
+      response_values = {:status => 503, :headers => {}, :body => '[foo]'}
+      exception = error_class.new("the server responded with status 503", response_values)
 
-  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(builder: Gibbon::Request)
-      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
+      stub_request(:get, "#{@api_root}/lists").to_raise(exception)
+      expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
     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))
+    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 = error_class.new("the server responded with status 503", response_values)
+        api_request = Gibbon::APIRequest.new(builder: Gibbon::Request)
         begin
           api_request.send :handle_error, exception
         rescue => boom
-          expect(boom.title).to eq "foo"
-          expect(boom.detail).to eq "bar"
+          expect(boom.status_code).to eq 503
+          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 = error_class.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
+
+  context 'Faraday::Error::ClientError' do
+    let(:error_class) { Faraday::Error::ClientError }
+
+    include_examples 'client error handling'
+  end
+
+  context 'Faraday::ClientError' do
+    let(:error_class) { Faraday::ClientError }
+
+    include_examples 'client error handling'
+  end
 end

data/spec/gibbon/gibbon_spec.rb

@@ -73,7 +73,7 @@ describe Gibbon do
       expect(@gibbon.proxy).to be_nil
     end
 
-    it "sets an proxy url key from the 'MAILCHIMP_PROXY_URL' ENV variable" do
+    it "sets a proxy url key from the 'MAILCHIMP_PROXY' ENV variable" do
       ENV['MAILCHIMP_PROXY'] = @proxy
       @gibbon = Gibbon::Request.new
       expect(@gibbon.proxy).to eq(@proxy)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2019-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -91,6 +91,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.markdown
@@ -123,15 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: gibbon
-rubygems_version: 2.4.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A wrapper for MailChimp API 3.0 and Export API