stripe 1.30.3 → 2.0.0

data/lib/stripe/customer.rb

@@ -2,9 +2,11 @@ module Stripe
   class Customer < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
 
+    save_nested_resource :source
+
     def add_invoice_item(params, opts={})
       opts = @opts.merge(Util.normalize_opts(opts))
       InvoiceItem.create(params.merge(:customer => id), opts)
@@ -36,20 +38,20 @@ module Stripe
     end
 
     def cancel_subscription(params={}, opts={})
-      response, opts = request(:delete, subscription_url, params, opts)
-      initialize_from({ :subscription => response }, opts, true)
+      resp, opts = request(:delete, subscription_url, params, opts)
+      initialize_from({ :subscription => resp.data }, opts, true)
       subscription
     end
 
     def update_subscription(params={}, opts={})
-      response, opts = request(:post, subscription_url, params, opts)
-      initialize_from({ :subscription => response }, opts, true)
+      resp, opts = request(:post, subscription_url, params, opts)
+      initialize_from({ :subscription => resp.data }, opts, true)
       subscription
     end
 
     def create_subscription(params={}, opts={})
-      response, opts = request(:post, subscriptions_url, params, opts)
-      initialize_from({ :subscription => response }, opts, true)
+      resp, opts = request(:post, subscriptions_url, params, opts)
+      initialize_from({ :subscription => resp.data }, opts, true)
       subscription
     end
 
@@ -61,15 +63,15 @@ module Stripe
     private
 
     def discount_url
-      url + '/discount'
+      resource_url + '/discount'
     end
 
     def subscription_url
-      url + '/subscription'
+      resource_url + '/subscription'
     end
 
     def subscriptions_url
-      url + '/subscriptions'
+      resource_url + '/subscriptions'
     end
   end
 end

data/lib/stripe/dispute.rb

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

data/lib/stripe/errors.rb

@@ -0,0 +1,92 @@
+module Stripe
+  # StripeError is the base error from which all other more specific Stripe
+  # errors derive.
+  class StripeError < StandardError
+    attr_reader :message
+
+    # Response contains a StripeResponse object that has some basic information
+    # about the response that conveyed the error.
+    attr_accessor :response
+
+    # These fields are now available as part of #response and that usage should
+    # be preferred.
+    attr_reader :http_body
+    attr_reader :http_headers
+    attr_reader :http_status
+    attr_reader :json_body # equivalent to #data
+    attr_reader :request_id
+
+    # Initializes a StripeError.
+    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}) "
+      id_string = @request_id.nil? ? "" : "(Request #{@request_id}) "
+      "#{status_string}#{id_string}#{@message}"
+    end
+  end
+
+  # AuthenticationError is raised when invalid credentials are used to connect
+  # to Stripe's servers.
+  class AuthenticationError < StripeError
+  end
+
+  # APIConnectionError is raised in the event that the SDK can't connect to
+  # Stripe's servers. That can be for a variety of different reasons from a
+  # downed network to a bad TLS certificate.
+  class APIConnectionError < StripeError
+  end
+
+  # APIError is a generic error that may be raised in cases where none of the
+  # other named errors cover the problem. It could also be raised in the case
+  # that a new error has been introduced in the API, but this version of the
+  # Ruby SDK doesn't know how to handle it.
+  class APIError < StripeError
+  end
+
+  # CardError is raised when a user enters a card that can't be charged for
+  # some reason.
+  class CardError < StripeError
+    attr_reader :param, :code
+
+    def initialize(message, param, code, http_status: nil, http_body: nil, json_body: nil,
+                   http_headers: nil)
+      super(message, http_status: http_status, http_body: http_body,
+        json_body: json_body, http_headers: http_headers)
+      @param = param
+      @code = code
+    end
+  end
+
+  # InvalidRequestError is raised when a request is initiated with invalid
+  # parameters.
+  class InvalidRequestError < StripeError
+    attr_accessor :param
+
+    def initialize(message, param, http_status: nil, http_body: nil, json_body: nil,
+                   http_headers: nil)
+      super(message, http_status: http_status, http_body: http_body,
+        json_body: json_body, http_headers: http_headers)
+      @param = param
+    end
+  end
+
+  # PermissionError is raised in cases where access was attempted on a resource
+  # that wasn't allowed.
+  class PermissionError < StripeError
+  end
+
+  # RateLimitError is raised in cases where an account is putting too much load
+  # on Stripe's API servers (usually by performing too many requests). Please
+  # back off on request rate.
+  class RateLimitError < StripeError
+  end
+end

data/lib/stripe/file_upload.rb

@@ -3,7 +3,7 @@ module Stripe
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
 
-    def self.url
+    def self.resource_url
       "/v1/files"
     end
 

data/lib/stripe/invoice.rb

@@ -1,27 +1,27 @@
 module Stripe
   class Invoice < APIResource
     extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::Create
 
     def self.upcoming(params, opts={})
-      response, opts = request(:get, upcoming_url, params, opts)
-      Util.convert_to_stripe_object(response, opts)
+      resp, opts = request(:get, upcoming_url, params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     def pay(opts={})
-      response, opts = request(:post, pay_url, {}, opts)
-      initialize_from(response, opts)
+      resp, opts = request(:post, pay_url, {}, opts)
+      initialize_from(resp.data, opts)
     end
 
     private
 
     def self.upcoming_url
-      url + '/upcoming'
+      resource_url + '/upcoming'
     end
 
     def pay_url
-      url + '/pay'
+      resource_url + '/pay'
     end
   end
 end

data/lib/stripe/invoice_item.rb

@@ -3,6 +3,6 @@ module Stripe
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
   end
 end

data/lib/stripe/list_object.rb

@@ -3,6 +3,7 @@ module Stripe
     include Enumerable
     include Stripe::APIOperations::List
     include Stripe::APIOperations::Request
+    include Stripe::APIOperations::Create
 
     # This accessor allows a `ListObject` to inherit various filters that were
     # given to a predecessor. This allows for things like consistent limits,
@@ -63,13 +64,8 @@ module Stripe
 
     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={})
-      response, opts = request(:post, url, params, opts)
-      Util.convert_to_stripe_object(response, opts)
+      resp, opts = request(:get,"#{resource_url}/#{CGI.escape(id)}", retrieve_params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     # Fetches the next page in the resource list (if there is one).
@@ -100,5 +96,10 @@ module Stripe
 
       list(params, opts)
     end
+
+    def resource_url
+      self.url ||
+        raise(ArgumentError, "List object does not contain a 'url' field.")
+    end
   end
 end

data/lib/stripe/order.rb

@@ -2,18 +2,26 @@ module Stripe
   class Order < APIResource
     extend Stripe::APIOperations::List
     extend Stripe::APIOperations::Create
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
 
     def pay(params, opts={})
-      response, opts = request(:post, pay_url, params, opts)
-      initialize_from(response, opts)
+      resp, opts = request(:post, pay_url, params, opts)
+      initialize_from(resp.data, opts)
+    end
+
+    def return_order(params, opts={})
+      resp, opts = request(:post, returns_url, params, opts)
+      Util.convert_to_stripe_object(resp.data, opts)
     end
 
     private
 
     def pay_url
-      url + "/pay"
+      resource_url + '/pay'
     end
 
+    def returns_url
+      resource_url + '/returns'
+    end
   end
 end

data/lib/stripe/order_return.rb

@@ -0,0 +1,9 @@
+module Stripe
+  class OrderReturn < APIResource
+    extend Stripe::APIOperations::List
+
+    def self.resource_url
+      "/v1/order_returns"
+    end
+  end
+end

data/lib/stripe/plan.rb

@@ -3,6 +3,6 @@ module Stripe
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
     extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
   end
 end

data/lib/stripe/product.rb

@@ -2,15 +2,7 @@ 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
+    include Stripe::APIOperations::Save
+    include Stripe::APIOperations::Delete
   end
 end

data/lib/stripe/recipient.rb

@@ -2,7 +2,7 @@ module Stripe
   class Recipient < APIResource
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
     extend Stripe::APIOperations::List
 
     def transfers

data/lib/stripe/refund.rb

@@ -2,6 +2,6 @@ module Stripe
   class Refund < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
-    include Stripe::APIOperations::Update
+    include Stripe::APIOperations::Save
   end
 end

data/lib/stripe/reversal.rb

@@ -1,10 +1,14 @@
 module Stripe
   class Reversal < APIResource
-    include Stripe::APIOperations::Update
     extend Stripe::APIOperations::List
+    include Stripe::APIOperations::Save
 
-    def url
-      "#{Transfer.url}/#{CGI.escape(transfer)}/reversals/#{CGI.escape(id)}"
+    def resource_url
+      "#{Transfer.resource_url}/#{CGI.escape(transfer)}/reversals/#{CGI.escape(id)}"
+    end
+
+    def self.update(id, params=nil, opts=nil)
+      raise NotImplementedError.new("Reversals cannot be updated without a transfer ID. Update a reversal using `r = transfer.reversals.retrieve('reversal_id'); r.save`")
     end
 
     def self.retrieve(id, opts={})

data/lib/stripe/singleton_api_resource.rb

@@ -1,14 +1,14 @@
 module Stripe
   class SingletonAPIResource < APIResource
-    def self.url
+    def self.resource_url
       if self == SingletonAPIResource
         raise NotImplementedError.new('SingletonAPIResource is an abstract class.  You should perform actions on its subclasses (Account, etc.)')
       end
       "/v1/#{CGI.escape(class_name.downcase)}"
     end
 
-    def url
-      self.class.url
+    def resource_url
+      self.class.resource_url
     end
 
     def self.retrieve(opts={})

data/lib/stripe/sku.rb

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

data/lib/stripe/source.rb

@@ -0,0 +1,11 @@
+module Stripe
+  class Source < APIResource
+    extend Stripe::APIOperations::Create
+    include Stripe::APIOperations::Save
+
+    def verify(params={}, opts={})
+      resp, opts = request(:post, resource_url + '/verify', params, opts)
+      initialize_from(resp.data, opts)
+    end
+  end
+end