Module: Craigler

Defined in:

lib/craigler.rb,
lib/craigler/search.rb,
lib/craigler/version.rb,
lib/craigler/constants.rb

Defined Under Namespace

Classes: CraiglerError, InvalidCategory, InvalidLocation, InvalidSearchTerm, Search

Constant Summary

VERSION =

"1.3.3"

RESULTS_PER_PAGE =

25

Class Method Summary

• .find(search_term, options = {}) ⇒ Object

  Wrapper for Search#initialize.

• .search(category, options = {}) ⇒ Object

  Alternate interface to Search#initialize.

Class Method Details

.find(search_term, options = {}) ⇒ Object

Wrapper for Craigler::Search#initialize

Parameters:

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

  a customizable set of options

# File 'lib/craigler.rb', line 28

def find(search_term, options = {})
  results = Search.new(search_term, options).results()
  results.each {|result| yield(result) } if block_given?
  results
end

.search(category, options = {}) ⇒ Object

Alternate interface to Craigler::Search#initialize

Parameters:

• category (Symbol) —

  the category to search

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

  options passed to Craigler::Search#initialize.

# File 'lib/craigler.rb', line 18

def search(category, options = {})
  options = options.merge({ :only => category })
  results = Search.new(options.delete(:for), options).results()
  results.each {|result| yield(result) } if block_given?
  results
end