earthmc 2.0.1

Async client for interacting with the EarthMC API
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
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

use std::collections::BTreeMap;

use serde::{Deserialize, Serialize};
use uuid::Uuid;

use crate::model::{
    location::{ChunkCoordinate, WorldLocation},
    named_uuid::{NamedUuid, NamedUuidOpt},
    permission::TownyPermissions,
    timestamp::Timestamp,
};

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct Town {
    pub name: String,
    pub uuid: Uuid,
    /// Shown on `/t` in-game.
    pub board: Option<String>,
    /// Shown on `/t` in-game.
    pub founder: String,
    pub wiki: Option<String>,
    pub mayor: NamedUuid,
    pub nation: NamedUuidOpt,
    pub timestamps: TownTimestamps,
    pub status: TownStatus,
    pub stats: TownStats,
    pub perms: TownyPermissions,
    pub coordinates: TownCoordinates,
    pub residents: Vec<NamedUuid>,
    pub trusted: Vec<NamedUuid>,
    pub outlaws: Vec<NamedUuid>,
    pub quarters: Vec<NamedUuid>,
    pub ranks: BTreeMap<TownRankKind, Vec<NamedUuid>>,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct TownTimestamps {
    /// Creation time.
    #[cfg_attr(
        feature = "chrono",
        serde(with = "crate::model::timestamp::seconds")
    )]
    pub registered: Timestamp,
    /// Current nation join time.
    #[cfg_attr(
        feature = "chrono",
        serde(with = "crate::model::timestamp::optional_seconds")
    )]
    pub joined_nation_at: Option<Timestamp>,
    /// Ruin time.
    #[cfg_attr(
        feature = "chrono",
        serde(with = "crate::model::timestamp::optional_seconds")
    )]
    pub ruined_at: Option<Timestamp>,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct TownStatus {
    pub is_public: bool,
    /// Invite-less joining is enabled.
    pub is_open: bool,
    pub is_neutral: bool,
    pub is_capital: bool,
    pub is_over_claimed: bool,
    pub is_ruined: bool,
    pub is_for_sale: bool,
    pub has_nation: bool,
    /// Outsiders may teleport to the town spawn.
    pub can_outsiders_spawn: bool,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct TownStats {
    pub num_town_blocks: i32,
    pub max_town_blocks: i32,
    pub bonus_blocks: i32,
    pub num_residents: i32,
    pub num_trusted: i32,
    pub num_outlaws: i32,
    /// Shown on `/t` in-game.
    pub balance: f64,
    /// Sale price when the town is listed.
    pub for_sale_price: Option<f64>,
}

#[derive(Clone, Deserialize, Serialize, PartialEq, Debug)]
#[serde(rename_all = "camelCase")]
pub struct TownCoordinates {
    pub spawn: WorldLocation,
    pub home_block: ChunkCoordinate,
    pub town_blocks: Vec<ChunkCoordinate>,
}

#[derive(
    Clone, Deserialize, Serialize, PartialEq, Eq, Hash, PartialOrd, Ord, Debug,
)]
#[serde(rename_all = "PascalCase")]
pub enum TownRankKind {
    Councillor,
    Builder,
    Recruiter,
    Police,
    #[serde(rename = "Tax-exempt")]
    TaxExempt,
    Treasurer,
    Realtor,
    Settler,
    #[serde(untagged)]
    Other(String),
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use crate::{
        endpoints::towns::TownCoordinates,
        model::location::{ChunkCoordinate, WorldLocation},
    };

    fn spawn() -> WorldLocation {
        WorldLocation {
            world: "earth".to_string(),
            x: 1.0,
            y: 64.0,
            z: 2.0,
            pitch: 0.0,
            yaw: 90.0,
        }
    }

    #[test]
    fn deserializes_town_blocks_from_coordinate_arrays() {
        let coordinates: TownCoordinates = serde_json::from_value(json!({
            "spawn": {
                "world": "earth",
                "x": 1.0,
                "y": 64.0,
                "z": 2.0,
                "pitch": 0.0,
                "yaw": 90.0
            },
            "homeBlock": [10, 20],
            "townBlocks": [[10, 20], [11, 20]]
        }))
        .unwrap();

        assert_eq!(coordinates.home_block, ChunkCoordinate { x: 10, z: 20 });
        assert_eq!(
            coordinates.town_blocks,
            vec![
                ChunkCoordinate { x: 10, z: 20 },
                ChunkCoordinate { x: 11, z: 20 },
            ]
        );
    }

    #[test]
    fn serializes_town_blocks_as_coordinate_arrays() {
        let coordinates = TownCoordinates {
            spawn: spawn(),
            home_block: ChunkCoordinate { x: 10, z: 20 },
            town_blocks: vec![
                ChunkCoordinate { x: 10, z: 20 },
                ChunkCoordinate { x: 11, z: 20 },
            ],
        };

        assert_eq!(
            serde_json::to_value(coordinates).unwrap(),
            json!({
                "spawn": {
                    "world": "earth",
                    "x": 1.0,
                    "y": 64.0,
                    "z": 2.0,
                    "pitch": 0.0,
                    "yaw": 90.0
                },
                "homeBlock": [10, 20],
                "townBlocks": [[10, 20], [11, 20]]
            })
        );
    }
}