stripe 1.18.0 → 1.30.0

data/lib/stripe/charge.rb

@@ -1,52 +1,44 @@
 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={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :post, refund_url, api_key || @api_key, params, headers)
-      refresh_from(response, api_key)
+      response, opts = request(:post, refund_url, params, opts)
+      initialize_from(response, opts)
     end
 
     def capture(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :post, capture_url, api_key || @api_key, params, headers)
-      refresh_from(response, api_key)
+      response, opts = request(:post, capture_url, params, opts)
+      initialize_from(response, opts)
     end
 
     def update_dispute(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :post, dispute_url, api_key || @api_key, params, headers)
-      refresh_from({ :dispute => response }, api_key, true)
+      response, opts = request(:post, dispute_url, params, opts)
+      initialize_from({ :dispute => response }, opts, true)
       dispute
     end
 
     def close_dispute(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :post, close_dispute_url, api_key || @api_key, params, headers)
-      refresh_from(response, api_key)
+      response, opts = request(:post, close_dispute_url, params, opts)
+      initialize_from(response, opts)
     end
 
     def mark_as_fraudulent
       params = {
         :fraud_details => { :user_report => 'fraudulent' }
       }
-      response, api_key = Stripe.request(:post, url, @api_key, params)
-      refresh_from(response, api_key)
+      response, opts = request(:post, url, params)
+      initialize_from(response, opts)
     end
 
     def mark_as_safe
       params = {
         :fraud_details => { :user_report => 'safe' }
       }
-      response, api_key = Stripe.request(:post, url, @api_key, params)
-      refresh_from(response, api_key)
+      response, opts = request(:post, url, params)
+      initialize_from(response, opts)
     end
 
     private

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,63 +1,61 @@
 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[:api_key] = @api_key
+      opts = @opts.merge(Util.normalize_opts(opts))
       InvoiceItem.create(params.merge(:customer => id), opts)
     end
 
-    def invoices
-      Invoice.all({ :customer => id }, @api_key)
+    def invoices(params={}, opts={})
+      opts = @opts.merge(Util.normalize_opts(opts))
+      Invoice.all(params.merge(:customer => id), opts)
     end
 
-    def invoice_items
-      InvoiceItem.all({ :customer => id }, @api_key)
+    def invoice_items(params={}, opts={})
+      opts = @opts.merge(Util.normalize_opts(opts))
+      InvoiceItem.all(params.merge(:customer => id), opts)
     end
 
-    def upcoming_invoice
-      Invoice.upcoming({ :customer => id }, @api_key)
+    def upcoming_invoice(params={}, opts={})
+      opts = @opts.merge(Util.normalize_opts(opts))
+      Invoice.upcoming(params.merge(:customer => id), opts)
     end
 
-    def charges
-      Charge.all({ :customer => id }, @api_key)
+    def charges(params={}, opts={})
+      opts = @opts.merge(Util.normalize_opts(opts))
+      Charge.all(params.merge(:customer => id), opts)
     end
 
     def create_upcoming_invoice(params={}, opts={})
-      opts[:api_key] = @api_key
+      opts = @opts.merge(Util.normalize_opts(opts))
       Invoice.create(params.merge(:customer => id), opts)
     end
 
     def cancel_subscription(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :delete, subscription_url, api_key || @api_key, params, headers)
-      refresh_from({ :subscription => response }, api_key, true)
+      response, opts = request(:delete, subscription_url, params, opts)
+      initialize_from({ :subscription => response }, opts, true)
       subscription
     end
 
     def update_subscription(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :post, subscription_url, api_key  || @api_key, params, headers)
-      refresh_from({ :subscription => response }, api_key, true)
+      response, opts = request(:post, subscription_url, params, opts)
+      initialize_from({ :subscription => response }, opts, true)
       subscription
     end
 
     def create_subscription(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :post, subscriptions_url, api_key || @api_key, params, headers)
-      refresh_from({ :subscription => response }, api_key, true)
+      response, opts = request(:post, subscriptions_url, params, opts)
+      initialize_from({ :subscription => response }, opts, true)
       subscription
     end
 
     def delete_discount
-      Stripe.request(:delete, discount_url, @api_key)
-      refresh_from({ :discount => nil }, api_key, true)
+      _, opts = request(:delete, discount_url)
+      initialize_from({ :discount => nil }, opts, true)
     end
 
     private

data/lib/stripe/dispute.rb

@@ -0,0 +1,16 @@
+module Stripe
+  class Dispute < APIResource
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Update
+
+    def close(params={}, opts={})
+      response, opts = request(:post, close_url, params, opts)
+      initialize_from(response, opts)
+    end
+
+    def close_url
+      url + '/close'
+    end
+  end
+end

data/lib/stripe/errors/card_error.rb

@@ -2,8 +2,9 @@ module Stripe
   class CardError < StripeError
     attr_reader :param, :code
 
-    def initialize(message, param, code, http_status=nil, http_body=nil, json_body=nil)
-      super(message, http_status, http_body, json_body)
+    def initialize(message, param, code, http_status=nil, http_body=nil, json_body=nil,
+                   http_headers=nil)
+      super(message, http_status, http_body, json_body, http_headers)
       @param = param
       @code = code
     end

data/lib/stripe/errors/invalid_request_error.rb

@@ -2,8 +2,9 @@ module Stripe
   class InvalidRequestError < StripeError
     attr_accessor :param
 
-    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil)
-      super(message, http_status, http_body, json_body)
+    def initialize(message, param, http_status=nil, http_body=nil, json_body=nil,
+                   http_headers=nil)
+      super(message, http_status, http_body, json_body, http_headers)
       @param = param
     end
   end

data/lib/stripe/errors/rate_limit_error.rb

@@ -0,0 +1,4 @@
+module Stripe
+  class RateLimitError < StripeError
+  end
+end

data/lib/stripe/errors/stripe_error.rb

@@ -3,18 +3,24 @@ module Stripe
     attr_reader :message
     attr_reader :http_status
     attr_reader :http_body
+    attr_reader :http_headers
+    attr_reader :request_id
     attr_reader :json_body
 
-    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil)
+    def initialize(message=nil, http_status=nil, http_body=nil, json_body=nil,
+                   http_headers=nil)
       @message = message
       @http_status = http_status
       @http_body = http_body
+      @http_headers = http_headers || {}
       @json_body = json_body
+      @request_id = @http_headers[:request_id]
     end
 
     def to_s
       status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
-      "#{status_string}#{@message}"
+      id_string = @request_id.nil? ? "" : "(Request #{@request_id}) "
+      "#{status_string}#{id_string}#{@message}"
     end
   end
 end

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,34 +1,24 @@
 module Stripe
   class FileUpload < APIResource
-    UPLOADS_API_BASE = "https://uploads.stripe.com"
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
 
     def self.url
       "/v1/files"
     end
 
-    def self.request_headers
-      {
-        :content_type => 'multipart/form-data',
-      }
-    end
-
-    def self.create(params={}, api_key=nil)
-      response, api_key = Stripe.request(
-        :post, self.url, api_key, params, self.request_headers, UPLOADS_API_BASE)
-      Util.convert_to_stripe_object(response, api_key)
+    def self.request(method, url, params={}, opts={})
+      opts = {
+        :api_base => Stripe::uploads_base
+      }.merge(Util.normalize_opts(opts))
+      super
     end
 
-    def self.all(filters={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      response, api_key = Stripe.request(
-        :get, self.url, api_key, filters, headers, UPLOADS_API_BASE)
-      Util.convert_to_stripe_object(response, api_key)
-    end
-
-    def refresh
-      response, api_key = Stripe.request(
-        :get, url, @api_key, @retrieve_options, self.class.request_headers, UPLOADS_API_BASE)
-      refresh_from(response, api_key)
+    def self.create(params={}, opts={})
+      opts = {
+        :content_type => 'multipart/form-data',
+      }.merge(Util.normalize_opts(opts))
+      super
     end
   end
 end

data/lib/stripe/invoice.rb

@@ -1,17 +1,17 @@
 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, api_key = nil)
-      response, api_key = Stripe.request(:get, upcoming_url, api_key, params)
-      Util.convert_to_stripe_object(response, api_key)
+    def self.upcoming(params, opts={})
+      response, opts = request(:get, upcoming_url, params, opts)
+      Util.convert_to_stripe_object(response, opts)
     end
 
-    def pay
-      response, api_key = Stripe.request(:post, pay_url, @api_key)
-      refresh_from(response, api_key)
+    def pay(opts={})
+      response, opts = request(:post, pay_url, {}, opts)
+      initialize_from(response, opts)
     end
 
     private

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,5 +1,20 @@
 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
@@ -10,28 +25,77 @@ 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
 
-    def retrieve(id, api_key=nil)
-      api_key ||= @api_key
-      response, api_key = Stripe.request(:get,"#{url}/#{CGI.escape(id)}", api_key)
-      Util.convert_to_stripe_object(response, api_key)
+    # 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?
+    end
+
+    def retrieve(id, opts={})
+      id, retrieve_params = Util.normalize_id(id)
+      response, opts = request(:get,"#{url}/#{CGI.escape(id)}", retrieve_params, opts)
+      Util.convert_to_stripe_object(response, opts)
     end
 
     def create(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      api_key ||= @api_key
-      response, api_key = Stripe.request(:post, url, api_key, params, headers)
-      Util.convert_to_stripe_object(response, api_key)
+      response, opts = request(:post, url, params, opts)
+      Util.convert_to_stripe_object(response, opts)
     end
 
-    def all(params={}, opts={})
-      api_key, headers = Util.parse_opts(opts)
-      api_key ||= @api_key
-      response, api_key = Stripe.request(:get, url, api_key, params, headers)
-      Util.convert_to_stripe_object(response, api_key)
+    # 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

@@ -0,0 +1,19 @@
+module Stripe
+  class Order < APIResource
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Update
+
+    def pay(params, opts={})
+      response, opts = request(:post, pay_url, params, opts)
+      initialize_from(response, opts)
+    end
+
+    private
+
+    def pay_url
+      url + "/pay"
+    end
+
+  end
+end

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

@@ -0,0 +1,16 @@
+module Stripe
+  class Product < APIResource
+    extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Update
+
+    # Keep APIResource#url as `api_url` to avoid letting the external URL
+    # replace the Stripe URL.
+    alias_method :api_url, :url
+
+    # Override Stripe::APIOperations::Update#save to explicitly pass URL.
+    def save
+      super(:req_url => api_url)
+    end
+  end
+end

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,14 +1,7 @@
 module Stripe
   class Refund < APIResource
+    extend Stripe::APIOperations::Create
+    extend Stripe::APIOperations::List
     include Stripe::APIOperations::Update
-    include Stripe::APIOperations::List
-
-    def url
-      "#{Charge.url}/#{CGI.escape(charge)}/refunds/#{CGI.escape(id)}"
-    end
-
-    def self.retrieve(id, api_key=nil)
-      raise NotImplementedError.new("Refunds cannot be retrieved without a charge ID. Retrieve a refund using charge.refunds.retrieve('refund_id')")
-    end
   end
 end

data/lib/stripe/reversal.rb

@@ -0,0 +1,14 @@
+module Stripe
+  class Reversal < APIResource
+    include Stripe::APIOperations::Update
+    extend Stripe::APIOperations::List
+
+    def url
+      "#{Transfer.url}/#{CGI.escape(transfer)}/reversals/#{CGI.escape(id)}"
+    end
+
+    def self.retrieve(id, opts={})
+      raise NotImplementedError.new("Reversals cannot be retrieved without a transfer ID. Retrieve a reversal using transfer.reversals.retrieve('reversal_id')")
+    end
+  end
+end

data/lib/stripe/singleton_api_resource.rb

@@ -11,8 +11,8 @@ module Stripe
       self.class.url
     end
 
-    def self.retrieve(api_key=nil)
-      instance = self.new(nil, api_key)
+    def self.retrieve(opts={})
+      instance = self.new(nil, Util.normalize_opts(opts))
       instance.refresh
       instance
     end

data/lib/stripe/sku.rb

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