Module: RedditKit::Client::Search

Included in:
RedditKit::Client
Defined in:
lib/redditkit/client/search.rb

Overview

Methods for searching reddit’s links.

Instance Method Summary collapse

Instance Method Details

#search(query, options = {}) ⇒ RedditKit::PaginatedResponse

Search for links.

Parameters:

  • query (String) —

    The search query.

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :restrict_to_subreddit (true, false) —

    Whether to search only in a specified subreddit.

  • :subreddit (String, RedditKit::Subreddit) —

    The optional subreddit to search.

  • limit (1..100) —

    The number of links to return.

  • before (String) —

    Only return links before this full name.

  • after (String) —

    Only return links after this full name.

Returns:



16
17
18
19
20
21
 
# File 'lib/redditkit/client/search.rb', line 16

def search(query, options = {})
  path = "%s/search.json" % ('r/' + options[:subreddit] if options[:subreddit])
  parameters = { :q => query, :restrict_sr => options[:restrict_to_subreddit], :limit => options[:limit] }
  
  objects_from_response(:get, path, parameters)
end