basic endpoint trait

.gitignore

@@ -12,3 +12,6 @@ Cargo.lock
 
 # MSVC Windows builds of rustc generate these, which store debugging information
 *.pdb
+
+# Project specific ignores
+.env

Cargo.toml

@@ -6,3 +6,15 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
+derive_builder = "~0.12"
+reqwest = { version = "~0.11.19", features = [
+  "blocking",
+  "json",
+], default-features = false, optional = true }
+thiserror = { version = "^1.0.2", optional = true }
+http = "~0.2"
+serde = { version = "~1.0.103", features = ["derive"] }
+serde_json = "^1.0.25"
+serde_urlencoded = "~0.7"
+url = "^2.1"
+dotenvy = "0.15.7"

src/api.rs

@@ -0,0 +1,4 @@
+mod endpoint;
+mod error;
+
+pub use self::error::BodyError;

src/api/endpoint.rs

@@ -0,0 +1,27 @@
+// Licensed under the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>.
+// This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use std::borrow::Cow;
+
+use http::{self, header, Method, Request};
+
+use crate::api::BodyError;
+
+pub trait Endpoint {
+    /// The HTTP method to use for the endpoint.
+    fn method(&self) -> Method;
+    /// The path to the endpoint.
+    fn endpoint(&self) -> Cow<'static, str>;
+
+    /// The body for the endpoint.
+    ///
+    /// Returns the `Content-Encoding` header for the data as well as the data itself.
+    ///
+    /// # Errors
+    /// This method returns an error if the body could not be serialized to JSON.
+    fn body(&self) -> Result<Option<(&'static str, Vec<u8>)>, BodyError> {
+        Ok(None)
+    }
+}

src/api/error.rs

@@ -0,0 +1,19 @@
+// Licensed under the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>.
+// This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use thiserror::Error;
+
+/// Errors which may occur when creating form data.
+#[derive(Debug, Error)]
+#[non_exhaustive]
+pub enum BodyError {
+    /// Body data could not be serialized from form parameters.
+    #[error("failed to URL encode form parameters: {}", source)]
+    UrlEncoded {
+        /// The source of the error.
+        #[from]
+        source: serde_urlencoded::ser::Error,
+    },
+}

src/lib.rs

@@ -1,14 +1,2 @@
-pub fn add(left: usize, right: usize) -> usize {
-    left + right
-}
+pub mod api;
 
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn it_works() {
-        let result = add(2, 2);
-        assert_eq!(result, 4);
-    }
-}