1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
pub mod auth;
pub mod comments;
pub mod error;
pub mod message;
pub mod responses;
pub mod submission;
pub mod subreddit;
pub mod user;
pub mod utils;
use log::trace;
use std::fmt::Write;
use std::fmt::{Debug, Formatter};
use reqwest::header::HeaderMap;
use reqwest::{Body, Client as ReqwestClient, ClientBuilder, Response};
use serde::de::DeserializeOwned;
use submission::response::SubmissionsResponse;
use crate::auth::{Authenticator, Authorized};
use crate::error::http_error::IntoResult;
use crate::error::internal_error::InternalError;
use crate::error::Error;
use crate::subreddit::response::{SubredditResponse, Subreddits};
use crate::subreddit::Subreddit;
use crate::user::me::Me;
use crate::user::response::{MeResponse, UserResponse, Users};
use crate::user::User;
use crate::utils::options::FeedOption;
macro_rules! get_auth {
($se:ident) => {{
#[cfg(not(feature = "shared_authentication"))]
let auth = $se.get_authenticator();
#[cfg(feature = "shared_authentication")]
let auth = $se.get_authenticator().await;
if auth.needs_token_refresh() {
trace!("Token Expired.");
#[cfg(not(feature = "shared_authentication"))]
{
return Err(Error::TokenExpired);
}
#[cfg(feature = "shared_authentication")]
{
trace!("Refreshing Token");
drop(auth);
$se.re_login().await?;
$se.get_authenticator().await
}
} else {
auth
}
}};
}
/// This is who you are. This is your identity and you access point to the Reddit API
#[derive(Clone)]
pub struct Client<A: Authenticator> {
#[cfg(feature = "shared_authentication")]
#[cfg(not(target_arch = "wasm32"))]
auth: std::sync::Arc<tokio::sync::RwLock<A>>,
#[cfg(not(feature = "shared_authentication"))]
auth: A,
client: ReqwestClient,
user_agent: String,
refresh_token: Option<String>,
pub oauth: bool,
}
impl<A: Authenticator> Client<A> {
/// Creates a Instance of the Client. Complete Initial Login Steps
#[cfg(not(target_arch = "wasm32"))]
#[cfg(feature = "shared_authentication")]
pub async fn login<S: Into<String>>(mut auth: A, user_agent: S) -> Result<Client<A>, Error> {
let user_agent = user_agent.into();
let client = ClientBuilder::new()
.user_agent(user_agent.clone())
.build()?;
let b = auth.oauth();
let _x = auth.login(&client, &user_agent).await?;
let r_t = auth.get_refresh_token();
Ok(Client {
auth: std::sync::Arc::new(tokio::sync::RwLock::new(auth)),
client,
user_agent,
oauth: b,
refresh_token: r_t,
})
}
#[cfg(not(target_arch = "wasm32"))]
#[cfg(not(feature = "shared_authentication"))]
pub async fn login<S: Into<String>>(mut auth: A, user_agent: S) -> Result<Client<A>, Error> {
let user_agent = user_agent.into();
let client = ClientBuilder::new()
.user_agent(user_agent.clone())
.build()?;
let b = auth.oauth();
let r_t = auth.get_refresh_token();
auth.login(&client, &user_agent).await?;
Ok(Client {
auth,
client,
user_agent,
oauth: b,
refresh_token: r_t,
})
}
/// Loads a Domain listing
/// ```rust
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use log::LevelFilter;
/// use rraw::auth::AnonymousAuthenticator;
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(AnonymousAuthenticator::new(), "RRAW Test (by u/KingTuxWH)").await?;
/// let subreddit = client.domain("rust-lang.org",None);
/// Ok(())
/// }
/// ```
pub async fn domain<T: Into<String>>(
&self,
name: T,
feed_options: Option<FeedOption>,
) -> Result<SubmissionsResponse, Error> {
let mut path = format!("/domain/{}.json", name.into());
if let Some(options) = feed_options {
options.extend(&mut path)
}
return self
.get_json::<SubmissionsResponse>(&path, false, true)
.await;
}
/// Loads SubReddit
/// ```rust
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use log::LevelFilter;
/// use rraw::auth::AnonymousAuthenticator;
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(AnonymousAuthenticator::new(), "RRAW Test (by u/KingTuxWH)").await?;
/// let subreddit = client.subreddit("rust");
/// Ok(())
/// }
/// ```
pub async fn subreddit<T: Into<String>>(&self, name: T) -> Result<Subreddit<'_, A>, Error> {
let string = format!("/r/{}/about.json", name.into());
let subreddit = self
.get_json::<SubredditResponse>(&string, false, false)
.await?;
Ok(Subreddit {
me: self,
subreddit: subreddit.data,
})
}
/// Creates a User struct.
/// ```rust
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use log::LevelFilter;
/// use rraw::auth::AnonymousAuthenticator;
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(AnonymousAuthenticator::new(), "RRAW Test (by u/KingTuxWH)").await?;
/// let subreddit = client.user("KingTuxWH").await?;
/// Ok(())
/// }
/// ```
pub async fn user<T: Into<String>>(&self, name: T) -> Result<User<'_, A>, Error> {
let string = format!("/u/{}/about", name.into());
let user = self.get_json::<UserResponse>(&string, false, false).await?;
Ok(User {
me: self,
user: user.data,
})
}
/// Searches for Subreddits by name
/// ```rust
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use log::LevelFilter;
/// use rraw::auth::AnonymousAuthenticator;
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(AnonymousAuthenticator::new(), "RRAW Test (by u/KingTuxWH)").await?;
/// let subreddits = client.search_subreddits("rust", None, None).await?;
/// Ok(())
/// }
/// ```
pub async fn search_subreddits<S: Into<String>>(
&self,
name: S,
limit: Option<u64>,
feed: Option<FeedOption>,
) -> crate::error::Result<Subreddits> {
let mut url = format!("/subreddits/search?q={}", name.into());
if let Some(options) = feed {
url.push_str(options.url().as_str());
}
if let Some(limit) = limit {
let _ = write!(url, "&limit={}", limit);
}
self.get_json::<Subreddits>(&url, false, false).await
}
/// Searches for Subreddits by name
/// ```rust
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use log::LevelFilter;
/// use rraw::auth::AnonymousAuthenticator;
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(AnonymousAuthenticator::new(), "RRAW Test (by u/KingTuxWH)").await?;
/// let users = client.search_users("King", None, None).await?;
/// Ok(())
/// }
/// ```
pub async fn search_users<S: Into<String>>(
&self,
name: S,
limit: Option<u64>,
feed: Option<FeedOption>,
) -> crate::error::Result<Users> {
let mut url = format!("/users/search?raw_json=1&q={}", name.into());
if let Some(options) = feed {
url.push_str(options.url().as_str());
}
if let Some(limit) = limit {
let _ = write!(url, "&limit={}", limit);
}
self.get_json::<Users>(&url, false, false).await
}
#[cfg(not(feature = "shared_authentication"))]
pub async fn re_login(&mut self) -> Result<bool, error::Error> {
self.auth
.token_refresh(&self.client, &self.user_agent)
.await
}
#[cfg(feature = "shared_authentication")]
pub async fn re_login(&self) -> Result<bool, error::Error> {
let mut guard = self.auth.write().await;
guard.token_refresh(&self.client, &self.user_agent).await
}
}
impl<A: Authenticator> Client<A> {
/// Gets the authenticator. Internal use
#[cfg(feature = "shared_authentication")]
pub(crate) async fn get_authenticator(&self) -> tokio::sync::RwLockReadGuard<'_, A> {
self.auth.read().await
}
#[cfg(not(feature = "shared_authentication"))]
pub(crate) fn get_authenticator(&self) -> &A {
&self.auth
}
pub(crate) async fn get(
&self,
url: &str,
oauth: bool,
private_api: bool,
) -> Result<Response, Error> {
let authenticator = get_auth!(self);
let string = self.build_url(url, oauth, authenticator.oauth(), private_api);
let mut headers = HeaderMap::new();
authenticator.headers(&mut headers);
#[cfg(feature = "shared_authentication")]
drop(authenticator);
self.client
.get(string)
.headers(headers)
.send()
.await
.map_err(|error| Error::InternalError(InternalError::ReqwestError(error)))
}
/// Makes a post request with Reqwest response
pub(crate) async fn post(&self, url: &str, oauth: bool, body: Body) -> Result<Response, Error> {
let authenticator = get_auth!(self);
let string = self.build_url(url, oauth, authenticator.oauth(), false);
let mut headers = HeaderMap::new();
authenticator.headers(&mut headers);
#[cfg(feature = "shared_authentication")]
drop(authenticator);
self.client
.post(string)
.body(body)
.headers(headers)
.send()
.await
.map_err(Error::from)
}
/// Makes a get request with JSON response
pub(crate) async fn get_json<T: DeserializeOwned>(
&self,
url: &str,
oauth: bool,
private_api: bool,
) -> crate::error::Result<T> {
let response = self.get(url, oauth, private_api).await?;
response.status().into_result()?;
response
.json()
.await
.map_err(|error| Error::InternalError(InternalError::ReqwestError(error)))
}
/// Makes a post request with JSON response
pub(crate) async fn post_json<T: DeserializeOwned>(
&self,
url: &str,
oauth: bool,
body: Body,
) -> crate::error::Result<T> {
let response = self.post(url, oauth, body).await?;
response.status().into_result()?;
response
.json()
.await
.map_err(|error| Error::InternalError(InternalError::ReqwestError(error)))
}
pub(crate) fn build_url(
&self,
dest: &str,
oauth_required: bool,
oauth_supported: bool,
private_api: bool,
) -> String {
let stem = if private_api {
"https://reddit.com"
} else if oauth_required || oauth_supported {
// All endpoints support OAuth, but some do not support the regular endpoint. If we are
// required to use it or support it, we will use it.
assert!(
oauth_supported,
"OAuth is required to use this endpoint, but your authenticator does not \
support it."
);
"https://oauth.reddit.com"
} else {
"https://api.reddit.com"
};
format!("{stem}{dest}")
}
}
impl<A: Authorized> Client<A> {
/// Gets the User Inbox Struct
/// ```no_run
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use std::env;
/// use log::LevelFilter;
/// use rraw::auth::{ PasswordAuthenticator};
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(PasswordAuthenticator::new(env::var("CLIENT_ID")?,env::var("CLIENT_SECRET")?,env::var("USERNAME")?,env::var("PASSWORD")?), "RRAW Test (by u/KingTuxWH)").await?;
/// let me = client.me().await?;
/// Ok(())
/// }
/// ```
pub async fn me(&self) -> Result<Me<'_, A>, Error> {
let me: MeResponse = self.get_json("/api/v1/me", true, false).await?;
Ok(Me { client: self, me })
}
/// Gets the Refresh Token if exist
///
/// Note: Refresh Token only will be exist when using CodeAuthenticator with an Permanent Duration Authorization Code.
/// The Refresh Token must be stored in a secure manner such as using the platform's Secret/Keyring service for future use.
/// ```no_run
/// #[tokio::main]
/// async fn main() ->anyhow::Result<()>{
/// use std::env;
/// use log::LevelFilter;
/// use rraw::auth::{ CodeAuthenticator};
/// use rraw::Client;
/// env_logger::builder().is_test(true).filter_level(LevelFilter::Trace).try_init();
/// let client = Client:: login(CodeAuthenticator::new(env::var("CLIENT_ID")?,env::var("CLIENT_SECRET")?,env::var("CODE")?,env::var("REDIRECT_URI")?), "RRAW Test (by u/KingTuxWH)").await?;
/// let refresh_token = client.refresh_token();
/// if refresh_token.is_some() {
/// println!("Refresh Token Is: {}", refresh_token.unwrap());
/// } else {
/// println!("Refresh Token Not Exist!");
/// }
/// Ok(())
/// }
/// ```
pub fn refresh_token(&self) -> Option<String> {
self.refresh_token.to_owned()
}
}
impl<A: Authenticator> Debug for Client<A> {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Reddit Client UserAgent: {}. Auth: {:?}",
self.user_agent, self.auth
)
}
}