chore: cleanup tests and docs (#3)

Author: joshka

bacon.toml

@@ -45,11 +45,13 @@ need_stdout = false
 command = [
     "cargo",
     "test",
+    "--workspace",
+    "--all-features",
     "--color",
     "always",
     "--",
     "--color",
-    "always",  # see https://github.com/Canop/bacon/issues/124
+    "always",         # see https://github.com/Canop/bacon/issues/124
 ]
 need_stdout = true
 

webfinger-rs/Cargo.toml

@@ -67,3 +67,7 @@ doc-scrape-examples = true
 [[example]]
 name = "actix"
 required-features = ["actix"]
+
+[[example]]
+name = "client"
+required-features = ["reqwest"]

webfinger-rs/src/axum.rs

@@ -20,7 +20,7 @@ const JRD_CONTENT_TYPE: HeaderValue = HeaderValue::from_static("application/jrd+
 impl IntoResponse for WebFingerResponse {
     /// Converts a WebFinger response into an axum response.
     ///
-    /// This is used to convert a WebFinger [`Response`] into an axum response in an axum route
+    /// This is used to convert a [`WebFingerResponse`] into an axum response in an axum route
     /// handler. The response will be serialized as JSON and the `Content-Type` header will be set
     /// to `application/jrd+json`.
     ///
@@ -30,18 +30,19 @@ impl IntoResponse for WebFingerResponse {
     ///
     /// ```rust
     /// use axum::response::IntoResponse;
-    /// use webfinger_rs::{Link, Request, Response};
+    /// use webfinger_rs::{Link, WebFingerRequest, WebFingerResponse};
     ///
-    /// async fn handler(request: Request) -> impl IntoResponse {
+    /// async fn handler(request: WebFingerRequest) -> impl IntoResponse {
     ///     // ... your code to handle the webfinger request ...
     ///     let subject = request.resource.to_string();
     ///     let link = Link::builder("http://webfinger.net/rel/profile-page")
     ///         .href(format!("https://example.com/profile/{subject}"));
-    ///     Response::builder(subject).link(link).build()
+    ///     WebFingerResponse::builder(subject).link(link).build()
     /// }
     /// ```
     ///
-    /// [axum example]: http://github.com/joshka/webfinger-rs/blob/main/webfinger-rs/examples/axum.rs
+    /// [axum example]:
+    ///     http://github.com/joshka/webfinger-rs/blob/main/webfinger-rs/examples/axum.rs
     fn into_response(self) -> AxumResponse {
         ([(header::CONTENT_TYPE, JRD_CONTENT_TYPE)], Json(self)).into_response()
     }
@@ -93,10 +94,7 @@ impl From<QueryRejection> for Rejection {
 impl<S: Send + Sync> FromRequestParts<S> for WebFingerRequest {
     type Rejection = Rejection;
 
-    /// Extracts a `Request` from the request parts.
-    ///
-    /// This is used to extract a WebFinger [`Request`] from the request parts in an axum route
-    /// handler.
+    /// Extracts a [`WebFingerRequest`] from the request parts.
     ///
     /// # Errors
     ///
@@ -115,16 +113,16 @@ impl<S: Send + Sync> FromRequestParts<S> for WebFingerRequest {
     ///
     /// ```rust
     /// use axum::response::IntoResponse;
-    /// use webfinger_rs::Request;
+    /// use webfinger_rs::WebFingerRequest;
     ///
-    /// async fn handler(request: Request) -> impl IntoResponse {
-    ///     let Request {
+    /// async fn handler(request: WebFingerRequest) -> impl IntoResponse {
+    ///     let WebFingerRequest {
     ///         host,
     ///         resource,
     ///         rels,
     ///     } = request;
     ///     // ... your code to handle the webfinger request ...
-    /// # webfinger_rs::Response::new(resource.to_string())
+    /// # webfinger_rs::WebFingerResponse::new(resource.to_string())
     /// }
     /// ```
     ///

webfinger-rs/src/lib.rs

@@ -35,15 +35,15 @@
 //! <https://github.com/joshka/webfinger-rs/blob/main/webfinger-rs/examples/client.rs>.
 //!
 //! ```rust,no_run
-//! use webfinger_rs::Request;
+//! use webfinger_rs::WebFingerRequest;
 //!
 //! #[tokio::main]
 //! async fn main() -> Result<(), Box<dyn std::error::Error>> {
-//!     let request = Request::builder("acct:[email protected]")?
+//!     let request = WebFingerRequest::builder("acct:[email protected]")?
 //!         .host("example.com")
 //!         .rel("http://webfinger.net/rel/profile-page")
 //!         .build();
-//!     let response = request.execute().await?;
+//!     let response = request.execute_reqwest().await?;
 //!     dbg!(response);
 //!     Ok(())
 //! }
@@ -57,7 +57,7 @@
 //!
 //! ```rust
 //! use axum::response::Result as AxumResult;
-//! use webfinger_rs::{Link, Rel, Request as WebFingerRequest, Response as WebFingerResponse};
+//! use webfinger_rs::{Link, Rel, WebFingerRequest, WebFingerResponse};
 //!
 //! async fn webfinger(request: WebFingerRequest) -> AxumResult<WebFingerResponse> {
 //!     let subject = request.resource.to_string();
@@ -124,7 +124,10 @@
 
 pub use crate::{
     error::Error,
-    types::{Link, Rel, Request as WebFingerRequest, Response as WebFingerResponse, Title},
+    types::{
+        Link, LinkBuilder, Rel, Request as WebFingerRequest, RequestBuilder,
+        Response as WebFingerResponse, ResponseBuilder, Title,
+    },
 };
 
 #[cfg(feature = "actix")]

webfinger-rs/src/reqwest.rs

@@ -39,14 +39,14 @@ impl WebFingerRequest {
     /// # Examples
     ///
     /// ```rust
-    /// use webfinger_rs::Request;
+    /// use webfinger_rs::WebFingerRequest;
     ///
     /// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
-    /// let query = Request::builder("acct:[email protected]")?
+    /// let query = WebFingerRequest::builder("acct:[email protected]")?
     ///     .host("example.com")
     ///     .rel("http://webfinger.net/rel/profile-page")
     ///     .build();
-    /// let response = query.execute().await?;
+    /// let response = query.execute_reqwest().await?;
     /// # Ok(())
     /// # }
     /// ```

webfinger-rs/src/types.rs

@@ -1,7 +1,7 @@
 pub use {
     rel::Rel,
-    request::Request,
-    response::{Link, Response, Title},
+    request::{Builder as RequestBuilder, Request},
+    response::{Builder as ResponseBuilder, Link, LinkBuilder, Response, Title},
 };
 
 mod rel;

webfinger-rs/src/types/request.rs

@@ -15,9 +15,9 @@ use crate::{Error, Rel};
 /// # Examples
 ///
 /// ```rust
-/// use webfinger_rs::Request;
+/// use webfinger_rs::WebFingerRequest;
 ///
-/// let request = Request::builder("acct:[email protected]")?
+/// let request = WebFingerRequest::builder("acct:[email protected]")?
 ///     .host("example.com")
 ///     .rel("http://webfinger.net/rel/profile-page")
 ///     .build();
@@ -28,21 +28,21 @@ use crate::{Error, Rel};
 ///
 /// ```rust
 /// # async fn example() -> Result<(), Box<dyn std::error::Error>> {
-/// # use webfinger_rs::Request;
-/// # let request = Request::builder("acct:[email protected]")?.build();
-/// let response = request.execute().await?;
+/// # use webfinger_rs::WebFingerRequest;
+/// # let request = WebFingerRequest::builder("acct:[email protected]")?.build();
+/// let response = request.execute_reqwest().await?;
 /// # Ok(())
 /// # }
 /// ```
 ///
 /// `Request` can be used as an Axum extractor as it implements [`axum::extract::FromRequestParts`].
 ///
 /// ```rust
-/// use webfinger_rs::{Request, Response};
+/// use webfinger_rs::{WebFingerRequest, WebFingerResponse};
 ///
-/// async fn handler(request: Request) -> Response {
+/// async fn handler(request: WebFingerRequest) -> WebFingerResponse {
 ///     // ... handle the request ...
-/// # Response::new("")
+/// # WebFingerResponse::new("")
 /// }
 /// ```
 #[serde_as]
@@ -98,9 +98,9 @@ impl Request {
 /// # Examples
 ///
 /// ```rust
-/// use webfinger_rs::Request;
+/// use webfinger_rs::WebFingerRequest;
 ///
-/// let query = Request::builder("acct:[email protected]")?
+/// let query = WebFingerRequest::builder("acct:[email protected]")?
 ///     .host("example.com")
 ///     .rel("http://webfinger.net/rel/profile-page")
 ///     .build();
@@ -142,9 +142,9 @@ impl Builder {
     /// # Examples
     ///
     /// ```rust
-    /// use webfinger_rs::Request;
+    /// use webfinger_rs::WebFingerRequest;
     ///
-    /// let query = Request::builder("acct:[email protected]")?
+    /// let query = WebFingerRequest::builder("acct:[email protected]")?
     ///     .rel("http://webfinger.net/rel/profile-page")
     ///     .build();
     /// # Ok::<(), Box<dyn std::error::Error>>(())

webfinger-rs/src/types/response.rs

@@ -19,15 +19,15 @@ use crate::Rel;
 /// # Examples
 ///
 /// ```rust
-/// use webfinger_rs::{Link, Response};
+/// use webfinger_rs::{Link, WebFingerResponse};
 ///
 /// let avatar = Link::builder("http://webfinger.net/rel/avatar")
 ///     .href("https://example.com/avatar.png")
 ///     .build();
 /// let profile = Link::builder("http://webfinger.net/rel/profile-page")
 ///     .href("https://example.com/profile/carol")
 ///     .build();
-/// let response = Response::builder("acct:[email protected]")
+/// let response = WebFingerResponse::builder("acct:[email protected]")
 ///     .alias("https://example.com/profile/carol")
 ///     .property("https://example.com/ns/role", "developer")
 ///     .link(avatar)
@@ -40,11 +40,11 @@ use crate::Rel;
 ///
 /// ```rust
 /// use axum::response::IntoResponse;
-/// use webfinger_rs::{Link, Request, Response};
+/// use webfinger_rs::{Link, WebFingerRequest, WebFingerResponse};
 ///
-/// async fn handler(request: Request) -> Response {
+/// async fn handler(request: WebFingerRequest) -> WebFingerResponse {
 ///     // ... handle the request ...
-///     Response::builder("acct:[email protected]")
+///     WebFingerResponse::builder("acct:[email protected]")
 ///         .alias("https://example.com/profile/carol")
 ///         .property("https://example.com/ns/role", "developer")
 ///         .link(
@@ -100,11 +100,11 @@ impl Response {
     /// # Examples
     ///
     /// ```rust
-    /// use webfinger_rs::{Link, Response};
+    /// use webfinger_rs::{Link, WebFingerResponse};
     ///
     /// let avatar =
     ///     Link::builder("http://webfinger.net/rel/avatar").href("https://example.com/avatar.png");
-    /// let response = Response::builder("acct:[email protected]")
+    /// let response = WebFingerResponse::builder("acct:[email protected]")
     ///     .alias("https://example.com/profile/carol")
     ///     .property("https://example.com/ns/role", "developer")
     ///     .link(avatar)