Class: Stripe::SearchResultObject

Inherits:
StripeObject show all
Includes:
Enumerable, APIOperations::Request, APIOperations::Search
Defined in:
lib/stripe/search_result_object.rb

Constant Summary collapse

OBJECT_NAME =
"search_result"

Constants inherited from StripeObject

Stripe::StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Request

included

Methods included from APIOperations::Search

#_search

Methods inherited from StripeObject

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

Constructor Details

#initialize(*args) ⇒ SearchResultObject

Returns a new instance of SearchResultObject.


23
24
25
26
# File 'lib/stripe/search_result_object.rb', line 23

def initialize(*args)
  super
  self.filters = {}
end

Dynamic Method Handling

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

Instance Attribute Details

#filtersObject

This accessor allows a `SearchResultObject` to inherit various filters that were given to a predecessor. This allows for things like consistent limits, expansions, and predicates as a user pages through resources.


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

def filters
  @filters
end

Class Method Details

.empty_search_result(opts = {}) ⇒ Object

An empty search result object. This is returned from next when we know that there isn't a next page in order to replicate the behavior of the API when it attempts to return a page beyond the last.


19
20
21
# File 'lib/stripe/search_result_object.rb', line 19

def self.empty_search_result(opts = {})
  SearchResultObject.construct_from({ data: [] }, opts)
end

Instance Method Details

#[](key) ⇒ Object


28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/stripe/search_result_object.rb', line 28

def [](key)
  case key
  when String, Symbol
    super
  else
    raise ArgumentError,
          "You tried to access the #{key.inspect} index, but " \
          "SearchResultObject types only support String keys. " \
          "(HINT: Search calls return an object with a 'data' (which is " \
          "the data array). You likely want to call #data[#{key.inspect}])"
  end
end

#auto_paging_each(&blk) ⇒ Object

Iterates through each resource in all pages, making additional fetches to the API as necessary.

Note that this method will make as many API calls as necessary to fetch all resources. For more granular control, please see each and next_search_result_page.


61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/stripe/search_result_object.rb', line 61

def auto_paging_each(&blk)
  return enum_for(:auto_paging_each) unless block_given?

  page = self

  loop do
    page.each(&blk)
    page = page.next_search_result_page

    break if page.empty?
  end
end

#each(&blk) ⇒ Object

Iterates through each resource in the page represented by the current `SearchListObject`.

Note that this method makes no effort to fetch a new page when it gets to the end of the current page's resources. See also auto_paging_each.


46
47
48
# File 'lib/stripe/search_result_object.rb', line 46

def each(&blk)
  data.each(&blk)
end

#empty?Boolean

Returns true if the page object contains no elements.

Returns:

  • (Boolean)

51
52
53
# File 'lib/stripe/search_result_object.rb', line 51

def empty?
  data.empty?
end

#next_search_result_page(params = {}, opts = {}) ⇒ Object

Fetches the next page in the resource list (if there is one).

This method will try to respect the limit of the current page. If none was given, the default limit will be fetched again.


78
79
80
81
82
83
84
# File 'lib/stripe/search_result_object.rb', line 78

def next_search_result_page(params = {}, opts = {})
  return self.class.empty_search_result(opts) unless has_more

  params = filters.merge(page: next_page).merge(params)

  _search(url, params, opts)
end