Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/outscraper/outscraper-ruby
The library provides convenient access to the Outscraper API from applications written in the Ruby language. Allows using Outscraper's services from your code.
https://github.com/outscraper/outscraper-ruby
google-maps-api google-rating-api google-reviews-api google-scraping google-serp-api ruby scraping scraping-websites serp-api
Last synced: 27 days ago
JSON representation
The library provides convenient access to the Outscraper API from applications written in the Ruby language. Allows using Outscraper's services from your code.
- Host: GitHub
- URL: https://github.com/outscraper/outscraper-ruby
- Owner: outscraper
- License: mit
- Created: 2022-07-16T13:11:53.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-03T15:58:47.000Z (9 months ago)
- Last Synced: 2024-08-08T15:38:23.309Z (5 months ago)
- Topics: google-maps-api, google-rating-api, google-reviews-api, google-scraping, google-serp-api, ruby, scraping, scraping-websites, serp-api
- Language: Ruby
- Homepage:
- Size: 34.2 KB
- Stars: 2
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Outscraper Ruby Library
The library provides convenient access to the [Outscraper API](https://app.outscraper.com/api-docs) from applications written in the Ruby language. Allows using [Outscraper's services](https://outscraper.com/services/) from your code.
## Installation
Install the gem and add to the application's Gemfile by executing:
```bash
bundle add outscraper
```
If bundler is not being used to manage dependencies, install the gem by executing:
```bash
gem install outscraper
```
[Link to the Ruby package page](https://rubygems.org/gems/outscraper)
## Initialization
```ruby
require 'Outscraper'
client = Outscraper::Client.new('SECRET_API_KEY')
```
[Link to the profile page to create the API key](https://app.outscraper.com/profile)
## Usage
```ruby
# Search for businesses in specific locations:
results = client.google_maps_search('restaurants brooklyn usa', limit: 20, language: 'en', region: 'us')
# Get data of the specific place by id
results = client.google_maps_search('ChIJrc9T9fpYwokRdvjYRHT8nI4', language: 'en')
# Get reviews of the specific place by id
results = client.google_maps_reviews('ChIJrc9T9fpYwokRdvjYRHT8nI4', reviews_limit: 20, language: 'en')
# Search contacts from website
results = client.emails_and_contacts('outscraper.com')
```
[More examples](https://github.com/outscraper/outscraper-ruby/tree/master/examples)
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/outscraper/outscraper-ruby.