Add documentation for remaining public api (#26)

README.md

@@ -14,7 +14,7 @@ Full documentation can be found at [https://docs.rs/unkey](https://docs.rs/unkey
 
 ## Setup
 
-Add the following to your `Cargo.toml` [dependencies]
+Add the following to your `Cargo.toml` dependencies array:
 
 ```toml
 unkey = "0.1"
@@ -24,12 +24,11 @@ unkey = "0.1"
 
 ### Verifying a key
 
-```rs
+```rust
 use unkey::models::{VerifyKeyRequest, Wrapped};
 use unkey::Client;
 
-#[tokio::main]
-async fn main() {
+async fn verify_key() {
     let c = Client::new("unkey_ABC");
     let req = VerifyKeyRequest::new("test_DEF");
 
@@ -42,12 +41,11 @@ async fn main() {
 
 ### Creating a key
 
-```rs
+```rust
 use unkey::models::{CreateKeyRequest, Wrapped};
 use unkey::Client;
 
-#[tokio::main]
-async fn main() {
+async fn create_key()-> Result<(), ()> {
     let c = Client::new("unkey_ABC");
     let req = CreateKeyRequest::new("api_123")
         .set_prefix("test")
@@ -59,17 +57,18 @@ async fn main() {
         Wrapped::Ok(res) => println!("{res:?}"),
         Wrapped::Err(err) => eprintln!("{err:?}"),
     }
+
+    Ok(())
 }
 ```
 
 ### Updating a key
 
-```rs
+```rust
 use unkey::models::{UpdateKeyRequest, Wrapped};
 use unkey::Client;
 
-#[tokio::main]
-async fn main() {
+async fn update_key() {
     let c = Client::new("unkey_ABC");
     let req = UpdateKeyRequest::new("key_XYZ")
         .set_name(Some("new_name")) // Update the keys name
@@ -84,12 +83,11 @@ async fn main() {
 
 ### Revoking a key
 
-```rs
+```rust
 use unkey::models::{RevokeKeyRequest, Wrapped};
 use unkey::Client;
 
-#[tokio::main]
-async fn main() {
+async fn revoke_key() {
     let c = Client::new("unkey_ABC");
     let req = RevokeKeyRequest::new("key_XYZ");
 
@@ -102,12 +100,11 @@ async fn main() {
 
 ### Listing api keys
 
-```rs
+```rust
 use unkey::models::{ListKeysRequest, Wrapped};
 use unkey::Client;
 
-#[tokio::main]
-async fn main() {
+async fn list_keys() {
     let c = Client::new("unkey_ABC");
     let req = ListKeysRequest::new("api_123");
 
@@ -120,12 +117,11 @@ async fn main() {
 
 ### Getting api information
 
-```rs
+```rust
 use unkey::models::{GetApiRequest, Wrapped};
 use unkey::Client;
 
-#[tokio::main]
-async fn main() {
+async fn get_api() {
     let c = Client::new("unkey_ABC");
     let req = GetApiRequest::new("api_123");
 

src/lib.rs

@@ -5,7 +5,6 @@ mod logging;
 pub mod models;
 mod routes;
 mod services;
-pub mod undefined;
 
 use serde::Deserialize;
 

src/logging.rs

@@ -1,5 +1,5 @@
 lazy_static::lazy_static! {
-    /// An evenironment variable containing the log level env var.
+    /// An environment variable containing the log level env var.
     pub(crate) static ref UNKEY_LOG: Log = match option_env!("UNKEY_LOG") {
         None => Log::None,
         Some(level) => match level {
@@ -14,6 +14,7 @@ lazy_static::lazy_static! {
     };
 }
 
+/// The different logging levels supported by the crate.
 #[derive(Eq, PartialEq, PartialOrd)]
 pub(crate) enum Log {
     None,
@@ -48,6 +49,7 @@ impl std::fmt::Display for Log {
     }
 }
 
+/// Logs the given message at the given level.
 macro_rules! log {
     ($level:expr, $message:expr) => {
         if *$crate::logging::UNKEY_LOG >= $level {
@@ -62,18 +64,21 @@ macro_rules! log {
     };
 }
 
+/// Logs the given message at the debug level.
 macro_rules! debug {
     ($message:expr) => {
         $crate::logging::log!($crate::logging::Log::Debug, $message)
     };
 }
 
+/// Logs the given message at the infomation level.
 macro_rules! info {
     ($message:expr) => {
         $crate::logging::log!($crate::logging::Log::Info, $message)
     };
 }
 
+/// Logs the given message at the error level.
 macro_rules! error {
     ($message:expr) => {
         $crate::logging::log!($crate::logging::Log::Error, $message)

src/models/keys.rs

@@ -5,7 +5,7 @@ use serde_json::Value;
 
 use super::Ratelimit;
 use super::RatelimitState;
-use crate::undefined::UndefinedOr;
+use super::UndefinedOr;
 
 /// An outgoing verify key request.
 #[derive(Debug, Clone, Serialize)]
@@ -463,7 +463,7 @@ impl UpdateKeyRequest {
     /// # Example
     /// ```
     /// # use unkey::models::UpdateKeyRequest;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let r = UpdateKeyRequest::new("test_123");
     ///
     /// assert_eq!(r.key_id, String::from("test_123"));
@@ -493,7 +493,7 @@ impl UpdateKeyRequest {
     /// # Example
     /// ```
     /// # use unkey::models::UpdateKeyRequest;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let r = UpdateKeyRequest::new("test");
     ///
     /// assert_eq!(r.owner_id, UndefinedOr::Undefined);
@@ -530,7 +530,7 @@ impl UpdateKeyRequest {
     /// # Example
     /// ```
     /// # use unkey::models::UpdateKeyRequest;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let r = UpdateKeyRequest::new("test");
     ///
     /// assert_eq!(r.name, UndefinedOr::Undefined);
@@ -567,7 +567,7 @@ impl UpdateKeyRequest {
     /// # Example
     /// ```
     /// # use unkey::models::UpdateKeyRequest;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// # use serde_json::json;
     /// let r = UpdateKeyRequest::new("test");
     ///
@@ -605,7 +605,7 @@ impl UpdateKeyRequest {
     /// # Example
     /// ```
     /// # use unkey::models::UpdateKeyRequest;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let r = UpdateKeyRequest::new("test");
     ///
     /// assert_eq!(r.expires, UndefinedOr::Undefined);
@@ -638,7 +638,7 @@ impl UpdateKeyRequest {
     /// # Example
     /// ```
     /// # use unkey::models::UpdateKeyRequest;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let r = UpdateKeyRequest::new("test");
     ///
     /// assert_eq!(r.remaining, UndefinedOr::Undefined);
@@ -673,7 +673,7 @@ impl UpdateKeyRequest {
     /// # use unkey::models::UpdateKeyRequest;
     /// # use unkey::models::Ratelimit;
     /// # use unkey::models::RatelimitType;
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let r = UpdateKeyRequest::new("test");
     ///
     /// assert_eq!(r.ratelimit, UndefinedOr::Undefined);

src/models/mod.rs

@@ -1,9 +1,17 @@
+//! This module houses the types you will be dealing with when sending and
+//! receiving requests from unkey.
+//!
+//! Mostly you will be constructing the structs suffixed with `Request`, and
+//! receiving the structs suffixed with `Response`. With some minor exceptions
+//! like [`Wrapped`] and [`UndefinedOr`].
 mod apis;
 mod http;
 mod keys;
 mod ratelimit;
+mod undefined;
 
 pub use apis::*;
 pub use http::*;
 pub use keys::*;
 pub use ratelimit::*;
+pub use undefined::*;

src/undefined.rs → src/models/undefined.rs

@@ -21,7 +21,7 @@ impl<T> UndefinedOr<T> {
     ///
     /// # Example
     /// ```
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let val = UndefinedOr::Value(0);
     ///
     /// assert!(val.is_some());
@@ -34,7 +34,7 @@ impl<T> UndefinedOr<T> {
     ///
     /// # Example
     /// ```
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let val = UndefinedOr::<u8>::Undefined;
     ///
     /// assert!(val.is_undefined());
@@ -47,7 +47,7 @@ impl<T> UndefinedOr<T> {
     ///
     /// # Example
     /// ```
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let val = UndefinedOr::<u8>::Null;
     ///
     /// assert!(val.is_null());
@@ -60,7 +60,7 @@ impl<T> UndefinedOr<T> {
     ///
     /// # Example
     /// ```
-    /// # use unkey::undefined::UndefinedOr;
+    /// # use unkey::models::UndefinedOr;
     /// let val = UndefinedOr::Value(420);
     ///
     /// assert_eq!(val.inner(), Some(&420));
@@ -113,7 +113,7 @@ impl<T> From<Option<T>> for UndefinedOr<T> {
 mod test {
     use serde::Serialize;
 
-    use crate::undefined::UndefinedOr;
+    use crate::models::UndefinedOr;
 
     #[derive(Serialize)]
     struct TestStruct {