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 serde::{de, Deserialize};
use serde_json::Value as JsonValue;
use serde_repr::Deserialize_repr;
use std::fmt;
use thiserror::Error as ThisError;

/// A response that is returned from the Philips Hue API.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum Response<T> {
    /// The response from the API if the request succeeded.
    Success(T),
    /// The response from the API if the request failed.
    Error(Error),
}

impl<T> Response<T> {
    /// Converts the response into a result.
    pub fn into_result(self) -> Result<T, Error> {
        match self {
            Self::Success(v) => Ok(v),
            Self::Error(e) => Err(e),
        }
    }
}

impl<T: fmt::Display> fmt::Display for Response<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Response::Success(v) => write!(f, "Success: {}", v),
            Response::Error(e) => write!(f, "Error: {}", e),
        }
    }
}

/// Errors that can be returned by responses from the Philips Hue API.
///
/// View the [API documentation] for more information.
///
/// [API documentation]: https://developers.meethue.com/develop/hue-api/error-messages
#[derive(Clone, Debug, Eq, PartialEq, Hash, Deserialize, ThisError)]
#[error("{description}")]
pub struct Error {
    /// Kind of the error.
    #[serde(rename = "type")]
    pub kind: ErrorKind,
    /// Address where the error occurred.
    pub address: String,
    /// Description of the error.
    pub description: String,
}

/// Kind of an error from a response.
#[allow(missing_docs)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash, Deserialize_repr)]
#[repr(u16)]
pub enum ErrorKind {
    UnauthorizedUser = 1,
    BodyContainsInvalidJson = 2,
    ResourceNotAvailable = 3,
    MethodNotAvailableForResource = 4,
    MissingParametersInBody = 5,
    ParameterNotAvailable = 6,
    InvalidValueForParameter = 7,
    ParameterIsNotModifiable = 8,
    TooManyItemsInList = 11,
    PortalConnectionRequired = 12,
    LinkButtonNotPressed = 101,
    DhcpCannotBeDisabled = 110,
    InvalidUpdateState = 111,
    DeviceIsSetToOff = 201,
    CommissionableLightListIsFull = 203,
    GroupTableIsFull = 301,
    UpdateOrDeleteGroupOfThisTypeNotAllowed = 305,
    LightAlreadyUsedInAnotherRoom = 306,
    SceneCouldNotBeCreatedBufferIsFull = 402,
    SceneCouldNotBeRemoved = 403,
    SceneCouldNotBeCreatedGroupIsEmpty = 404,
    NotAllowedToCreateSensorType = 501,
    SensorListIsFull = 502,
    CommissionableSensorListIsFull = 503,
    RuleEngineFull = 601,
    ConditionError = 607,
    ActionError = 608,
    UnableToActivate = 609,
    ScheduleListIsFull = 701,
    ScheduleTimezoneNotValid = 702,
    ScheduleCannotSetTimeAndLocalTime = 703,
    CannotCreateSchedule = 704,
    CannotEnableScheduleTimeInPast = 705,
    CommandError = 706,
    SourceModelInvalid = 801,
    SourceFactoryNew = 802,
    InvalidState = 803,
    InternalError = 901,
    UnkownError,
}

/// A response type that is used when modifying a resource.
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct Modified {
    /// Address of the changed attribute.
    pub address: String,
    /// New value of the attribute.
    pub value: JsonValue,
}

impl fmt::Display for Modified {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Set '{}' to {}", self.address, self.value)
    }
}

impl<'de> de::Deserialize<'de> for Modified {
    fn deserialize<D: de::Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
        struct ModifiedVisitor;

        impl<'de> de::Visitor<'de> for ModifiedVisitor {
            type Value = Modified;

            fn expecting(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
                f.write_str("struct Modified")
            }

            fn visit_map<V: de::MapAccess<'de>>(self, mut map: V) -> Result<Modified, V::Error> {
                let mut address = None;
                let mut value = None;
                while let Some(key) = map.next_key()? {
                    address = Some(key);
                    value = Some(map.next_value()?);
                }
                let address = address.ok_or_else(|| de::Error::missing_field("address"))?;
                let value = value.ok_or_else(|| de::Error::missing_field("value"))?;
                Ok(Modified { address, value })
            }
        }

        const FIELDS: &[&str] = &["address", "value"];
        deserializer.deserialize_struct("Modified", FIELDS, ModifiedVisitor)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::{json, Number as JsonNumber};

    #[test]
    fn deserialize_response_success() {
        let json = json!({"success": "test"});
        let response: Response<String> = serde_json::from_value(json).unwrap();
        assert_eq!(response, Response::Success("test".to_owned()));
        let json = json!({"success": 0});
        let response: Response<i32> = serde_json::from_value(json).unwrap();
        assert_eq!(response, Response::Success(0));
    }

    #[test]
    fn deserialize_response_error() {
        let json = json!({
            "error": {
                "type": 1,
                "address": "/address/123",
                "description": "description test",
            }
        });
        let response: Response<String> = serde_json::from_value(json).unwrap();
        let error = Error {
            kind: ErrorKind::UnauthorizedUser,
            address: "/address/123".to_owned(),
            description: "description test".to_owned(),
        };
        assert_eq!(response, Response::Error(error));
    }

    #[test]
    fn deserialize_response_modifier() {
        let json = json!({
            "success": {
                "/light/1": 0.1,
            }
        });
        let response: Response<Modified> = serde_json::from_value(json).unwrap();
        let modified = Modified {
            address: "/light/1".to_owned(),
            value: JsonValue::Number(JsonNumber::from_f64(0.1).unwrap()),
        };
        assert_eq!(response, Response::Success(modified));
    }
}