👺 ratiogoblin

ratiogoblin is a simple tool designed for use with status bars such as i3-bar, Waybar, and Polybar to get your current torrent ratio from IPTorrents.

⚠️ Note: This tool calls IPTorrents, so be nice to their servers and avoid setting a very low refresh interval when integrating with your status bar. I am not responsible for any bans or issues that may arise from excessive requests!

P.S. I made this in like 1 hour so don't expect too much from it :)

Updates

Starting with version 0.2.0, if there is an update available for ratiogoblin, you'll see a "*" appended to the output of ratiogoblin run. To update to the latest version, simply run:

ratiogoblin update

For previous versions, you will need to repeat the installation steps to get the latest version.

Installation

You can install ratiogoblin by grabbing a pre-built binary or by building it from source.

Pre-built Binaries

1. Download the latest binary from the GitHub Releases page. Or use curl to download it directly. Replace VERSION with the latest version number (e.g., v0.1.0):

   export VERSION=v0.1.1
   curl -Lo ratiogoblin.tar.gz https://github.com/1337jazz/ratio-goblin/releases/download/$VERSION/ratiogoblin_Linux_x86_64.tar.gz

2. Extract the binary:

   tar -xvf ratiogoblin.tar.gz

3. Move the binary to a directory in your system's PATH (e.g., /usr/local/bin/):

   sudo mv ratiogoblin /usr/local/bin/

Now you can run the ratiogoblin command from anywhere in your terminal.

Building from Source

Prerequisites:

• Go (version 1.23 or higher)
• Make (for using the Makefile)

Steps:

1. Clone the repository:

   git clone https://github.com/1337jazz/ratio-goblin.git
   cd ratio-goblin

2. Build the project:

   make

   This will create the binary at bin/ratiogoblin.

3. (Optional) Move the binary to a global directory to make it accessible system-wide:

   sudo mv bin/ratiogoblin /usr/local/bin/

4. (Alternatively) Build with specific version information embedded:

   make build-version version=1.0.0-test

---

Quick Start

To get started with ratiogoblin, follow these steps:

1. Run ratiogoblin init to create a default configuration file - for most distros this will be at ~/.config/ratiogoblin/config.json.

2. Edit the configuration file to add your IPTorrents credentials (from your cookie). Note, the pass field is not necessarily your account password, but the pass cookie value from IPTorrents.

   {
     "uid": "your_uid",
     "pass": "your_pass"
   }

3. Run ratiogoblin run to see your current ratio.

4. Integrate ratiogoblin with your status bar of choice by adding the appropriate command to your bar's configuration (some examples are provided below).

Examples

Polybar

Add the following module to your Polybar configuration file (usually located at ~/.config/polybar/config):

[module/ratiogoblin]
type = custom/script
exec = ratiogoblin run
interval = 3600
label = "Ratio: %output%" # `output` will be your ratio

Then, include the module in your bar where desired:

modules-right = ratiogoblin <other-modules>

Waybar

Add the following custom module to your Waybar configuration file (usually located at ~/.config/waybar/config):

"custom/ratiogoblin": {
  "exec": "ratiogoblin run",
  "interval": 3600,
  "format":  "Ratio: {text}" # `text` will be your ratio
}

Then, add the custom module to Waybar’s modules-right (or other section):

"modules-right": [
  "custom/ratiogoblin"
]

---

Automated Release Workflow

This project uses goreleaser to automate the release process. Here’s how it works:

Prerequisites:

• You must have push access to the repository to make a release.

Steps:

1. Bump the Version: Update the version number in internal/version/version.go using semantic versioning.

   package version
   
   const Version = "0.2.0" // Example of new version

2. Commit the Version Update:

   git add internal/version/version.go
   git commit -m "bump version to 0.2.0"

3. Tag the Release: Create a new Git tag that starts with v, and push it to the repository.

   git tag v0.2.0
   git push origin v0.2.0

4. Automated Workflow:

   • Once the tag is pushed, the GitHub Actions workflow (.github/workflows/release.yml) will trigger automatically.
   • Goreleaser will:
     • Build the binaries for the project.
     • Package the application into release-ready archives (e.g., .tar.gz).
     • Create a release on GitHub with the versioned tag.
     • Generate a changelog from commit history.

5. Release Completed:

   • Upon successful completion, the release will be available on the GitHub Releases page complete with downloadable binaries and changelogs.

---

Contributing

Contributions are welcome! Please submit pull requests or open issues for any suggestions, bug reports, or improvements.