gibbon 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34d4b58a97f16a89c75bf58613f549aa65254a06
-  data.tar.gz: e8daf0d12e8f4d180eece626ad64a0740a1a2fb3
+  metadata.gz: 5863ce163571867687599035a3efb7ae64f0be27
+  data.tar.gz: bc2afd9c27b43999b3fae7e20332af73945305f1
 SHA512:
-  metadata.gz: 7b627afea51e05ed36a958982ce2e0cdfab1f8abc013e36dc12850da2c8d05fb37218fa44d90dd97864e9e0daa182ee4c3bb68d704e04f2e46f65929348fbdc8
-  data.tar.gz: 4b9c3d6718612ba070dd15d156794fde5324d6b9c2717e02e3f5315f519710be6f65f8d0f85c0fd4c33725396bce2f0d2e94fc73dffdce866f58f1153a60f672
+  metadata.gz: 6cd38d270b357e015498fb881e2556efb4ea89e1926ef1c81dbb6072eb825d0632b51cd3ce6877465e9daa330f412bcb5f67246185c28e6b05141a898abedb8a
+  data.tar.gz: 3c3f56bdbb3654b366ed4ea557f07a7ed986611638a4e679cd312778f461938d3c65478b7fdadcd8e41cc92dd0b020eaed28cc1d1d34c36f36098b1c611843c5

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+before_install: gem install bundler -v 1.5.1
 rvm:
   - 1.9.3
   - 2.0.0

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 platforms :rbx do
   gem 'rubysl', '~> 2.0'

data/README.markdown

@@ -11,7 +11,7 @@ Gibbon now targets MailChimp API 2.0, which is substantially different from API
 * Supports MailChimp API 2.0 and Export API 1.0
 * Errors are raised by default since 0.4.x
 * Timeouts can be specified per request during initialization
-* Ruby 1.9.x+ for now. A future version may be Ruby 2.0 only to take advantage of lazy iteration when using the Export API.
+* 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
 
@@ -34,13 +34,13 @@ You can set `api_key`, `timeout` and `throws_exceptions` globally:
     Gibbon::API.api_key = "your_api_key"
     Gibbon::API.timeout = 15
     Gibbon::API.throws_exceptions = false
-		
+
 similarly
 
     Gibbon::Export.api_key = "your_api_key"
     Gibbon::Export.timeout = 15
     Gibbon::Export.throws_exceptions = false
-    
+
 For example, you could set the values above in an `initializer` file in your `Rails` app (e.g. your\_app/config/initializers/gibbon.rb).
 
 Assuming you've set an `api_key` on Gibbon, you can conveniently make API calls on the class itself:
@@ -97,6 +97,10 @@ Subscribe a member to a list:
 
 > Note: This will send a welcome email to the new subscriber
 
+Here's an example showing pagination. The following code fetches the first page of 100 members subscribed to your list:
+
+    gb.lists.members({:id => list_id, :opts => {:start => 0, :limit => 100}})
+
 or
 
 Batch subscribe members to a list:
@@ -108,15 +112,15 @@ Batch subscribe members to a list:
 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"}, :merge_vars => {:FNAME => "FirstName1", :LNAME => "LastName1"}}], :update_existing => true)
-    
+
 > 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.    
- 
+
+> 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})
@@ -164,8 +168,8 @@ at the bottom of each page. Here's how you might do that:
 
 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 
+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.

data/gibbon.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "gibbon"
-  s.version     = "1.1.1"
+  s.version     = "1.1.2"
   s.authors     = ["Amro Mousa"]
   s.email       = ["amromousa@gmail.com"]
   s.homepage    = "http://github.com/amro/gibbon"

data/lib/gibbon.rb

@@ -2,6 +2,7 @@ require 'httparty'
 require 'multi_json'
 require 'cgi'
 
+require 'gibbon/gibbon_error'
 require 'gibbon/mailchimp_error'
 require 'gibbon/api_category'
 require 'gibbon/api'

data/lib/gibbon/api_category.rb

@@ -20,6 +20,8 @@ module Gibbon
     end
 
     def call(method, params = {})
+      ensure_api_key params
+
       api_url = base_api_url + method
       params = @default_params.merge(params).merge({:apikey => @api_key})
       headers = params.delete(:headers) || {}
@@ -88,5 +90,14 @@ module Gibbon
 
       data_center
     end
+
+
+    private
+
+    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"
+      end
+    end
   end
 end

data/lib/gibbon/export.rb

@@ -15,6 +15,8 @@ module Gibbon
     end
 
     def call(method, params = {})
+      ensure_api_key params
+
       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)
@@ -57,6 +59,15 @@ module Gibbon
       %w{list ecommOrders ecomm_orders campaignSubscriberActivity campaign_subscriber_activity}.include?(method.to_s) || super
     end
 
+
+    private
+
+    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"
+      end
+    end
+
     class << self
       attr_accessor :api_key, :timeout, :throws_exceptions
 

data/lib/gibbon/gibbon_error.rb

@@ -0,0 +1,3 @@
+module Gibbon
+  class GibbonError < StandardError; end
+end

data/spec/gibbon/gibbon_spec.rb

@@ -57,9 +57,8 @@ describe Gibbon do
       @url = "https://api.mailchimp.com/2.0/say/hello"
     end
 
-    it "handle empty api key" do
-      expect_post(@url, {"apikey" => nil})
-      @gibbon.say.hello
+    it "doesn't allow empty api key" do
+      expect {@gibbon.say.hello}.to raise_error(Gibbon::GibbonError)
     end
 
     it "handle malformed api key" do
@@ -70,7 +69,8 @@ describe Gibbon do
     end
 
     it "handle timeout" do
-      expect_post(@url, {"apikey" => nil}, 120)
+      expect_post(@url, {"apikey" => 'test'}, 120)
+      @gibbon.api_key = 'test'
       @gibbon.timeout=120
       @gibbon.say.hello
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gibbon
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Amro Mousa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-03 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -85,6 +85,7 @@ files:
 - lib/gibbon/api.rb
 - lib/gibbon/api_category.rb
 - lib/gibbon/export.rb
+- lib/gibbon/gibbon_error.rb
 - lib/gibbon/mailchimp_error.rb
 - spec/gibbon/gibbon_spec.rb
 - spec/spec_helper.rb
@@ -111,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: gibbon
-rubygems_version: 2.2.0
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: A wrapper for MailChimp API 2.0 and Export API 1.0