mailchimp 0.0.8 → 0.0.9

data/CONTRIBUTORS.markdown

@@ -14,5 +14,4 @@
 * [Dave Worth](https://github.com/daveworth)
 * [Mike Skalnik](https://github.com/skalnik)
 * [Kristopher Murata](https://github.com/krsmurata)
-* [Michael Klishin](https://github.com/michaelklishin)
-* [Ben Simpson](https://github.com/bsimpson)
+* [Michael Klishin](https://github.com/michaelklishin)

data/README-api.markdown

@@ -63,9 +63,15 @@ or
 ### Export API usage
 
 In addition to the standard API you can make calls to the
-[MailChimp Export API](http://apidocs.mailchimp.com/export/1.0/) using a Mailchimp::Export object:
-  
-  mailchimp_export = Mailchimp::Export.new(@api_key)
+[MailChimp Export API](http://apidocs.mailchimp.com/export/1.0/) using a APIExport object.  Given an existing
+Mailchimp::API object you can request a new Mailchimp::APIExporter object:
+
+    api = Mailchimp::API.new(@api_key)
+    mailchimp_export = api.get_exporter
+
+or you can construct a new object directly:
+
+    mailchimp_export = Mailchimp::APIExport.new(@api_key)
 
 Calling Export API functions is identical to making standard API calls but the
 return value is an Enumerator which loops over the lines returned from the

data/lib/mailchimp.rb

@@ -10,6 +10,7 @@ require "mailchimp/api"
 require "mailchimp/sts"
 require "mailchimp/mandrill"
 require 'mailchimp/export'
+require "mailchimp/api_error"
 
 module Mailchimp
 end

data/lib/mailchimp/api.rb

@@ -40,7 +40,7 @@ module Mailchimp
       end
 
       if @throws_exceptions && response.is_a?(Hash) && response["error"]
-        raise "Error from MailChimp API: #{response["error"]} (code #{response["code"]})"
+        raise Mailchimp::APIError.new(response['error'],response['code'])
       end
 
       response

data/lib/mailchimp/api_error.rb

@@ -0,0 +1,10 @@
+module Mailchimp
+  class APIError < RuntimeError
+    attr_accessor :error, :code
+    def initialize(error,code)
+      super("Error from MailChimp API: #{error} (code #{code})")
+      @error = error
+      @code = code
+    end
+  end
+end

data/lib/mailchimp/base.rb

@@ -6,12 +6,13 @@ module Mailchimp
     include HTTParty
     default_timeout 30
 
-    attr_accessor :api_key, :timeout, :options
+    attr_accessor :api_key, :timeout, :options, :throws_exceptions
 
     def initialize(api_key = nil, default_parameters = {})
       @api_key = api_key || ENV['MAILCHIMP_API_KEY'] || nil
       @timeout = default_parameters.delete(:timeout) 
       @default_params = default_parameters
+      @throws_exceptions = false
     end
 
     def dc_from_api_key
@@ -39,7 +40,7 @@ module Mailchimp
         response = self.class.post(url, :body => params, :timeout => timeout)
         begin; response = JSON.parse(response.body); rescue; response = response.body ;end
         if @throws_exceptions && response.is_a?(Hash) && response["error"]
-          raise "Error from MailChimp API: #{response["error"]} (code #{response["code"]})"
+          raise Mailchimp::APIError response["error"], response["code"]
         end
         response
       end

data/lib/mailchimp/export.rb

@@ -1,8 +1,5 @@
 module Mailchimp
   class Export < Base
-    
-    format :plain
-    
     def initialize(api_key = nil, default_parameters = {})
       super(api_key, {:apikey => api_key}.merge(default_parameters))
     end
@@ -20,7 +17,7 @@ module Mailchimp
       lines = response.body.lines
       if @throws_exceptions
         first_line_object = JSON.parse(lines.first) if lines.first
-        raise "Error from MailChimp Export API: #{first_line_object["error"]} (code #{first_line_object["code"]})" if first_line_object.is_a?(Hash) && first_line_object["error"]
+        raise Mailchimp::APIError.new(first_line_object["error"],first_line_object["code"]) if first_line_object.is_a?(Hash) && first_line_object["error"]
       end
 
       lines  

data/lib/mailchimp/ext/httparty.rb

@@ -1,4 +1,4 @@
-class MailchimpPsuedoJSONParser < HTTParty::Parser
+class MailchimpPseudoJSONParser < HTTParty::Parser
   # Unfornately Mailchimp's API returns invalid JSON for some valid requests,
   # specifically mandrill's users/ping.  We need to just pass that through instead
   # of blowing up inside of HTTParty so that we can do something with it later.

data/lib/mailchimp/mandrill.rb

@@ -4,7 +4,7 @@ end
 
 module Mailchimp
   class Mandrill < Base
-    parser MailchimpPsuedoJSONParser
+    parser MailchimpPseudoJSONParser
 
     def initialize(api_key = nil, default_parameters = {})
       super(api_key, {

data/lib/mailchimp/version.rb

@@ -1,3 +1,3 @@
 module Mailchimp
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/mailchimp.gemspec

@@ -5,8 +5,8 @@ require "mailchimp/version"
 Gem::Specification.new do |s|
   s.name        = "mailchimp"
   s.version     = Mailchimp::VERSION
-  s.authors     = ["Chris Kelly"]
-  s.email       = ["chris@highgroove.com"]
+  s.authors     = ["Chris Kelly", "Dave Worth"]
+  s.email       = ["dave@bignerdranch.com"]
   s.homepage    = "https://github.com/mailchimp/mailchimp-gem"
   s.summary     = %q{Mailchimp APIs in Ruby}
   s.description = %q{This provides Ruby access to (eventually) all of Mailchimp's APIs}
@@ -17,9 +17,9 @@ 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.add_dependency('httparty')
-  
+
   s.add_development_dependency('ruby-debug19')
   s.add_development_dependency('rake')
   s.add_development_dependency('shoulda')

data/test/lib/api_test.rb

@@ -115,22 +115,26 @@ class ApiTest < Test::Unit::TestCase
       @returns = Struct.new(:body).new(["array", "entries"].to_json)
     end
 
-    should "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
-      Mailchimp::API.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
+    should "not throw exception if the API replies with a JSON hash containing a key called 'error'" do
+      Mailchimp::API.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things', 'code' => '254'}.to_json))
       assert_nothing_raised do
         result = @api.say_hello
+        assert_equal 'bad things', result['error']
+        assert_equal '254', result['code']
       end
-
-      ap result
     end
 
     should "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
       @api.throws_exceptions = true
-      Mailchimp::API.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
-      assert_raise RuntimeError do
+      Mailchimp::API.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things', 'code' => '254'}.to_json))
+      e = assert_raise Mailchimp::APIError do
         @api.say_hello
       end
+
+      assert_equal 'bad things', e.error
+      assert_equal '254', e.code
     end
+
     should 'allow one to check api key validity' do
       Mailchimp::API.stubs(:post).returns(Struct.new(:body).new(%q{"Everything's Chimpy!"}.to_json))
       assert_equal true, @api.valid_api_key?

data/test/lib/export_test.rb

@@ -21,23 +21,24 @@ class ExportTest < Test::Unit::TestCase
     end
 
     should "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
-      Mailchimp::Export.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things'}.to_json))
+      Mailchimp::Export.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things', 'code' => '123'}.to_json))
 
       assert_nothing_raised do
         @api.say_hello(@body)
       end
     end
-=begin #pending throw exception decision
+
     should "throw exception if configured to and the Export API replies with a JSON hash containing a key called 'error'" do
       @api.throws_exceptions = true
       params = {:body => @body, :timeout => nil}
       Mailchimp::Export.stubs(:post).returns(Struct.new(:body).new({'error' => 'bad things', 'code' => '123'}.to_json))
 
-      assert_raise RuntimeError do
+      e = assert_raise Mailchimp::APIError do
         @api.say_hello(@body)
       end
+      assert_equal 'bad things', e.error
+      assert_equal '123', e.code
     end
-=end
   end
   private
 
@@ -49,4 +50,4 @@ class ExportTest < Test::Unit::TestCase
     end.returns(Struct.new(:body).new("") )
   end
 
-end
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: mailchimp
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
 - Chris Kelly
+- Dave Worth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-18 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70361207201980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70361207201980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ruby-debug19
-  requirement: &70361207201240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +38,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361207201240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70361207200740 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361207200740
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70361207200240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +70,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361207200240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70361207199720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +86,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361207199720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &70361207199260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +102,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361207199260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70361207198760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +118,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70361207198760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This provides Ruby access to (eventually) all of Mailchimp's APIs
 email:
-- chris@highgroove.com
+- dave@bignerdranch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -109,6 +145,7 @@ files:
 - examples/sts_example.rb
 - lib/mailchimp.rb
 - lib/mailchimp/api.rb
+- lib/mailchimp/api_error.rb
 - lib/mailchimp/base.rb
 - lib/mailchimp/export.rb
 - lib/mailchimp/ext/httparty.rb
@@ -120,7 +157,6 @@ files:
 - mailchimp.gemspec
 - test/integration/api_test.rb
 - test/integration/base_test.rb
-- test/integration/export_test.rb
 - test/integration/mandrill_test.rb
 - test/integration/sts_test.rb
 - test/lib/api_test.rb
@@ -150,14 +186,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mailchimp
-rubygems_version: 1.8.17
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Mailchimp APIs in Ruby
 test_files:
 - test/integration/api_test.rb
 - test/integration/base_test.rb
-- test/integration/export_test.rb
 - test/integration/mandrill_test.rb
 - test/integration/sts_test.rb
 - test/lib/api_test.rb

data/test/integration/export_test.rb

@@ -1,34 +0,0 @@
-require 'test_helper'
-
-class ExportIntegrationTest < Test::Unit::TestCase
-  
-  should "send request List Data from the Mailchimp Export API" do
-    
-    FakeWeb.register_uri(
-      :post,
-      'http://us2.api.mailchimp.com/export/1.0/list/',
-      body: '["Email Address","First Name","Last Name","Salesforce ID","EMAIL_TYPE","MEMBER_RATING","OPTIN_TIME","OPTIN_IP","CONFIRM_TIME","CONFIRM_IP","LATITUDE","LONGITUDE","GMTOFF","DSTOFF","TIMEZONE","CC","REGION","LAST_CHANGED"]
-["highgroove@example.com","Daniel","Rice","00Qd0000005MKaEEAW","html",2,"2011-10-06 20:06:46","173.160.74.121","2011-10-06 20:07:28","173.160.74.121","33.7490000","-84.3880000","-5","-4","America\/Kentucky\/Monticello","US","GA","2012-03-12 17:45:18"]
-["chimpy@example.com","Daniel","Rice","00Qd0000006AjjtEAC","html",2,"",null,"2012-03-08 20:52:31","173.160.74.121",null,null,null,null,null,null,null,"2012-03-12 17:45:20"]
-["wolfbrain@example.com","George P","Burdell","00Qd0000006AjjuEAC","html",2,"",null,"2012-03-08 20:53:10","173.160.74.121",null,null,null,null,null,null,null,"2012-03-12 17:45:22"]'
-    )
-    
-    m = Mailchimp::Export.new('abc123-us2')
-    response = m.list(:id => 'xxxxxxxx')
-    
-    assert_kind_of Enumerator, response
-    
-  end
-  
-  should "get campaign subscriber activity" do
-
-    FakeWeb.register_uri(
-      :post,
-      'http://us2.api.mailchimp.com/export/1.0/campaignSubscriberActivity/',
-      body: '{"highgroove@example.com":[{"action":"open","timestamp":"2012-03-12 20:14:17","url":null,"ip":"184.77.22.196"}]} {"wolfbrain@example.com":[{"action":"open","timestamp":"2012-03-12 20:14:20","url":null,"ip":"184.77.22.196"}]}'.to_json
-    )
-    response = Mailchimp::Export.new('abc123-us2').campaign_subscriber_activity(:id => 'xxxxxxxx')
-    
-    assert_kind_of Enumerator, response
-  end
-end