Initial Implementation

Author: ZipFile

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.go]
+indent_style = tab
+
+[Makefile]
+indent_style = tab

.gitignore

@@ -9,3 +9,4 @@ venv/
 *.dylib
 *.test
 *.out
+twitch-stream-monitor

Makefile

@@ -0,0 +1,17 @@
+.DEFAULT_GOAL := build
+
+build:
+	go build
+
+fmt:
+	go fmt ./...
+
+imports:
+	find internal -name '*.go' -exec goimports -w {} \;
+	goimports -w *.go
+
+tests:
+	go test ./... -coverprofile=coverage.out
+
+coverage:
+	go tool cover -html=coverage.out

README.md

@@ -0,0 +1,24 @@
+# Twitch Stream Monitor
+
+* [Installation and Usage](#installation-and-usage)
+* [Installation and Usage (Windows)](#installation-and-usage-windows)
+* [Getting Credentials](docs/credentials.md)
+* [Webhook Configuration](docs/webhook.md)
+* [Environment Variables](docs/environment-variables.md)
+* [Development](docs/development.md)
+* [Ngrok Support](docs/ngrok.md)
+
+## Installation and Usage
+
+1. Download latest version form the releases page.
+2. Extract tar.gz file.
+3. Create a `.env` file as descibed in [Environment Variables](docs/environment-variables.md#.env).
+4. `cd` to the directory extracted on the step 2.
+5. Run `twitch-stream-monitor`.
+
+## Installation and Usage (Windows)
+
+1. Download latest version form the releases page.
+2. Extract zip file.
+3. Create a `twitch-stream-monitor.bat` file as descibed in [Environment Variables](docs/environment-variables.md#windows).
+4. Run `twitch-stream-monitor.bat`.

docs/credentials.md

@@ -0,0 +1,22 @@
+# Getting Credentials
+
+For tool to operate, we need a Twitch app. If you do not have one, follow [official documentation](https://dev.twitch.tv/docs/authentication#registration).
+
+When asked, fill:
+
+* **Name**: any name you want
+* **OAuth Redirect URLs**: `http://localhost`
+* **Category**: any would suffice, `Application Integration` more or less reflects the tool intention
+
+After registration, you'll be presented with **Client IDs** and **Client Secret**. We need both, store them securely. **Client Secret** will be presented only once, so do not miss the opportunity.
+
+After you received both **Client IDs** and **Client Secret**, use them to set `TWITCH_CLIENT_ID` and `TWITCH_CLIENT_SECRET` [environment variables](environment-variables.md) respectively.
+
+## App Access Token
+
+In order to communicate with a Twitch API, we need an App Access Token. By default app will request new token on each startup. You can override this behavior by providing one of the 2 environment variables:
+
+* `TWITCH_APP_ACCESS_TOKEN` - If set, new token won't be requested and its value will be used instead.
+* `TWITCH_APP_ACCESS_TOKEN_LOCATION` - File location to store app access token. Next time app starts, it will use token from this file.
+
+It is advised to set `TWITCH_APP_ACCESS_TOKEN_LOCATION`, since it will prevent unnecessary token generation on each restart and will enable auto-reneval of the token upon expiration.

docs/development.md

@@ -0,0 +1,88 @@
+# Development
+
+Before you can start working on the code, you need the following tooling:
+
+* Git.
+* Go 1.17 or newer.
+* Python 3. Used for running tests, should be installed in all modern distros.
+* GNU Make. `build-essential` package in Ubuntu, for other distros refer to respective distro documentation.
+
+## Clone the Code
+
+```sh
+git clone git@github.com:ZipFile/twitch-stream-monitor.git
+cd twitch-stream-monitor
+```
+
+## Preparing the Environment
+
+If your intention is to build the code, skip this step.
+
+Otherwise, in order to run tests and experiment with actual stream recording you need a working Python 3 installation and a Streamlink.
+
+If you have both installed - great. If not, you can setup a [Python's virtualenv](https://docs.python.org/3/library/venv.html):
+
+```sh
+python -m venv env
+. env/bin/activate
+```
+
+And then install the Streamlink:
+
+```sh
+pip install streamlink
+```
+
+Next time whenever you're back to development, use:
+
+```sh
+. env/bin/activate
+```
+
+In case your streamlink located somewhere else or you do not want to use venv, set a `TWITCH_MONITOR_STREAMLINK_PATH` environment variable to the path pointing to the streamlink executable.
+
+## Build
+
+```sh
+make
+```
+
+### Windows
+
+```sh
+GOOS=windows make
+```
+
+## Run Tests
+
+```sh
+make tests
+```
+
+## Format Code
+
+```sh
+make imports
+make fmt
+```
+
+## .env Support
+
+See [environment variables](environment-variables.md#env).
+
+## Debug Logging
+
+Default logging configuration is to output messages of the level INFO and above in a [CBOR](https://cbor.io/) format so it can be processed by structured-log-aggregating software like [fluentd](https://docs.fluentd.org/parser/json).
+
+For debugging purposes you likely want more verbosity and human-readability. This can be achieved by exporting following environment variables:
+
+```sh
+TWITCH_MONITOR_LOG_LEVEL=trace
+TWITCH_MONITOR_LOG_PRETTY=true
+```
+
+Either export them directly, or put into the `.env` file.
+
+## Testing Webhooks
+
+See [Ngrok Support](ngrok.md).