Skip to content

Optional middleware #95

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Optional middleware #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad2ef77
Move middleware behind flag
augustuswm Dec 9, 2024
07f1957
Make middleware default
augustuswm Dec 9, 2024
ab88d99
Bump version
augustuswm Dec 9, 2024
4bc6e66
Update version to 0.9
augustuswm Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
SHELL := bash

VERSION = 0.8.0-rc.2
VERSION = 0.9.0

DOCUSIGN_SPEC_DIR = $(CURDIR)/specs/docusign
DOCUSIGN_SPEC = $(DOCUSIGN_SPEC_DIR)/docusign.yaml
Expand Down
18 changes: 12 additions & 6 deletions docusign/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
[package]
name = "docusign"
description = "A fully generated & opinionated API client for the DocuSign API."
version = "0.8.0-rc.2"
version = "0.9.0"
documentation = "https://docs.rs/docusign/"
repository = "https://github.com/oxidecomputer/third-party-api-clients/tree/main/docusign"
readme = "README.md"
edition = "2021"
license = "MIT"

[features]
default = ["rustls-tls"]
default = ["middleware", "rustls-tls"]
# enable etag-based http_cache functionality
httpcache = ["dirs"]
native-tls = ["reqwest/default-tls", "openssl"]
rustls-tls = ["reqwest/rustls-tls", "ring", "pem"]
middleware = [
"reqwest-conditional-middleware",
"reqwest-middleware",
"reqwest-retry",
"reqwest-tracing",
]

[dependencies]
async-recursion = "^1.0"
Expand All @@ -28,10 +34,10 @@ parse_link_header = "0.3.3"
pem = { version = "1.1.0", default-features = false, optional = true }
percent-encoding = "2.2"
reqwest = { version = "0.12", default-features = false, features = ["json", "multipart"] }
reqwest-conditional-middleware = "0.4"
reqwest-middleware = { version = "0.4", features = ["multipart"] }
reqwest-retry = "0.7"
reqwest-tracing = "0.5.4"
reqwest-conditional-middleware = { version = "0.4", optional = true }
reqwest-middleware = { version = "0.4", features = ["multipart"], optional = true }
reqwest-retry = { version = "0.7", optional = true }
reqwest-tracing = { version = "0.5.4", optional = true }
ring = { version = "0.16", default-features = false, optional = true }
schemars = { version = "0.8", features = ["bytes", "chrono", "url", "uuid1"] }
serde = { version = "1", features = ["derive"] }
Expand Down
2 changes: 1 addition & 1 deletion docusign/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To install the library, add the following to your `Cargo.toml` file.

```toml
[dependencies]
docusign = "0.8.0-rc.2"
docusign = "0.9.0"
```

## Basic example
Expand Down
4 changes: 1 addition & 3 deletions docusign/src/account_password_rules.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,7 @@ impl AccountPasswordRules {
pub async fn password_rules_get(
&self,
) -> ClientResult<crate::Response<crate::types::UserPasswordRules>> {
let url = self
.client
.url("/v2.1/current_user/password_rules", None);
let url = self.client.url("/v2.1/current_user/password_rules", None);
self.client
.get(
&url,
Expand Down
4 changes: 1 addition & 3 deletions docusign/src/accounts.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,9 +167,7 @@ impl Accounts {
pub async fn get_provisioning(
&self,
) -> ClientResult<crate::Response<crate::types::ProvisioningInformation>> {
let url = self
.client
.url("/v2.1/accounts/provisioning", None);
let url = self.client.url("/v2.1/accounts/provisioning", None);
self.client
.get(
&url,
Expand Down
8 changes: 2 additions & 6 deletions docusign/src/appliance_info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -868,9 +868,7 @@ impl ApplianceInfo {
*
*/
pub async fn envelope_post_error(&self) -> ClientResult<crate::Response<()>> {
let url = self
.client
.url("/v2.1/display_appliance_info/error", None);
let url = self.client.url("/v2.1/display_appliance_info/error", None);
self.client
.post(
&url,
Expand All @@ -891,9 +889,7 @@ impl ApplianceInfo {
pub async fn envelope_post_redeem(
&self,
) -> ClientResult<crate::Response<crate::types::ApplianceInfo>> {
let url = self
.client
.url("/v2.1/display_appliance_info/redeem", None);
let url = self.client.url("/v2.1/display_appliance_info/redeem", None);
self.client
.post(
&url,
Expand Down
29 changes: 19 additions & 10 deletions docusign/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
//!
//! ```toml
//! [dependencies]
//! docusign = "0.8.0-rc.2"
//! docusign = "0.9.0"
//! ```
//!
//! ## Basic example
Expand Down Expand Up @@ -2227,6 +2227,7 @@
/// Errors returned by reqwest::header
#[error(transparent)]
InvalidHeaderValue(#[from] reqwest::header::InvalidHeaderValue),
#[cfg(feature = "middleware")]
/// Errors returned by reqwest middleware
#[error(transparent)]
ReqwestMiddleWareError(#[from] reqwest_middleware::Error),
Expand Down Expand Up @@ -2297,7 +2298,10 @@
redirect_uri: String,

auto_refresh: bool,
#[cfg(feature = "middleware")]
client: reqwest_middleware::ClientWithMiddleware,
#[cfg(not(feature = "middleware"))]
client: reqwest::Client,
}

use schemars::JsonSchema;
Expand Down Expand Up @@ -2378,15 +2382,20 @@
.build();
match client {
Ok(c) => {
let client = reqwest_middleware::ClientBuilder::new(c)
// Trace HTTP requests. See the tracing crate to make use of these traces.
.with(reqwest_tracing::TracingMiddleware::default())
// Retry failed requests.
.with(reqwest_conditional_middleware::ConditionalMiddleware::new(
reqwest_retry::RetryTransientMiddleware::new_with_policy(retry_policy),
|req: &reqwest::Request| req.try_clone().is_some(),
))
.build();
#[cfg(feature = "middleware")]
let client = {
reqwest_middleware::ClientBuilder::new(c)
// Trace HTTP requests. See the tracing crate to make use of these traces.
.with(reqwest_tracing::TracingMiddleware::default())
// Retry failed requests.
.with(reqwest_conditional_middleware::ConditionalMiddleware::new(
reqwest_retry::RetryTransientMiddleware::new_with_policy(retry_policy),
|req: &reqwest::Request| req.try_clone().is_some(),
))
.build()
};
#[cfg(not(feature = "middleware"))]
let client = c;

let host = RootDefaultServer::default().default_url().to_string();

Expand Down Expand Up @@ -4066,8 +4075,8 @@
///To use an anchoring option:
///
///1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.
///For best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.

Check warning on line 4078 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:4078:8
     |
4078 |     ///For best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number ...
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
4078 |     ///   For best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.
     |        +++
///For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text "BorrowerSignHere" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use "BorrowerSignHere" as the anchor string.

Check warning on line 4079 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:4079:8
     |
4079 |     ///For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur ...
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
4079 |     ///   For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text "BorrowerSignHere" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use "BorrowerSignHere" as the anchor string.
     |        +++
///1. Reference the anchor through the `anchorString` property of the tab.
///1. Determine the offset from the anchor string location to where the tab should be placed.
///
Expand Down Expand Up @@ -4142,7 +4151,7 @@
/// In order to automatically populate both occurrences
/// of the `Name` Text tabs,
/// the `bold` property must be set to the same value for both tabs.
///.

Check warning on line 4154 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:4154:8
     |
4154 |     ///.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
4154 |     ///  .
     |        ++
pub fn envelope_recipient_tabs(&self) -> envelope_recipient_tabs::EnvelopeRecipientTabs {
envelope_recipient_tabs::EnvelopeRecipientTabs::new(self.clone())
}
Expand Down Expand Up @@ -4982,8 +4991,8 @@
///To use an anchoring option:
///
///1. Identify the location in the document by text string. You can use a pre-existing text string or add a new one.
///For best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.

Check warning on line 4994 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:4994:8
     |
4994 |     ///For best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number ...
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
4994 |     ///   For best performance DocuSign recommends using single word anchor strings when possible, especially when there are a large number of pages in the envelope.
     |        +++
///For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text "BorrowerSignHere" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use "BorrowerSignHere" as the anchor string.

Check warning on line 4995 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:4995:8
     |
4995 |     ///For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur ...
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
4995 |     ///   For example, you might want to add a Sign Here tab to the "Borrower's Signature" lines in a document, but that phrase might occur in places in the document where you don't want to tab to appear. In this case, you could add the text "BorrowerSignHere" in white font color (so that isn't visible in the document) to all the places you want Sign Here tabs to appear and use "BorrowerSignHere" as the anchor string.
     |        +++
///1. Reference the anchor through the `anchorString` property of the tab.
///1. Determine the offset from the anchor string location to where the tab should be placed.
///
Expand Down Expand Up @@ -5053,7 +5062,7 @@
/// In order to automatically populate both occurrences
/// of the `Name` Text tabs,
/// the `bold` property must be set to the same value for both tabs.
///.

Check warning on line 5065 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5065:8
     |
5065 |     ///.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5065 |     ///  .
     |        ++
pub fn template_recipient_tabs(&self) -> template_recipient_tabs::TemplateRecipientTabs {
template_recipient_tabs::TemplateRecipientTabs::new(self.clone())
}
Expand Down Expand Up @@ -5159,17 +5168,17 @@
///
///- `PowerForms_Recipient_Denied_Documents`: The recipient is denied access to the documents.
///- `PowerForms_DigitalCerts_Shared_Tabs_Not_Allowed`: Shared tags are not allowed because a digital certificate is required
///for a signer.

Check warning on line 5171 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5171:8
     |
5171 |     ///for a signer.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5171 |     ///  for a signer.
     |        ++
///- `PowerForms_DigitalCerts_Free_Form_Tabs_Not_Allowed`: Signers that are required to use a digital certificate must have at
///least one required, non-conditional signature or initials tab.

Check warning on line 5173 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5173:8
     |
5173 |     ///least one required, non-conditional signature or initials tab.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5173 |     ///  least one required, non-conditional signature or initials tab.
     |        ++
///- `PowerForms_DigitalCerts_Multiple_Recipients_Routing_Order`: Signers that are required to use a digital certificate must be the
///only recipient in a routing order. Edit the routing order or remove the digital certificate requirement.

Check warning on line 5175 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5175:8
     |
5175 |     ///only recipient in a routing order. Edit the routing order or remove the digital certificate requirement.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5175 |     ///  only recipient in a routing order. Edit the routing order or remove the digital certificate requirement.
     |        ++
///- `PowerForms_DigitalCerts_Markup_Not_Allowed`: Document markup is not allowed because a digital certificate is
///required for a signer.

Check warning on line 5177 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5177:8
     |
5177 |     ///required for a signer.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5177 |     ///  required for a signer.
     |        ++
///- `PowerForms_Incomplete_Recipient`: The recipient's username, email, or role is not set.
///- `PowerForms_PowerFormId_Required`: A `powerFormId` is required.
///- `PowerForms_PowerFormId_Mismatch`: A `powerFormId` mismatch has occurred.
///.

Check warning on line 5181 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5181:8
     |
5181 |     ///.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5181 |     ///  .
     |        ++
pub fn power_forms(&self) -> power_forms::PowerForms {
power_forms::PowerForms::new(self.clone())
}
Expand Down Expand Up @@ -5244,7 +5253,7 @@
///- The maximum number of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 10.
///- The maximum total size of all of a member's unexpired, unconsumed ChunkedUploads. The default value is 1 GB.
///- The amount of time that a chunked upload is active after you initialize it. The default value is 20 minutes.
///.

Check warning on line 5256 in docusign/src/lib.rs

View workflow job for this annotation

GitHub Actions / clippy

doc list item without indentation 

warning: doc list item without indentation
    --> docusign/src/lib.rs:5256:8
     |
5256 |     ///.
     |        ^
     |
     = help: if this is supposed to be its own paragraph, add a blank line
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#doc_lazy_continuation
help: indent this line
     |
5256 |     ///  .
     |        ++
pub fn chunked_uploads(&self) -> chunked_uploads::ChunkedUploads {
chunked_uploads::ChunkedUploads::new(self.clone())
}
Expand Down
8 changes: 2 additions & 6 deletions docusign/src/notary.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,7 @@ impl Notary {
&self,
body: &crate::types::NotaryData,
) -> ClientResult<crate::Response<crate::types::NotaryData>> {
let url = self
.client
.url("/v2.1/current_user/notary", None);
let url = self.client.url("/v2.1/current_user/notary", None);
self.client
.put(
&url,
Expand All @@ -83,9 +81,7 @@ impl Notary {
&self,
body: &crate::types::NotaryData,
) -> ClientResult<crate::Response<crate::types::NotaryData>> {
let url = self
.client
.url("/v2.1/current_user/notary", None);
let url = self.client.url("/v2.1/current_user/notary", None);
self.client
.post(
&url,
Expand Down
Loading
Loading