{"repo":"Yelp/yelp-ruby","free":true,"listed":false,"github":"https://github.com/Yelp/yelp-ruby","clone":"git clone https://github.com/Yelp/yelp-ruby.git","description":"A Ruby gem for communicating with the Yelp REST API","language":"Ruby","stars":103,"topics":["api-client","ruby"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"yelp-ruby This is a Ruby Gem for the Yelp API. It'll simplify the process of consuming data from the Yelp API for developers using Ruby. The library encompasses both Search and Business API functions. Please remember to read and follow the Terms of Use and display requirements before creating your applications. Installation Add this line to your application's Gemfile: gem 'yelp', require: 'yelp' And then execute: $ bundle Or install it yourself as: $ gem install yelp Usage Basic usage The gem uses a client model to query against the API. You create and configure a client with your API keys and make requests through that. Alternatively, you can also globally configure the client using a configure block, and access a client singleton using Yelp.client . If you intend to use the gem with Rails, the client should be configured in an initializer. After creating the client you're able to make requests to either the Search API or Business API. Note: all four keys are required for making requests against the Yelp API. If you need any keys sign up and get access from http://www.yelp.com/developers. Search API Once you have a client you can use #search to make a request to the Search API. You can also pass in general params and locale options to the method as hashes Key names and options for params and locale match the documented names on the Yelp Search API Additionally there are two more search methods for searching by a bounding box or for geographical coordinates: Business API To u","default_branch":null,"files":null,"tree":[],"storefront":"/r/Yelp","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Yelp/yelp-ruby/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}