gibbon 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eedf8f39648b37f49821cf07606f6632218e2b8
-  data.tar.gz: 32c2da7b8ed6edd091d8b762e527de5d5c320e2e
+  metadata.gz: 3568033ceac76caeac9a0c242498bea98928a54b
+  data.tar.gz: 5eaee69f08c43608056f4407058ae68db18ae062
 SHA512:
-  metadata.gz: b240b5939c6c0bfba804bddc57ee2d41c9dc92ed363aa204f2fd47092c08bae8f7b0eb1a83ddf40474ff9227caa863a769cd4de73c53499d5c5b697eed9ebf03
-  data.tar.gz: bcc381f439b1664a8894d7d269b6335ba2f78670ecf4822da31b2bf8444d08208cfd91fe614a95dd22179d0fe9c07202cc1e72c1f903616f652430660b5709e5
+  metadata.gz: 6aee46b63e30a3d8b2178864c76f773edc36d4b2f0dbe9c64feecf5b79fba5e008cbb71ce0af31f9deb1c9ab96a0ff85bbe4cfd443187ee7335e90ad10df6c74
+  data.tar.gz: 1054e23dc767ec9d60b507febdaecc2c646cfcac98c149b4a35b35cced3ab2c1d98b1e51c25c8c892f8ca0ddbe019ce21dba6a9bdca46b9c94378785998d8566

data/CHANGELOG.md

@@ -1,12 +1,19 @@
 ## [Unreleased][unreleased]
 -
+
+## [1.2.0] - 2015-07-16
+- Same as 1.1.6 but rereleased because it's a breaking change
+- Support for Ruby 2 streaming with Export API. Now returns an Array of Array of Strings instead of an Array of Strings.
+- Fix a bug that caused calling methods statically on Gibbon::Export to fail
+
+## [1.1.6] - 2015-06-04 (Yanked)
+- Support for Ruby 2 streaming with Export API
+
 ## [1.1.5] - 2015-02-19
-### Fixed
 - Update MultiJSON dependency to 1.9.0
 - Handle single empty space in Export API response
 
 ## [1.1.4] - 2012-11-04
-### Fixed
 - Fix JSON::ParserError on export calls that return blank results
 
 [unreleased]: https://github.com/amro/gibbon/compare/v1.1.5...HEAD

data/Gemfile

@@ -5,4 +5,8 @@ platforms :rbx do
   gem 'rubinius-developer_tools'
 end
 
+group :development, :test do
+  gem 'webmock'
+end
+
 gemspec

data/LICENSE.txt

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

@@ -9,9 +9,8 @@ Gibbon is an API wrapper for MailChimp's [Primary and Export APIs](http://www.ma
 Gibbon now targets MailChimp API 2.0, which is substantially different from API 1.3. Please use Gibbon 0.4.6 if you need to use API 1.3.
 
 * Supports MailChimp API 2.0 and Export API 1.0
-* Errors are raised by default since 0.4.x
+* Errors are raised by default
 * Timeouts can be specified per request during initialization
-* Ruby 1.9.3+ for now. A future version may be Ruby 2.0 only to take advantage of lazy iteration when using the Export API.
 
 ##Installation
 
@@ -190,7 +189,26 @@ of JSON objects rather than a single JSON array.
 
 For example, dumping list members via the "list" method works like this:
 
-    gibbon_export.list({:id => list_id})
+    gibbon_export.list({:id => *list_id*})
+
+One can also use this in a streaming fashion, where each row is parsed on it comes in like this:
+
+    gibbon_export.list({:id => *list_id*}) { |row| *do_sth_with* row }
+
+For the streaming functionality, it is important to supply an explicit block / procedure to the export functions, not an implicit one. So, the preceding and following one will work. Please note this method also includes a counter (*i*, starting at 0) telling which row of data you're receiving:
+```
+    method = Proc.new do |row, i|
+        *do_sth_with* row
+    end
+    gibbon_export.list(params, &method)
+```
+
+Please note, the following example gives a block that is outside of the function and therefore **won't** work:
+```
+    gibbon_export.list({:id => *list_id*}) do |row|
+        *do_sth_with* row
+    end
+```
 
 ##Thanks
 
@@ -198,5 +216,5 @@ Thanks to everyone who's [contributed](https://github.com/amro/gibbon/contributo
 
 ##Copyright
 
-* Copyright (c) 2010-2014 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2014 The Rocket Science Group.
+* Copyright (c) 2010-2015 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2015 The Rocket Science Group.

data/gibbon.gemspec

@@ -1,9 +1,10 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+require 'gibbon/version'
 
 Gem::Specification.new do |s|
   s.name        = "gibbon"
-  s.version     = "1.1.5"
+  s.version     = Gibbon::VERSION
   s.authors     = ["Amro Mousa"]
   s.email       = ["amromousa@gmail.com"]
   s.homepage    = "http://github.com/amro/gibbon"

data/lib/gibbon/api_category.rb

@@ -27,27 +27,26 @@ module Gibbon
       headers = params.delete(:headers) || {}
       response = self.class.post(api_url, :body => MultiJson.dump(params), :headers => headers, :timeout => @timeout)
 
-      parsed_response = nil
-
-      if (response.body)
-        begin
-          parsed_response = MultiJson.load(response.body)
-        rescue MultiJson::ParseError
-          parsed_response = {
-            "error" => "Unparseable response: #{response.body}", 
-            "name" => "UNPARSEABLE_RESPONSE", 
-            "code" => 500
-          }
-        end
-
-        if should_raise_for_response?(parsed_response)
-          error = MailChimpError.new(parsed_response["error"])
-          error.code = parsed_response["code"]
-          error.name = parsed_response["name"]
-          raise error
-        end
+      parse_response(response.body) if response.body
+    end
+
+    def parse_response(response, check_error = true)
+      begin
+        parsed_response = MultiJson.load(response)
+      rescue MultiJson::ParseError
+        parsed_response = {
+          "error" => "Unparseable response: #{response}",
+          "name" => "UNPARSEABLE_RESPONSE",
+          "code" => 500
+        }
       end
 
+      if should_raise_for_response?(parsed_response)
+        error = MailChimpError.new(parsed_response["error"])
+        error.code = parsed_response["code"]
+        error.name = parsed_response["name"]
+        raise error
+      end
       parsed_response
     end
 
@@ -61,7 +60,7 @@ module Gibbon
       if ((args.length > 0) && args[0].is_a?(Hash))
         method_missing(:send, args[0])
       else
-        __send__(args)
+        __send__(*args)
       end
     end
 
@@ -100,7 +99,6 @@ module Gibbon
       data_center
     end
 
-
     private
 
     def ensure_api_key(params)

data/lib/gibbon/export.rb

@@ -14,37 +14,51 @@ module Gibbon
       "http://#{get_data_center_from_api_key}api.mailchimp.com/export/1.0/"
     end
 
-    def call(method, params = {})
-      ensure_api_key params
+    # fsluis: Alternative, streaming, interface to mailchimp export api
+    #         Prevents having to keep lots of data in memory
+    def call(method, params = {}, &block)
+      rows = []
 
       api_url = export_api_url + method + "/"
       params = @default_params.merge(params).merge({:apikey => @api_key})
-      response = self.class.post(api_url, :body => MultiJson.dump(params), :timeout => @timeout)
-
-      lines = response.body.lines
-      if @throws_exceptions
-        # ignore blank responses
-        return [] if !lines.first || lines.first.strip.empty?
-
-        first_line = MultiJson.load(lines.first) if lines.first
+      block = Proc.new { |row| rows << row } unless block_given?
+      ensure_api_key params
 
-        if should_raise_for_response?(first_line)
-          error = MailChimpError.new(first_line["error"])
-          error.code = first_line["code"]
-          raise error
+      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) 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?
+            lines = (last+chunk).split("\n")
+            last = lines.pop || ''
+            lines.each do |line|
+              block.call(parse_response(line, i < 0), i += 1) unless line.nil?
+            end
+          end
+          block.call(parse_response(last, i < 0), i += 1) unless last.nil? or last.empty?
         end
       end
+      rows unless block_given?
+    end
 
-      lines
+    def parse_response(res, check_error)
+      return [] if res.strip.empty?
+      super(res, check_error)
     end
 
     def set_instance_defaults
-      super
       @api_key = self.class.api_key if @api_key.nil?
       @timeout = self.class.timeout if @timeout.nil?
+      super
     end
 
-    def method_missing(method, *args)
+    # fsluis: added a &block to this method and function call
+    def method_missing(method, *args, &block)
       # To support underscores, we camelize the method name
 
       # Thanks for the camelize gsub, Rails
@@ -55,16 +69,25 @@ module Gibbon
       # must be upcased (See "Campaign Report Data Methods" in their API docs).
       method = method[0].chr.downcase + method[1..-1].gsub(/aim$/i, 'AIM')
 
-      call(method, *args)
+      call(method, *args, &block)
     end
 
     def respond_to_missing?(method, include_private = false)
       %w{list ecommOrders ecomm_orders campaignSubscriberActivity campaign_subscriber_activity}.include?(method.to_s) || super
     end
 
-
     private
 
+    def split_json(lines, delimiter)
+      lines.map do |line|
+        if line.include? delimiter
+          line.split(delimiter).each_with_index.map{ |s, i|  i % 2 == 0 ? s + delimiter[0] : delimiter[1] + s }
+        else
+          line
+        end
+      end.flatten
+    end
+
     def ensure_api_key(params)
       unless @api_key || @default_params[:apikey] || params[:apikey]
         raise Gibbon::GibbonError, "You must set an api_key prior to making a call"

data/lib/gibbon/version.rb

@@ -0,0 +1,3 @@
+module Gibbon
+  VERSION = "1.2.0"
+end

data/spec/gibbon/gibbon_spec.rb

@@ -1,5 +1,7 @@
 require 'spec_helper'
 require 'cgi'
+require 'webmock'
+require 'webmock/rspec'
 
 describe Gibbon do
 
@@ -229,7 +231,8 @@ describe Gibbon do
       @gibbon = Gibbon::Export.new(@key)
       @url = "http://us1.api.mailchimp.com/export/1.0/"
       @body = {:apikey => @key, :id => "listid"}
-      @returns = Struct.new(:body).new(MultiJson.dump(["array", "entries"]))
+      @return_items = ["array", "entries"]
+      @returns = MultiJson.dump(@return_items)
     end
 
     it "handle api key with dc" do
@@ -237,43 +240,70 @@ describe Gibbon do
       @gibbon = Gibbon::Export.new(@api_key)
 
       @body[:apikey] = @api_key
-      params = {:body => MultiJson.dump(@body), :timeout => 30}
-
       url = @url.gsub('us1', 'us2') + "sayHello/"
-      expect(Gibbon::Export).to receive(:post).with(url, params).and_return(@returns)
+
+      # Fake request
+      stub_request(:post, url).
+        to_return(:body => @returns, :status => 200)
+
+      # Check request url
       @gibbon.say_hello(@body)
+      expect(WebMock).to have_requested(:post, url).with(:body => @body)
+    end
+
+    it "uses timeout if set" do
+      Gibbon::Export.timeout = 45
+      expect(Gibbon::Export.new.timeout).to eql 45
     end
 
     it "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = false
-      allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+      reply = MultiJson.dump({:error => 'bad things'})
+      stub_request(:post, @url + 'sayHello/').
+        to_return(:body => reply, :status => 200)
 
       @gibbon.say_hello(@body)
     end
 
     it "throw exception if configured to and the Export API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = true
-      params = {:body => @body, :timeout => 30}
-      reply = Struct.new(:body).new MultiJson.dump({'error' => 'bad things', 'code' => '123'})
-      allow(Gibbon::Export).to receive(:post).and_return reply
+      reply = MultiJson.dump({:error => 'bad things', :code => '123'})
+      stub_request(:post, @url + 'sayHello/').
+        to_return(:body => reply, :status => 200)
 
       expect {@gibbon.say_hello(@body)}.to raise_error(Gibbon::MailChimpError)
     end
 
     it "should handle a single empty space response without throwing an exception" do
       @gibbon.throws_exceptions = true
-      allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(" "))
+      stub_request(:post, @url + 'sayHello/').
+        to_return(:body => " ", :status => 200)
+      #allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(" "))
 
       expect(@gibbon.say_hello(@body)).to eq([])
     end
 
     it "should handle an empty response without throwing an exception" do
       @gibbon.throws_exceptions = true
-      allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(""))
+      stub_request(:post, @url + 'sayHello/').
+        to_return(:body => "", :status => 200)
+      #allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(""))
 
       expect(@gibbon.say_hello(@body)).to eq([])
     end
 
+    it "should feed API results per row to a given block" do
+      # Fake request
+      stub_request(:post, @url + 'sayHello/').
+        to_return(:body => @returns, :status => 200)
+
+      # Check request url
+      @result = []
+      @gibbon.say_hello(@body) { |res| @result << res }
+      expect(@result).to contain_exactly(@return_items)
+    end
+
+
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.2.0
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -88,6 +88,7 @@ files:
 - lib/gibbon/export.rb
 - lib/gibbon/gibbon_error.rb
 - lib/gibbon/mailchimp_error.rb
+- lib/gibbon/version.rb
 - spec/gibbon/gibbon_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/amro/gibbon
@@ -113,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gibbon
-rubygems_version: 2.3.0
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A wrapper for MailChimp API 2.0 and Export API 1.0