stripe 4.11.0 → 4.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81c34bec9bdd939d6ebe5a63c4a14e617e609fceaba92275168bd57b5f5f4f9d
-  data.tar.gz: 34365a8cd2d1a662984a387dba59891205a5a5e26bf4f7b7688d87340c210655
+  metadata.gz: a30c5b27bb9161913905e0ada304efcef00519446eb64cbf2e7c3d0d625a2810
+  data.tar.gz: d8503b19941c67e68c75b7b4e1c24cae2bd7a4c80a5b91e5c4e81058d23b658d
 SHA512:
-  metadata.gz: 1cb0774d3e51ac40a97ff62dd16543cc5782ceeca4f4b38922867a3d3635f7aee5581fb454025f4672b4b40e22d685a81265f3f8a4367907f6050ba010a0564c
-  data.tar.gz: 568a35c534b30e8d47be7a44f74401c590613e5f266746e4dc6214374350e3f7a855202d47e5846d0d787040548c3c2a6e11c027013dd421ecfd728453cf2e8c
+  metadata.gz: a3a0ecd3172c802dc16bacab0be7f3d34373ed2230d18e5a89b84814d3705568e6f0ca261fb576492c1ec3ef39132b17a9b9126ba69f3941e45a4b3f851a3f07
+  data.tar.gz: 7a6d70ebe915abe5774a4f5e55815e43ea24d6db4f4553ce77f18394b93aca8eeae051f9fd557d74bdda4d3e4d77112b821dca22a62c7284fc942392fc797638

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.1
 
 Layout/CaseIndentation:
   EnforcedStyle: end

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 4.12.0 - 2019-04-02
+* [#752](https://github.com/stripe/stripe-ruby/pull/752) Add `.delete` class method on deletable API resources
+* [#754](https://github.com/stripe/stripe-ruby/pull/754) Add class methods for all custom API requests (e.g. `Charge.capture`)
+
 ## 4.11.0 - 2019-03-26
 * [#753](https://github.com/stripe/stripe-ruby/pull/753) Add a global proxy configuration parameter
 

data/VERSION

@@ -1 +1 @@
-4.11.0
+4.12.0

data/lib/stripe.rb

@@ -53,6 +53,7 @@ require "stripe/checkout/session"
 require "stripe/country_spec"
 require "stripe/coupon"
 require "stripe/customer"
+require "stripe/discount"
 require "stripe/dispute"
 require "stripe/ephemeral_key"
 require "stripe/event"

data/lib/stripe/account.rb

@@ -11,6 +11,8 @@ module Stripe
 
     OBJECT_NAME = "account".freeze
 
+    custom_method :reject, http_verb: :post
+
     save_nested_resource :external_account
     nested_resource_class_methods :external_account,
                                   operations: %i[create retrieve update delete list]

data/lib/stripe/api_operations/delete.rb

@@ -3,11 +3,35 @@
 module Stripe
   module APIOperations
     module Delete
+      module ClassMethods
+        # Deletes an API resource
+        #
+        # Deletes the identified resource with the passed in parameters.
+        #
+        # ==== Attributes
+        #
+        # * +id+ - ID of the resource to delete.
+        # * +params+ - A hash of parameters to pass to the API
+        # * +opts+ - A Hash of additional options (separate from the params /
+        #   object values) to be added to the request. E.g. to allow for an
+        #   idempotency_key to be passed in the request headers, or for the
+        #   api_key to be overwritten. See {APIOperations::Request.request}.
+        def delete(id, params = {}, opts = {})
+          opts = Util.normalize_opts(opts)
+          resp, opts = request(:delete, "#{resource_url}/#{id}", params, opts)
+          Util.convert_to_stripe_object(resp.data, opts)
+        end
+      end
+
       def delete(params = {}, opts = {})
         opts = Util.normalize_opts(opts)
         resp, opts = request(:delete, resource_url, params, opts)
         initialize_from(resp.data, opts)
       end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
     end
   end
 end

data/lib/stripe/api_resource.rb

@@ -48,6 +48,30 @@ module Stripe
       end
     end
 
+    # Adds a custom method to a resource class. This is used to add support for
+    # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
+    # following parameters:
+    # - name: the name of the custom method to create (as a symbol)
+    # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
+    # - http_path: the path to append to the resource's URL. If not provided,
+    #              the name is used as the path
+    #
+    # For example, this call:
+    #     custom_method :capture, http_verb: post
+    # adds a `capture` class method to the resource class that, when called,
+    # will send a POST request to `/v1/<object_name>/capture`.
+    def self.custom_method(name, http_verb:, http_path: nil)
+      unless %i[get post delete].include?(http_verb)
+        raise ArgumentError, "Invalid http_verb value: #{http_verb.inspect}. Should be one of :get, :post or :delete."
+      end
+      http_path ||= name.to_s
+      define_singleton_method(name) do |id, params = {}, opts = {}|
+        url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(http_path)}"
+        resp, opts = request(http_verb, url, params, opts)
+        Util.convert_to_stripe_object(resp.data, opts)
+      end
+    end
+
     def resource_url
       unless (id = self["id"])
         raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", "id")

data/lib/stripe/charge.rb

@@ -8,6 +8,8 @@ module Stripe
 
     OBJECT_NAME = "charge".freeze
 
+    custom_method :capture, http_verb: :post
+
     def refund(params = {}, opts = {})
       # Old versions of charge objects included a `refunds` field that was just
       # a vanilla array instead of a Stripe list object.

data/lib/stripe/customer.rb

@@ -10,6 +10,8 @@ module Stripe
 
     OBJECT_NAME = "customer".freeze
 
+    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+
     save_nested_resource :source
     nested_resource_class_methods :source,
                                   operations: %i[create retrieve update delete list]

data/lib/stripe/discount.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Stripe
+  class Discount < StripeObject
+    OBJECT_NAME = "discount".freeze
+  end
+end

data/lib/stripe/dispute.rb

@@ -7,6 +7,8 @@ module Stripe
 
     OBJECT_NAME = "dispute".freeze
 
+    custom_method :close, http_verb: :post
+
     def close(params = {}, opts = {})
       resp, opts = request(:post, close_url, params, opts)
       initialize_from(resp.data, opts)

data/lib/stripe/invoice.rb

@@ -9,6 +9,12 @@ module Stripe
 
     OBJECT_NAME = "invoice".freeze
 
+    custom_method :finalize_invoice, http_verb: :post, http_path: "finalize"
+    custom_method :mark_uncollectible, http_verb: :post
+    custom_method :pay, http_verb: :post
+    custom_method :send_invoice, http_verb: :post, http_path: "send"
+    custom_method :void_invoice, http_verb: :post, http_path: "void"
+
     def finalize_invoice(params = {}, opts = {})
       url = resource_url + "/finalize"
       resp, opts = request(:post, url, params, opts)

data/lib/stripe/issuing/authorization.rb

@@ -8,6 +8,9 @@ module Stripe
 
       OBJECT_NAME = "issuing.authorization".freeze
 
+      custom_method :approve, http_verb: :post
+      custom_method :decline, http_verb: :post
+
       def approve(params = {}, opts = {})
         resp, opts = request(:post, resource_url + "/approve", params, opts)
         initialize_from(resp.data, opts)

data/lib/stripe/issuing/card.rb

@@ -9,6 +9,8 @@ module Stripe
 
       OBJECT_NAME = "issuing.card".freeze
 
+      custom_method :details, http_verb: :get
+
       def details(params = {}, opts = {})
         resp, opts = request(:get, resource_url + "/details", params, opts)
         Util.convert_to_stripe_object(resp.data, opts)

data/lib/stripe/order.rb

@@ -8,6 +8,9 @@ module Stripe
 
     OBJECT_NAME = "order".freeze
 
+    custom_method :pay, http_verb: :post
+    custom_method :return_order, http_verb: :post, http_path: "returns"
+
     def pay(params, opts = {})
       resp, opts = request(:post, pay_url, params, opts)
       initialize_from(resp.data, opts)

data/lib/stripe/payment_intent.rb

@@ -8,6 +8,10 @@ module Stripe
 
     OBJECT_NAME = "payment_intent".freeze
 
+    custom_method :cancel, http_verb: :post
+    custom_method :capture, http_verb: :post
+    custom_method :confirm, http_verb: :post
+
     def cancel(params = {}, opts = {})
       resp, opts = request(:post, resource_url + "/cancel", params, opts)
       initialize_from(resp.data, opts)

data/lib/stripe/payment_method.rb

@@ -8,6 +8,9 @@ module Stripe
 
     OBJECT_NAME = "payment_method".freeze
 
+    custom_method :attach, http_verb: :post
+    custom_method :detach, http_verb: :post
+
     def attach(params = {}, opts = {})
       url = resource_url + "/attach"
       resp, opts = request(:post, url, params, opts)

data/lib/stripe/payout.rb

@@ -8,6 +8,8 @@ module Stripe
 
     OBJECT_NAME = "payout".freeze
 
+    custom_method :cancel, http_verb: :post
+
     def cancel
       resp, api_key = request(:post, cancel_url)
       initialize_from(resp.data, api_key)

data/lib/stripe/review.rb

@@ -6,6 +6,8 @@ module Stripe
 
     OBJECT_NAME = "review".freeze
 
+    custom_method :approve, http_verb: :post
+
     def approve(params = {}, opts = {})
       resp, opts = request(:post, resource_url + "/approve", params, opts)
       initialize_from(resp.data, opts)

data/lib/stripe/source.rb

@@ -7,6 +7,8 @@ module Stripe
 
     OBJECT_NAME = "source".freeze
 
+    custom_method :verify, http_verb: :post
+
     def detach(params = {}, opts = {})
       if !respond_to?(:customer) || customer.nil? || customer.empty?
         raise NotImplementedError,

data/lib/stripe/subscription.rb

@@ -9,6 +9,8 @@ module Stripe
 
     OBJECT_NAME = "subscription".freeze
 
+    custom_method :delete_discount, http_verb: :delete, http_path: "discount"
+
     save_nested_resource :source
 
     def delete_discount

data/lib/stripe/subscription_schedule.rb

@@ -9,6 +9,9 @@ module Stripe
 
     OBJECT_NAME = "subscription_schedule".freeze
 
+    custom_method :cancel, http_verb: :post
+    custom_method :release, http_verb: :post
+
     nested_resource_class_methods :revision,
                                   operations: %i[retrieve list]
 

data/lib/stripe/topup.rb

@@ -8,6 +8,8 @@ module Stripe
 
     OBJECT_NAME = "topup".freeze
 
+    custom_method :cancel, http_verb: :post
+
     def cancel
       resp, api_key = request(:post, resource_url + "/cancel")
       initialize_from(resp.data, api_key)

data/lib/stripe/transfer.rb

@@ -9,6 +9,8 @@ module Stripe
 
     OBJECT_NAME = "transfer".freeze
 
+    custom_method :cancel, http_verb: :post
+
     nested_resource_class_methods :reversal, operations: %i[create retrieve update list]
 
     def cancel

data/lib/stripe/util.rb

@@ -62,6 +62,7 @@ module Stripe
         CountrySpec::OBJECT_NAME                  => CountrySpec,
         Coupon::OBJECT_NAME                       => Coupon,
         Customer::OBJECT_NAME                     => Customer,
+        Discount::OBJECT_NAME                     => Discount,
         Dispute::OBJECT_NAME                      => Dispute,
         EphemeralKey::OBJECT_NAME                 => EphemeralKey,
         Event::OBJECT_NAME                        => Event,

data/lib/stripe/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stripe
-  VERSION = "4.11.0".freeze
+  VERSION = "4.12.0".freeze
 end

data/test/stripe/account_test.rb

@@ -24,15 +24,18 @@ module Stripe
     end
 
     should "be rejectable" do
-      account_data = { id: "acct_foo" }
-      stub_request(:get, "#{Stripe.api_base}/v1/accounts/acct_foo")
-        .to_return(body: JSON.generate(account_data))
-
-      stub_request(:post, "#{Stripe.api_base}/v1/accounts/acct_foo/reject")
-        .to_return(body: JSON.generate(account_data))
-
       account = Stripe::Account.retrieve("acct_foo")
-      account.reject(reason: "fraud")
+      account = account.reject(reason: "fraud")
+      assert_requested :post, "#{Stripe.api_base}/v1/accounts/#{account.id}/reject"
+      assert account.is_a?(Stripe::Account)
+    end
+
+    context ".reject" do
+      should "reject the account" do
+        account = Stripe::Account.reject("acct_foo", reason: "fraud")
+        assert_requested :post, "#{Stripe.api_base}/v1/accounts/#{account.id}/reject"
+        assert account.is_a?(Stripe::Account)
+      end
     end
 
     should "be creatable" do
@@ -54,11 +57,21 @@ module Stripe
       assert account.is_a?(Stripe::Account)
     end
 
-    should "be deletable" do
-      account = Stripe::Account.retrieve("acct_123")
-      account = account.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/accounts/#{account.id}"
-      assert account.is_a?(Stripe::Account)
+    context "#delete" do
+      should "be deletable" do
+        account = Stripe::Account.retrieve("acct_123")
+        account = account.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/accounts/#{account.id}"
+        assert account.is_a?(Stripe::Account)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        account = Stripe::Account.delete("acct_123")
+        assert_requested :delete, "#{Stripe.api_base}/v1/accounts/acct_123"
+        assert account.is_a?(Stripe::Account)
+      end
     end
 
     should "be able to list Persons" do

data/test/stripe/apple_pay_domain_test.rb

@@ -24,10 +24,23 @@ module Stripe
     end
 
     should "be deletable" do
-      domain = Stripe::ApplePayDomain.retrieve("apwc_123")
-      domain = domain.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/apple_pay/domains/#{domain.id}"
-      assert domain.is_a?(Stripe::ApplePayDomain)
+    end
+
+    context "#delete" do
+      should "be deletable" do
+        domain = Stripe::ApplePayDomain.retrieve("apwc_123")
+        domain = domain.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/apple_pay/domains/#{domain.id}"
+        assert domain.is_a?(Stripe::ApplePayDomain)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        domain = Stripe::ApplePayDomain.delete("apwc_123")
+        assert_requested :delete, "#{Stripe.api_base}/v1/apple_pay/domains/apwc_123"
+        assert domain.is_a?(Stripe::ApplePayDomain)
+      end
     end
   end
 end

data/test/stripe/charge_test.rb

@@ -40,6 +40,27 @@ module Stripe
       assert charge.is_a?(Stripe::Charge)
     end
 
+    context "#capture" do
+      should "capture the charge" do
+        charge = Stripe::Charge.retrieve("ch_123")
+        charge = charge.capture(amount: 100)
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/charges/ch_123/capture",
+                         body: { amount: 100 }
+        assert charge.is_a?(Stripe::Charge)
+      end
+    end
+
+    context ".capture" do
+      should "capture the charge" do
+        charge = Stripe::Charge.capture("ch_123", amount: 100)
+        assert_requested :post,
+                         "#{Stripe.api_base}/v1/charges/ch_123/capture",
+                         body: { amount: 100 }
+        assert charge.is_a?(Stripe::Charge)
+      end
+    end
+
     context "#mark_as_fraudulent" do
       should "charges should be able to be marked as fraudulent" do
         charge = Stripe::Charge.retrieve("ch_123")

data/test/stripe/coupon_test.rb

@@ -41,11 +41,21 @@ module Stripe
       assert coupon.is_a?(Stripe::Coupon)
     end
 
-    should "be deletable" do
-      coupon = Stripe::Coupon.retrieve("25OFF")
-      coupon = coupon.delete
-      assert_requested :delete, "#{Stripe.api_base}/v1/coupons/#{coupon.id}"
-      assert coupon.is_a?(Stripe::Coupon)
+    context "#delete" do
+      should "be deletable" do
+        coupon = Stripe::Coupon.delete("25OFF")
+        assert_requested :delete, "#{Stripe.api_base}/v1/coupons/#{coupon.id}"
+        assert coupon.is_a?(Stripe::Coupon)
+      end
+    end
+
+    context ".delete" do
+      should "be deletable" do
+        coupon = Stripe::Coupon.retrieve("25OFF")
+        coupon = coupon.delete
+        assert_requested :delete, "#{Stripe.api_base}/v1/coupons/25OFF"
+        assert coupon.is_a?(Stripe::Coupon)
+      end
     end
   end
 end