Feat: V4.0 new endpoints and more

.circleci/config.yml

@@ -6,7 +6,7 @@ commands:
     steps:
       - run:
           name: Install OS packages
-          command: apk add git build-base ruby-dev ruby-etc ruby-json libsodium
+          command: apk add git build-base ruby-dev ruby-etc ruby-json libsodium-dev
       - checkout
       - run:
           name: "Ruby version"
@@ -27,45 +27,50 @@ commands:
             - ./vendor/bundle
 
 jobs:
-  test_ruby_26:
+  test_ruby_31:
     docker:
-      - image: ruby:2.6-alpine
+      - image: ruby:3.1-alpine
     steps:
       - setup-env
       - run:
           name: Run RSpec
-          command: bundle exec rspec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml
+      - store_test_results:
+          path: ~/rspec
 
-  test_ruby_27:
+  test_ruby_32:
     docker:
-      - image: ruby:2.7-alpine
+      - image: ruby:3.2-alpine
     steps:
       - setup-env
       - run:
           name: Run RSpec
-          command: bundle exec rspec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml
+      - store_test_results:
+          path: ~/rspec
 
-  test_ruby_30:
+
+  test_ruby_33:
     docker:
-      - image: ruby:3.0-alpine
+      - image: ruby:3.3-alpine
     steps:
       - setup-env
       - run:
           name: Run RSpec
-          command: bundle exec rspec
+          command: bundle exec rspec --format progress --format RspecJunitFormatter -o ~/rspec/rspec.xml
 
   rubocop:
     docker:
-      - image: ruby:2.6-alpine
+      - image: ruby:3.3-alpine
     steps:
       - setup-env
       - run:
           name: Run Rubocop
-          command: bundle exec rubocop -P
+          command: bundle exec rubocop
 
   yard:
     docker:
-      - image: ruby:2.6-alpine
+      - image: ruby:3.3-alpine
     steps:
       - setup-env
       - attach_workspace:
@@ -79,13 +84,22 @@ jobs:
             - docs
 
   pages:
-    machine: true
+    docker:
+      - image: alpine
     steps:
+      - run:
+          name: Install OS packages
+          command: apk add git openssh-client-default
       - attach_workspace:
           at: /tmp/workspace
       - run:
           name: Clone docs
-          command: git clone $CIRCLE_REPOSITORY_URL -b gh-pages .
+          command: |
+            mkdir -p ~/.ssh
+
+            echo 'github.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk=' >> ~/.ssh/known_hosts
+
+            git clone $CIRCLE_REPOSITORY_URL -b gh-pages .
       - add_ssh_keys:
           fingerprints:
             - "9a:4c:50:94:23:46:81:74:41:97:87:04:4e:59:4b:4e"
@@ -111,9 +125,9 @@ jobs:
 workflows:
   test:
     jobs:
-      - test_ruby_26
-      - test_ruby_27
-      - test_ruby_30
+      - test_ruby_31
+      - test_ruby_32
+      - test_ruby_33
       - rubocop
       - yard
   deploy:

.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

.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"
+}

.devcontainer/postcreate.sh

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

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,7 +1,6 @@
 ---
 name: Bug report
 about: Report a bug to help us improve the library
-
 ---
 
 # Summary

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,6 @@
 ---
 name: Feature Request
 about: Request a new feature, or change an existing one
-
 ---
 
 <!---

.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@v2
+      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@v2
+
+    # ℹ️ 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@v2
+      with:
+        category: "/language:${{matrix.language}}"

.markdownlint.json

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

.rubocop.yml

@@ -8,7 +8,7 @@ inherit_mode:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.3
 
 # Disable line length checks
 Layout/LineLength:
@@ -67,5 +67,52 @@ Style/SingleLineBlockParams:
     - reduce: [m, e]
     - inject: [m, e]
 
-Layout/EndOfLine:
-  EnforcedStyle: lf
+###################################
+## 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
+
+# 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