2021-01-09 03:36:14 +00:00
|
|
|
//! API bindings for ListenBrainz.
|
|
|
|
|
|
|
|
use serde::de::DeserializeOwned;
|
2021-01-10 18:30:03 +00:00
|
|
|
use serde::Serialize;
|
2021-01-10 16:59:15 +00:00
|
|
|
|
2021-01-09 03:36:14 +00:00
|
|
|
use ureq::Agent;
|
|
|
|
|
2021-01-10 18:22:50 +00:00
|
|
|
mod endpoint;
|
2021-01-10 18:30:03 +00:00
|
|
|
mod error;
|
2021-01-09 03:36:14 +00:00
|
|
|
pub mod models;
|
|
|
|
|
2021-01-10 18:22:50 +00:00
|
|
|
use endpoint::Endpoint;
|
2021-01-10 18:30:03 +00:00
|
|
|
pub use error::Error;
|
2021-01-09 03:36:14 +00:00
|
|
|
use models::request::*;
|
|
|
|
use models::response::*;
|
|
|
|
|
|
|
|
const API_ROOT_URL: &str = "https://api.listenbrainz.org/1/";
|
|
|
|
|
|
|
|
/// Low-level client that more-or-less directly wraps the ListenBrainz HTTP API.
|
|
|
|
///
|
|
|
|
/// Client exposes functions that map one-to-one to the API methods described
|
|
|
|
/// in the [ListenBrainz API docs](https://listenbrainz.readthedocs.io/en/production/dev/api/).
|
|
|
|
pub struct Client {
|
|
|
|
agent: Agent,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Client {
|
|
|
|
/// Construct a new client.
|
|
|
|
pub fn new() -> Self {
|
|
|
|
Self {
|
|
|
|
agent: ureq::agent(),
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-01-10 16:59:15 +00:00
|
|
|
fn get<R: DeserializeOwned>(&mut self, endpoint: Endpoint) -> Result<R, Error> {
|
2021-01-09 03:36:14 +00:00
|
|
|
let endpoint = format!("{}{}", API_ROOT_URL, endpoint);
|
|
|
|
|
2021-01-10 16:59:15 +00:00
|
|
|
self.agent
|
|
|
|
.get(&endpoint)
|
|
|
|
.call()?
|
2021-01-09 03:36:14 +00:00
|
|
|
.into_json()
|
|
|
|
.map_err(Error::ResponseJson)
|
|
|
|
}
|
|
|
|
|
|
|
|
fn post<D, R>(&mut self, endpoint: Endpoint, token: &str, data: D) -> Result<R, Error>
|
|
|
|
where
|
|
|
|
D: Serialize,
|
|
|
|
R: DeserializeOwned,
|
|
|
|
{
|
|
|
|
let data = serde_json::to_value(data).map_err(Error::RequestJson)?;
|
|
|
|
|
|
|
|
let endpoint = format!("{}{}", API_ROOT_URL, endpoint);
|
|
|
|
|
2021-01-10 16:59:15 +00:00
|
|
|
self.agent
|
|
|
|
.post(&endpoint)
|
2021-01-09 03:36:14 +00:00
|
|
|
.set("Authorization", &format!("Token {}", token))
|
|
|
|
.send_json(data)?
|
|
|
|
.into_json()
|
|
|
|
.map_err(Error::ResponseJson)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Endpoint: `submit-listens`
|
2021-01-10 16:59:15 +00:00
|
|
|
pub fn submit_listens(
|
|
|
|
&mut self,
|
|
|
|
token: &str,
|
|
|
|
data: SubmitListens,
|
|
|
|
) -> Result<SubmitListensResponse, Error> {
|
2021-01-09 03:36:14 +00:00
|
|
|
self.post(Endpoint::SubmitListens, token, data)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Endpoint: `validate-token`
|
|
|
|
pub fn validate_token(&mut self, token: &str) -> Result<ValidateTokenResponse, Error> {
|
2021-01-10 16:59:15 +00:00
|
|
|
let endpoint = format!("{}{}", API_ROOT_URL, Endpoint::ValidateToken);
|
|
|
|
|
|
|
|
self.agent
|
|
|
|
.get(&endpoint)
|
|
|
|
.query("token", token)
|
|
|
|
.call()?
|
|
|
|
.into_json()
|
|
|
|
.map_err(Error::ResponseJson)
|
2021-01-09 03:36:14 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Endpoint: `delete-listen`
|
2021-01-10 16:59:15 +00:00
|
|
|
pub fn delete_listen(
|
|
|
|
&mut self,
|
|
|
|
token: &str,
|
|
|
|
data: DeleteListen,
|
|
|
|
) -> Result<DeleteListenResponse, Error> {
|
2021-01-09 03:36:14 +00:00
|
|
|
self.post(Endpoint::DeleteListen, token, data)
|
|
|
|
}
|
|
|
|
|
2021-01-10 16:59:15 +00:00
|
|
|
/// Endpoint: `users/{user_list}/recent-listens
|
|
|
|
pub fn users_recent_listens(
|
|
|
|
&mut self,
|
|
|
|
user_list: &[&str],
|
|
|
|
) -> Result<UsersRecentListensResponse, Error> {
|
|
|
|
self.get(Endpoint::UsersRecentListens(user_list))
|
|
|
|
}
|
|
|
|
|
2021-01-09 03:36:14 +00:00
|
|
|
/// Endpoint: `user/{user_name}/listen-count`
|
2021-01-10 16:59:15 +00:00
|
|
|
pub fn user_listen_count(&mut self, user_name: &str) -> Result<UserListenCountResponse, Error> {
|
|
|
|
self.get(Endpoint::UserListenCount(user_name))
|
2021-01-09 03:36:14 +00:00
|
|
|
}
|
|
|
|
|
2021-01-10 16:59:15 +00:00
|
|
|
// UserPlayingNow(&'a str),
|
|
|
|
/// Endpoint: `user/{user_name}/playing-now`
|
|
|
|
pub fn user_playing_now(&mut self, user_name: &str) -> Result<UserPlayingNowResponse, Error> {
|
|
|
|
self.get(Endpoint::UserPlayingNow(user_name))
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn user_listens(
|
|
|
|
&mut self,
|
|
|
|
user_name: &str,
|
|
|
|
min_ts: Option<i64>,
|
|
|
|
max_ts: Option<i64>,
|
|
|
|
count: Option<u32>,
|
|
|
|
time_range: Option<u64>
|
|
|
|
) -> Result<UserListensResponse, Error> {
|
|
|
|
let endpoint = format!("{}{}", API_ROOT_URL, Endpoint::UserListens(user_name));
|
|
|
|
|
|
|
|
let mut request = self.agent.get(&endpoint);
|
|
|
|
|
|
|
|
if let Some(min_ts) = min_ts {
|
|
|
|
request = request.query("min_ts", &min_ts.to_string());
|
|
|
|
}
|
|
|
|
if let Some(max_ts) = max_ts {
|
|
|
|
request = request.query("max_ts", &max_ts.to_string());
|
|
|
|
}
|
|
|
|
if let Some(count) = count {
|
|
|
|
request = request.query("count", &count.to_string());
|
|
|
|
}
|
|
|
|
if let Some(time_range) = time_range {
|
|
|
|
request = request.query("time_range", &time_range.to_string());
|
|
|
|
}
|
|
|
|
|
|
|
|
request.call()?.into_json().map_err(Error::ResponseJson)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Endpoint: `latest-import` (GET)
|
|
|
|
pub fn get_latest_import(&mut self, user_name: &str) -> Result<GetLatestImportResponse, Error> {
|
|
|
|
let endpoint = format!("{}{}", API_ROOT_URL, Endpoint::LatestImport);
|
|
|
|
|
|
|
|
self.agent
|
|
|
|
.get(&endpoint)
|
|
|
|
.query("user_name", user_name)
|
|
|
|
.call()?
|
|
|
|
.into_json()
|
|
|
|
.map_err(Error::ResponseJson)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Endpoint: `latest-import` (POST)
|
|
|
|
pub fn update_latest_import(
|
|
|
|
&mut self,
|
|
|
|
token: &str,
|
|
|
|
data: UpdateLatestImport,
|
|
|
|
) -> Result<UpdateLatestImportResponse, Error> {
|
|
|
|
self.post(Endpoint::LatestImport, token, data)
|
|
|
|
}
|
|
|
|
|
|
|
|
// StatsSitewideArtists,
|
|
|
|
// StatsUserListeningActivity(&'a str),
|
|
|
|
// StatsUserDailyActivity(&'a str),
|
|
|
|
// StatsUserRecordings(&'a str),
|
|
|
|
// StatsUserArtistMap(&'a str),
|
|
|
|
// StatsUserReleases(&'a str),
|
|
|
|
// StatsUserArtists(&'a str),
|
|
|
|
|
2021-01-09 03:36:14 +00:00
|
|
|
/// Endpoint: `status/get-dump-info`
|
2021-01-10 16:59:15 +00:00
|
|
|
pub fn status_get_dump_info(
|
|
|
|
&mut self,
|
|
|
|
id: Option<i64>,
|
|
|
|
) -> Result<StatusGetDumpInfoResponse, Error> {
|
|
|
|
let endpoint = format!("{}{}", API_ROOT_URL, Endpoint::StatusGetDumpInfo);
|
|
|
|
|
|
|
|
let mut request = self.agent.get(&endpoint);
|
|
|
|
|
2021-01-09 03:36:14 +00:00
|
|
|
if let Some(id) = id {
|
2021-01-10 16:59:15 +00:00
|
|
|
request = request.query("id", &id.to_string());
|
2021-01-09 03:36:14 +00:00
|
|
|
}
|
2021-01-10 16:59:15 +00:00
|
|
|
|
|
|
|
request.call()?.into_json().map_err(Error::ResponseJson)
|
2021-01-09 03:36:14 +00:00
|
|
|
}
|
|
|
|
}
|