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 'list' => ListObject, # business objects 'account' => Account, 'alipay_account' => AlipayAccount, 'application_fee' => ApplicationFee, 'balance' => Balance, 'balance_transaction' => BalanceTransaction, 'bank_account' => BankAccount, 'card' => Card, 'charge' => Charge, 'country_spec' => CountrySpec, 'coupon' => Coupon, 'customer' => Customer, 'event' => Event, 'fee_refund' => ApplicationFeeRefund, 'invoiceitem' => InvoiceItem, 'invoice' => Invoice, 'plan' => Plan, 'recipient' => Recipient, 'refund' => Refund, 'subscription' => Subscription, 'file_upload' => FileUpload, 'token' => Token, 'transfer' => Transfer, 'transfer_reversal' => Reversal, 'bitcoin_receiver' => BitcoinReceiver, 'bitcoin_transaction' => BitcoinTransaction, 'dispute' => Dispute, 'product' => Product, 'sku' => SKU, 'order' => Order, 'order_return' => OrderReturn, 'three_d_secure' => ThreeDSecure, } 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 resp.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(resp[:object], StripeObject).construct_from(resp, opts) else resp 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 # 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) 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 end end