commit dee0d550ce5526cf9e399c0373c765a4e9c32551 Author: Paul-Christian Volkmer Date: Wed Dec 20 01:23:54 2023 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..09bbcbc --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/target +/.idea + +Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..d923309 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,23 @@ +[package] +name = "arsnova-client" +description = "ARSnova live feedback client library" +version = "0.1.0" +edition = "2021" +license = "LGPL-3.0-or-later" +authors = ["Paul-Christian Volkmer"] + +[dependencies] +futures-util = "0.3" +reqwest = { version = "0.11", features = ["json", "rustls-tls"], default-features = false } +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" +tokio = { version = "1.35", features = ["rt-multi-thread", "macros"], default-features = false } +tokio-tungstenite = { version = "0.21", features = ["connect", "rustls-tls-webpki-roots"], default-features = false } +url = "2.5" + +[profile.release] +opt-level = "s" +codegen-units = 1 +lto = "thin" +strip = true +panic = "abort" diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..078619b --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# ARSnova-client + +An ARSnova live feedback client library + +## Usage + +### Initialize client and login + +Create a client using and request guest login. + +```rust +let client = Client::new("https://ars.particify.de/api").expect("client created"); +client.guest_login().await; +``` + +### Request room information + +The room information contains the name, ID and the 8-digit short ID of the requested room. + +```rust +let room_info = client.get_room_info("12345678").await.expect("room information"); +``` + +### Feedback + +You can get feedback information in two different ways: Direct request and getting notified about changes. + +#### Direct request + +You can request (poll) the current feedback: + +```rust +let feedback = client.get_feedback("12345678").await.expect("current feedback"); +``` + +#### Getting notified + +To handle feedback changes, you can use a handler function or forward the feedback to a channel. + +Handle feedback changes using a function: + +```rust +client.on_feedback_changed( & cli.room, FeedbackHandler::Fn(|feedback| {/*...*/})).await; +``` + +Forward feedback to a channel: + +```rust +let (tx, rx) = tokio::sync::mpsc::channel::(10); + +client.on_feedback_changed( & cli.room, FeedbackHandler::Sender(tx.clone())).await; +``` \ No newline at end of file diff --git a/src/client.rs b/src/client.rs new file mode 100644 index 0000000..2975bc1 --- /dev/null +++ b/src/client.rs @@ -0,0 +1,322 @@ +/* + * This file is part of arsnova-client + * + * Copyright (C) 2023 Paul-Christian Volkmer + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + */ + +use std::fmt::Display; +use std::time::Duration; + +use futures_util::{SinkExt, StreamExt}; +use serde::Deserialize; +use tokio::join; +use tokio::sync::mpsc::Sender; +use tokio_tungstenite::connect_async; +use tokio_tungstenite::tungstenite::Message; +use url::Url; + +#[derive(Deserialize, Debug)] +struct LoginResponse { + #[serde(rename = "token")] + token: String, +} + +#[derive(Deserialize, Debug)] +struct MembershipResponse { + #[serde(rename = "id")] + id: String, + #[serde(rename = "shortId")] + short_id: String, + #[serde(rename = "name")] + name: String, +} + +struct WsConnectMessage { + token: String, +} + +impl WsConnectMessage { + fn new(token: &str) -> WsConnectMessage { + WsConnectMessage { + token: token.to_string(), + } + } +} + +impl Display for WsConnectMessage { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let str = format!( + "CONNECT\ntoken:{}\naccept-version:1.2,1.1,1.0\nheart-beat:20000,0\n\n\0", + self.token + ); + write!(f, "{}", str) + } +} + +struct WsSubscribeMessage { + room_id: String, +} + +impl WsSubscribeMessage { + fn new(room_id: &str) -> WsSubscribeMessage { + WsSubscribeMessage { + room_id: room_id.to_string(), + } + } +} + +#[derive(Debug)] +struct WsFeedbackMessage { + body: WsFeedbackBody, +} + +impl WsFeedbackMessage { + fn parse(raw: &str) -> Result { + let parts = raw.split("\n\n"); + match serde_json::from_str::(parts.last().unwrap().replace('\0', "").trim()) + { + Ok(body) => Ok(WsFeedbackMessage { body }), + Err(_) => Err(()), + } + } +} + +#[derive(Deserialize, Debug)] +struct WsFeedbackBody { + #[serde(rename = "type")] + body_type: String, + payload: WsFeedbackPayload, +} + +#[derive(Deserialize, Debug)] +struct WsFeedbackPayload { + values: Vec, +} + +impl WsFeedbackPayload { + fn get_feedback(self) -> Feedback { + Feedback::from_values(self.values) + } +} + +impl Display for WsSubscribeMessage { + fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { + let str = format!( + "SUBSCRIBE\nid:sub-6\ndestination:/topic/{}.feedback.stream\n\n\0", + self.room_id + ); + write!(f, "{}", str) + } +} + +#[derive(Debug)] +pub struct RoomInfo { + pub id: String, + pub short_id: String, + pub name: String, + pub description: String, +} + +#[derive(Debug, Clone)] +pub struct Feedback { + pub very_good: u16, + pub good: u16, + pub bad: u16, + pub very_bad: u16, +} + +impl Feedback { + pub fn from_values(values: Vec) -> Feedback { + let mut result = Feedback { + very_good: 0, + good: 0, + bad: 0, + very_bad: 0, + }; + + if !values.is_empty() { + result.very_good = values[0] + } + if values.len() >= 2 { + result.good = values[1] + } + if values.len() >= 3 { + result.bad = values[2] + } + if values.len() >= 4 { + result.very_bad = values[3] + } + + result + } + + pub fn count_votes(&self) -> u16 { + self.very_good + self.good + self.bad + self.very_bad + } +} + +#[allow(dead_code)] +pub enum FeedbackHandler { + Fn(fn(&Feedback)), + Sender(Sender), +} + +pub struct Client { + api_url: String, + http_client: reqwest::Client, + token: Option, +} + +impl Client { + pub fn new(api_url: &str) -> Result { + let client = reqwest::Client::builder() + .user_agent(format!("arsnova-cli-client/{}", env!("CARGO_PKG_VERSION"))) + .build() + .map_err(|_| ())?; + + Ok(Client { + api_url: api_url.to_string(), + http_client: client, + token: None, + }) + } + + pub async fn guest_login(&mut self) -> Result<(), ()> { + match self + .http_client + .post(format!("{}/auth/login/guest", self.api_url)) + .send() + .await + { + Ok(res) => match res.json::().await { + Ok(res) => { + self.token = Some(res.token); + Ok(()) + } + Err(_) => Err(()), + }, + Err(_) => Err(()), + } + } + + pub async fn get_room_info(&self, short_id: &str) -> Result { + let token = self.token.as_ref().unwrap(); + + let membership_response = match self + .http_client + .post(format!( + "{}/room/~{}/request-membership", + self.api_url, short_id + )) + .bearer_auth(token.to_string()) + .header("ars-room-role", "PARTICIPANT") + .header("content-type", "application/json") + .body("{}") + .send() + .await + { + Ok(res) => res.json::().await.unwrap(), + Err(err) => { + eprintln!("{}", err); + return Err(()); + } + }; + + Ok(RoomInfo { + id: membership_response.id, + short_id: membership_response.short_id, + name: membership_response.name, + description: String::new(), + }) + } + + pub async fn get_feedback(&self, short_id: &str) -> Result { + let room_info = self.get_room_info(short_id).await?; + + let res = self + .http_client + .get(format!("{}/room/{}/survey", self.api_url, room_info.id)) + .bearer_auth(self.token.as_ref().unwrap_or(&"".to_string()).to_string()) + .send() + .await + .map_err(|_| ())?; + + Ok(Feedback::from_values(res.json::>().await.unwrap())) + } + + pub async fn on_feedback_changed( + &self, + short_id: &str, + handler: FeedbackHandler, + ) -> Result<(), ()> { + let room_info = self.get_room_info(short_id).await?; + + let ws_url = self.api_url.replace("http", "ws"); + let (socket, _) = connect_async(Url::parse(&format!("{}/ws/websocket", ws_url)).unwrap()) + .await + .map_err(|_| ())?; + + let (mut write, read) = socket.split(); + + if write + .send(Message::Text( + WsConnectMessage::new(self.token.as_ref().unwrap()).to_string(), + )) + .await + .is_ok() + { + match write + .send(Message::Text( + WsSubscribeMessage::new(&room_info.id).to_string(), + )) + .await + { + Ok(_) => {} + Err(_) => return Err(()), + } + + let jh1 = read.for_each(|msg| async { + if let Ok(msg) = msg { + if msg.is_text() && msg.clone().into_text().unwrap().starts_with("MESSAGE") { + if let Ok(msg) = WsFeedbackMessage::parse(msg.to_text().unwrap()) { + if msg.body.body_type == "FeedbackChanged" { + let feedback = msg.body.payload.get_feedback(); + match &handler { + FeedbackHandler::Fn(f) => f(&feedback), + FeedbackHandler::Sender(tx) => { + let _ = tx.send(feedback).await; + } + }; + } + } + } + } + }); + + let jh2 = tokio::spawn(async move { + loop { + tokio::time::sleep(Duration::from_secs(15)).await; + let _ = write.send(Message::Text("\n".to_string())).await; + } + }); + + let _ = join!(jh1, jh2); + return Ok(()); + } + + Err(()) + } +} diff --git a/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..83f4ca7 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,22 @@ +/* + * This file is part of arsnova-client + * + * Copyright (C) 2023 Paul-Christian Volkmer + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License + * along with this program. If not, see . + */ + +pub mod client; + +pub use client::{Client, Feedback, FeedbackHandler, RoomInfo};