boomack 0.4.1

Client library for Boomack
Documentation 
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

//! Structures and functions to create
//! [`ClientRequest`](../api/struct.ClientRequest.html) instances
//! for making evaluation requests

use std::path::PathBuf;
use super::json::*;
use super::api::*;

/// Evaluation parameters contain all required information
/// for the evaluation request, except the JavaScript code.
pub struct EvalParameters<'l> {
    /// Target panel ID
    pub panel: Option<&'l str>,
}

fn init_eval_request_body(p: &EvalParameters) -> JsonMap
{
    let mut req = JsonMap::new();
    if let Some(panel_id) = p.panel {
        set_json_str_value(&mut req, "panel", panel_id);
    }
    req
}

fn build_eval_json_request(body: JsonMap) -> ClientRequest {
    let mut req = ClientRequest::post(format!("eval"));
    req.set_json_body(body);
    req
}

/// Create an evaluation request with the JavaScript code in a string.
pub fn eval_text_request(p: EvalParameters, text: &str)
    -> ClientRequest
{
    let mut body = init_eval_request_body(&p);
    set_json_str_value(&mut body, "script", text);
    build_eval_json_request(body)
}

fn build_stream_eval_request(p: EvalParameters) -> ClientRequest
{
    let mut req = ClientRequest::post(format!("panels/{}/eval",
        p.panel.unwrap_or("default")));
    req.set_header("Content-Type", "application/javascript");
    req
}

/// Create an evaluation request with the JavaScript code in a file.
pub fn eval_file_request(p: EvalParameters, filename: &str)
    -> ClientRequest
{
    let mut req = build_stream_eval_request(p);
    req.set_file_body(PathBuf::from(filename));
    req
}

/// Create an evaluation request with the JavaScript code read from STDIN.
pub fn eval_stdin_request(p: EvalParameters)
    -> ClientRequest
{
    let mut req = build_stream_eval_request(p);
    req.set_stdin_body();
    req
}