v0.25.0 💎

🚀 Enhancements

• [v1.3] Total Tasks in task route #463 (#464) @andre-m-dev
• Deprecate camelCase attributes usage (#470), (#377) @brunoocasali & @jkms

⚠️ This PR introduces warnings that will pop up in any request sent with a camel case attribute.
There is no clear path until this warning is triggered, but the idea is to drop the compatibility of camelCase attributes soon.
So, please make the change as soon as possible.

Warning example:

Attributes will be expected to be snake_case in future versions of Meilisearch Ruby.

Non-conforming attributes: distinctAttribute

💅 Misc

• Changes related to the next Meilisearch release (v1.3.0) (#452)
• Fix issue #456 (#469) @brunoocasali
• Add codecov (#471) @brunoocasali

Thanks again to @andre-m-dev, @brunoocasali and @jmks! 🎉

v0.24.0 💎

This version introduces features released on Meilisearch v1.2.0 🎉
Check out the changelog of Meilisearch v1.2.0 for more information on the changes.
⚠️ If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• The method delete_documents() now supports a different behavior. This method could take an options hash containing a filter: key/value object to filter the documents or a simple array or single value as usual.
  ⚠️ Still, even being supported, the ability to receive other types than a hash is deprecated and should be changed to a filter. Please use filter instead.
  #438 @brunoocasali

• When a query with a filter key is sent to get_documents(options = {}) it will filter the documents like the search method. This feature requires a Meilisearch server version greater than v1.2. See the docs on how to use filters. #439 @brunoocasali

Thanks again to @brunoocasali! 🎉

v0.23.0 💎

This version introduces features released on Meilisearch v1.1.0 🎉
Check out the changelog of Meilisearch v1.1.0 for more information on the changes.
If you want to adopt new features of this release, update the Meilisearch server to the according version.

🚀 Enhancements

• Add a new optional argument to add_documents_csv. This argument allows you to customize the separator character in your csv file. (#429) @brunoocasali.

• Add client.multi_search() method to execute multiple search requests simultaneously with different configurations. (#430) @brunoocasali
  Usage example:

  client.multi_search([
    { index_uid: 'books', q: 'prince' },
    { index_uid: 'movies', q: 'prince' },
  ])

  ⚠️ The SearchQuery was not meant to be used if the regular $index->search() requests (yet).

Thanks again to @brunoocasali! 🎉

v0.22.0 💎

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

⚠️ Breaking Changes

• Fails task when updating documents with a primary_key argument which already have a proper primary_key defined in the index (#410) @brunoocasali
• New error codes check the full changed list here

If you would like to discover every potential breaking change, please check the Meilisearch engine CHANGELOG.

Thanks again to @brunoocasali! 🎉

v0.21.1 💎

🚀 Enhancements

• Allow the latest httparty version because all lower ones have a vulnerability:
  GHSA-5pq7-52mg-hr42 (#414) @bb

Thanks again to @bb, @brunoocasali! 🎉

v0.21.0 💎

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

🚀 Enhancements

• Add MeilisearchClient#cancel_tasks (#392) @brunoocasali
• Add MeilisearchClient#swap_indexes (#393) @brunoocasali
• Add MeilisearchClient#delete_tasks (#394) @brunoocasali
• Add support to finite pagination by using page and hits_per_page like index.search('', { page: 1, hits_per_page: 10 })
• Add filters for tasks resources (#391) @brunoocasali
  • uids filter parameter for MeilisearchClient#get_tasks({ uids: [1, 2, 3] })
  • canceled_by filter parameter for MeilisearchClient#get_tasks({ canceled_by: [99, 100]})
  • before_enqueued_at and after_enqueued_at filter parameter for MeilisearchClient#get_tasks({ before_enqueued_at: DateTime.new(2022), after_enqueued_at: '2022-01-20' })
  • before_finished_at and after_finished_at filter parameter for MeilisearchClient#get_tasks({ before_finished_at: DateTime.new(2022), after_finished_at: '2022-01-20' })
  • before_started_at and after_started_at filter parameter for MeilisearchClient#get_tasks({ before_started_at: DateTime.new(2022), after_started_at: '2022-01-20' })

⚠️ Breaking Changes

• Update filters for tasks resources (#391) @brunoocasali
  • index_uid query parameter is renamed index_uids when querying MeilisearchClient#get_tasks
  • type query parameter is renamed types when querying MeilisearchClient#get_tasks
  • status query parameter is renamed statuses when querying MeilisearchClient#get_tasks

💅 Misc

• Fix broken CI after rubocop upgrade (#381) @jonatanrdsantos
• Add new code-samples for matching_strategy (#384) @thicolares
• Improve indexes names in tests (#385) @thicolares

Thanks again to @brunoocasali, @dibashthapa, @jonatanrdsantos, and @thicolares! 🎉

v0.20.0 💎

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

🚀 Enhancements

• Ensure support to the new search query parameter matchingStrategy (#364) @brunoocasali
• Ensure support to keys with wildcarded actions.
  • actions field during key creation now accepts wildcards on actions. For example, indexes.* provides rights to indexes.create, indexes.get,indexes.delete, indexes.delete, and indexes.update. (#365) @brunoocasali

⚠️ Breaking Changes

This breaking change may not affect you, but in any case, you should check your search queries if you want to keep the same behavior from v0.28.

• The NOT filter keyword does not have an implicitly EXIST operator anymore. Check out for more information: meilisearch/meilisearch#2486

v0.19.2 💎

🚀 Enhancements

• Add typo tolerance customization settings (#350) @voloyev
• Add faceting settings customization (#352) @voloyev
• Support custom agents (#354) @brunoocasali

Thanks again to @brunoocasali, and @voloyev! 🎉

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! 🎉