feat: put client behind a feature gate

fix: some client API arguments
fix: `all` test

Author: yusdacra

Cargo.toml

@@ -9,18 +9,20 @@ license = "MIT"
 prost = "0.6"
 prost-types = "0.6"
 tonic = "0.3"
-log = "0.4"
-http = "0.2"
-assign = "1.1"
-paste = "1.0"
+log = { version = "0.4", optional = true }
+http = { version = "0.2", optional = true }
+assign = { version = "1.1", optional = true }
+paste = { version = "1.0", optional = true }
 parking_lot = { version = "0.11", optional = true }
-futures = "0.3"
+futures = { version = "0.3", optional = true }
 
 [build-dependencies]
 tonic-build = "0.3"
 
 [features]
-deafult = [ ]
+default = [ "client" ]
+client = [ "futures", "paste", "assign", "http", "log" ]
+
 use_parking_lot = [ "parking_lot" ]
 
 [dev-dependencies]
@@ -29,3 +31,4 @@ env_logger = "0.8"
 
 [[example]]
 name = "echo_bot"
+required-features = [ "client" ]

README.md

@@ -21,3 +21,4 @@ Rust implementation of [the Harmony chat protocol](https://github.com/harmony-de
 
 ## Crate features
 - Enable the `use_parking_lot` feature if you want to use [parking_lot](https://github.com/Amanieu/parking_lot) `sync` types instead of `std::sync`.
+- Enable the `client` feature for a lightweight client implementation and the client API. Enabled by default.

examples/echo_bot.rs

@@ -23,15 +23,9 @@ async fn main() -> ClientResult<()> {
     log::info!("Successfully created client.");
 
     // We try to login, if it fails we register (which also authenticates)
-    if let Err(_) = client.login(EMAIL.to_string(), PASSWORD.to_string()).await {
+    if let Err(_) = client.login(EMAIL, PASSWORD).await {
         log::info!("Login failed, let's try registering.");
-        client
-            .register(
-                EMAIL.to_string(),
-                USERNAME.to_string(),
-                PASSWORD.to_string(),
-            )
-            .await?;
+        client.register(EMAIL, USERNAME, PASSWORD).await?;
         log::info!("Successfully registered.");
     } else {
         log::info!("Successfully logon.");

src/client/api/core.rs

@@ -221,8 +221,8 @@ client_api! {
     args {
         guild_id: u64 => guild_id: (|g| g);
         channel_id: u64 => channel_id: (|g| g);
-        previous_channel_id: u64 => previous_id: (|p| p);
-        next_channel_id: u64 => next_id: (|n| n);
+        previous_channel_id: Option<u64> => previous_id: Option::unwrap_or_default;
+        next_channel_id: Option<u64> => next_id: Option::unwrap_or_default;
     }
 }
 
@@ -454,7 +454,7 @@ client_api! {
         guild_id: u64 => guild_id: (|g| g);
         channel_id: u64 => channel_id: (|g| g);
         role_id: u64 => role_id: (|g| g);
-        permissions: Option<PermissionList> => perms: (|p| p);
+        permissions: PermissionList => perms: Some;
     }
 }
 
@@ -518,8 +518,8 @@ client_api_action! {
     args {
         guild_id: u64 => guild_id: (|g| g);
         role_id: u64 => role_id: (|g| g);
-        before_role_id: u64 => before_id: (|g| g);
-        after_role_id: u64 => after_id: (|g| g);
+        before_role_id: Option<u64> => before_id: Option::unwrap_or_default;
+        after_role_id: Option<u64> => after_id: Option::unwrap_or_default;
     }
 }
 

src/client/error.rs

@@ -1,4 +1,4 @@
-pub use tonic::{transport::Error as TransportError, Status};
+pub use tonic::{transport::Error as TransportError, Code, Status};
 
 /// Result type used by many `Client` methods.
 pub type ClientResult<T> = Result<T, ClientError>;

src/client/mod.rs

@@ -13,12 +13,12 @@
 //!
 //!     // Login:
 //!     let session = client
-//!         .login("[email protected]".to_string(), "password".to_string())
+//!         .login("[email protected]", "password")
 //!         .await?;
 //!
 //!     // Or register:
 //!     let session = client
-//!         .register("[email protected]".to_string(), "example".to_string(), "password".to_string())
+//!         .register("[email protected]", "example", "password")
 //!         .await?;
 //!
 //!     // You're now logged in / registered!
@@ -51,12 +51,16 @@
 //! You can also use the API methods in the [`api`] module
 //! (note that you *won't* be able to store a [`Session`] that you got from these APIs inside a [`Client`]):
 //! ```no_run
-//! use harmony_rust_sdk::client::{Client, Session, api::foundation::login};
+//! use harmony_rust_sdk::client::{Client, Session, api::core::create_guild};
 //!
 //! let work = async {
 //!     let homeserver_url = "https://example.org".parse().unwrap();
 //!     let client = Client::new(homeserver_url, None).await?;
-//!     let session = login(&client, "[email protected]".to_string(), "password".to_string()).await?;
+//!
+//!     // Auth here
+//!
+//!     // Create a guild and get the guild_id from the response
+//!     let created_guild_id = create_guild(&client, String::from("Example Guild"), None).await?.guild_id;
 //!
 //!     // make more API calls
 //! # harmony_rust_sdk::client::ClientResult::Ok(())
@@ -195,8 +199,8 @@ impl Client {
     }
 
     /// Send a [`api::foundation::login`] request to the server and store the returned session.
-    pub async fn login(&self, email: String, password: String) -> ClientResult<()> {
-        let session = api::foundation::login(self, email, password).await?;
+    pub async fn login(&self, email: impl ToString, password: impl ToString) -> ClientResult<()> {
+        let session = api::foundation::login(self, email.to_string(), password.to_string()).await?;
         *self.session_lock() = Some(session);
 
         Ok(())
@@ -205,11 +209,17 @@ impl Client {
     /// Send a [`api::foundation::register`] request to the server and store the returned session.
     pub async fn register(
         &self,
-        email: String,
-        username: String,
-        password: String,
+        email: impl ToString,
+        username: impl ToString,
+        password: impl ToString,
     ) -> ClientResult<()> {
-        let session = api::foundation::register(self, email, username, password).await?;
+        let session = api::foundation::register(
+            self,
+            email.to_string(),
+            username.to_string(),
+            password.to_string(),
+        )
+        .await?;
         *self.session_lock() = Some(session);
 
         Ok(())

src/lib.rs

@@ -13,10 +13,5 @@ pub mod api {
     }
 }
 
-/// Exports of some deps used in this crate's public API.
-pub mod exports {
-    pub use futures;
-    pub use http;
-}
-
+#[cfg(feature = "client")]
 pub mod client;

tests/all.rs

@@ -1,25 +1,21 @@
-use harmony_rust_sdk::{client::Client, exports::http::Uri};
+use harmony_rust_sdk::client::{Client, ClientResult};
+
+const EMAIL: &str = "[email protected]";
+const USERNAME: &str = "example";
+const PASSWORD: &str = "123456789";
 
 // Make sure legato is running on `http://127.0.0.1:2289` before running this test.
 #[tokio::test]
-async fn all() {
+async fn all() -> ClientResult<()> {
     env_logger::builder().is_test(true).init();
 
-    let email = String::from("[email protected]");
-    let username = String::from("example");
-    let password = String::from("123456789");
-
-    let client = Client::new("http://127.0.0.1".parse::<Uri>().unwrap(), None)
-        .await
-        .unwrap();
-
-    let response = client.login(email.clone(), password.clone()).await;
+    let client = Client::new("http://127.0.0.1".parse().unwrap(), None).await?;
 
-    log::info!("{:?}", response);
+    if client.login(EMAIL, PASSWORD).await.is_err() {
+        client.register(EMAIL, USERNAME, PASSWORD).await?;
+    }
 
-    let response = client
-        .register(email.clone(), username.clone(), password.clone())
-        .await;
+    // TODO: do more API calls
 
-    log::info!("{:?}", response);
+    Ok(())
 }