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: 18 days 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 (almost 12 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:35:09.000Z (6 months ago)
- Last Synced: 2024-10-29T13:25:22.830Z (6 months ago)
- Topics: algolia, gem, ruby, search
- Language: Ruby
- Homepage: https://www.algolia.com/doc/api-client/getting-started/install/ruby/?language=ruby
- Size: 3.68 MB
- Stars: 167
- Watchers: 83
- Forks: 72
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
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
## 💡 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::SearchClient.create('YourApplicationID', 'YourAPIKey')client.save_object('your_index_name', {objectID: 1, name: 'Foo'})
```Finally, you may begin searching a object using the `search` method:
```ruby
objects = client.search_single_index('your_index_name', 'Foo')
```For full documentation, visit the **[Algolia Ruby API Client](https://www.algolia.com/doc/libraries/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. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
## Contributing
This repository hosts the code of the generated Algolia API client for Ruby, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
## 📄 License
The Algolia Ruby API Client is an open-sourced software licensed under the [MIT license](LICENSE).