Class: Yummly::Api

Inherits:

Object

• Object
• Yummly::Api

Defined in:

lib/yummly/api.rb

Class Method Summary

• .find(id) ⇒ Yummly::Recipe

  Retrieves a single recipe.

• .search(terms, params = {}) ⇒ Yummly::SearchResult

  Searches for recipes that match the supplied search terms.

Class Method Details

.find(id) ⇒ Yummly::Recipe

Retrieves a single recipe.

Examples:

recipe = Yummly::Api.find('French-Onion-Soup-The-Pioneer-Woman-Cooks-_-Ree-Drummond-41364')

Parameters:

• id (String) —

  The yummly recipe identifier.

Returns:

• (Yummly::Recipe) —

  a instance of a recipe object

# File 'lib/yummly/api.rb', line 19

def self.find(id)
  recipe_json = Yummly::Connection.get("recipe/#{id}")
  recipe_json.nil? ? nil : Yummly::Recipe.new(recipe_json)
end

.search(terms, params = {}) ⇒ Yummly::SearchResult

Searches for recipes that match the supplied search terms.

Examples:

recipes = Yummly::Api.search('Onion soup')

Parameters:

• terms (String) —

  A string of terms used to search API

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

  Additional options to pass to the search API

Returns:

• (Yummly::SearchResult) —

  an enumerable search result object

# File 'lib/yummly/api.rb', line 31

def self.search(terms, params = {})
  params[:q] = terms unless params.has_key?(:q)
  result = Yummly::Connection.get("recipes", params)
  Yummly::SearchResult.new(result)
end