stripe 3.3.1 → 5.38.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (205) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +962 -0
  3. data/CODE_OF_CONDUCT.md +77 -0
  4. data/Gemfile +24 -22
  5. data/History.txt +1 -689
  6. data/README.md +202 -55
  7. data/Rakefile +18 -12
  8. data/VERSION +1 -1
  9. data/bin/stripe-console +5 -3
  10. data/lib/stripe/api_operations/create.rb +4 -2
  11. data/lib/stripe/api_operations/delete.rb +31 -3
  12. data/lib/stripe/api_operations/list.rb +4 -13
  13. data/lib/stripe/api_operations/nested_resource.rb +73 -0
  14. data/lib/stripe/api_operations/request.rb +84 -17
  15. data/lib/stripe/api_operations/save.rb +25 -13
  16. data/lib/stripe/api_resource.rb +70 -11
  17. data/lib/stripe/connection_manager.rb +179 -0
  18. data/lib/stripe/error_object.rb +93 -0
  19. data/lib/stripe/errors.rb +47 -19
  20. data/lib/stripe/instrumentation.rb +84 -0
  21. data/lib/stripe/list_object.rb +54 -22
  22. data/lib/stripe/multipart_encoder.rb +131 -0
  23. data/lib/stripe/oauth.rb +29 -20
  24. data/lib/stripe/object_types.rb +107 -0
  25. data/lib/stripe/{account.rb → resources/account.rb} +70 -36
  26. data/lib/stripe/resources/account_link.rb +10 -0
  27. data/lib/stripe/resources/alipay_account.rb +34 -0
  28. data/lib/stripe/{apple_pay_domain.rb → resources/apple_pay_domain.rb} +5 -2
  29. data/lib/stripe/resources/application_fee.rb +14 -0
  30. data/lib/stripe/resources/application_fee_refund.rb +31 -0
  31. data/lib/stripe/resources/balance.rb +8 -0
  32. data/lib/stripe/resources/balance_transaction.rb +10 -0
  33. data/lib/stripe/resources/bank_account.rb +43 -0
  34. data/lib/stripe/resources/billing_portal/configuration.rb +14 -0
  35. data/lib/stripe/resources/billing_portal/session.rb +12 -0
  36. data/lib/stripe/{bitcoin_receiver.rb → resources/bitcoin_receiver.rb} +7 -5
  37. data/lib/stripe/resources/bitcoin_transaction.rb +16 -0
  38. data/lib/stripe/resources/capability.rb +34 -0
  39. data/lib/stripe/resources/card.rb +38 -0
  40. data/lib/stripe/resources/charge.rb +23 -0
  41. data/lib/stripe/resources/checkout/session.rb +16 -0
  42. data/lib/stripe/resources/country_spec.rb +10 -0
  43. data/lib/stripe/{coupon.rb → resources/coupon.rb} +5 -2
  44. data/lib/stripe/resources/credit_note.rb +33 -0
  45. data/lib/stripe/resources/credit_note_line_item.rb +8 -0
  46. data/lib/stripe/resources/customer.rb +41 -0
  47. data/lib/stripe/resources/customer_balance_transaction.rb +31 -0
  48. data/lib/stripe/resources/discount.rb +7 -0
  49. data/lib/stripe/resources/dispute.rb +22 -0
  50. data/lib/stripe/resources/ephemeral_key.rb +20 -0
  51. data/lib/stripe/resources/event.rb +10 -0
  52. data/lib/stripe/resources/exchange_rate.rb +10 -0
  53. data/lib/stripe/resources/file.rb +36 -0
  54. data/lib/stripe/resources/file_link.rb +12 -0
  55. data/lib/stripe/resources/identity/verification_report.rb +12 -0
  56. data/lib/stripe/resources/identity/verification_session.rb +35 -0
  57. data/lib/stripe/resources/invoice.rb +74 -0
  58. data/lib/stripe/{invoice_item.rb → resources/invoice_item.rb} +5 -2
  59. data/lib/stripe/resources/invoice_line_item.rb +8 -0
  60. data/lib/stripe/resources/issuing/authorization.rb +34 -0
  61. data/lib/stripe/resources/issuing/card.rb +25 -0
  62. data/lib/stripe/resources/issuing/card_details.rb +9 -0
  63. data/lib/stripe/resources/issuing/cardholder.rb +14 -0
  64. data/lib/stripe/resources/issuing/dispute.rb +25 -0
  65. data/lib/stripe/resources/issuing/transaction.rb +13 -0
  66. data/lib/stripe/resources/line_item.rb +8 -0
  67. data/lib/stripe/resources/login_link.rb +15 -0
  68. data/lib/stripe/resources/mandate.rb +8 -0
  69. data/lib/stripe/resources/order.rb +33 -0
  70. data/lib/stripe/resources/order_return.rb +10 -0
  71. data/lib/stripe/resources/payment_intent.rb +43 -0
  72. data/lib/stripe/resources/payment_method.rb +33 -0
  73. data/lib/stripe/resources/payout.rb +33 -0
  74. data/lib/stripe/resources/person.rb +32 -0
  75. data/lib/stripe/{plan.rb → resources/plan.rb} +4 -1
  76. data/lib/stripe/resources/price.rb +12 -0
  77. data/lib/stripe/{product.rb → resources/product.rb} +6 -3
  78. data/lib/stripe/resources/promotion_code.rb +12 -0
  79. data/lib/stripe/resources/quote.rb +105 -0
  80. data/lib/stripe/resources/radar/early_fraud_warning.rb +12 -0
  81. data/lib/stripe/resources/radar/value_list.rb +15 -0
  82. data/lib/stripe/resources/radar/value_list_item.rb +14 -0
  83. data/lib/stripe/resources/recipient.rb +14 -0
  84. data/lib/stripe/resources/recipient_transfer.rb +7 -0
  85. data/lib/stripe/{refund.rb → resources/refund.rb} +4 -1
  86. data/lib/stripe/resources/reporting/report_run.rb +13 -0
  87. data/lib/stripe/resources/reporting/report_type.rb +13 -0
  88. data/lib/stripe/resources/reversal.rb +30 -0
  89. data/lib/stripe/resources/review.rb +21 -0
  90. data/lib/stripe/resources/setup_attempt.rb +10 -0
  91. data/lib/stripe/resources/setup_intent.rb +33 -0
  92. data/lib/stripe/resources/sigma/scheduled_query_run.rb +16 -0
  93. data/lib/stripe/{sku.rb → resources/sku.rb} +6 -3
  94. data/lib/stripe/resources/source.rb +47 -0
  95. data/lib/stripe/resources/source_transaction.rb +7 -0
  96. data/lib/stripe/resources/subscription.rb +26 -0
  97. data/lib/stripe/resources/subscription_item.rb +26 -0
  98. data/lib/stripe/resources/subscription_schedule.rb +33 -0
  99. data/lib/stripe/resources/tax_code.rb +10 -0
  100. data/lib/stripe/resources/tax_id.rb +27 -0
  101. data/lib/stripe/resources/tax_rate.rb +12 -0
  102. data/lib/stripe/resources/terminal/connection_token.rb +12 -0
  103. data/lib/stripe/resources/terminal/location.rb +15 -0
  104. data/lib/stripe/resources/terminal/reader.rb +15 -0
  105. data/lib/stripe/{three_d_secure.rb → resources/three_d_secure.rb} +4 -1
  106. data/lib/stripe/resources/token.rb +10 -0
  107. data/lib/stripe/resources/topup.rb +23 -0
  108. data/lib/stripe/resources/transfer.rb +27 -0
  109. data/lib/stripe/resources/usage_record.rb +8 -0
  110. data/lib/stripe/resources/usage_record_summary.rb +8 -0
  111. data/lib/stripe/{recipient.rb → resources/webhook_endpoint.rb} +6 -7
  112. data/lib/stripe/resources.rb +90 -0
  113. data/lib/stripe/singleton_api_resource.rb +10 -4
  114. data/lib/stripe/stripe_client.rb +798 -346
  115. data/lib/stripe/stripe_configuration.rb +194 -0
  116. data/lib/stripe/stripe_object.rb +271 -126
  117. data/lib/stripe/stripe_response.rb +89 -27
  118. data/lib/stripe/util.rb +134 -194
  119. data/lib/stripe/version.rb +3 -1
  120. data/lib/stripe/webhook.rb +57 -18
  121. data/lib/stripe.rb +74 -186
  122. data/stripe.gemspec +35 -16
  123. metadata +110 -165
  124. data/.gitattributes +0 -4
  125. data/.github/ISSUE_TEMPLATE.md +0 -5
  126. data/.gitignore +0 -5
  127. data/.travis.yml +0 -38
  128. data/lib/stripe/alipay_account.rb +0 -22
  129. data/lib/stripe/application_fee.rb +0 -22
  130. data/lib/stripe/application_fee_refund.rb +0 -20
  131. data/lib/stripe/balance.rb +0 -5
  132. data/lib/stripe/balance_transaction.rb +0 -11
  133. data/lib/stripe/bank_account.rb +0 -30
  134. data/lib/stripe/bitcoin_transaction.rb +0 -11
  135. data/lib/stripe/card.rb +0 -27
  136. data/lib/stripe/charge.rb +0 -82
  137. data/lib/stripe/country_spec.rb +0 -11
  138. data/lib/stripe/customer.rb +0 -79
  139. data/lib/stripe/dispute.rb +0 -17
  140. data/lib/stripe/ephemeral_key.rb +0 -18
  141. data/lib/stripe/event.rb +0 -7
  142. data/lib/stripe/file_upload.rb +0 -33
  143. data/lib/stripe/invoice.rb +0 -29
  144. data/lib/stripe/invoice_line_item.rb +0 -5
  145. data/lib/stripe/login_link.rb +0 -9
  146. data/lib/stripe/order.rb +0 -29
  147. data/lib/stripe/order_return.rb +0 -11
  148. data/lib/stripe/payout.rb +0 -18
  149. data/lib/stripe/recipient_transfer.rb +0 -6
  150. data/lib/stripe/reversal.rb +0 -20
  151. data/lib/stripe/source.rb +0 -23
  152. data/lib/stripe/subscription.rb +0 -33
  153. data/lib/stripe/subscription_item.rb +0 -14
  154. data/lib/stripe/token.rb +0 -7
  155. data/lib/stripe/transfer.rb +0 -18
  156. data/test/api_stub_helpers.rb +0 -0
  157. data/test/stripe/account_test.rb +0 -202
  158. data/test/stripe/alipay_account_test.rb +0 -17
  159. data/test/stripe/api_operations_test.rb +0 -31
  160. data/test/stripe/api_resource_test.rb +0 -558
  161. data/test/stripe/apple_pay_domain_test.rb +0 -31
  162. data/test/stripe/application_fee_refund_test.rb +0 -35
  163. data/test/stripe/application_fee_test.rb +0 -12
  164. data/test/stripe/balance_test.rb +0 -11
  165. data/test/stripe/bank_account_test.rb +0 -36
  166. data/test/stripe/bitcoin_receiver_test.rb +0 -67
  167. data/test/stripe/bitcoin_transaction_test.rb +0 -19
  168. data/test/stripe/charge_test.rb +0 -57
  169. data/test/stripe/country_spec_test.rb +0 -18
  170. data/test/stripe/coupon_test.rb +0 -42
  171. data/test/stripe/customer_card_test.rb +0 -46
  172. data/test/stripe/customer_test.rb +0 -114
  173. data/test/stripe/dispute_test.rb +0 -40
  174. data/test/stripe/ephemeral_key_test.rb +0 -84
  175. data/test/stripe/errors_test.rb +0 -18
  176. data/test/stripe/file_upload_test.rb +0 -66
  177. data/test/stripe/invoice_item_test.rb +0 -53
  178. data/test/stripe/invoice_line_item_test.rb +0 -6
  179. data/test/stripe/invoice_test.rb +0 -110
  180. data/test/stripe/list_object_test.rb +0 -170
  181. data/test/stripe/login_link_test.rb +0 -35
  182. data/test/stripe/oauth_test.rb +0 -85
  183. data/test/stripe/order_return_test.rb +0 -19
  184. data/test/stripe/order_test.rb +0 -57
  185. data/test/stripe/payout_test.rb +0 -48
  186. data/test/stripe/plan_test.rb +0 -50
  187. data/test/stripe/product_test.rb +0 -45
  188. data/test/stripe/recipient_card_test.rb +0 -44
  189. data/test/stripe/recipient_test.rb +0 -48
  190. data/test/stripe/refund_test.rb +0 -37
  191. data/test/stripe/reversal_test.rb +0 -41
  192. data/test/stripe/sku_test.rb +0 -48
  193. data/test/stripe/source_test.rb +0 -68
  194. data/test/stripe/stripe_client_test.rb +0 -750
  195. data/test/stripe/stripe_object_test.rb +0 -398
  196. data/test/stripe/stripe_response_test.rb +0 -46
  197. data/test/stripe/subscription_item_test.rb +0 -52
  198. data/test/stripe/subscription_test.rb +0 -58
  199. data/test/stripe/three_d_secure_test.rb +0 -21
  200. data/test/stripe/transfer_test.rb +0 -41
  201. data/test/stripe/util_test.rb +0 -414
  202. data/test/stripe/webhook_test.rb +0 -92
  203. data/test/stripe_test.rb +0 -59
  204. data/test/test_data.rb +0 -59
  205. data/test/test_helper.rb +0 -56
@@ -1,13 +1,41 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Stripe
2
4
  module APIOperations
3
5
  module Request
4
6
  module ClassMethods
5
- OPTS_KEYS_TO_PERSIST = Set[:api_key, :api_base, :client, :stripe_account, :stripe_version]
7
+ def execute_resource_request(method, url,
8
+ params = {}, opts = {})
9
+ execute_resource_request_internal(
10
+ :execute_request, method, url, params, opts
11
+ )
12
+ end
13
+
14
+ def execute_resource_request_stream(method, url,
15
+ params = {}, opts = {},
16
+ &read_body_chunk_block)
17
+ execute_resource_request_internal(
18
+ :execute_request_stream,
19
+ method,
20
+ url,
21
+ params,
22
+ opts,
23
+ &read_body_chunk_block
24
+ )
25
+ end
26
+
27
+ private def execute_resource_request_internal(client_request_method_sym,
28
+ method, url,
29
+ params, opts,
30
+ &read_body_chunk_block)
31
+ params ||= {}
6
32
 
7
- def request(method, url, params={}, opts={})
33
+ error_on_invalid_params(params)
8
34
  warn_on_opts_in_params(params)
9
35
 
10
36
  opts = Util.normalize_opts(opts)
37
+ error_on_non_string_user_opts(opts)
38
+
11
39
  opts[:client] ||= StripeClient.active_client
12
40
 
13
41
  headers = opts.clone
@@ -16,32 +44,60 @@ module Stripe
16
44
  client = headers.delete(:client)
17
45
  # Assume all remaining opts must be headers
18
46
 
19
- resp, opts[:api_key] = client.execute_request(
47
+ resp, opts[:api_key] = client.send(
48
+ client_request_method_sym,
20
49
  method, url,
21
50
  api_base: api_base, api_key: api_key,
22
- headers: headers, params: params
51
+ headers: headers, params: params,
52
+ &read_body_chunk_block
23
53
  )
24
54
 
25
55
  # Hash#select returns an array before 1.9
26
56
  opts_to_persist = {}
27
57
  opts.each do |k, v|
28
- if OPTS_KEYS_TO_PERSIST.include?(k)
29
- opts_to_persist[k] = v
30
- end
58
+ opts_to_persist[k] = v if Util::OPTS_PERSISTABLE.include?(k)
31
59
  end
32
60
 
33
61
  [resp, opts_to_persist]
34
62
  end
35
63
 
36
- private
64
+ # This method used to be called `request`, but it's such a short name
65
+ # that it eventually conflicted with the name of a field on an API
66
+ # resource (specifically, `Event#request`), so it was renamed to
67
+ # something more unique.
68
+ #
69
+ # The former name had been around for just about forever though, and
70
+ # although all internal uses have been renamed, I've left this alias in
71
+ # place for backwards compatibility. Consider removing it on the next
72
+ # major.
73
+ alias request execute_resource_request
74
+
75
+ private def error_on_non_string_user_opts(opts)
76
+ Util::OPTS_USER_SPECIFIED.each do |opt|
77
+ next unless opts.key?(opt)
37
78
 
38
- KNOWN_OPTS = Set[:api_key, :idempotency_key, :stripe_account, :stripe_version]
39
- private_constant :KNOWN_OPTS
79
+ val = opts[opt]
80
+ next if val.nil?
81
+ next if val.is_a?(String)
40
82
 
41
- def warn_on_opts_in_params(params)
42
- KNOWN_OPTS.each do |opt|
43
- if params.has_key?(opt)
44
- $stderr.puts("WARNING: #{opt} should be in opts instead of params.")
83
+ raise ArgumentError,
84
+ "request option '#{opt}' should be a string value " \
85
+ "(was a #{val.class})"
86
+ end
87
+ end
88
+
89
+ private def error_on_invalid_params(params)
90
+ return if params.nil? || params.is_a?(Hash)
91
+
92
+ raise ArgumentError,
93
+ "request params should be either a Hash or nil " \
94
+ "(was a #{params.class})"
95
+ end
96
+
97
+ private def warn_on_opts_in_params(params)
98
+ Util::OPTS_USER_SPECIFIED.each do |opt|
99
+ if params.key?(opt)
100
+ warn("WARNING: '#{opt}' should be in opts instead of params.")
45
101
  end
46
102
  end
47
103
  end
@@ -51,12 +107,23 @@ module Stripe
51
107
  base.extend(ClassMethods)
52
108
  end
53
109
 
54
- protected
110
+ protected def execute_resource_request(method, url,
111
+ params = {}, opts = {})
112
+ opts = @opts.merge(Util.normalize_opts(opts))
113
+ self.class.execute_resource_request(method, url, params, opts)
114
+ end
55
115
 
56
- def request(method, url, params={}, opts={})
116
+ protected def execute_resource_request_stream(method, url,
117
+ params = {}, opts = {},
118
+ &read_body_chunk_block)
57
119
  opts = @opts.merge(Util.normalize_opts(opts))
58
- self.class.request(method, url, params, opts)
120
+ self.class.execute_resource_request_stream(
121
+ method, url, params, opts, &read_body_chunk_block
122
+ )
59
123
  end
124
+
125
+ # See notes on `alias` above.
126
+ alias request execute_resource_request
60
127
  end
61
128
  end
62
129
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Stripe
2
4
  module APIOperations
3
5
  module Save
@@ -13,15 +15,17 @@ module Stripe
13
15
  # * +opts+ - A Hash of additional options (separate from the params /
14
16
  # object values) to be added to the request. E.g. to allow for an
15
17
  # idempotency_key to be passed in the request headers, or for the
16
- # api_key to be overwritten. See {APIOperations::Request.request}.
17
- def update(id, params={}, opts={})
18
- params.each do |k, v|
19
- if self.protected_fields.include?(k)
18
+ # api_key to be overwritten. See
19
+ # {APIOperations::Request.execute_resource_request}.
20
+ def update(id, params = {}, opts = {})
21
+ params.each_key do |k|
22
+ if protected_fields.include?(k)
20
23
  raise ArgumentError, "Cannot update protected field: #{k}"
21
24
  end
22
25
  end
23
26
 
24
- resp, opts = request(:post, "#{resource_url}/#{id}", params, opts)
27
+ resp, opts = execute_resource_request(:post, "#{resource_url}/#{id}",
28
+ params, opts)
25
29
  Util.convert_to_stripe_object(resp.data, opts)
26
30
  end
27
31
  end
@@ -41,8 +45,9 @@ module Stripe
41
45
  # * +opts+ - A Hash of additional options (separate from the params /
42
46
  # object values) to be added to the request. E.g. to allow for an
43
47
  # idempotency_key to be passed in the request headers, or for the
44
- # api_key to be overwritten. See {APIOperations::Request.request}.
45
- def save(params={}, opts={})
48
+ # api_key to be overwritten. See
49
+ # {APIOperations::Request.execute_resource_request}.
50
+ def save(params = {}, opts = {})
46
51
  # We started unintentionally (sort of) allowing attributes sent to
47
52
  # +save+ to override values used during the update. So as not to break
48
53
  # the API, this makes that official here.
@@ -51,30 +56,37 @@ module Stripe
51
56
  # Now remove any parameters that look like object attributes.
52
57
  params = params.reject { |k, _| respond_to?(k) }
53
58
 
54
- values = self.serialize_params(self).merge(params)
59
+ values = serialize_params(self).merge(params)
55
60
 
56
61
  # note that id gets removed here our call to #url above has already
57
62
  # generated a uri for this object with an identifier baked in
58
63
  values.delete(:id)
59
64
 
60
- resp, opts = request(:post, save_url, values, opts)
65
+ resp, opts = execute_resource_request(:post, save_url, values, opts)
61
66
  initialize_from(resp.data, opts)
62
67
  end
63
68
 
64
69
  def self.included(base)
70
+ # Set `metadata` as additive so that when it's set directly we remember
71
+ # to clear keys that may have been previously set by sending empty
72
+ # values for them.
73
+ #
74
+ # It's possible that not every object with `Save` has `metadata`, but
75
+ # it's a close enough heuristic, and having this option set when there
76
+ # is no `metadata` field is not harmful.
77
+ base.additive_object_param(:metadata)
78
+
65
79
  base.extend(ClassMethods)
66
80
  end
67
81
 
68
- private
69
-
70
- def save_url
82
+ private def save_url
71
83
  # This switch essentially allows us "upsert"-like functionality. If the
72
84
  # API resource doesn't have an ID set (suggesting that it's new) and
73
85
  # its class responds to .create (which comes from
74
86
  # Stripe::APIOperations::Create), then use the URL to create a new
75
87
  # resource. Otherwise, generate a URL based on the object's identifier
76
88
  # for a normal update.
77
- if self[:id] == nil && self.class.respond_to?(:create)
89
+ if self[:id].nil? && self.class.respond_to?(:create)
78
90
  self.class.resource_url
79
91
  else
80
92
  resource_url
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Stripe
2
4
  class APIResource < StripeObject
3
5
  include Stripe::APIOperations::Request
@@ -10,14 +12,18 @@ module Stripe
10
12
  attr_accessor :save_with_parent
11
13
 
12
14
  def self.class_name
13
- self.name.split('::')[-1]
15
+ name.split("::")[-1]
14
16
  end
15
17
 
16
18
  def self.resource_url
17
19
  if self == APIResource
18
- raise NotImplementedError.new('APIResource is an abstract class. You should perform actions on its subclasses (Charge, Customer, etc.)')
20
+ raise NotImplementedError,
21
+ "APIResource is an abstract class. You should perform actions " \
22
+ "on its subclasses (Charge, Customer, etc.)"
19
23
  end
20
- "/v1/#{CGI.escape(class_name.downcase)}s"
24
+ # Namespaces are separated in object names with periods (.) and in URLs
25
+ # with forward slashes (/), so replace the former with the latter.
26
+ "/v1/#{self::OBJECT_NAME.downcase.tr('.', '/')}s"
21
27
  end
22
28
 
23
29
  # A metaprogramming call that specifies that a field of a resource can be
@@ -38,31 +44,84 @@ module Stripe
38
44
  # Note that the value may be subresource, but could also be a scalar
39
45
  # (like a tokenized card's ID for example), so we check the type before
40
46
  # setting #save_with_parent here.
41
- if value.is_a?(APIResource)
42
- value.save_with_parent = true
43
- end
47
+ value.save_with_parent = true if value.is_a?(APIResource)
44
48
 
45
49
  value
46
50
  end
47
51
  end
48
52
 
53
+ # Adds a custom method to a resource class. This is used to add support for
54
+ # non-CRUDL API requests, e.g. capturing charges. custom_method takes the
55
+ # following parameters:
56
+ # - name: the name of the custom method to create (as a symbol)
57
+ # - http_verb: the HTTP verb for the API request (:get, :post, or :delete)
58
+ # - http_path: the path to append to the resource's URL. If not provided,
59
+ # the name is used as the path
60
+ #
61
+ # For example, this call:
62
+ # custom_method :capture, http_verb: post
63
+ # adds a `capture` class method to the resource class that, when called,
64
+ # will send a POST request to `/v1/<object_name>/capture`.
65
+ def self.custom_method(name, http_verb:, http_path: nil)
66
+ unless %i[get post delete].include?(http_verb)
67
+ raise ArgumentError,
68
+ "Invalid http_verb value: #{http_verb.inspect}. Should be one " \
69
+ "of :get, :post or :delete."
70
+ end
71
+ http_path ||= name.to_s
72
+ define_singleton_method(name) do |id, params = {}, opts = {}|
73
+ unless id.is_a?(String)
74
+ raise ArgumentError,
75
+ "id should be a string representing the ID of an API resource"
76
+ end
77
+
78
+ url = "#{resource_url}/#{CGI.escape(id)}/#{CGI.escape(http_path)}"
79
+ resp, opts = execute_resource_request(http_verb, url, params, opts)
80
+ Util.convert_to_stripe_object(resp.data, opts)
81
+ end
82
+ end
83
+
49
84
  def resource_url
50
- unless id = self['id']
51
- raise InvalidRequestError.new("Could not determine which URL to request: #{self.class} instance has invalid ID: #{id.inspect}", 'id')
85
+ unless (id = self["id"])
86
+ raise InvalidRequestError.new(
87
+ "Could not determine which URL to request: #{self.class} instance " \
88
+ "has invalid ID: #{id.inspect}",
89
+ "id"
90
+ )
52
91
  end
53
92
  "#{self.class.resource_url}/#{CGI.escape(id)}"
54
93
  end
55
94
 
56
95
  def refresh
57
- resp, opts = request(:get, resource_url, @retrieve_params)
96
+ resp, opts = execute_resource_request(:get, resource_url,
97
+ @retrieve_params)
58
98
  initialize_from(resp.data, opts)
59
99
  end
60
100
 
61
- def self.retrieve(id, opts={})
101
+ def self.retrieve(id, opts = {})
62
102
  opts = Util.normalize_opts(opts)
63
- instance = self.new(id, opts)
103
+ instance = new(id, opts)
64
104
  instance.refresh
65
105
  instance
66
106
  end
107
+
108
+ protected def request_stripe_object(method:, path:, params:, opts: {})
109
+ resp, opts = execute_resource_request(method, path, params, opts)
110
+
111
+ # If we're getting back this thing, update; otherwise, instantiate.
112
+ if Util.object_name_matches_class?(resp.data[:object], self.class)
113
+ initialize_from(resp.data, opts)
114
+ else
115
+ Util.convert_to_stripe_object(resp.data, opts)
116
+ end
117
+ end
118
+
119
+ protected def request_stream(method:, path:, params:, opts: {},
120
+ &read_body_chunk_block)
121
+ resp, = execute_resource_request_stream(
122
+ method, path, params, opts, &read_body_chunk_block
123
+ )
124
+ resp
125
+ end
67
126
  end
68
127
  end
@@ -0,0 +1,179 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Stripe
4
+ # Manages connections across multiple hosts which is useful because the
5
+ # library may connect to multiple hosts during a typical session (main API,
6
+ # Connect, Uploads). Ruby doesn't provide an easy way to make this happen
7
+ # easily, so this class is designed to track what we're connected to and
8
+ # manage the lifecycle of those connections.
9
+ #
10
+ # Note that this class in itself is *not* thread safe. We expect it to be
11
+ # instantiated once per thread.
12
+ class ConnectionManager
13
+ # Timestamp (in seconds procured from the system's monotonic clock)
14
+ # indicating when the connection manager last made a request. This is used
15
+ # by `StripeClient` to determine whether a connection manager should be
16
+ # garbage collected or not.
17
+ attr_reader :last_used
18
+ attr_reader :config
19
+
20
+ def initialize(config = Stripe.config)
21
+ @config = config
22
+ @active_connections = {}
23
+ @last_used = Util.monotonic_time
24
+
25
+ # A connection manager may be accessed across threads as one thread makes
26
+ # requests on it while another is trying to clear it (either because it's
27
+ # trying to garbage collect the manager or trying to clear it because a
28
+ # configuration setting has changed). That's probably thread-safe already
29
+ # because of Ruby's GIL, but just in case the library's running on JRuby
30
+ # or the like, use a mutex to synchronize access in this connection
31
+ # manager.
32
+ @mutex = Mutex.new
33
+ end
34
+
35
+ # Finishes any active connections by closing their TCP connection and
36
+ # clears them from internal tracking.
37
+ def clear
38
+ @mutex.synchronize do
39
+ @active_connections.each do |_, connection|
40
+ connection.finish
41
+ end
42
+ @active_connections = {}
43
+ end
44
+ end
45
+
46
+ # Gets a connection for a given URI. This is for internal use only as it's
47
+ # subject to change (we've moved between HTTP client schemes in the past
48
+ # and may do it again).
49
+ #
50
+ # `uri` is expected to be a string.
51
+ def connection_for(uri)
52
+ @mutex.synchronize do
53
+ u = URI.parse(uri)
54
+ connection = @active_connections[[u.host, u.port]]
55
+
56
+ if connection.nil?
57
+ connection = create_connection(u)
58
+ connection.start
59
+
60
+ @active_connections[[u.host, u.port]] = connection
61
+ end
62
+
63
+ connection
64
+ end
65
+ end
66
+
67
+ # Executes an HTTP request to the given URI with the given method. Also
68
+ # allows a request body, headers, and query string to be specified.
69
+ def execute_request(method, uri, body: nil, headers: nil, query: nil,
70
+ &block)
71
+ # Perform some basic argument validation because it's easy to get
72
+ # confused between strings and hashes for things like body and query
73
+ # parameters.
74
+ raise ArgumentError, "method should be a symbol" \
75
+ unless method.is_a?(Symbol)
76
+ raise ArgumentError, "uri should be a string" \
77
+ unless uri.is_a?(String)
78
+ raise ArgumentError, "body should be a string" \
79
+ if body && !body.is_a?(String)
80
+ raise ArgumentError, "headers should be a hash" \
81
+ if headers && !headers.is_a?(Hash)
82
+ raise ArgumentError, "query should be a string" \
83
+ if query && !query.is_a?(String)
84
+
85
+ @last_used = Util.monotonic_time
86
+
87
+ connection = connection_for(uri)
88
+
89
+ u = URI.parse(uri)
90
+ path = if query
91
+ u.path + "?" + query
92
+ else
93
+ u.path
94
+ end
95
+
96
+ method_name = method.to_s.upcase
97
+ has_response_body = method_name != "HEAD"
98
+ request = Net::HTTPGenericRequest.new(
99
+ method_name,
100
+ (body ? true : false),
101
+ has_response_body,
102
+ path,
103
+ headers
104
+ )
105
+
106
+ @mutex.synchronize do
107
+ # The block parameter is special here. If a block is provided, the block
108
+ # is invoked with the Net::HTTPResponse. However, the body will not have
109
+ # been read yet in the block, and can be streamed by calling
110
+ # HTTPResponse#read_body.
111
+ connection.request(request, body, &block)
112
+ end
113
+ end
114
+
115
+ #
116
+ # private
117
+ #
118
+
119
+ # `uri` should be a parsed `URI` object.
120
+ private def create_connection(uri)
121
+ # These all come back as `nil` if no proxy is configured.
122
+ proxy_host, proxy_port, proxy_user, proxy_pass = proxy_parts
123
+
124
+ connection = Net::HTTP.new(uri.host, uri.port,
125
+ proxy_host, proxy_port,
126
+ proxy_user, proxy_pass)
127
+
128
+ # Time in seconds within which Net::HTTP will try to reuse an already
129
+ # open connection when issuing a new operation. Outside this window, Ruby
130
+ # will transparently close and re-open the connection without trying to
131
+ # reuse it.
132
+ #
133
+ # Ruby's default of 2 seconds is almost certainly too short. Here I've
134
+ # reused Go's default for `DefaultTransport`.
135
+ connection.keep_alive_timeout = 30
136
+
137
+ connection.open_timeout = config.open_timeout
138
+ connection.read_timeout = config.read_timeout
139
+ if connection.respond_to?(:write_timeout=)
140
+ connection.write_timeout = config.write_timeout
141
+ end
142
+
143
+ connection.use_ssl = uri.scheme == "https"
144
+
145
+ if config.verify_ssl_certs
146
+ connection.verify_mode = OpenSSL::SSL::VERIFY_PEER
147
+ connection.cert_store = config.ca_store
148
+ else
149
+ connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
150
+ warn_ssl_verify_none
151
+ end
152
+
153
+ connection
154
+ end
155
+
156
+ # `Net::HTTP` somewhat awkwardly requires each component of a proxy URI
157
+ # (host, port, etc.) rather than the URI itself. This method simply parses
158
+ # out those pieces to make passing them into a new connection a little less
159
+ # ugly.
160
+ private def proxy_parts
161
+ if config.proxy.nil?
162
+ [nil, nil, nil, nil]
163
+ else
164
+ u = URI.parse(config.proxy)
165
+ [u.host, u.port, u.user, u.password]
166
+ end
167
+ end
168
+
169
+ private def warn_ssl_verify_none
170
+ return if @verify_ssl_warned
171
+
172
+ @verify_ssl_warned = true
173
+ warn("WARNING: Running without SSL cert verification. " \
174
+ "You should never do this in production. " \
175
+ "Execute `Stripe.verify_ssl_certs = true` to enable " \
176
+ "verification.")
177
+ end
178
+ end
179
+ end
@@ -0,0 +1,93 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Stripe
4
+ # Represents an error object as returned by the API.
5
+ #
6
+ # @see https://stripe.com/docs/api/errors
7
+ class ErrorObject < StripeObject
8
+ # Unlike other objects, we explicitly declare getter methods here. This
9
+ # is because the API doesn't return `null` values for fields on this
10
+ # object, rather the fields are omitted entirely. Not declaring the getter
11
+ # methods would cause users to run into `NoMethodError` exceptions and
12
+ # get in the way of generic error handling.
13
+
14
+ # For card errors, the ID of the failed charge.
15
+ def charge
16
+ @values[:charge]
17
+ end
18
+
19
+ # For some errors that could be handled programmatically, a short string
20
+ # indicating the error code reported.
21
+ def code
22
+ @values[:code]
23
+ end
24
+
25
+ # For card errors resulting from a card issuer decline, a short string
26
+ # indicating the card issuer's reason for the decline if they provide one.
27
+ def decline_code
28
+ @values[:decline_code]
29
+ end
30
+
31
+ # A URL to more information about the error code reported.
32
+ def doc_url
33
+ @values[:doc_url]
34
+ end
35
+
36
+ # A human-readable message providing more details about the error. For card
37
+ # errors, these messages can be shown to your users.
38
+ def message
39
+ @values[:message]
40
+ end
41
+
42
+ # If the error is parameter-specific, the parameter related to the error.
43
+ # For example, you can use this to display a message near the correct form
44
+ # field.
45
+ def param
46
+ @values[:param]
47
+ end
48
+
49
+ # The PaymentIntent object for errors returned on a request involving a
50
+ # PaymentIntent.
51
+ def payment_intent
52
+ @values[:payment_intent]
53
+ end
54
+
55
+ # The PaymentMethod object for errors returned on a request involving a
56
+ # PaymentMethod.
57
+ def payment_method
58
+ @values[:payment_method]
59
+ end
60
+
61
+ # The SetupIntent object for errors returned on a request involving a
62
+ # SetupIntent.
63
+ def setup_intent
64
+ @values[:setup_intent]
65
+ end
66
+
67
+ # The source object for errors returned on a request involving a source.
68
+ def source
69
+ @values[:source]
70
+ end
71
+
72
+ # The type of error returned. One of `api_error`, `card_error`,
73
+ # `idempotency_error`, or `invalid_request_error`.
74
+ def type
75
+ @values[:type]
76
+ end
77
+ end
78
+
79
+ # Represents on OAuth error returned by the OAuth API.
80
+ #
81
+ # @see https://stripe.com/docs/connect/oauth-reference#post-token-errors
82
+ class OAuthErrorObject < StripeObject
83
+ # A unique error code per error type.
84
+ def error
85
+ @values[:error]
86
+ end
87
+
88
+ # A human readable description of the error.
89
+ def error_description
90
+ @values[:error_description]
91
+ end
92
+ end
93
+ end