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
//! The Odoo "object" service (types only)

use odoo_api_macros::odoo_api_request;
use serde::{Deserialize, Serialize};
use serde_json::{Map, Value};

/// This method  allows you to call an arbitrary Odoo method (e.g. `read` or
/// `create` or `my_function`), passing some arbitrary data, and returns the
/// result of that method call.
///
/// Note that this method does not support keyword args. If you need to pass
/// kwargs, see [`ExecuteKw`] and [`execute_kw`].
///
/// Example:
/// ```no_run
/// use odoo_api::types::object;
/// use serde_json::json;
///
/// let request = object::execute(
///     "my-database",
///     1, // admin user
///     "password1",
///     "res.users",
///     "read",
///     json!([
///         [1, 2, 3],
///         ["name", "login"]
///     ])
/// );
/// ```
///
/// See: [odoo/service/model.py](https://github.com/odoo/odoo/blob/b6e195ccb3a6c37b0d980af159e546bdc67b1e42/odoo/service/model.py#L62-L68)
#[derive(Debug, Deserialize, PartialEq)]
#[odoo_api_request(
    "object",
    "execute",
    "Call a business-logic method on an Odoo model (positional args)"
)]
pub struct Execute {
    /// The database name
    db: String,

    /// The user id
    uid: u32,

    /// The user password
    password: String,

    /// The model name
    model: String,

    /// The method name (e.g. "read" or "create")
    method: String,

    /// The arguments (*args)
    args: Vec<Value>,
}

/// Represents the response to an Odoo [`Execute`]
///
/// This struct is intentionally very generic, as the `execute` call can return
/// any arbitrary JSON data.
#[derive(Debug, Serialize, Deserialize, PartialEq)]
#[serde(transparent)]
pub struct ExecuteResponse {
    pub data: Value,
}

/// This method is very similar to `execute`; It allows you to call an arbitrary
/// Odoo method (e.g. `read` or `create` or `my_function`), passing some arbitrary
/// data, and returns the result of that method call.
///
/// This differs from `execute` in that keyword args (`kwargs`) can be passed.
///
/// Example:
/// ```no_run
/// use odoo_api::types::object;
/// use serde_json::json;
///
/// let request = object::execute_kw(
///     "my-database",
///     1, // admin user
///     "password1",
///     "res.users",
///     "read",
///     json!([]),
///     json!({
///         "limit": 5,
///     })
/// );
/// ```
///
/// Reference: [odoo/service/model.py](https://github.com/odoo/odoo/blob/b6e195ccb3a6c37b0d980af159e546bdc67b1e42/odoo/service/model.py#L58-L59)
#[derive(Debug, Deserialize, PartialEq)]
#[odoo_api_request(
    "object",
    "execute_kw",
    "Call a business-logic method on an Odoo model (positional & keyword args)"
)]
pub struct ExecuteKw {
    /// The database name
    db: String,

    /// The user id
    uid: u32,

    /// The user password
    password: String,

    /// The model name
    model: String,

    /// The method name (e.g. "read" or "create")
    method: String,

    /// The arguments (*args)
    args: Vec<Value>,

    /// The keyword-argments (**kwargs)
    kwargs: Map<String, Value>,
}

/// Represents the response to an Odoo [`Execute`] call
///
/// This struct is intentionally very generic, as the `execute` call can return
/// any arbitrary JSON data.
#[derive(Debug, Serialize, Deserialize, PartialEq)]
#[serde(transparent)]
pub struct ExecuteKwResponse {
    pub data: Value,
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::jsonrpc::{JsonRpcResponseSuccess, JsonRpcVersion, OdooApiResponse, Result};
    use serde_json::{json, to_value};

    #[test]
    fn execute() -> Result<()> {
        let expected_request = to_value(json!({
            "version": "2.0",
            "id": 1000,
            "method": "call",
            "params": {
                "service": "object",
                "method": "execute",
                "args": [
                    "my-database",
                    1,
                    "password123",
                    "res.users",
                    "search",
                    [
                        ["login", "ilike", "%"],
                        "|",
                        ["active", "=", true],
                        ["active", "=", false]
                    ]
                ]
            }
        }))?;
        let expected_response = to_value(json!({
            "jsonrpc": "2.0",
            "id": 1000,
            "result": [
                1,
                2,
                3
            ]
        }))?;

        let request = super::execute(
            "my-database",
            1,
            "password123",
            "res.users",
            "search",
            json!([
                ["login", "ilike", "%"],
                "|",
                ["active", "=", true],
                ["active", "=", false]
            ]),
        )?
        .to_json_value()?;

        let response = to_value(OdooApiResponse::<Execute>::Success(
            JsonRpcResponseSuccess {
                jsonrpc: JsonRpcVersion::V2,
                id: 1000,
                result: ExecuteResponse {
                    data: json!([1, 2, 3]),
                },
            },
        ))?;

        assert_eq!(request, expected_request);
        assert_eq!(response, expected_response);

        Ok(())
    }

    #[test]
    fn execute_kw() -> Result<()> {
        let expected_request = to_value(json!({
            "version": "2.0",
            "id": 1000,
            "method": "call",
            "params": {
                "service": "object",
                "method": "execute_kw",
                "args": [
                    "my-database",
                    1,
                    "password123",
                    "res.users",
                    "search",
                    [
                        [
                            ["login", "ilike", "%"],
                            "|",
                            ["active", "=", true],
                            ["active", "=", false]
                        ]
                    ],
                    {
                        "limit": 1
                    }
                ]
            }
        }))?;
        let expected_response = to_value(json!({
            "jsonrpc": "2.0",
            "id": 1000,
            "result": [
                1
            ]
        }))?;

        let request = super::execute_kw(
            "my-database",
            1,
            "password123",
            "res.users",
            "search",
            json!([[
                ["login", "ilike", "%"],
                "|",
                ["active", "=", true],
                ["active", "=", false]
            ]]),
            json!({
                "limit": 1
            }),
        )?
        .to_json_value()?;

        let response = to_value(OdooApiResponse::<ExecuteKw>::Success(
            JsonRpcResponseSuccess {
                jsonrpc: JsonRpcVersion::V2,
                id: 1000,
                result: ExecuteKwResponse { data: json!([1]) },
            },
        ))?;

        assert_eq!(request, expected_request);
        assert_eq!(response, expected_response);

        Ok(())
    }
}