onyxcord 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f5d2ba7d4563edb0e1a0e1e19706759c987f775d31bf75e5e21600fa99b9fb7c
+  data.tar.gz: 92a280220aff31be1a36e526309193a4269437f2845fc409e3fba6cedef19d81
+SHA512:
+  metadata.gz: 580c7ae99d795b2c12a823f03d0e1097f83834141c180321994e6b7ae903e57ad0fc24b5d797f46c8431ce1816af3f35d7ba9a5aa0a2fa137cab0a5e0f4780c2
+  data.tar.gz: 051cabf28b31f5b92c93a6fd28397f8b171510cd25d946c9f9ac55913a4cfe282bf2753d7881f6712f0ffe35cb56127388b8cec12f508b542c27d4ceb0daed74

data/.devcontainer/Dockerfile

@@ -0,0 +1,13 @@
+# Which Ruby version to use. You may need to use a more restrictive version,
+# e.g. `3.0`
+ARG VARIANT=3.3
+
+# Pull Microsoft's ruby devcontainer base image
+FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
+
+# Install libsodium dependency for voice channel interactions
+RUN apt update -yq && apt install -y libsodium-dev
+
+# Ensure we're running the latest bundler, as what ships with the Ruby image may
+# not be current, and bundler will auto-downgrade to match the Gemfile.lock
+RUN gem install bundler

data/.devcontainer/devcontainer.json

@@ -0,0 +1,29 @@
+{
+  "name": "Ruby",
+  "build": {
+    "dockerfile": "Dockerfile"
+  },
+
+  // Configure tool-specific properties.
+  "customizations": {
+    // Configure properties specific to VS Code.
+    "vscode": {
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        "shopify.ruby-lsp"
+      ]
+    }
+  },
+
+  // Set the environment variables
+  // "runArgs": ["--env-file",".env"],
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  //   "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  "postCreateCommand": "bash .devcontainer/postcreate.sh",
+
+  // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+  "remoteUser": "vscode"
+}

data/.devcontainer/postcreate.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+bundle config set path vendor/bundle
+bundle install --jobs=1

data/.github/CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing guidelines
+
+Any contributions are very much appreciated! This project is relatively relaxed when it comes to guidelines, however
+there are still some things that would be nice to have considered.
+
+For bug reports, please try to include a code sample if at all appropriate for
+the issue, so we can reproduce it on our own machines.
+
+For PRs, please make sure that you tested your code before every push; it's a little annoying to keep having to get back
+to a PR because of small avoidable oversights. (Huge bonus points if you're adding specs for your code! This project
+has very few specs in places where it should have more so every added spec is very much appreciated.)
+
+If you have any questions at all, don't be afraid to ask in the [onyxcord channel on Discord](https://discord.gg/cyK3Hjm).

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Report a bug to help us improve the library
+---
+
+# Summary
+
+<!---
+  First, please check to see that another issue or pull request (open or closed)
+  already addresses the problem you are facing. If you are not sure, please ask
+  in the Discord channel (link below).
+
+  Describe the bug you are encountering with as much detail as you can.
+  If you are not sure if a small detail is relevant, include it anyways!
+
+  Include simple code examples that will reproduce the bug.
+  Include any exceptions you are encountering in your logs, including
+  the initial error message and the backtrace that follows.
+
+  Stuck or need help? Join the Discord! https://discord.gg/cyK3Hjm
+-->
+
+---
+
+## Environment
+
+<!---
+  These are some commands to run to give us basic information about
+  your Ruby environment. Some issues may be version, OS, or hardware specific.
+--->
+
+**Ruby version:**
+
+<!--- Paste full output of `ruby -v` here --->
+
+**OnyxCord version:**
+
+<!--- Paste full output of `gem list onyxcord` or `bundle list onyxcord` here --->

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature Request
+about: Request a new feature, or change an existing one
+---
+
+<!---
+  Describe your feature request in as much detail as you can here.
+
+  Include why you want this feature. For example:
+
+  - It is a feature supported by Discord's API, but missing from the library
+
+  - It is a feature that would simplify a lot of your bots code
+
+  - It is a feature present in other popular Discord libraries
+
+  Include simple code examples (pseudocode is fine) that demonstrate
+  what you want to do.
+
+  Do your best to think about how this new feature would impact the code
+  of other people who use onyxcord, and not just your own bot's codebase.
+
+  Stuck or need help? Join the Discord! https://discord.gg/cyK3Hjm
+--->

data/.github/pull_request_template.md

@@ -0,0 +1,37 @@
+# Summary
+
+<!---
+  Describe the general goal of your pull request here:
+
+  - Include details about any issues you encountered that inspired
+  the pull request, such as bugs or missing features.
+
+  - If adding or changing features, include a small example that showcases
+  the new behavior.
+
+  - Reference any related issues or pull requests.
+
+  Stuck or need help? Join the Discord! https://discord.gg/cyK3Hjm
+--->
+
+---
+
+<!---
+  List each individual change you made to the library here in the appropriate
+  section in short, bulleted sentences.
+
+  This will aid in reviewing your pull request, and for adding it to the
+  changelog later.
+
+  You may remove sections that have no items if you want.
+--->
+
+## Added
+
+## Changed
+
+## Deprecated
+
+## Removed
+
+## Fixed

data/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  # --- Test on multiple Ruby versions ---
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [3.3, 3.4, 4.0]
+    container:
+      image: ruby:${{ matrix.ruby }}-alpine
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'onyxcord.gemspec') }}-${{ matrix.ruby }}
+          restore-keys: |
+            bundle-${{ matrix.ruby }}
+      - name: Install dependencies
+        run: bundle config set path vendor/bundle && bundle install
+      - name: Run RSpec
+        run: |
+          mkdir -p rspec
+          bundle exec rspec --format progress --format RspecJunitFormatter -o rspec/rspec.xml
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        with:
+          name: rspec-results-${{ matrix.ruby }}
+          path: rspec/rspec.xml
+
+  # --- Rubocop ---
+  rubocop:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:3.3-alpine
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'onyxcord.gemspec') }}-rubocop
+      - name: Install dependencies
+        run: bundle config set path vendor/bundle && bundle install
+      - name: Run Rubocop
+        run: bundle exec rubocop
+
+  # --- Generate YARD docs ---
+  yard:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:3.3-alpine
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'onyxcord.gemspec') }}-yard
+      - name: Install dependencies
+        run: bundle config set path vendor/bundle && bundle install
+      - name: Run YARD
+        run: |
+          mkdir -p docs
+          bundle exec yard --output-dir docs

data/.github/workflows/codeql.yml

@@ -0,0 +1,65 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ 'main' ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ 'main' ]
+  schedule:
+    - cron: '29 6 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

data/.github/workflows/deploy.yml

@@ -0,0 +1,54 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main] # deploy only on merges to main
+    tags:
+      - "v*" # deploy when a version tag (e.g., v1.0.0) is created
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:3.3-alpine
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install OS packages
+        run: apk add git build-base ruby-dev libsodium-dev
+
+      - name: Cache bundle
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: bundle-${{ hashFiles('Gemfile', 'onyxcord.gemspec') }}-yard
+
+      - name: Install dependencies
+        run: bundle install --path vendor/bundle
+
+      - name: Generate YARD documentation
+        run: |
+          mkdir -p docs
+          bundle exec yard --output-dir docs
+
+      - name: Determine deploy folder
+        id: set_folder
+        run: |
+          if [[ "${GITHUB_REF}" == refs/tags/* ]]; then
+            echo "folder=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
+          else
+            echo "folder=${GITHUB_REF#refs/heads/}" >> $GITHUB_OUTPUT
+          fi
+          echo "Deploying to folder: ${{ steps.set_folder.outputs.folder }}"
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          publish_branch: gh-pages
+          destination_dir: ${{ steps.set_folder.outputs.folder }}
+          keep_files: true
+          user_name: "GitHub Actions"
+          user_email: "actions@github.com"

data/.github/workflows/release.yml

@@ -0,0 +1,51 @@
+name: Publish RubyGems + GitHub Packages
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # IMPORTANT: this permission is required for `rake release` to push the release tag
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: '3.4.7'
+
+      - name: Validate tag matches gemspecs
+        run: |
+          TAG_VERSION="${GITHUB_REF#refs/tags/v}"
+          for gemspec in *.gemspec; do
+            GEM_VERSION=$(ruby -e "puts Gem::Specification.load('$gemspec').version")
+            if [ "$TAG_VERSION" != "$GEM_VERSION" ]; then
+              echo "::error::$gemspec version ($GEM_VERSION) does not match tag ($TAG_VERSION)"
+              exit 1
+            fi
+          done
+
+      - uses: rubygems/release-gem@v1
+
+      - name: Publish to GitHub Packages
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          OWNER=$(echo "${GITHUB_REPOSITORY}" | cut -d'/' -f1)
+          for gemspec in *.gemspec; do
+            gem build "$gemspec"
+          done
+          for gem_file in *.gem; do
+            echo "Publishing $gem_file to GitHub Packages..."
+            gem push "$gem_file" \
+              --key github \
+              --host "https://rubygems.pkg.github.com/${OWNER}" || true
+          done

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/profiles/
+/tmp/
+/.idea/
+.DS_Store
+*.gem
+**.sw*
+
+/vendor/bundle

data/.markdownlint.json

@@ -0,0 +1,4 @@
+{
+  "MD013": false,
+  "MD024": { "siblings_only": true }
+}

data/.overcommit.yml

@@ -0,0 +1,7 @@
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+  AuthorName:
+    enabled: false

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,129 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - AllowedNames
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.3
+
+# Disable line length checks
+Layout/LineLength:
+  Enabled: false
+
+# TODO: Larger refactor
+Lint/MissingSuper:
+  Enabled: false
+
+# Allow 'Pokémon-style' exception handling
+Lint/RescueException:
+  Enabled: false
+
+# Disable all metrics.
+Metrics:
+  Enabled: false
+
+# Allow some common and/or obvious short method params
+Naming/MethodParameterName:
+  AllowedNames:
+    - e
+
+# Ignore `eval` in the examples folder
+Security/Eval:
+  Exclude:
+    - examples/**/*
+
+# https://stackoverflow.com/q/4763121/
+Style/Alias:
+  Enabled: false
+
+# Had to disable this globally because it's being silently autocorrected even with local disable comments?
+Style/BisectedAttrAccessor:
+  Enabled: false
+
+# Prefer compact module/class defs
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# So RuboCop doesn't complain about application IDs
+Style/NumericLiterals:
+  Exclude:
+    - examples/**/*
+
+# TODO: Requires breaking changes
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Prefer explicit arguments in case global variables like `$;` or `$,` are changed
+Style/RedundantArgument:
+  Enabled: false
+
+# Prefer |m, e| for the `reduce` block arguments
+Style/SingleLineBlockParams:
+  Methods:
+    - reduce: [m, e]
+    - inject: [m, e]
+
+###################################
+## NEW COPS TO MAKE DECISIONS ON ##
+###################################
+
+# TODO: Decide how you want to handle this:
+# https://rubydoc.info/gems/rubocop/RuboCop/Cop/Style/HashSyntax
+Style/HashSyntax:
+  EnforcedShorthandSyntax: either
+
+Style/ArgumentsForwarding:
+  Enabled: false
+
+Performance/StringIdentifierArgument:
+  Enabled: false
+
+Style/ComparableClamp:
+  Enabled: false
+
+Style/SuperArguments:
+  Enabled: false
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Style/RedundantSelfAssignmentBranch:
+  Enabled: false
+
+Performance/MapCompact:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantParentheses:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+# This will probably be a breaking change, but should happen
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: false
+
+# FIXME: Disabled due to breaking tests, should probably refactor the code instead
+Style/SafeNavigation:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Exclude:
+    - lib/onyxcord/data/role.rb

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --hide-tag todo --fail-on-warning

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in onyxcord.gemspec
+gemspec name: 'onyxcord'
+gemspec name: 'onyxcord-webhooks', development_group: 'webhooks'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2026 meew0
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.