mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-06-02 00:00:35 -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
69 lines
2.4 KiB
Ruby
69 lines
2.4 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Stripe
|
|
class APIResource < StripeObject
|
|
include Stripe::APIOperations::Request
|
|
|
|
# A flag that can be set a behavior that will cause this resource to be
|
|
# encoded and sent up along with an update of its parent resource. This is
|
|
# usually not desirable because resources are updated individually on their
|
|
# own endpoints, but there are certain cases, replacing a customer's source
|
|
# for example, where this is allowed.
|
|
attr_accessor :save_with_parent
|
|
|
|
def self.class_name
|
|
name.split("::")[-1]
|
|
end
|
|
|
|
def self.resource_url
|
|
if self == APIResource
|
|
raise NotImplementedError, "APIResource is an abstract class. You should perform actions on its subclasses (Charge, Customer, etc.)"
|
|
end
|
|
"/v1/#{CGI.escape(class_name.downcase)}s"
|
|
end
|
|
|
|
# A metaprogramming call that specifies that a field of a resource can be
|
|
# its own type of API resource (say a nested card under an account for
|
|
# example), and if that resource is set, it should be transmitted to the
|
|
# API on a create or update. Doing so is not the default behavior because
|
|
# API resources should normally be persisted on their own RESTful
|
|
# endpoints.
|
|
def self.save_nested_resource(name)
|
|
define_method(:"#{name}=") do |value|
|
|
super(value)
|
|
|
|
# The parent setter will perform certain useful operations like
|
|
# converting to an APIResource if appropriate. Refresh our argument
|
|
# value to whatever it mutated to.
|
|
value = send(name)
|
|
|
|
# Note that the value may be subresource, but could also be a scalar
|
|
# (like a tokenized card's ID for example), so we check the type before
|
|
# setting #save_with_parent here.
|
|
value.save_with_parent = true if value.is_a?(APIResource)
|
|
|
|
value
|
|
end
|
|
end
|
|
|
|
def resource_url
|
|
unless (id = self["id"])
|
|
raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", "id")
|
|
end
|
|
"#{self.class.resource_url}/#{CGI.escape(id)}"
|
|
end
|
|
|
|
def refresh
|
|
resp, opts = request(:get, resource_url, @retrieve_params)
|
|
initialize_from(resp.data, opts)
|
|
end
|
|
|
|
def self.retrieve(id, opts = {})
|
|
opts = Util.normalize_opts(opts)
|
|
instance = new(id, opts)
|
|
instance.refresh
|
|
instance
|
|
end
|
|
end
|
|
end
|