gibbon 3.3.3 → 3.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbdff62baa93bc714bc199105fa84691067cec6650a1a5c06dbde64da52c8bd6
-  data.tar.gz: 5e115ce632e5e3229692f3975c0819cc165eec6a2ef41ab0fa76704ce9c83955
+  metadata.gz: cbf98318183318809515680772c41112c958c6bbe179cca742be0ede39a7ff00
+  data.tar.gz: b5ef43d8313654cd65cc57da8698189cf559200e89da98cd269b9e3973d02b9e
 SHA512:
-  metadata.gz: dec423c9924c775b88110218b948f2685daa949f03ea3ee7eef7bafd4c9b97ed5db201167cb9aae66edfb9be964e227c864c2536f9ab6407e1f50b14ec2061c3
-  data.tar.gz: dfca56671affd0cffc57cb19b4292eed8f70e7a8de60b5a8524660cb2fe44ae947f794c540781039a1de77cf2ca5918c4bb0f6cbaadfe375bd5ed916e3d84c1a
+  metadata.gz: 6c4534f315ae5d1bdf712bbdb56414ba2e96170af76c6e70dde47f1d01157e2d3707d4473be60f3a38b9cfa3ab8780694bcde7b007d5dc0919c103d5b7f69598
+  data.tar.gz: fe7e4f3f2c55b289ee93c8f72ce28204a55ad013c3f997f287a734e0cb7e07b2ec5ce635a9c5534f2be11e25eda8ed291365d6c7579f6fb5cbfcf2a1287f1bdf

data/.travis.yml

@@ -4,8 +4,9 @@ cache: bundler
 before_install:
   - gem install bundler # -v 1.7.14 if a specific version is needed
 rvm:
-  - 2.3.8
   - 2.4.5
   - 2.5.7
   - 2.6.5
   - 2.7
+  - 3.0.0
+

data/CHANGELOG.md

@@ -1,6 +1,23 @@
 ## [Unreleased][unreleased]
 
-## [3.3.3] - 2020-02-7
+
+## [3.4.3] - 2022-01-19
+- Support for Faraday 2.0, which requires new syntax for basic auth
+
+## [3.4.2] - 2021-09-21
+- Fixing the deprecation warning in version 3.4.2 requires moving to a minimum version of Faraday 1.0.0 (more than 2 years old).
+
+## [3.4.1] - 2021-09-12
+- Fix deprecation warning for upcoming versions of Faraday (2.x.x)
+
+## [3.4.0] - 2021-03-12
+- Support for Faraday 1.x.x and higer
+
+## [3.3.4] - 2020-04-01
+- Added support for setting API key via environment variable for Export API
+- Updated webmock
+
+## [3.3.3] - 2020-02-07
 - Removes bit of extra conditional logic that was part of supporting older versions of Faraday
 
 ## [3.3.2] - 2020-01-19

data/Gemfile

@@ -1,12 +1,11 @@
 source "https://rubygems.org"
 
 platforms :rbx do
-  gem 'rubysl', '~> 2.2.0'
   gem 'rubinius-developer_tools'
 end
 
 group :development, :test do
-  gem 'webmock', '~>1.24.0'
+  gem 'webmock', '~> 3.8'
 end
 
 gemspec

data/LICENSE.txt

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

@@ -2,7 +2,7 @@
 
 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)
+[![Build Status](https://travis-ci.com/amro/gibbon.svg?branch=master)](https://app.travis-ci.com/github/amro/gibbon)
 
 ## Important Notes
 
@@ -38,7 +38,7 @@ 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.
+are specified inline and a `CRUD` (`create`, `retrieve` (or `get`), `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.
 
 ***Note*** `upsert` requires Gibbon version 2.1.0 or newer!
 
@@ -48,6 +48,8 @@ You can specify `headers`, `params`, and `body` when calling a `CRUD` method. Fo
 gibbon.lists.retrieve(headers: {"SomeHeader": "SomeHeaderValue"}, params: {"query_param": "query_param_value"})
 ```
 
+***Note*** `get` can be substituted for `retrieve` as of Gibbon version 3.4.1 or newer!
+
 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`, `open_timeout`, `faraday_adapter`, `proxy`, `symbolize_keys`, `logger`, and `debug` globally:
@@ -506,5 +508,5 @@ Thanks to everyone who has [contributed](https://github.com/amro/gibbon/contribu
 
 ## Copyright
 
-* Copyright (c) 2010-2020 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2020 The Rocket Science Group.
+* Copyright (c) 2010-2022 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2022 The Rocket Science Group.

data/gibbon.gemspec

@@ -17,13 +17,13 @@ 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.3.8'
+  s.required_ruby_version = '>= 2.4.0'
 
-  s.add_dependency('faraday', '>= 0.16.0')
+  s.add_dependency('faraday', '>= 1.0')
   s.add_dependency('multi_json', '>= 1.11.0')
 
   s.add_development_dependency 'rake'
   s.add_development_dependency "rspec", "3.5.0"
-  s.add_development_dependency 'webmock', '~> 1.21.0'
+  s.add_development_dependency 'webmock', '~> 3.8'
 
 end

data/lib/gibbon/api_request.rb

@@ -109,7 +109,7 @@ module Gibbon
       error_params = {}
 
       begin
-        if error.is_a?(Faraday::ClientError) && error.response
+        if (error.is_a?(Faraday::ClientError) || error.is_a?(Faraday::ServerError)) && error.response
           error_params[:status_code] = error.response[:status]
           error_params[:raw_body] = error.response[:body]
 
@@ -152,8 +152,14 @@ module Gibbon
         if @request_builder.debug
           faraday.response :logger, @request_builder.logger, bodies: true
         end
+
+        if Faraday::VERSION.to_i >= 2
+          faraday.request :authorization, :basic, 'apikey', self.api_key
+        else
+          faraday.request :basic_auth, 'apikey', self.api_key
+        end
       end
-      client.basic_auth('apikey', self.api_key)
+
       client
     end
 

data/lib/gibbon/export.rb

@@ -7,7 +7,7 @@ module Gibbon
     attr_accessor :api_key, :timeout
 
     def initialize(api_key: nil, timeout: nil)
-      @api_key = api_key || self.class.api_key
+      @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
       @timeout = timeout || self.class.timeout || 600
     end
 

data/lib/gibbon/request.rb

@@ -61,6 +61,10 @@ module Gibbon
       reset
     end
 
+    def get(params: nil, headers: nil)
+      retrieve(params: params, headers: headers)
+    end
+
     def retrieve(params: nil, headers: nil)
       APIRequest.new(builder: self).get(params: params, headers: headers)
     ensure

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "3.3.3"
+  VERSION = "3.4.3"
 end

data/spec/gibbon/api_request_spec.rb

@@ -6,20 +6,21 @@ describe Gibbon::APIRequest do
 
   before do
     @gibbon = Gibbon::Request.new(api_key: api_key)
-    @api_root = "https://apikey:#{api_key}@us1.api.mailchimp.com/3.0"
+    @api_root = "https://us1.api.mailchimp.com/3.0"
+    @basic_auth_credentials = ['apikey', api_key]
   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)
+      stub_request(:get, "#{@api_root}/lists").with(basic_auth: @basic_auth_credentials).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 = error_class.new(
         "the server responded with status 503")
-      stub_request(:get, "#{@api_root}/lists").to_raise(exception)
+      stub_request(:get, "#{@api_root}/lists").with(basic_auth: @basic_auth_credentials).to_raise(exception)
       expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
     end
 
@@ -27,7 +28,7 @@ describe Gibbon::APIRequest do
       response_values = {:status => 503, :headers => {}, :body => '[foo]'}
       exception = error_class.new("the server responded with status 503", response_values)
 
-      stub_request(:get, "#{@api_root}/lists").to_raise(exception)
+      stub_request(:get, "#{@api_root}/lists").with(basic_auth: @basic_auth_credentials).to_raise(exception)
       expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
     end
 

data/spec/gibbon/export_spec.rb

@@ -17,6 +17,13 @@ describe Gibbon::Export do
     expect {@export.list(id: "123456")}.to raise_error(Gibbon::GibbonError)
   end
 
+  it "sets an API key from the 'MAILCHIMP_API_KEY' ENV variable" do
+    ENV['MAILCHIMP_API_KEY'] = 'TESTKEY-us1'
+    @export = Gibbon::Export.new
+    expect(@export.api_key).to eq('TESTKEY-us1')
+    ENV.delete('MAILCHIMP_API_KEY')
+  end
+
   it "sets correct endpoint from api key" do
     @api_key = "TESTKEY-us1"
     @export.api_key = @api_key

data/spec/gibbon/upsert_spec.rb

@@ -17,8 +17,8 @@ describe Gibbon do
   end
 
   it 'supports upsert request' do
-    stub_request(:put, "https://apikey:1234-us1@us1.api.mailchimp.com/3.0/lists/#{list_id}/members/#{member_id}")
-      .with(body: MultiJson.dump(request_body))
+    stub_request(:put, "https://us1.api.mailchimp.com/3.0/lists/#{list_id}/members/#{member_id}")
+      .with(body: MultiJson.dump(request_body), basic_auth: ['apikey', '1234-us1'])
       .to_return(status: 200)
 
     Gibbon::Request.new(api_key: api_key)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 3.3.3
+  version: 3.4.3
 platform: ruby
 authors:
 - Amro Mousa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2022-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: '3.8'
 description: A wrapper for MailChimp API 3.0 and Export API
 email:
 - amromousa@gmail.com
@@ -116,7 +116,7 @@ homepage: http://github.com/amro/gibbon
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,15 +124,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.8
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.27
+signing_key:
 specification_version: 4
 summary: A wrapper for MailChimp API 3.0 and Export API
 test_files: