Skip to content

justinbeltran/yelpr

Repository files navigation

Yelpr

Build Status

Yelpr is a yelp gem for the masses. In general, it's just a wrapper on top of the existing Yelp v2 API.

Before you use Yelpr and Yelp's v2 API, you must set up API OAuth access on the following page:

http://www.yelp.com/developers/getting_started/api_access

See the following for reference, when using the client:

http://www.yelp.com/developers/documentation/v2/overview

Installation

gem install yelpr

Usage

After you provide your API credentials, you can pass API params to the search method as an options hash. For example to search for the first 5 results for "food" in Los Angeles, you would do the following:

client = Yelpr::Client.new do |c|
	c.consumer_key    = 'consumer_key'
	c.consumer_secret = 'consumer_secret'
	c.token           = 'token'
	c.token_secret    = 'token_secret'
end

results = client.search(:term => 'food', :location => 'Los Angeles, CA', :limit => 5)

The results are in the form of a Hashie::Mash

About

Ruby Yelp gem for the masses

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages