gibbon 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1f19b602cdd22a49058f62d097abe6121d04ada
-  data.tar.gz: 01e37c1aa62e820a9b1cba9c476bdfba7640c001
+  metadata.gz: cadad0262542fdc59cf9296a13273855c6060de0
+  data.tar.gz: 58cd1444c3e4cf456fa06386adbc3a4135ce9b46
 SHA512:
-  metadata.gz: cc64c4a643ceacc05f06e3a621616eb25a57072a0486bd134cd233f650966db1d5ed7f7c7154887fd96344844325bdadfe0a9f188c2c4c29add288fe638fc339
-  data.tar.gz: c046252678c798d2b1f10c87f34b6a507fb4d4d7e919e2528343fbfa19803387c44c7fa52b62a7111439fdc453ff7ce9719664d871614076b0d69d86f116c080
+  metadata.gz: f147ecf3ab960b613cd4f8623cc1ae06d40d1835f7d72af08bf6624dc1417a178671d69010eb3c5ed9fb8697e3d6b0426ba531ae31cdf4a812d527909cbb3678
+  data.tar.gz: 057fae67da3e668dcee8f38d3b2a2aa099523458dab1a04725e57a730674633603a596857776026201c929ba956f55939bef40b61f7ad4597c87e5aba24e255c

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased][unreleased]
 
+## [3.1.0] - 2017-07-27
+- Add back support for Export API until MailChimp stops supporting it
+- Implement `responds_to_missing`
+
 ## [3.0.2] - 2017-05-08
 - Fix subtle bug in `symbolize_keys` when parsing error
 
@@ -69,7 +73,9 @@
 ## [1.1.4] - 2012-11-04
 - Fix JSON::ParserError on export calls that return blank results
 
-[unreleased]: https://github.com/amro/gibbon/compare/v3.0.1...HEAD
+[unreleased]: https://github.com/amro/gibbon/compare/v3.1.0...HEAD
+[3.1.0]: https://github.com/amro/gibbon/compare/v3.0.2...v3.1.0
+[3.0.2]: https://github.com/amro/gibbon/compare/v3.0.1...v3.0.2
 [3.0.1]: https://github.com/amro/gibbon/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/amro/gibbon/compare/v2.2.5...v3.0.0
 [2.2.5]: https://github.com/amro/gibbon/compare/v2.2.4...v2.2.5

data/README.markdown

@@ -458,6 +458,33 @@ 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}
-  s.description = %q{A wrapper for MailChimp API 3.0}
+  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.license     = "MIT"
 
   s.rubyforge_project = "gibbon"

data/lib/gibbon.rb

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

data/lib/gibbon/export.rb

@@ -0,0 +1,93 @@
+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
+      @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) 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/lib/gibbon/request.rb

@@ -27,6 +27,10 @@ module Gibbon
       self
     end
 
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+
     def send(*args)
       if args.length == 0
         method_missing(:send, args)
@@ -81,6 +85,10 @@ module Gibbon
       def method_missing(sym, *args, &block)
         new(api_key: self.api_key, api_endpoint: self.api_endpoint, timeout: self.timeout, open_timeout: self.open_timeout, faraday_adapter: self.faraday_adapter, symbolize_keys: self.symbolize_keys, debug: self.debug, proxy: self.proxy, logger: self.logger).send(sym, *args, &block)
       end
+
+      def respond_to_missing?(method_name, include_private = false)
+        true
+      end
     end
   end
 end

data/lib/gibbon/version.rb

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

data/spec/gibbon/export_spec.rb

@@ -0,0 +1,32 @@
+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 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

data/spec/gibbon/gibbon_spec.rb

@@ -222,4 +222,13 @@ describe Gibbon do
       expect(Gibbon::Request.new.logger).to eq(logger)
     end
   end
+
+  describe "missing methods" do
+    it "respond to .method call on class" do
+      expect(Gibbon::Request.method(:lists)).to be_a(Method)
+    end
+    it "respond to .method call on instance" do
+      expect(Gibbon::Request.new.method(:lists)).to be_a(Method)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-08 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.21.0
-description: A wrapper for MailChimp API 3.0
+description: A wrapper for MailChimp API 3.0 and Export API
 email:
 - amromousa@gmail.com
 executables: []
@@ -98,6 +98,7 @@ 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
@@ -105,6 +106,7 @@ 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/upsert_spec.rb
 - spec/spec_helper.rb
@@ -131,9 +133,10 @@ rubyforge_project: gibbon
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: A wrapper for MailChimp API 3.0
+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/upsert_spec.rb
 - spec/spec_helper.rb