gfas-api 0.9.15

//! This crate exports some GitHub API bindings through [`GitHub`].

use std::collections::HashSet;
use std::ops::{Deref, DerefMut};

use octorust::Client;
use octorust::auth::Credentials;

type Result<T> = std::result::Result<T, octorust::ClientError>;

/// Asynchronous GitHub API bindings that wraps [`octorust::Client`] internally.
///
/// # Examples
///
/// ```rust
/// use gfas_api::GitHub;
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let github = GitHub::new(String::from("<TOKEN>"))?;
/// # Ok(())
/// # }
/// ```
#[derive(Clone)]
#[repr(transparent)]
pub struct GitHub(Client);

impl Deref for GitHub {
	type Target = Client;

	fn deref(&self) -> &Self::Target { &self.0 }
}

impl DerefMut for GitHub {
	fn deref_mut(&mut self) -> &mut Self::Target { &mut self.0 }
}

impl GitHub {
	const USER_AGENT: &'static str = "gfas";

	/// Create a new GitHub API client.
	#[allow(clippy::result_large_err)]
	pub fn new(token: String) -> Result<Self> {
		Ok(Self(Client::new(Self::USER_AGENT, Credentials::Token(token))?))
	}

	/// List all followings of given user.
	///
	/// # Errors
	///
	/// Fails if an error occurs during sending requests.
	pub async fn list_followings(&self, user: &str) -> Result<HashSet<String>> {
		Ok(
			self
				.users()
				.list_all_following_for_user(user)
				.await?
				.body
				.into_iter()
				.map(|u| u.login)
				.collect()
		)
	}

	/// List all followings of given user.
	///
	/// # Errors
	///
	/// Fails if an error occurs during sending requests.
	pub async fn list_followers(&self, user: &str) -> Result<HashSet<String>> {
		Ok(
			self
				.users()
				.list_all_followers_for_user(user)
				.await?
				.body
				.into_iter()
				.map(|u| u.login)
				.collect()
		)
	}
}