FacebookPlaces
This gem provides a Ruby wrapper around the Facebook Places API.
Installation
Add this line to your application's Gemfile:
gem 'facebook_places'
And then execute:
$ bundle
Or install it yourself as:
$ gem install facebook_places
Usage
Initializing the Places Client by a token
client = FacebookPlaces::Client.new(token)
Places Search Docs
With the Places Search API, you can search for millions of places worldwide, and retrieve place-related details like the number of checkins, ratings, and addresses—all with a single request.
results = client.search(options)
option | Description |
---|---|
q | The name of the place to search for. |
center | The coordinates for the center of the search, in the format: [latitude],[longitude]; e.g., "140.7307,-73.9918". |
fields | An array of Place fields |
distance | The maximum distance from the center, in meters. This parameter can only be used in conjunction with center. |
categories | The place categories to restrict the search results, e.g., ["FOOD_BEVERAGE"]. |
Pagination You can paginate through next pages of the search results by
new_results = results.next_page
Place Information Docs
The Places Information API allows your app to retrieve Place-related information. You can retrieve Place-related information using a place ID.
place = client.find(place_id, fields: [])
params | Description |
---|---|
place_id | PLACE_ID |
fields | An array of Place fields |
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mohameddiaa27/facebook_places. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.