Enable usage of the crate only as a parser + types via.

The client specific functions are now enabled via the `client` feature.

This enables more specific handling of the http requests and makes testing easier.

Author: Emilgardis

.github/workflows/ci.yml

@@ -38,7 +38,7 @@ jobs:
         uses: actions/cache@v1
         id: cache
         with:
-          path: | 
+          path: |
             ~/.cargo/registry/index
             ~/.cargo/registry/cache
             ~/.cargo/git
@@ -65,7 +65,6 @@ jobs:
         with:
           command: fmt
           args: --all -- --check
-
   clippy:
     name: Clippy
     runs-on: ubuntu-latest
@@ -81,17 +80,22 @@ jobs:
         uses: actions/cache@v1
         id: cache
         with:
-          path: | 
+          path: |
             ~/.cargo/registry/index
             ~/.cargo/registry/cache
             ~/.cargo/git
             target
           key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+      - name: Run clippy
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --locked
       - name: Run clippy --all-targets --all-features
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --locked --all-targets --all-features 
+          args: --locked --all-targets --all-features
   docs:
     name: Docs
     runs-on: ubuntu-latest
@@ -106,7 +110,7 @@ jobs:
         uses: actions/cache@v1
         id: cache
         with:
-          path: | 
+          path: |
             ~/.cargo/registry/index
             ~/.cargo/registry/cache
             ~/.cargo/git

Cargo.toml

@@ -12,11 +12,12 @@ readme = "README.md"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [features]
 default = []
-reqwest = ["dep:reqwest"]
-surf_client_curl = ["dep:surf", "surf/curl-client"]
-surf = ["dep:surf", "dep:http-types", "http-types?/hyperium_http"]
+client = []
+reqwest = ["dep:reqwest", "client"]
+surf_client_curl = ["surf", "surf/curl-client"]
+surf = ["dep:surf", "dep:http-types", "http-types?/hyperium_http", "client"]
 mock_api = []
-all = ["surf_client_curl", "dep:reqwest"]
+all = ["surf_client_curl", "reqwest"]
 
 [dependencies]
 thiserror = "1.0.29"

release.toml

@@ -9,6 +9,5 @@ pre-release-replacements = [
   {file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}", prerelease=false},
   {file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n\n## [Unreleased] - ReleaseDate\n\n[Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v{{version}}...Unreleased)", prerelease=false},
   {file="README.md", search="twitch_oauth2/[a-z0-9\\.-]+/twitch_oauth2", replace="{{crate_name}}/{{version}}/{{crate_name}}", prerelease=true},
-  {file="src/lib.rs", search="https://docs.rs/twitch_oauth2/[a-z0-9\\.-]+", replace="https://docs.rs/{{crate_name}}/{{version}}", prerelease=true},
   {file="Cargo.toml", search="https://docs.rs/twitch_oauth2/[a-z0-9\\.-]+", replace="https://docs.rs/{{crate_name}}/{{version}}", prerelease=true},
 ]

src/client.rs

@@ -20,8 +20,8 @@ pub trait Client<'a>: Sync + Send + 'a {
     /// Send a request
     fn req(
         &'a self,
-        request: crate::HttpRequest,
-    ) -> BoxedFuture<'a, Result<crate::HttpResponse, <Self as Client>::Error>>;
+        request: http::Request<Vec<u8>>,
+    ) -> BoxedFuture<'a, Result<http::Response<Vec<u8>>, <Self as Client>::Error>>;
 }
 
 #[doc(hidden)]
@@ -35,8 +35,8 @@ impl<'a> Client<'a> for DummyClient {
 
     fn req(
         &'a self,
-        _: crate::HttpRequest,
-    ) -> BoxedFuture<'a, Result<crate::HttpResponse, Self::Error>> {
+        _: http::Request<Vec<u8>>,
+    ) -> BoxedFuture<'a, Result<http::Response<Vec<u8>>, Self::Error>> {
         Box::pin(async move { Err(self.clone()) })
     }
 }
@@ -49,8 +49,8 @@ impl<'a> Client<'a> for ReqwestClient {
 
     fn req(
         &'a self,
-        request: crate::HttpRequest,
-    ) -> BoxedFuture<'a, Result<crate::HttpResponse, Self::Error>> {
+        request: http::Request<Vec<u8>>,
+    ) -> BoxedFuture<'a, Result<http::Response<Vec<u8>>, Self::Error>> {
         // Reqwest plays really nice here and has a try_from on `http::Request` -> `reqwest::Request`
         let req = match reqwest::Request::try_from(request) {
             Ok(req) => req,
@@ -98,8 +98,8 @@ impl<'a> Client<'a> for SurfClient {
 
     fn req(
         &'a self,
-        request: crate::HttpRequest,
-    ) -> BoxedFuture<'a, Result<crate::HttpResponse, Self::Error>> {
+        request: http::Request<Vec<u8>>,
+    ) -> BoxedFuture<'a, Result<http::Response<Vec<u8>>, Self::Error>> {
         // First we translate the `http::Request` method and uri into types that surf understands.
 
         let method: surf::http::Method = request.method().clone().into();
@@ -124,7 +124,7 @@ impl<'a> Client<'a> for SurfClient {
         }
 
         // assembly the request, now we can send that to our `surf::Client`
-        req.body_bytes(&request.body());
+        req.body_bytes(request.body());
 
         let client = self.clone();
         Box::pin(async move {

src/id.rs

@@ -2,9 +2,14 @@
 
 use serde::{Deserialize, Serialize};
 
-use crate::AccessToken;
+use crate::{AccessToken, RequestParseError};
 use std::time::Duration;
 /// Twitch's representation of the oauth flow.
+///
+/// Retrieve with
+///
+/// * [`UserTokenBuilder::get_user_token_request`](crate::tokens::UserTokenBuilder::get_user_token_request)
+/// * [`AppAccessToken::::get_app_access_token_request`](crate::tokens::AppAccessToken::get_app_access_token_request)
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct TwitchTokenResponse {
     /// Access token
@@ -21,6 +26,15 @@ pub struct TwitchTokenResponse {
     pub scopes: Option<Vec<crate::Scope>>,
 }
 
+impl TwitchTokenResponse {
+    /// Create a [TwitchTokenResponse] from a [http::Response]
+    pub fn from_response<B: AsRef<[u8]>>(
+        resp: &http::Response<B>,
+    ) -> Result<TwitchTokenResponse, RequestParseError> {
+        crate::parse_response(resp)
+    }
+}
+
 /// Twitch's representation of the oauth flow for errors
 #[derive(Clone, Debug, Deserialize, Serialize, thiserror::Error)]
 pub struct TwitchTokenErrorResponse {