groupme-rust-stats 1.0.7

A rust command line tool which downloads the complete history of a groupme chat group. It also runs a few analytics on the data and displays as a plain text file.
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

A Tool to download all history of a GroupMe chat room
and runs a few stats on each user's messages in the group:

Prerequisites:
1) Create an application api key for GroupMe API
	- Go to https://dev.groupme.com/applications
	- Login with your account
	- Click "Create Application"
	- Set callback to "localhost"
	- Click save
	- Copy the value at `<user name>'s Access Token`
		- This will be used in the settings file as the `<Groupme_Api_Key>`
2) Get the group chat id:
	- Go to https://web.groupme.com/chats
	- Login with you account
	- Open the developer console by following one of these steps:
		https://balsamiq.com/support/faqs/browserconsole/
	- Look at the networking tab
	- Find the URL that matches this pattern:
		- https://api.groupme.com/v3/groups/0000000/messages?acceptFiles=1&limit=10
		- 0000000 -> This is the chat's Id, used in settings file as
		`<Groupme_Chat_Ids>`


Output:url

Two folders will be created when run:
- raw_output:
	- This holds all the raw JSON from the groupme API, file names are the timestamp range for the file's messages
- results:
	- messages.csv:

			| createdTimestamp | userId | userName@timeOfMessage| messageText | totaldabs | favorited_by | message_id |
   
	- users.csv:

			| userId | usernames (separated by comma) |
	- results.txt:
		- For each user in group, this file holds the follow stats:
			- Total Likes
			- Top Liked Messages
			- Ratio of amount of messages to likes
			- Who Liked My Messages:
				- An ordered list of the other users in the group with a total like count on this user's messages
			- Whos Messages Did I Like
				- An ordered list of other users in the group with the current user's total like count for their messages


How To Run:
- Option 1: (use Rust runtime)
	- Install Rust runtime time from here: 
		- https://www.rust-lang.org/tools/install
	- Clone repository
	- Change Settings.default.toml to Settings.toml and add the following information:

		group_ids = `<Groupme_Chat_Ids>` <br>
		api_key = `"<Groupme_Api_Key>"` <br>
		output_folder = `"<Relative_Path_Loction_For_Output_Folder>"` <br>
		results_folder = `"<Relative_Path_Location_For_Results_Folder>"`

	- Use command: 
		- `cargo run`
	- On complete you should see an output like the one below:

		![Alt text](readmePic/ExpectedOutPut.png?raw=true "ExpectedOutput")
- Option 2: (use binary file and run from command line/terminal)
	- Download binary from the releases (supports windows and linux [compiled on ubuntu 20.04]): 
		- https://github.com/taylorjbrown/groupme-rust-stats/releases/latest
		- If you are using the ubuntu version (non .exe file) make sure to run `chmod +x` on the file after the download
	- Create a folder, add the downloaded binary to it
	- Create a Settings.toml in the same folder as the binary
	- Add the following information to the settings file:

		group_ids = `<Groupme_Chat_Ids>` <br>
		api_key = `"<Groupme_Api_Key>"` <br>
		output_folder = `"<Relative_Path_Loction_For_Output_Folder>"` <br>
		results_folder = `"<Relative_Path_Location_For_Results_Folder>"`

	- Open command-line/terminal, navigate to folder that holds the binary
	- Run the following command: 
		- `./groupme-rust-stats`
	- On complete you should see an output like the one below:

		![Alt text](readmePic/ExpectedOutPut.png?raw=true "ExpectedOutput")
- Option 3: (install from cargo package manager)
	- Have rust runtime installed on machine
	- Run `cargo install groupme-rust-stats`
	- Add a Settings.toml file, in current folder, with the following details:
	
	
		group_ids = `<Groupme_Chat_Ids>` <br>
		api_key = `"<Groupme_Api_Key>"` <br>
		output_folder = `"<Relative_Path_Loction_For_Output_Folder>"` <br>
		results_folder = `"<Relative_Path_Location_For_Results_Folder>"`

	- Run package with `~/.cargo/bin/groupme-rust-stats`


#### If you found this tool useful and feel like buying me a coffee/beer please donate with the button below:
[![](readmePic/lightningPay.png)](https://www.lndonationscode.duckdns.org:33938/api/v1/invoices?storeId=9MoCExvosJ7hGKE4WQpb6xqAnZkSRrH5CQXUkPjqq9h&notifyEmail=taylorjbrown%40protonmail.com&price=3&currency=USD)