From 5365ee3afe838e8f4711c52a969be60ae7a00323 Mon Sep 17 00:00:00 2001
From: Jonas Platte <jplatte+git@posteo.de>
Date: Thu, 4 Jun 2020 21:13:58 +0200
Subject: [PATCH] Use PresenceState from ruma_common, deprecate SetPresence

---
 CHANGELOG.md               |  7 ++++++-
 Cargo.toml                 |  2 +-
 src/r0/sync/sync_events.rs | 33 +++++++++------------------------
 3 files changed, 16 insertions(+), 26 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index d129619c..5bfc9d9b 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -15,7 +15,12 @@ Breaking changes:
 Improvements:
 
 * Add method `into_event_content` for `r0::room::create_room::CreationContent`
-* Add room visibility endpoints: `r0::directory::{get_room_visibility, set_room_visibility}`. 
+* Add room visibility endpoints: `r0::directory::{get_room_visibility, set_room_visibility}`.
+
+Deprecations:
+
+* `r0::sync::sync_events::SetPresence` has been renamed to `PresenceState`. It is still available
+  under its previous name, but only for one release.
 
 # 0.9.0
 
diff --git a/Cargo.toml b/Cargo.toml
index 1ed9dd53..8f7ac04e 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -16,7 +16,7 @@ edition = "2018"
 http = "0.2.1"
 js_int = { version = "0.1.5", features = ["serde"] }
 ruma-api = "0.16.1"
-ruma-common = "0.1.2"
+ruma-common = "0.1.3"
 ruma-events = { git = "https://github.com/ruma/ruma-events", rev = "7395f94" }
 ruma-identifiers = "0.16.2"
 ruma-serde = "0.2.2"
diff --git a/src/r0/sync/sync_events.rs b/src/r0/sync/sync_events.rs
index a253698c..dad8a069 100644
--- a/src/r0/sync/sync_events.rs
+++ b/src/r0/sync/sync_events.rs
@@ -51,7 +51,7 @@ ruma_api! {
         /// Controls whether the client is automatically marked as online by polling this API.
         #[serde(default, skip_serializing_if = "ruma_serde::is_default")]
         #[ruma_api(query)]
-        pub set_presence: SetPresence,
+        pub set_presence: PresenceState,
 
         /// The maximum time to poll in milliseconds before returning this request.
         #[serde(
@@ -98,25 +98,10 @@ ruma_api! {
     error: crate::Error
 }
 
-/// Whether to set presence or not during sync.
-#[derive(Clone, Copy, Debug, PartialEq, Deserialize, Serialize)]
-#[serde(rename_all = "lowercase")]
-pub enum SetPresence {
-    /// Do not set the presence of the user calling this API.
-    Offline,
+pub use ruma_common::presence::PresenceState;
 
-    /// Mark client as online explicitly. Assumed by default.
-    Online,
-
-    /// Mark client as being idle.
-    Unavailable,
-}
-
-impl Default for SetPresence {
-    fn default() -> Self {
-        Self::Online
-    }
-}
+#[deprecated = "use `PresenceState` instead"]
+pub use self::PresenceState as SetPresence;
 
 /// A filter represented either as its full JSON definition or the ID of a saved filter.
 #[derive(Clone, Debug, Deserialize, Serialize)]
@@ -344,7 +329,7 @@ mod tests {
 
     use matches::assert_matches;
 
-    use super::{Filter, Request, SetPresence};
+    use super::{Filter, PresenceState, Request};
 
     #[test]
     fn serialize_all_params() {
@@ -352,7 +337,7 @@ mod tests {
             filter: Some(Filter::FilterId("66696p746572".into())),
             since: Some("s72594_4483_1934".into()),
             full_state: true,
-            set_presence: SetPresence::Offline,
+            set_presence: PresenceState::Offline,
             timeout: Some(Duration::from_millis(30000)),
         }
         .try_into()
@@ -395,7 +380,7 @@ mod tests {
         assert_matches!(req.filter, Some(Filter::FilterId(id)) if id == "myfilter");
         assert_eq!(req.since, Some("myts".into()));
         assert_eq!(req.full_state, false);
-        assert_eq!(req.set_presence, SetPresence::Offline);
+        assert_eq!(req.set_presence, PresenceState::Offline);
         assert_eq!(req.timeout, Some(Duration::from_millis(5000)));
     }
 
@@ -418,7 +403,7 @@ mod tests {
         assert_matches!(req.filter, None);
         assert_eq!(req.since, None);
         assert_eq!(req.full_state, false);
-        assert_eq!(req.set_presence, SetPresence::Online);
+        assert_eq!(req.set_presence, PresenceState::Online);
         assert_eq!(req.timeout, None);
     }
 
@@ -445,7 +430,7 @@ mod tests {
         assert_matches!(req.filter, Some(Filter::FilterId(id)) if id == "EOKFFmdZYF");
         assert_eq!(req.since, None);
         assert_eq!(req.full_state, false);
-        assert_eq!(req.set_presence, SetPresence::Online);
+        assert_eq!(req.set_presence, PresenceState::Online);
         assert_eq!(req.timeout, Some(Duration::from_millis(0)));
     }
 }