Added gh_validation_id to report #20

Author: rimutaka

README.md

@@ -10,13 +10,14 @@ The code analysis is non-judgemental. It simply collects the facts such as what
   - [Quick start](#quick-start)
   - [Adding more commit emails](#adding-more-commit-emails)
   - [Adding more projects to your profile](#adding-more-projects-to-your-profile)
+  - [Making your profile public](#making-your-profile-public)
   - [Using StackMuncher app on multiple machines](#using-stackmuncher-app-on-multiple-machines)
   - [Detailed usage instructions](#detailed-usage-instructions)
     - [Additional options](#additional-options)
       - [Processing settings](#processing-settings)
       - [Profile settings](#profile-settings)
       - [Debug settings](#debug-settings)
-      - [Additional commands](#additional-commands)
+      - [Additional info](#additional-info)
   - [Limitations](#limitations)
   - [Troubleshooting](#troubleshooting)
   - [Bug reports and contributions](#bug-reports-and-contributions)
@@ -225,7 +226,7 @@ We want to hear about as many issues users run into as possible. Copy-paste the
 * run `stackmuncher config` and check the output in `reports` folder - there should be at least 4 files:
     * _project_report.json_: includes all contributors 
     * _combined_report.json_: a combined report for authors/committers from Git's `user.email` setting and from `--emails` param
-    * _submitted_report.json_: a sanitized version of the combined report exactly as it was submitted to the Directory
+    * _submission.json_: a sanitized version of the combined report exactly as it is submitted to the Directory
     * _contributor_xxxxxxxx.json_: cached reports for individual contributors
 
 ## Bug reports and contributions

stackmuncher/src/cmd_config.rs

@@ -77,11 +77,18 @@ pub(crate) async fn view_config(config: AppConfig) {
         .to_string_lossy()
         .to_string();
 
-    let (public_profile, github_validation) =
-        match get_validated_gist(&config.gh_validation_id, &config.user_key_pair).await {
-            Some(v) => (["https://stackmuncher.com/", &v.login].concat(), v.html_url),
-            None => ("disabled".to_owned(), "not set".to_owned()),
-        };
+    // gh_validation_gist may already be in the config if --gist option was used and it was validated
+    // otherwise we need to re-validate it and get the details from github
+    let gh_validation_gist = match config.gh_validation_gist {
+        Some(v) => Some(v),
+        None => get_validated_gist(&config.gh_validation_id, &config.user_key_pair).await,
+    };
+
+    // prepare user-friendly GH validation messages
+    let (public_profile, github_validation) = match gh_validation_gist {
+        Some(v) => (["https://stackmuncher.com/", &v.login].concat(), v.html_url),
+        None => ("disabled".to_owned(), "not set".to_owned()),
+    };
 
     println!();
     println!("    Primary email: {}", config.primary_email.as_ref().unwrap_or(&"not set".to_owned()));

stackmuncher/src/cmd_munch.rs

@@ -156,6 +156,7 @@ pub(crate) async fn run(config: AppConfig) -> Result<(), ()> {
 
             // add any personal details supplied via CLI or taken from the environment
             combined_report.primary_email = config.primary_email.clone();
+            combined_report.gh_validation_id = config.gh_validation_id.clone();
 
             // check if there is a already a cached contributor report
             // it would have to be a dry run (no submission) if it's the first time STM is run on this repo

stackmuncher/src/config.rs

@@ -28,25 +28,24 @@ pub(crate) struct AppConfig {
     pub primary_email: Option<String>,
     /// A 32-byte long hex string of the Gist ID with the validation string for the user GH account
     /// E.g. `fb8fc0f87ee78231f064131022c8154a`
+    /// It is validated on change and then cached in config.json
     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
     pub user_key_pair: Ed25519KeyPair,
     /// The full path to the config file.
     pub config_file_path: PathBuf,
+    /// A stash for validation Gist details to avoid going to GitHub twice
+    /// Not cached and can only be present if --gist param was used to link to a new github a/c
+    pub gh_validation_gist: Option<crate::cmd_config::Gist>,
 }
 
 /// A container for storing some config info locally as a file.
 #[derive(Serialize, Deserialize, PartialEq)]
 struct AppConfigCache {
     pub primary_email: 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 gh_validation_id: Option<String>,
     pub git_identities: Vec<String>,
 }
 
@@ -235,29 +234,30 @@ impl AppConfig {
             println!();
         }
 
-        // GitHub login validation - use the validated URL or None if --gist param was provided
+        // GitHub login validation - use the validated ID 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
+        let (gh_validation_id, gh_validation_gist) = if app_args.gh_validation_id.is_some() {
+            // --gist was present - so a change was requested by the user
             match crate::cmd_config::get_validated_gist(&app_args.gh_validation_id, &user_key_pair).await {
-                Some(gist) => Some(gist.html_url),
-                None => None,
+                // the gist struct will be needed to print config details later
+                Some(gist) => (app_args.gh_validation_id.clone(), Some(gist)),
+                None => (None, None),
             }
         } else {
             // --gist was not present - use what's in cache
-            app_config_cache.gh_validation_url.clone()
+            (app_config_cache.gh_validation_id.clone(), None)
         };
 
         let app_config = AppConfig {
             command: app_args.command,
             dryrun: app_args.dryrun,
             primary_email,
-            gh_validation_id: app_args.gh_validation_id,
-            gh_validation_url,
+            gh_validation_id,
             lib_config: config,
             user_key_pair,
             config_file_path,
+            gh_validation_gist,
         };
 
         app_config_cache.save(&app_config);
@@ -505,7 +505,7 @@ impl AppConfigCache {
         // create a blank dummy to return in case of a problem
         let app_config_cache = AppConfigCache {
             primary_email: None,
-            gh_validation_url: None,
+            gh_validation_id: None,
             git_identities: Vec::new(),
         };
 
@@ -557,7 +557,7 @@ impl AppConfigCache {
         // prepare the data to save
         let app_config_cache = AppConfigCache {
             primary_email: app_config.primary_email.clone(),
-            gh_validation_url: app_config.gh_validation_url.clone(),
+            gh_validation_id: app_config.gh_validation_id.clone(),
             git_identities: app_config.lib_config.git_identities.clone(),
         };
 

stackmuncher_lib/src/report.rs

@@ -55,6 +55,11 @@ pub struct Report {
     /// A unique name containing user name and project name when stored in S3, e.g. `rimutaka/stackmuncher.report`
     #[serde(skip_serializing_if = "String::is_empty", default = "String::new")]
     pub report_s3_name: String,
+    /// A GH ownership validation Gist ID.
+    /// E.g. fb8fc0f87ee78231f064131022c8154a from https://gist.github.com/rimutaka/fb8fc0f87ee78231f064131022c8154a
+    /// The app validates it, but it has to be re-checked on the server on changes and possibly more often.
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub gh_validation_id: Option<String>,
     /// The very last commit at the time of the report generation.
     #[serde(skip_serializing_if = "Option::is_none")]
     pub report_commit_sha1: Option<String>,
@@ -512,6 +517,7 @@ impl Report {
             first_contributor_commit_date_epoch: None,
             owner_id: None,
             project_id: None,
+            gh_validation_id: None,
         }
     }