require "cgi" module Stripe module Util def self.objects_to_ids(h) case h when APIResource h.id when Hash res = {} h.each { |k, v| res[k] = objects_to_ids(v) unless v.nil? } res when Array h.map { |v| objects_to_ids(v) } else h end end def self.object_classes @object_classes ||= { # data structures ListObject::OBJECT_NAME => ListObject, # business objects Account::OBJECT_NAME => Account, AlipayAccount::OBJECT_NAME => AlipayAccount, ApplePayDomain::OBJECT_NAME => ApplePayDomain, ApplicationFee::OBJECT_NAME => ApplicationFee, ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund, Balance::OBJECT_NAME => Balance, BalanceTransaction::OBJECT_NAME => BalanceTransaction, BankAccount::OBJECT_NAME => BankAccount, BitcoinReceiver::OBJECT_NAME => BitcoinReceiver, BitcoinTransaction::OBJECT_NAME => BitcoinTransaction, Card::OBJECT_NAME => Card, Charge::OBJECT_NAME => Charge, CountrySpec::OBJECT_NAME => CountrySpec, Coupon::OBJECT_NAME => Coupon, Customer::OBJECT_NAME => Customer, Dispute::OBJECT_NAME => Dispute, Event::OBJECT_NAME => Event, FileUpload::OBJECT_NAME => FileUpload, Invoice::OBJECT_NAME => Invoice, InvoiceItem::OBJECT_NAME => InvoiceItem, Order::OBJECT_NAME => Order, OrderReturn::OBJECT_NAME => OrderReturn, Payout::OBJECT_NAME => Payout, Plan::OBJECT_NAME => Plan, Product::OBJECT_NAME => Product, Recipient::OBJECT_NAME => Recipient, RecipientTransfer::OBJECT_NAME => RecipientTransfer, Refund::OBJECT_NAME => Refund, Reversal::OBJECT_NAME => Reversal, SKU::OBJECT_NAME => SKU, Source::OBJECT_NAME => Source, Subscription::OBJECT_NAME => Subscription, SubscriptionItem::OBJECT_NAME => SubscriptionItem, ThreeDSecure::OBJECT_NAME => ThreeDSecure, Token::OBJECT_NAME => Token, Transfer::OBJECT_NAME => Transfer, } 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 unknown type, the newly created instance will fall back # to being a +StripeObject+. # # ==== Attributes # # * +data+ - 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(data, opts = {}) case data when Array data.map { |i| convert_to_stripe_object(i, opts) } when Hash # Try converting to a known object class. If none available, fall back to generic StripeObject object_classes.fetch(data[:object], StripeObject).construct_from(data, opts) else data end end def self.file_readable(file) # This is nominally equivalent to File.readable?, but that can # report incorrect results on some more oddball filesystems # (such as AFS) begin File.open(file) { |f| } rescue false else true end end def self.symbolize_names(object) case object when Hash new_hash = {} object.each do |key, value| key = (key.to_sym rescue key) || key new_hash[key] = symbolize_names(value) end new_hash when Array object.map { |value| symbolize_names(value) } else object end end # Encodes a hash of parameters in a way that's suitable for use as query # parameters in a URI or as form parameters in a request body. This mainly # involves escaping special characters from parameter keys and values (e.g. # `&`). def self.encode_parameters(params) Util.flatten_params(params). map { |k,v| "#{url_encode(k)}=#{url_encode(v)}" }.join('&') end # Transforms an array into a hash with integer keys. Used for a small # number of API endpoints. If the argument is not an Array, return it # unchanged. Example: [{foo: 'bar'}] => {"0" => {foo: "bar"}} def self.array_to_hash(array) case array when Array hash = {} array.each_with_index { |v,i| hash[i.to_s] = v } hash else array end end # Encodes a string in a way that makes it suitable for use in a set of # query parameters in a URI or in a set of form parameters in a request # body. def self.url_encode(key) CGI.escape(key.to_s). # Don't use strict form encoding by changing the square bracket control # characters back to their literals. This is fine by the server, and # makes these parameter strings easier to read. gsub('%5B', '[').gsub('%5D', ']') end def self.flatten_params(params, parent_key=nil) result = [] # do not sort the final output because arrays (and arrays of hashes # especially) can be order sensitive, but do sort incoming parameters params.each do |key, value| calculated_key = parent_key ? "#{parent_key}[#{key}]" : "#{key}" if value.is_a?(Hash) result += flatten_params(value, calculated_key) elsif value.is_a?(Array) check_array_of_maps_start_keys!(value) result += flatten_params_array(value, calculated_key) else result << [calculated_key, value] end end result end def self.flatten_params_array(value, calculated_key) result = [] value.each do |elem| if elem.is_a?(Hash) result += flatten_params(elem, "#{calculated_key}[]") elsif elem.is_a?(Array) result += flatten_params_array(elem, calculated_key) else result << ["#{calculated_key}[]", elem] end end result end def self.normalize_id(id) if id.kind_of?(Hash) # overloaded id params_hash = id.dup id = params_hash.delete(:id) else params_hash = {} end [id, params_hash] end # The secondary opts argument can either be a string or hash # Turn this value into an api_key and a set of headers def self.normalize_opts(opts) case opts when String {:api_key => opts} when Hash check_api_key!(opts.fetch(:api_key)) if opts.has_key?(:api_key) opts.clone else raise TypeError.new('normalize_opts expects a string or a hash') end end def self.check_string_argument!(key) raise TypeError.new("argument must be a string") unless key.is_a?(String) key end def self.check_api_key!(key) raise TypeError.new("api_key must be a string") unless key.is_a?(String) key end private # We use a pretty janky version of form encoding (Rack's) that supports # more complex data structures like maps and arrays through the use of # specialized syntax. To encode an array of maps like: # # [{a: 1, b: 2}, {a: 3, b: 4}] # # We have to produce something that looks like this: # # arr[][a]=1&arr[][b]=2&arr[][a]=3&arr[][b]=4 # # The only way for the server to recognize that this is a two item array is # that it notices the repetition of element "a", so it's key that these # repeated elements are encoded first. # # This method is invoked for any arrays being encoded and checks that if # the array contains all non-empty maps, that each of those maps must start # with the same key so that their boundaries can be properly encoded. def self.check_array_of_maps_start_keys!(arr) expected_key = nil arr.each do |item| return if !item.is_a?(Hash) return if item.count == 0 first_key = item.first[0] if expected_key if expected_key != first_key raise ArgumentError, "All maps nested in an array should start with the same key " + "(expected starting key '#{expected_key}', got '#{first_key}')" end else expected_key = first_key end end end end end