sharpetronics/stripe-ruby
1
0
Fork 0
mirror of https://github.com/stripe/stripe-ruby.git synced 2025-08-24 00:00:51 -04:00
Code Issues Projects Releases Wiki Activity

Document Util.convert_to_stripe_object

Browse Source 
Adds some basic documentation to `Util.convert_to_stripe_object`.
This commit is contained in:
Brandur 2016-06-09 09:02:23 -07:00
parent 6920d9db68
commit 531e0ff317
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
lib/stripe/util.rb
View File

@ -56,6 +56,18 @@ module Stripe
}
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
# `charge` would create an instance of +Charge+), but if `object` is not
# present or of an unkown type, the newly created instance will fall back
# to being a +StripeObject+.
#
# ==== Attributes
#
# * +resp+ - Hash of fields and values to be converted into a StripeObject.
# * +opts+ - Options for +StripeObject+ like an API key that will be reused
# on subsequent API calls.
def self.convert_to_stripe_object(resp, opts)
case resp
when Array