Merge #95

95: more non-async compat with new feature flag `client` and `::from_response` methods and `*_request` methods r=Emilgardis a=Emilgardis

Enables usage of the crate only as a parser + types

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

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

Co-authored-by: Emil Gardström <emil.gardstrom@gmail.com>

Author: bors[bot]

.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

CHANGELOG.md

@@ -6,26 +6,33 @@
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v0.8.0...Unreleased)
 
+### Breaking
+
+- Added new feature flag `client` that enables client specific functions. Without this feature,
+  `twitch_oauth2` will only provide non-async functions and
+  provide library users functions that returns `http::Request`s and consume `http::Response`s.
+- `ValidatedToken::expires_in` is now an `Option`.
+
 ## [v0.8.0] - 2022-08-27
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v0.7.1...v0.8.0)
 
 ### Breaking
 
-* Bumped `aliri_braid` to `0.2`, this change means that the `new` method on the types in `types` only take an owned string now
-  * `AccessToken::new`, `ClientId::new`, `ClientSecret::new`, `CsrfToken::new` and `RefreshToken::new` now take a `String` instead of `impl Into<String>`
+- Bumped `aliri_braid` to `0.2`, this change means that the `new` method on the types in `types` only take an owned string now
+  - `AccessToken::new`, `ClientId::new`, `ClientSecret::new`, `CsrfToken::new` and `RefreshToken::new` now take a `String` instead of `impl Into<String>`
 
 ## [v0.7.1] - 2022-08-27
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v0.7.0...v0.7.1)
 
 ### Changed
 
-* Organization moved to `twitch-rs`
+- Organization moved to `twitch-rs`
 
 ### Added
 
-* Added scopes `channel:manage:raids`, `channel:manage:moderators`, `channel:manage:vips`, `channel:read:charity`,
+- Added scopes `channel:manage:raids`, `channel:manage:moderators`, `channel:manage:vips`, `channel:read:charity`,
   `channel:read:vips`, `moderator:manage:announcements`, `moderator:manage:chat_messages`, `user:manage:chat_color` and
   `user:manage:whispers`
 
@@ -35,16 +42,16 @@
 
 ### Breaking changes
 
-* switch to [`twitch_types`](https://crates.io/crates/twitch_types) for `UserId` and `Nickname`/`UserName`
-* bump MSRV to 1.60, also changes the feature names for clients to their simpler variant `surf` and `client`
+- switch to [`twitch_types`](https://crates.io/crates/twitch_types) for `UserId` and `Nickname`/`UserName`
+- bump MSRV to 1.60, also changes the feature names for clients to their simpler variant `surf` and `client`
 
 ## [v0.6.1] - 2021-11-23
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v0.6.0...v0.6.1)
 
 ### Added
 
-* Added new scopes `moderator:manage:automod_settings`, `moderator:manage:banned_users`,
+- Added new scopes `moderator:manage:automod_settings`, `moderator:manage:banned_users`,
   `moderator:manage:blocked_terms`, `moderator:manage:chat_settings`, `moderator:read:automod_settings`,
   `moderator:read:blocked_terms` and `moderator:read:chat_settings`
 
@@ -54,68 +61,69 @@
 
 ### Breaking changes
 
-* All types associated with tokens are now defined in this crate. This is a consequence of the `oauth2` dependency being removed from tree.
+- All types associated with tokens are now defined in this crate. This is a consequence of the `oauth2` dependency being removed from tree.
   Additionally, as another consequence, clients are now able to be specified as a `for<'a> &'a T where T: Client<'a>`, meaning `twitch_api` can use its clients as an interface to token requests,
   and clients can persist instead of being rebuilt every call. Care should be taken when making clients, as SSRF and similar attacks are possible with improper client configurations.
 
 ### Added
 
-* Added types/braids `ClientId`, `ClientSecret`, `AccessToken`, `RefreshToken` and `CsrfToken`.
-* Added way to interact with the Twitch-CLI [mock API](https://github.com/twitchdev/twitch-cli/blob/main/docs/mock-api.md) using environment variables.
+- Added types/braids `ClientId`, `ClientSecret`, `AccessToken`, `RefreshToken` and `CsrfToken`.
+- Added way to interact with the Twitch-CLI [mock API](https://github.com/twitchdev/twitch-cli/blob/main/docs/mock-api.md) using environment variables.
   See static variables `AUTH_URL`, `TOKEN_URL`, `VALIDATE_URL` and `REVOKE_URL` for more information.
-* Added `impl Borrow<str> for Scope`, meaning it can be used in places it couldn't be used before. Primarily, it allows the following code to work:
+- Added `impl Borrow<str> for Scope`, meaning it can be used in places it couldn't be used before. Primarily, it allows the following code to work:
   ```rust
   let scopes = vec![Scope::ChatEdit, Scope::ChatRead];
   let space_separated_scope: String = scopes.as_slice().join(" ");
   ```
-* Added scope `channel:read:goals`
+- Added scope `channel:read:goals`
 
 ### Changed
 
-* Requests to `id.twitch.tv` now follow the documentation, instead of following a subset of the RFC for oauth2.
-* URLs are now initialized lazily and specified as `url::Url`s.
+- Requests to `id.twitch.tv` now follow the documentation, instead of following a subset of the RFC for oauth2.
+- URLs are now initialized lazily and specified as `url::Url`s.
 
 ### Removed
 
-* Removed `oauth2` dependency.
+- Removed `oauth2` dependency.
 
 ## [v0.5.2] - 2021-06-18
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v0.5.1...v0.5.2)
 
 ### Added
 
-* Added new scope `channel:manage:schedule`
+- Added new scope `channel:manage:schedule`
 
 ## [v0.5.1] - 2021-05-16
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/v0.5.0...v0.5.1)
 
 ### Added
 
-* Added new scopes `channel:manage:polls`, `channel:manage:predictions`, `channel:read:polls`, `channel:read:predictions`, and `moderator:manage:automod`,
-* Added function `Scope::description` to get the description of the scope
+- Added new scopes `channel:manage:polls`, `channel:manage:predictions`, `channel:read:polls`, `channel:read:predictions`, and `moderator:manage:automod`,
+- Added function `Scope::description` to get the description of the scope
 
 ## [v0.5.0] - 2021-05-08
 
 [Commits](https://github.com/twitch-rs/twitch_oauth2/compare/49a083ceda6768cc52a1f8f1714bb7f942f24c01...v0.5.0)
 
 ### Added
 
-* Made crate runtime agnostic with custom clients.
-* Updated deps.
-* Add an extra (optional) client secret field to `UserToken::from_existing` (thanks [Dinnerbone](https://github.com/Dinnerbone))
-* Added `channel:manage:redemptions`, `channel:read:editors`, `channel:manage:videos`, `user:read:blocked_users`,  `user:manage:blocked_users`, `user:read:subscriptions` and `user:read:follows`
-* Implemented [OAuth Authorization Code Flow](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/#oauth-authorization-code-flow) with `UserTokenBuilder`
-* Added a way to suggest or infer that an user token is never expiring, making `is_elapsed` return false and `expires_in` a bogus (max) duration.
+- Made crate runtime agnostic with custom clients.
+- Updated deps.
+- Add an extra (optional) client secret field to `UserToken::from_existing` (thanks [Dinnerbone](https://github.com/Dinnerbone))
+- Added `channel:manage:redemptions`, `channel:read:editors`, `channel:manage:videos`, `user:read:blocked_users`, `user:manage:blocked_users`, `user:read:subscriptions` and `user:read:follows`
+- Implemented [OAuth Authorization Code Flow](https://dev.twitch.tv/docs/authentication/getting-tokens-oauth/#oauth-authorization-code-flow) with `UserTokenBuilder`
+- Added a way to suggest or infer that an user token is never expiring, making `is_elapsed` return false and `expires_in` a bogus (max) duration.
+
 ### Changed
 
-* MSRV: 1.51
-* Made scope take `Cow<&'static str>`
-* Made fields `access_token`, `refresh_token`, `user_id` and `login` `pub` on `UserToken` and `AppAccessToken` (where applicable)
-* Fixed wrong scope `user:read:stream_key` -> `channel:read:stream_key`
-* BREAKING: changed `TwitchToken::expires` -> `TwitchToken::expires_in` to calculate current lifetime of token
+- MSRV: 1.51
+- Made scope take `Cow<&'static str>`
+- Made fields `access_token`, `refresh_token`, `user_id` and `login` `pub` on `UserToken` and `AppAccessToken` (where applicable)
+- Fixed wrong scope `user:read:stream_key` -> `channel:read:stream_key`
+- BREAKING: changed `TwitchToken::expires` -> `TwitchToken::expires_in` to calculate current lifetime of token
 
 ## End of Changelog
 
-Changelog starts on v0.5.0
+Changelog starts on v0.5.0

Cargo.toml

@@ -12,18 +12,19 @@ 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 = ["dep:async-trait"]
+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"
 displaydoc = "0.2.3"
 serde = { version = "1.0.130", features = ["derive"] }
 serde_json = "1.0.68"
-async-trait = "0.1.51"
+async-trait = { version = "0.1.51", optional = true }
 http = "0.2.5"
 surf = { version = "2.3.1", optional = true, default-features = false }
 reqwest = { version = "0.11.4", optional = true, default-features = false }

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]>>(
+        response: &http::Response<B>,
+    ) -> Result<TwitchTokenResponse, RequestParseError> {
+        crate::parse_response(response)
+    }
+}
+
 /// Twitch's representation of the oauth flow for errors
 #[derive(Clone, Debug, Deserialize, Serialize, thiserror::Error)]
 pub struct TwitchTokenErrorResponse {