gibbon 3.1.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cadad0262542fdc59cf9296a13273855c6060de0
-  data.tar.gz: 58cd1444c3e4cf456fa06386adbc3a4135ce9b46
+SHA256:
+  metadata.gz: c0c5907fb603a29a0ec038bc64a29c401fa9bc793653037ec5891a3ef2872098
+  data.tar.gz: 21b8c423a29b5662777441ddb28cca46edba64381fb72edd7b73a09d570d3511
 SHA512:
-  metadata.gz: f147ecf3ab960b613cd4f8623cc1ae06d40d1835f7d72af08bf6624dc1417a178671d69010eb3c5ed9fb8697e3d6b0426ba531ae31cdf4a812d527909cbb3678
-  data.tar.gz: 057fae67da3e668dcee8f38d3b2a2aa099523458dab1a04725e57a730674633603a596857776026201c929ba956f55939bef40b61f7ad4597c87e5aba24e255c
+  metadata.gz: 64ecc31deb5d9b142de580fb914d8653e8e4cff2d2e0f7904bcd365d937921be52945dd68a9f40aed7e04024d27c8fef9888c5ad126bf9824fa734bfbc8fd9e3
+  data.tar.gz: 32c351fcf6c71151bd2fed29d48a59ca3f80b99c1c4288490f020680d1c5c8dcfaaa07a3f238b51f47ae3a86644109fb20e89dd1d726e2631ebfeee27011ef08

data/.travis.yml

@@ -1,8 +1,11 @@
 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
-  - 2.2.2
-  - 2.3.3
+  - 2.3.8
+  - 2.4.5
+  - 2.5.7
+  - 2.6.5
+  - 2.7

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 ## [Unreleased][unreleased]
 
+## [3.3.1] - 2019-11-08
+- Fix statically setting `faraday_adapter` did not set adapter on new requests
+
+## [3.3.0] - 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
+
+## [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`

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/LICENSE.txt

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

@@ -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(lower_case_email_address)).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-2020 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2020 The Rocket Science Group.

data/gibbon.gemspec

@@ -13,15 +13,13 @@ Gem::Specification.new do |s|
   s.description = %q{A wrapper for MailChimp API 3.0 and Export API}
   s.license     = "MIT"
 
-  s.rubyforge_project = "gibbon"
-
   s.files         = `git ls-files`.split("\n")
   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('faraday', '>= 0.16.0')
   s.add_dependency('multi_json', '>= 1.11.0')
 
   s.add_development_dependency 'rake'

data/lib/gibbon/api_request.rb

@@ -102,14 +102,17 @@ module Gibbon
     def symbolize_keys
       @request_builder.symbolize_keys
     end
-    
+
     # Helpers
 
     def handle_error(error)
       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]
 
@@ -146,7 +149,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
@@ -157,7 +160,7 @@ module Gibbon
       client
     end
 
-    def parse_response(response)      
+    def parse_response(response)
       parsed_response = nil
 
       if response.body && !response.body.empty?
@@ -166,9 +169,8 @@ module Gibbon
           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

data/lib/gibbon/export.rb

@@ -41,7 +41,7 @@ module Gibbon
       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) do |http|
+      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
@@ -90,4 +90,4 @@ module Gibbon
       end
     end
   end
-end
+end

data/lib/gibbon/request.rb

@@ -13,7 +13,7 @@ module Gibbon
       @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
+      @faraday_adapter = faraday_adapter || self.class.faraday_adapter || Faraday.default_adapter
       @symbolize_keys = symbolize_keys || self.class.symbolize_keys || false
       @debug = debug || self.class.debug || false
       @logger = logger || self.class.logger || ::Logger.new(STDOUT)

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "3.1.0"
-end
+  VERSION = "3.3.2"
+end

data/spec/gibbon/api_request_spec.rb

@@ -9,52 +9,60 @@ 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::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)

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: 3.1.0
+  version: 3.3.2
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2020-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +91,7 @@ files:
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.markdown
@@ -108,6 +109,7 @@ 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
 homepage: http://github.com/amro/gibbon
@@ -122,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
@@ -138,5 +139,6 @@ 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