Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 21 additions & 9 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@ repository = "https://github.com/kilork/keycloak"
rust-version = "1.87"

[features]
default = ["tags-all", "resource-builder"]
default = ["tags-all", "resource-builder", "reqwest"]
resource-builder = ["builder", "resource"]
schemars = ["dep:schemars"]
multipart = ["reqwest/multipart"]
multipart = ["reqwest12?/multipart", "reqwest13?/multipart"]
reqwest = ["reqwest13"]
reqwest12 = ["dep:reqwest12"]
reqwest13 = ["dep:reqwest13"]
rc = ["rc-map", "rc-str", "rc-val", "rc-vec"]
rc-map = ["serde/rc"]
rc-str = ["serde/rc"]
Expand Down Expand Up @@ -50,20 +53,29 @@ resource = []
builder = []

[dependencies]
reqwest = { version = "0.12", default-features = false, features = ["json"] }
reqwest12 = { package = "reqwest", version = "0.12", default-features = false, features = [
"json",
], optional = true }
reqwest13 = { package = "reqwest", version = "0.13", default-features = false, features = [
"form",
"json",
"query",
], optional = true }
serde_json = "1"
serde = { version = "1", features = ["derive"] }
serde_with = { version = "3", default-features = false, features = ["macros"] }
async-trait = "0.1"
schemars = { version = "0.8.11", default-features = false, features = [
"derive",
], optional = true }
percent-encoding = "2.3.1"
schemars = { version = "0.8.22", optional = true, default-features = false, features = [ "derive" ] }
percent-encoding = "2.3.2"

[dev-dependencies]
tokio = { version = "1", features = ["full"] }
heck = "0.5"
clap = { version = "4", features = ["derive", "help", "std"], default-features = false }
toml = "0.8"
clap = { version = "4", features = [
"derive",
"help",
"std",
], default-features = false }
toml = "0.9.11"
serde = { version = "1", features = ["derive", "rc"] }
indexmap = { version = "2", features = ["serde"] }
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@ Implements [Keycloak Admin REST API version 26.4.0](https://www.keycloak.org/doc

### Feature flags

Default flags: `tags-all`.
Default flags: `tags-all`, `resource-builder`, `reqwest`.

- `rc`: use `Arc` for deserialization.
- `schemars`: add [schemars](https://crates.io/crates/schemars) support.
- `multipart`: add multipart support to reqwest, enabling extra methods in API.
- `tags-all`: activate all tags (resource groups) in REST API, it is default behavior. Disable default features and use individual `tag-xxx` features to activate only required resource groups. For a full list reference the [Cargo.toml](Cargo.toml).
- `resource-builder`: add resource builder support.
- `reqwest`: use up to date [reqwest](https://crates.io/crates/reqwest) version (`reqwest 0.13.x`).
- `reqwest12`: use `reqwest 0.12.x`.
- `reqwest13`: use `reqwest 0.13.x`.

## Usage

Expand Down
1 change: 1 addition & 0 deletions examples/adduser.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
use keycloak::{
prelude::reqwest,
types::*,
{KeycloakAdmin, KeycloakAdminToken},
};
Expand Down
5 changes: 4 additions & 1 deletion examples/importconfig.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
async fn main() -> Result<(), Box<dyn std::error::Error>> {
#[cfg(feature = "multipart")]
{
use keycloak::{KeycloakAdmin, KeycloakAdminToken};
use keycloak::{
prelude::reqwest,
{KeycloakAdmin, KeycloakAdminToken},
};

let url = std::env::var("KEYCLOAK_ADDR").unwrap_or_else(|_| "http://localhost:8080".into());
let user = std::env::var("KEYCLOAK_USER").unwrap_or_else(|_| "admin".into());
Expand Down
2 changes: 2 additions & 0 deletions examples/openapi.rs
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,8 @@ mod openapi {
use indexmap::IndexMap;
use serde::Deserialize;

use keycloak::prelude::reqwest;

use crate::{RESERVED_WORDS, TAG_NONE};

#[derive(Debug, PartialEq, Eq)]
Expand Down
2 changes: 1 addition & 1 deletion examples/resource_adduser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ fn main() {}
#[cfg(all(feature = "builder", feature = "resource"))]
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
use keycloak::{types::*, KeycloakAdmin, KeycloakAdminToken};
use keycloak::{prelude::reqwest, types::*, KeycloakAdmin, KeycloakAdminToken};

const REALM: &str = "resource";

Expand Down
4 changes: 4 additions & 0 deletions rust-toolchain.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[toolchain]
channel = "1.87"
profile = "minimal"
components = [ "rustfmt", "clippy", "rust-analyzer" ]
2 changes: 2 additions & 0 deletions src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ use std::{borrow::Cow, error::Error, fmt::Display};

use serde::{Deserialize, Serialize};

use crate::prelude::reqwest;

#[derive(Debug)]
pub enum KeycloakError {
ReqwestFailure(reqwest::Error),
Expand Down
7 changes: 6 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ keycloak = "~26.4"
```rust, no_run
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
use keycloak::{types::*, KeycloakAdmin, KeycloakAdminToken};
use keycloak::{
prelude::reqwest,
types::*,
{KeycloakAdmin, KeycloakAdminToken},
};

const REALM: &str = "resource";

Expand Down Expand Up @@ -110,6 +114,7 @@ pub mod resource;
pub mod types;

mod error;
pub mod prelude;
mod rest;

pub use error::KeycloakError;
Expand Down
6 changes: 6 additions & 0 deletions src/prelude.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
#[cfg(all(feature = "reqwest12", not(feature = "reqwest13")))]
pub use reqwest12 as reqwest;
#[cfg(all(feature = "reqwest12", feature = "reqwest13"))]
pub use reqwest13 as reqwest;
#[cfg(all(feature = "reqwest13", not(feature = "reqwest12")))]
pub use reqwest13 as reqwest;
2 changes: 1 addition & 1 deletion src/rest/default_response.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use reqwest::Response;
use crate::prelude::reqwest::{self, Response};

/// Default adapter around [Response].
pub struct DefaultResponse(Response);
Expand Down
2 changes: 1 addition & 1 deletion src/rest/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use std::future::Future;
use async_trait::async_trait;
use serde::{Deserialize, Serialize};

use crate::{types::*, KeycloakError};
use crate::{prelude::reqwest, types::*, KeycloakError};

mod default_response;
mod generated_rest;
Expand Down
5 changes: 4 additions & 1 deletion templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,16 @@ Implements [Keycloak Admin REST API version {{ env_var "KEYCLOAK_VERSION" }}](ht

### Feature flags

Default flags: `tags-all`.
Default flags: `tags-all`, `resource-builder`, `reqwest`.

- `rc`: use `Arc` for deserialization.
- `schemars`: add [schemars](https://crates.io/crates/schemars) support.
- `multipart`: add multipart support to reqwest, enabling extra methods in API.
- `tags-all`: activate all tags (resource groups) in REST API, it is default behavior. Disable default features and use individual `tag-xxx` features to activate only required resource groups. For a full list reference the [Cargo.toml](Cargo.toml).
- `resource-builder`: add resource builder support.
- `reqwest`: use up to date [reqwest](https://crates.io/crates/reqwest) version (`reqwest 0.13.x`).
- `reqwest12`: use `reqwest 0.12.x`.
- `reqwest13`: use `reqwest 0.13.x`.

## Usage

Expand Down
1 change: 1 addition & 0 deletions templates/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ pub mod resource;
pub mod types;

mod error;
pub mod prelude;
mod rest;

pub use error::KeycloakError;
Expand Down