impl "multipart/form-data" support

Cargo.toml

@@ -15,10 +15,10 @@ resolver = "2"
 #[patch."https://github.com/oxidecomputer/dropshot"]
 #dropshot = { path = "../dropshot/dropshot" }
 
-#[patch."https://github.com/oxidecomputer/typify"]
-#typify = { path = "../typify/typify" }
+# [patch."https://github.com/oxidecomputer/typify"]
+# typify = { path = "../typify/typify" }
 
-#[patch.crates-io]
+# [patch.crates-io]
 #serde_tokenstream = { path = "../serde_tokenstream" }
-#typify = { path = "../typify/typify" }
+# typify = { path = "../typify/typify" }
 #rustfmt-wrapper = { path = "../rustfmt-wrapper" }

README.md

@@ -40,7 +40,7 @@ You'll need to add the following to `Cargo.toml`:
 [dependencies]
 futures = "0.3"
 progenitor = { git = "https://github.com/oxidecomputer/progenitor" }
-reqwest = { version = "0.11", features = ["json", "stream"] }
+reqwest = { version = "0.11", features = ["json", "stream", "multipart"] }
 serde = { version = "1.0", features = ["derive"] }
 ```
 
@@ -133,7 +133,7 @@ You'll need to add the following to `Cargo.toml`:
 [dependencies]
 futures = "0.3"
 progenitor-client = { git = "https://github.com/oxidecomputer/progenitor" }
-reqwest = { version = "0.11", features = ["json", "stream"] }
+reqwest = { version = "0.11", features = ["json", "stream","multipart"] }
 serde = { version = "1.0", features = ["derive"] }
 
 [build-dependencies]
@@ -199,7 +199,7 @@ bytes = "1.3.0"
 chrono = { version = "0.4.23", default-features=false, features = ["serde"] }
 futures-core = "0.3.25"
 percent-encoding = "2.2.0"
-reqwest = { version = "0.11.13", default-features=false, features = ["json", "stream"] }
+reqwest = { version = "0.11.13", default-features=false, features = ["json", "stream", "multipart"] }
 serde = { version = "1.0.152", features = ["derive"] }
 serde_urlencoded = "0.7.1"
 ```

cargo-progenitor/src/main.rs

@@ -1,5 +1,12 @@
 // Copyright 2023 Oxide Computer Company
 
+//! The cargo tool to generate a rust representation of an OpenAPI spec.
+
+#![deny(missing_docs)]
+#![deny(unused_crate_dependencies)]
+#![deny(unused_imports)]
+#![deny(unused_import_braces)]
+
 use std::{
     collections::HashMap,
     fs::{File, OpenOptions},
@@ -13,6 +20,7 @@ use openapiv3::OpenAPI;
 use progenitor::{GenerationSettings, Generator, InterfaceStyle, TagStyle};
 use progenitor_impl::space_out_items;
 
+/// Include the artifact created by `build.rs`.
 pub mod built_info {
     // The file has been placed there by the build script.
     include!(concat!(env!("OUT_DIR"), "/built.rs"));
@@ -225,6 +233,7 @@ fn main() -> Result<()> {
     Ok(())
 }
 
+/// List of dependencies required when including the generated code.
 pub fn dependencies(builder: Generator, include_client: bool) -> Vec<String> {
     let dependency_versions: HashMap<String, String> = built_info::DEPENDENCIES
         .iter()
@@ -234,7 +243,7 @@ pub fn dependencies(builder: Generator, include_client: bool) -> Vec<String> {
     let mut deps = vec![
         format!("bytes = \"{}\"", dependency_versions.get("bytes").unwrap()),
         format!("futures-core = \"{}\"", dependency_versions.get("futures-core").unwrap()),
-        format!("reqwest = {{ version = \"{}\", default-features=false, features = [\"json\", \"stream\"] }}", dependency_versions.get("reqwest").unwrap()),
+        format!("reqwest = {{ version = \"{}\", default-features=false, features = [\"json\", \"stream\", \"multipart\"] }}", dependency_versions.get("reqwest").unwrap()),
         format!("serde = {{ version = \"{}\", features = [\"derive\"] }}", dependency_versions.get("serde").unwrap()),
         format!("serde_urlencoded = \"{}\"", dependency_versions.get("serde_urlencoded").unwrap()),
     ];

example-build/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 [dependencies]
 chrono = { version = "0.4", features = ["serde"] }
 progenitor-client = { path = "../progenitor-client" }
-reqwest = { version = "0.11.27", features = ["json", "stream"] }
+reqwest = { version = "0.11.27", features = ["json", "stream", "multipart"] }
 base64 = "0.22"
 rand = "0.8"
 serde = { version = "1.0", features = ["derive"] }

example-macro/Cargo.toml

@@ -5,9 +5,10 @@ authors = ["Adam H. Leventhal <[email protected]>"]
 edition = "2021"
 
 [dependencies]
+
+serde = { version = "1.0", features = ["derive"] }
 chrono = { version = "0.4", features = ["serde"] }
 progenitor = { path = "../progenitor" }
-reqwest = { version = "0.11.27", features = ["json", "stream"] }
+reqwest = { version = "0.11.27", features = ["json", "stream", "multipart"] }
 schemars = { version = "0.8.16", features = ["uuid1"] }
-serde = { version = "1.0", features = ["derive"] }
 uuid = { version = "1.8", features = ["serde", "v4"] }

progenitor-client/Cargo.toml

@@ -10,7 +10,7 @@ description = "An OpenAPI client generator - client support"
 bytes = "1.6.0"
 futures-core = "0.3.30"
 percent-encoding = "2.3"
-reqwest = { version = "0.11.27", default-features = false, features = ["json", "stream"] }
+reqwest = { version = "0.11.27", default-features = false, features = ["json", "stream", "multipart"] }
 serde = "1.0"
 serde_json = "1.0"
 serde_urlencoded = "0.7.1"

progenitor-client/src/lib.rs

@@ -3,6 +3,9 @@
 //! Support for generated clients.
 
 #![deny(missing_docs)]
+#![deny(unused_crate_dependencies)]
+#![deny(unused_imports)]
+#![deny(unused_import_braces)]
 
 mod progenitor_client;
 

progenitor-client/src/progenitor_client.rs

@@ -8,7 +8,7 @@ use std::ops::{Deref, DerefMut};
 
 use bytes::Bytes;
 use futures_core::Stream;
-use reqwest::RequestBuilder;
+use reqwest::{multipart::Part, RequestBuilder};
 use serde::{de::DeserializeOwned, Serialize};
 
 #[cfg(not(target_arch = "wasm32"))]
@@ -421,11 +421,23 @@ pub fn encode_path(pc: &str) -> String {
 }
 
 #[doc(hidden)]
-pub trait RequestBuilderExt<E> {
+pub trait RequestBuilderExt<E>
+where
+    Self: Sized,
+{
     fn form_urlencoded<T: Serialize + ?Sized>(
         self,
         body: &T,
     ) -> Result<RequestBuilder, Error<E>>;
+
+    fn form_from_raw<
+        S: AsRef<str>,
+        T: AsRef<[u8]>,
+        I: Sized + IntoIterator<Item = (S, T)>,
+    >(
+        self,
+        iter: I,
+    ) -> Result<Self, Error<E>>;
 }
 
 impl<E> RequestBuilderExt<E> for RequestBuilder {
@@ -440,8 +452,37 @@ impl<E> RequestBuilderExt<E> for RequestBuilder {
                     "application/x-www-form-urlencoded",
                 ),
             )
-            .body(serde_urlencoded::to_string(body).map_err(|_| {
-                Error::InvalidRequest("failed to serialize body".to_string())
+            .body(serde_urlencoded::to_string(body).map_err(|e| {
+                Error::InvalidRequest(format!(
+                    "failed to serialize body: {e:?}"
+                ))
             })?))
     }
+
+    fn form_from_raw<
+        S: AsRef<str>,
+        T: AsRef<[u8]>,
+        I: Sized + IntoIterator<Item = (S, T)>,
+    >(
+        self,
+        iter: I,
+    ) -> Result<Self, Error<E>> {
+        use reqwest::multipart::Form;
+
+        let mut form = Form::new();
+        for (name, value) in iter {
+            form = form.part(
+                name.as_ref().to_owned(),
+                Part::stream(Vec::from(value.as_ref())),
+            );
+        }
+        Ok(self
+            .header(
+                reqwest::header::CONTENT_TYPE,
+                reqwest::header::HeaderValue::from_static(
+                    "multipart/form-data",
+                ),
+            )
+            .multipart(form))
+    }
 }

progenitor-impl/Cargo.toml

@@ -10,7 +10,6 @@ readme = "../README.md"
 [dependencies]
 heck = "0.5.0"
 http = "0.2.9"
-getopts = "0.2"
 indexmap = "2.2.6"
 openapiv3 = "2.0.0"
 proc-macro2 = "1.0"

progenitor-impl/src/cli.rs

@@ -470,7 +470,8 @@ impl Generator {
                 // are currently...
                 OperationParameterType::RawBody => None,
 
-                OperationParameterType::Type(body_type_id) => {
+                OperationParameterType::Type(body_type_id)
+                | OperationParameterType::Form(body_type_id) => {
                     Some(body_type_id)
                 }
             });

progenitor-impl/src/httpmock.rs

@@ -164,7 +164,8 @@ impl Generator {
                  name, typ, kind, ..
              }| {
                 let arg_type_name = match typ {
-                    OperationParameterType::Type(arg_type_id) => self
+                    OperationParameterType::Type(arg_type_id)
+                    | OperationParameterType::Form(arg_type_id) => self
                         .type_space
                         .get_type(arg_type_id)
                         .unwrap()
@@ -245,9 +246,9 @@ impl Generator {
                     OperationParameterKind::Header(_) => quote! { todo!() },
                     OperationParameterKind::Body(body_content_type) => {
                         match typ {
-                            OperationParameterType::Type(_) => quote! {
+                            OperationParameterType::Type(_)
+                            | OperationParameterType::Form(_) => quote! {
                                 Self(self.0.json_body_obj(value))
-
                             },
                             OperationParameterType::RawBody => {
                                 match body_content_type {

progenitor-impl/src/lib.rs

@@ -3,14 +3,19 @@
 //! Core implementation for the progenitor OpenAPI client generator.
 
 #![deny(missing_docs)]
+#![cfg_attr(not(test), deny(unused_crate_dependencies))]
+#![deny(unused_import_braces)]
+#![deny(unused_imports)]
 
 use std::collections::{BTreeMap, HashMap, HashSet};
 
+use indexmap::IndexSet;
 use openapiv3::OpenAPI;
 use proc_macro2::TokenStream;
 use quote::quote;
 use serde::Deserialize;
 use thiserror::Error;
+use typify::{TypeDetails, TypeId};
 use typify::{TypeSpace, TypeSpaceSettings};
 
 use crate::to_schema::ToSchema;
@@ -48,6 +53,7 @@ pub type Result<T> = std::result::Result<T, Error>;
 /// OpenAPI generator.
 pub struct Generator {
     type_space: TypeSpace,
+    forms: IndexSet<TypeId>,
     settings: GenerationSettings,
     uses_futures: bool,
     uses_websockets: bool,
@@ -198,6 +204,7 @@ impl Default for Generator {
             type_space: TypeSpace::new(
                 TypeSpaceSettings::default().with_type_mod("types"),
             ),
+            forms: Default::default(),
             settings: Default::default(),
             uses_futures: Default::default(),
             uses_websockets: Default::default(),
@@ -240,6 +247,7 @@ impl Generator {
         Self {
             type_space: TypeSpace::new(&type_settings),
             settings: settings.clone(),
+            forms: Default::default(),
             uses_futures: false,
             uses_websockets: false,
         }
@@ -304,6 +312,42 @@ impl Generator {
 
         let types = self.type_space.to_stream();
 
+        let extra_impl = TokenStream::from_iter(
+            self.forms
+                .iter()
+                .map(|type_id| {
+                    let typ = self.get_type_space().get_type(type_id).unwrap();
+                    let td = typ.details();
+                    let TypeDetails::Struct(tstru) = td else { unreachable!() };
+                    let properties = indexmap::IndexMap::<&'_ str, _>::from_iter(
+                        tstru
+                            .properties()
+                            .filter_map(|(prop_name, prop_id)| {
+                                self.get_type_space()
+                                    .get_type(&prop_id).ok()
+                                    .map(|prop_typ| (prop_name, prop_typ))
+                            })
+                        );
+                    let properties = syn::punctuated::Punctuated::<_, syn::Token![,]>::from_iter(
+                        properties
+                            .into_iter()
+                            .map(|(prop_name, _prop_ty)| {
+                                let ident = quote::format_ident!("{}", prop_name);
+                                quote!{ (#prop_name, &self. #ident) }
+                            }));
+
+                    let form_name = quote::format_ident!("{}",typ.name());
+
+                    quote! {
+                        impl #form_name {
+                            pub fn as_form<'f>(&'f self) -> impl std::iter::Iterator<Item=(&'static str, &'f [u8])> {
+                                [#properties]
+                                    .into_iter()
+                                    .filter_map(|(name, val)| val.as_ref().map(|val| (name, val.as_bytes())))
+                            }
+                        }
+                    }
+                }));
         // Generate an implementation of a `Self::as_inner` method, if an inner
         // type is defined.
         let maybe_inner = self.settings.inner_type.as_ref().map(|inner| {
@@ -332,20 +376,20 @@ impl Generator {
         });
 
         let client_docstring = {
-            let mut s = format!("Client for {}", spec.info.title);
+            let mut doc = format!("Client for {}", spec.info.title);
 
-            if let Some(ss) = &spec.info.description {
-                s.push_str("\n\n");
-                s.push_str(ss);
+            if let Some(desc) = &spec.info.description {
+                doc.push_str("\n\n");
+                doc.push_str(desc);
             }
-            if let Some(ss) = &spec.info.terms_of_service {
-                s.push_str("\n\n");
-                s.push_str(ss);
+            if let Some(tos) = &spec.info.terms_of_service {
+                doc.push_str("\n\n");
+                doc.push_str(tos);
             }
 
-            s.push_str(&format!("\n\nVersion: {}", &spec.info.version));
+            doc.push_str(&format!("\n\nVersion: {}", &spec.info.version));
 
-            s
+            doc
         };
 
         let version_str = &spec.info.version;
@@ -373,6 +417,8 @@ impl Generator {
                 use std::convert::TryFrom;
 
                 #types
+
+                #extra_impl
             }
 
             #[derive(Clone, Debug)]