Extract duplicate code into new package: bittorrent-http-protocol

.github/workflows/deployment.yaml

@@ -55,6 +55,7 @@ jobs:
         env:
           CARGO_REGISTRY_TOKEN: "${{ secrets.TORRUST_UPDATE_CARGO_REGISTRY_TOKEN }}"
         run: |
+          cargo publish -p bittorrent-http-protocol
           cargo publish -p bittorrent-tracker-client
           cargo publish -p torrust-tracker
           cargo publish -p torrust-tracker-client

.github/workflows/testing.yaml

@@ -140,7 +140,7 @@ jobs:
 
       - id: test-docs
         name: Run Documentation Tests
-        run: cargo test --doc
+        run: cargo test --doc --workspace
 
       - id: test
         name: Run Unit Tests

Cargo.toml

@@ -36,6 +36,7 @@ axum = { version = "0", features = ["macros"] }
 axum-client-ip = "0"
 axum-extra = { version = "0", features = ["query"] }
 axum-server = { version = "0", features = ["tls-rustls-no-provider"] }
+bittorrent-http-protocol = { version = "3.0.0-develop", path = "packages/http-protocol" }
 bittorrent-primitives = "0.1.0"
 bittorrent-tracker-client = { version = "3.0.0-develop", path = "packages/tracker-client" }
 blowfish = "0"

contrib/bencode/src/lib.rs

@@ -5,9 +5,9 @@
 //! Decoding bencoded data:
 //!
 //! ```rust
-//!     extern crate bencode;
+//!     extern crate torrust_tracker_contrib_bencode;
 //!
-//!     use bencode::{BencodeRef, BRefAccess, BDecodeOpt};
+//!     use torrust_tracker_contrib_bencode::{BencodeRef, BRefAccess, BDecodeOpt};
 //!
 //!     fn main() {
 //!         let data = b"d12:lucky_numberi7ee"; // cspell:disable-line
@@ -22,7 +22,7 @@
 //!
 //! ```rust
 //!     #[macro_use]
-//!     extern crate bencode;
+//!     extern crate torrust_tracker_contrib_bencode;
 //!
 //!     fn main() {
 //!         let message = (ben_map!{

packages/http-protocol/Cargo.toml

@@ -0,0 +1,21 @@
+[package]
+description = "A library with the primitive types and functions for the BitTorrent HTTP tracker protocol."
+keywords = ["api", "library", "primitives"]
+name = "bittorrent-http-protocol"
+readme = "README.md"
+
+authors.workspace = true
+documentation.workspace = true
+edition.workspace = true
+homepage.workspace = true
+license.workspace = true
+publish.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+version.workspace = true
+
+[dependencies]
+aquatic_udp_protocol = "0"
+bittorrent-primitives = "0.1.0"
+percent-encoding = "2"
+torrust-tracker-primitives = { version = "3.0.0-develop", path = "../primitives" }

packages/http-protocol/README.md

@@ -0,0 +1,11 @@
+# BitTorrent HTTP Tracker Protocol
+
+A library with the primitive types and functions used by BitTorrent HTTP trackers.
+
+## Documentation
+
+[Crate documentation](https://docs.rs/bittorrent-http-protocol).
+
+## License
+
+The project is licensed under the terms of the [GNU AFFERO GENERAL PUBLIC LICENSE](./LICENSE).

packages/http-protocol/src/lib.rs

@@ -0,0 +1,2 @@
+//! Primitive types and function for `BitTorrent` HTTP trackers.
+pub mod percent_encoding;

src/servers/http/percent_encoding.rs → packages/http-protocol/src/percent_encoding.rs

@@ -27,7 +27,7 @@ use torrust_tracker_primitives::peer;
 ///
 /// ```rust
 /// use std::str::FromStr;
-/// use torrust_tracker::servers::http::percent_encoding::percent_decode_info_hash;
+/// use bittorrent_http_protocol::percent_encoding::percent_decode_info_hash;
 /// use bittorrent_primitives::info_hash::InfoHash;
 /// use torrust_tracker_primitives::peer;
 ///
@@ -60,7 +60,7 @@ pub fn percent_decode_info_hash(raw_info_hash: &str) -> Result<InfoHash, info_ha
 /// use std::str::FromStr;
 ///
 /// use aquatic_udp_protocol::PeerId;
-/// use torrust_tracker::servers::http::percent_encoding::percent_decode_peer_id;
+/// use bittorrent_http_protocol::percent_encoding::percent_decode_peer_id;
 /// use bittorrent_primitives::info_hash::InfoHash;
 ///
 /// let encoded_peer_id = "%2DqB00000000000000000";
@@ -85,7 +85,7 @@ mod tests {
     use aquatic_udp_protocol::PeerId;
     use bittorrent_primitives::info_hash::InfoHash;
 
-    use crate::servers::http::percent_encoding::{percent_decode_info_hash, percent_decode_peer_id};
+    use crate::percent_encoding::{percent_decode_info_hash, percent_decode_peer_id};
 
     #[test]
     fn it_should_decode_a_percent_encoded_info_hash() {

packages/located-error/src/lib.rs

@@ -23,7 +23,7 @@
 //! let b: LocatedError<TestError> = Located(e).into();
 //! let l = get_caller_location();
 //!
-//! assert!(b.to_string().contains("Test, src/lib.rs"));
+//! assert!(b.to_string().contains("src/lib.rs"));
 //! ```
 //!
 //! # Credits

packages/tracker-client/src/http/mod.rs

@@ -1,5 +1,4 @@
 pub mod client;
-pub mod url_encoding;
 
 use percent_encoding::NON_ALPHANUMERIC;
 
@@ -25,3 +24,19 @@ impl InfoHash {
         self.0
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::http::percent_encode_byte_array;
+
+    #[test]
+    fn it_should_encode_a_20_byte_array() {
+        assert_eq!(
+            percent_encode_byte_array(&[
+                0x3b, 0x24, 0x55, 0x04, 0xcf, 0x5f, 0x11, 0xbb, 0xdb, 0xe1, 0x20, 0x1c, 0xea, 0x6a, 0x6b, 0xf4, 0x5a, 0xee, 0x1b,
+                0xc0,
+            ]),
+            "%3B%24U%04%CF%5F%11%BB%DB%E1%20%1C%EAjk%F4Z%EE%1B%C0"
+        );
+    }
+}

src/servers/http/mod.rs

@@ -305,7 +305,6 @@
 //! - [Bencode to Json Online converter](https://chocobo1.github.io/bencode_online).
 use serde::{Deserialize, Serialize};
 
-pub mod percent_encoding;
 pub mod server;
 pub mod v1;
 

src/servers/http/v1/requests/announce.rs

@@ -6,12 +6,12 @@ use std::panic::Location;
 use std::str::FromStr;
 
 use aquatic_udp_protocol::{NumberOfBytes, PeerId};
+use bittorrent_http_protocol::percent_encoding::{percent_decode_info_hash, percent_decode_peer_id};
 use bittorrent_primitives::info_hash::{self, InfoHash};
 use thiserror::Error;
 use torrust_tracker_located_error::{Located, LocatedError};
 use torrust_tracker_primitives::peer;
 
-use crate::servers::http::percent_encoding::{percent_decode_info_hash, percent_decode_peer_id};
 use crate::servers::http::v1::query::{ParseQueryError, Query};
 use crate::servers::http::v1::responses;
 

src/servers/http/v1/requests/scrape.rs

@@ -3,11 +3,11 @@
 //! Data structures and logic for parsing the `scrape` request.
 use std::panic::Location;
 
+use bittorrent_http_protocol::percent_encoding::percent_decode_info_hash;
 use bittorrent_primitives::info_hash::{self, InfoHash};
 use thiserror::Error;
 use torrust_tracker_located_error::{Located, LocatedError};
 
-use crate::servers::http::percent_encoding::percent_decode_info_hash;
 use crate::servers::http::v1::query::Query;
 use crate::servers::http::v1::responses;