gibbon 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a078fe9c806ec8909a1f808a6d6983de6f1d1414c361a9b54156b66f8a796bb3
-  data.tar.gz: d0ded539be8f09eae933da1d20cace7ee804529668add90f8c892e672c61c362
+  metadata.gz: 61103c56f7d3ff60ca48fab8a2ca7c71949c1c01c784abd7ddb062dbd74d4560
+  data.tar.gz: 93f18505844eb71b72d189622547c61c0bda3c416bdb2a2caa4ec0358899e52b
 SHA512:
-  metadata.gz: 9963ae0173d0189cfe674e1547313ad6570f3dc6f502198e77118e67f067bb842478b36dc46ed72bd675f692b42067f1bda0db59c47e43f8f215364818ac1d33
-  data.tar.gz: 6f855c6ad7a73d447ed9c3219ba6383cd624dfa33abf3effbb655207b888e4eb2006297413aabb62f481f0adfde56dc67c863c47eb287a599c9f907db5c29aa9
+  metadata.gz: 7e4203bc006c80cc20c5fff0217673543faa842a28b57eb3620a373a63409c0e1b5f503335d44ff05d8ba8d124db1f5b984dcf5f98632aaa8ee077d525d0a413
+  data.tar.gz: ecc7c39379e218a5a10d92c4597fdb9e5f28c90c8297ef5a19d04189044a0b86a0f84120151369ecca4c989c3d88bb359fcc651de9527497cba368b608225d9d

data/.github/FUNDING.yml

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

data/.travis.yml

@@ -9,4 +9,5 @@ rvm:
   - 2.6.5
   - 2.7
   - 3.0.0
-
+  - 3.1
+  - 3.2

data/CHANGELOG.md

@@ -1,4 +1,5 @@
-## [Unreleased][unreleased]
+## [3.5.0, unreleased] - 2022-06-05
+- 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/README.markdown

@@ -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.
@@ -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

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.email       = ["amromousa@gmail.com"]
   s.homepage    = "http://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")

data/lib/gibbon/version.rb

@@ -1,3 +1,3 @@
 module Gibbon
-  VERSION = "3.4.4"
+  VERSION = "3.5.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 3.4.4
+  version: 3.5.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,7 +80,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 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".document"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".travis.yml"
 - CHANGELOG.md
@@ -99,7 +100,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,7 +107,6 @@ files:
 - lib/gibbon/response.rb
 - lib/gibbon/version.rb
 - 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
@@ -134,10 +133,9 @@ requirements: []
 rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
-summary: A wrapper for MailChimp API 3.0 and Export API
+summary: A wrapper for MailChimp API 3.0
 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

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