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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
//! Postman Collection Generator.
//!
//! This module provides a utility to generate a Postman v2.1.0 Collection
//! from a Salesforce SObjectDescribe metadata payload. It creates standard
//! CRUD (Create, Read, Update, Delete) operations with pre-filled variables
//! based on the object's schema.
#[cfg(feature = "schema")]
use crate::types::describe::SObjectDescribe;
#[cfg(feature = "schema")]
use serde_json::{Value, json};
/// Generates a Postman v2.1.0 Collection for an SObject.
#[cfg(feature = "schema")]
#[must_use]
#[allow(clippy::too_many_lines)]
pub fn generate_postman_collection(describe: &SObjectDescribe) -> Value {
let name = &describe.name;
let label = if describe.label.is_empty() {
name.clone()
} else {
describe.label.clone()
};
// Build dummy json body for create/update using fields that are createable/updateable
let mut create_body = serde_json::Map::new();
let mut update_body = serde_json::Map::new();
for field in &describe.fields {
if field.createable && field.name != "Id" {
create_body.insert(
field.name.clone(),
json!(format!("{{{{${}}}}}", field.name)),
);
}
if field.updateable && field.name != "Id" {
update_body.insert(
field.name.clone(),
json!(format!("{{{{${}}}}}", field.name)),
);
}
}
let create_body_str =
serde_json::to_string_pretty(&create_body).unwrap_or_else(|_| "{}".to_string());
let update_body_str =
serde_json::to_string_pretty(&update_body).unwrap_or_else(|_| "{}".to_string());
json!({
"info": {
"name": format!("Salesforce REST API - {}", label),
"description": format!("Generated CRUD operations for {}", name),
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": format!("Create {}", label),
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": create_body_str
},
"url": {
"raw": format!("{{{{_endpoint}}}}/services/data/v60.0/sobjects/{}", name),
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v60.0",
"sobjects",
name
]
}
}
},
{
"name": format!("Read {}", label),
"request": {
"method": "GET",
"header": [],
"url": {
"raw": format!("{{{{_endpoint}}}}/services/data/v60.0/sobjects/{}/{{{{recordId}}}}", name),
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v60.0",
"sobjects",
name,
"{{recordId}}"
]
}
}
},
{
"name": format!("Update {}", label),
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": update_body_str
},
"url": {
"raw": format!("{{{{_endpoint}}}}/services/data/v60.0/sobjects/{}/{{{{recordId}}}}", name),
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v60.0",
"sobjects",
name,
"{{recordId}}"
]
}
}
},
{
"name": format!("Delete {}", label),
"request": {
"method": "DELETE",
"header": [],
"url": {
"raw": format!("{{{{_endpoint}}}}/services/data/v60.0/sobjects/{}/{{{{recordId}}}}", name),
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v60.0",
"sobjects",
name,
"{{recordId}}"
]
}
}
}
]
})
}
#[cfg(test)]
#[cfg(feature = "schema")]
mod tests {
use super::*;
use crate::test_support::{MockFieldDescribeBuilder, MockSObjectDescribeBuilder, MustMsg};
use crate::types::describe::FieldType;
#[test]
fn test_generate_postman_collection() {
let describe = MockSObjectDescribeBuilder::new("Account")
.field(
MockFieldDescribeBuilder::new("Id", FieldType::Id)
.createable(true)
.updateable(true)
.build(),
)
.field(
MockFieldDescribeBuilder::new("Name", FieldType::String)
.createable(true)
.updateable(true)
.build(),
)
.field(
MockFieldDescribeBuilder::new("Industry", FieldType::Picklist)
.createable(true)
.updateable(true)
.build(),
)
.field(
MockFieldDescribeBuilder::new("CreateOnly", FieldType::String)
.createable(true)
.updateable(false)
.build(),
)
.field(
MockFieldDescribeBuilder::new("UpdateOnly", FieldType::String)
.createable(false)
.updateable(true)
.build(),
)
.build();
let collection = generate_postman_collection(&describe);
assert_eq!(collection["info"]["name"], "Salesforce REST API - Account");
assert_eq!(
collection["info"]["schema"],
"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
);
let items = collection["item"]
.as_array()
.must_msg("item should be an array");
assert_eq!(items.len(), 4, "Should have 4 CRUD operations");
// Check Create Request
let create_item = &items[0];
assert_eq!(create_item["name"], "Create Account");
assert_eq!(create_item["request"]["method"], "POST");
let create_raw = create_item["request"]["body"]["raw"]
.as_str()
.must_msg("raw body should be string");
assert!(
!create_raw.contains("\"Id\""),
"Id should not be createable"
);
assert!(create_raw.contains("\"Name\""), "Name should be createable");
assert!(
create_raw.contains("\"CreateOnly\""),
"CreateOnly should be createable"
);
assert!(
!create_raw.contains("\"UpdateOnly\""),
"UpdateOnly should not be createable"
);
// Check Update Request
let update_item = &items[2];
assert_eq!(update_item["name"], "Update Account");
assert_eq!(update_item["request"]["method"], "PATCH");
let update_raw = update_item["request"]["body"]["raw"]
.as_str()
.must_msg("raw body should be string");
assert!(
!update_raw.contains("\"Id\""),
"Id should not be updateable"
);
assert!(update_raw.contains("\"Name\""), "Name should be updateable");
assert!(
!update_raw.contains("\"CreateOnly\""),
"CreateOnly should not be updateable"
);
assert!(
update_raw.contains("\"UpdateOnly\""),
"UpdateOnly should be updateable"
);
}
}