Initial commit

.gitignore

@@ -0,0 +1 @@
+/target

Cargo.toml

@@ -0,0 +1,30 @@
+[package]
+name = "contextswitch"
+version = "0.1.0"
+edition = "2021"
+authors = ["David Rousselie <david@rousselie.name>"]
+
+[lib]
+path = "src/lib.rs"
+
+[[bin]]
+path = "src/main.rs"
+name = "contextswitch"
+
+[dependencies]
+actix-web = "=4.0.0-beta.10"
+actix-http = "=3.0.0-beta.11"
+serde = "1.0.130"
+serde_json = "1.0.71"
+uuid = { version = "0.8.2", features = ["serde"] }
+chrono = { version = "0.4.19", features = ["serde"] }
+mktemp = "0.4.1"
+configparser = "3.0.0"
+env_logger = "0.9.0"
+dotenv = "0.15.0"
+listenfd = "0.3.5"
+
+[dev-dependencies]
+actix-rt = "2"
+reqwest = "0.11.6"
+tokio = "1"

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 David Rousselie
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,2 @@
+# contextswitch
+

src/lib.rs

@@ -0,0 +1,82 @@
+use actix_web::{dev::Server, middleware::Logger, web, App, HttpResponse, HttpServer};
+use chrono::{DateTime, Utc};
+use listenfd::ListenFd;
+use serde::{Deserialize, Serialize};
+use std::io::Error;
+use std::net::TcpListener;
+use uuid::Uuid;
+
+pub mod taskwarrior;
+
+#[derive(Deserialize)]
+struct TaskQuery {
+    filter: String,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+pub struct Task {
+    pub uuid: Uuid,
+    pub id: u32,
+    #[serde(with = "taskwarrior::tw_date_format")]
+    pub entry: DateTime<Utc>,
+    #[serde(with = "taskwarrior::tw_date_format")]
+    pub modified: DateTime<Utc>,
+    pub status: taskwarrior::Status,
+    pub description: String,
+    pub urgency: f64,
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        with = "taskwarrior::opt_tw_date_format"
+    )]
+    pub due: Option<DateTime<Utc>>,
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        with = "taskwarrior::opt_tw_date_format"
+    )]
+    pub end: Option<DateTime<Utc>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub parent: Option<Uuid>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub project: Option<String>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub recur: Option<taskwarrior::Recurrence>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub tags: Option<Vec<String>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub contextswitch: Option<taskwarrior::ContextSwitchMetadata>,
+}
+
+async fn list_tasks(task_query: web::Query<TaskQuery>) -> Result<HttpResponse, Error> {
+    let tasks = taskwarrior::export(task_query.filter.split(' ').collect())?;
+
+    Ok(HttpResponse::Ok()
+        .content_type("application/json")
+        .body(serde_json::to_string(&tasks)?))
+}
+
+async fn health_check() -> HttpResponse {
+    HttpResponse::Ok().finish()
+}
+
+pub fn run(listener: TcpListener) -> Result<Server, std::io::Error> {
+    let mut server = HttpServer::new(|| {
+        App::new()
+            .wrap(Logger::default())
+            .route("/ping", web::get().to(health_check))
+            .route("/tasks", web::get().to(list_tasks))
+    })
+    .keep_alive(60)
+    .shutdown_timeout(60);
+
+    let mut listenfd = ListenFd::from_env();
+
+    server = if let Some(fdlistener) = listenfd.take_tcp_listener(0)? {
+        server.listen(fdlistener)?
+    } else {
+        server.listen(listener)?
+    };
+
+    Ok(server.run())
+}

src/main.rs

@@ -0,0 +1,22 @@
+extern crate dotenv;
+extern crate env_logger;
+extern crate listenfd;
+
+use contextswitch::run;
+use dotenv::dotenv;
+use std::env;
+use std::net::TcpListener;
+
+pub mod taskwarrior;
+
+#[actix_web::main]
+async fn main() -> std::io::Result<()> {
+    env::set_var("RUST_LOG", "actix_web=info");
+    env_logger::init();
+    dotenv().ok();
+
+    let port = env::var("PORT").unwrap_or("8000".to_string());
+
+    let listener = TcpListener::bind(format!("0.0.0.0:{}", port)).expect("Failed to bind port");
+    run(listener)?.await
+}

src/taskwarrior.rs

@@ -0,0 +1,146 @@
+use chrono::{DateTime, Utc};
+use serde::{de, Deserialize, Deserializer, Serialize};
+use serde_json;
+use std::io::Error;
+use std::process::Command;
+use std::str;
+use uuid::Uuid;
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum Recurrence {
+    Daily,
+    Weekly,
+    Monthly,
+    Yearly,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "lowercase")]
+pub enum Status {
+    Pending,
+    Completed,
+    Recurring,
+    Deleted,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+pub struct ContextSwitchMetadata {
+    pub test: u32,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+pub struct Task {
+    pub uuid: Uuid,
+    pub id: u32,
+    #[serde(with = "tw_date_format")]
+    pub entry: DateTime<Utc>,
+    #[serde(with = "tw_date_format")]
+    pub modified: DateTime<Utc>,
+    pub status: Status,
+    pub description: String,
+    pub urgency: f64,
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        with = "opt_tw_date_format"
+    )]
+    pub due: Option<DateTime<Utc>>,
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        with = "opt_tw_date_format"
+    )]
+    pub end: Option<DateTime<Utc>>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub parent: Option<Uuid>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub project: Option<String>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub recur: Option<Recurrence>,
+    #[serde(default, skip_serializing_if = "Option::is_none")]
+    pub tags: Option<Vec<String>>,
+    #[serde(
+        default,
+        skip_serializing_if = "Option::is_none",
+        deserialize_with = "deserialize_from_json"
+    )]
+    pub contextswitch: Option<ContextSwitchMetadata>,
+}
+
+fn deserialize_from_json<'de, D>(deserializer: D) -> Result<Option<ContextSwitchMetadata>, D::Error>
+where
+    D: Deserializer<'de>,
+{
+    let s: String = Deserialize::deserialize(deserializer)?;
+    serde_json::from_str(&s).map_err(de::Error::custom)
+}
+
+pub mod tw_date_format {
+    use chrono::{DateTime, TimeZone, Utc};
+    use serde::{self, Deserialize, Deserializer, Serializer};
+
+    const FORMAT: &'static str = "%Y%m%dT%H%M%SZ";
+
+    pub fn serialize<S>(date: &DateTime<Utc>, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        let s = format!("{}", date.format(FORMAT));
+        serializer.serialize_str(&s)
+    }
+
+    pub fn deserialize<'de, D>(deserializer: D) -> Result<DateTime<Utc>, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s = String::deserialize(deserializer)?;
+        Utc.datetime_from_str(&s, FORMAT)
+            .map_err(serde::de::Error::custom)
+    }
+}
+
+pub mod opt_tw_date_format {
+    use chrono::{DateTime, TimeZone, Utc};
+    use serde::{self, Deserialize, Deserializer, Serializer};
+
+    const FORMAT: &'static str = "%Y%m%dT%H%M%SZ";
+
+    pub fn serialize<S>(date: &Option<DateTime<Utc>>, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        if let Some(ref d) = *date {
+            return serializer.serialize_str(&d.format(FORMAT).to_string());
+        }
+
+        serializer.serialize_none()
+    }
+
+    pub fn deserialize<'de, D>(deserializer: D) -> Result<Option<DateTime<Utc>>, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s = String::deserialize(deserializer)?;
+        Utc.datetime_from_str(&s, FORMAT)
+            .map(Some)
+            .map_err(serde::de::Error::custom)
+    }
+}
+
+pub fn export(filters: Vec<&str>) -> Result<Vec<Task>, Error> {
+    let mut args = vec!["export"];
+    args.extend(filters);
+    let export_output = Command::new("task").args(args).output()?;
+
+    let tasks: Vec<Task> = serde_json::from_slice(&export_output.stdout)?;
+
+    return Ok(tasks);
+}
+
+pub fn add(add_args: Vec<&str>) -> Result<(), Error> {
+    let mut args = vec!["add"];
+    args.extend(add_args);
+    Command::new("task").args(args).output()?;
+    return Ok(());
+}

tests/health_check.rs

@@ -0,0 +1,16 @@
+pub mod test_helper;
+
+#[actix_rt::test]
+async fn health_check_works() {
+    let address = test_helper::spawn_app();
+    let client = reqwest::Client::new();
+
+    let response = client
+        .get(&format!("{}/ping", &address))
+        .send()
+        .await
+        .expect("Failed to execute request.");
+
+    assert!(response.status().is_success());
+    assert_eq!(Some(0), response.content_length());
+}

tests/task.rs

@@ -0,0 +1,27 @@
+pub mod test_helper;
+
+use contextswitch::taskwarrior;
+use contextswitch::Task;
+
+#[actix_rt::test]
+async fn list_tasks() {
+    let task_data_path = test_helper::setup_tasks();
+    let address = test_helper::spawn_app();
+    let client = reqwest::Client::new();
+    taskwarrior::add(vec!["test1", "contextswitch:'{\"test\": 1}'"]).unwrap();
+
+    let response = client
+        .get(&format!("{}/tasks?filter=ls", &address))
+        .send()
+        .await
+        .expect("Failed to execute request.");
+
+    test_helper::clear_tasks(task_data_path);
+    let text_body = response.text_with_charset("utf-8").await.unwrap();
+    let tasks: Vec<Task> = serde_json::from_str(&text_body).unwrap();
+    assert_eq!(tasks.len(), 1);
+    assert_eq!(tasks[0].description, "test1");
+
+    let cs_metadata = tasks[0].contextswitch.as_ref().unwrap();
+    assert_eq!(cs_metadata.test, 1);
+}

tests/test_helper.rs

@@ -0,0 +1,45 @@
+use configparser::ini::Ini;
+use mktemp::Temp;
+use std::env;
+use std::fs;
+use std::net::TcpListener;
+use std::path::PathBuf;
+
+pub fn spawn_app() -> String {
+    let listener = TcpListener::bind("127.0.0.1:0").expect("Failed to bind random port");
+    let port = listener.local_addr().unwrap().port();
+
+    let server = contextswitch::run(listener).expect("Failed to bind address");
+    let _ = tokio::spawn(server);
+    format!("http://127.0.0.1:{}", port)
+}
+
+pub fn setup_tasks() -> PathBuf {
+    let mut config = Ini::new();
+    config.setstr("default", "uda.contextswitch.type", Some("string"));
+    config.setstr(
+        "default",
+        "uda.contextswitch.label",
+        Some("Context Switch metadata"),
+    );
+    config.setstr("default", "uda.contextswitch.default", Some("{}"));
+
+    let tmp_dir = Temp::new_dir().unwrap();
+    let task_data_path = tmp_dir.to_path_buf();
+    config.setstr(
+        "default",
+        "data.location",
+        Some(task_data_path.to_str().unwrap()),
+    );
+
+    let taskrc_path = task_data_path.join(".taskrc");
+    config.write(taskrc_path.as_path()).unwrap();
+    env::set_var("TASKRC", taskrc_path.to_str().unwrap());
+
+    tmp_dir.release();
+    return task_data_path;
+}
+
+pub fn clear_tasks(task_data_path: PathBuf) {
+    fs::remove_dir_all(task_data_path).unwrap();
+}