refactor: torrent_resource to torrent

Author: da2ce7

src/api/resources/mod.rs

@@ -3,10 +3,10 @@
 //! WIP. Not all endpoints have their resource structs.
 //!
 //! - [x] `AuthKeys`
-//! - [ ] `TorrentResource`, `TorrentListItemResource`, `TorrentPeerResource`, `PeerIdResource`
+//! - [ ] `Torrent`, `ListItem`, `Peer`, `PeerId`
 //! - [ ] `StatsResource`
 //! - [ ] ...
 
 pub mod auth_key;
 pub mod stats;
-pub mod torrent_resource;
+pub mod torrent;

src/api/resources/torrent_resource.rs renamed to src/api/resources/torrent.rs

@@ -1,29 +1,29 @@
 use serde::{Deserialize, Serialize};
 
-use crate::tracker::peer::{self, Peer};
+use crate::tracker::peer;
 
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
-pub struct TorrentResource {
+pub struct Torrent {
     pub info_hash: String,
     pub seeders: u32,
     pub completed: u32,
     pub leechers: u32,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub peers: Option<Vec<TorrentPeerResource>>,
+    pub peers: Option<Vec<Peer>>,
 }
 
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
-pub struct TorrentListItemResource {
+pub struct ListItem {
     pub info_hash: String,
     pub seeders: u32,
     pub completed: u32,
     pub leechers: u32,
     // todo: this is always None. Remove field from endpoint?
-    pub peers: Option<Vec<TorrentPeerResource>>,
+    pub peers: Option<Vec<Peer>>,
 }
 
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq)]
-pub struct TorrentPeerResource {
+pub struct Peer {
     pub peer_id: PeerIdResource,
     pub peer_addr: String,
     #[deprecated(since = "2.0.0", note = "please use `updated_milliseconds_ago` instead")]
@@ -50,10 +50,10 @@ impl From<peer::Id> for PeerIdResource {
     }
 }
 
-impl From<Peer> for TorrentPeerResource {
+impl From<peer::Peer> for Peer {
     #[allow(deprecated)]
-    fn from(peer: Peer) -> Self {
-        TorrentPeerResource {
+    fn from(peer: peer::Peer) -> Self {
+        Peer {
             peer_id: PeerIdResource::from(peer.peer_id),
             peer_addr: peer.peer_addr.to_string(),
             updated: peer.updated.as_millis(),

src/api/server.rs

@@ -9,7 +9,7 @@ use warp::{filters, reply, serve, Filter};
 
 use super::resources::auth_key::AuthKey;
 use super::resources::stats::Stats;
-use super::resources::torrent_resource::{TorrentListItemResource, TorrentPeerResource, TorrentResource};
+use super::resources::torrent::{ListItem, Peer, Torrent};
 use crate::protocol::info_hash::InfoHash;
 use crate::tracker;
 
@@ -81,7 +81,7 @@ pub fn start(socket_addr: SocketAddr, tracker: &Arc<tracker::Tracker>) -> impl w
                 .iter()
                 .map(|(info_hash, torrent_entry)| {
                     let (seeders, completed, leechers) = torrent_entry.get_stats();
-                    TorrentListItemResource {
+                    ListItem {
                         info_hash: info_hash.to_string(),
                         seeders,
                         completed,
@@ -179,9 +179,9 @@ pub fn start(socket_addr: SocketAddr, tracker: &Arc<tracker::Tracker>) -> impl w
 
             let peers = torrent_entry.get_peers(None);
 
-            let peer_resources = peers.iter().map(|peer| TorrentPeerResource::from(**peer)).collect();
+            let peer_resources = peers.iter().map(|peer| Peer::from(**peer)).collect();
 
-            Ok(reply::json(&TorrentResource {
+            Ok(reply::json(&Torrent {
                 info_hash: info_hash.to_string(),
                 seeders,
                 completed,

tests/api.rs

@@ -18,14 +18,13 @@ mod tracker_api {
     use tokio::task::JoinHandle;
     use torrust_tracker::api::resources::auth_key::AuthKey;
     use torrust_tracker::api::resources::stats::Stats;
-    use torrust_tracker::api::resources::torrent_resource::{TorrentListItemResource, TorrentPeerResource, TorrentResource};
+    use torrust_tracker::api::resources::torrent::{self, Torrent};
     use torrust_tracker::config::Configuration;
     use torrust_tracker::jobs::tracker_api;
     use torrust_tracker::protocol::clock::DurationSinceUnixEpoch;
     use torrust_tracker::protocol::info_hash::InfoHash;
-    use torrust_tracker::tracker::auth;
-    use torrust_tracker::tracker::peer::{self, Peer};
     use torrust_tracker::tracker::statistics::Keeper;
+    use torrust_tracker::tracker::{auth, peer};
     use torrust_tracker::{ephemeral_instance_keys, logging, static_time, tracker};
 
     use crate::common::ephemeral_random_port;
@@ -104,7 +103,7 @@ mod tracker_api {
 
         assert_eq!(
             torrent_resource,
-            TorrentResource {
+            Torrent {
                 info_hash: "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_string(),
                 seeders: 1,
                 completed: 0,
@@ -135,7 +134,7 @@ mod tracker_api {
 
         assert_eq!(
             torrent_resources,
-            vec![TorrentListItemResource {
+            vec![torrent::ListItem {
                 info_hash: "9e0217d0fa71c87332cd8bf9dbeabcb2c2cf3c4d".to_string(),
                 seeders: 1,
                 completed: 0,
@@ -187,8 +186,8 @@ mod tracker_api {
         );
     }
 
-    fn sample_torrent_peer() -> (Peer, TorrentPeerResource) {
-        let torrent_peer = Peer {
+    fn sample_torrent_peer() -> (peer::Peer, torrent::Peer) {
+        let torrent_peer = peer::Peer {
             peer_id: peer::Id(*b"-qB00000000000000000"),
             peer_addr: SocketAddr::new(IpAddr::V4(Ipv4Addr::new(126, 0, 0, 1)), 8080),
             updated: DurationSinceUnixEpoch::new(1_669_397_478_934, 0),
@@ -197,7 +196,7 @@ mod tracker_api {
             left: NumberOfBytes(0),
             event: AnnounceEvent::Started,
         };
-        let torrent_peer_resource = TorrentPeerResource::from(torrent_peer);
+        let torrent_peer_resource = torrent::Peer::from(torrent_peer);
 
         (torrent_peer, torrent_peer_resource)
     }
@@ -326,7 +325,7 @@ mod tracker_api {
             reqwest::Client::new().post(url.clone()).send().await.unwrap()
         }
 
-        pub async fn get_torrent(&self, info_hash: &str) -> TorrentResource {
+        pub async fn get_torrent(&self, info_hash: &str) -> Torrent {
             let url = format!(
                 "http://{}/api/torrent/{}?token={}",
                 &self.connection_info.bind_address, &info_hash, &self.connection_info.api_token
@@ -338,12 +337,12 @@ mod tracker_api {
                 .send()
                 .await
                 .unwrap()
-                .json::<TorrentResource>()
+                .json::<Torrent>()
                 .await
                 .unwrap()
         }
 
-        pub async fn get_torrents(&self) -> Vec<TorrentListItemResource> {
+        pub async fn get_torrents(&self) -> Vec<torrent::ListItem> {
             let url = format!(
                 "http://{}/api/torrents?token={}",
                 &self.connection_info.bind_address, &self.connection_info.api_token
@@ -355,7 +354,7 @@ mod tracker_api {
                 .send()
                 .await
                 .unwrap()
-                .json::<Vec<TorrentListItemResource>>()
+                .json::<Vec<torrent::ListItem>>()
                 .await
                 .unwrap()
         }