stripe 5.26.0 → 5.55.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 +126 -0
- data/Gemfile +0 -1
- data/Makefile +7 -0
- data/README.md +10 -5
- data/VERSION +1 -1
- data/lib/stripe/api_operations/request.rb +35 -2
- data/lib/stripe/api_operations/search.rb +19 -0
- data/lib/stripe/api_resource.rb +10 -17
- data/lib/stripe/api_resource_test_helpers.rb +47 -0
- data/lib/stripe/connection_manager.rb +51 -10
- data/lib/stripe/error_object.rb +2 -3
- data/lib/stripe/instrumentation.rb +3 -1
- data/lib/stripe/oauth.rb +4 -3
- data/lib/stripe/object_types.rb +19 -1
- data/lib/stripe/resources/account.rb +3 -8
- data/lib/stripe/resources/application_fee_refund.rb +2 -1
- data/lib/stripe/resources/billing_portal/configuration.rb +14 -0
- data/lib/stripe/resources/bitcoin_transaction.rb +3 -2
- data/lib/stripe/resources/capability.rb +2 -1
- data/lib/stripe/resources/cash_balance.rb +22 -0
- data/lib/stripe/resources/charge.rb +9 -0
- data/lib/stripe/resources/checkout/session.rb +11 -0
- data/lib/stripe/resources/credit_note_line_item.rb +1 -0
- data/lib/stripe/resources/customer.rb +39 -1
- data/lib/stripe/resources/customer_balance_transaction.rb +3 -2
- data/lib/stripe/resources/discount.rb +1 -0
- data/lib/stripe/resources/file.rb +2 -1
- data/lib/stripe/resources/financial_connections/account.rb +31 -0
- data/lib/stripe/resources/financial_connections/account_owner.rb +10 -0
- data/lib/stripe/resources/financial_connections/account_ownership.rb +10 -0
- data/lib/stripe/resources/financial_connections/session.rb +12 -0
- 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 +9 -0
- data/lib/stripe/resources/invoice_line_item.rb +1 -0
- data/lib/stripe/resources/issuing/card_details.rb +2 -1
- data/lib/stripe/resources/line_item.rb +1 -0
- data/lib/stripe/resources/login_link.rb +1 -0
- data/lib/stripe/resources/payment_intent.rb +39 -0
- data/lib/stripe/resources/payment_link.rb +23 -0
- data/lib/stripe/resources/payout.rb +10 -0
- data/lib/stripe/resources/person.rb +1 -0
- data/lib/stripe/resources/price.rb +9 -0
- data/lib/stripe/resources/product.rb +9 -0
- data/lib/stripe/resources/quote.rb +105 -0
- data/lib/stripe/resources/refund.rb +30 -0
- data/lib/stripe/resources/reversal.rb +3 -2
- data/lib/stripe/resources/setup_intent.rb +10 -0
- data/lib/stripe/resources/shipping_rate.rb +12 -0
- data/lib/stripe/resources/source_transaction.rb +1 -0
- data/lib/stripe/resources/subscription.rb +9 -0
- data/lib/stripe/resources/tax_code.rb +10 -0
- data/lib/stripe/resources/tax_id.rb +1 -0
- data/lib/stripe/resources/terminal/configuration.rb +15 -0
- data/lib/stripe/resources/terminal/reader.rb +60 -0
- data/lib/stripe/resources/test_helpers/test_clock.rb +25 -0
- data/lib/stripe/resources/usage_record.rb +1 -0
- data/lib/stripe/resources/usage_record_summary.rb +1 -0
- data/lib/stripe/resources.rb +16 -0
- data/lib/stripe/search_result_object.rb +86 -0
- data/lib/stripe/stripe_client.rb +252 -114
- data/lib/stripe/stripe_configuration.rb +35 -8
- data/lib/stripe/stripe_object.rb +23 -0
- data/lib/stripe/stripe_response.rb +80 -52
- data/lib/stripe/util.rb +62 -7
- data/lib/stripe/version.rb +1 -1
- data/lib/stripe.rb +27 -22
- data/stripe.gemspec +12 -5
- metadata +26 -196
- data/.editorconfig +0 -10
- data/.gitattributes +0 -4
- data/.github/ISSUE_TEMPLATE.md +0 -5
- data/.gitignore +0 -8
- data/.rubocop.yml +0 -80
- data/.rubocop_todo.yml +0 -33
- data/.travis.yml +0 -38
- data/.vscode/extensions.json +0 -7
- data/.vscode/settings.json +0 -8
- data/test/openapi/README.md +0 -9
- data/test/stripe/account_link_test.rb +0 -18
- data/test/stripe/account_test.rb +0 -412
- 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 -646
- 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/balance_transaction_test.rb +0 -20
- data/test/stripe/bank_account_test.rb +0 -36
- data/test/stripe/billing_portal/session_test.rb +0 -18
- data/test/stripe/capability_test.rb +0 -45
- data/test/stripe/charge_test.rb +0 -64
- data/test/stripe/checkout/session_test.rb +0 -53
- data/test/stripe/connection_manager_test.rb +0 -163
- 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 -90
- data/test/stripe/customer_balance_transaction_test.rb +0 -37
- data/test/stripe/customer_card_test.rb +0 -48
- data/test/stripe/customer_test.rb +0 -226
- data/test/stripe/dispute_test.rb +0 -51
- data/test/stripe/ephemeral_key_test.rb +0 -93
- data/test/stripe/errors_test.rb +0 -53
- 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 -87
- data/test/stripe/instrumentation_test.rb +0 -74
- 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 -229
- data/test/stripe/issuing/authorization_test.rb +0 -72
- data/test/stripe/issuing/card_test.rb +0 -74
- data/test/stripe/issuing/cardholder_test.rb +0 -53
- data/test/stripe/issuing/dispute_test.rb +0 -54
- data/test/stripe/issuing/transaction_test.rb +0 -48
- data/test/stripe/list_object_test.rb +0 -202
- data/test/stripe/login_link_test.rb +0 -37
- data/test/stripe/mandate_test.rb +0 -14
- data/test/stripe/multipart_encoder_test.rb +0 -130
- data/test/stripe/oauth_test.rb +0 -104
- 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/price_test.rb +0 -48
- data/test/stripe/product_test.rb +0 -58
- data/test/stripe/promotion_code_test.rb +0 -42
- 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_attempt_test.rb +0 -16
- 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 -119
- data/test/stripe/stripe_client_test.rb +0 -1291
- data/test/stripe/stripe_configuration_test.rb +0 -128
- data/test/stripe/stripe_object_test.rb +0 -500
- data/test/stripe/stripe_response_test.rb +0 -95
- data/test/stripe/subscription_item_test.rb +0 -84
- data/test/stripe/subscription_schedule_test.rb +0 -82
- 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 -29
- data/test/stripe/util_test.rb +0 -402
- data/test/stripe/webhook_endpoint_test.rb +0 -59
- data/test/stripe/webhook_test.rb +0 -135
- data/test/stripe_mock.rb +0 -78
- data/test/stripe_test.rb +0 -119
- data/test/test_data.rb +0 -61
- data/test/test_helper.rb +0 -75
@@ -8,5 +8,35 @@ module Stripe
|
|
8
8
|
include Stripe::APIOperations::Save
|
9
9
|
|
10
10
|
OBJECT_NAME = "refund"
|
11
|
+
|
12
|
+
custom_method :cancel, http_verb: :post
|
13
|
+
|
14
|
+
def cancel(params = {}, opts = {})
|
15
|
+
request_stripe_object(
|
16
|
+
method: :post,
|
17
|
+
path: resource_url + "/cancel",
|
18
|
+
params: params,
|
19
|
+
opts: opts
|
20
|
+
)
|
21
|
+
end
|
22
|
+
|
23
|
+
def test_helpers
|
24
|
+
TestHelpers.new(self)
|
25
|
+
end
|
26
|
+
|
27
|
+
class TestHelpers < APIResourceTestHelpers
|
28
|
+
RESOURCE_CLASS = Refund
|
29
|
+
|
30
|
+
custom_method :expire, http_verb: :post
|
31
|
+
|
32
|
+
def expire(params = {}, opts = {})
|
33
|
+
@resource.request_stripe_object(
|
34
|
+
method: :post,
|
35
|
+
path: resource_url + "/expire",
|
36
|
+
params: params,
|
37
|
+
opts: opts
|
38
|
+
)
|
39
|
+
end
|
40
|
+
end
|
11
41
|
end
|
12
42
|
end
|
@@ -1,3 +1,4 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
1
2
|
# frozen_string_literal: true
|
2
3
|
|
3
4
|
module Stripe
|
@@ -22,8 +23,8 @@ module Stripe
|
|
22
23
|
def self.retrieve(_id, _opts = {})
|
23
24
|
raise NotImplementedError,
|
24
25
|
"Reversals cannot be retrieved without a transfer ID. Retrieve " \
|
25
|
-
|
26
|
-
|
26
|
+
"a reversal using `Transfer.retrieve_reversal('transfer_id', " \
|
27
|
+
"'reversal_id'`"
|
27
28
|
end
|
28
29
|
end
|
29
30
|
end
|
@@ -11,6 +11,7 @@ module Stripe
|
|
11
11
|
|
12
12
|
custom_method :cancel, http_verb: :post
|
13
13
|
custom_method :confirm, http_verb: :post
|
14
|
+
custom_method :verify_microdeposits, http_verb: :post
|
14
15
|
|
15
16
|
def cancel(params = {}, opts = {})
|
16
17
|
request_stripe_object(
|
@@ -29,5 +30,14 @@ module Stripe
|
|
29
30
|
opts: opts
|
30
31
|
)
|
31
32
|
end
|
33
|
+
|
34
|
+
def verify_microdeposits(params = {}, opts = {})
|
35
|
+
request_stripe_object(
|
36
|
+
method: :post,
|
37
|
+
path: resource_url + "/verify_microdeposits",
|
38
|
+
params: params,
|
39
|
+
opts: opts
|
40
|
+
)
|
41
|
+
end
|
32
42
|
end
|
33
43
|
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
class ShippingRate < APIResource
|
6
|
+
extend Stripe::APIOperations::Create
|
7
|
+
extend Stripe::APIOperations::List
|
8
|
+
include Stripe::APIOperations::Save
|
9
|
+
|
10
|
+
OBJECT_NAME = "shipping_rate"
|
11
|
+
end
|
12
|
+
end
|
@@ -6,6 +6,7 @@ module Stripe
|
|
6
6
|
extend Stripe::APIOperations::Create
|
7
7
|
include Stripe::APIOperations::Delete
|
8
8
|
extend Stripe::APIOperations::List
|
9
|
+
extend Stripe::APIOperations::Search
|
9
10
|
include Stripe::APIOperations::Save
|
10
11
|
|
11
12
|
OBJECT_NAME = "subscription"
|
@@ -22,5 +23,13 @@ module Stripe
|
|
22
23
|
end
|
23
24
|
|
24
25
|
save_nested_resource :source
|
26
|
+
|
27
|
+
def self.search(params = {}, opts = {})
|
28
|
+
_search("/v1/subscriptions/search", params, opts)
|
29
|
+
end
|
30
|
+
|
31
|
+
def self.search_auto_paging_each(params = {}, opts = {}, &blk)
|
32
|
+
search(params, opts).auto_paging_each(&blk)
|
33
|
+
end
|
25
34
|
end
|
26
35
|
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module Terminal
|
6
|
+
class Configuration < APIResource
|
7
|
+
extend Stripe::APIOperations::Create
|
8
|
+
include Stripe::APIOperations::Delete
|
9
|
+
extend Stripe::APIOperations::List
|
10
|
+
include Stripe::APIOperations::Save
|
11
|
+
|
12
|
+
OBJECT_NAME = "terminal.configuration"
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -10,6 +10,66 @@ module Stripe
|
|
10
10
|
include Stripe::APIOperations::Save
|
11
11
|
|
12
12
|
OBJECT_NAME = "terminal.reader"
|
13
|
+
|
14
|
+
custom_method :cancel_action, http_verb: :post
|
15
|
+
custom_method :process_payment_intent, http_verb: :post
|
16
|
+
custom_method :process_setup_intent, http_verb: :post
|
17
|
+
custom_method :set_reader_display, http_verb: :post
|
18
|
+
|
19
|
+
def cancel_action(params = {}, opts = {})
|
20
|
+
request_stripe_object(
|
21
|
+
method: :post,
|
22
|
+
path: resource_url + "/cancel_action",
|
23
|
+
params: params,
|
24
|
+
opts: opts
|
25
|
+
)
|
26
|
+
end
|
27
|
+
|
28
|
+
def process_payment_intent(params = {}, opts = {})
|
29
|
+
request_stripe_object(
|
30
|
+
method: :post,
|
31
|
+
path: resource_url + "/process_payment_intent",
|
32
|
+
params: params,
|
33
|
+
opts: opts
|
34
|
+
)
|
35
|
+
end
|
36
|
+
|
37
|
+
def process_setup_intent(params = {}, opts = {})
|
38
|
+
request_stripe_object(
|
39
|
+
method: :post,
|
40
|
+
path: resource_url + "/process_setup_intent",
|
41
|
+
params: params,
|
42
|
+
opts: opts
|
43
|
+
)
|
44
|
+
end
|
45
|
+
|
46
|
+
def set_reader_display(params = {}, opts = {})
|
47
|
+
request_stripe_object(
|
48
|
+
method: :post,
|
49
|
+
path: resource_url + "/set_reader_display",
|
50
|
+
params: params,
|
51
|
+
opts: opts
|
52
|
+
)
|
53
|
+
end
|
54
|
+
|
55
|
+
def test_helpers
|
56
|
+
TestHelpers.new(self)
|
57
|
+
end
|
58
|
+
|
59
|
+
class TestHelpers < APIResourceTestHelpers
|
60
|
+
RESOURCE_CLASS = Reader
|
61
|
+
|
62
|
+
custom_method :present_payment_method, http_verb: :post
|
63
|
+
|
64
|
+
def present_payment_method(params = {}, opts = {})
|
65
|
+
@resource.request_stripe_object(
|
66
|
+
method: :post,
|
67
|
+
path: resource_url + "/present_payment_method",
|
68
|
+
params: params,
|
69
|
+
opts: opts
|
70
|
+
)
|
71
|
+
end
|
72
|
+
end
|
13
73
|
end
|
14
74
|
end
|
15
75
|
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
module Stripe
|
5
|
+
module TestHelpers
|
6
|
+
class TestClock < APIResource
|
7
|
+
extend Stripe::APIOperations::Create
|
8
|
+
include Stripe::APIOperations::Delete
|
9
|
+
extend Stripe::APIOperations::List
|
10
|
+
|
11
|
+
OBJECT_NAME = "test_helpers.test_clock"
|
12
|
+
|
13
|
+
custom_method :advance, http_verb: :post
|
14
|
+
|
15
|
+
def advance(params = {}, opts = {})
|
16
|
+
request_stripe_object(
|
17
|
+
method: :post,
|
18
|
+
path: resource_url + "/advance",
|
19
|
+
params: params,
|
20
|
+
opts: opts
|
21
|
+
)
|
22
|
+
end
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
data/lib/stripe/resources.rb
CHANGED
@@ -1,3 +1,4 @@
|
|
1
|
+
# File generated from our OpenAPI spec
|
1
2
|
# frozen_string_literal: true
|
2
3
|
|
3
4
|
require "stripe/resources/account"
|
@@ -9,11 +10,13 @@ require "stripe/resources/application_fee_refund"
|
|
9
10
|
require "stripe/resources/balance"
|
10
11
|
require "stripe/resources/balance_transaction"
|
11
12
|
require "stripe/resources/bank_account"
|
13
|
+
require "stripe/resources/billing_portal/configuration"
|
12
14
|
require "stripe/resources/billing_portal/session"
|
13
15
|
require "stripe/resources/bitcoin_receiver"
|
14
16
|
require "stripe/resources/bitcoin_transaction"
|
15
17
|
require "stripe/resources/capability"
|
16
18
|
require "stripe/resources/card"
|
19
|
+
require "stripe/resources/cash_balance"
|
17
20
|
require "stripe/resources/charge"
|
18
21
|
require "stripe/resources/checkout/session"
|
19
22
|
require "stripe/resources/country_spec"
|
@@ -29,6 +32,13 @@ require "stripe/resources/event"
|
|
29
32
|
require "stripe/resources/exchange_rate"
|
30
33
|
require "stripe/resources/file"
|
31
34
|
require "stripe/resources/file_link"
|
35
|
+
require "stripe/resources/financial_connections/account"
|
36
|
+
require "stripe/resources/financial_connections/account_owner"
|
37
|
+
require "stripe/resources/financial_connections/account_ownership"
|
38
|
+
require "stripe/resources/financial_connections/session"
|
39
|
+
require "stripe/resources/funding_instructions"
|
40
|
+
require "stripe/resources/identity/verification_report"
|
41
|
+
require "stripe/resources/identity/verification_session"
|
32
42
|
require "stripe/resources/invoice"
|
33
43
|
require "stripe/resources/invoice_item"
|
34
44
|
require "stripe/resources/invoice_line_item"
|
@@ -44,6 +54,7 @@ require "stripe/resources/mandate"
|
|
44
54
|
require "stripe/resources/order"
|
45
55
|
require "stripe/resources/order_return"
|
46
56
|
require "stripe/resources/payment_intent"
|
57
|
+
require "stripe/resources/payment_link"
|
47
58
|
require "stripe/resources/payment_method"
|
48
59
|
require "stripe/resources/payout"
|
49
60
|
require "stripe/resources/person"
|
@@ -51,6 +62,7 @@ require "stripe/resources/plan"
|
|
51
62
|
require "stripe/resources/price"
|
52
63
|
require "stripe/resources/product"
|
53
64
|
require "stripe/resources/promotion_code"
|
65
|
+
require "stripe/resources/quote"
|
54
66
|
require "stripe/resources/radar/early_fraud_warning"
|
55
67
|
require "stripe/resources/radar/value_list"
|
56
68
|
require "stripe/resources/radar/value_list_item"
|
@@ -63,6 +75,7 @@ require "stripe/resources/reversal"
|
|
63
75
|
require "stripe/resources/review"
|
64
76
|
require "stripe/resources/setup_attempt"
|
65
77
|
require "stripe/resources/setup_intent"
|
78
|
+
require "stripe/resources/shipping_rate"
|
66
79
|
require "stripe/resources/sigma/scheduled_query_run"
|
67
80
|
require "stripe/resources/sku"
|
68
81
|
require "stripe/resources/source"
|
@@ -70,11 +83,14 @@ require "stripe/resources/source_transaction"
|
|
70
83
|
require "stripe/resources/subscription"
|
71
84
|
require "stripe/resources/subscription_item"
|
72
85
|
require "stripe/resources/subscription_schedule"
|
86
|
+
require "stripe/resources/tax_code"
|
73
87
|
require "stripe/resources/tax_id"
|
74
88
|
require "stripe/resources/tax_rate"
|
89
|
+
require "stripe/resources/terminal/configuration"
|
75
90
|
require "stripe/resources/terminal/connection_token"
|
76
91
|
require "stripe/resources/terminal/location"
|
77
92
|
require "stripe/resources/terminal/reader"
|
93
|
+
require "stripe/resources/test_helpers/test_clock"
|
78
94
|
require "stripe/resources/three_d_secure"
|
79
95
|
require "stripe/resources/token"
|
80
96
|
require "stripe/resources/topup"
|
@@ -0,0 +1,86 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Stripe
|
4
|
+
class SearchResultObject < StripeObject
|
5
|
+
include Enumerable
|
6
|
+
include Stripe::APIOperations::Search
|
7
|
+
include Stripe::APIOperations::Request
|
8
|
+
|
9
|
+
OBJECT_NAME = "search_result"
|
10
|
+
|
11
|
+
# This accessor allows a `SearchResultObject` to inherit various filters
|
12
|
+
# that were given to a predecessor. This allows for things like consistent
|
13
|
+
# limits, expansions, and predicates as a user pages through resources.
|
14
|
+
attr_accessor :filters
|
15
|
+
|
16
|
+
# An empty search result object. This is returned from +next+ when we know
|
17
|
+
# that there isn't a next page in order to replicate the behavior of the API
|
18
|
+
# when it attempts to return a page beyond the last.
|
19
|
+
def self.empty_search_result(opts = {})
|
20
|
+
SearchResultObject.construct_from({ data: [] }, opts)
|
21
|
+
end
|
22
|
+
|
23
|
+
def initialize(*args)
|
24
|
+
super
|
25
|
+
self.filters = {}
|
26
|
+
end
|
27
|
+
|
28
|
+
def [](key)
|
29
|
+
case key
|
30
|
+
when String, Symbol
|
31
|
+
super
|
32
|
+
else
|
33
|
+
raise ArgumentError,
|
34
|
+
"You tried to access the #{key.inspect} index, but " \
|
35
|
+
"SearchResultObject types only support String keys. " \
|
36
|
+
"(HINT: Search calls return an object with a 'data' (which is " \
|
37
|
+
"the data array). You likely want to call #data[#{key.inspect}])"
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
# Iterates through each resource in the page represented by the current
|
42
|
+
# `SearchListObject`.
|
43
|
+
#
|
44
|
+
# Note that this method makes no effort to fetch a new page when it gets to
|
45
|
+
# the end of the current page's resources. See also +auto_paging_each+.
|
46
|
+
def each(&blk)
|
47
|
+
data.each(&blk)
|
48
|
+
end
|
49
|
+
|
50
|
+
# Returns true if the page object contains no elements.
|
51
|
+
def empty?
|
52
|
+
data.empty?
|
53
|
+
end
|
54
|
+
|
55
|
+
# Iterates through each resource in all pages, making additional fetches to
|
56
|
+
# the API as necessary.
|
57
|
+
#
|
58
|
+
# Note that this method will make as many API calls as necessary to fetch
|
59
|
+
# all resources. For more granular control, please see +each+ and
|
60
|
+
# +next_search_result_page+.
|
61
|
+
def auto_paging_each(&blk)
|
62
|
+
return enum_for(:auto_paging_each) unless block_given?
|
63
|
+
|
64
|
+
page = self
|
65
|
+
|
66
|
+
loop do
|
67
|
+
page.each(&blk)
|
68
|
+
page = page.next_search_result_page
|
69
|
+
|
70
|
+
break if page.empty?
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# Fetches the next page in the resource list (if there is one).
|
75
|
+
#
|
76
|
+
# This method will try to respect the limit of the current page. If none
|
77
|
+
# was given, the default limit will be fetched again.
|
78
|
+
def next_search_result_page(params = {}, opts = {})
|
79
|
+
return self.class.empty_search_result(opts) unless has_more
|
80
|
+
|
81
|
+
params = filters.merge(page: next_page).merge(params)
|
82
|
+
|
83
|
+
_search(url, params, opts)
|
84
|
+
end
|
85
|
+
end
|
86
|
+
end
|