stripe 4.21.3 → 5.52.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +254 -1
- data/CODE_OF_CONDUCT.md +77 -0
- data/Gemfile +10 -16
- data/Makefile +7 -0
- data/README.md +115 -47
- data/Rakefile +8 -7
- data/VERSION +1 -1
- data/lib/stripe/api_operations/create.rb +1 -1
- data/lib/stripe/api_operations/delete.rb +7 -3
- data/lib/stripe/api_operations/list.rb +1 -12
- data/lib/stripe/api_operations/nested_resource.rb +29 -26
- data/lib/stripe/api_operations/request.rb +82 -6
- data/lib/stripe/api_operations/save.rb +7 -4
- data/lib/stripe/api_operations/search.rb +19 -0
- data/lib/stripe/api_resource.rb +22 -17
- data/lib/stripe/api_resource_test_helpers.rb +47 -0
- data/lib/stripe/connection_manager.rb +200 -0
- data/lib/stripe/error_object.rb +93 -0
- data/lib/stripe/errors.rb +24 -3
- data/lib/stripe/instrumentation.rb +84 -0
- data/lib/stripe/list_object.rb +34 -5
- data/lib/stripe/multipart_encoder.rb +131 -0
- data/lib/stripe/oauth.rb +8 -6
- data/lib/stripe/object_types.rb +20 -5
- data/lib/stripe/resources/account.rb +12 -16
- data/lib/stripe/resources/account_link.rb +2 -1
- data/lib/stripe/resources/alipay_account.rb +1 -1
- data/lib/stripe/resources/apple_pay_domain.rb +2 -1
- data/lib/stripe/resources/application_fee.rb +2 -12
- data/lib/stripe/resources/application_fee_refund.rb +3 -2
- data/lib/stripe/resources/balance.rb +2 -1
- data/lib/stripe/resources/balance_transaction.rb +2 -5
- data/lib/stripe/resources/bank_account.rb +3 -2
- data/lib/stripe/resources/billing_portal/configuration.rb +14 -0
- data/lib/stripe/resources/billing_portal/session.rb +12 -0
- data/lib/stripe/resources/bitcoin_receiver.rb +2 -1
- data/lib/stripe/resources/bitcoin_transaction.rb +4 -3
- data/lib/stripe/resources/capability.rb +3 -2
- data/lib/stripe/resources/card.rb +2 -1
- data/lib/stripe/resources/charge.rb +13 -65
- data/lib/stripe/resources/checkout/session.rb +17 -1
- data/lib/stripe/resources/country_spec.rb +2 -1
- data/lib/stripe/resources/coupon.rb +2 -1
- data/lib/stripe/resources/credit_note.rb +18 -3
- data/lib/stripe/resources/credit_note_line_item.rb +8 -0
- data/lib/stripe/resources/customer.rb +35 -59
- data/lib/stripe/resources/customer_balance_transaction.rb +4 -3
- data/lib/stripe/resources/discount.rb +2 -1
- data/lib/stripe/resources/dispute.rb +8 -9
- data/lib/stripe/resources/ephemeral_key.rb +2 -1
- data/lib/stripe/resources/event.rb +2 -1
- data/lib/stripe/resources/exchange_rate.rb +2 -1
- data/lib/stripe/resources/file.rb +6 -14
- data/lib/stripe/resources/file_link.rb +2 -1
- data/lib/stripe/resources/funding_instructions.rb +16 -0
- data/lib/stripe/resources/identity/verification_report.rb +12 -0
- data/lib/stripe/resources/identity/verification_session.rb +35 -0
- data/lib/stripe/resources/invoice.rb +47 -12
- data/lib/stripe/resources/invoice_item.rb +2 -1
- data/lib/stripe/resources/invoice_line_item.rb +2 -1
- data/lib/stripe/resources/issuing/authorization.rb +14 -5
- data/lib/stripe/resources/issuing/card.rb +8 -3
- data/lib/stripe/resources/issuing/card_details.rb +3 -2
- data/lib/stripe/resources/issuing/cardholder.rb +2 -1
- data/lib/stripe/resources/issuing/dispute.rb +13 -1
- data/lib/stripe/resources/issuing/transaction.rb +2 -1
- data/lib/stripe/resources/line_item.rb +8 -0
- data/lib/stripe/resources/login_link.rb +2 -1
- data/lib/stripe/resources/mandate.rb +8 -0
- data/lib/stripe/resources/order.rb +14 -13
- data/lib/stripe/resources/order_return.rb +2 -1
- data/lib/stripe/resources/payment_intent.rb +59 -7
- data/lib/stripe/resources/payment_link.rb +23 -0
- data/lib/stripe/resources/payment_method.rb +14 -5
- data/lib/stripe/resources/payout.rb +16 -7
- data/lib/stripe/resources/person.rb +2 -1
- data/lib/stripe/resources/plan.rb +2 -1
- data/lib/stripe/resources/price.rb +21 -0
- data/lib/stripe/resources/product.rb +11 -1
- data/lib/stripe/resources/promotion_code.rb +12 -0
- data/lib/stripe/resources/quote.rb +105 -0
- data/lib/stripe/resources/radar/early_fraud_warning.rb +2 -1
- data/lib/stripe/resources/radar/value_list.rb +2 -1
- data/lib/stripe/resources/radar/value_list_item.rb +2 -1
- data/lib/stripe/resources/recipient.rb +2 -5
- data/lib/stripe/resources/recipient_transfer.rb +1 -1
- data/lib/stripe/resources/refund.rb +13 -1
- data/lib/stripe/resources/reporting/report_run.rb +2 -1
- data/lib/stripe/resources/reporting/report_type.rb +2 -1
- data/lib/stripe/resources/reversal.rb +4 -3
- data/lib/stripe/resources/review.rb +8 -3
- data/lib/stripe/resources/setup_attempt.rb +10 -0
- data/lib/stripe/resources/setup_intent.rb +24 -5
- data/lib/stripe/resources/shipping_rate.rb +12 -0
- data/lib/stripe/resources/sigma/scheduled_query_run.rb +2 -1
- data/lib/stripe/resources/sku.rb +2 -1
- data/lib/stripe/resources/source.rb +17 -12
- data/lib/stripe/resources/source_transaction.rb +2 -1
- data/lib/stripe/resources/subscription.rb +16 -6
- data/lib/stripe/resources/subscription_item.rb +11 -2
- data/lib/stripe/resources/subscription_schedule.rb +14 -13
- data/lib/stripe/resources/tax_code.rb +10 -0
- data/lib/stripe/resources/tax_id.rb +2 -1
- data/lib/stripe/resources/tax_rate.rb +2 -1
- data/lib/stripe/resources/terminal/configuration.rb +15 -0
- data/lib/stripe/resources/terminal/connection_token.rb +2 -1
- data/lib/stripe/resources/terminal/location.rb +2 -1
- data/lib/stripe/resources/terminal/reader.rb +62 -1
- data/lib/stripe/resources/test_helpers/test_clock.rb +25 -0
- data/lib/stripe/resources/three_d_secure.rb +2 -1
- data/lib/stripe/resources/token.rb +2 -1
- data/lib/stripe/resources/topup.rb +8 -3
- data/lib/stripe/resources/transfer.rb +8 -8
- data/lib/stripe/resources/usage_record.rb +2 -17
- data/lib/stripe/resources/usage_record_summary.rb +2 -1
- data/lib/stripe/resources/webhook_endpoint.rb +2 -1
- data/lib/stripe/resources.rb +18 -2
- data/lib/stripe/search_result_object.rb +86 -0
- data/lib/stripe/stripe_client.rb +617 -243
- data/lib/stripe/stripe_configuration.rb +194 -0
- data/lib/stripe/stripe_object.rb +30 -25
- data/lib/stripe/stripe_response.rb +87 -27
- data/lib/stripe/util.rb +88 -18
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe/webhook.rb +39 -8
- data/lib/stripe.rb +43 -131
- data/stripe.gemspec +17 -13
- metadata +36 -220
- data/.editorconfig +0 -10
- data/.gitattributes +0 -4
- data/.github/ISSUE_TEMPLATE.md +0 -5
- data/.gitignore +0 -8
- data/.rubocop.yml +0 -43
- data/.rubocop_todo.yml +0 -38
- data/.travis.yml +0 -43
- data/.vscode/extensions.json +0 -7
- data/.vscode/settings.json +0 -8
- data/lib/stripe/resources/issuer_fraud_record.rb +0 -9
- data/lib/stripe/resources/subscription_schedule_revision.rb +0 -34
- data/test/api_stub_helpers.rb +0 -1
- data/test/openapi/README.md +0 -9
- data/test/stripe/account_link_test.rb +0 -18
- data/test/stripe/account_test.rb +0 -428
- data/test/stripe/alipay_account_test.rb +0 -37
- data/test/stripe/api_operations_test.rb +0 -80
- data/test/stripe/api_resource_test.rb +0 -544
- data/test/stripe/apple_pay_domain_test.rb +0 -46
- data/test/stripe/application_fee_refund_test.rb +0 -37
- data/test/stripe/application_fee_test.rb +0 -58
- data/test/stripe/balance_test.rb +0 -13
- data/test/stripe/bank_account_test.rb +0 -36
- data/test/stripe/capability_test.rb +0 -45
- data/test/stripe/charge_test.rb +0 -80
- data/test/stripe/checkout/session_test.rb +0 -41
- data/test/stripe/country_spec_test.rb +0 -20
- data/test/stripe/coupon_test.rb +0 -61
- data/test/stripe/credit_note_test.rb +0 -61
- data/test/stripe/customer_balance_transaction_test.rb +0 -37
- data/test/stripe/customer_card_test.rb +0 -42
- data/test/stripe/customer_test.rb +0 -269
- data/test/stripe/dispute_test.rb +0 -51
- data/test/stripe/ephemeral_key_test.rb +0 -93
- data/test/stripe/errors_test.rb +0 -20
- data/test/stripe/exchange_rate_test.rb +0 -20
- data/test/stripe/file_link_test.rb +0 -41
- data/test/stripe/file_test.rb +0 -97
- data/test/stripe/file_upload_test.rb +0 -79
- data/test/stripe/invoice_item_test.rb +0 -66
- data/test/stripe/invoice_line_item_test.rb +0 -8
- data/test/stripe/invoice_test.rb +0 -213
- data/test/stripe/issuer_fraud_record_test.rb +0 -20
- data/test/stripe/issuing/authorization_test.rb +0 -72
- data/test/stripe/issuing/card_test.rb +0 -62
- data/test/stripe/issuing/cardholder_test.rb +0 -53
- data/test/stripe/issuing/dispute_test.rb +0 -45
- data/test/stripe/issuing/transaction_test.rb +0 -48
- data/test/stripe/list_object_test.rb +0 -156
- data/test/stripe/login_link_test.rb +0 -37
- data/test/stripe/oauth_test.rb +0 -88
- data/test/stripe/order_return_test.rb +0 -21
- data/test/stripe/order_test.rb +0 -82
- data/test/stripe/payment_intent_test.rb +0 -107
- data/test/stripe/payment_method_test.rb +0 -84
- data/test/stripe/payout_test.rb +0 -57
- data/test/stripe/person_test.rb +0 -46
- data/test/stripe/plan_test.rb +0 -98
- data/test/stripe/product_test.rb +0 -59
- data/test/stripe/radar/early_fraud_warning_test.rb +0 -22
- data/test/stripe/radar/value_list_item_test.rb +0 -48
- data/test/stripe/radar/value_list_test.rb +0 -61
- data/test/stripe/recipient_test.rb +0 -62
- data/test/stripe/refund_test.rb +0 -39
- data/test/stripe/reporting/report_run_test.rb +0 -33
- data/test/stripe/reporting/report_type_test.rb +0 -22
- data/test/stripe/reversal_test.rb +0 -43
- data/test/stripe/review_test.rb +0 -27
- data/test/stripe/setup_intent_test.rb +0 -84
- data/test/stripe/sigma/scheduled_query_run_test.rb +0 -22
- data/test/stripe/sku_test.rb +0 -60
- data/test/stripe/source_test.rb +0 -99
- data/test/stripe/source_transaction_test.rb +0 -19
- data/test/stripe/stripe_client_test.rb +0 -842
- data/test/stripe/stripe_object_test.rb +0 -525
- data/test/stripe/stripe_response_test.rb +0 -49
- data/test/stripe/subscription_item_test.rb +0 -63
- data/test/stripe/subscription_schedule_revision_test.rb +0 -37
- data/test/stripe/subscription_schedule_test.rb +0 -116
- data/test/stripe/subscription_test.rb +0 -80
- data/test/stripe/tax_id_test.rb +0 -31
- data/test/stripe/tax_rate_test.rb +0 -43
- data/test/stripe/terminal/connection_token_test.rb +0 -16
- data/test/stripe/terminal/location_test.rb +0 -68
- data/test/stripe/terminal/reader_test.rb +0 -62
- data/test/stripe/three_d_secure_test.rb +0 -23
- data/test/stripe/topup_test.rb +0 -62
- data/test/stripe/transfer_test.rb +0 -88
- data/test/stripe/usage_record_summary_test.rb +0 -19
- data/test/stripe/usage_record_test.rb +0 -28
- data/test/stripe/util_test.rb +0 -402
- data/test/stripe/webhook_endpoint_test.rb +0 -59
- data/test/stripe/webhook_test.rb +0 -96
- data/test/stripe_mock.rb +0 -77
- data/test/stripe_test.rb +0 -63
- data/test/test_data.rb +0 -61
- data/test/test_helper.rb +0 -71
data/lib/stripe/stripe_client.rb
CHANGED
@@ -1,101 +1,172 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
+
require "stripe/instrumentation"
|
4
|
+
|
3
5
|
module Stripe
|
4
6
|
# StripeClient executes requests against the Stripe API and allows a user to
|
5
7
|
# recover both a resource a call returns as well as a response object that
|
6
8
|
# contains information on the HTTP call.
|
7
9
|
class StripeClient
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
10
|
+
# A set of all known thread contexts across all threads and a mutex to
|
11
|
+
# synchronize global access to them.
|
12
|
+
@thread_contexts_with_connection_managers = Set.new
|
13
|
+
@thread_contexts_with_connection_managers_mutex = Mutex.new
|
14
|
+
@last_connection_manager_gc = Util.monotonic_time
|
15
|
+
|
16
|
+
# Initializes a new StripeClient
|
17
|
+
def initialize(config_arg = {})
|
14
18
|
@system_profiler = SystemProfiler.new
|
15
19
|
@last_request_metrics = nil
|
20
|
+
|
21
|
+
@config = case config_arg
|
22
|
+
when Hash
|
23
|
+
Stripe.config.reverse_duplicate_merge(config_arg)
|
24
|
+
when Stripe::ConnectionManager
|
25
|
+
# Supports accepting a connection manager object for backwards
|
26
|
+
# compatibility only, and that use is DEPRECATED.
|
27
|
+
Stripe.config.dup
|
28
|
+
when Stripe::StripeConfiguration
|
29
|
+
config_arg
|
30
|
+
when String
|
31
|
+
Stripe.config.reverse_duplicate_merge(
|
32
|
+
{ api_key: config_arg }
|
33
|
+
)
|
34
|
+
else
|
35
|
+
raise ArgumentError, "Can't handle argument: #{config_arg}"
|
36
|
+
end
|
16
37
|
end
|
17
38
|
|
39
|
+
attr_reader :config
|
40
|
+
attr_reader :options
|
41
|
+
|
42
|
+
# Gets a currently active `StripeClient`. Set for the current thread when
|
43
|
+
# `StripeClient#request` is being run so that API operations being executed
|
44
|
+
# inside of that block can find the currently active client. It's reset to
|
45
|
+
# the original value (hopefully `nil`) after the block ends.
|
46
|
+
#
|
47
|
+
# For internal use only. Does not provide a stable API and may be broken
|
48
|
+
# with future non-major changes.
|
18
49
|
def self.active_client
|
19
|
-
|
50
|
+
current_thread_context.active_client || default_client
|
20
51
|
end
|
21
52
|
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
#
|
28
|
-
#
|
29
|
-
#
|
30
|
-
|
31
|
-
|
32
|
-
#
|
33
|
-
#
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
#
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
53
|
+
# Finishes any active connections by closing their TCP connection and
|
54
|
+
# clears them from internal tracking in all connection managers across all
|
55
|
+
# threads.
|
56
|
+
#
|
57
|
+
# If passed a `config` object, only clear connection managers for that
|
58
|
+
# particular configuration.
|
59
|
+
#
|
60
|
+
# For internal use only. Does not provide a stable API and may be broken
|
61
|
+
# with future non-major changes.
|
62
|
+
def self.clear_all_connection_managers(config: nil)
|
63
|
+
# Just a quick path for when configuration is being set for the first
|
64
|
+
# time before any connections have been opened. There is technically some
|
65
|
+
# potential for thread raciness here, but not in a practical sense.
|
66
|
+
return if @thread_contexts_with_connection_managers.empty?
|
67
|
+
|
68
|
+
@thread_contexts_with_connection_managers_mutex.synchronize do
|
69
|
+
pruned_contexts = Set.new
|
70
|
+
|
71
|
+
@thread_contexts_with_connection_managers.each do |thread_context|
|
72
|
+
# Note that the thread context itself is not destroyed, but we clear
|
73
|
+
# its connection manager and remove our reference to it. If it ever
|
74
|
+
# makes a new request we'll give it a new connection manager and
|
75
|
+
# it'll go back into `@thread_contexts_with_connection_managers`.
|
76
|
+
thread_context.default_connection_managers.reject! do |cm_config, cm|
|
77
|
+
if config.nil? || config.key == cm_config
|
78
|
+
cm.clear
|
79
|
+
true
|
80
|
+
end
|
81
|
+
end
|
82
|
+
|
83
|
+
if thread_context.default_connection_managers.empty?
|
84
|
+
pruned_contexts << thread_context
|
46
85
|
end
|
47
86
|
end
|
48
87
|
|
49
|
-
|
88
|
+
@thread_contexts_with_connection_managers.subtract(pruned_contexts)
|
89
|
+
end
|
90
|
+
end
|
50
91
|
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
92
|
+
# A default client for the current thread.
|
93
|
+
def self.default_client
|
94
|
+
current_thread_context.default_client ||= StripeClient.new(Stripe.config)
|
95
|
+
end
|
96
|
+
|
97
|
+
# A default connection manager for the current thread scoped to the
|
98
|
+
# configuration object that may be provided.
|
99
|
+
def self.default_connection_manager(config = Stripe.config)
|
100
|
+
current_thread_context.default_connection_managers[config.key] ||= begin
|
101
|
+
connection_manager = ConnectionManager.new(config)
|
102
|
+
|
103
|
+
@thread_contexts_with_connection_managers_mutex.synchronize do
|
104
|
+
maybe_gc_connection_managers
|
105
|
+
@thread_contexts_with_connection_managers << current_thread_context
|
64
106
|
end
|
65
107
|
|
66
|
-
|
108
|
+
connection_manager
|
67
109
|
end
|
68
110
|
end
|
69
111
|
|
70
112
|
# Checks if an error is a problem that we should retry on. This includes
|
71
113
|
# both socket errors that may represent an intermittent problem and some
|
72
114
|
# special HTTP statuses.
|
73
|
-
def self.should_retry?(error,
|
74
|
-
|
75
|
-
|
76
|
-
# Retry on timeout-related problems (either on open or read).
|
77
|
-
return true if error.is_a?(Faraday::TimeoutError)
|
115
|
+
def self.should_retry?(error,
|
116
|
+
method:, num_retries:, config: Stripe.config)
|
117
|
+
return false if num_retries >= config.max_network_retries
|
78
118
|
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
#
|
86
|
-
|
119
|
+
case error
|
120
|
+
when Net::OpenTimeout, Net::ReadTimeout
|
121
|
+
# Retry on timeout-related problems (either on open or read).
|
122
|
+
true
|
123
|
+
when EOFError, Errno::ECONNREFUSED, Errno::ECONNRESET,
|
124
|
+
Errno::EHOSTUNREACH, Errno::ETIMEDOUT, SocketError
|
125
|
+
# Destination refused the connection, the connection was reset, or a
|
126
|
+
# variety of other connection failures. This could occur from a single
|
127
|
+
# saturated server, so retry in case it's intermittent.
|
128
|
+
true
|
129
|
+
when Stripe::StripeError
|
130
|
+
# The API may ask us not to retry (e.g. if doing so would be a no-op),
|
131
|
+
# or advise us to retry (e.g. in cases of lock timeouts). Defer to
|
132
|
+
# those instructions if given.
|
133
|
+
return false if error.http_headers["stripe-should-retry"] == "false"
|
134
|
+
return true if error.http_headers["stripe-should-retry"] == "true"
|
135
|
+
|
136
|
+
# 409 Conflict
|
137
|
+
return true if error.http_status == 409
|
138
|
+
|
139
|
+
# 429 Too Many Requests
|
140
|
+
#
|
141
|
+
# There are a few different problems that can lead to a 429. The most
|
142
|
+
# common is rate limiting, on which we *don't* want to retry because
|
143
|
+
# that'd likely contribute to more contention problems. However, some
|
144
|
+
# 429s are lock timeouts, which is when a request conflicted with
|
145
|
+
# another request or an internal process on some particular object.
|
146
|
+
# These 429s are safe to retry.
|
147
|
+
return true if error.http_status == 429 && error.code == "lock_timeout"
|
148
|
+
|
149
|
+
# 500 Internal Server Error
|
150
|
+
#
|
151
|
+
# We only bother retrying these for non-POST requests. POSTs end up
|
152
|
+
# being cached by the idempotency layer so there's no purpose in
|
153
|
+
# retrying them.
|
154
|
+
return true if error.http_status == 500 && method != :post
|
155
|
+
|
156
|
+
# 503 Service Unavailable
|
157
|
+
error.http_status == 503
|
158
|
+
else
|
159
|
+
false
|
87
160
|
end
|
88
|
-
|
89
|
-
false
|
90
161
|
end
|
91
162
|
|
92
|
-
def self.sleep_time(num_retries)
|
163
|
+
def self.sleep_time(num_retries, config: Stripe.config)
|
93
164
|
# Apply exponential backoff with initial_network_retry_delay on the
|
94
165
|
# number of num_retries so far as inputs. Do not allow the number to
|
95
166
|
# exceed max_network_retry_delay.
|
96
167
|
sleep_seconds = [
|
97
|
-
|
98
|
-
|
168
|
+
config.initial_network_retry_delay * (2**(num_retries - 1)),
|
169
|
+
config.max_network_retry_delay,
|
99
170
|
].min
|
100
171
|
|
101
172
|
# Apply some jitter by randomizing the value in the range of
|
@@ -103,10 +174,17 @@ module Stripe
|
|
103
174
|
sleep_seconds *= (0.5 * (1 + rand))
|
104
175
|
|
105
176
|
# But never sleep less than the base sleep seconds.
|
106
|
-
|
177
|
+
[config.initial_network_retry_delay, sleep_seconds].max
|
178
|
+
end
|
107
179
|
|
108
|
-
|
180
|
+
# Gets the connection manager in use for the current `StripeClient`.
|
181
|
+
#
|
182
|
+
# This method is DEPRECATED and for backwards compatibility only.
|
183
|
+
def connection_manager
|
184
|
+
self.class.default_connection_manager
|
109
185
|
end
|
186
|
+
extend Gem::Deprecate
|
187
|
+
deprecate :connection_manager, :none, 2020, 9
|
110
188
|
|
111
189
|
# Executes the API call within the given block. Usage looks like:
|
112
190
|
#
|
@@ -114,131 +192,323 @@ module Stripe
|
|
114
192
|
# charge, resp = client.request { Charge.create }
|
115
193
|
#
|
116
194
|
def request
|
117
|
-
|
118
|
-
|
119
|
-
|
195
|
+
old_stripe_client = self.class.current_thread_context.active_client
|
196
|
+
self.class.current_thread_context.active_client = self
|
197
|
+
|
198
|
+
if self.class.current_thread_context.last_responses&.key?(object_id)
|
199
|
+
raise "calls to StripeClient#request cannot be nested within a thread"
|
200
|
+
end
|
201
|
+
|
202
|
+
self.class.current_thread_context.last_responses ||= {}
|
203
|
+
self.class.current_thread_context.last_responses[object_id] = nil
|
120
204
|
|
121
205
|
begin
|
122
206
|
res = yield
|
123
|
-
[res,
|
207
|
+
[res, self.class.current_thread_context.last_responses[object_id]]
|
124
208
|
ensure
|
125
|
-
|
209
|
+
self.class.current_thread_context.active_client = old_stripe_client
|
210
|
+
self.class.current_thread_context.last_responses.delete(object_id)
|
126
211
|
end
|
127
212
|
end
|
128
213
|
|
129
214
|
def execute_request(method, path,
|
130
215
|
api_base: nil, api_key: nil, headers: {}, params: {})
|
131
|
-
|
132
|
-
|
216
|
+
http_resp, api_key = execute_request_internal(
|
217
|
+
method, path, api_base, api_key, headers, params
|
218
|
+
)
|
219
|
+
|
220
|
+
begin
|
221
|
+
resp = StripeResponse.from_net_http(http_resp)
|
222
|
+
rescue JSON::ParserError
|
223
|
+
raise general_api_error(http_resp.code.to_i, http_resp.body)
|
224
|
+
end
|
225
|
+
|
226
|
+
# If being called from `StripeClient#request`, put the last response in
|
227
|
+
# thread-local memory so that it can be returned to the user. Don't store
|
228
|
+
# anything otherwise so that we don't leak memory.
|
229
|
+
store_last_response(object_id, resp)
|
230
|
+
|
231
|
+
[resp, api_key]
|
232
|
+
end
|
233
|
+
|
234
|
+
# Executes a request and returns the body as a stream instead of converting
|
235
|
+
# it to a StripeObject. This should be used for any request where we expect
|
236
|
+
# an arbitrary binary response.
|
237
|
+
#
|
238
|
+
# A `read_body_chunk` block can be passed, which will be called repeatedly
|
239
|
+
# with the body chunks read from the socket.
|
240
|
+
#
|
241
|
+
# If a block is passed, a StripeHeadersOnlyResponse is returned as the
|
242
|
+
# block is expected to do all the necessary body processing. If no block is
|
243
|
+
# passed, then a StripeStreamResponse is returned containing an IO stream
|
244
|
+
# with the response body.
|
245
|
+
def execute_request_stream(method, path,
|
246
|
+
api_base: nil, api_key: nil,
|
247
|
+
headers: {}, params: {},
|
248
|
+
&read_body_chunk_block)
|
249
|
+
unless block_given?
|
250
|
+
raise ArgumentError,
|
251
|
+
"execute_request_stream requires a read_body_chunk_block"
|
252
|
+
end
|
253
|
+
|
254
|
+
http_resp, api_key = execute_request_internal(
|
255
|
+
method, path, api_base, api_key, headers, params, &read_body_chunk_block
|
256
|
+
)
|
257
|
+
|
258
|
+
# When the read_body_chunk_block is given, we no longer have access to the
|
259
|
+
# response body at this point and so return a response object containing
|
260
|
+
# only the headers. This is because the body was consumed by the block.
|
261
|
+
resp = StripeHeadersOnlyResponse.from_net_http(http_resp)
|
262
|
+
|
263
|
+
[resp, api_key]
|
264
|
+
end
|
265
|
+
|
266
|
+
def store_last_response(object_id, resp)
|
267
|
+
return unless last_response_has_key?(object_id)
|
268
|
+
|
269
|
+
self.class.current_thread_context.last_responses[object_id] = resp
|
270
|
+
end
|
271
|
+
|
272
|
+
def last_response_has_key?(object_id)
|
273
|
+
self.class.current_thread_context.last_responses&.key?(object_id)
|
274
|
+
end
|
275
|
+
|
276
|
+
#
|
277
|
+
# private
|
278
|
+
#
|
279
|
+
|
280
|
+
# Time (in seconds) that a connection manager has not been used before it's
|
281
|
+
# eligible for garbage collection.
|
282
|
+
CONNECTION_MANAGER_GC_LAST_USED_EXPIRY = 120
|
283
|
+
|
284
|
+
# How often to check (in seconds) for connection managers that haven't been
|
285
|
+
# used in a long time and which should be garbage collected.
|
286
|
+
CONNECTION_MANAGER_GC_PERIOD = 60
|
287
|
+
|
288
|
+
ERROR_MESSAGE_CONNECTION =
|
289
|
+
"Unexpected error communicating when trying to connect to " \
|
290
|
+
"Stripe (%s). You may be seeing this message because your DNS is not " \
|
291
|
+
"working or you don't have an internet connection. To check, try " \
|
292
|
+
"running `host stripe.com` from the command line."
|
293
|
+
ERROR_MESSAGE_SSL =
|
294
|
+
"Could not establish a secure connection to Stripe (%s), you " \
|
295
|
+
"may need to upgrade your OpenSSL version. To check, try running " \
|
296
|
+
"`openssl s_client -connect api.stripe.com:443` from the command " \
|
297
|
+
"line."
|
298
|
+
|
299
|
+
# Common error suffix sared by both connect and read timeout messages.
|
300
|
+
ERROR_MESSAGE_TIMEOUT_SUFFIX =
|
301
|
+
"Please check your internet connection and try again. " \
|
302
|
+
"If this problem persists, you should check Stripe's service " \
|
303
|
+
"status at https://status.stripe.com, or let us know at " \
|
304
|
+
"support@stripe.com."
|
305
|
+
|
306
|
+
ERROR_MESSAGE_TIMEOUT_CONNECT = (
|
307
|
+
"Timed out connecting to Stripe (%s). " +
|
308
|
+
ERROR_MESSAGE_TIMEOUT_SUFFIX
|
309
|
+
).freeze
|
310
|
+
|
311
|
+
ERROR_MESSAGE_TIMEOUT_READ = (
|
312
|
+
"Timed out communicating with Stripe (%s). " +
|
313
|
+
ERROR_MESSAGE_TIMEOUT_SUFFIX
|
314
|
+
).freeze
|
315
|
+
|
316
|
+
# Maps types of exceptions that we're likely to see during a network
|
317
|
+
# request to more user-friendly messages that we put in front of people.
|
318
|
+
# The original error message is also appended onto the final exception for
|
319
|
+
# full transparency.
|
320
|
+
NETWORK_ERROR_MESSAGES_MAP = {
|
321
|
+
EOFError => ERROR_MESSAGE_CONNECTION,
|
322
|
+
Errno::ECONNREFUSED => ERROR_MESSAGE_CONNECTION,
|
323
|
+
Errno::ECONNRESET => ERROR_MESSAGE_CONNECTION,
|
324
|
+
Errno::EHOSTUNREACH => ERROR_MESSAGE_CONNECTION,
|
325
|
+
Errno::ETIMEDOUT => ERROR_MESSAGE_TIMEOUT_CONNECT,
|
326
|
+
SocketError => ERROR_MESSAGE_CONNECTION,
|
327
|
+
|
328
|
+
Net::OpenTimeout => ERROR_MESSAGE_TIMEOUT_CONNECT,
|
329
|
+
Net::ReadTimeout => ERROR_MESSAGE_TIMEOUT_READ,
|
330
|
+
|
331
|
+
OpenSSL::SSL::SSLError => ERROR_MESSAGE_SSL,
|
332
|
+
}.freeze
|
333
|
+
private_constant :NETWORK_ERROR_MESSAGES_MAP
|
334
|
+
|
335
|
+
# A record representing any data that `StripeClient` puts into
|
336
|
+
# `Thread.current`. Making it a class likes this gives us a little extra
|
337
|
+
# type safety and lets us document what each field does.
|
338
|
+
#
|
339
|
+
# For internal use only. Does not provide a stable API and may be broken
|
340
|
+
# with future non-major changes.
|
341
|
+
class ThreadContext
|
342
|
+
# A `StripeClient` that's been flagged as currently active within a
|
343
|
+
# thread by `StripeClient#request`. A client stays active until the
|
344
|
+
# completion of the request block.
|
345
|
+
attr_accessor :active_client
|
346
|
+
|
347
|
+
# A default `StripeClient` object for the thread. Used in all cases where
|
348
|
+
# the user hasn't specified their own.
|
349
|
+
attr_accessor :default_client
|
350
|
+
|
351
|
+
# A temporary map of object IDs to responses from last executed API
|
352
|
+
# calls. Used to return a responses from calls to `StripeClient#request`.
|
353
|
+
#
|
354
|
+
# Stored in the thread data to make the use of a single `StripeClient`
|
355
|
+
# object safe across multiple threads. Stored as a map so that multiple
|
356
|
+
# `StripeClient` objects can run concurrently on the same thread.
|
357
|
+
#
|
358
|
+
# Responses are only left in as long as they're needed, which means
|
359
|
+
# they're removed as soon as a call leaves `StripeClient#request`, and
|
360
|
+
# because that's wrapped in an `ensure` block, they should never leave
|
361
|
+
# garbage in `Thread.current`.
|
362
|
+
attr_accessor :last_responses
|
363
|
+
|
364
|
+
# A map of connection mangers for the thread. Normally shared between
|
365
|
+
# all `StripeClient` objects on a particular thread, and created so as to
|
366
|
+
# minimize the number of open connections that an application needs.
|
367
|
+
def default_connection_managers
|
368
|
+
@default_connection_managers ||= {}
|
369
|
+
end
|
370
|
+
|
371
|
+
def reset_connection_managers
|
372
|
+
@default_connection_managers = {}
|
373
|
+
end
|
374
|
+
end
|
375
|
+
|
376
|
+
# Access data stored for `StripeClient` within the thread's current
|
377
|
+
# context. Returns `ThreadContext`.
|
378
|
+
#
|
379
|
+
# For internal use only. Does not provide a stable API and may be broken
|
380
|
+
# with future non-major changes.
|
381
|
+
def self.current_thread_context
|
382
|
+
Thread.current[:stripe_client__internal_use_only] ||= ThreadContext.new
|
383
|
+
end
|
384
|
+
|
385
|
+
# Garbage collects connection managers that haven't been used in some time,
|
386
|
+
# with the idea being that we want to remove old connection managers that
|
387
|
+
# belong to dead threads and the like.
|
388
|
+
#
|
389
|
+
# Prefixed with `maybe_` because garbage collection will only run
|
390
|
+
# periodically so that we're not constantly engaged in busy work. If
|
391
|
+
# connection managers live a little passed their useful age it's not
|
392
|
+
# harmful, so it's not necessary to get them right away.
|
393
|
+
#
|
394
|
+
# For testability, returns `nil` if it didn't run and the number of
|
395
|
+
# connection managers that were garbage collected otherwise.
|
396
|
+
#
|
397
|
+
# IMPORTANT: This method is not thread-safe and expects to be called inside
|
398
|
+
# a lock on `@thread_contexts_with_connection_managers_mutex`.
|
399
|
+
#
|
400
|
+
# For internal use only. Does not provide a stable API and may be broken
|
401
|
+
# with future non-major changes.
|
402
|
+
def self.maybe_gc_connection_managers
|
403
|
+
next_gc_time = @last_connection_manager_gc + CONNECTION_MANAGER_GC_PERIOD
|
404
|
+
return nil if next_gc_time > Util.monotonic_time
|
405
|
+
|
406
|
+
last_used_threshold =
|
407
|
+
Util.monotonic_time - CONNECTION_MANAGER_GC_LAST_USED_EXPIRY
|
408
|
+
|
409
|
+
pruned_contexts = []
|
410
|
+
@thread_contexts_with_connection_managers.each do |thread_context|
|
411
|
+
thread_context
|
412
|
+
.default_connection_managers
|
413
|
+
.each do |config_key, connection_manager|
|
414
|
+
next if connection_manager.last_used > last_used_threshold
|
415
|
+
|
416
|
+
connection_manager.clear
|
417
|
+
thread_context.default_connection_managers.delete(config_key)
|
418
|
+
end
|
419
|
+
end
|
420
|
+
|
421
|
+
@thread_contexts_with_connection_managers.each do |thread_context|
|
422
|
+
next unless thread_context.default_connection_managers.empty?
|
423
|
+
|
424
|
+
pruned_contexts << thread_context
|
425
|
+
end
|
426
|
+
|
427
|
+
@thread_contexts_with_connection_managers -= pruned_contexts
|
428
|
+
@last_connection_manager_gc = Util.monotonic_time
|
429
|
+
|
430
|
+
pruned_contexts.count
|
431
|
+
end
|
432
|
+
|
433
|
+
private def execute_request_internal(method, path,
|
434
|
+
api_base, api_key, headers, params,
|
435
|
+
&read_body_chunk_block)
|
436
|
+
raise ArgumentError, "method should be a symbol" \
|
437
|
+
unless method.is_a?(Symbol)
|
438
|
+
raise ArgumentError, "path should be a string" \
|
439
|
+
unless path.is_a?(String)
|
440
|
+
|
441
|
+
api_base ||= config.api_base
|
442
|
+
api_key ||= config.api_key
|
133
443
|
params = Util.objects_to_ids(params)
|
134
444
|
|
135
445
|
check_api_key!(api_key)
|
136
446
|
|
137
|
-
|
447
|
+
body_params = nil
|
138
448
|
query_params = nil
|
139
|
-
case method
|
449
|
+
case method
|
140
450
|
when :get, :head, :delete
|
141
451
|
query_params = params
|
142
452
|
else
|
143
|
-
|
453
|
+
body_params = params
|
144
454
|
end
|
145
455
|
|
146
|
-
|
147
|
-
# parameters in `query_params` and query parameters that are appended
|
148
|
-
# onto the end of the given path. In this case, Faraday will silently
|
149
|
-
# discard the URL's parameters which may break a request.
|
150
|
-
#
|
151
|
-
# Here we decode any parameters that were added onto the end of a path
|
152
|
-
# and add them to `query_params` so that all parameters end up in one
|
153
|
-
# place and all of them are correctly included in the final request.
|
154
|
-
u = URI.parse(path)
|
155
|
-
unless u.query.nil?
|
156
|
-
query_params ||= {}
|
157
|
-
query_params = Hash[URI.decode_www_form(u.query)].merge(query_params)
|
158
|
-
|
159
|
-
# Reset the path minus any query parameters that were specified.
|
160
|
-
path = u.path
|
161
|
-
end
|
456
|
+
query_params, path = merge_query_params(query_params, path)
|
162
457
|
|
163
458
|
headers = request_headers(api_key, method)
|
164
459
|
.update(Util.normalize_headers(headers))
|
165
|
-
params_encoder = FaradayStripeEncoder.new
|
166
460
|
url = api_url(path, api_base)
|
167
461
|
|
462
|
+
# Merge given query parameters with any already encoded in the path.
|
463
|
+
query = query_params ? Util.encode_parameters(query_params) : nil
|
464
|
+
|
465
|
+
# Encoding body parameters is a little more complex because we may have
|
466
|
+
# to send a multipart-encoded body. `body_log` is produced separately as
|
467
|
+
# a log-friendly variant of the encoded form. File objects are displayed
|
468
|
+
# as such instead of as their file contents.
|
469
|
+
body, body_log =
|
470
|
+
body_params ? encode_body(body_params, headers) : [nil, nil]
|
471
|
+
|
168
472
|
# stores information on the request we're about to make so that we don't
|
169
473
|
# have to pass as many parameters around for logging.
|
170
474
|
context = RequestLogContext.new
|
171
475
|
context.account = headers["Stripe-Account"]
|
172
476
|
context.api_key = api_key
|
173
477
|
context.api_version = headers["Stripe-Version"]
|
174
|
-
context.body =
|
478
|
+
context.body = body_log
|
175
479
|
context.idempotency_key = headers["Idempotency-Key"]
|
176
480
|
context.method = method
|
177
481
|
context.path = path
|
178
|
-
context.
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
#
|
183
|
-
#
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
482
|
+
context.query = query
|
483
|
+
|
484
|
+
# A block can be passed in to read the content directly from the response.
|
485
|
+
# We want to execute this block only when the response was actually
|
486
|
+
# successful. When it wasn't, we defer to the standard error handling as
|
487
|
+
# we have to read the body and parse the error JSON.
|
488
|
+
response_block =
|
489
|
+
if block_given?
|
490
|
+
lambda do |response|
|
491
|
+
unless should_handle_as_error(response.code.to_i)
|
492
|
+
response.read_body(&read_body_chunk_block)
|
493
|
+
end
|
494
|
+
end
|
190
495
|
end
|
191
|
-
end
|
192
|
-
|
193
|
-
begin
|
194
|
-
resp = StripeResponse.from_faraday_response(http_resp)
|
195
|
-
rescue JSON::ParserError
|
196
|
-
raise general_api_error(http_resp.status, http_resp.body)
|
197
|
-
end
|
198
|
-
|
199
|
-
# Allows StripeClient#request to return a response object to a caller.
|
200
|
-
@last_response = resp
|
201
|
-
[resp, api_key]
|
202
|
-
end
|
203
496
|
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
#
|
213
|
-
# The class also performs simple caching so that we don't have to encode
|
214
|
-
# parameters twice for every request (once to build the request and once
|
215
|
-
# for logging).
|
216
|
-
#
|
217
|
-
# When initialized with `multipart: true`, the encoder just inspects the
|
218
|
-
# hash instead to get a decent representation for logging. In the case of a
|
219
|
-
# multipart request, Faraday won't use the result of this encoder.
|
220
|
-
class FaradayStripeEncoder
|
221
|
-
def initialize
|
222
|
-
@cache = {}
|
223
|
-
end
|
224
|
-
|
225
|
-
# This is quite subtle, but for a `multipart/form-data` request Faraday
|
226
|
-
# will throw away the result of this encoder and build its body.
|
227
|
-
def encode(hash)
|
228
|
-
@cache.fetch(hash) do |k|
|
229
|
-
@cache[k] = Util.encode_parameters(hash)
|
230
|
-
end
|
497
|
+
http_resp = execute_request_with_rescues(method, api_base, context) do
|
498
|
+
self.class
|
499
|
+
.default_connection_manager(config)
|
500
|
+
.execute_request(method, url,
|
501
|
+
body: body,
|
502
|
+
headers: headers,
|
503
|
+
query: query,
|
504
|
+
&response_block)
|
231
505
|
end
|
232
506
|
|
233
|
-
|
234
|
-
def decode(_str)
|
235
|
-
raise NotImplementedError,
|
236
|
-
"#{self.class.name} does not implement #decode"
|
237
|
-
end
|
507
|
+
[http_resp, api_key]
|
238
508
|
end
|
239
509
|
|
240
510
|
private def api_url(url = "", api_base = nil)
|
241
|
-
(api_base ||
|
511
|
+
(api_base || config.api_base) + url
|
242
512
|
end
|
243
513
|
|
244
514
|
private def check_api_key!(api_key)
|
@@ -258,17 +528,69 @@ module Stripe
|
|
258
528
|
"email support@stripe.com if you have any questions.)"
|
259
529
|
end
|
260
530
|
|
261
|
-
|
531
|
+
# Encodes a set of body parameters using multipart if `Content-Type` is set
|
532
|
+
# for that, or standard form-encoding otherwise. Returns the encoded body
|
533
|
+
# and a version of the encoded body that's safe to be logged.
|
534
|
+
private def encode_body(body_params, headers)
|
535
|
+
body = nil
|
536
|
+
flattened_params = Util.flatten_params(body_params)
|
537
|
+
|
538
|
+
if headers["Content-Type"] == MultipartEncoder::MULTIPART_FORM_DATA
|
539
|
+
body, content_type = MultipartEncoder.encode(flattened_params)
|
540
|
+
|
541
|
+
# Set a new content type that also includes the multipart boundary.
|
542
|
+
# See `MultipartEncoder` for details.
|
543
|
+
headers["Content-Type"] = content_type
|
544
|
+
|
545
|
+
# `#to_s` any complex objects like files and the like to build output
|
546
|
+
# that's more condusive to logging.
|
547
|
+
flattened_params =
|
548
|
+
flattened_params.map { |k, v| [k, v.is_a?(String) ? v : v.to_s] }.to_h
|
549
|
+
|
550
|
+
else
|
551
|
+
body = Util.encode_parameters(body_params)
|
552
|
+
end
|
553
|
+
|
554
|
+
# We don't use `Util.encode_parameters` partly as an optimization (to not
|
555
|
+
# redo work we've already done), and partly because the encoded forms of
|
556
|
+
# certain characters introduce a lot of visual noise and it's nice to
|
557
|
+
# have a clearer format for logs.
|
558
|
+
body_log = flattened_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
559
|
+
|
560
|
+
[body, body_log]
|
561
|
+
end
|
562
|
+
|
563
|
+
private def should_handle_as_error(http_status)
|
564
|
+
http_status >= 400
|
565
|
+
end
|
566
|
+
|
567
|
+
private def execute_request_with_rescues(method, api_base, context)
|
262
568
|
num_retries = 0
|
569
|
+
|
263
570
|
begin
|
264
|
-
request_start =
|
571
|
+
request_start = nil
|
572
|
+
user_data = nil
|
573
|
+
|
265
574
|
log_request(context, num_retries)
|
575
|
+
user_data = notify_request_begin(context)
|
576
|
+
|
577
|
+
request_start = Util.monotonic_time
|
266
578
|
resp = yield
|
267
|
-
|
268
|
-
log_response(context, request_start, resp.status, resp.body)
|
579
|
+
request_duration = Util.monotonic_time - request_start
|
269
580
|
|
270
|
-
|
271
|
-
|
581
|
+
http_status = resp.code.to_i
|
582
|
+
context = context.dup_from_response_headers(resp)
|
583
|
+
|
584
|
+
if should_handle_as_error(http_status)
|
585
|
+
handle_error_response(resp, context)
|
586
|
+
end
|
587
|
+
|
588
|
+
log_response(context, request_start, http_status, resp.body, resp)
|
589
|
+
notify_request_end(context, request_duration, http_status,
|
590
|
+
num_retries, user_data)
|
591
|
+
|
592
|
+
if config.enable_telemetry? && context.request_id
|
593
|
+
request_duration_ms = (request_duration * 1000).to_i
|
272
594
|
@last_request_metrics =
|
273
595
|
StripeRequestMetrics.new(context.request_id, request_duration_ms)
|
274
596
|
end
|
@@ -280,28 +602,34 @@ module Stripe
|
|
280
602
|
# If we modify context we copy it into a new variable so as not to
|
281
603
|
# taint the original on a retry.
|
282
604
|
error_context = context
|
605
|
+
http_status = nil
|
606
|
+
request_duration = Util.monotonic_time - request_start if request_start
|
283
607
|
|
284
|
-
if e.
|
285
|
-
error_context = context.
|
608
|
+
if e.is_a?(Stripe::StripeError)
|
609
|
+
error_context = context.dup_from_response_headers(e.http_headers)
|
610
|
+
http_status = resp.code.to_i
|
286
611
|
log_response(error_context, request_start,
|
287
|
-
e.
|
612
|
+
e.http_status, e.http_body, resp)
|
288
613
|
else
|
289
614
|
log_response_error(error_context, request_start, e)
|
290
615
|
end
|
616
|
+
notify_request_end(context, request_duration, http_status, num_retries,
|
617
|
+
user_data)
|
291
618
|
|
292
|
-
if self.class.should_retry?(e,
|
619
|
+
if self.class.should_retry?(e,
|
620
|
+
method: method,
|
621
|
+
num_retries: num_retries,
|
622
|
+
config: config)
|
293
623
|
num_retries += 1
|
294
|
-
sleep self.class.sleep_time(num_retries)
|
624
|
+
sleep self.class.sleep_time(num_retries, config: config)
|
295
625
|
retry
|
296
626
|
end
|
297
627
|
|
298
628
|
case e
|
299
|
-
when
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
handle_network_error(e, error_context, num_retries, api_base)
|
304
|
-
end
|
629
|
+
when Stripe::StripeError
|
630
|
+
raise
|
631
|
+
when *NETWORK_ERROR_MESSAGES_MAP.keys
|
632
|
+
handle_network_error(e, error_context, num_retries, api_base)
|
305
633
|
|
306
634
|
# Only handle errors when we know we can do so, and re-raise otherwise.
|
307
635
|
# This should be pretty infrequent.
|
@@ -313,6 +641,42 @@ module Stripe
|
|
313
641
|
resp
|
314
642
|
end
|
315
643
|
|
644
|
+
private def notify_request_begin(context)
|
645
|
+
return unless Instrumentation.any_subscribers?(:request_begin)
|
646
|
+
|
647
|
+
event = Instrumentation::RequestBeginEvent.new(
|
648
|
+
method: context.method,
|
649
|
+
path: context.path,
|
650
|
+
user_data: {}
|
651
|
+
)
|
652
|
+
Stripe::Instrumentation.notify(:request_begin, event)
|
653
|
+
|
654
|
+
# This field may be set in the `request_begin` callback. If so, we'll
|
655
|
+
# forward it onto `request_end`.
|
656
|
+
event.user_data
|
657
|
+
end
|
658
|
+
|
659
|
+
private def notify_request_end(context, duration, http_status, num_retries,
|
660
|
+
user_data)
|
661
|
+
return if !Instrumentation.any_subscribers?(:request_end) &&
|
662
|
+
!Instrumentation.any_subscribers?(:request)
|
663
|
+
|
664
|
+
event = Instrumentation::RequestEndEvent.new(
|
665
|
+
duration: duration,
|
666
|
+
http_status: http_status,
|
667
|
+
method: context.method,
|
668
|
+
num_retries: num_retries,
|
669
|
+
path: context.path,
|
670
|
+
request_id: context.request_id,
|
671
|
+
user_data: user_data || {}
|
672
|
+
)
|
673
|
+
Stripe::Instrumentation.notify(:request_end, event)
|
674
|
+
|
675
|
+
# The name before `request_begin` was also added. Provided for backwards
|
676
|
+
# compatibility.
|
677
|
+
Stripe::Instrumentation.notify(:request, event)
|
678
|
+
end
|
679
|
+
|
316
680
|
private def general_api_error(status, body)
|
317
681
|
APIError.new("Invalid response object from API: #{body.inspect} " \
|
318
682
|
"(HTTP response code was #{status})",
|
@@ -332,12 +696,12 @@ module Stripe
|
|
332
696
|
|
333
697
|
private def handle_error_response(http_resp, context)
|
334
698
|
begin
|
335
|
-
resp = StripeResponse.
|
699
|
+
resp = StripeResponse.from_net_http(http_resp)
|
336
700
|
error_data = resp.data[:error]
|
337
701
|
|
338
702
|
raise StripeError, "Indeterminate error" unless error_data
|
339
703
|
rescue JSON::ParserError, StripeError
|
340
|
-
raise general_api_error(http_resp
|
704
|
+
raise general_api_error(http_resp.code.to_i, http_resp.body)
|
341
705
|
end
|
342
706
|
|
343
707
|
error = if error_data.is_a?(String)
|
@@ -350,6 +714,28 @@ module Stripe
|
|
350
714
|
raise(error)
|
351
715
|
end
|
352
716
|
|
717
|
+
# Works around an edge case where we end up with both query parameters from
|
718
|
+
# parameteers and query parameters that were appended onto the end of the
|
719
|
+
# given path.
|
720
|
+
#
|
721
|
+
# Decode any parameters that were added onto the end of a path and add them
|
722
|
+
# to a unified query parameter hash so that all parameters end up in one
|
723
|
+
# place and all of them are correctly included in the final request.
|
724
|
+
private def merge_query_params(query_params, path)
|
725
|
+
u = URI.parse(path)
|
726
|
+
|
727
|
+
# Return original results if there was nothing to be found.
|
728
|
+
return query_params, path if u.query.nil?
|
729
|
+
|
730
|
+
query_params ||= {}
|
731
|
+
query_params = Hash[URI.decode_www_form(u.query)].merge(query_params)
|
732
|
+
|
733
|
+
# Reset the path minus any query parameters that were specified.
|
734
|
+
path = u.path
|
735
|
+
|
736
|
+
[query_params, path]
|
737
|
+
end
|
738
|
+
|
353
739
|
private def specific_api_error(resp, error_data, context)
|
354
740
|
Util.log_error("Stripe API error",
|
355
741
|
status: resp.http_status,
|
@@ -358,7 +744,8 @@ module Stripe
|
|
358
744
|
error_param: error_data[:param],
|
359
745
|
error_type: error_data[:type],
|
360
746
|
idempotency_key: context.idempotency_key,
|
361
|
-
request_id: context.request_id
|
747
|
+
request_id: context.request_id,
|
748
|
+
config: config)
|
362
749
|
|
363
750
|
# The standard set of arguments that can be used to initialize most of
|
364
751
|
# the exceptions.
|
@@ -374,29 +761,26 @@ module Stripe
|
|
374
761
|
when 400, 404
|
375
762
|
case error_data[:type]
|
376
763
|
when "idempotency_error"
|
377
|
-
IdempotencyError.new(error_data[:message], opts)
|
764
|
+
IdempotencyError.new(error_data[:message], **opts)
|
378
765
|
else
|
379
766
|
InvalidRequestError.new(
|
380
767
|
error_data[:message], error_data[:param],
|
381
|
-
opts
|
768
|
+
**opts
|
382
769
|
)
|
383
770
|
end
|
384
771
|
when 401
|
385
|
-
AuthenticationError.new(error_data[:message], opts)
|
772
|
+
AuthenticationError.new(error_data[:message], **opts)
|
386
773
|
when 402
|
387
|
-
# TODO: modify CardError constructor to make code a keyword argument
|
388
|
-
# so we don't have to delete it from opts
|
389
|
-
opts.delete(:code)
|
390
774
|
CardError.new(
|
391
|
-
error_data[:message], error_data[:param],
|
392
|
-
opts
|
775
|
+
error_data[:message], error_data[:param],
|
776
|
+
**opts
|
393
777
|
)
|
394
778
|
when 403
|
395
|
-
PermissionError.new(error_data[:message], opts)
|
779
|
+
PermissionError.new(error_data[:message], **opts)
|
396
780
|
when 429
|
397
|
-
RateLimitError.new(error_data[:message], opts)
|
781
|
+
RateLimitError.new(error_data[:message], **opts)
|
398
782
|
else
|
399
|
-
APIError.new(error_data[:message], opts)
|
783
|
+
APIError.new(error_data[:message], **opts)
|
400
784
|
end
|
401
785
|
end
|
402
786
|
|
@@ -410,30 +794,31 @@ module Stripe
|
|
410
794
|
error_code: error_code,
|
411
795
|
error_description: description,
|
412
796
|
idempotency_key: context.idempotency_key,
|
413
|
-
request_id: context.request_id
|
797
|
+
request_id: context.request_id,
|
798
|
+
config: config)
|
414
799
|
|
415
|
-
args =
|
800
|
+
args = {
|
416
801
|
http_status: resp.http_status, http_body: resp.http_body,
|
417
802
|
json_body: resp.data, http_headers: resp.http_headers,
|
418
|
-
}
|
803
|
+
}
|
419
804
|
|
420
805
|
case error_code
|
421
806
|
when "invalid_client"
|
422
|
-
OAuth::InvalidClientError.new(
|
807
|
+
OAuth::InvalidClientError.new(error_code, description, **args)
|
423
808
|
when "invalid_grant"
|
424
|
-
OAuth::InvalidGrantError.new(
|
809
|
+
OAuth::InvalidGrantError.new(error_code, description, **args)
|
425
810
|
when "invalid_request"
|
426
|
-
OAuth::InvalidRequestError.new(
|
811
|
+
OAuth::InvalidRequestError.new(error_code, description, **args)
|
427
812
|
when "invalid_scope"
|
428
|
-
OAuth::InvalidScopeError.new(
|
813
|
+
OAuth::InvalidScopeError.new(error_code, description, **args)
|
429
814
|
when "unsupported_grant_type"
|
430
|
-
OAuth::UnsupportedGrantTypeError.new(
|
815
|
+
OAuth::UnsupportedGrantTypeError.new(error_code, description, **args)
|
431
816
|
when "unsupported_response_type"
|
432
|
-
OAuth::UnsupportedResponseTypeError.new(
|
817
|
+
OAuth::UnsupportedResponseTypeError.new(error_code, description, **args)
|
433
818
|
else
|
434
819
|
# We'd prefer that all errors are typed, but we create a generic
|
435
820
|
# OAuthError in case we run into a code that we don't recognize.
|
436
|
-
OAuth::OAuthError.new(
|
821
|
+
OAuth::OAuthError.new(error_code, description, **args)
|
437
822
|
end
|
438
823
|
end
|
439
824
|
|
@@ -442,35 +827,21 @@ module Stripe
|
|
442
827
|
Util.log_error("Stripe network error",
|
443
828
|
error_message: error.message,
|
444
829
|
idempotency_key: context.idempotency_key,
|
445
|
-
request_id: context.request_id
|
446
|
-
|
447
|
-
case error
|
448
|
-
when Faraday::ConnectionFailed
|
449
|
-
message = "Unexpected error communicating when trying to connect to " \
|
450
|
-
"Stripe. You may be seeing this message because your DNS is not " \
|
451
|
-
"working. To check, try running `host stripe.com` from the " \
|
452
|
-
"command line."
|
453
|
-
|
454
|
-
when Faraday::SSLError
|
455
|
-
message = "Could not establish a secure connection to Stripe, you " \
|
456
|
-
"may need to upgrade your OpenSSL version. To check, try running " \
|
457
|
-
"`openssl s_client -connect api.stripe.com:443` from the command " \
|
458
|
-
"line."
|
459
|
-
|
460
|
-
when Faraday::TimeoutError
|
461
|
-
api_base ||= Stripe.api_base
|
462
|
-
message = "Could not connect to Stripe (#{api_base}). " \
|
463
|
-
"Please check your internet connection and try again. " \
|
464
|
-
"If this problem persists, you should check Stripe's service " \
|
465
|
-
"status at https://status.stripe.com, or let us know at " \
|
466
|
-
"support@stripe.com."
|
830
|
+
request_id: context.request_id,
|
831
|
+
config: config)
|
467
832
|
|
468
|
-
|
469
|
-
|
470
|
-
|
833
|
+
errors, message = NETWORK_ERROR_MESSAGES_MAP.detect do |(e, _)|
|
834
|
+
error.is_a?(e)
|
835
|
+
end
|
471
836
|
|
837
|
+
if errors.nil?
|
838
|
+
message = "Unexpected error #{error.class.name} communicating " \
|
839
|
+
"with Stripe. Please let us know at support@stripe.com."
|
472
840
|
end
|
473
841
|
|
842
|
+
api_base ||= config.api_base
|
843
|
+
message = message % api_base
|
844
|
+
|
474
845
|
message += " Request was retried #{num_retries} times." if num_retries > 0
|
475
846
|
|
476
847
|
raise APIConnectionError,
|
@@ -489,7 +860,7 @@ module Stripe
|
|
489
860
|
"Content-Type" => "application/x-www-form-urlencoded",
|
490
861
|
}
|
491
862
|
|
492
|
-
if
|
863
|
+
if config.enable_telemetry? && !@last_request_metrics.nil?
|
493
864
|
headers["X-Stripe-Client-Telemetry"] = JSON.generate(
|
494
865
|
last_request_metrics: @last_request_metrics.payload
|
495
866
|
)
|
@@ -497,12 +868,12 @@ module Stripe
|
|
497
868
|
|
498
869
|
# It is only safe to retry network failures on post and delete
|
499
870
|
# requests if we add an Idempotency-Key header
|
500
|
-
if %i[post delete].include?(method) &&
|
871
|
+
if %i[post delete].include?(method) && config.max_network_retries > 0
|
501
872
|
headers["Idempotency-Key"] ||= SecureRandom.uuid
|
502
873
|
end
|
503
874
|
|
504
|
-
headers["Stripe-Version"] =
|
505
|
-
headers["Stripe-Account"] =
|
875
|
+
headers["Stripe-Version"] = config.api_version if config.api_version
|
876
|
+
headers["Stripe-Account"] = config.stripe_account if config.stripe_account
|
506
877
|
|
507
878
|
user_agent = @system_profiler.user_agent
|
508
879
|
begin
|
@@ -526,27 +897,38 @@ module Stripe
|
|
526
897
|
idempotency_key: context.idempotency_key,
|
527
898
|
method: context.method,
|
528
899
|
num_retries: num_retries,
|
529
|
-
path: context.path
|
900
|
+
path: context.path,
|
901
|
+
config: config)
|
530
902
|
Util.log_debug("Request details",
|
531
903
|
body: context.body,
|
532
904
|
idempotency_key: context.idempotency_key,
|
533
|
-
|
905
|
+
query: context.query,
|
906
|
+
config: config,
|
907
|
+
process_id: Process.pid,
|
908
|
+
thread_object_id: Thread.current.object_id,
|
909
|
+
log_timestamp: Util.monotonic_time)
|
534
910
|
end
|
535
911
|
|
536
|
-
private def log_response(context, request_start, status, body)
|
912
|
+
private def log_response(context, request_start, status, body, resp)
|
537
913
|
Util.log_info("Response from Stripe API",
|
538
914
|
account: context.account,
|
539
915
|
api_version: context.api_version,
|
540
|
-
elapsed:
|
916
|
+
elapsed: Util.monotonic_time - request_start,
|
541
917
|
idempotency_key: context.idempotency_key,
|
542
918
|
method: context.method,
|
543
919
|
path: context.path,
|
544
920
|
request_id: context.request_id,
|
545
|
-
status: status
|
921
|
+
status: status,
|
922
|
+
config: config)
|
546
923
|
Util.log_debug("Response details",
|
547
924
|
body: body,
|
548
925
|
idempotency_key: context.idempotency_key,
|
549
|
-
request_id: context.request_id
|
926
|
+
request_id: context.request_id,
|
927
|
+
config: config,
|
928
|
+
process_id: Process.pid,
|
929
|
+
thread_object_id: Thread.current.object_id,
|
930
|
+
response_object_id: resp.object_id,
|
931
|
+
log_timestamp: Util.monotonic_time)
|
550
932
|
|
551
933
|
return unless context.request_id
|
552
934
|
|
@@ -554,16 +936,19 @@ module Stripe
|
|
554
936
|
idempotency_key: context.idempotency_key,
|
555
937
|
request_id: context.request_id,
|
556
938
|
url: Util.request_id_dashboard_url(context.request_id,
|
557
|
-
context.api_key)
|
939
|
+
context.api_key),
|
940
|
+
config: config)
|
558
941
|
end
|
559
942
|
|
560
943
|
private def log_response_error(context, request_start, error)
|
944
|
+
elapsed = request_start ? Util.monotonic_time - request_start : nil
|
561
945
|
Util.log_error("Request error",
|
562
|
-
elapsed:
|
946
|
+
elapsed: elapsed,
|
563
947
|
error_message: error.message,
|
564
948
|
idempotency_key: context.idempotency_key,
|
565
949
|
method: context.method,
|
566
|
-
path: context.path
|
950
|
+
path: context.path,
|
951
|
+
config: config)
|
567
952
|
end
|
568
953
|
|
569
954
|
# RequestLogContext stores information about a request that's begin made so
|
@@ -577,7 +962,7 @@ module Stripe
|
|
577
962
|
attr_accessor :idempotency_key
|
578
963
|
attr_accessor :method
|
579
964
|
attr_accessor :path
|
580
|
-
attr_accessor :
|
965
|
+
attr_accessor :query
|
581
966
|
attr_accessor :request_id
|
582
967
|
|
583
968
|
# The idea with this method is that we might want to update some of
|
@@ -586,18 +971,7 @@ module Stripe
|
|
586
971
|
# with for a request. For example, we should trust whatever came back in
|
587
972
|
# a `Stripe-Version` header beyond what configuration information that we
|
588
973
|
# might have had available.
|
589
|
-
def
|
590
|
-
return self if resp.nil?
|
591
|
-
|
592
|
-
# Faraday's API is a little unusual. Normally it'll produce a response
|
593
|
-
# object with a `headers` method, but on error what it puts into
|
594
|
-
# `e.response` is an untyped `Hash`.
|
595
|
-
headers = if resp.is_a?(Faraday::Response)
|
596
|
-
resp.headers
|
597
|
-
else
|
598
|
-
resp[:headers]
|
599
|
-
end
|
600
|
-
|
974
|
+
def dup_from_response_headers(headers)
|
601
975
|
context = dup
|
602
976
|
context.account = headers["Stripe-Account"]
|
603
977
|
context.api_version = headers["Stripe-Version"]
|