Validation of GH profile #20

rimutaka · rimutaka · commit bc01cb0b72c6 · 2021-08-24T01:44:05.000Z
diff --git a/samples/validation_gist.json b/samples/validation_gist.json
@@ -0,0 +1,82 @@
+{
+  "url": "https://api.github.com/gists/fb8fc0f87ee78231f064131022c8154a",
+  "forks_url": "https://api.github.com/gists/fb8fc0f87ee78231f064131022c8154a/forks",
+  "commits_url": "https://api.github.com/gists/fb8fc0f87ee78231f064131022c8154a/commits",
+  "id": "fb8fc0f87ee78231f064131022c8154a",
+  "node_id": "MDQ6R2lzdGZiOGZjMGY4N2VlNzgyMzFmMDY0MTMxMDIyYzgxNTRh",
+  "git_pull_url": "https://gist.github.com/fb8fc0f87ee78231f064131022c8154a.git",
+  "git_push_url": "https://gist.github.com/fb8fc0f87ee78231f064131022c8154a.git",
+  "html_url": "https://gist.github.com/fb8fc0f87ee78231f064131022c8154a",
+  "files": {
+    "stm.txt": {
+      "filename": "stm.txt",
+      "type": "text/plain",
+      "language": "Text",
+      "raw_url": "https://gist.githubusercontent.com/rimutaka/fb8fc0f87ee78231f064131022c8154a/raw/1e99cbb2ae82c4ebfb3df7195a150f81142b894a/stm.txt",
+      "size": 17,
+      "truncated": false,
+      "content": "MDQ6R2lzdGZiOGZjMGY4N2VlNzgyMzFmMDY0MTMxMDIyYzgxNTRh"
+    }
+  },
+  "public": false,
+  "created_at": "2021-08-14T04:20:07Z",
+  "updated_at": "2021-08-14T04:20:07Z",
+  "description": "",
+  "comments": 0,
+  "user": null,
+  "comments_url": "https://api.github.com/gists/fb8fc0f87ee78231f064131022c8154a/comments",
+  "owner": {
+    "login": "rimutaka",
+    "id": 5926028,
+    "node_id": "MDQ6VXNlcjU5MjYwMjg=",
+    "avatar_url": "https://avatars.githubusercontent.com/u/5926028?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/rimutaka",
+    "html_url": "https://github.com/rimutaka",
+    "followers_url": "https://api.github.com/users/rimutaka/followers",
+    "following_url": "https://api.github.com/users/rimutaka/following{/other_user}",
+    "gists_url": "https://api.github.com/users/rimutaka/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/rimutaka/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/rimutaka/subscriptions",
+    "organizations_url": "https://api.github.com/users/rimutaka/orgs",
+    "repos_url": "https://api.github.com/users/rimutaka/repos",
+    "events_url": "https://api.github.com/users/rimutaka/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/rimutaka/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "forks": [],
+  "history": [
+    {
+      "user": {
+        "login": "rimutaka",
+        "id": 5926028,
+        "node_id": "MDQ6VXNlcjU5MjYwMjg=",
+        "avatar_url": "https://avatars.githubusercontent.com/u/5926028?v=4",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/rimutaka",
+        "html_url": "https://github.com/rimutaka",
+        "followers_url": "https://api.github.com/users/rimutaka/followers",
+        "following_url": "https://api.github.com/users/rimutaka/following{/other_user}",
+        "gists_url": "https://api.github.com/users/rimutaka/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/rimutaka/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/rimutaka/subscriptions",
+        "organizations_url": "https://api.github.com/users/rimutaka/orgs",
+        "repos_url": "https://api.github.com/users/rimutaka/repos",
+        "events_url": "https://api.github.com/users/rimutaka/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/rimutaka/received_events",
+        "type": "User",
+        "site_admin": false
+      },
+      "version": "0d2c74fcd6167f9a2de514ed75d48bba2bd8361a",
+      "committed_at": "2021-08-14T04:20:07Z",
+      "change_status": {
+        "total": 1,
+        "additions": 1,
+        "deletions": 0
+      },
+      "url": "https://api.github.com/gists/fb8fc0f87ee78231f064131022c8154a/0d2c74fcd6167f9a2de514ed75d48bba2bd8361a"
+    }
+  ],
+  "truncated": false
+}
diff --git a/stackmuncher/src/app_args.rs b/stackmuncher/src/app_args.rs
@@ -1,8 +1,12 @@
 use crate::help;
 use pico_args;
+use regex::Regex;
+use std::env::consts::EXE_SUFFIX;
 use std::str::FromStr;
 use std::{path::PathBuf, process::exit};
 
+pub(crate) const GIST_ID_REGEX: &str = "[a-f0-9]{32}";
+
 /// List of valid app commands
 #[derive(PartialEq)]
 pub(crate) enum AppArgCommands {
@@ -16,6 +20,8 @@ pub(crate) enum AppArgCommands {
     MakeAnon,
     /// Completely delete the member profile from the directory
     DeleteProfile,
+    /// Configure Github validation page
+    GitGHubConfig,
 }
 
 /// A container for user-provided CLI commands and params. The names of the members correspond
@@ -25,8 +31,9 @@ pub(crate) struct AppArgs {
     pub dryrun: bool,
     pub primary_email: Option<String>,
     pub emails: Option<Vec<String>>,
-    pub public_name: Option<String>,
-    pub public_contact: Option<String>,
+    /// A 32-byte long hex string of the Gist ID with the validation string for the user's GH account
+    /// E.g. `fb8fc0f87ee78231f064131022c8154a`
+    pub gh_validation_id: Option<String>,
     pub project: Option<PathBuf>,
     pub rules: Option<PathBuf>,
     pub reports: Option<PathBuf>,
@@ -45,6 +52,7 @@ impl FromStr for AppArgCommands {
             "viewconfig" | "view-config" | "view_config" | "config" => Self::ViewConfig,
             "makeanon" | "make-anon" | "make_anon" => Self::MakeAnon,
             "deleteprofile" | "delete-profile" | "delete_profile" | "delete" => Self::DeleteProfile,
+            "github" => Self::GitGHubConfig,
             _ => {
                 eprintln!("STACKMUNCHER CONFIG ERROR: invalid command `{}`", command);
                 help::emit_usage_msg();
@@ -65,8 +73,7 @@ impl AppArgs {
             dryrun: false,
             primary_email: None,
             emails: None,
-            public_name: None,
-            public_contact: None,
+            gh_validation_id: None,
             project: None,
             rules: None,
             reports: None,
@@ -124,15 +131,35 @@ impl AppArgs {
             app_args.emails = Some(emails);
         };
 
-        // --public_name
-        if let Some(public_name) = find_arg_value(&mut pargs, vec!["--public_name", "--public-name", "--publicname"]) {
-            app_args.public_name = Some(public_name);
-        };
-        // --public_contact
-        if let Some(public_contact) =
-            find_arg_value(&mut pargs, vec!["--public_contact", "--public-contact", "--public_contact"])
-        {
-            app_args.public_contact = Some(public_contact);
+        // --gist
+        if let Some(gist_url) = find_arg_value(&mut pargs, vec!["--gist"]) {
+            // extract the gist id from the input, which can be the full URL, just the ID or the raw URL which is even longer
+            // e.g. fb8fc0f87ee78231f064131022c8154a
+            // or https://gist.github.com/rimutaka/fb8fc0f87ee78231f064131022c8154a
+            // or https://gist.githubusercontent.com/rimutaka/fb8fc0f87ee78231f064131022c8154a
+            // or https://gist.githubusercontent.com/rimutaka/fb8fc0f87ee78231f064131022c8154a/raw/1e99cbb2ae82c4ebfb3df7195a150f81142b894a/stm.txt
+
+            if gist_url.is_empty() {
+                // the user requested removal of GH login
+                app_args.gh_validation_id = Some(String::new());
+            } else if let Some(matches) = Regex::new(GIST_ID_REGEX)
+                .expect("Invalid gist_id_regex. It's a bug.")
+                .find(&gist_url)
+            {
+                // some value with a likely-looking gist id was provided
+                app_args.gh_validation_id = Some(matches.as_str().to_string());
+            } else {
+                // some other value was provided
+                eprintln!("STACKMUNCHER CONFIG ERROR: param `--gist` has an invalid value.",);
+                eprintln!();
+                eprintln!("    It accepts either the Gist URL or the Gist ID found in the Gist URL:",);
+                eprintln!("    * https://gist.github.com/rimutaka/fb8fc0f87ee78231f064131022c8154a");
+                eprintln!("    * fb8fc0f87ee78231f064131022c8154a");
+                eprintln!();
+                eprintln!("    To unlink from GitHub and remove private projects from your public profile use `stackmuncher{} --gist \"\"`", EXE_SUFFIX);
+                help::emit_usage_msg();
+                exit(1);
+            }
         };
 
         // project folder
@@ -258,7 +285,7 @@ fn find_arg_value(pargs: &mut pico_args::Arguments, arg_names: Vec<&'static str>
             Ok(v) => v,
             Err(_) => {
                 eprintln!(
-                    "STACKMUNCHER CONFIG ERROR: invalid or missing value for `{}`. Add \"\" to reset the value.",
+                    "STACKMUNCHER CONFIG ERROR: invalid or missing value for `{}`. Add \"\" to reset this setting.",
                     arg_name
                 );
                 help::emit_usage_msg();
diff --git a/stackmuncher/src/cmd_munch.rs b/stackmuncher/src/cmd_munch.rs
@@ -155,8 +155,6 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
             combined_report.recompute_tech_section();
 
             // add any personal details supplied via CLI or taken from the environment
-            combined_report.public_name = config.public_name.clone();
-            combined_report.public_contact = config.public_contact.clone();
             combined_report.primary_email = config.primary_email.clone();
 
             // check if there is a already a cached contributor report
diff --git a/stackmuncher/src/config.rs b/stackmuncher/src/config.rs
@@ -26,8 +26,12 @@ pub(crate) struct AppConfig {
     pub command: AppArgCommands,
     pub dryrun: bool,
     pub primary_email: Option<String>,
-    pub public_name: Option<String>,
-    pub public_contact: Option<String>,
+    /// A 32-byte long hex string of the Gist ID with the validation string for the user GH account
+    /// E.g. `fb8fc0f87ee78231f064131022c8154a`
+    pub gh_validation_id: Option<String>,
+    /// The URL is reconstructed from a Gist ID after validation.
+    /// It may seize to exist or change the contents, but the URL itself is guaranteed to be valid
+    pub gh_validation_url: Option<String>,
     /// Core config from stackmuncher_lib
     pub lib_config: Config,
     /// Extracted from the key file stored next to the config file
@@ -40,8 +44,9 @@ pub(crate) struct AppConfig {
 #[derive(Serialize, Deserialize, PartialEq)]
 struct AppConfigCache {
     pub primary_email: Option<String>,
-    pub public_name: Option<String>,
-    pub public_contact: Option<String>,
+    /// The URL is reconstructed from a Gist ID after validation.
+    /// It may seize to exist or change the contents, but the URL itself is guaranteed to be valid
+    pub gh_validation_url: Option<String>,
     pub git_identities: Vec<String>,
 }
 
@@ -202,69 +207,6 @@ impl AppConfig {
             None
         };
 
-        let public_name = if let Some(pub_name) = &app_args.public_name {
-            if pub_name.is_empty() {
-                // empty public name - make anon
-                println!("Your Directory Profile name was removed. Your profile will be anonymous.");
-                println!();
-                println!(
-                    "    Run `stackmuncher{} --public_name \"My Name or Nickname\"` to make it public.",
-                    EXE_SUFFIX
-                );
-                println!();
-            } else {
-                // a new public name was supplied
-                println!(
-                    "Your new Directory Profile name: {}. It is visible to anyone, including search engines.",
-                    pub_name
-                );
-                println!();
-                println!(
-                    "    Run `stackmuncher{} --public_name \"\"` to remove the name and make your profile anonymous.",
-                    EXE_SUFFIX
-                );
-                println!();
-            }
-            app_args.public_name
-        } else if app_config_cache.public_name.is_some() {
-            app_config_cache.public_name.clone()
-        } else {
-            None
-        };
-
-        let public_contact = if let Some(pub_contact) = &app_args.public_contact {
-            if pub_contact.is_empty() {
-                // no public contact details
-                if primary_email.is_some() && !primary_email.as_ref().unwrap().is_empty() {
-                    println!("Your Directory Profile contact details were removed. Employers will be able to express their interest via Directory notifications sent to {}.", primary_email.as_ref().unwrap());
-                } else {
-                    println!("Your Directory Profile contact details were removed. Since your primary email address is blank as well your profile will be hidden.");
-                }
-
-                println!();
-                println!(
-                    "    Run `stackmuncher{} --public_contact \"Your email, website or any other contact details\"` for employers to contact you directly.",
-                    EXE_SUFFIX
-                );
-                println!();
-            } else {
-                // new public contact details
-                println!(
-                    "Your new Directory Profile contact: {}. It is visible to anyone, including search engines.",
-                    pub_contact
-                );
-                println!();
-                println!("    Run `stackmuncher{} --public_contact \"\"` to remove it.", EXE_SUFFIX);
-                println!();
-            }
-
-            app_args.public_contact
-        } else if app_config_cache.public_contact.is_some() {
-            app_config_cache.public_contact.clone()
-        } else {
-            None
-        };
-
         // print a message about multiple git IDs on the first run
         if config.git_identities.len() > 0 && app_args.emails.is_none() && app_config_cache.git_identities.is_empty() {
             println!("Only commits from {} will be analyzed. Did you use any other email addresses for Git commits in the past?",config.git_identities[0]);
@@ -293,12 +235,26 @@ impl AppConfig {
             println!();
         }
 
+        // GitHub login validation - use the validated URL or None if --gist param was provided
+        // It means that the user requested a change of sorts.
+        // Otherwise use what is in the cache without any validation.
+        let gh_validation_url = if app_args.gh_validation_id.is_some() {
+            // --gist was present - so something was requested
+            match crate::configure::get_validated_gist(&app_args.gh_validation_id, &user_key_pair).await {
+                Some(gist) => Some(gist.html_url),
+                None => None,
+            }
+        } else {
+            // --gist was not present - use what's in cache
+            app_config_cache.gh_validation_url.clone()
+        };
+
         let app_config = AppConfig {
             command: app_args.command,
             dryrun: app_args.dryrun,
             primary_email,
-            public_name,
-            public_contact,
+            gh_validation_id: app_args.gh_validation_id,
+            gh_validation_url,
             lib_config: config,
             user_key_pair,
             config_file_path,
@@ -549,8 +505,7 @@ impl AppConfigCache {
         // create a blank dummy to return in case of a problem
         let app_config_cache = AppConfigCache {
             primary_email: None,
-            public_name: None,
-            public_contact: None,
+            gh_validation_url: None,
             git_identities: Vec::new(),
         };
 
@@ -602,8 +557,7 @@ impl AppConfigCache {
         // prepare the data to save
         let app_config_cache = AppConfigCache {
             primary_email: app_config.primary_email.clone(),
-            public_name: app_config.public_name.clone(),
-            public_contact: app_config.public_contact.clone(),
+            gh_validation_url: app_config.gh_validation_url.clone(),
             git_identities: app_config.lib_config.git_identities.clone(),
         };
 
diff --git a/stackmuncher/src/configure.rs b/stackmuncher/src/configure.rs
diff --git a/stackmuncher/src/help.rs b/stackmuncher/src/help.rs
