Gem that retrieves review information from different services
Ruby
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
user_reviews.gemspec

README.md

UserReviews

Build Status

Is a simple api wrapper for:

  • Yelp
  • Citysearch
  • Google Ratings

Getting started

Add this line to your application's Gemfile:

gem 'user_reviews'

And then execute:

$ bundle

Or install it yourself as:

$ gem install user_reviews

Usage

Create an api_provider

For Citysearch

auth_info = {publisher_key: 'your_city_search_api_key'}
city_search = UserReviews.provider_factory(:citysearch, auth_info)

For Google Reviews

auth_info = {key: 'your_google_api_key'}
google = UserReviews.provider_factory(:google, auth_info)

For Yelp

auth_info = {consumer_key: 'yelp_consumer_key', consumer_secret:'yelp_consumer_secret' ,token:'yelp_token' , token_secret:'yelp_token_secret'}
yelp = UserReviews.provider_factory(:yelp, auth_info)

Get reviews for a business

city_search.find_reviews_for_business city_search_business_id

Get information about a business

city_search.find_business_by_id(business_id)

Each Review object has 4 attributes:

  • author_name
  • rating
  • reviewed_at
  • comment

Each Business object has 4 attributes:

  • name
  • address
  • reference
  • average_rating
  • url

More information about each API:

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Add your own provider folder which inherits from the Providers::Base class and tests
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

License

MIT License. Copyright 2013. http://www.unpakt.com