api-tools 0.7.0

An API tools library for Rust
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

//! Datetime represents a date and time value in the UTC timezone.

use chrono::{DateTime, TimeDelta, Utc};
use serde::Deserialize;
use std::fmt::{Display, Formatter};
use std::ops::Add;
use thiserror::Error;

/// UTC Datetime possible errors
#[derive(Debug, Clone, PartialEq, Error)]
pub enum UtcDateTimeError {
    #[error("Invalid date time: {0}")]
    InvalidDateTime(String),
}

/// Date time with UTC timezone
#[derive(Debug, Default, Clone, PartialEq, PartialOrd, Eq, Deserialize)]
pub struct UtcDateTime {
    value: DateTime<Utc>,
}

impl UtcDateTime {
    /// Create a new date time for now
    pub fn now() -> Self {
        Self { value: Utc::now() }
    }

    /// Create a new date time
    pub fn new(value: DateTime<Utc>) -> Self {
        Self { value }
    }

    /// Create a new date time from RFC3339 string
    ///
    /// # Example
    /// ```rust
    /// use api_tools::value_objects::datetime::UtcDateTime;
    ///
    /// let datetime = UtcDateTime::from_rfc3339("2024-08-28T12:00:00Z");
    /// assert_eq!(datetime.unwrap().to_string(), "2024-08-28T12:00:00Z".to_owned());
    ///
    /// let invalid_datetime = UtcDateTime::from_rfc3339("2024-08-T12:00:00Z");
    /// ```
    pub fn from_rfc3339(value: &str) -> Result<Self, UtcDateTimeError> {
        let dt = DateTime::parse_from_rfc3339(value)
            .map_err(|e| UtcDateTimeError::InvalidDateTime(format!("{e}: {value}")))?;

        Ok(Self {
            value: dt.with_timezone(&Utc),
        })
    }

    /// Get timestamp value
    pub fn timestamp(&self) -> i64 {
        self.value.timestamp()
    }

    /// Get date time value
    pub fn value(&self) -> DateTime<Utc> {
        self.value
    }

    /// Create a new date time from a timestamp
    pub fn add(&self, rhs: TimeDelta) -> Self {
        Self {
            value: self.value.add(rhs),
        }
    }
}

impl From<DateTime<Utc>> for UtcDateTime {
    fn from(value: DateTime<Utc>) -> Self {
        Self { value }
    }
}

impl Display for UtcDateTime {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.value.to_rfc3339_opts(chrono::SecondsFormat::Secs, true))
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn test_utc_date_time_display() {
        let dt = DateTime::parse_from_rfc3339("2024-08-28T12:00:00Z")
            .unwrap()
            .with_timezone(&Utc);
        let datetime = UtcDateTime::from(dt);

        assert_eq!(datetime.to_string(), "2024-08-28T12:00:00Z");
    }

    #[test]
    fn test_from_rfc3339() {
        let datetime = UtcDateTime::from_rfc3339("2024-08-28T12:00:00Z");
        assert!(datetime.is_ok());
        assert_eq!(datetime.unwrap().to_string(), "2024-08-28T12:00:00Z".to_owned());

        let invalid_datetime = UtcDateTime::from_rfc3339("2024-08-T12:00:00Z");
        assert!(invalid_datetime.is_err());
    }

    #[test]
    fn test_value() {
        let dt = DateTime::parse_from_rfc3339("2024-08-28T12:00:00Z")
            .unwrap()
            .with_timezone(&Utc);
        let datetime = UtcDateTime::from(dt);

        assert_eq!(datetime.value(), dt);
    }

    #[test]
    fn test_timestamp() {
        let dt = DateTime::parse_from_rfc3339("2024-08-28T12:00:00Z")
            .unwrap()
            .with_timezone(&Utc);
        let datetime = UtcDateTime::from(dt);

        assert_eq!(datetime.timestamp(), 1724846400);
    }

    #[test]
    fn test_add() {
        let dt = DateTime::parse_from_rfc3339("2024-08-28T12:00:00Z")
            .unwrap()
            .with_timezone(&Utc);
        let datetime = UtcDateTime::from(dt);
        let new_datetime = datetime.add(TimeDelta::seconds(3600));
        assert_eq!(new_datetime.to_string(), "2024-08-28T13:00:00Z".to_owned());
    }
}