Merge pull request #808 from stripe/ralex/unified_requests

Unify request/response handling
stripe · Aug 8, 2019 · d369e84 · d369e84
2 parents 86da04c + 17d689a
commit d369e84
Show file tree

Hide file tree

Showing 19 changed files with 254 additions and 54 deletions.
diff --git a/lib/stripe/api_resource.rb b/lib/stripe/api_resource.rb
@@ -103,5 +103,16 @@ def self.retrieve(id, opts = {})
       instance.refresh
       instance
     end
+
+    protected def request_stripe_object(method:, path:, params:, opts: {})
+      resp, opts = request(method, path, params, opts)
+
+      # If we're getting back this thing, update; otherwise, instantiate.
+      if Util.object_name_matches_class?(resp.data[:object], self.class)
+        initialize_from(resp.data, opts)
+      else
+        Util.convert_to_stripe_object(resp.data, opts)
+      end
+    end
   end
 end
diff --git a/lib/stripe/resources/account.rb b/lib/stripe/resources/account.rb
@@ -20,8 +20,12 @@ class Account < APIResource
                                   operations: %i[create retrieve update delete list]
 
     def reject(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/reject", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/reject",
+        params: params,
+        opts: opts
+      )
     end
 
     save_nested_resource :external_account

diff --git a/lib/stripe/resources/credit_note.rb b/lib/stripe/resources/credit_note.rb
@@ -11,8 +11,12 @@ class CreditNote < APIResource
     custom_method :void_credit_note, http_verb: :post, http_path: "void"
 
     def void_credit_note(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/void", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/void",
+        params: params,
+        opts: opts
+      )
     end
   end
 end
diff --git a/lib/stripe/resources/dispute.rb b/lib/stripe/resources/dispute.rb
@@ -10,8 +10,12 @@ class Dispute < APIResource
     custom_method :close, http_verb: :post
 
     def close(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/close", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/close",
+        params: params,
+        opts: opts
+      )
     end
 
     def close_url

diff --git a/lib/stripe/resources/invoice.rb b/lib/stripe/resources/invoice.rb
@@ -16,28 +16,48 @@ class Invoice < APIResource
     custom_method :void_invoice, http_verb: :post, http_path: "void"
 
     def finalize_invoice(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/finalize", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/finalize",
+        params: params,
+        opts: opts
+      )
     end
 
     def mark_uncollectible(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/mark_uncollectible", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/mark_uncollectible",
+        params: params,
+        opts: opts
+      )
     end
 
     def pay(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/pay", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/pay",
+        params: params,
+        opts: opts
+      )
     end
 
     def send_invoice(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/send", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/send",
+        params: params,
+        opts: opts
+      )
     end
 
     def void_invoice(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/void", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/void",
+        params: params,
+        opts: opts
+      )
     end
 
     def self.upcoming(params, opts = {})

diff --git a/lib/stripe/resources/issuing/authorization.rb b/lib/stripe/resources/issuing/authorization.rb
@@ -12,13 +12,21 @@ class Authorization < APIResource
       custom_method :decline, http_verb: :post
 
       def approve(params = {}, opts = {})
-        resp, opts = request(:post, resource_url + "/approve", params, opts)
-        initialize_from(resp.data, opts)
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/approve",
+          params: params,
+          opts: opts
+        )
       end
 
       def decline(params = {}, opts = {})
-        resp, opts = request(:post, resource_url + "/decline", params, opts)
-        initialize_from(resp.data, opts)
+        request_stripe_object(
+          method: :post,
+          path: resource_url + "/decline",
+          params: params,
+          opts: opts
+        )
       end
     end
   end

diff --git a/lib/stripe/resources/issuing/card.rb b/lib/stripe/resources/issuing/card.rb
@@ -12,8 +12,12 @@ class Card < APIResource
       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)
+        request_stripe_object(
+          method: :get,
+          path: resource_url + "/details",
+          params: params,
+          opts: opts
+        )
       end
     end
   end

diff --git a/lib/stripe/resources/order.rb b/lib/stripe/resources/order.rb
@@ -12,13 +12,21 @@ class Order < APIResource
     custom_method :return_order, http_verb: :post, http_path: "returns"
 
     def pay(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/pay", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/pay",
+        params: params,
+        opts: opts
+      )
     end
 
     def return_order(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/returns", params, opts)
-      Util.convert_to_stripe_object(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/returns",
+        params: params,
+        opts: opts
+      )
     end
 
     private def pay_url

diff --git a/lib/stripe/resources/payment_intent.rb b/lib/stripe/resources/payment_intent.rb
@@ -13,18 +13,30 @@ class PaymentIntent < APIResource
     custom_method :confirm, http_verb: :post
 
     def cancel(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/cancel", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
     end
 
     def capture(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/capture", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/capture",
+        params: params,
+        opts: opts
+      )
     end
 
     def confirm(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/confirm", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/confirm",
+        params: params,
+        opts: opts
+      )
     end
   end
 end
diff --git a/lib/stripe/resources/payment_method.rb b/lib/stripe/resources/payment_method.rb
@@ -12,13 +12,21 @@ class PaymentMethod < APIResource
     custom_method :detach, http_verb: :post
 
     def attach(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/attach", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/attach",
+        params: params,
+        opts: opts
+      )
     end
 
     def detach(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/detach", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/detach",
+        params: params,
+        opts: opts
+      )
     end
   end
 end
diff --git a/lib/stripe/resources/payout.rb b/lib/stripe/resources/payout.rb
@@ -11,8 +11,12 @@ class Payout < APIResource
     custom_method :cancel, http_verb: :post
 
     def cancel(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/cancel", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
     end
 
     def cancel_url

diff --git a/lib/stripe/resources/review.rb b/lib/stripe/resources/review.rb
@@ -9,8 +9,12 @@ class Review < APIResource
     custom_method :approve, http_verb: :post
 
     def approve(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/approve", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/approve",
+        params: params,
+        opts: opts
+      )
     end
   end
 end
diff --git a/lib/stripe/resources/setup_intent.rb b/lib/stripe/resources/setup_intent.rb
@@ -12,13 +12,21 @@ class SetupIntent < APIResource
     custom_method :confirm, http_verb: :post
 
     def cancel(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/cancel", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
     end
 
     def confirm(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/confirm", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/confirm",
+        params: params,
+        opts: opts
+      )
     end
   end
 end
diff --git a/lib/stripe/resources/source.rb b/lib/stripe/resources/source.rb
@@ -10,8 +10,12 @@ class Source < APIResource
     custom_method :verify, http_verb: :post
 
     def verify(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/verify", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/verify",
+        params: params,
+        opts: opts
+      )
     end
 
     def detach(params = {}, opts = {})

diff --git a/lib/stripe/resources/subscription_schedule.rb b/lib/stripe/resources/subscription_schedule.rb
@@ -15,13 +15,21 @@ class SubscriptionSchedule < APIResource
     nested_resource_class_methods :revision, operations: %i[retrieve list]
 
     def cancel(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/cancel", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
     end
 
     def release(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/release", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/release",
+        params: params,
+        opts: opts
+      )
     end
 
     def revisions(params = {}, opts = {})

diff --git a/lib/stripe/resources/topup.rb b/lib/stripe/resources/topup.rb
@@ -11,8 +11,12 @@ class Topup < APIResource
     custom_method :cancel, http_verb: :post
 
     def cancel(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/cancel", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
     end
   end
 end
diff --git a/lib/stripe/resources/transfer.rb b/lib/stripe/resources/transfer.rb
@@ -15,8 +15,12 @@ class Transfer < APIResource
                                   operations: %i[create retrieve update list]
 
     def cancel(params = {}, opts = {})
-      resp, opts = request(:post, resource_url + "/cancel", params, opts)
-      initialize_from(resp.data, opts)
+      request_stripe_object(
+        method: :post,
+        path: resource_url + "/cancel",
+        params: params,
+        opts: opts
+      )
     end
 
     def cancel_url

diff --git a/lib/stripe/util.rb b/lib/stripe/util.rb
@@ -43,6 +43,10 @@ def self.object_classes
       @object_classes ||= Stripe::ObjectTypes.object_names_to_classes
     end
 
+    def self.object_name_matches_class?(object_name, klass)
+      Util.object_classes[object_name] == klass
+    end
+
     # Converts a hash of fields or an array of hashes into a +StripeObject+ or
     # array of +StripeObject+s. These new objects will be created as a concrete
     # type as dictated by their `object` field (e.g. an `object` value of