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
data/lib/stripe/errors.rb CHANGED
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Stripe
2
4
  # StripeError is the base error from which all other more specific Stripe
3
5
  # errors derive.
@@ -8,8 +10,8 @@ module Stripe
8
10
  # about the response that conveyed the error.
9
11
  attr_accessor :response
10
12
 
11
- # These fields are now available as part of #response and that usage should
12
- # be preferred.
13
+ attr_reader :code
14
+ attr_reader :error
13
15
  attr_reader :http_body
14
16
  attr_reader :http_headers
15
17
  attr_reader :http_status
@@ -17,14 +19,30 @@ module Stripe
17
19
  attr_reader :request_id
18
20
 
19
21
  # Initializes a StripeError.
20
- def initialize(message=nil, http_status: nil, http_body: nil, json_body: nil,
21
- http_headers: nil)
22
+ def initialize(message = nil, http_status: nil, http_body: nil,
23
+ json_body: nil, http_headers: nil, code: nil)
22
24
  @message = message
23
25
  @http_status = http_status
24
26
  @http_body = http_body
25
27
  @http_headers = http_headers || {}
28
+ @idempotent_replayed = @http_headers["idempotent-replayed"] == "true"
26
29
  @json_body = json_body
27
- @request_id = @http_headers[:request_id]
30
+ @code = code
31
+ @request_id = @http_headers["request-id"]
32
+ @error = construct_error_object
33
+ end
34
+
35
+ def construct_error_object
36
+ return nil if @json_body.nil? || !@json_body.key?(:error)
37
+
38
+ ErrorObject.construct_from(@json_body[:error])
39
+ end
40
+
41
+ # Whether the error was the result of an idempotent replay, meaning that it
42
+ # originally occurred on a previous request and is being replayed back
43
+ # because the user sent the same idempotency key for this one.
44
+ def idempotent_replayed?
45
+ @idempotent_replayed
28
46
  end
29
47
 
30
48
  def to_s
@@ -55,26 +73,32 @@ module Stripe
55
73
  # CardError is raised when a user enters a card that can't be charged for
56
74
  # some reason.
57
75
  class CardError < StripeError
58
- attr_reader :param, :code
76
+ attr_reader :param
59
77
 
60
- def initialize(message, param, code, http_status: nil, http_body: nil, json_body: nil,
61
- http_headers: nil)
78
+ def initialize(message, param, code: nil, http_status: nil, http_body: nil,
79
+ json_body: nil, http_headers: nil)
62
80
  super(message, http_status: http_status, http_body: http_body,
63
- json_body: json_body, http_headers: http_headers)
81
+ json_body: json_body, http_headers: http_headers,
82
+ code: code)
64
83
  @param = param
65
- @code = code
66
84
  end
67
85
  end
68
86
 
87
+ # IdempotencyError is raised in cases where an idempotency key was used
88
+ # improperly.
89
+ class IdempotencyError < StripeError
90
+ end
91
+
69
92
  # InvalidRequestError is raised when a request is initiated with invalid
70
93
  # parameters.
71
94
  class InvalidRequestError < StripeError
72
95
  attr_accessor :param
73
96
 
74
- def initialize(message, param, http_status: nil, http_body: nil, json_body: nil,
75
- http_headers: nil)
97
+ def initialize(message, param, http_status: nil, http_body: nil,
98
+ json_body: nil, http_headers: nil, code: nil)
76
99
  super(message, http_status: http_status, http_body: http_body,
77
- json_body: json_body, http_headers: http_headers)
100
+ json_body: json_body, http_headers: http_headers,
101
+ code: code)
78
102
  @param = param
79
103
  end
80
104
  end
@@ -104,13 +128,17 @@ module Stripe
104
128
  module OAuth
105
129
  # OAuthError is raised when the OAuth API returns an error.
106
130
  class OAuthError < StripeError
107
- attr_accessor :code
108
-
109
- def initialize(code, description, http_status: nil, http_body: nil, json_body: nil,
110
- http_headers: nil)
131
+ def initialize(code, description, http_status: nil, http_body: nil,
132
+ json_body: nil, http_headers: nil)
111
133
  super(description, http_status: http_status, http_body: http_body,
112
- json_body: json_body, http_headers: http_headers)
113
- @code = code
134
+ json_body: json_body, http_headers: http_headers,
135
+ code: code)
136
+ end
137
+
138
+ def construct_error_object
139
+ return nil if @json_body.nil?
140
+
141
+ OAuthErrorObject.construct_from(@json_body)
114
142
  end
115
143
  end
116
144
 
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Stripe
4
+ class Instrumentation
5
+ # Event emitted on `request_begin` callback.
6
+ class RequestBeginEvent
7
+ attr_reader :method
8
+ attr_reader :path
9
+
10
+ # Arbitrary user-provided data in the form of a Ruby hash that's passed
11
+ # from subscribers on `request_begin` to subscribers on `request_end`.
12
+ # `request_begin` subscribers can set keys which will then be available
13
+ # in `request_end`.
14
+ #
15
+ # Note that all subscribers of `request_begin` share the same object, so
16
+ # they must be careful to set unique keys so as to not conflict with data
17
+ # set by other subscribers.
18
+ attr_reader :user_data
19
+
20
+ def initialize(method:, path:, user_data:)
21
+ @method = method
22
+ @path = path
23
+ @user_data = user_data
24
+ freeze
25
+ end
26
+ end
27
+
28
+ # Event emitted on `request_end` callback.
29
+ class RequestEndEvent
30
+ attr_reader :duration
31
+ attr_reader :http_status
32
+ attr_reader :method
33
+ attr_reader :num_retries
34
+ attr_reader :path
35
+ attr_reader :request_id
36
+
37
+ # Arbitrary user-provided data in the form of a Ruby hash that's passed
38
+ # from subscribers on `request_begin` to subscribers on `request_end`.
39
+ # `request_begin` subscribers can set keys which will then be available
40
+ # in `request_end`.
41
+ attr_reader :user_data
42
+
43
+ def initialize(duration:, http_status:, method:, num_retries:, path:,
44
+ request_id:, user_data: nil)
45
+ @duration = duration
46
+ @http_status = http_status
47
+ @method = method
48
+ @num_retries = num_retries
49
+ @path = path
50
+ @request_id = request_id
51
+ @user_data = user_data
52
+ freeze
53
+ end
54
+ end
55
+
56
+ # This class was renamed for consistency. This alias is here for backwards
57
+ # compatibility.
58
+ RequestEvent = RequestEndEvent
59
+
60
+ # Returns true if there are a non-zero number of subscribers on the given
61
+ # topic, and false otherwise.
62
+ def self.any_subscribers?(topic)
63
+ !subscribers[topic].empty?
64
+ end
65
+
66
+ def self.subscribe(topic, name = rand, &block)
67
+ subscribers[topic][name] = block
68
+ name
69
+ end
70
+
71
+ def self.unsubscribe(topic, name)
72
+ subscribers[topic].delete(name)
73
+ end
74
+
75
+ def self.notify(topic, event)
76
+ subscribers[topic].each_value { |subscriber| subscriber.call(event) }
77
+ end
78
+
79
+ def self.subscribers
80
+ @subscribers ||= Hash.new { |hash, key| hash[key] = {} }
81
+ end
82
+ private_class_method :subscribers
83
+ end
84
+ end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Stripe
2
4
  class ListObject < StripeObject
3
5
  include Enumerable
@@ -5,7 +7,7 @@ module Stripe
5
7
  include Stripe::APIOperations::Request
6
8
  include Stripe::APIOperations::Create
7
9
 
8
- OBJECT_NAME = 'list'
10
+ OBJECT_NAME = "list"
9
11
 
10
12
  # This accessor allows a `ListObject` to inherit various filters that were
11
13
  # given to a predecessor. This allows for things like consistent limits,
@@ -15,8 +17,8 @@ module Stripe
15
17
  # An empty list object. This is returned from +next+ when we know that
16
18
  # there isn't a next page in order to replicate the behavior of the API
17
19
  # when it attempts to return a page beyond the last.
18
- def self.empty_list(opts={})
19
- ListObject.construct_from({ :data => [] }, opts)
20
+ def self.empty_list(opts = {})
21
+ ListObject.construct_from({ data: [] }, opts)
20
22
  end
21
23
 
22
24
  def initialize(*args)
@@ -24,12 +26,16 @@ module Stripe
24
26
  self.filters = {}
25
27
  end
26
28
 
27
- def [](k)
28
- case k
29
+ def [](key)
30
+ case key
29
31
  when String, Symbol
30
32
  super
31
33
  else
32
- raise ArgumentError.new("You tried to access the #{k.inspect} index, but ListObject types only support String keys. (HINT: List calls return an object with a 'data' (which is the data array). You likely want to call #data[#{k.inspect}])")
34
+ raise ArgumentError,
35
+ "You tried to access the #{key.inspect} index, but ListObject " \
36
+ "types only support String keys. (HINT: List calls return an " \
37
+ "object with a 'data' (which is the data array). You likely " \
38
+ "want to call #data[#{key.inspect}])"
33
39
  end
34
40
  end
35
41
 
@@ -39,12 +45,22 @@ module Stripe
39
45
  # Note that this method makes no effort to fetch a new page when it gets to
40
46
  # the end of the current page's resources. See also +auto_paging_each+.
41
47
  def each(&blk)
42
- self.data.each(&blk)
48
+ data.each(&blk)
43
49
  end
44
50
 
45
51
  # Iterates through each resource in all pages, making additional fetches to
46
52
  # the API as necessary.
47
53
  #
54
+ # The default iteration direction is forwards according to Stripe's API
55
+ # "natural" ordering direction -- newer objects first, and moving towards
56
+ # older objects.
57
+ #
58
+ # However, if the initial list object was fetched using an `ending_before`
59
+ # cursor (and only `ending_before`, `starting_after` cannot also be
60
+ # included), the method assumes that the user is trying to iterate
61
+ # backwards compared to natural ordering and returns results that way --
62
+ # older objects first, and moving towards newer objects.
63
+ #
48
64
  # Note that this method will make as many API calls as necessary to fetch
49
65
  # all resources. For more granular control, please see +each+ and
50
66
  # +next_page+.
@@ -53,20 +69,31 @@ module Stripe
53
69
 
54
70
  page = self
55
71
  loop do
56
- page.each(&blk)
57
- page = page.next_page
72
+ # Backward iterating activates if we have an `ending_before` constraint
73
+ # and _just_ an `ending_before` constraint. If `starting_after` was
74
+ # also used, we iterate forwards normally.
75
+ if filters.include?(:ending_before) &&
76
+ !filters.include?(:starting_after)
77
+ page.reverse_each(&blk)
78
+ page = page.previous_page
79
+ else
80
+ page.each(&blk)
81
+ page = page.next_page
82
+ end
83
+
58
84
  break if page.empty?
59
85
  end
60
86
  end
61
87
 
62
88
  # Returns true if the page object contains no elements.
63
89
  def empty?
64
- self.data.empty?
90
+ data.empty?
65
91
  end
66
92
 
67
- def retrieve(id, opts={})
93
+ def retrieve(id, opts = {})
68
94
  id, retrieve_params = Util.normalize_id(id)
69
- resp, opts = request(:get,"#{resource_url}/#{CGI.escape(id)}", retrieve_params, opts)
95
+ url = "#{resource_url}/#{CGI.escape(id)}"
96
+ resp, opts = execute_resource_request(:get, url, retrieve_params, opts)
70
97
  Util.convert_to_stripe_object(resp.data, opts)
71
98
  end
72
99
 
@@ -74,13 +101,12 @@ module Stripe
74
101
  #
75
102
  # This method will try to respect the limit of the current page. If none
76
103
  # was given, the default limit will be fetched again.
77
- def next_page(params={}, opts={})
78
- return self.class.empty_list(opts) if !has_more
104
+ def next_page(params = {}, opts = {})
105
+ return self.class.empty_list(opts) unless has_more
106
+
79
107
  last_id = data.last.id
80
108
 
81
- params = filters.merge({
82
- :starting_after => last_id,
83
- }).merge(params)
109
+ params = filters.merge(starting_after: last_id).merge(params)
84
110
 
85
111
  list(params, opts)
86
112
  end
@@ -89,19 +115,25 @@ module Stripe
89
115
  #
90
116
  # This method will try to respect the limit of the current page. If none
91
117
  # was given, the default limit will be fetched again.
92
- def previous_page(params={}, opts={})
118
+ def previous_page(params = {}, opts = {})
119
+ return self.class.empty_list(opts) unless has_more
120
+
93
121
  first_id = data.first.id
94
122
 
95
- params = filters.merge({
96
- :ending_before => first_id,
97
- }).merge(params)
123
+ params = filters.merge(ending_before: first_id).merge(params)
98
124
 
99
125
  list(params, opts)
100
126
  end
101
127
 
102
128
  def resource_url
103
- self.url ||
129
+ url ||
104
130
  raise(ArgumentError, "List object does not contain a 'url' field.")
105
131
  end
132
+
133
+ # Iterates through each resource in the page represented by the current
134
+ # `ListObject` in reverse.
135
+ def reverse_each(&blk)
136
+ data.reverse_each(&blk)
137
+ end
106
138
  end
107
139
  end
@@ -0,0 +1,131 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "securerandom"
4
+ require "tempfile"
5
+
6
+ module Stripe
7
+ # Encodes parameters into a `multipart/form-data` payload as described by RFC
8
+ # 2388:
9
+ #
10
+ # https://tools.ietf.org/html/rfc2388
11
+ #
12
+ # This is most useful for transferring file-like objects.
13
+ #
14
+ # Parameters should be added with `#encode`. When ready, use `#body` to get
15
+ # the encoded result and `#content_type` to get the value that should be
16
+ # placed in the `Content-Type` header of a subsequent request (which includes
17
+ # a boundary value).
18
+ class MultipartEncoder
19
+ MULTIPART_FORM_DATA = "multipart/form-data"
20
+
21
+ # A shortcut for encoding a single set of parameters and finalizing a
22
+ # result.
23
+ #
24
+ # Returns an encoded body and the value that should be set in the content
25
+ # type header of a subsequent request.
26
+ def self.encode(params)
27
+ encoder = MultipartEncoder.new
28
+ encoder.encode(params)
29
+ encoder.close
30
+ [encoder.body, encoder.content_type]
31
+ end
32
+
33
+ # Gets the object's randomly generated boundary string.
34
+ attr_reader :boundary
35
+
36
+ # Initializes a new multipart encoder.
37
+ def initialize
38
+ # Kind of weird, but required by Rubocop because the unary plus operator
39
+ # is considered faster than `Stripe.new`.
40
+ @body = +""
41
+
42
+ # Chose the same number of random bytes that Go uses in its standard
43
+ # library implementation. Easily enough entropy to ensure that it won't
44
+ # be present in a file we're sending.
45
+ @boundary = SecureRandom.hex(30)
46
+
47
+ @closed = false
48
+ @first_field = true
49
+ end
50
+
51
+ # Gets the encoded body. `#close` must be called first.
52
+ def body
53
+ raise "object must be closed before getting body" unless @closed
54
+
55
+ @body
56
+ end
57
+
58
+ # Finalizes the object by writing the final boundary.
59
+ def close
60
+ raise "object already closed" if @closed
61
+
62
+ @body << "\r\n"
63
+ @body << "--#{@boundary}--"
64
+
65
+ @closed = true
66
+
67
+ nil
68
+ end
69
+
70
+ # Gets the value including boundary that should be put into a multipart
71
+ # request's `Content-Type`.
72
+ def content_type
73
+ "#{MULTIPART_FORM_DATA}; boundary=#{@boundary}"
74
+ end
75
+
76
+ # Encodes a set of parameters to the body.
77
+ #
78
+ # Note that parameters are expected to be a hash, but a "flat" hash such
79
+ # that complex substructures like hashes and arrays have already been
80
+ # appropriately Stripe-encoded. Pass a complex structure through
81
+ # `Util.flatten_params` first before handing it off to this method.
82
+ def encode(params)
83
+ raise "no more parameters can be written to closed object" if @closed
84
+
85
+ params.each do |name, val|
86
+ if val.is_a?(::File) || val.is_a?(::Tempfile)
87
+ write_field(name, val.read, filename: ::File.basename(val.path))
88
+ elsif val.respond_to?(:read)
89
+ write_field(name, val.read, filename: "blob")
90
+ else
91
+ write_field(name, val, filename: nil)
92
+ end
93
+ end
94
+
95
+ nil
96
+ end
97
+
98
+ #
99
+ # private
100
+ #
101
+
102
+ # Escapes double quotes so that the given value can be used in a
103
+ # double-quoted string and replaces any linebreak characters with spaces.
104
+ private def escape(str)
105
+ str.gsub('"', "%22").tr("\n", " ").tr("\r", " ")
106
+ end
107
+
108
+ private def write_field(name, data, filename:)
109
+ if !@first_field
110
+ @body << "\r\n"
111
+ else
112
+ @first_field = false
113
+ end
114
+
115
+ @body << "--#{@boundary}\r\n"
116
+
117
+ if filename
118
+ @body << %(Content-Disposition: form-data) +
119
+ %(; name="#{escape(name.to_s)}") +
120
+ %(; filename="#{escape(filename)}"\r\n)
121
+ @body << %(Content-Type: application/octet-stream\r\n)
122
+ else
123
+ @body << %(Content-Disposition: form-data) +
124
+ %(; name="#{escape(name.to_s)}"\r\n)
125
+ end
126
+
127
+ @body << "\r\n"
128
+ @body << data.to_s
129
+ end
130
+ end
131
+ end
data/lib/stripe/oauth.rb CHANGED
@@ -1,54 +1,63 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Stripe
2
4
  module OAuth
3
5
  module OAuthOperations
4
6
  extend APIOperations::Request::ClassMethods
5
7
 
6
- def self.request(method, url, params, opts)
8
+ def self.execute_resource_request(method, url, params, opts)
7
9
  opts = Util.normalize_opts(opts)
8
- opts[:client] ||= StripeClient.active_client
9
- opts[:api_base] ||= Stripe.connect_base
10
+ opts[:client] ||= opts[:client] || StripeClient.active_client
11
+ opts[:api_base] ||= opts[:client].config.connect_base
10
12
 
11
13
  super(method, url, params, opts)
12
14
  end
13
15
  end
14
16
 
15
- def self.get_client_id(params={})
17
+ def self.get_client_id(params = {})
16
18
  client_id = params[:client_id] || Stripe.client_id
17
19
  unless client_id
18
- raise AuthenticationError.new('No client_id provided. ' \
20
+ raise AuthenticationError, "No client_id provided. " \
19
21
  'Set your client_id using "Stripe.client_id = <CLIENT-ID>". ' \
20
- 'You can find your client_ids in your Stripe dashboard at ' \
21
- 'https://dashboard.stripe.com/account/applications/settings, ' \
22
- 'after registering your account as a platform. See ' \
23
- 'https://stripe.com/docs/connect/standalone-accounts for details, ' \
24
- 'or email support@stripe.com if you have any questions.')
22
+ "You can find your client_ids in your Stripe dashboard at " \
23
+ "https://dashboard.stripe.com/account/applications/settings, " \
24
+ "after registering your account as a platform. See " \
25
+ "https://stripe.com/docs/connect/standalone-accounts for details, " \
26
+ "or email support@stripe.com if you have any questions."
25
27
  end
26
28
  client_id
27
29
  end
28
30
 
29
- def self.authorize_url(params={}, opts={})
30
- base = opts[:connect_base] || Stripe.connect_base
31
+ def self.authorize_url(params = {}, opts = {})
32
+ client = opts[:client] || StripeClient.active_client
33
+ base = opts[:connect_base] || client.config.connect_base
34
+
35
+ path = "/oauth/authorize"
36
+ path = "/express" + path if opts[:express]
31
37
 
32
38
  params[:client_id] = get_client_id(params)
33
- params[:response_type] ||= 'code'
39
+ params[:response_type] ||= "code"
34
40
  query = Util.encode_parameters(params)
35
41
 
36
- "#{base}/oauth/authorize?#{query}"
42
+ "#{base}#{path}?#{query}"
37
43
  end
38
44
 
39
- def self.token(params={}, opts={})
45
+ def self.token(params = {}, opts = {})
40
46
  opts = Util.normalize_opts(opts)
41
- resp, opts = OAuthOperations.request(
42
- :post, '/oauth/token', params, opts)
47
+ opts[:api_key] = params[:client_secret] if params[:client_secret]
48
+ resp, opts = OAuthOperations.execute_resource_request(
49
+ :post, "/oauth/token", params, opts
50
+ )
43
51
  # This is just going to return a generic StripeObject, but that's okay
44
52
  Util.convert_to_stripe_object(resp.data, opts)
45
53
  end
46
54
 
47
- def self.deauthorize(params={}, opts={})
55
+ def self.deauthorize(params = {}, opts = {})
48
56
  opts = Util.normalize_opts(opts)
49
57
  params[:client_id] = get_client_id(params)
50
- resp, opts = OAuthOperations.request(
51
- :post, '/oauth/deauthorize', params, opts)
58
+ resp, opts = OAuthOperations.execute_resource_request(
59
+ :post, "/oauth/deauthorize", params, opts
60
+ )
52
61
  # This is just going to return a generic StripeObject, but that's okay
53
62
  Util.convert_to_stripe_object(resp.data, opts)
54
63
  end
@@ -0,0 +1,107 @@
1
+ # File generated from our OpenAPI spec
2
+ # frozen_string_literal: true
3
+
4
+ # rubocop:disable Metrics/MethodLength
5
+
6
+ module Stripe
7
+ module ObjectTypes
8
+ def self.object_names_to_classes
9
+ {
10
+ # data structures
11
+ ListObject::OBJECT_NAME => ListObject,
12
+
13
+ # business objects
14
+ Account::OBJECT_NAME => Account,
15
+ AccountLink::OBJECT_NAME => AccountLink,
16
+ AlipayAccount::OBJECT_NAME => AlipayAccount,
17
+ ApplePayDomain::OBJECT_NAME => ApplePayDomain,
18
+ ApplicationFee::OBJECT_NAME => ApplicationFee,
19
+ ApplicationFeeRefund::OBJECT_NAME => ApplicationFeeRefund,
20
+ Balance::OBJECT_NAME => Balance,
21
+ BalanceTransaction::OBJECT_NAME => BalanceTransaction,
22
+ BankAccount::OBJECT_NAME => BankAccount,
23
+ BillingPortal::Configuration::OBJECT_NAME => BillingPortal::Configuration,
24
+ BillingPortal::Session::OBJECT_NAME => BillingPortal::Session,
25
+ BitcoinReceiver::OBJECT_NAME => BitcoinReceiver,
26
+ BitcoinTransaction::OBJECT_NAME => BitcoinTransaction,
27
+ Capability::OBJECT_NAME => Capability,
28
+ Card::OBJECT_NAME => Card,
29
+ Charge::OBJECT_NAME => Charge,
30
+ Checkout::Session::OBJECT_NAME => Checkout::Session,
31
+ CountrySpec::OBJECT_NAME => CountrySpec,
32
+ Coupon::OBJECT_NAME => Coupon,
33
+ CreditNote::OBJECT_NAME => CreditNote,
34
+ CreditNoteLineItem::OBJECT_NAME => CreditNoteLineItem,
35
+ Customer::OBJECT_NAME => Customer,
36
+ CustomerBalanceTransaction::OBJECT_NAME => CustomerBalanceTransaction,
37
+ Discount::OBJECT_NAME => Discount,
38
+ Dispute::OBJECT_NAME => Dispute,
39
+ EphemeralKey::OBJECT_NAME => EphemeralKey,
40
+ Event::OBJECT_NAME => Event,
41
+ ExchangeRate::OBJECT_NAME => ExchangeRate,
42
+ File::OBJECT_NAME => File,
43
+ File::OBJECT_NAME_ALT => File,
44
+ FileLink::OBJECT_NAME => FileLink,
45
+ Identity::VerificationReport::OBJECT_NAME => Identity::VerificationReport,
46
+ Identity::VerificationSession::OBJECT_NAME => Identity::VerificationSession,
47
+ Invoice::OBJECT_NAME => Invoice,
48
+ InvoiceItem::OBJECT_NAME => InvoiceItem,
49
+ InvoiceLineItem::OBJECT_NAME => InvoiceLineItem,
50
+ Issuing::Authorization::OBJECT_NAME => Issuing::Authorization,
51
+ Issuing::Card::OBJECT_NAME => Issuing::Card,
52
+ Issuing::CardDetails::OBJECT_NAME => Issuing::CardDetails,
53
+ Issuing::Cardholder::OBJECT_NAME => Issuing::Cardholder,
54
+ Issuing::Dispute::OBJECT_NAME => Issuing::Dispute,
55
+ Issuing::Transaction::OBJECT_NAME => Issuing::Transaction,
56
+ LineItem::OBJECT_NAME => LineItem,
57
+ LoginLink::OBJECT_NAME => LoginLink,
58
+ Mandate::OBJECT_NAME => Mandate,
59
+ Order::OBJECT_NAME => Order,
60
+ OrderReturn::OBJECT_NAME => OrderReturn,
61
+ PaymentIntent::OBJECT_NAME => PaymentIntent,
62
+ PaymentMethod::OBJECT_NAME => PaymentMethod,
63
+ Payout::OBJECT_NAME => Payout,
64
+ Person::OBJECT_NAME => Person,
65
+ Plan::OBJECT_NAME => Plan,
66
+ Price::OBJECT_NAME => Price,
67
+ Product::OBJECT_NAME => Product,
68
+ PromotionCode::OBJECT_NAME => PromotionCode,
69
+ Quote::OBJECT_NAME => Quote,
70
+ Radar::EarlyFraudWarning::OBJECT_NAME => Radar::EarlyFraudWarning,
71
+ Radar::ValueList::OBJECT_NAME => Radar::ValueList,
72
+ Radar::ValueListItem::OBJECT_NAME => Radar::ValueListItem,
73
+ Recipient::OBJECT_NAME => Recipient,
74
+ RecipientTransfer::OBJECT_NAME => RecipientTransfer,
75
+ Refund::OBJECT_NAME => Refund,
76
+ Reporting::ReportRun::OBJECT_NAME => Reporting::ReportRun,
77
+ Reporting::ReportType::OBJECT_NAME => Reporting::ReportType,
78
+ Reversal::OBJECT_NAME => Reversal,
79
+ Review::OBJECT_NAME => Review,
80
+ SetupAttempt::OBJECT_NAME => SetupAttempt,
81
+ SetupIntent::OBJECT_NAME => SetupIntent,
82
+ Sigma::ScheduledQueryRun::OBJECT_NAME => Sigma::ScheduledQueryRun,
83
+ SKU::OBJECT_NAME => SKU,
84
+ Source::OBJECT_NAME => Source,
85
+ SourceTransaction::OBJECT_NAME => SourceTransaction,
86
+ Subscription::OBJECT_NAME => Subscription,
87
+ SubscriptionItem::OBJECT_NAME => SubscriptionItem,
88
+ SubscriptionSchedule::OBJECT_NAME => SubscriptionSchedule,
89
+ TaxCode::OBJECT_NAME => TaxCode,
90
+ TaxId::OBJECT_NAME => TaxId,
91
+ TaxRate::OBJECT_NAME => TaxRate,
92
+ Terminal::ConnectionToken::OBJECT_NAME => Terminal::ConnectionToken,
93
+ Terminal::Location::OBJECT_NAME => Terminal::Location,
94
+ Terminal::Reader::OBJECT_NAME => Terminal::Reader,
95
+ ThreeDSecure::OBJECT_NAME => ThreeDSecure,
96
+ Token::OBJECT_NAME => Token,
97
+ Topup::OBJECT_NAME => Topup,
98
+ Transfer::OBJECT_NAME => Transfer,
99
+ UsageRecord::OBJECT_NAME => UsageRecord,
100
+ UsageRecordSummary::OBJECT_NAME => UsageRecordSummary,
101
+ WebhookEndpoint::OBJECT_NAME => WebhookEndpoint,
102
+ }
103
+ end
104
+ end
105
+ end
106
+
107
+ # rubocop:enable Metrics/MethodLength