databag/app/mobile/vendor/bundle/ruby/2.7.0/gems/algoliasearch-1.27.5
2023-02-15 12:24:17 -08:00
..
lib pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
resources pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
spec pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
.rspec pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
.travis.yml pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
algoliasearch.gemspec pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
CHANGELOG.md pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
contacts.json pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
Gemfile pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
Gemfile.lock pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
LICENSE pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
Rakefile pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00
README.md pod install wont work without the vendor folder....whytf?? 2023-02-15 12:24:17 -08:00

Algolia for Ruby

The perfect starting point to integrate Algolia within your Ruby project

Build Status Gem Version License

DocumentationRailsCommunity ForumStack OverflowReport a bugFAQSupport

Features

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

💡 Getting Started

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

gem install algoliasearch

Then, create objects on your index:

Algolia.init(application_id: 'YourApplicationID',
             api_key:        'YourAPIKey')
index = Algolia::Index.new('your_index_name')

index.save_objects([objectID:  1, name: 'Foo'])

Finally, you may begin searching a object using the search method:

objects = index.search('Fo')

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.

📄 License

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