Add support for multipart/form-data bodies

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 - Structured bodies can now be defined with tags on the `body` field of a recipe, making it more convenient to construct bodies of common types. Supported types are:
   - `!json` [#242](https://github.com/LucasPickering/slumber/issues/242)
   - `!form_urlencoded` [#244](https://github.com/LucasPickering/slumber/issues/244)
+  - `!form_multipart` [#243](https://github.com/LucasPickering/slumber/issues/243)
   - [See docs](https://slumber.lucaspickering.me/book/api/request_collection/recipe_body.html) for usage instructions
 - Support multiple instances of the same query param [#245](https://github.com/LucasPickering/slumber/issues/245) (@maksimowiczm)
   - Query params can now be defined as a list of `<param>=<value>` entries

Cargo.toml

@@ -33,7 +33,7 @@ nom = "7.1.3"
 notify = {version = "^6.1.1", default-features = false, features = ["macos_fsevent"]}
 open = "5.1.1"
 ratatui = {version = "^0.26.0", features = ["serde", "unstable-rendered-line-info"]}
-reqwest = {version = "^0.12.4", default-features = false, features = ["rustls-tls"]}
+reqwest = {version = "^0.12.4", default-features = false, features = ["multipart", "rustls-tls"]}
 rmp-serde = "^1.1.2"
 rusqlite = {version = "^0.31.0", default-features = false, features = ["bundled", "chrono", "uuid"]}
 rusqlite_migration = "^1.2.0"
@@ -52,6 +52,7 @@ uuid = {version = "^1.4.1", default-features = false, features = ["serde", "v4"]
 [dev-dependencies]
 mockito = {version = "1.4.0", default-features = false}
 pretty_assertions = "1.4.0"
+regex = {version = "1.10.5", default-features = false}
 rstest = {version = "0.19.0", default-features = false}
 serde_test = "1.0.176"
 

docs/src/api/request_collection/recipe_body.md

@@ -8,10 +8,11 @@ In addition, you can pass any [`Template`](./template.md) to render any text or
 
 The following content types have first-class support. Slumber will automatically set the `Content-Type` header to the specified value, but you can override this simply by providing your own value for the header.
 
-| Variant            | Type                                         | `Content-Type`                      | Description                                                                                               |
-| ------------------ | -------------------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `!json`            | Any                                          | `application/json`                  | Structured JSON body; all strings are treated as templates                                                |
-| `!form_urlencoded` | [`mapping[string, Template]`](./template.md) | `application/x-www-form-urlencoded` | URL-encoded form data; [see here for more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST |
+| Variant            | Type                                         | `Content-Type`                      | Description                                                                                                |
+| ------------------ | -------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------------------------------------------------- |
+| `!json`            | Any                                          | `application/json`                  | Structured JSON body; all strings are treated as templates                                                 |
+| `!form_urlencoded` | [`mapping[string, Template]`](./template.md) | `application/x-www-form-urlencoded` | URL-encoded form data; [see here for more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST) |
+| `!form_multipart`  | [`mapping[string, Template]`](./template.md) | `multipart/form-data`               | Binary form data; [see here for more](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/POST)      |
 
 ## Examples
 
@@ -41,4 +42,19 @@ requests:
     url: "{{host}}/fishes/{{fish_id}}"
     # Content-Type header will be set automatically based on the body type
     body: !json { "name": "Alfonso" }
+
+  urlencoded_body: !request
+    method: POST
+    url: "{{host}}/fishes/{{fish_id}}"
+    # Content-Type header will be set automatically based on the body type
+    body: !form_urlencoded
+      name: Alfonso
+
+  multipart_body: !request
+    method: POST
+    url: "{{host}}/fishes/{{fish_id}}"
+    # Content-Type header will be set automatically based on the body type
+    body: !form_multipart
+      name: Alfonso
+      image: "{{chains.fish_image}}"
 ```

slumber.yml

@@ -29,6 +29,9 @@ chains:
       recipe: login
       trigger: !expire 12h
     selector: $.data
+  image:
+    source: !file
+      path: ./static/slumber.png
 
 .ignore:
   base: &base
@@ -81,6 +84,14 @@ requests:
     method: GET
     url: "{{host}}/image"
 
+  upload_image: !request
+    name: Upload Image
+    method: POST
+    url: "{{host}}/anything/image"
+    body: !form_multipart
+      filename: "logo.png"
+      image: "{{chains.image}}"
+
   delay: !request
     <<: *base
     name: Delay

src/cli/history.rs

@@ -7,6 +7,7 @@ use crate::{
     GlobalArgs,
 };
 use anyhow::anyhow;
+use bytesize::ByteSize;
 use clap::Parser;
 use dialoguer::console::Style;
 use std::process::ExitCode;
@@ -94,8 +95,8 @@ impl HistoryCommand {
             print!(
                 "{} ({})\n{}",
                 subheader_style.apply_to("Body"),
-                body.size(),
-                MaybeStr(body.bytes())
+                ByteSize(body.len() as u64),
+                MaybeStr(body)
             )
         }
         println!();

src/collection/cereal.rs

@@ -227,8 +227,12 @@ impl RecipeBody {
     const STRUCT_NAME: &'static str = "RecipeBody";
     const VARIANT_JSON: &'static str = "json";
     const VARIANT_FORM_URLENCODED: &'static str = "form_urlencoded";
-    const ALL_VARIANTS: &'static [&'static str] =
-        &[Self::VARIANT_JSON, Self::VARIANT_FORM_URLENCODED];
+    const VARIANT_FORM_MULTIPART: &'static str = "form_multipart";
+    const ALL_VARIANTS: &'static [&'static str] = &[
+        Self::VARIANT_JSON,
+        Self::VARIANT_FORM_URLENCODED,
+        Self::VARIANT_FORM_MULTIPART,
+    ];
 }
 
 /// Custom serialization for RecipeBody, so the `Raw` variant serializes as a
@@ -255,6 +259,13 @@ impl Serialize for RecipeBody {
                     Self::VARIANT_FORM_URLENCODED,
                     value,
                 ),
+            RecipeBody::FormMultipart(value) => serializer
+                .serialize_newtype_variant(
+                    Self::STRUCT_NAME,
+                    3,
+                    Self::VARIANT_FORM_MULTIPART,
+                    value,
+                ),
         }
     }
 }
@@ -316,6 +327,9 @@ impl<'de> Deserialize<'de> for RecipeBody {
                     RecipeBody::VARIANT_FORM_URLENCODED => {
                         Ok(RecipeBody::FormUrlencoded(value.newtype_variant()?))
                     }
+                    RecipeBody::VARIANT_FORM_MULTIPART => {
+                        Ok(RecipeBody::FormMultipart(value.newtype_variant()?))
+                    }
                     other => Err(A::Error::unknown_variant(
                         other,
                         RecipeBody::ALL_VARIANTS,
@@ -519,7 +533,8 @@ mod tests {
             tag: Tag::new("raw"),
             value: "{{user_id}}".into()
         })),
-        "unknown variant `raw`, expected `json` or `form_urlencoded`",
+        "unknown variant `raw`, expected one of \
+        `json`, `form_urlencoded`, `form_multipart`",
     )]
     #[case::form_urlencoded_wrong_type(
         serde_yaml::Value::Tagged(Box::new(TaggedValue{