examples/ssb-friends.rs

@@ -0,0 +1,86 @@
+use async_std::stream::StreamExt;
+use futures::pin_mut;
+use std::process;
+
+use golgi::error::GolgiError;
+use golgi::messages::SsbMessageContent;
+use golgi::sbot::Sbot;
+use golgi::sbot::{FriendsHops, RelationshipQuery, SubsetQuery, SubsetQueryOptions};
+
+async fn run() -> Result<(), GolgiError> {
+    let mut sbot_client = Sbot::init(None, None).await?;
+
+    let id = sbot_client.whoami().await?;
+    println!("whoami: {}", id);
+
+    // test ids to follow and block
+    let to_follow = String::from("@5Pt3dKy2HTJ0mWuS78oIiklIX0gBz6BTfEnXsbvke9c=.ed25519");
+    let to_block = String::from("@7Y4nwfQmVtAilEzi5knXdS2gilW7cGKSHXdXoT086LM=.ed25519");
+
+    // follow to_follow
+    let response = sbot_client
+        .set_relationship(&to_follow, true, false)
+        .await?;
+    println!("follow_response: {:?}", response);
+
+    // block to_block
+    let response = sbot_client.set_relationship(&to_block, false, true).await?;
+    println!("follow_response: {:?}", response);
+
+    // print all users you are following
+    let follows = sbot_client
+        .friends_hops(FriendsHops {
+            max: 1,
+            start: None,
+            // doesnt seem like reverse does anything, currently
+            reverse: Some(false),
+        })
+        .await?;
+    println!("follows: {:?}", follows);
+
+    // print if you are following to_follow (should be true)
+    let mref = sbot_client
+        .friends_is_following(RelationshipQuery {
+            source: id.clone(),
+            dest: to_follow.clone(),
+        })
+        .await?;
+    println!("isfollowingmref: {}", mref);
+
+    // print if you are blocking to_block (should be true)
+    let mref = sbot_client
+        .friends_is_blocking(RelationshipQuery {
+            source: id.clone(),
+            dest: to_block.clone(),
+        })
+        .await?;
+    println!("isblockingmref: {}", mref);
+
+    // print if you are blocking to_follow (should be false)
+    let mref = sbot_client
+        .friends_is_blocking(RelationshipQuery {
+            source: id.clone(),
+            dest: to_follow,
+        })
+        .await?;
+    println!("isblockingmref(should be false): {}", mref);
+
+    // print if you are following to_block (should be false)
+    let mref = sbot_client
+        .friends_is_following(RelationshipQuery {
+            source: id,
+            dest: to_block.clone(),
+        })
+        .await?;
+    println!("isfollowingmref(should be false): {}", mref);
+
+    Ok(())
+}
+
+#[async_std::main]
+async fn main() {
+    if let Err(e) = run().await {
+        eprintln!("Application error: {}", e);
+        process::exit(1);
+    }
+}

git_hooks/pre-commit

@@ -0,0 +1 @@
+cargo fmt

src/sbot.rs

@@ -1,10 +1,10 @@
 //! Sbot type and associated methods.
-use std::collections::HashMap;
 use async_std::{
     net::TcpStream,
     stream::{Stream, StreamExt},
 };
 use futures::pin_mut;
+use std::collections::HashMap;
 
 use kuska_handshake::async_std::BoxStream;
 use kuska_sodiumoxide::crypto::{auth, sign::ed25519};
@@ -21,7 +21,9 @@ use crate::utils;
 use crate::utils::get_source_stream;
 
 // re-export types from kuska
-pub use kuska_ssb::api::dto::content::{SubsetQuery, SubsetQueryOptions};
+pub use kuska_ssb::api::dto::content::{
+    FriendsHops, RelationshipQuery, SubsetQuery, SubsetQueryOptions,
+};
 
 /// A struct representing a connection with a running sbot.
 /// A client and an rpc_reader can together be used to make requests to the sbot
@@ -39,7 +41,7 @@ pub struct Sbot {
     private_key: ed25519::SecretKey,
     address: String,
     // aka caps key (scuttleverse identifier)
-    network_id: auth::Key
+    network_id: auth::Key,
 }
 
 impl Sbot {
@@ -68,7 +70,7 @@ impl Sbot {
             public_key: pk,
             private_key: sk,
             address,
-            network_id
+            network_id,
         })
     }
 
@@ -136,8 +138,12 @@ impl Sbot {
             .client
             .getsubset_req_send(query, options)
             .await?;
-        let get_subset_stream =
-            get_source_stream(sbot_connection.rpc_reader, req_id, utils::ssb_message_res_parse).await;
+        let get_subset_stream = get_source_stream(
+            sbot_connection.rpc_reader,
+            req_id,
+            utils::ssb_message_res_parse,
+        )
+        .await;
         Ok(get_subset_stream)
     }
 
@@ -180,6 +186,111 @@ impl Sbot {
         .await
     }
 
+    // Convenience method to set a relationship with following: true, blocking: false
+    pub async fn follow(&mut self, contact: &str) -> Result<String, GolgiError> {
+        self.set_relationship(contact, true, false).await
+    }
+
+    // Convenience method to set a relationship with following: false, blocking: true
+    pub async fn block(&mut self, contact: &str) -> Result<String, GolgiError> {
+        self.set_relationship(contact, false, true).await
+    }
+
+    /// Publishes a contact relationship to the given user (with ssb_id) with the given state.
+    pub async fn set_relationship(
+        &mut self,
+        contact: &str,
+        following: bool,
+        blocking: bool,
+    ) -> Result<String, GolgiError> {
+        let msg = SsbMessageContent::Contact {
+            contact: Some(contact.to_string()),
+            following: Some(following),
+            blocking: Some(blocking),
+            autofollow: None,
+        };
+        self.publish(msg).await
+    }
+
+    /// Call the `friends isFollowing` RPC method and return a message reference.
+    /// Returns true if src_id is following dest_id and false otherwise.
+    pub async fn friends_is_following(
+        &mut self,
+        args: RelationshipQuery,
+    ) -> Result<String, GolgiError> {
+        let mut sbot_connection = self.get_sbot_connection().await?;
+        let req_id = sbot_connection
+            .client
+            .friends_is_following_req_send(args)
+            .await?;
+
+        utils::get_async(
+            &mut sbot_connection.rpc_reader,
+            req_id,
+            utils::string_res_parse,
+        )
+        .await
+    }
+
+    /// Call the `friends isblocking` RPC method and return a message reference.
+    /// Returns true if src_id is blocking dest_id and false otherwise.
+    pub async fn friends_is_blocking(
+        &mut self,
+        args: RelationshipQuery,
+    ) -> Result<String, GolgiError> {
+        let mut sbot_connection = self.get_sbot_connection().await?;
+        let req_id = sbot_connection
+            .client
+            .friends_is_blocking_req_send(args)
+            .await?;
+
+        utils::get_async(
+            &mut sbot_connection.rpc_reader,
+            req_id,
+            utils::string_res_parse,
+        )
+        .await
+    }
+
+    // Gets a Vec<String> where each element is a peer you are following
+    pub async fn get_follows(&mut self) -> Result<Vec<String>, GolgiError> {
+        self.friends_hops(FriendsHops {
+            max: 1,
+            start: None,
+            reverse: Some(false),
+        })
+        .await
+    }
+
+    // Gets a Vec<String> where each element is a peer who follows you
+    /// TODO: currently this  method is not working
+    /// go-sbot does not seem to listen to the reverse=True parameter
+    /// and just returns follows
+    async fn get_followers(&mut self) -> Result<Vec<String>, GolgiError> {
+        self.friends_hops(FriendsHops {
+            max: 1,
+            start: None,
+            reverse: Some(true),
+        })
+        .await
+    }
+
+    /// Call the `friends hops` RPC method and return a Vector<String>
+    /// where each element of the vector is the ssb_id of a peer.
+    ///
+    /// When opts.reverse = True, it should return peers who are following you
+    /// (but this is currently not working)
+    pub async fn friends_hops(&mut self, args: FriendsHops) -> Result<Vec<String>, GolgiError> {
+        let mut sbot_connection = self.get_sbot_connection().await?;
+        let req_id = sbot_connection.client.friends_hops_req_send(args).await?;
+        utils::get_source_until_eof(
+            &mut sbot_connection.rpc_reader,
+            req_id,
+            utils::string_res_parse,
+        )
+        .await
+    }
+
     /// Wrapper for publish which constructs and publishes a post message appropriately from a string.
     ///
     /// # Arguments
@@ -252,9 +363,7 @@ impl Sbot {
         // and remove this filter section
         // filter down to about  messages
         let about_message_stream = get_subset_stream.filter(|msg| match msg {
-            Ok(val) => {
-                val.is_message_type(SsbMessageContentType::About)
-            }
+            Ok(val) => val.is_message_type(SsbMessageContentType::About),
             Err(_err) => false,
         });
         // return about message stream
@@ -272,13 +381,14 @@ impl Sbot {
         // now we have a stream of about messages with most recent at the front of the vector
         pin_mut!(about_message_stream);
         // iterate through the vector looking for most recent about message with the given key
-        let latest_about_message_res: Option<Result<SsbMessageValue, GolgiError>> = about_message_stream
-            // find the first msg that contains the field `key`
-            .find(|res| match res {
-                Ok(msg) => msg.content.get(key).is_some(),
-                Err(_) => false,
-            })
-            .await;
+        let latest_about_message_res: Option<Result<SsbMessageValue, GolgiError>> =
+            about_message_stream
+                // find the first msg that contains the field `key`
+                .find(|res| match res {
+                    Ok(msg) => msg.content.get(key).is_some(),
+                    Err(_) => false,
+                })
+                .await;
         // Option<Result<SsbMessageValue, GolgiError>> -> Option<SsbMessageValue>
         let latest_about_message = latest_about_message_res.and_then(|msg| msg.ok());
         // Option<SsbMessageValue> -> Option<String>
@@ -297,14 +407,20 @@ impl Sbot {
     }
 
     /// Get HashMap of profile info for given user
-    pub async fn get_profile_info(&mut self, ssb_id: &str) -> Result<HashMap<String, String>, GolgiError> {
+    pub async fn get_profile_info(
+        &mut self,
+        ssb_id: &str,
+    ) -> Result<HashMap<String, String>, GolgiError> {
         let mut keys_to_search_for = vec!["name", "description", "image"];
         self.get_about_info(ssb_id, keys_to_search_for).await
     }
 
     /// Get HashMap of name and image for given user
     /// (this is can be used to display profile images of a list of users)
-    pub async fn get_name_and_image(&mut self, ssb_id: &str) -> Result<HashMap<String, String>, GolgiError> {
+    pub async fn get_name_and_image(
+        &mut self,
+        ssb_id: &str,
+    ) -> Result<HashMap<String, String>, GolgiError> {
         let mut keys_to_search_for = vec!["name", "image"];
         self.get_about_info(ssb_id, keys_to_search_for).await
     }
@@ -323,7 +439,7 @@ impl Sbot {
     pub async fn get_about_info(
         &mut self,
         ssb_id: &str,
-        mut keys_to_search_for: Vec<&str>
+        mut keys_to_search_for: Vec<&str>,
     ) -> Result<HashMap<String, String>, GolgiError> {
         // get about_message_stream
         let about_message_stream = self.get_about_message_stream(ssb_id).await?;
@@ -335,7 +451,7 @@ impl Sbot {
         while let Some(res) = about_message_stream.next().await {
             // if there are no more keys we are looking for, then we are done
             if keys_to_search_for.len() == 0 {
-                break
+                break;
             }
             // if there are still keys we are looking for, then continue searching
             match res {
@@ -343,7 +459,9 @@ impl Sbot {
                     // for each key we are searching for, check if this about
                     // message contains a value for that key
                     for key in &keys_to_search_for.clone() {
-                        let option_val = msg.content.get(key)
+                        let option_val = msg
+                            .content
+                            .get(key)
                             .and_then(|val| val.as_str())
                             .map(|val| val.to_string());
                         match option_val {
@@ -353,15 +471,13 @@ impl Sbot {
                                 // remove this key fom keys_to_search_for, since we are no longer searching for it
                                 keys_to_search_for.retain(|val| val != key)
                             }
-                            None => {
-                                continue
-                            }
+                            None => continue,
                         }
                     }
                 }
                 Err(err) => {
                     // skip errors
-                    continue
+                    continue;
                 }
             }
         }