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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
use queryst::parse;
use std::collections::HashMap;
use serde_json::value::Value;
#[derive(Debug, PartialEq, Clone, Copy)]
pub struct PageParams {
pub size: i64,
pub number: i64,
}
/// JSON-API Query parameters
#[derive(Clone, Debug, PartialEq, Default)]
pub struct Query {
pub _type: String,
pub include: Option<Vec<String>>,
pub fields: Option<HashMap<String, Vec<String>>>,
pub page: Option<PageParams>,
pub sort: Option<Vec<String>>,
pub filter: Option<HashMap<String, Vec<String>>>
}
//
// Helper functions to break down the cyclomatic complexity of parameter parsing
//
fn ok_params_include(o:&Value) -> Option<Vec<String>> {
match o.pointer("/include") {
None => None,
Some(inc) => {
match inc.as_str() {
None => None,
Some(include_str) => {
let arr: Vec<String> =
include_str.split(',').map(|s| s.to_string()).collect();
Some(arr)
}
}
}
}
}
fn ok_params_fields(o:&Value) -> HashMap<String, Vec<String>> {
let mut fields = HashMap::<String, Vec<String>>::new();
if let Some(x) = o.pointer("/fields") {
if x.is_object() {
if let Some(obj) = x.as_object() {
for (key, value) in obj.iter() {
let arr: Vec<String> = match value.as_str() {
Some(string) => {
string.split(',').map(|s| s.to_string()).collect()
}
None => Vec::<String>::new(),
};
fields.insert(key.to_string(), arr);
}
}
} else {
warn!("Query::from_params : No fields found in {:?}", x);
}
}
fields
}
fn ok_params_sort(o:&Value) -> Option<Vec<String>> {
match o.pointer("/sort") {
None => None,
Some(sort) => {
match sort.as_str() {
None => None,
Some(sort_str) => {
let arr: Vec<String> =
sort_str.split(',').map(|s| s.to_string()).collect();
Some(arr)
}
}
}
}
}
fn ok_params_filter(o:&Value) -> Option<HashMap<String, Vec<String>>> {
match o.pointer("/filter") {
None => None,
Some(x) => {
if x.is_object() {
let mut tmp_filter = HashMap::<String, Vec<String>>::new();
if let Some(obj) = x.as_object() {
for (key, value) in obj.iter() {
let arr: Vec<String> = match value.as_str() {
Some(string) => {
string.split(',').map(|s| s.to_string()).collect()
}
None => Vec::<String>::new(),
};
tmp_filter.insert(key.to_string(), arr);
}
}
Some(tmp_filter)
} else {
warn!("Query::from_params : No filter found in {:?}", x);
None
}
}
}
}
fn ok_params_page(o:&Value) -> PageParams {
PageParams {
number: match o.pointer("/page/number") {
None => {
warn!(
"Query::from_params : No page/number found in {:?}, setting \
default 0",
o
);
0
}
Some(num) => {
if num.is_string() {
match num.as_str().map(str::parse::<i64>) {
Some(y) => y.unwrap_or(0),
None => {
warn!(
"Query::from_params : page/number found in {:?}, \
not able not able to parse it - setting default 0",
o
);
0
}
}
} else {
warn!(
"Query::from_params : page/number found in {:?}, but it is \
not an expected type - setting default 0",
o
);
0
}
}
},
size: match o.pointer("/page/size") {
None => {
warn!(
"Query::from_params : No page/size found in {:?}, setting \
default 0",
o
);
0
}
Some(num) => {
if num.is_string() {
match num.as_str().map(str::parse::<i64>) {
Some(y) => y.unwrap_or(0),
None => {
warn!(
"Query::from_params : page/size found in {:?}, \
not able not able to parse it - setting default 0",
o
);
0
}
}
} else {
warn!(
"Query::from_params : page/size found in {:?}, but it is \
not an expected type - setting default 0",
o
);
0
}
}
},
}
}
fn ok_params(o:Value) -> Query {
Query {
_type: "none".into(),
include : ok_params_include(&o),
fields: Some(ok_params_fields(&o)),
page: Some(ok_params_page(&o)),
sort: ok_params_sort(&o),
filter: ok_params_filter(&o),
}
}
/// JSON-API Query parameters
impl Query {
///
/// Takes a query parameter string and returns a Query
///
/// ```
/// use jsonapi::query::Query;
/// let query = Query::from_params("include=author&fields[articles]=title,\
/// body&fields[people]=name&page[number]=3&page[size]=1");
/// match query.include {
/// None => assert!(false),
/// Some(include) => {
/// assert_eq!(include.len(), 1);
/// assert_eq!(include[0], "author");
/// }
/// }
///
/// ```
pub fn from_params(params: &str) -> Self {
match parse(params) {
Ok(o) => {
ok_params(o)
}
Err(err) => {
warn!("Query::from_params : Can't parse : {:?}", err);
Query {
_type: "none".into(),
..Default::default()
}
}
}
}
///
/// Builds a query parameter string from a Query
///
/// ```
/// use jsonapi::query::{Query, PageParams};
/// let query = Query {
/// _type: "post".into(),
/// include: Some(vec!["author".into()]),
/// fields: None,
/// page: Some(PageParams {
/// size: 5,
/// number: 10,
/// }),
/// sort: None,
/// filter: None,
/// };
///
/// let query_string = query.to_params();
/// assert_eq!(query_string, "include=author&page[size]=5&page[number]=10");
///
/// ```
pub fn to_params(&self) -> String {
let mut params = Vec::<String>::new();
if let Some(ref include) = self.include {
params.push(format!("include={}", include.join(",")));
}
// Examples from json-api.org,
// fields[articles]=title,body,author&fields[people]=name
// fields[articles]=title,body&fields[people]=name
if let Some(ref fields) = self.fields {
for (name, val) in fields.iter() {
params.push(format!("fields[{}]={}", name, val.join(",")));
}
}
if let Some(ref sort) = self.sort {
params.push(format!("sort={}", sort.join(",")))
}
if let Some(ref filter) = self.filter {
for (name, val) in filter.iter() {
params.push(format!("filter[{}]={}", name, val.join(",")));
}
}
if let Some(ref page) = self.page {
params.push(page.to_params());
}
params.join("&")
}
}
impl PageParams {
pub fn to_params(&self) -> String {
format!("page[size]={}&page[number]={}", self.size, self.number)
}
}