v0.19.1 💎

⚠️ If possible, you should use this version if you want to make your code compatible with the pagy gem.

🐛 Bug Fixes

• Add nbHits to keep backward compatibility (#349) @brunoocasali

🚀 Enhancements

• Add methods related to pagination settings (#345) @Mcdostone

Thanks again to @Mcdostone, @brunoocasali! 🎉

v0.19.0 💎

This version makes this package compatible with Meilisearch v0.28.0 🎉
Check out the changelog of Meilisearch v0.28.0 for more information on the changes.

💥 Breaking Changes

• MeiliSearch::Client#keys now returns a hash with: (#340) @brunoocasali
  • results array
  • limit integer
  • offset integer
  • total integer
• MeiliSearch::Index#indexes, MeiliSearch::Client#raw_indexes now returns a hash with: (#342) @brunoocasali
  • results array
  • limit integer
  • offset integer
  • total integer
• MeiliSearch::Client#create_dump now responds with a Task object. (#335) @brunoocasali
• MeiliSearch::Client#get_dump_status was removed. Use the MeiliSearch::Client#tasks or MeiliSearch::Client#task instead. (#335) @brunoocasali
• MeiliSearch::Index#search: (#331) @curquiza
  • Renamed nbHits response parameter to estimatedTotalHits.
  • Deleted exhaustiveNbHits response parameter.
  • Deleted exhaustiveFacetsCount response parameter.
  • _matchesInfo response parameter is renamed _matchesPosition.
  • facetsDistribution response parameter is renamed facetDistribution.
  • facetsDistribution request parameter is renamed facets.
  • matches request parameter is renamed showMatchesPosition.
• MeiliSearch::Index#documents now returns an hash with: (#342) @brunoocasali
  • results array
  • limit integer
  • offset integer
  • total integer
• MeiliSearch::Index#tasks now returns a hash with: (#336), (#341) @brunoocasali
  • results array
  • limit integer
  • from integer
  • next integer
• add_documents, create_dump, update_settings and other methods that "creates" a new task, now responds with a taskUid instead of uid (#336), (#341) @brunoocasali
• MeiliSearch::Client#generate_tenant_token(uid, search_rules, api_key: api_key, expires_at: expires_at) now requires a api key uid to generate tenant tokens. (#340) @brunoocasali

🐛 Enhancements

• MeiliSearch::Client#indexes, MeiliSearch::Client#raw_indexes now accepts an hash with pagination limit, offset.
• MeiliSearch::Client#documents, now accepts an hash with pagination limit, offset. (#342) @brunoocasali
• MeiliSearch::Client#document, now accepts a named param called fields which takes an array of strings to remap the response. (#342) @brunoocasali
• MeiliSearch::Client#tasks, now accepts these filtering parameters: type, status and index_uid. Usage example: tasks(status: ['processing'], type: ['documentAdditionOrUpdate']). (#336), (#341) @brunoocasali
• MeiliSearch::Client#create_key, MeiliSearch::Client#delete_key, MeiliSearch::Client#update_key accepts both api key or api key uid. (#340) @brunoocasali
• MeiliSearch::Client#create_key can optionally specify a uid: to generate deterministic API keys. (#340) @brunoocasali
• MeiliSearch::Client#update_key only accepts description and name, other keys will be removed silently. (#340) @brunoocasali

Thanks again to @brunoocasali, @curquiza! 🎉

v0.18.3 💎

This version makes this package compatible with Meilisearch v0.27.0 🎉
Check out the changelog of Meilisearch v0.27.0 for more information on the changes.

🚀 Enhancements

• Ensure nested field support (#318) @brunoocasali
• Add highlightPreTag, highlightPostTag, cropMarker, parameters in the search request (#319) @brunoocasali
• Create a helper module to reduce test duplication (#316) @brunoocasali

🐛 Bug Fixes

• Improve error handling, rescue EPIPE and Net::* errors (#307) @brunoocasali

Thanks again to @brunoocasali! 🎉

v0.18.2 💎

This version makes this package compatible with MeiliSearch v0.25 up to v0.26.0 🎉
Check out the changelog of MeiliSearch v0.26.0 for more information about the ⚠️ breaking changes about the flag and dump new behavior.

🚀 Enhancements

• Added new method generate_tenant_token() as a result of the addition of the multi-tenant functionality.
  This method creates a JWT tenant token that will allow the user to have multi-tenant indexes and thus restrict access to documents based on the end-user making the search request. (#299) @brunoocasali

Thanks again to @brunoocasali! 🎉

v0.18.1 💎

🚀 Enhancements

• Simplify headers handling (#295) @brunoocasali
• Add User-Agent header to have analytics in every http request (#292) @brunoocasali

Analytics is enabled by default in the server, but you can disable them by following this guide
Also, of course, every analytics data we collect are ANONYMOUS read the guide for more information.

💅 Other improvements

Expand to see the list!

• Update rubocop requirement from ~> 1.24.1 to ~> 1.25.0 (#290) @dependabot

Thanks again to @brunoocasali, @curquiza 🎉

v0.18.0 💎

This package version is compatible with MeiliSearch v0.25.0 🎉

⚠️ Breaking changes

• This package is only compatible with MeiliSearch v0.25.0 and later, but not with v0.24.0 and older. Be sure you are using at least MeiliSearch v0.25.0 or newer before doing the upgrade.
  Why isn't it compatible?
  • MeiliSearch v0.25.0 uses Authorization header instead of X-Meili-API-Key (#275)
  • MeiliSearch v0.25.0 has a new API regarding the updates that have been renamed into tasks. More details in the following points
• Changes related to the new task API (#276) @curquiza Check out the task API references and the asynchronous tasks guide
  • create_index, update_index and delete_index are now asynchrone regarding MeiliSearch and do not return a Index instance anymore, but a task object. Please use index() method instead.
  • Rename index.get_all_update_status into index.tasks
  • Rename index.get_update_status into index.task
  • wait_for_pending_update is renamed into wait_for_task and is accessible from index and from client
• Remove get_or_create_index method (#277) @curquiza
• Remove delete_index_if_exists method (#278) @curquiza
• client.keys does not return an object of keys, but an array of keys. Check out keys API references.

🚀 Enhancements

• Add API keys methods (#279) @curquiza
  • client.create_key
  • client.update_key
  • client.delete_key
  • client.key

Check out the documentation guide.

• Add new method create_index! that creates an index synchronously regarding MeiliSearch. Be careful using it, this can block your code in production.
• Add new methods client.tasks and client.task

Thanks again to @curquiza, and @brunoocasali ! 🎉

v0.17.3 💎

🚀 Enhancements

• Add methods to add JSON, CSV and NDJSON document (#257) @thicolares

Thanks again to @bidoubiwa, @brunoocasali, @curquiza, and @thicolares! 🎉

v0.17.2 💎

This version is compatible with MeiliSearch v0.24.0

Breaking changes

• Change client#indexes method to retrieve a list of Index instance (#234) @nagaroni
• This package version is compatible with MeiliSearch v0.24.0 and later, but not with v0.23.1 and older. Be sure you are using at least MeiliSearch v0.24.0 or newer before doing the upgrade.

🚀 Enhancements

• Add delete_index_if_exists method (#232) @toshitapandey
• Added methods add_documents_in_batches, update_documents_in_batches and their tests (#224) @FlamesRunner
• Handle case when client returns a 500 error without a JSON response (#231) @rafaeelaudibert
• Add snake_case support for query parameters (#237) @brunoocasali
• Add updatedAt and createdAt to Index (#242) @bb
• Add method to get the raw index information (#249) @thicolares

🐛 Bug Fixes

• Fix snake_case issue in v0.17.0 by moving out params parsing of the HttpRequest class (#266) @brunoocasali
• Remove Content-Type from non-body HTTP methods (#253) @thicolares
• Add utils.rb to meilisearch.gemspec (#269) @curquiza

Thanks again to @AudTheCodeWitch, @FlamesRunner, @bb, @brunoocasali, @curquiza, @edinapap, @jmks, @meili-bors[bot], @nagaroni, @rafaeelaudibert, @reginaalyssa, @saintmalik, @thicolares, @toshitapandey and @zinovik! 🎉

v0.17.1 💎 [DEPRECATED]

Deprecated because of #268

v0.17.0 💎 [DEPRECATED]

⚠️ Do NOT use this version because of #265 ⚠️