https://github.com/arkaeriit/devzat-extractor

A plugin to extract messages from Devzat.
https://github.com/arkaeriit/devzat-extractor

Last synced: 26 days ago
JSON representation

A plugin to extract messages from Devzat.

• Host: GitHub
• URL: https://github.com/arkaeriit/devzat-extractor
• Owner: Arkaeriit
• License: bsd-3-clause
• Created: 2023-08-17T09:04:44.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-08-09T15:36:08.000Z (5 months ago)
• Last Synced: 2024-08-10T12:43:24.050Z (5 months ago)
• Language: Go
• Size: 13.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Devzat-Extractor

On [Devzat](https://github.com/quackduck/devzat), people send a lot of messages and can have meaningful conversations. If you want to save those conversations, this plugin serves them over a web interface.

## In-chat usage

This plugins listen to every messages it receives. If you want to extract the messages sent in the last 30 minutes in the current room, use the command `extract 30m`. The plugin will reply with an URL such as `https://devzat.bobignou.red/timespan/main/1692250655/1692261454/extract.txt`. On it, you will find all the messages you wanted.

## Web API

The web API offers two routes:

* `/timespan////extract.txt`: extracts the messages from the given room sent between the two UNIX timestamps `from` and `to`.

* `/timespan-all///extract.txt`: extracts the messages from every room sent between the two UNIX timestamps `from` and `to`.

It will reply a 200 code if some messages are recovered, 204 when no messages have been found, 400 when the timestamps are invalid, and 404 if any other route is accesses.

## Admin usage

The plugin is made for a single-file executable. It is configured with the following environment variable.

|Variable name |Description                                        |Default                                                                     |

|--------------|---------------------------------------------------|----------------------------------------------------------------------------|

|`DEVZAT_HOST` |URL of the chat-room interface                     |`devzat.hackclub.com:5556`                                                  |

|`DEVZAT_TOKEN`|Authentication token                               |Does not defaults to anything. The program panics if the token is not given.|

|`PORT`        |The port used to serve the web API                 |8080                                                                        |

|`HOST`        |The host name and protocol of the web API          |`http://localhost:8080`                                                     |

|`BANK_SIZE`   |The maximum number of messages the plugin remembers|1000                                                                        |