class BBC::Redux::SearchResults

Search results container

@example Properties of search results

results = redux_client.search(:name => 'Pingu')

results.created_at     #=> DateTime
results.query          #=> Hash
results.query_time     #=> Float
results.assets         #=> Array<BBC::Redux::Asset>
results.total          #=> Integer
results.total_returned #=> Integer
results.has_more?      #=> Boolean

@example Iterating all search results

results = redux_client.search(:name => 'Pingu', :offset => 0)

while true do
  results.assets.each do |asset|
    puts asset.name
  end

  if results.has_more?
    next_query = results.query.merge({
      :offset => results.query[:offset] + 10
    })

    results = redux_client.search(next_query)
  else
    break
  end
end

Public Instance Methods

has_more?() click to toggle source

@return [Boolean] true if there are more results available than

returned in this query
# File lib/bbc/redux/search_results.rb, line 75
def has_more?
  (offset + total_returned) < total
end