An open API service indexing awesome lists of open source software.

https://github.com/satoryu/google_suggest

A gem which allows us to retrieve suggest words from Google in your Ruby Code.
https://github.com/satoryu/google_suggest

google-suggestions hacktoberfest ruby rubygem

Last synced: 6 months ago
JSON representation

A gem which allows us to retrieve suggest words from Google in your Ruby Code.

Awesome Lists containing this project

README

        

# GoogleSuggest

[![Gem Version](https://badge.fury.io/rb/google_suggest.svg)](https://badge.fury.io/rb/google_suggest)
[![CI](https://github.com/satoryu/google_suggest/workflows/CI/badge.svg)](https://github.com/satoryu/google_suggest/actions?query=workflow%3ACI)
[![Test Coverage](https://codeclimate.com/github/satoryu/google_suggest/badges/coverage.svg)](https://codeclimate.com/github/satoryu/google_suggest/coverage)

This gem allows you to access google suggest API in your ruby codes.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'google_suggest'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install google_suggest

## Usage

`GoogleSuggest.suggest_for` gives suggestions for a given keyword.

```ruby
GoogleSuggest.suggest_for 'google'
=> ["google", "google maps", "google translate", "google classroom", "google docs", "google drive", "google earth", "google play", "google scholar", "google slides"]
```

and allows developers to switch the endpoint by specifying `region` option:

```ruby
GoogleSuggest.suggest_for 'google', region: 'jp'
=> ["google", "google maps", "google drive", "google translate", "google scholar", "google docs", "google flights", "google news", "google play", "google earth"]
```

You can get all available region codes by `GoogleSuggest::Region.codes`.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/satoryu/google_suggest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).