df_st_api 0.3.0-development-1

Starting an API server for the DF Storyteller project.
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
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

use crate::api_errors::{APIErrorNoContent, APIErrorNotModified};
use crate::api_objects::ApiObject;
use crate::pagination::{
    ApiCountPage, ApiCountPagination, ApiItem, ApiItemQuery, ApiPage, ApiPagination,
};
use crate::DfStDatabase;
use crate::ServerInfo;
use df_st_core::item_count::ItemCount;
use df_st_db::{id_filter, DBObject};
use rocket::{get, State};
use rocket_contrib::json::Json;
use df_rocket_okapi_codegen::openapi;

impl ApiObject for df_st_core::HistoricalEventCollection {
    fn get_type() -> String {
        "historical_event_collection".to_owned()
    }
    fn get_item_link(&self, base_url: &str) -> String {
        format!("{}/historical_event_collections/{}", base_url, self.id)
    }
    fn get_page_link(base_url: &str) -> String {
        format!("{}/historical_event_collections", base_url)
    }
    fn get_count_link(base_url: &str) -> String {
        format!("{}/historical_event_collections/count", base_url)
    }
}

/// Request a `HistoricalEventCollection` by id.
/// The `attacking_squad_*` and `defending_squad_*` field are not yet implemented because of technical issues.
///
/// ( Since = "0.1.0" )
#[openapi]
#[get("/historical_event_collections/<historical_event_collection_id>?<item_query..>")]
pub fn get_historical_event_collection(
    conn: DfStDatabase,
    historical_event_collection_id: i32,
    item_query: ApiItemQuery,
    server_info: State<ServerInfo>,
) -> Result<Json<ApiItem<df_st_core::HistoricalEventCollection>>, APIErrorNoContent> {
    let mut api_page =
        ApiItem::<df_st_core::HistoricalEventCollection>::new(&server_info, &item_query);
    let item_search = df_st_db::HistoricalEventCollection::get_from_db(
        &*conn,
        id_filter!["id" => historical_event_collection_id, "world_id" => server_info.world_id],
        api_page.get_nested_items(),
    )?;
    if let Some(item) = item_search {
        api_page.wrap(item);
        return Ok(Json(api_page));
    }
    Err(APIErrorNoContent::new())
}

/// Request a list of all `HistoricalEventCollection` in the world.
/// The `attacking_squad_*` and `defending_squad_*` field are not yet implemented because of technical issues.
/// Order_by is only implemented for `id`, `type`, `start_year`, `start_seconds72`, `end_year` and `end_seconds72`.
///
/// ( Since = "0.1.0" )
#[openapi]
#[get("/historical_event_collections?<pagination..>")]
pub fn list_historical_event_collections(
    conn: DfStDatabase,
    pagination: ApiPagination,
    server_info: State<ServerInfo>,
) -> Result<Json<ApiPage<df_st_core::HistoricalEventCollection>>, APIErrorNotModified> {
    let mut api_page =
        ApiPage::<df_st_core::HistoricalEventCollection>::new(&pagination, &server_info);
    api_page.match_fields::<df_st_db::HistoricalEventCollection, _, _>()?;

    api_page.total_item_count = df_st_db::HistoricalEventCollection::get_count_from_db(
        &*conn,
        api_page.add_int_filter(id_filter!["world_id" => server_info.world_id]),
        api_page.get_string_filter(),
        0,
        1,
        None,
        None,
    )?
    .get(0)
    .unwrap()
    .count;

    let result_list = df_st_db::HistoricalEventCollection::get_list_from_db(
        &*conn,
        api_page.add_int_filter(id_filter!["world_id" => server_info.world_id]),
        api_page.get_string_filter(),
        api_page.page_start,
        api_page.max_page_size,
        api_page.get_db_order(),
        api_page.order_by.clone(),
        None,
        api_page.get_nested_items(),
    )?;

    if api_page.wrap(result_list) {
        return Err(APIErrorNotModified::new());
    }
    Ok(Json(api_page))
}

/// Request a counts about `HistoricalEventCollection` grouped by a field.
/// Group_by is only implemented for `id`, `type`, `start_year`, `start_seconds72`, `end_year` and `end_seconds72`.
///
/// ( Since = "0.1.0" )
#[openapi]
#[get("/historical_event_collections/count?<group_by>&<pagination..>")]
pub fn get_historical_event_collection_count(
    conn: DfStDatabase,
    group_by: Option<String>,
    pagination: ApiCountPagination,
    server_info: State<ServerInfo>,
) -> Result<Json<ApiCountPage<ItemCount, df_st_core::HistoricalEventCollection>>, APIErrorNotModified>
{
    let mut api_page = ApiCountPage::<ItemCount, df_st_core::HistoricalEventCollection>::new(
        &pagination,
        &server_info,
    );
    api_page.group_by = group_by;
    api_page.match_fields::<df_st_db::HistoricalEventCollection, _, _>()?;

    api_page.total_item_count = df_st_db::HistoricalEventCollection::get_count_from_db(
        &*conn,
        api_page.add_int_filter(id_filter!["world_id" => server_info.world_id]),
        api_page.get_string_filter(),
        0,
        u32::MAX,
        api_page.group_by.clone(),
        None,
    )?
    .len() as u32;

    let result_list = df_st_db::HistoricalEventCollection::get_count_from_db(
        &*conn,
        api_page.add_int_filter(id_filter!["world_id" => server_info.world_id]),
        api_page.get_string_filter(),
        api_page.page_start,
        api_page.max_page_size,
        api_page.group_by.clone(),
        None,
    )?;

    if api_page.wrap(result_list) {
        return Err(APIErrorNotModified::new());
    }
    Ok(Json(api_page))
}