1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
#![forbid(unsafe_code)]
//! # z_osmf
//!
//! The VERY work in progress Rust z/OSMF<sup>TM</sup> [^1] Client.
//!
//! ---
//!
//! [^1]: z/OSMF<sup>TM</sup>, z/OS<sup>TM</sup>, and the lowercase letter z<sup>TM</sup> (probably) are trademarks owned by International Business Machines Corporation ("IBM").
//! This crate is not approved, endorsed, acknowledged, or even tolerated by IBM.
//! (Please don't sue me, Big Blue)
pub use bytes::Bytes;
#[cfg(feature = "datasets")]
pub mod datasets;
pub mod error;
#[cfg(feature = "files")]
pub mod files;
#[cfg(feature = "jobs")]
pub mod jobs;
mod convert;
mod utils;
use std::sync::Arc;
#[cfg(feature = "datasets")]
use self::datasets::DatasetsClient;
use self::error::Error;
#[cfg(feature = "files")]
use self::files::FilesClient;
#[cfg(feature = "jobs")]
use self::jobs::JobsClient;
/// # ZOsmf
///
/// Client for interacting with z/OSMF.
///
/// ```
/// # async fn example() -> anyhow::Result<()> {
/// # use z_osmf::ZOsmf;
/// let client_builder = reqwest::ClientBuilder::new();
/// let base_url = "https://zosmf.mainframe.my-company.com";
/// let username = "USERNAME";
///
/// let zosmf = ZOsmf::new(client_builder, base_url)?;
/// zosmf.login(username, "PASSWORD").await?;
///
/// let my_datasets = zosmf.datasets().list(username).build().await?;
///
/// for dataset in my_datasets.items().iter() {
/// println!("{:?}", dataset);
/// }
/// # Ok(())
/// # }
/// ```
#[derive(Clone, Debug)]
pub struct ZOsmf {
base_url: Arc<str>,
client: reqwest::Client,
}
impl ZOsmf {
/// Create a new z/OSMF client.
///
/// # Example
/// ```
/// # async fn example() -> anyhow::Result<()> {
/// # use z_osmf::ZOsmf;
/// let client_builder = reqwest::ClientBuilder::new();
/// let base_url = "https://zosmf.mainframe.my-company.com";
///
/// let zosmf = ZOsmf::new(client_builder, base_url)?;
/// # Ok(())
/// # }
/// ```
pub fn new<B>(client_builder: reqwest::ClientBuilder, base_url: B) -> Result<Self, Error>
where
B: std::fmt::Display,
{
let base_url: Arc<str> = format!("{}", base_url)
.trim_end_matches('/')
.to_string()
.into();
let client = client_builder.cookie_store(true).build()?;
Ok(ZOsmf { base_url, client })
}
/// Authenticate with z/OSMF.
///
/// # Example
/// ```
/// # async fn example(zosmf: z_osmf::ZOsmf) -> anyhow::Result<()> {
/// zosmf.login("USERNAME", "PASSWORD").await?;
/// # Ok(())
/// # }
/// ```
pub async fn login<U, P>(&self, username: U, password: P) -> Result<(), Error>
where
U: std::fmt::Display,
P: std::fmt::Display,
{
self.client
.post(format!("{}/zosmf/services/authenticate", self.base_url))
.basic_auth(username, Some(password))
.send()
.await?
.error_for_status()?;
Ok(())
}
/// Logout of z/OSMF.
///
/// <p style="background:rgba(255,181,77,0.16);padding:0.75em;">
/// <strong>Warning:</strong> Logging out before an action has completed,
/// like immediately after submitting a job, can cause the action to fail.
/// </p>
///
/// # Example
/// ```
/// # async fn example(zosmf: z_osmf::ZOsmf) -> anyhow::Result<()> {
/// zosmf.logout().await?;
/// # Ok(())
/// # }
/// ```
pub async fn logout(&self) -> Result<(), Error> {
self.client
.delete(format!("{}/zosmf/services/authenticate", self.base_url))
.send()
.await?
.error_for_status()?;
Ok(())
}
/// Create a [DatasetsClient] for working with datasets via z/OSMF.
///
/// # Example
/// ```
/// # async fn example(zosmf: z_osmf::ZOsmf) -> anyhow::Result<()> {
/// let dataset_client = zosmf.datasets();
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "datasets")]
pub fn datasets(&self) -> DatasetsClient {
DatasetsClient::new(self.base_url.clone(), self.client.clone())
}
/// Create a [FilesClient] for working with files via z/OSMF.
///
/// # Example
/// ```
/// # async fn example(zosmf: z_osmf::ZOsmf) -> anyhow::Result<()> {
/// let files_client = zosmf.files();
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "files")]
pub fn files(&self) -> FilesClient {
FilesClient::new(self.base_url.clone(), self.client.clone())
}
/// Create a [JobsClient] for working with jobs via z/OSMF.
///
/// # Example
/// ```
/// # async fn example(zosmf: z_osmf::ZOsmf) -> anyhow::Result<()> {
/// let jobs_client = zosmf.jobs();
/// # Ok(())
/// # }
/// ```
#[cfg(feature = "jobs")]
pub fn jobs(&self) -> JobsClient {
JobsClient::new(self.base_url.clone(), self.client.clone())
}
}
#[cfg(test)]
mod tests {
use super::*;
pub(crate) fn get_zosmf() -> ZOsmf {
ZOsmf::new(reqwest::Client::builder(), "https://test.com").unwrap()
}
pub(crate) trait GetJson {
fn json(&self) -> Option<serde_json::Value>;
}
impl GetJson for reqwest::Request {
fn json(&self) -> Option<serde_json::Value> {
Some(
serde_json::from_slice(self.body()?.as_bytes()?)
.expect("failed to deserialize JSON"),
)
}
}
}