Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/algoliasearch-client-ruby
⚡️ A fully-featured and blazing-fast Ruby API client to interact with Algolia.
https://github.com/algolia/algoliasearch-client-ruby
algolia gem ruby search
Last synced: about 1 month ago
JSON representation
⚡️ A fully-featured and blazing-fast Ruby API client to interact with Algolia.
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-client-ruby
- Owner: algolia
- License: mit
- Created: 2013-05-24T20:07:36.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T12:12:41.000Z (8 months ago)
- Last Synced: 2024-04-10T17:32:44.082Z (8 months ago)
- Topics: algolia, gem, ruby, search
- Language: Ruby
- Homepage: https://www.algolia.com/doc/api-client/getting-started/install/ruby/?language=ruby
- Size: 2.88 MB
- Stars: 169
- Watchers: 85
- Forks: 68
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-blazingly-fast - algoliasearch-client-ruby - ⚡️ A fully-featured and blazing-fast Ruby API client to interact with Algolia. (Ruby)
README
The perfect starting point to integrate Algolia within your Ruby project
Documentation •
Rails •
Community Forum •
Stack Overflow •
Report a bug •
FAQ •
Support
## ✨ Features
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Supports Ruby `^2.4`.
## 💡 Getting Started
First, install Algolia Ruby API Client via the [RubyGems](https://rubygems.org/) package manager:
```bash
gem install algolia
```
Then, create objects on your index:
```ruby
client = Algolia::Search::Client.create('YourApplicationID', 'YourAPIKey')
index = client.init_index('your_index_name')
index.save_objects([{objectID: 1, name: 'Foo'}])
```
Finally, you may begin searching a object using the `search` method:
```ruby
objects = index.search('Foo')
```
For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/api-client/getting-started/install/ruby/)**.
## ❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/ruby/) where you will find answers for the most common issues and gotchas with the client.
## Upgrade from V1 to V2
If you were using the v1 and wish to update to v2, please follow our [Upgrade Guide](upgrade_guide.md)
## 📄 License
Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE.md).