Merge branch 'main' into add-with-array-filter

Author: puddingpy

.code-samples.meilisearch.yaml

@@ -358,6 +358,28 @@ reset_displayed_attributes_1: |-
     .reset_displayed_attributes()
     .await
     .unwrap();
+get_faceting_settings_1: |-
+  let faceting: FacetingSettings = client
+    .index("books")
+    .get_faceting()
+    .await
+    .unwrap();
+update_faceting_settings_1: |-
+  let mut faceting = FacetingSettings {
+    max_values_per_facet: 2,
+  };
+
+  let task: TaskInfo = client
+    .index("books")
+    .set_faceting(&faceting)
+    .await
+    .unwrap();
+reset_faceting_settings_1: |-
+  let task: TaskInfo = client
+    .index("books")
+    .reset_faceting()
+    .await
+    .unwrap();
 get_index_stats_1: |-
   let stats: IndexStats = client
     .index("movies")
@@ -661,6 +683,18 @@ settings_guide_sortable_1: |-
     .set_settings(&settings)
     .await
     .unwrap();
+settings_guide_faceting_1: |-
+  let faceting = FacetingSettings {
+      max_values_per_facet: 5,
+  };
+  let settings = Settings::new()
+    .with_faceting(&faceting);
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_settings(&settings)
+    .await
+    .unwrap();
 add_movies_json_1: |-
   use meilisearch_sdk::{
     indexes::*,
@@ -987,6 +1021,16 @@ getting_started_sorting: |-
     .execute()
     .await
     .unwrap();
+getting_started_faceting: |-
+  let mut faceting = FacetingSettings {
+    max_values_per_facet: 2,
+  };
+
+  let task: TaskInfo = client
+    .index("movies")
+    .set_faceting(&faceting)
+    .await
+    .unwrap();
 getting_started_filtering: |-
   let results: SearchResults<Meteorite> = client
     .index("meteorites")

.github/workflows/tests.yml

@@ -44,6 +44,14 @@ jobs:
       # Will fail when encountering warnings
       run: cargo clippy -- -D warnings
 
+  formatter:
+    name: rust-format
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Run formatter
+      run: cargo fmt
+
   readme_check:
     name: readme-check
     runs-on: ubuntu-latest

CONTRIBUTING.md

@@ -16,7 +16,7 @@ It's [Hacktoberfest month](https://hacktoberfest.com)! 🥳
 
 Thanks so much for participating with Meilisearch this year!
 
-1. We will follow the quality standards set by the organizers of Hacktoberfest (see detail on their [website](https://hacktoberfest.digitalocean.com/resources/qualitystandards)). Our reviewers will not consider any PR that doesn’t match that standard.
+1. We will follow the quality standards set by the organizers of Hacktoberfest (see detail on their [website](https://hacktoberfest.com/participation/#spam)). Our reviewers will not consider any PR that doesn’t match that standard.
 2. PRs reviews will take place from Monday to Thursday, during usual working hours, CEST time. If you submit outside of these hours, there’s no need to panic; we will get around to your contribution.
 3. There will be no issue assignment as we don’t want people to ask to be assigned specific issues and never return, discouraging the volunteer contributors from opening a PR to fix this issue. We take the liberty to choose the PR that best fixes the issue, so we encourage you to get to it as soon as possible and do your best!
 

bors.toml

@@ -1,6 +1,7 @@
 status = [
     'integration-tests',
     'clippy-check',
+    'rust-format',
     'readme-check',
     'wasm-build'
 ]

src/dumps.rs

@@ -122,3 +122,4 @@ mod tests {
         Ok(())
     }
 }
+

src/indexes.rs

@@ -611,7 +611,13 @@ impl Index {
         } else {
             format!("{}/indexes/{}/documents", self.client.host, self.uid)
         };
-        request::<&[T], TaskInfo>(&url, &self.client.api_key, Method::Put(documents), 202).await
+        request::<&[T], TaskInfo>(
+            &url, 
+            &self.client.api_key, 
+            Method::Put(documents), 
+            202
+        )
+        .await
     }
 
     /// Delete all documents in the index.

src/settings.rs

@@ -7,6 +7,13 @@ use crate::{
 use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
 
+#[derive(Serialize, Deserialize, Default, Debug, Clone, Eq, PartialEq)]
+#[serde(rename_all = "camelCase")]
+pub struct FacetingSettings {
+    #[serde()]
+    pub max_values_per_facet: usize,
+}
+
 /// Struct reprensenting a set of settings.
 /// You can build this struct using the builder syntax.
 ///
@@ -58,6 +65,9 @@ pub struct Settings {
     /// Fields displayed in the returned documents
     #[serde(skip_serializing_if = "Option::is_none")]
     pub displayed_attributes: Option<Vec<String>>,
+    /// Faceting settings
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub faceting: Option<FacetingSettings>,
 }
 
 #[allow(missing_docs)]
@@ -73,6 +83,7 @@ impl Settings {
             distinct_attribute: None,
             searchable_attributes: None,
             displayed_attributes: None,
+            faceting: None,
         }
     }
     pub fn with_synonyms<S, U, V>(self, synonyms: HashMap<S, U>) -> Settings
@@ -193,6 +204,16 @@ impl Settings {
             ..self
         }
     }
+
+    pub fn with_faceting(
+        self,
+        faceting: &FacetingSettings,
+    ) -> Settings {
+        Settings {
+            faceting: Some(faceting.clone()),
+            ..self
+        }
+    }
 }
 
 impl Index {
@@ -454,6 +475,35 @@ impl Index {
         .await
     }
 
+    /// Get [faceting](https://docs.meilisearch.com/reference/api/settings.html#faceting) settings of the [Index].
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*};
+    /// #
+    /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// #
+    /// # futures::executor::block_on(async move {
+    /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
+    /// # client.create_index("get_faceting", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// let index = client.index("get_faceting");
+    /// let faceting = index.get_faceting().await.unwrap();
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn get_faceting(&self) -> Result<FacetingSettings, Error> {
+        request::<(), FacetingSettings>(
+            &format!(
+                "{}/indexes/{}/settings/faceting",
+                self.client.host, self.uid
+            ),
+            &self.client.api_key,
+            Method::Get(()),
+            200,
+        )
+        .await
+    }
+
     /// Update [settings](../settings/struct.Settings.html) of the [Index].
     /// Updates in the settings are partial. This means that any parameters corresponding to a `None` value will be left unchanged.
     ///
@@ -816,6 +866,45 @@ impl Index {
         .await
     }
 
+    /// Update [faceting](https://docs.meilisearch.com/reference/api/settings.html#faceting) settings of the [Index].
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings, settings::FacetingSettings};
+    /// #
+    /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// #
+    /// # futures::executor::block_on(async move {
+    /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
+    /// # client.create_index("set_faceting", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// let mut index = client.index("set_faceting");
+    ///
+    /// let mut faceting = FacetingSettings {
+    ///     max_values_per_facet: 12,
+    /// };
+    ///
+    /// let task = index.set_faceting(&faceting).await.unwrap();
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn set_faceting(
+        &self,
+        faceting: &FacetingSettings,
+    ) -> Result<TaskInfo, Error> {
+        request::<&FacetingSettings, TaskInfo>(
+            &format!(
+                "{}/indexes/{}/settings/faceting",
+                self.client.host, self.uid
+            ),
+            &self.client.api_key,
+            Method::Patch(faceting),
+            202,
+        )
+        .await
+    }
+
     /// Reset [Settings] of the [Index].
     /// All settings will be reset to their [default value](https://docs.meilisearch.com/reference/api/settings.html#reset-settings).
     ///
@@ -1102,4 +1191,98 @@ impl Index {
         )
         .await
     }
+
+    /// Reset [faceting](https://docs.meilisearch.com/reference/api/settings.html#faceting) settings of the [Index].
+    ///
+    /// # Example
+    ///
+    /// ```
+    /// # use meilisearch_sdk::{client::*, indexes::*, settings::Settings};
+    /// #
+    /// # let MEILISEARCH_HOST = option_env!("MEILISEARCH_HOST").unwrap_or("http://localhost:7700");
+    /// # let MEILISEARCH_API_KEY = option_env!("MEILISEARCH_API_KEY").unwrap_or("masterKey");
+    /// #
+    /// # futures::executor::block_on(async move {
+    /// let client = Client::new(MEILISEARCH_HOST, MEILISEARCH_API_KEY);
+    /// # client.create_index("reset_faceting", None).await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// let mut index = client.index("reset_faceting");
+    ///
+    /// let task = index.reset_faceting().await.unwrap();
+    /// # index.delete().await.unwrap().wait_for_completion(&client, None, None).await.unwrap();
+    /// # });
+    /// ```
+    pub async fn reset_faceting(&self) -> Result<TaskInfo, Error> {
+        request::<(), TaskInfo>(
+            &format!(
+                "{}/indexes/{}/settings/faceting",
+                self.client.host, self.uid
+            ),
+            &self.client.api_key,
+            Method::Delete,
+            202,
+        )
+        .await
+    }
+}
+
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    use crate::client::*;
+    use meilisearch_test_macro::meilisearch_test;
+
+    #[meilisearch_test]
+    async fn test_set_faceting_settings(client: Client, index: Index) {
+        let faceting = FacetingSettings {
+            max_values_per_facet: 5,
+        };
+        let settings = Settings::new()
+            .with_faceting(&faceting);
+
+        let task_info = index.set_settings(&settings).await.unwrap();
+        client.wait_for_task(task_info, None, None).await.unwrap();
+
+        let res = index.get_faceting().await.unwrap();
+
+        assert_eq!(faceting, res);
+    }
+
+    #[meilisearch_test]
+    async fn test_get_faceting(index: Index) {
+        let faceting = FacetingSettings {
+            max_values_per_facet: 100,
+        };
+
+        let res = index.get_faceting().await.unwrap();
+
+        assert_eq!(faceting, res);
+    }
+
+    #[meilisearch_test]
+    async fn test_set_faceting(client: Client, index: Index) {
+        let faceting = FacetingSettings {
+            max_values_per_facet: 5,
+        };
+        let task_info = index.set_faceting(&faceting).await.unwrap();
+        client.wait_for_task(task_info, None, None).await.unwrap();
+
+        let res = index.get_faceting().await.unwrap();
+
+        assert_eq!(faceting, res);
+    }
+
+    #[meilisearch_test]
+    async fn test_reset_faceting(client: Client, index: Index) {
+        let task_info = index.reset_faceting().await.unwrap();
+        client.wait_for_task(task_info, None, None).await.unwrap();
+        let faceting = FacetingSettings {
+            max_values_per_facet: 100,
+        };
+
+        let res = index.get_faceting().await.unwrap();
+
+        assert_eq!(faceting, res);
+    }
 }