slackrs 0.3.0

Provides a CLI and library functions to analyze Slack message data exports (zipped JSONs with a Slack-specific structure) and plot statistics.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

/// slackrs: a simple command-line tool to create plots from Slack data exports.
use clap::Parser;
use slackrs::{plot, slack, plot::PlotTask, slack::MessageInChannel};
use std::{fs, io::Error, io::ErrorKind, path::PathBuf, result::Result};

#[derive(Parser)]
struct Cli {
    #[arg(
        short = 'i',
        long = "input-file",
        help = "The input file to analyze, in the ZIP format provided by Slack's export."
    )]
    input_file: PathBuf,

    #[arg(
        short = 'o',
        long = "output-dir",
        default_value = "./output",
        help = "The output directory for the plots."
    )]
    output_dir: PathBuf,

    #[arg(
        short = 'c',
        long = "task-file",
        default_value = "tasks.json",
        help = "The JSON file with the tasks to run (see README for examples)."
    )]
    task_file: PathBuf,
}

impl Cli {
    fn validate(self: &Cli) -> Result<(), Error> {
        if !self.input_file.is_file() {
            Err(Error::new(
                ErrorKind::InvalidInput,
                format!("The input file '{:?}' is not a file.", self.input_file),
            ))
        } else if !self.task_file.is_file() {
            Err(Error::new(
                ErrorKind::InvalidInput,
                format!("The task file '{:?}' is not a file.", self.task_file),
            ))
        } else if self.output_dir.is_file() {
            Err(Error::new(
                ErrorKind::InvalidInput,
                format!("The output directory '{:?}' is a file.", self.output_dir),
            ))
        } else if !self.output_dir.exists() {
            println!(
                "Creating output directory '{:?}', as it does not yet exist.",
                self.output_dir
            );
            fs::create_dir_all(&self.output_dir)
        } else {
            Ok(())
        }
    }
}

fn main() {
    let args = Cli::parse();
    let validation_result = args.validate();
    if validation_result.is_err() {
        eprintln!(
            "Stopping, as input parameters are invalid: '{:?}'.",
            validation_result.err()
        );
    } else {
        // Start with reading tasks file, as this is faster and more likely to fail
        let tasks: Vec<PlotTask> = plot::read_tasks_from_file(args.task_file.to_str().unwrap(), &args.output_dir)
        .expect("Failed to read tasks from file");
        println!(
            "Found {} tasks in task file '{:?}'.",
            tasks.len(),
            args.task_file.file_name().unwrap()
        );

        let messages: Vec<MessageInChannel> = slack::read_zip_contents(&args.input_file);
        let _ = slackrs::process_tasks(&tasks, &messages);
        println!("Done.");
    }
}