Merge branch 'main' into dependabot/cargo/yew-0.20

Author: bidoubiwa

.code-samples.meilisearch.yaml

@@ -4,7 +4,7 @@
 current_tag=$(echo $GITHUB_REF | cut -d '/' -f 3 | sed -r 's/^v//')
 major=$(echo $current_tag | cut -d '.' -f1)
 minor=$(echo $current_tag | cut -d '.' -f2)
-cropped_current_tag="$major.$minor"
+
 file1='Cargo.toml'
 file2='README.tpl'
 file3='.code-samples.meilisearch.yaml'
@@ -21,15 +21,15 @@ file_tag5=$(grep '^version = ' $file5 | grep -Eo '[0-9]+.[0-9]+.[0-9]+')
 if [ "$current_tag" != "$file_tag1" ] ||
   [ "$current_tag" != "$file_tag_1_1" ] ||
   [ "$current_tag" != "$file_tag2" ] ||
-  [ "$cropped_current_tag" != "$file_tag3" ] ||
+  [ "$current_tag" != "$file_tag3" ] ||
   [ "$current_tag" != "$file_tag4" ] ||
   [ "$current_tag" != "$file_tag5" ] \
   ; then
   echo "Error: the current tag does not match the version in package file(s)."
   echo "$file1: found $file_tag1 - expected $current_tag"
   echo "$file1: found $file_tag_1_1 - expected $current_tag"
   echo "$file2: found $file_tag2 - expected $current_tag"
-  echo "$file3: found $file_tag3 - expected $cropped_current_tag"
+  echo "$file3: found $file_tag3 - expected $current_tag"
   echo "$file4: found $file_tag4 - expected $current_tag"
   echo "$file5: found $file_tag5 - expected $current_tag"
   exit 1

.github/scripts/check-release.sh

@@ -12,8 +12,8 @@ First of all, thank you for contributing to Meilisearch! The goal of this docume
 ## Assumptions
 
 1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.**
-2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).**
-3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.**
+2. **You've read the Meilisearch [documentation](https://www.meilisearch.com/docs) and the [README](/README.md).**
+3. **You know about the [Meilisearch community](https://discord.com/invite/meilisearch). Please use this for help.**
 
 ## How to Contribute
 
@@ -175,30 +175,31 @@ Make a PR modifying the file [`Cargo.toml`](/Cargo.toml):
 version = "X.X.X"
 ```
 
-After the changes on `Cargo.toml`, run the following command: 
+the [`README.tpl`](/README.tpl):
 
-```
-sh scripts/update_macro_versions.sh
+```rust
+//! meilisearch-sdk = "X.X.X"
 ```
 
-and the [`README.tpl`](/README.tpl):
+and the [code-samples file](/.code-samples.meilisearch.yaml):
 
-```rust
-//! meilisearch-sdk = "X.X.X"
+```yml
+  meilisearch-sdk = "X.X.X"
 ```
 
 with the right version.
 
-After the changes on `lib.rs`, run the following command:
 
-```bash
-sh scripts/update-readme.sh
+After the changes on `Cargo.toml`, run the following command: 
+
+```
+sh scripts/update_macro_versions.sh
 ```
 
-You might need to change the [code-samples file](/.code-samples.meilisearch.yaml) if the minor has been upgraded:
+After the changes on `lib.rs`, run the following command:
 
-```yml
-  meilisearch-sdk = "X.X"
+```bash
+sh scripts/update-readme.sh
 ```
 
 Once the changes are merged on `main`, you can publish the current draft release via the [GitHub interface](https://github.com/meilisearch/meilisearch-rust/releases): on this page, click on `Edit` (related to the draft release) > update the description (be sure you apply [these recommendations](https://github.com/meilisearch/integration-guides/blob/main/resources/integration-release.md#writting-the-release-description)) > when you are ready, click on `Publish release`.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 [package]
 name = "meilisearch-sdk"
-version = "0.22.0"
+version = "0.24.1"
 authors = ["Mubelotix <[email protected]>"]
 edition = "2018"
 description = "Rust wrapper for the Meilisearch API. Meilisearch is a powerful, fast, open-source, easy to use and deploy search engine."
@@ -13,7 +13,7 @@ members = ["examples/*"]
 
 [dependencies]
 async-trait = "0.1.51"
-iso8601-duration = "0.1.0"
+iso8601 = "0.6.1"
 log = "0.4"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
@@ -22,7 +22,7 @@ jsonwebtoken = { version = "8", default-features = false }
 yaup = "0.2.0"
 either = { version = "1.8.0", features = ["serde"] }
 thiserror = "1.0.37"
-meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.22.0" }
+meilisearch-index-setting-macro = { path = "meilisearch-index-setting-macro", version = "0.24.1" }
 
 
 [target.'cfg(not(target_arch = "wasm32"))'.dependencies]
@@ -40,6 +40,7 @@ wasm-bindgen-futures = "0.4"
 [features]
 default = ["isahc-static-curl"]
 isahc-static-curl = ["isahc/static-curl"]
+isahc-static-ssl = ["isahc/static-ssl"]
 
 [dev-dependencies]
 env_logger = "0.10"

Cargo.toml

@@ -10,19 +10,19 @@
 
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
-  <a href="https://docs.meilisearch.com">Documentation</a> |
+  <a href="https://www.meilisearch.com/docs">Documentation</a> |
   <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
-  <a href="https://docs.meilisearch.com/faq">FAQ</a>
+  <a href="https://www.meilisearch.com/docs/faq">FAQ</a>
 </h4>
 
 <p align="center">
   <a href="https://crates.io/crates/meilisearch-sdk"><img src="https://img.shields.io/crates/v/meilisearch-sdk.svg" alt="crates.io"></a>
   <a href="https://github.com/meilisearch/meilisearch-rust/actions"><img src="https://github.com/meilisearch/meilisearch-rust/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
   <a href="https://github.com/meilisearch/meilisearch-rust/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
   <a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
-  <a href="https://app.bors.tech/repositories/28502"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://ms-bors.herokuapp.com/repositories/62"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
 <p align="center">⚡ The Meilisearch API client written for Rust 🦀</p>
@@ -44,15 +44,15 @@
 
 This readme contains all the documentation you need to start using this Meilisearch SDK.
 
-For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
+For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).
 
 ## 🔧 Installation
 
 To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.22.0"
+meilisearch-sdk = "0.24.1"
 ```
 
 The following optional dependencies may also be useful:
@@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu
 
 This crate requires a Meilisearch server to run.
 
-There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
 
 For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
 
@@ -104,7 +104,7 @@ struct Movie {
 
 fn main() { block_on(async move {
     // Create a client (without sending any request so that can't fail)
-    let client = Client::new(MEILISEARCH_URL, MEILISEARCH_API_KEY);
+    let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY));
 
     // An index is where the documents are stored.
     let movies = client.index("movies");
@@ -121,7 +121,7 @@ fn main() { block_on(async move {
 })}
 ```
 
-With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://docs.meilisearch.com/reference/api/tasks.html#get-task).
+With the `uid`, you can check the status (`enqueued`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
 
 #### Basic Search <!-- omit in TOC -->
 
@@ -199,7 +199,7 @@ client.index("movies_4").set_filterable_attributes(&filterable_attributes).await
 
 You only need to perform this operation once.
 
-Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://docs.meilisearch.com/reference/api/tasks.html#get-task)).
+Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
 
 Then, you can perform the search:
 

README.md

@@ -10,19 +10,19 @@
 
 <h4 align="center">
   <a href="https://github.com/meilisearch/meilisearch">Meilisearch</a> |
-  <a href="https://docs.meilisearch.com">Documentation</a> |
+  <a href="https://www.meilisearch.com/docs">Documentation</a> |
   <a href="https://discord.meilisearch.com">Discord</a> |
   <a href="https://roadmap.meilisearch.com/tabs/1-under-consideration">Roadmap</a> |
   <a href="https://www.meilisearch.com">Website</a> |
-  <a href="https://docs.meilisearch.com/faq">FAQ</a>
+  <a href="https://www.meilisearch.com/docs/faq">FAQ</a>
 </h4>
 
 <p align="center">
   <a href="https://crates.io/crates/meilisearch-sdk"><img src="https://img.shields.io/crates/v/meilisearch-sdk.svg" alt="crates.io"></a>
   <a href="https://github.com/meilisearch/meilisearch-rust/actions"><img src="https://github.com/meilisearch/meilisearch-rust/workflows/Tests/badge.svg?branch=main" alt="Tests"></a>
   <a href="https://github.com/meilisearch/meilisearch-rust/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
   <a href="https://github.com/meilisearch/meilisearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
-  <a href="https://app.bors.tech/repositories/28502"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
+  <a href="https://ms-bors.herokuapp.com/repositories/62"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
 </p>
 
 <p align="center">⚡ The Meilisearch API client written for Rust 🦀</p>
@@ -44,15 +44,15 @@
 
 This readme contains all the documentation you need to start using this Meilisearch SDK.
 
-For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://docs.meilisearch.com/).
+For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).
 
 ## 🔧 Installation
 
 To use `meilisearch-sdk`, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-meilisearch-sdk = "0.22.0"
+meilisearch-sdk = "0.24.1"
 ```
 
 The following optional dependencies may also be useful:
@@ -71,7 +71,7 @@ Using this crate is possible without [serde](https://crates.io/crates/serde), bu
 
 This crate requires a Meilisearch server to run.
 
-There are many easy ways to [download and run a Meilisearch instance](https://docs.meilisearch.com/reference/features/installation.html#download-and-launch).
+There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
 
 For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
 

README.tpl

@@ -7,7 +7,7 @@ use std::io::stdin;
 
 // instantiate the client. load it once
 lazy_static! {
-    static ref CLIENT: Client = Client::new("http://localhost:7700", "masterKey");
+    static ref CLIENT: Client = Client::new("http://localhost:7700", Some("masterKey"));
 }
 
 fn main() {
@@ -67,13 +67,13 @@ async fn build_index() {
     // serialize the string to clothes objects
     let clothes: Vec<Clothes> = serde_json::from_str(content).unwrap();
 
-    //create displayed attributes
+    // create displayed attributes
     let displayed_attributes = ["article", "cost", "size", "pattern"];
 
     // Create ranking rules
     let ranking_rules = ["words", "typo", "attribute", "exactness", "cost:asc"];
 
-    //create searchable attributes
+    // create searchable attributes
     let searchable_attributes = ["seaon", "article", "size", "pattern"];
 
     // create the synonyms hashmap
@@ -82,14 +82,14 @@ async fn build_index() {
     synonyms.insert("sweat pants", vec!["joggers", "gym pants"]);
     synonyms.insert("t-shirt", vec!["tees", "tshirt"]);
 
-    //create the settings struct
+    // create the settings struct
     let settings = Settings::new()
         .with_ranking_rules(ranking_rules)
         .with_searchable_attributes(searchable_attributes)
         .with_displayed_attributes(displayed_attributes)
         .with_synonyms(synonyms);
 
-    //add the settings to the index
+    // add the settings to the index
     let result = CLIENT
         .index("clothes")
         .set_settings(&settings)

examples/cli-app/src/main.rs

@@ -5,7 +5,7 @@ use meilisearch_sdk::settings::Settings;
 // we need an async runtime
 #[tokio::main(flavor = "current_thread")]
 async fn main() {
-    let client: Client = Client::new("http://localhost:7700", "masterKey");
+    let client: Client = Client::new("http://localhost:7700", Some("masterKey"));
 
     // We try to create an index called `movies` with a primary_key of `movie_id`.
     let my_index: Index = client
@@ -23,7 +23,7 @@ async fn main() {
         .expect("An error happened with the index creation.");
 
     // And now we can update the settings!
-    // You can read more about the available options here: https://docs.meilisearch.com/learn/configuration/settings.html#index-settings
+    // You can read more about the available options here: https://www.meilisearch.com/docs/learn/configuration/settings#index-settings
     let settings: Settings = Settings::new()
         .with_searchable_attributes(["name", "title"])
         .with_filterable_attributes(["created_at"]);
@@ -39,12 +39,11 @@ async fn main() {
         .expect("Could not join the remote server.");
 
     // We check if the task failed.
-    if task.is_failure() {
-        panic!(
-            "Could not update the settings. {}",
-            task.unwrap_failure().error_message
-        );
-    }
+    assert!(
+        !task.is_failure(),
+        "Could not update the settings. {}",
+        task.unwrap_failure().error_message
+    );
 
     // And finally we delete the `Index`.
     my_index
@@ -56,10 +55,9 @@ async fn main() {
         .expect("Could not join the remote server.");
 
     // We check if the task failed.
-    if task.is_failure() {
-        panic!(
-            "Could not delete the index. {}",
-            task.unwrap_failure().error_message
-        );
-    }
+    assert!(
+        !task.is_failure(),
+        "Could not delete the index. {}",
+        task.unwrap_failure().error_message
+    );
 }

examples/settings.rs

@@ -12,7 +12,7 @@ crate-type = ["cdylib", "rlib"]
 serde_json = "1.0"
 wasm-bindgen = "0.2"
 wasm-bindgen-futures = "0.4.18"
-yew = "0.20"
+yew = {version="0.20", features = ["csr"]}
 meilisearch-sdk = {path="../.."}
 lazy_static = "1.4"
 serde = {version="1.0", features=["derive"]}

examples/web_app/Cargo.toml

@@ -1,7 +1,7 @@
 # Build your front-end page in Rust with WebAssembly
 
 > **Note**
-> It is not possible to run Meilisearch in the browser without a server. This demo uses the Rust SDK in a browser using WASM, and communicate with a Meilisearch instance that is running on a remote server.
+> It is not possible to run Meilisearch in the browser without a server. This demo uses the Rust SDK in a browser using WASM, and communicates with a Meilisearch instance that is running on a remote server.
 
 This example is a clone of [crates.meilisearch.com](https://crates.meilisearch.com), but the front-end is written in Rust!
 The Rust source files are compiled into WebAssembly and so can be readable by the browsers.

examples/web_app/README.md

@@ -13,7 +13,6 @@ pub struct Crate {
     version: String,
 }
 
-// Implement the Document trait so that we can use our struct with Meilisearch
 fn get_readable_download_count(this: &Map<String, Value>) -> String {
     if let Some(downloads) = this["downloads"].as_f64() {
         if downloads < 1000.0 {
@@ -37,22 +36,22 @@ pub fn display(this: &Map<String, Value>) -> Html {
     url = url.replace("</em>", "");
 
     html! {
-        <li><a href=url>
+        <li><a href={url}>
             <div class="h">
                 <h4>
                     {
                         // This field is formatted so we don't want Yew to escape the HTML tags
-                        unescaped_html(&this["name"].as_str().unwrap_or_default())
+                        unescaped_html(this["name"].as_str().unwrap_or_default())
                     }
                 </h4>
-                <p class="desc">{unescaped_html(&this["description"].as_str().unwrap_or_default())}</p>
+                <p class="desc">{unescaped_html(this["description"].as_str().unwrap_or_default())}</p>
             </div>
             <div class="meta">
                 <span class="version stable">
                     <span>{"v"}</span>
                     {&this["version"].as_str().unwrap_or_default()}
                 </span>
-                <span class="downloads" title=format!("{} recent downloads", this["downloads"].as_f64().unwrap_or(0.0))>
+                <span class="downloads" title={format!("{} recent downloads", this["downloads"].as_f64().unwrap_or(0.0))}>
                     {get_readable_download_count(this)}
                 </span>
                 {for this["keywords"].as_array().unwrap().iter().map(|keyword|