gibbon 3.4.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a078fe9c806ec8909a1f808a6d6983de6f1d1414c361a9b54156b66f8a796bb3
-  data.tar.gz: d0ded539be8f09eae933da1d20cace7ee804529668add90f8c892e672c61c362
+  metadata.gz: 1cb1352737a9335535ba7d79420ec208817700b6e8b4fcf07a449499837b721f
+  data.tar.gz: 5fd15b6c055607e95a2e81f8b4fda95b606dc6be3ac7aa147057acd13c946a1a
 SHA512:
-  metadata.gz: 9963ae0173d0189cfe674e1547313ad6570f3dc6f502198e77118e67f067bb842478b36dc46ed72bd675f692b42067f1bda0db59c47e43f8f215364818ac1d33
-  data.tar.gz: 6f855c6ad7a73d447ed9c3219ba6383cd624dfa33abf3effbb655207b888e4eb2006297413aabb62f481f0adfde56dc67c863c47eb287a599c9f907db5c29aa9
+  metadata.gz: 20bd382a94c31402452f63037c0f266cdb291493b72b93b1aab2c15021fb108fbf9a45b4ced1f3070c2c2a18aaee3bd117ef98dc4b8846b3a07f44ac042c864f
+  data.tar.gz: a030570ce92ecd7744ee1ed8dead15f0a176e3b178fd0b410e4c11a870f90ebbc0ba5909a82ae59b55959cf1ae3c06f0fd612826b5fdf93a26954907aba96729

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [amro]

data/.travis.yml

@@ -1,12 +1,23 @@
 language: ruby
-sudo: false
 cache: bundler
-before_install:
-  - gem install bundler # -v 1.7.14 if a specific version is needed
 rvm:
-  - 2.4.5
-  - 2.5.7
-  - 2.6.5
-  - 2.7
-  - 3.0.0
-
+  - 3.1
+  - 3.2
+  - 3.3
+  - 3.4
+jobs:
+  include:
+    # rvm's stable release does not know Ruby 4.0 yet, so boot on 3.4,
+    # then upgrade rvm to master and install 4.0 from there
+    - name: "4.0 (via rvm master)"
+      rvm: 3.4
+      before_install:
+        - rvm get master
+        - rvm install ruby-4.0
+        - rvm use ruby-4.0
+        - ruby -v
+      # Bundler 4 (shipped with Ruby 4.0) removed the --path flag that
+      # Travis's default install step still passes
+      install:
+        - bundle config set --local path vendor/bundle
+        - bundle install --jobs=3 --retry=3

data/CHANGELOG.md

@@ -1,4 +1,10 @@
-## [Unreleased][unreleased]
+## [4.0.0] - 2026-07-23
+- Require Ruby 3.1+ (drops support for EOL Rubies 2.4 through 3.0)
+- Require TLS 1.2 as a minimum instead of pinning it exactly, allowing TLS 1.3
+- Modernize development setup: loosen rspec pin, remove Rubinius leftovers, update CI matrix to Ruby 3.1 through 4.0
+
+## [3.5.0] - 2023-06-07
+- Remove support for retired Export API
 
 ## [3.4.4] - 2022-02-24
 - Remove non-alpha characters when parsing datacenter from API keys to prevent potential attackers from injecting a domain via the API key. This would only be possible if one were using user-provided API keys (e.g. from a form, etc.).

data/Gemfile

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

data/README.markdown

@@ -1,12 +1,12 @@
 # gibbon
 
-Gibbon is an API wrapper for MailChimp's [API](http://kb.mailchimp.com/api/).
+Gibbon is an API wrapper for MailChimp's [API](https://mailchimp.com/developer/marketing/api/).
 
-[![Build Status](https://travis-ci.com/amro/gibbon.svg?branch=master)](https://app.travis-ci.com/github/amro/gibbon)
+[![Build Status](https://app.travis-ci.com/amro/gibbon.svg?branch=master)](https://app.travis-ci.com/github/amro/gibbon)
 
 ## Important Notes
 
-Please read MailChimp's [Getting Started Guide](http://kb.mailchimp.com/api/article/api-3-overview).
+Please read MailChimp's [Getting Started Guide](https://mailchimp.com/developer/marketing/guides/quick-start/).
 
 Gibbon 3.0.0+ returns a `Gibbon::Response` instead of the response body directly. `Gibbon::Response` exposes the parsed response `body` and `headers`.
 
@@ -16,7 +16,7 @@ Gibbon 3.0.0+ returns a `Gibbon::Response` instead of the response body directly
 
 ## Requirements
 
-A MailChimp account and API key. You can see your API keys [here](http://admin.mailchimp.com/account/api).
+A MailChimp account and API key. You can see your API keys [here](https://admin.mailchimp.com/account/api).
 
 ## Usage
 
@@ -35,9 +35,9 @@ 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.
+You can read about `timeout` and `open_timeout` in the [Net::HTTP](https://docs.ruby-lang.org/en/master/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
+Now you can make requests using the resources defined in [MailChimp's docs](https://mailchimp.com/developer/marketing/api/). Resource IDs
 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!
@@ -84,7 +84,7 @@ Pass `symbolize_keys: true` to use symbols (instead of strings) as hash keys in
 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.
+MailChimp's [resource documentation](https://mailchimp.com/developer/marketing/api/) is a list of available resources.
 
 ## Debug Logging
 
@@ -180,6 +180,12 @@ Get a specific member's information (open/click rates etc.) from MailChimp:
 gibbon.lists(list_id).members(lower_case_md5_hashed_email_address).retrieve
 ```
 
+Permanently delete a specific member from a list:
+
+```ruby
+gibbon.lists(list_id).members(lower_case_md5_hashed_email_address).actions.delete_permanent.create
+```
+
 ### 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.
@@ -235,7 +241,7 @@ gibbon.batches(batch_id).retrieve
 ```
 
 ***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.
+[API documentation for Batch Operations](https://mailchimp.com/developer/marketing/api/batches/) for more details.
 
 ### Fields
 
@@ -357,7 +363,7 @@ The response body (i.e. `response.body`) looks someting like this (unrelated thi
 {"id"=>"...", "email_address"=>"...", ..., "interests"=>{"3def637141"=>true, "f7cc4ee841"=>false, "fcdc951b9f"=>false, "3daf3cf27d"=>true, "293a3703ed"=>false, "72370e0d1f"=>false, "d434d21a1c"=>false, "bdb1ff199f"=>false, "a54e78f203"=>false, "c4527fd018"=>false} ...}
 ```
 
-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:
+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](https://mailchimp.com/developer/marketing/api/interests/), we need to do this:
 
 ```ruby
 gibbon.lists(list_id).interest_categories.retrieve
@@ -394,7 +400,7 @@ end
 
 ### Other
 
-Overriding Gibbon's API endpoint (i.e. if using an access token from OAuth and have the `api_endpoint` from the [metadata](http://apidocs.mailchimp.com/oauth2/)):
+Overriding Gibbon's API endpoint (i.e. if using an access token from OAuth and have the `api_endpoint` from the [metadata](https://mailchimp.com/developer/marketing/guides/access-user-data-oauth-2/)):
 
 ```ruby
 Gibbon::Request.api_endpoint = "https://us1.api.mailchimp.com"
@@ -474,33 +480,6 @@ Gibbon 2.x+:
 ```ruby
 gibbon.lists(list_id).members.create(body: {email_address: "foo@bar.com", status: "subscribed", merge_fields: {FNAME: "Bob", LNAME: "Smith"}})
 ```
-## Export API 1.0
-
-Gibbon 3.0.0+ supports MailChimp's [Export API 1.0](https://apidocs.mailchimp.com/export/1.0/). You can choose to handle the API response all at
-once or line by line by passing a block. To access the Export API with Gibbon, you must first create an instance of `Gibbon::Export`:
-
-```ruby
-export = Gibbon::Export.new(api_key: "your_api_key")
-```
-
-Next, call the method corresponding to the API endpoint you'd like to query:
-
-```ruby
-export.list(id: list_id)
-```
-
-This fetches and returns all of the results at once. Pass a block if you'd like to handle the response as individual lines:
-
-```ruby
-export = Gibbon::Export.new(api_key: "your_api_key", timeout: 1200)
-export.list(id: list_id) do |row|
-  puts row
-end
-```
-
-This is useful when handling large sets of data. Setting the `timeout` here is optional, but a high value is recommended given the nature of the Export API. The default timeout is 600 seconds.
-
-Gibbon supports all current Export API endpoints: `/list`, `/ecommOrders`, and `/campaignSubscriberActivity`. They're mapped onto Ruby methods with similar names: `list()`, `ecomm_orders()`, and `campaign_subscriber_activity()` respectively. Please see [MailChimp's API documentation](https://developer.mailchimp.com/documentation/mailchimp/guides/how-to-use-the-export-api/) for supported parameters.
 
 ## Thanks
 

data/gibbon.gemspec

@@ -7,23 +7,22 @@ Gem::Specification.new do |s|
   s.version     = Gibbon::VERSION
   s.authors     = ["Amro Mousa"]
   s.email       = ["amromousa@gmail.com"]
-  s.homepage    = "http://github.com/amro/gibbon"
+  s.homepage    = "https://github.com/amro/gibbon"
 
-  s.summary     = %q{A wrapper for MailChimp API 3.0 and Export API}
-  s.description = %q{A wrapper for MailChimp API 3.0 and Export API}
+  s.summary     = %q{A wrapper for MailChimp API 3.0}
+  s.description = %q{A wrapper for MailChimp API 3.0}
   s.license     = "MIT"
 
   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.4.0'
+  s.required_ruby_version = '>= 3.1.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 "rspec", "~> 3.13"
   s.add_development_dependency 'webmock', '~> 3.8'
 
 end

data/lib/gibbon/api_request.rb

@@ -106,6 +106,10 @@ module Gibbon
     # Helpers
 
     def handle_error(error)
+      # Errors we raised ourselves (e.g. unparseable response bodies) already
+      # carry their details; re-wrapping them here would strip those attributes
+      raise error if error.is_a?(MailChimpError)
+
       error_params = {}
 
       begin
@@ -146,7 +150,7 @@ module Gibbon
     end
 
     def rest_client
-      client = Faraday.new(self.api_url, proxy: self.proxy, ssl: { version: "TLSv1_2" }) do |faraday|
+      client = Faraday.new(self.api_url, proxy: self.proxy, ssl: { min_version: :TLS1_2 }) do |faraday|
         faraday.response :raise_error
         faraday.adapter adapter
         if @request_builder.debug

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "3.4.4"
+  VERSION = "4.0.0"
 end

data/lib/gibbon.rb

@@ -9,7 +9,6 @@ require 'gibbon/mailchimp_error'
 require 'gibbon/request'
 require 'gibbon/api_request'
 require 'gibbon/response'
-require 'gibbon/export'
 
 module Gibbon
 end

data/spec/gibbon/api_request_spec.rb

@@ -66,4 +66,133 @@ describe Gibbon::APIRequest do
 
     include_examples 'client error handling'
   end
+
+  context 'Faraday::ServerError' do
+    let(:error_class) { Faraday::ServerError }
+
+    include_examples 'client error handling'
+  end
+
+  context "error responses over HTTP" do
+    it "raises a MailChimpError with details parsed from a 4xx JSON response" do
+      error_body = '{"title": "Invalid Resource", "detail": "The resource submitted could not be validated.", "status": 422}'
+      stub_request(:get, "#{@api_root}/lists")
+        .with(basic_auth: @basic_auth_credentials)
+        .to_return(status: 422, body: error_body, headers: { 'Content-Type' => 'application/json' })
+
+      begin
+        @gibbon.lists.retrieve
+        fail "expected a Gibbon::MailChimpError"
+      rescue Gibbon::MailChimpError => e
+        expect(e.status_code).to eq 422
+        expect(e.title).to eq "Invalid Resource"
+        expect(e.detail).to eq "The resource submitted could not be validated."
+        expect(e.raw_body).to eq error_body
+        expect(e.body).to eq MultiJson.load(error_body)
+      end
+    end
+
+    it "raises a MailChimpError on a 5xx response" do
+      stub_request(:get, "#{@api_root}/lists")
+        .with(basic_auth: @basic_auth_credentials)
+        .to_return(status: 503, body: '{"title": "Service Unavailable"}')
+
+      begin
+        @gibbon.lists.retrieve
+        fail "expected a Gibbon::MailChimpError"
+      rescue Gibbon::MailChimpError => e
+        expect(e.status_code).to eq 503
+        expect(e.title).to eq "Service Unavailable"
+      end
+    end
+  end
+
+  context "response parsing" do
+    it "returns a Gibbon::Response with the parsed body and headers" do
+      stub_request(:get, "#{@api_root}/lists")
+        .with(basic_auth: @basic_auth_credentials)
+        .to_return(status: 200, body: '{"lists": [{"id": "abc123"}]}', headers: { 'Content-Type' => 'application/json' })
+
+      response = @gibbon.lists.retrieve
+      expect(response).to be_a Gibbon::Response
+      expect(response.body).to eq({ "lists" => [{ "id" => "abc123" }] })
+      expect(response.headers["content-type"]).to eq "application/json"
+    end
+
+    it "symbolizes response keys when symbolize_keys is true" do
+      stub_request(:get, "#{@api_root}/lists")
+        .with(basic_auth: @basic_auth_credentials)
+        .to_return(status: 200, body: '{"lists": [{"id": "abc123"}]}')
+
+      response = Gibbon::Request.new(api_key: api_key, symbolize_keys: true).lists.retrieve
+      expect(response.body).to eq({ lists: [{ id: "abc123" }] })
+    end
+
+    it "returns nil for an empty response body" do
+      stub_request(:get, "#{@api_root}/lists")
+        .with(basic_auth: @basic_auth_credentials)
+        .to_return(status: 200, body: "")
+
+      expect(@gibbon.lists.retrieve).to be_nil
+    end
+
+    it "raises a MailChimpError with details intact for an unparseable success response" do
+      stub_request(:get, "#{@api_root}/lists")
+        .with(basic_auth: @basic_auth_credentials)
+        .to_return(status: 200, body: "not json")
+
+      begin
+        @gibbon.lists.retrieve
+        fail "expected a Gibbon::MailChimpError"
+      rescue Gibbon::MailChimpError => e
+        expect(e.title).to eq "UNPARSEABLE_RESPONSE"
+        expect(e.status_code).to eq 500
+      end
+    end
+  end
+
+  context "configure_request" do
+    it "sets params, headers, body, and timeouts on the request" do
+      gibbon = Gibbon::Request.new(api_key: api_key, timeout: 45, open_timeout: 15)
+      api_request = Gibbon::APIRequest.new(builder: gibbon.lists)
+      request = Struct.new(:params, :headers, :body, :options).new({}, {}, nil, Faraday::RequestOptions.new)
+
+      api_request.send(:configure_request, request: request, params: { "count" => "10" }, headers: { "X-Custom" => "value" }, body: '{"a":1}')
+
+      expect(request.params).to eq({ "count" => "10" })
+      expect(request.headers).to eq({ "Content-Type" => "application/json", "X-Custom" => "value" })
+      expect(request.body).to eq '{"a":1}'
+      expect(request.options.timeout).to eq 45
+      expect(request.options.open_timeout).to eq 15
+    end
+  end
+
+  context "rest_client configuration" do
+    it "includes the logger middleware when debug is enabled" do
+      gibbon = Gibbon::Request.new(api_key: api_key, debug: true)
+      client = Gibbon::APIRequest.new(builder: gibbon.lists).send(:rest_client)
+      expect(client.builder.handlers).to include(Faraday::Response::Logger)
+    end
+
+    it "omits the logger middleware by default" do
+      client = Gibbon::APIRequest.new(builder: @gibbon.lists).send(:rest_client)
+      expect(client.builder.handlers).not_to include(Faraday::Response::Logger)
+    end
+
+    it "configures the proxy" do
+      gibbon = Gibbon::Request.new(api_key: api_key, proxy: "http://proxy.example.com:8080")
+      client = Gibbon::APIRequest.new(builder: gibbon.lists).send(:rest_client)
+      expect(client.proxy.host).to eq "proxy.example.com"
+      expect(client.proxy.port).to eq 8080
+    end
+  end
+
+  context "rest_client ssl configuration" do
+    it "requires TLS 1.2 as a minimum without capping the TLS version" do
+      api_request = Gibbon::APIRequest.new(builder: @gibbon.lists)
+      client = api_request.send(:rest_client)
+      expect(client.ssl.min_version).to eq :TLS1_2
+      expect(client.ssl.max_version).to be_nil
+    end
+  end
 end

data/spec/gibbon/gibbon_helpers_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Gibbon::Helpers do
+  let(:helper) { Class.new { include Gibbon::Helpers }.new }
+
+  describe "#get_data_center_from_api_key" do
+    it "returns an empty string for a nil api key" do
+      expect(helper.get_data_center_from_api_key(nil)).to eq("")
+    end
+
+    it "returns an empty string for an api key without a data center" do
+      expect(helper.get_data_center_from_api_key("1234")).to eq("")
+    end
+
+    it "returns the data center with a trailing dot" do
+      expect(helper.get_data_center_from_api_key("1234-us1")).to eq("us1.")
+    end
+
+    it "uses the last segment of a key containing multiple hyphens" do
+      expect(helper.get_data_center_from_api_key("12-34-us10")).to eq("us10.")
+    end
+
+    it "strips non-alphanumeric characters to prevent domain injection" do
+      expect(helper.get_data_center_from_api_key("1234-attacker.net/path?")).to eq("attackernetpath.")
+    end
+  end
+end

data/spec/gibbon/mailchimp_error_spec.rb

@@ -46,4 +46,22 @@ describe Gibbon::MailChimpError do
   it 'sets the status_code attribute' do
     expect(@gibbon.status_code).to eq(params[:status_code])
   end
+
+  context "without params" do
+    before do
+      @gibbon = Gibbon::MailChimpError.new(message)
+    end
+
+    it "leaves the attributes nil" do
+      expect(@gibbon.title).to be_nil
+      expect(@gibbon.detail).to be_nil
+      expect(@gibbon.body).to be_nil
+      expect(@gibbon.raw_body).to be_nil
+      expect(@gibbon.status_code).to be_nil
+    end
+
+    it "still includes the attributes in the message" do
+      expect(@gibbon.message).to eq "Foo @title=nil, @detail=nil, @body=nil, @raw_body=nil, @status_code=nil"
+    end
+  end
 end

data/spec/gibbon/request_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require 'webmock/rspec'
+
+describe Gibbon::Request do
+  let(:api_key) { "1234-us1" }
+  let(:api_root) { "https://us1.api.mailchimp.com/3.0" }
+  let(:basic_auth_credentials) { ['apikey', api_key] }
+
+  before do
+    @gibbon = Gibbon::Request.new(api_key: api_key)
+  end
+
+  describe "path building" do
+    it "builds a path from chained calls" do
+      @gibbon.lists("list123").members
+      expect(@gibbon.path).to eq("lists/list123/members")
+    end
+
+    it "replaces underscores with hyphens" do
+      @gibbon.lists("list123").interest_categories
+      expect(@gibbon.path).to eq("lists/list123/interest-categories")
+    end
+
+    it "downcases path parts" do
+      @gibbon.LISTS
+      expect(@gibbon.path).to eq("lists")
+    end
+
+    it "responds to any method" do
+      expect(@gibbon.respond_to?(:anything_at_all)).to be true
+    end
+
+    it "appends 'send' to the path when called without arguments" do
+      @gibbon.campaigns("abc").actions.send
+      expect(@gibbon.path).to eq("campaigns/abc/actions/send")
+    end
+
+    it "dispatches send with arguments as a regular method call" do
+      expect(@gibbon.send(:api_key)).to eq(api_key)
+    end
+
+    it "resets the path after a request" do
+      stub_request(:get, "#{api_root}/lists").with(basic_auth: basic_auth_credentials).to_return(status: 200)
+      @gibbon.lists.retrieve
+      expect(@gibbon.path).to eq("")
+    end
+
+    it "resets the path when a request raises" do
+      stub_request(:get, "#{api_root}/lists").with(basic_auth: basic_auth_credentials).to_return(status: 500, body: "{}")
+      expect { @gibbon.lists.retrieve }.to raise_error(Gibbon::MailChimpError)
+      expect(@gibbon.path).to eq("")
+    end
+  end
+
+  describe "HTTP verb mapping" do
+    let(:body) { { name: "Foo" } }
+
+    it "maps create to POST" do
+      stub = stub_request(:post, "#{api_root}/lists")
+        .with(body: MultiJson.dump(body), basic_auth: basic_auth_credentials, headers: { 'Content-Type' => 'application/json' })
+        .to_return(status: 200)
+      @gibbon.lists.create(body: body)
+      expect(stub).to have_been_requested
+    end
+
+    it "maps update to PATCH" do
+      stub = stub_request(:patch, "#{api_root}/lists/list123")
+        .with(body: MultiJson.dump(body), basic_auth: basic_auth_credentials, headers: { 'Content-Type' => 'application/json' })
+        .to_return(status: 200)
+      @gibbon.lists("list123").update(body: body)
+      expect(stub).to have_been_requested
+    end
+
+    it "maps upsert to PUT" do
+      stub = stub_request(:put, "#{api_root}/lists/list123")
+        .with(body: MultiJson.dump(body), basic_auth: basic_auth_credentials, headers: { 'Content-Type' => 'application/json' })
+        .to_return(status: 200)
+      @gibbon.lists("list123").upsert(body: body)
+      expect(stub).to have_been_requested
+    end
+
+    it "maps retrieve to GET" do
+      stub = stub_request(:get, "#{api_root}/lists").with(basic_auth: basic_auth_credentials).to_return(status: 200)
+      @gibbon.lists.retrieve
+      expect(stub).to have_been_requested
+    end
+
+    it "maps get to GET" do
+      stub = stub_request(:get, "#{api_root}/lists").with(basic_auth: basic_auth_credentials).to_return(status: 200)
+      @gibbon.lists.get
+      expect(stub).to have_been_requested
+    end
+
+    it "maps delete to DELETE" do
+      stub = stub_request(:delete, "#{api_root}/lists/list123").with(basic_auth: basic_auth_credentials).to_return(status: 204)
+      @gibbon.lists("list123").delete
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe "request options" do
+    it "passes query params" do
+      stub = stub_request(:get, "#{api_root}/lists")
+        .with(query: { "count" => "10", "offset" => "20" }, basic_auth: basic_auth_credentials)
+        .to_return(status: 200)
+      @gibbon.lists.retrieve(params: { "count" => "10", "offset" => "20" })
+      expect(stub).to have_been_requested
+    end
+
+    it "passes custom headers" do
+      stub = stub_request(:get, "#{api_root}/lists")
+        .with(headers: { 'X-Custom' => 'custom-value' }, basic_auth: basic_auth_credentials)
+        .to_return(status: 200)
+      @gibbon.lists.retrieve(headers: { 'X-Custom' => 'custom-value' })
+      expect(stub).to have_been_requested
+    end
+  end
+
+  describe "api key handling" do
+    it "strips whitespace from the api key" do
+      gibbon = Gibbon::Request.new(api_key: "  #{api_key}  ")
+      expect(gibbon.api_key).to eq(api_key)
+    end
+  end
+
+  describe "class-level requests" do
+    before do
+      Gibbon::Request.api_key = api_key
+    end
+
+    after do
+      Gibbon::Request.api_key = nil
+    end
+
+    it "makes requests directly on the class" do
+      stub = stub_request(:get, "#{api_root}/lists").with(basic_auth: basic_auth_credentials).to_return(status: 200)
+      Gibbon::Request.lists.retrieve
+      expect(stub).to have_been_requested
+    end
+  end
+end

data/spec/gibbon/response_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Gibbon::Response do
+  it "defaults body and headers to empty hashes" do
+    response = Gibbon::Response.new
+    expect(response.body).to eq({})
+    expect(response.headers).to eq({})
+  end
+
+  it "exposes the body and headers it is given" do
+    body = { "id" => "abc" }
+    headers = { "content-type" => "application/json" }
+    response = Gibbon::Response.new(body: body, headers: headers)
+    expect(response.body).to eq(body)
+    expect(response.headers).to eq(headers)
+  end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 4.0.0
 platform: ruby
 authors:
 - Amro Mousa
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -56,16 +55,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +79,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
-description: A wrapper for MailChimp API 3.0 and Export API
+description: A wrapper for MailChimp API 3.0
 email:
 - amromousa@gmail.com
 executables: []
@@ -88,6 +87,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -99,7 +99,6 @@ files:
 - gibbon.gemspec
 - lib/gibbon.rb
 - lib/gibbon/api_request.rb
-- lib/gibbon/export.rb
 - lib/gibbon/gibbon_error.rb
 - lib/gibbon/gibbon_helpers.rb
 - lib/gibbon/mailchimp_error.rb
@@ -107,16 +106,17 @@ files:
 - lib/gibbon/response.rb
 - lib/gibbon/version.rb
 - spec/gibbon/api_request_spec.rb
-- spec/gibbon/export_spec.rb
+- spec/gibbon/gibbon_helpers_spec.rb
 - spec/gibbon/gibbon_spec.rb
 - spec/gibbon/mailchimp_error_spec.rb
+- spec/gibbon/request_spec.rb
+- spec/gibbon/response_spec.rb
 - spec/gibbon/upsert_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/amro/gibbon
+homepage: https://github.com/amro/gibbon
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,21 +124,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
-summary: A wrapper for MailChimp API 3.0 and Export API
-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
+summary: A wrapper for MailChimp API 3.0
+test_files: []

data/lib/gibbon/export.rb

@@ -1,93 +0,0 @@
-require 'net/https'
-
-module Gibbon
-  class Export
-    include Helpers
-
-    attr_accessor :api_key, :timeout
-
-    def initialize(api_key: nil, timeout: nil)
-      @api_key = api_key || self.class.api_key || ENV['MAILCHIMP_API_KEY']
-      @timeout = timeout || self.class.timeout || 600
-    end
-
-    def list(params = {}, &block)
-      call("list", params, &block)
-    end
-
-    def ecomm_orders(params = {}, &block)
-      call("ecommOrders", params, &block)
-    end
-
-    def campaign_subscriber_activity(params = {}, &block)
-      call("campaignSubscriberActivity", params, &block)
-    end
-
-    protected
-
-    def export_api_url
-      "https://#{get_data_center_from_api_key(@api_key)}api.mailchimp.com/export/1.0/"
-    end
-
-    def call(method, params = {}, &block)
-      rows = []
-
-      api_url = export_api_url + method + "/"
-      params = params.merge({ apikey: @api_key })
-      block = Proc.new { |row| rows << row } unless block_given?
-
-      ensure_api_key(params)
-
-      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, 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
-          last = ''
-          response.read_body do |chunk|
-            next if chunk.nil? or chunk.strip.empty?
-            infix = "\n" if last[-1, 1]==']'
-            lines, last = try_parse_line("#{last}#{infix}#{chunk}")
-            lines.each { |line| block.call(line, i += 1) }
-          end
-          block.call(parse_line(last), i += 1) unless last.nil? or last.empty?
-        end
-      end
-      rows unless block_given?
-    end
-
-    def try_parse_line(res)
-      lines = res.split("\n")
-      last = lines.pop || ''
-      lines.map! { |line| parse_line(line) }
-      [lines.compact, last]
-    rescue MultiJson::ParseError
-      [[], last]
-    end
-     
-     
-    def parse_line(line)
-      parsed_response = MultiJson.load(line)
-    rescue MultiJson::ParseError
-      return []
-    end
-
-    private
-
-    def ensure_api_key(params)
-      unless params[:apikey] && (get_data_center_from_api_key(params[:apikey]) != "")
-        raise Gibbon::GibbonError, "You must set an api_key prior to making a call"
-      end
-    end
-
-    class << self
-      attr_accessor :api_key, :timeout
-
-      def method_missing(sym, *args, &block)
-        new(api_key: self.api_key, timeout: self.timeout).send(sym, *args, &block)
-      end
-    end
-  end
-end

data/spec/gibbon/export_spec.rb

@@ -1,39 +0,0 @@
-require 'spec_helper'
-require 'webmock/rspec'
-
-describe Gibbon::Export do
-  before do
-    Gibbon::Export.send(:public, *Gibbon::Export.protected_instance_methods)
-    @export = Gibbon::Export.new
-  end
-
-  it "doesn't allow empty api key" do
-    expect {@export.list(id: "123456")}.to raise_error(Gibbon::GibbonError)
-  end
-
-  it "doesn't allow api key without data center" do
-    @api_key = "123"
-    @export.api_key = @api_key
-    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
-    expect(@export.export_api_url).to eq("https://us1.api.mailchimp.com/export/1.0/")
-  end
-
-  it "sets correct timeout" do
-    @api_key = "TESTKEY-us1"
-    @export.api_key = @api_key
-    @export.timeout = 9
-    expect(@export.timeout).to eq(9)
-  end
-end