1.44
A long-lived project that still receives updates
A simple Ruby client for the algolia.com REST API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

~> 0
~> 0
~> 0

Runtime

~> 2.8, >= 2.8.3
>= 1.5.1
 Project Readme

Algolia for Ruby

The perfect starting point to integrate Algolia within your Ruby project

CircleCI Gem Version License

DocumentationRailsCommunity ForumStack OverflowReport a bugFAQSupport

✨ Features

  • Thin & minimal low-level HTTP client to interact with Algolia's API
  • Supports Ruby ^2.2.

💡 Getting Started

First, install Algolia Ruby API Client via the RubyGems package manager:

gem install algolia

Then, create objects on your index:

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:

objects = index.search('Foo')

For full documentation, visit the Algolia Ruby API Client.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ 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

📄 License

Algolia Ruby API Client is an open-sourced software licensed under the MIT license.