Class: Stripe::APIResource

Inherits:
StripeObject show all
Includes:
Stripe::APIOperations::Request
Defined in:
lib/stripe/api_resource.rb

Constant Summary

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Stripe::APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#save_with_parentObject

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.


12
13
14
# File 'lib/stripe/api_resource.rb', line 12

def save_with_parent
  @save_with_parent
end

Class Method Details

.class_nameObject


14
15
16
# File 'lib/stripe/api_resource.rb', line 14

def self.class_name
  name.split("::")[-1]
end

.custom_method(name, http_verb:, http_path: nil) ⇒ Object

Adds a custom method to a resource class. This is used to add support for non-CRUDL API requests, e.g. capturing charges. custom_method takes the following parameters:

  • name: the name of the custom method to create (as a symbol)

  • http_verb: the HTTP verb for the API request (:get, :post, or :delete)

  • http_path: the path to append to the resource's URL. If not provided,

    the name is used as the path
    

For example, this call:

custom_method :capture, http_verb: post

adds a `capture` class method to the resource class that, when called, will send a POST request to `/v1/<object_name>/capture`.


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/stripe/api_resource.rb', line 65

def self.custom_method(name, http_verb:, http_path: nil)
  unless %i[get post delete].include?(http_verb)
    raise ArgumentError,
          "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
          "of :get, :post or :delete."
  end
  http_path ||= name.to_s
  define_singleton_method(name) do |id, params = {}, opts = {}|
    unless id.is_a?(String)
      raise ArgumentError,
            "id should be a string representing the ID of an API resource"
    end

    url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(http_path)}"
    resp, opts = execute_resource_request(http_verb, url, params, opts)
    Util.convert_to_stripe_object(resp.data, opts)
  end
end

.resource_urlObject


18
19
20
21
22
23
24
25
26
27
# File 'lib/stripe/api_resource.rb', line 18

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
  # Namespaces are separated in object names with periods (.) and in URLs
  # with forward slashes (/), so replace the former with the latter.
  "/v1/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
end

.retrieve(id, opts = {}) ⇒ Object


101
102
103
104
105
106
# File 'lib/stripe/api_resource.rb', line 101

def self.retrieve(id, opts = {})
  opts = Util.normalize_opts(opts)
  instance = new(id, opts)
  instance.refresh
  instance
end

.save_nested_resource(name) ⇒ Object

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.


35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/stripe/api_resource.rb', line 35

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

Instance Method Details

#refreshObject


95
96
97
98
99
# File 'lib/stripe/api_resource.rb', line 95

def refresh
  resp, opts = execute_resource_request(:get, resource_url,
                                        @retrieve_params)
  initialize_from(resp.data, opts)
end

#resource_urlObject


84
85
86
87
88
89
90
91
92
93
# File 'lib/stripe/api_resource.rb', line 84

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