improved paste/review API

Author: Heliozoa

tmc-client/src/tmc_client.rs

@@ -1,6 +1,7 @@
 //! Contains the TmcClient struct for communicating with the TMC server.
 pub mod api_v8;
 
+use self::api_v8::{PasteData, ReviewData};
 use crate::error::ClientError;
 use crate::request::*;
 use crate::response::*;
@@ -203,15 +204,6 @@ impl TmcClient {
         api_v8::core::get_exercise_details(self, exercise_ids)
     }
 
-    /// Fetches the course's information. Requires authentication.
-    ///
-    /// # Errors
-    /// If not authenticated, there's some problem reaching the API, or if the API returns an error.
-    pub fn get_course_submissions(&self, course_id: u32) -> Result<Vec<Submission>, ClientError> {
-        self.require_authentication()?;
-        api_v8::submission::get_course_submissions_by_id(self, course_id)
-    }
-
     /// Fetches all courses under the given organization. Requires authentication.
     ///
     /// # Errors
@@ -275,11 +267,17 @@ impl TmcClient {
             None,
         );
 
+        let paste = if let Some(message) = paste_message {
+            PasteData::WithMessage(message)
+        } else {
+            PasteData::WithoutMessage
+        };
+
         let result = api_v8::core::submit_exercise(
             self,
             exercise_id,
             Cursor::new(compressed),
-            paste_message,
+            Some(paste),
             None,
             locale,
         )?;
@@ -531,20 +529,26 @@ impl TmcClient {
         &self,
         exercise_id: u32,
         submission_path: &Path,
-        message_for_reviewer: String,
+        message_for_reviewer: Option<String>,
         locale: Option<Language>,
     ) -> Result<NewSubmission, ClientError> {
         self.require_authentication()?;
 
         // compress
         let compressed = tmc_langs_plugins::compress_project_to_zip(submission_path)?;
 
+        let review = if let Some(message) = message_for_reviewer {
+            ReviewData::WithMessage(message)
+        } else {
+            ReviewData::WithoutMessage
+        };
+
         api_v8::core::submit_exercise(
             self,
             exercise_id,
             Cursor::new(compressed),
             None,
-            Some(message_for_reviewer),
+            Some(review),
             locale,
         )
     }

tmc-client/src/tmc_client/api_v8.rs

@@ -13,6 +13,16 @@ use std::{collections::HashMap, time::SystemTime};
 use tmc_langs_plugins::Language;
 use url::Url;
 
+pub enum PasteData {
+    WithoutMessage,
+    WithMessage(String),
+}
+
+pub enum ReviewData {
+    WithoutMessage,
+    WithMessage(String),
+}
+
 // joins the URL "tail" with the API url root from the client
 fn make_url(client: &TmcClient, tail: impl AsRef<str>) -> Result<Url, ClientError> {
     client
@@ -843,8 +853,8 @@ pub mod core {
         client: &TmcClient,
         exercise_id: u32,
         submission_zip: impl Read + Send + Sync + 'static,
-        paste_message: Option<String>,
-        message_for_reviewer: Option<String>,
+        submit_paste: Option<PasteData>,
+        submit_for_review: Option<ReviewData>,
         locale: Option<Language>,
     ) -> Result<NewSubmission, ClientError> {
         let url = make_url(
@@ -867,16 +877,17 @@ pub mod core {
                 Part::reader(submission_zip).file_name("submission.zip"),
             );
 
-        if let Some(paste_message) = paste_message {
-            form = form
-                .text("paste", "1")
-                .text("message_for_paste", paste_message);
+        if let Some(submit_paste) = submit_paste {
+            form = form.text("paste", "1");
+            if let PasteData::WithMessage(message) = submit_paste {
+                form = form.text("message_for_paste", message);
+            }
         }
-
-        if let Some(message_for_reviewer) = message_for_reviewer {
-            form = form
-                .text("request_review", "1")
-                .text("message_for_reviewer", message_for_reviewer);
+        if let Some(submit_for_review) = submit_for_review {
+            form = form.text("request_review", "1");
+            if let ReviewData::WithMessage(message) = submit_for_review {
+                form = form.text("message_for_reviewer", message);
+            }
         }
 
         if let Some(locale) = locale {
@@ -2398,8 +2409,8 @@ mod test {
             client,
             0,
             Cursor::new(vec![]),
-            Some("paste".to_string()),
-            Some("message".to_string()),
+            Some(PasteData::WithMessage("paste".to_string())),
+            Some(ReviewData::WithMessage("message".to_string())),
             Some(Language::from_639_1("fi").unwrap()),
         )
         .unwrap();

tmc-langs-cli/src/app.rs

@@ -420,7 +420,7 @@ pub enum Core {
         locale: Locale,
         /// Message for the review.
         #[structopt(long)]
-        message_for_reviewer: String,
+        message_for_reviewer: Option<String>,
         /// Path to the directory where the submission resides.
         #[structopt(long)]
         submission_path: PathBuf,