gibbon 1.0.4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 179ae4117301bfcbfb7d78011c395df230568bb2
-  data.tar.gz: bd2ffd6e9f3ae5d5fef1f739589645440856f3a5
+  metadata.gz: 34d4b58a97f16a89c75bf58613f549aa65254a06
+  data.tar.gz: e8daf0d12e8f4d180eece626ad64a0740a1a2fb3
 SHA512:
-  metadata.gz: 08d20f09120b756973c4bc271618f373898c0f24e0825e008057c2fafa41a8d06134ae57ed73951e7fbc986f3daeadde639136274819f3214bec15954a0e68ba
-  data.tar.gz: 393e9e3796276fcb4164292eadc9080bc919302093e0e5dad5d85762051ac39eb7b50e180619db3ee2f41566fbe9b064a56207c42e59966c4c14a9d1865cac6d
+  metadata.gz: 7b627afea51e05ed36a958982ce2e0cdfab1f8abc013e36dc12850da2c8d05fb37218fa44d90dd97864e9e0daa182ee4c3bb68d704e04f2e46f65929348fbdc8
+  data.tar.gz: 4b9c3d6718612ba070dd15d156794fde5324d6b9c2717e02e3f5315f519710be6f65f8d0f85c0fd4c33725396bce2f0d2e94fc73dffdce866f58f1153a60f672

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1.0
+  - jruby-19mode
+  - rbx

data/Gemfile

@@ -1,3 +1,8 @@
 source "http://rubygems.org"
 
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end
+
 gemspec

data/LICENSE.txt

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

@@ -3,9 +3,8 @@
 Gibbon is an API wrapper for MailChimp's [Primary and Export APIs](http://www.mailchimp.com/api).
 
 [![Build Status](https://secure.travis-ci.org/amro/gibbon.png)](http://travis-ci.org/amro/gibbon)
-
-##Important Notes About Version 0.5.0+
-### (It's different!)
+[![Dependency Status](https://gemnasium.com/amro/gibbon.png)](https://gemnasium.com/amro/gibbon)
+##Important Notes
 
 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.
 
@@ -80,7 +79,7 @@ Or, to fetch a list by name:
 
 Getting batch member information for subscribers looks like this:
 
-    info = gb.lists.member_info({:id => list_id, :emails => email_array})
+    info = gb.lists.member_info({:id => list_id, :emails => [{:email => email_1}, {:email => email_2}]})
 
 List subscribers for a list:
 
@@ -102,16 +101,22 @@ or
 
 Batch subscribe members to a list:
 
-    gb.lists.batch_subscribe(:id => list_id, :batch => [{:EMAIL => {:email => "email1"}, :FNAME => "FirstName1", :LNAME => "LastName1"},{:EMAIL => {:email =>"email2"}, :FNAME => "FirstName2", :LNAME => "LastName2"}])
+    gb.lists.batch_subscribe(:id => list_id, :batch => [{:email => {:email => "email1"}, :merge_vars => {:FNAME => "FirstName1", :LNAME => "LastName1"}},{:email => {:email =>"email2"}, :merge_vars => {:FNAME => "FirstName2", :LNAME => "LastName2"}}])
 
 > Note: This will send welcome emails to the new subscribers
 
 If you want to update the existing members you need to send the boolean update_existing in true
 
-    gb.lists.batch_subscribe(:id => list_id, :batch => [{:EMAIL => {:email => "email1"}, :FNAME => "FirstName1", :LNAME => "LastName1"}], :update_existing => true)
+    gb.lists.batch_subscribe(:id => list_id, :batch => [{:email => {:email => "email1"}, :merge_vars => {:FNAME => "FirstName1", :LNAME => "LastName1"}}], :update_existing => true)
     
-> On :EMAIL you can send the :euid (the unique id for an email address) or the :leid (the list email id) too, instead :email.
+> Note: The `email` hash can also accept either a unique email id or a list email id. Please see the [lists/batch-subscribe](http://apidocs.mailchimp.com/api/2.0/lists/batch-subscribe.php) documentation for more information.
+
+You can also unsubscribe a member from a list:
 
+    gb.lists.unsubscribe(:id => list_id, :email => {:email => "user_email"}, :delete_member => true, :send_notify => true)
+    
+> Note: :delete_member defaults to false, meaning the member stays on your mailchimp list as "unsubscribed".  See [Api Docs](http://apidocs.mailchimp.com/api/2.0/lists/unsubscribe.php) for details of options.    
+ 
 Fetch recipients who opened particular campaign:
 
     email_stats = gb.reports.opened({:cid => campaign_id})
@@ -148,7 +153,20 @@ information about the error, and "code", the numeric code of the error.
 
 If you rescue Gibbon::MailChimpError, you are provided with the error message itself as well as
 a `code` attribute that you can map onto the API's error list. The API docs list possible errors
-at the bottom of each page.
+at the bottom of each page. Here's how you might do that:
+
+    begin
+      g.lists.subscribe(...)
+    rescue Gibbon::MailChimpError => e
+      # do something with e.message here
+      # do something wiht e.code here
+    end
+
+Some API endpoints, like `[lists/batch-subscribe](http://apidocs.mailchimp.com/api/2.0/lists/batch-subscribe.php)`
+return errors to let you know that some of your actions failed, but some suceeded. Gibbon will not
+raise Gibbon::MailChimpError for these endpoints because the key for the success count varies from endpoint to endpoint. 
+This makes it difficult to determine whether all of your actions failed in a generic way. **Because of this, you're responsible 
+for checking the response body for the `errors` array in these cases.**
 
 > Note: In an effort to make Gibbon easier to use, errors are raised automatically as of version 0.4.0.
 
@@ -174,9 +192,9 @@ For example, dumping list members via the "list" method works like this:
 
 ##Thanks
 
-Thanks to everyone who's [contributed](https://github.com/amro/gibbon/contributors) to Gibbon's development. Major props to Jesse at MailChimp for adding nice stuff in API 2.0 that makes it easier to develop against.
+Thanks to everyone who's [contributed](https://github.com/amro/gibbon/contributors) to Gibbon's development. Major props to The Viking for making MailChimp API 2.0 great.
 
 ##Copyright
 
-* Copyright (c) 2010-2013 Amro Mousa. See LICENSE.txt for details.
-* MailChimp (c) 2001-2013 The Rocket Science Group.
+* Copyright (c) 2010-2014 Amro Mousa. See LICENSE.txt for details.
+* MailChimp (c) 2001-2014 The Rocket Science Group.

data/gibbon.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "gibbon"
-  s.version     = "1.0.4"
+  s.version     = "1.1.1"
   s.authors     = ["Amro Mousa"]
   s.email       = ["amromousa@gmail.com"]
   s.homepage    = "http://github.com/amro/gibbon"
@@ -26,6 +26,6 @@ Gem::Specification.new do |s|
   s.add_dependency('multi_json', '>= 1.3.4')
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency "rspec", "~> 2.13.0"
+  s.add_development_dependency "rspec", ">= 2.14.1"
 
 end

data/lib/gibbon/api.rb

@@ -23,6 +23,10 @@ module Gibbon
       api
     end
 
+    def respond_to_missing?(method, include_private = false)
+      %w{campaigns ecomm folders gallery lists helper reports templates users vip}.include?(method.to_s) || super
+    end
+
     class << self
       attr_accessor :api_key, :timeout, :throws_exceptions, :api_endpoint
 

data/lib/gibbon/api_category.rb

@@ -22,7 +22,8 @@ module Gibbon
     def call(method, params = {})
       api_url = base_api_url + method
       params = @default_params.merge(params).merge({:apikey => @api_key})
-      response = self.class.post(api_url, :body => MultiJson.dump(params), :timeout => @timeout)
+      headers = params.delete(:headers) || {}
+      response = self.class.post(api_url, :body => MultiJson.dump(params), :headers => headers, :timeout => @timeout)
 
       parsed_response = nil
 
@@ -30,7 +31,7 @@ module Gibbon
         parsed_response = MultiJson.load(response.body)
 
         if should_raise_for_response?(parsed_response)
-          error = MailChimpError.new("MailChimp API Error: #{parsed_response["error"]} (code #{parsed_response["code"]})")
+          error = MailChimpError.new(parsed_response["error"])
           error.code = parsed_response["code"]
           raise error
         end

data/lib/gibbon/export.rb

@@ -24,7 +24,7 @@ module Gibbon
         first_line = MultiJson.load(lines.first) if lines.first
 
         if should_raise_for_response?(first_line)
-          error = MailChimpError.new("MailChimp Export API Error: #{first_line["error"]} (code #{first_line["code"]})")
+          error = MailChimpError.new(first_line["error"])
           error.code = first_line["code"]
           raise error
         end
@@ -53,6 +53,10 @@ module Gibbon
       call(method, *args)
     end
 
+    def respond_to_missing?(method, include_private = false)
+      %w{list ecommOrders ecomm_orders campaignSubscriberActivity campaign_subscriber_activity}.include?(method.to_s) || super
+    end
+
     class << self
       attr_accessor :api_key, :timeout, :throws_exceptions
 

data/spec/gibbon/gibbon_spec.rb

@@ -158,6 +158,19 @@ describe Gibbon do
       expect_post(@url, @body.merge("fee" => 99))
       @gibbon.say.hello(:fee => 99)
     end
+    
+    it "pass through http header settings" do
+      @gibbon.timeout=30
+      expect_post(@url, @body.merge("messages" => 'Simon says'), @gibbon.timeout, {'Accept-Language' => 'en'})
+      @gibbon.say.hello(:messages => 'Simon says', :headers => {'Accept-Language' => 'en'} )
+    end
+    
+    it "with http headers not set" do
+      @gibbon.timeout=30
+      expect_post(@url, @body.merge("messages" => 'Simon says'), @gibbon.timeout, {})
+      @gibbon.say.hello(:messages => 'Simon says' )
+    end
+    
   end
 
   describe "Gibbon instances" do
@@ -176,24 +189,24 @@ describe Gibbon do
 
     it "not throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = false
-      Gibbon::APICategory.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
 
       @gibbon.say.hello
     end
 
     it "throw exception if configured to and the API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = true
-      Gibbon::APICategory.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
       expect {@gibbon.say.hello}.to raise_error(Gibbon::MailChimpError)
     end
 
     it "not raise exception if the api returns no response body" do
-      Gibbon::APICategory.stub(:post).and_return(Struct.new(:body).new(nil))
+      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(nil))
       expect(@gibbon.say.hello).to be_nil
     end
 
     it "can send a campaign" do
-      Gibbon::APICategory.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({"cid" => "1234567"})))
+      allow(Gibbon::APICategory).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({"cid" => "1234567"})))
       expect(@gibbon.campaigns.send({"cid" => "1234567"})).to eq({"cid" => "1234567"})
     end
   end
@@ -215,13 +228,13 @@ describe Gibbon do
       params = {:body => MultiJson.dump(@body), :timeout => 30}
 
       url = @url.gsub('us1', 'us2') + "sayHello/"
-      Gibbon::Export.should_receive(:post).with(url, params).and_return(@returns)
+      expect(Gibbon::Export).to receive(:post).with(url, params).and_return(@returns)
       @gibbon.say_hello(@body)
     end
 
     it "not throw exception if the Export API replies with a JSON hash containing a key called 'error'" do
       @gibbon.throws_exceptions = false
-      Gibbon::Export.stub(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
+      allow(Gibbon::Export).to receive(:post).and_return(Struct.new(:body).new(MultiJson.dump({'error' => 'bad things'})))
 
       @gibbon.say_hello(@body)
     end
@@ -230,7 +243,7 @@ describe Gibbon do
       @gibbon.throws_exceptions = true
       params = {:body => @body, :timeout => 30}
       reply = Struct.new(:body).new MultiJson.dump({'error' => 'bad things', 'code' => '123'})
-      Gibbon::Export.stub(:post).and_return reply
+      allow(Gibbon::Export).to receive(:post).and_return reply
 
       expect {@gibbon.say_hello(@body)}.to raise_error(Gibbon::MailChimpError)
     end
@@ -239,12 +252,13 @@ describe Gibbon do
 
   private
 
-  def expect_post(expected_url, expected_body, expected_timeout=30)
-    Gibbon::APICategory.should_receive(:post).with do |url, opts|
+  def expect_post(expected_url, expected_body, expected_timeout=30, expected_headers={})
+    expect(Gibbon::APICategory).to receive(:post).with { |url, opts|
       expect(url).to            eq expected_url
       expect(expected_body).to  eq MultiJson.load(URI::decode(opts[:body]))
       expect(opts[:timeout]).to eq expected_timeout
-    end.and_return(Struct.new(:body).new("[]"))
+      expect(opts[:headers]).to eq expected_headers
+    }.and_return(Struct.new(:body).new("[]"))
   end
 
   # def expect_post(expected_url, expected_body, expected_timeout=30)

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.1
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2014-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.14.1
 description: A wrapper for MailChimp API 2.0 and Export API 1.0
 email:
 - amromousa@gmail.com
@@ -73,9 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .document
-- .gitignore
-- .travis.yml
+- ".document"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.markdown
@@ -101,17 +101,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: gibbon
-rubygems_version: 2.1.2
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A wrapper for MailChimp API 2.0 and Export API 1.0