mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-07 00:05:33 -04:00
863da48398
Adds the magic `frozen_string_literal: true` comment to every file and enables a Rubocop rule to make sure that it's always going to be there going forward as well. See here for more background [1], but the basic idea is that unlike many other languages, static strings in code are mutable by default. This has since been acknowledged as not a particularly good idea, and the intention is to rectify the mistake when Ruby 3 comes out, where all string literals will be frozen. The `frozen_string_literal` magic comment was introduced in Ruby 2.3 as a way of easing the transition, and allows libraries and projects to freeze their literals in advance. I don't think this is breaking in any way: it's possible that users might've been pulling out one of are literals somehow and mutating it, but that would probably not have been useful for anything and would certainly not be recommended, so I'm quite comfortable pushing this change through as a minor version. As discussed in #641. [1] https://stackoverflow.com/a/37799399
64 lines
2.7 KiB
Ruby
64 lines
2.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
module APIOperations
|
|
# Adds methods to help manipulate a subresource from its parent resource so
|
|
# that it's possible to do so from a static context (i.e. without a
|
|
# pre-existing collection of subresources on the parent).
|
|
#
|
|
# For examle, a transfer gains the static methods for reversals so that the
|
|
# methods `.create_reversal`, `.retrieve_reversal`, `.update_reversal`,
|
|
# etc. all become available.
|
|
module NestedResource
|
|
def nested_resource_class_methods(resource, path: nil, operations: nil)
|
|
path ||= "#{resource}s"
|
|
raise ArgumentError, "operations array required" if operations.nil?
|
|
|
|
resource_url_method = :"#{resource}s_url"
|
|
define_singleton_method(resource_url_method) do |id, nested_id = nil|
|
|
url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(path)}"
|
|
url += "/#{CGI.escape(nested_id)}" unless nested_id.nil?
|
|
url
|
|
end
|
|
|
|
operations.each do |operation|
|
|
case operation
|
|
when :create
|
|
define_singleton_method(:"create_#{resource}") do |id, params = {}, opts = {}|
|
|
url = send(resource_url_method, id)
|
|
resp, opts = request(:post, url, params, opts)
|
|
Util.convert_to_stripe_object(resp.data, opts)
|
|
end
|
|
when :retrieve
|
|
define_singleton_method(:"retrieve_#{resource}") do |id, nested_id, opts = {}|
|
|
url = send(resource_url_method, id, nested_id)
|
|
resp, opts = request(:get, url, {}, opts)
|
|
Util.convert_to_stripe_object(resp.data, opts)
|
|
end
|
|
when :update
|
|
define_singleton_method(:"update_#{resource}") do |id, nested_id, params = {}, opts = {}|
|
|
url = send(resource_url_method, id, nested_id)
|
|
resp, opts = request(:post, url, params, opts)
|
|
Util.convert_to_stripe_object(resp.data, opts)
|
|
end
|
|
when :delete
|
|
define_singleton_method(:"delete_#{resource}") do |id, nested_id, params = {}, opts = {}|
|
|
url = send(resource_url_method, id, nested_id)
|
|
resp, opts = request(:delete, url, params, opts)
|
|
Util.convert_to_stripe_object(resp.data, opts)
|
|
end
|
|
when :list
|
|
define_singleton_method(:"list_#{resource}s") do |id, params = {}, opts = {}|
|
|
url = send(resource_url_method, id)
|
|
resp, opts = request(:get, url, params, opts)
|
|
Util.convert_to_stripe_object(resp.data, opts)
|
|
end
|
|
else
|
|
raise ArgumentError, "Unknown operation: #{operation.inspect}"
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|