stripe 1.28.1 → 1.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 083eab18104ef39dd85e2646f9a0a8da259d159d
-  data.tar.gz: 9f1695c23d275adcfef769c577b81865c1739e84
+  metadata.gz: cad15842f509a5f748f5e644a3932ea8b45ae480
+  data.tar.gz: defecc310910f380f32d973ec2c1032b08e85a51
 SHA512:
-  metadata.gz: 1ab0cdfe76978d120847fc213d4cfa5cb0887f5b1d7486471528630a8ff643828962d8620f42700e2ce7f355983ab252a932353bdaa2faf94f9524ac8c22eda9
-  data.tar.gz: d27dabf527fe69329dbf827d9bcab1deb3a4e3cec1fb00e59ffffcc68d414ded73bfa5f2eb8696288d6021cb85bbe537bf27cfb232e09b59a61627b56ca11fca
+  metadata.gz: 0776d66e4e13d87f2b5478e24cd00e4e00c4990bf7cf2f0e652e6f052cb17c7e90c0e4514f8ab7daa485b33751acf79fa11d6a1d5908d5536f2a63d7fdf2fc3a
+  data.tar.gz: 0e1e2e41df59fb7ec775240b279a4bde6087883d37024b6f01794ccdc0ab91aaa100b39c35b06e5f8242f246f9e8d3ff8dd9795ed12ceab9a69404b2dbaca2ea

data/History.txt

@@ -1,6 +1,6 @@
-=== 1.28.1 2015-10-05
+=== 1.29.0 2015-10-05
 
-* DESCRIBE CHANGES HERE (try to use the same style, tense, etc. as the other entries) 
+* Add pagination helpers `#auto_paging_each`, `#previous_page`, and `#next_page`
 
 === 1.28.1 2015-10-05
 

data/VERSION

@@ -1 +1 @@
-1.28.1
+1.29.0

data/lib/stripe/account.rb

@@ -1,8 +1,8 @@
 module Stripe
   class Account < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Update
 
     def url

data/lib/stripe/api_operations/create.rb

@@ -1,15 +1,9 @@
 module Stripe
   module APIOperations
     module Create
-      module ClassMethods
-        def create(params={}, opts={})
-          response, opts = request(:post, url, params, opts)
-          Util.convert_to_stripe_object(response, opts)
-        end
-      end
-
-      def self.included(base)
-        base.extend(ClassMethods)
+      def create(params={}, opts={})
+        response, opts = request(:post, url, params, opts)
+        Util.convert_to_stripe_object(response, opts)
       end
     end
   end

data/lib/stripe/api_operations/list.rb

@@ -1,17 +1,25 @@
 module Stripe
   module APIOperations
     module List
-      module ClassMethods
-        def all(filters={}, opts={})
-          opts = Util.normalize_opts(opts)
-          response, opts = request(:get, url, filters, opts)
-          Util.convert_to_stripe_object(response, opts)
-        end
-      end
+      def list(filters={}, opts={})
+        opts = Util.normalize_opts(opts)
+        opts = @opts.merge(opts) if @opts
+
+        response, opts = request(:get, url, filters, opts)
+        obj = ListObject.construct_from(response, opts)
 
-      def self.included(base)
-        base.extend(ClassMethods)
+        # set a limit so that we can fetch the same number when accessing the
+        # next and previous pages
+        obj.limit = filters[:limit]
+
+        obj
       end
+
+      # The original version of #list was given the somewhat unfortunate name of
+      # #all, and this alias allows us to maintain backward compatibility (the
+      # choice was somewhat misleading in the way that it only returned a single
+      # page rather than all objects).
+      alias :all :list
     end
   end
 end

data/lib/stripe/application_fee.rb

@@ -1,6 +1,6 @@
 module Stripe
   class ApplicationFee < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def self.url
       '/v1/application_fees'

data/lib/stripe/application_fee_refund.rb

@@ -1,7 +1,7 @@
 module Stripe
   class ApplicationFeeRefund < APIResource
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def url
       "#{ApplicationFee.url}/#{CGI.escape(fee)}/refunds/#{CGI.escape(id)}"

data/lib/stripe/balance_transaction.rb

@@ -1,6 +1,6 @@
 module Stripe
   class BalanceTransaction < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def self.url
       '/v1/balance/history'

data/lib/stripe/bank_account.rb

@@ -2,7 +2,7 @@ module Stripe
   class BankAccount < APIResource
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def url
       if respond_to?(:customer)

data/lib/stripe/bitcoin_receiver.rb

@@ -1,9 +1,9 @@
 module Stripe
   class BitcoinReceiver < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def self.url
       "/v1/bitcoin/receivers"

data/lib/stripe/bitcoin_transaction.rb

@@ -1,6 +1,6 @@
 module Stripe
   class BitcoinTransaction < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def self.url
       "/v1/bitcoin/transactions"

data/lib/stripe/card.rb

@@ -2,7 +2,7 @@ module Stripe
   class Card < APIResource
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def url
       if respond_to?(:recipient)

data/lib/stripe/charge.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Charge < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
     def refund(params={}, opts={})

data/lib/stripe/coupon.rb

@@ -1,8 +1,8 @@
 module Stripe
   class Coupon < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
   end
 end

data/lib/stripe/customer.rb

@@ -1,9 +1,9 @@
 module Stripe
   class Customer < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def add_invoice_item(params, opts={})
       opts = @opts.merge(Util.normalize_opts(opts))

data/lib/stripe/dispute.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Dispute < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
     def close(params={}, opts={})

data/lib/stripe/event.rb

@@ -1,5 +1,5 @@
 module Stripe
   class Event < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
   end
 end

data/lib/stripe/file_upload.rb

@@ -1,7 +1,7 @@
 module Stripe
   class FileUpload < APIResource
-    include Stripe::APIOperations::Create
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
 
     def self.url
       "/v1/files"

data/lib/stripe/invoice.rb

@@ -1,8 +1,8 @@
 module Stripe
   class Invoice < APIResource
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
 
     def self.upcoming(params, opts={})
       response, opts = request(:get, upcoming_url, params, opts)

data/lib/stripe/invoice_item.rb

@@ -1,7 +1,7 @@
 module Stripe
   class InvoiceItem < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     include Stripe::APIOperations::Update
   end

data/lib/stripe/list_object.rb

@@ -1,8 +1,21 @@
 module Stripe
   class ListObject < StripeObject
     include Enumerable
+    include Stripe::APIOperations::List
     include Stripe::APIOperations::Request
 
+    # This accessor allows a `ListObject` to inherit a limit that was given to
+    # a predecessor. This allows consistent limits as a user pages through
+    # resources.
+    attr_accessor :limit
+
+    # An empty list object. This is returned from +next+ when we know that
+    # there isn't a next page in order to replicate the behavior of the API
+    # when it attempts to return a page beyond the last.
+    def self.empty_list(opts={})
+      ListObject.construct_from({ :data => [] }, opts)
+    end
+
     def [](k)
       case k
       when String, Symbol
@@ -12,10 +25,32 @@ module Stripe
       end
     end
 
+    # Iterates through each resource in the page represented by the current
+    # `ListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
     def each(&blk)
       self.data.each(&blk)
     end
 
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_page+.
+    def auto_paging_each(&blk)
+      return enum_for(:auto_paging_each) unless block_given?
+
+      page = self
+      loop do
+        page.each(&blk)
+        page = page.next_page
+        break if page.empty?
+      end
+    end
+
     # Returns true if the page object contains no elements.
     def empty?
       self.data.empty?
@@ -32,9 +67,35 @@ module Stripe
       Util.convert_to_stripe_object(response, opts)
     end
 
-    def all(params={}, opts={})
-      response, opts = request(:get, url, params, opts)
-      Util.convert_to_stripe_object(response, opts)
+    # Fetches the next page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def next_page(params={}, opts={})
+      return self.class.empty_list(opts) if !has_more
+      last_id = data.last.id
+
+      params = {
+        :limit          => limit, # may be nil
+        :starting_after => last_id,
+      }.merge(params)
+
+      list(params, opts)
+    end
+
+    # Fetches the previous page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def previous_page(params={}, opts={})
+      first_id = data.first.id
+
+      params = {
+        :ending_before => first_id,
+        :limit         => limit, # may be nil
+      }.merge(params)
+
+      list(params, opts)
     end
   end
 end

data/lib/stripe/order.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Order < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
     def pay(params, opts={})

data/lib/stripe/plan.rb

@@ -1,8 +1,8 @@
 module Stripe
   class Plan < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Update
   end
 end

data/lib/stripe/product.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Product < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
     # Keep APIResource#url as `api_url` to avoid letting the external URL

data/lib/stripe/recipient.rb

@@ -1,9 +1,9 @@
 module Stripe
   class Recipient < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def transfers
       Transfer.all({ :recipient => id }, @api_key)

data/lib/stripe/refund.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Refund < APIResource
-    include Stripe::APIOperations::Create
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Update
   end
 end

data/lib/stripe/reversal.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Reversal < APIResource
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::List
+    extend Stripe::APIOperations::List
 
     def url
       "#{Transfer.url}/#{CGI.escape(transfer)}/reversals/#{CGI.escape(id)}"

data/lib/stripe/sku.rb

@@ -1,7 +1,7 @@
 module Stripe
   class SKU < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
   end

data/lib/stripe/stripe_object.rb

@@ -25,6 +25,13 @@ module Stripe
       self.new(values[:id]).refresh_from(values, opts)
     end
 
+    # Determines the equality of two Stripe objects. Stripe objects are
+    # considered to be equal if they have the same set of values and each one
+    # of those values is the same.
+    def ==(other)
+      @values == other.instance_variable_get(:@values)
+    end
+
     def to_s(*args)
       JSON.pretty_generate(@values)
     end

data/lib/stripe/token.rb

@@ -1,5 +1,5 @@
 module Stripe
   class Token < APIResource
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::Create
   end
 end

data/lib/stripe/transfer.rb

@@ -1,7 +1,7 @@
 module Stripe
   class Transfer < APIResource
-    include Stripe::APIOperations::List
-    include Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Update
 
     def cancel

data/lib/stripe/version.rb

@@ -1,3 +1,3 @@
 module Stripe
-  VERSION = '1.28.1'
+  VERSION = '1.29.0'
 end

data/test/stripe/api_resource_test.rb

@@ -39,10 +39,10 @@ module Stripe
 
     should "using a nil api key should raise an exception" do
       assert_raises TypeError do
-        Stripe::Customer.all({}, nil)
+        Stripe::Customer.list({}, nil)
       end
       assert_raises TypeError do
-        Stripe::Customer.all({}, { :api_key => nil })
+        Stripe::Customer.list({}, { :api_key => nil })
       end
     end
 
@@ -231,17 +231,17 @@ module Stripe
       should "urlencode values in GET params" do
         response = make_response(make_charge_array)
         @mock.expects(:get).with("#{Stripe.api_base}/v1/charges?customer=test%20customer", nil, nil).returns(response)
-        charges = Stripe::Charge.all(:customer => 'test customer').data
+        charges = Stripe::Charge.list(:customer => 'test customer').data
         assert charges.kind_of? Array
       end
 
       should "construct URL properly with base query parameters" do
         response = make_response(make_invoice_customer_array)
         @mock.expects(:get).with("#{Stripe.api_base}/v1/invoices?customer=test_customer", nil, nil).returns(response)
-        invoices = Stripe::Invoice.all(:customer => 'test_customer')
+        invoices = Stripe::Invoice.list(:customer => 'test_customer')
 
         @mock.expects(:get).with("#{Stripe.api_base}/v1/invoices?customer=test_customer&paid=true", nil, nil).returns(response)
-        invoices.all(:paid => true)
+        invoices.list(:paid => true)
       end
 
       should "a 400 should give an InvalidRequestError with http status, body, and JSON body" do
@@ -311,7 +311,7 @@ module Stripe
           (url =~ %r{^#{Stripe.api_base}/v1/charges?} &&
            query.keys.sort == ['offset', 'sad'])
         end.returns(make_response({ :count => 1, :data => [make_charge] }))
-        Stripe::Charge.all(:count => nil, :offset => 5, :sad => false)
+        Stripe::Charge.list(:count => nil, :offset => 5, :sad => false)
 
         @mock.expects(:post).with do |url, api_key, params|
           url == "#{Stripe.api_base}/v1/charges" &&
@@ -335,8 +335,9 @@ module Stripe
 
       should "making a GET request with parameters should have a query string and no body" do
         params = { :limit => 1 }
-        @mock.expects(:get).once.with("#{Stripe.api_base}/v1/charges?limit=1", nil, nil).returns(make_response([make_charge]))
-        Stripe::Charge.all(params)
+        @mock.expects(:get).once.with("#{Stripe.api_base}/v1/charges?limit=1", nil, nil).
+          returns(make_response({ :data => [make_charge] }))
+        Stripe::Charge.list(params)
       end
 
       should "making a POST request with parameters should have a body and no query string" do
@@ -407,7 +408,7 @@ module Stripe
 
       should "loading all of an APIResource should return an array of recursively instantiated objects" do
         @mock.expects(:get).once.returns(make_response(make_charge_array))
-        c = Stripe::Charge.all.data
+        c = Stripe::Charge.list.data
         assert c.kind_of? Array
         assert c[0].kind_of? Stripe::Charge
         assert c[0].card.kind_of?(Stripe::StripeObject) && c[0].card.object == 'card'

data/test/stripe/application_fee_test.rb

@@ -4,7 +4,7 @@ module Stripe
   class ApplicationFeeTest < Test::Unit::TestCase
     should "application fees should be listable" do
       @mock.expects(:get).once.returns(make_response(make_application_fee_array))
-      fees = Stripe::ApplicationFee.all
+      fees = Stripe::ApplicationFee.list
       assert fees.data.kind_of? Array
       fees.each do |fee|
         assert fee.kind_of?(Stripe::ApplicationFee)

data/test/stripe/bitcoin_receiver_test.rb

@@ -16,7 +16,7 @@ module Stripe
 
     should "all should list bitcoin receivers" do
       @mock.expects(:get).once.returns(make_response(make_bitcoin_receiver_array))
-      receivers = Stripe::BitcoinReceiver.all
+      receivers = Stripe::BitcoinReceiver.list
       assert_equal 3, receivers.data.length
       assert receivers.data.kind_of? Array
       receivers.each do |receiver|
@@ -31,7 +31,7 @@ module Stripe
       @mock.expects(:get).with("#{Stripe.api_base}/v1/bitcoin/receivers/btcrcv_test_receiver", nil, nil).once.returns(make_response(make_bitcoin_receiver))
       receiver = Stripe::BitcoinReceiver.retrieve('btcrcv_test_receiver')
       @mock.expects(:get).with("#{Stripe.api_base}/v1/bitcoin/receivers/btcrcv_test_receiver/transactions", nil, nil).once.returns(make_response(make_bitcoin_transaction_array))
-      transactions = receiver.transactions.all
+      transactions = receiver.transactions.list
       assert_equal(3, transactions.data.length)
     end
 

data/test/stripe/bitcoin_transaction_test.rb

@@ -18,7 +18,7 @@ module Stripe
         with("#{Stripe.api_base}/v1/bitcoin/transactions", nil, nil).
         once.
         returns(make_response(make_bitcoin_transaction_array))
-      transactions = Stripe::BitcoinTransaction.all
+      transactions = Stripe::BitcoinTransaction.list
       assert_equal 3, transactions.data.length
       assert transactions.data.kind_of? Array
       transactions.each do |transaction|

data/test/stripe/charge_test.rb

@@ -4,7 +4,7 @@ module Stripe
   class ChargeTest < Test::Unit::TestCase
     should "charges should be listable" do
       @mock.expects(:get).once.returns(make_response(make_charge_array))
-      c = Stripe::Charge.all
+      c = Stripe::Charge.list
       assert c.data.kind_of? Array
       c.each do |charge|
         assert charge.kind_of?(Stripe::Charge)

data/test/stripe/customer_card_test.rb

@@ -12,7 +12,7 @@ module Stripe
     should "customer cards should be listable" do
       c = customer
       @mock.expects(:get).once.returns(make_response(make_customer_card_array(customer.id)))
-      cards = c.sources.all(:object => "card").data
+      cards = c.sources.list(:object => "card").data
       assert cards.kind_of? Array
       assert cards[0].kind_of? Stripe::Card
     end

data/test/stripe/customer_test.rb

@@ -4,7 +4,7 @@ module Stripe
   class CustomerTest < Test::Unit::TestCase
     should "customers should be listable" do
       @mock.expects(:get).once.returns(make_response(make_customer_array))
-      c = Stripe::Customer.all.data
+      c = Stripe::Customer.list.data
       assert c.kind_of? Array
       assert c[0].kind_of? Stripe::Customer
     end

data/test/stripe/dispute_test.rb

@@ -10,7 +10,7 @@ module Stripe
 
     should "disputes should be listable" do
       @mock.expects(:get).once.returns(make_response(make_dispute_array))
-      d = Stripe::Dispute.all
+      d = Stripe::Dispute.list
       assert d.data.kind_of? Array
       d.each do |dispute|
         assert dispute.kind_of?(Stripe::Dispute)

data/test/stripe/file_upload_test.rb

@@ -31,7 +31,7 @@ module Stripe
         with("#{Stripe.uploads_base}/v1/files", nil, nil).
         returns(make_response(make_file_array))
 
-      c = Stripe::FileUpload.all.data
+      c = Stripe::FileUpload.list.data
       assert c.kind_of? Array
       assert c[0].kind_of? Stripe::FileUpload
     end

data/test/stripe/list_object_test.rb

@@ -2,6 +2,123 @@ require File.expand_path('../../test_helper', __FILE__)
 
 module Stripe
   class ListObjectTest < Test::Unit::TestCase
+    should "provide .empty_list" do
+      list = Stripe::ListObject.empty_list
+      assert list.empty?
+    end
+
+    should "provide #count via enumerable" do
+      list = Stripe::ListObject.construct_from(make_charge_array)
+      assert_equal 3, list.count
+    end
+
+    should "provide #each" do
+      arr = [
+        { :id => 1 },
+        { :id => 2 },
+        { :id => 3 },
+      ]
+      expected = Util.convert_to_stripe_object(arr, {})
+      list = Stripe::ListObject.construct_from({ :data => arr })
+      assert_equal expected, list.each.to_a
+    end
+
+    should "provide #auto_paging_each" do
+      arr = [
+        { :id => 1 },
+        { :id => 2 },
+        { :id => 3 },
+      ]
+      expected = Util.convert_to_stripe_object(arr, {})
+
+      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      @mock.expects(:get).once.with("#{Stripe.api_base}/things?starting_after=1", nil, nil).
+        returns(make_response({ :data => [{ :id => 2 }, { :id => 3}], :has_more => false }))
+
+      assert_equal expected, list.auto_paging_each.to_a
+    end
+
+    should "provide #auto_paging_each that responds to a block" do
+      arr = [
+        { :id => 1 },
+        { :id => 2 },
+        { :id => 3 },
+      ]
+      expected = Util.convert_to_stripe_object(arr, {})
+
+      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      @mock.expects(:get).once.with("#{Stripe.api_base}/things?starting_after=1", nil, nil).
+        returns(make_response({ :data => [{ :id => 2 }, { :id => 3}], :has_more => false }))
+
+      actual = []
+      list.auto_paging_each do |obj|
+        actual << obj
+      end
+
+      assert_equal expected, actual
+    end
+
+    should "provide #empty?" do
+      list = Stripe::ListObject.construct_from({ :data => [] })
+      assert list.empty?
+      list = Stripe::ListObject.construct_from({ :data => [{}] })
+      refute list.empty?
+    end
+
+    #
+    # next_page
+    #
+
+    should "fetch a next page through #next_page" do
+      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      @mock.expects(:get).once.with("#{Stripe.api_base}/things?starting_after=1", nil, nil).
+        returns(make_response({ :data => [{ :id => 2 }], :has_more => false }))
+      next_list = list.next_page
+      refute next_list.empty?
+    end
+
+    should "fetch a next page through #next_page and respect limit" do
+      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => true })
+      list.limit = 3
+      @mock.expects(:get).once.with("#{Stripe.api_base}/things?limit=3&starting_after=1", nil, nil).
+        returns(make_response({ :data => [{ :id => 2 }], :has_more => false }))
+      next_list = list.next_page
+      assert_equal 3, next_list.limit
+    end
+
+    should "fetch an empty page through #next_page" do
+      list = TestListObject.construct_from({ :data => [{ :id => 1 }], :has_more => false })
+      next_list = list.next_page
+      assert_equal Stripe::ListObject.empty_list, next_list
+    end
+
+    #
+    # previous_page
+    #
+
+    should "fetch a next page through #previous_page" do
+      list = TestListObject.construct_from({ :data => [{ :id => 2 }] })
+      @mock.expects(:get).once.with("#{Stripe.api_base}/things?ending_before=2", nil, nil).
+        returns(make_response({ :data => [{ :id => 1 }] }))
+      next_list = list.previous_page
+      refute next_list.empty?
+    end
+
+    should "fetch a next page through #previous_page and respect limit" do
+      list = TestListObject.construct_from({ :data => [{ :id => 2 }] })
+      list.limit = 3
+      @mock.expects(:get).once.with("#{Stripe.api_base}/things?ending_before=2&limit=3", nil, nil).
+        returns(make_response({ :data => [{ :id => 1 }] }))
+      next_list = list.previous_page
+      assert_equal 3, next_list.limit
+    end
+
+    #
+    # backward compatibility
+    #
+
+    # note that the name #all is deprecated, as is using it fetch the next page
+    # in a list
     should "be able to retrieve full lists given a listobject" do
       @mock.expects(:get).twice.returns(make_response(make_charge_array))
       c = Stripe::Charge.all
@@ -12,19 +129,12 @@ module Stripe
       assert_equal('/v1/charges', all.url)
       assert all.data.kind_of?(Array)
     end
+  end
+end
 
-    should "provide #empty?" do
-      object = Stripe::ListObject.construct_from({ :data => [] })
-      assert object.empty?
-      object = Stripe::ListObject.construct_from({ :data => [{}] })
-      refute object.empty?
-    end
-
-    should "provide enumerable functionality" do
-      @mock.expects(:get).once.returns(make_response(make_charge_array))
-      c = Stripe::Charge.all
-      assert c.kind_of?(Stripe::ListObject)
-      assert_equal 3, c.count
-    end
+# A helper class with a URL that allows us to try out pagination.
+class TestListObject < Stripe::ListObject
+  def url
+    "/things"
   end
 end

data/test/stripe/order_test.rb

@@ -4,7 +4,7 @@ module Stripe
   class OrderTest < Test::Unit::TestCase
     should "orders should be listable" do
       @mock.expects(:get).once.returns(make_response(make_order_array))
-      orders = Stripe::Order.all
+      orders = Stripe::Order.list
       assert orders.data.kind_of?(Array)
       orders.each do |order|
         assert order.kind_of?(Stripe::Order)

data/test/stripe/product_test.rb

@@ -4,7 +4,7 @@ module Stripe
   class ProductTest < Test::Unit::TestCase
     should "products should be listable" do
       @mock.expects(:get).once.returns(make_response(make_product_array))
-      products = Stripe::Product.all
+      products = Stripe::Product.list
       assert products.data.kind_of?(Array)
       products.each do |product|
         assert product.kind_of?(Stripe::Product)

data/test/stripe/recipient_card_test.rb

@@ -12,7 +12,7 @@ module Stripe
     should "recipient cards should be listable" do
       c = recipient
       @mock.expects(:get).once.returns(make_response(make_recipient_card_array(recipient.id)))
-      cards = c.cards.all.data
+      cards = c.cards.list.data
       assert cards.kind_of? Array
       assert cards[0].kind_of? Stripe::Card
     end

data/test/stripe/refund_test.rb

@@ -7,7 +7,7 @@ module Stripe
         with("#{Stripe.api_base}/v1/refunds", nil, nil).
         once.returns(make_response(make_refund_array))
 
-      refunds = Stripe::Refund.all
+      refunds = Stripe::Refund.list
 
       assert refunds.first.kind_of?(Stripe::Refund)
     end

data/test/stripe/sku_test.rb

@@ -5,7 +5,7 @@ module Stripe
     should "SKUs should be listable" do
       @mock.expects(:get).once.
         returns(make_response(make_sku_array("test_product")))
-      skus = Stripe::SKU.all
+      skus = Stripe::SKU.list
       assert skus.data.kind_of? Array
       skus.each do |sku|
         assert sku.kind_of?(Stripe::SKU)

data/test/stripe/stripe_object_test.rb

@@ -2,7 +2,16 @@ require File.expand_path('../../test_helper', __FILE__)
 
 module Stripe
   class StripeObjectTest < Test::Unit::TestCase
-    should "implement #respond_to correctly" do
+    should "implement #==" do
+      obj1 = Stripe::StripeObject.construct_from({ :id => 1, :foo => "bar" })
+      obj2 = Stripe::StripeObject.construct_from({ :id => 1, :foo => "bar" })
+      obj3 = Stripe::StripeObject.construct_from({ :id => 1, :foo => "rab" })
+
+      assert obj1 == obj2
+      refute obj1 == obj3
+    end
+
+    should "implement #respond_to" do
       obj = Stripe::StripeObject.construct_from({ :id => 1, :foo => 'bar' })
       assert obj.respond_to?(:id)
       assert obj.respond_to?(:foo)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stripe
 version: !ruby/object:Gem::Version
-  version: 1.28.1
+  version: 1.29.0
 platform: ruby
 authors:
 - Ross Boucher