torrust-index 3.0.0

A BitTorrent Index
Documentation 
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

//! Action that a user can perform on a Index website.
use thiserror::Error;
use tracing::debug;

use crate::web::api::client::v1::client::Client;
use crate::web::api::client::v1::contexts::category::forms::AddCategoryForm;
use crate::web::api::client::v1::contexts::category::responses::{ListItem, ListResponse};
use crate::web::api::client::v1::contexts::torrent::forms::UploadTorrentMultipartForm;
use crate::web::api::client::v1::contexts::torrent::responses::{UploadedTorrent, UploadedTorrentResponse};
use crate::web::api::client::v1::contexts::user::forms::LoginForm;
use crate::web::api::client::v1::contexts::user::responses::{LoggedInUserData, SuccessfulLoginResponse};
use crate::web::api::client::v1::responses::TextResponse;

#[derive(Error, Debug)]
pub enum Error {
    #[error("Torrent with the same info-hash already exist in the database")]
    TorrentInfoHashAlreadyExists,
    #[error("Torrent with the same title already exist in the database")]
    TorrentTitleAlreadyExists,
}

/// It uploads a torrent file to the Torrust Index.
///
/// # Errors
///
/// It returns an error if the torrent already exists in the database.
///
/// # Panics
///
/// Panics if the response body is not a valid JSON.
pub async fn upload_torrent(client: &Client, upload_torrent_form: UploadTorrentMultipartForm) -> Result<UploadedTorrent, Error> {
    let categories = get_categories(client).await;

    if !contains_category_with_name(&categories, &upload_torrent_form.category) {
        add_category(client, &upload_torrent_form.category).await;
    }

    // todo: if we receive timeout error we should retry later. Otherwise we
    // have to restart the seeder manually.

    let response = client
        .upload_torrent(upload_torrent_form.into())
        .await
        .expect("API should return a response");

    debug!(target:"seeder", "response: {}", response.status);

    if response.status == 400 {
        if response.body.contains("This torrent already exists in our database") {
            return Err(Error::TorrentInfoHashAlreadyExists);
        }

        if response.body.contains("This torrent title has already been used") {
            return Err(Error::TorrentTitleAlreadyExists);
        }
    }

    assert!(response.is_json_and_ok(), "Error uploading torrent: {}", response.body);

    let uploaded_torrent_response: UploadedTorrentResponse =
        serde_json::from_str(&response.body).expect("a valid JSON response should be returned from the Torrust Index API");

    Ok(uploaded_torrent_response.data)
}

/// It logs in the user and returns the user data.
///
/// # Panics
///
/// Panics if the response body is not a valid JSON.
pub async fn login(client: &Client, username: &str, password: &str) -> LoggedInUserData {
    let response = client
        .login_user(LoginForm {
            login: username.to_owned(),
            password: password.to_owned(),
        })
        .await
        .expect("API should return a response");

    let res: SuccessfulLoginResponse = serde_json::from_str(&response.body).unwrap_or_else(|_| {
        panic!(
            "a valid JSON response should be returned after login. Received: {}",
            response.body
        )
    });

    res.data
}

/// It returns all the index categories.
///
/// # Panics
///
/// Panics if the response body is not a valid JSON.
pub async fn get_categories(client: &Client) -> Vec<ListItem> {
    let response = client.get_categories().await.expect("API should return a response");

    let res: ListResponse = serde_json::from_str(&response.body).unwrap();

    res.data
}

/// It adds a new category.
///
/// # Panics
///
/// Will panic if it doesn't get a response form the API.
pub async fn add_category(client: &Client, name: &str) -> TextResponse {
    client
        .add_category(AddCategoryForm {
            name: name.to_owned(),
            icon: None,
        })
        .await
        .expect("API should return a response")
}

/// It checks if the category list contains the given category.
fn contains_category_with_name(items: &[ListItem], category_name: &str) -> bool {
    items.iter().any(|item| item.name == category_name)
}