discorb 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ab7661480ef3de4adbdd46bb59617cb37db17f991f88b263512abe3550e6982
-  data.tar.gz: c7e92a338b7a71c1b8163aa1a3f801c9256ba72f48a56f42fa481f0c75497793
+  metadata.gz: 810e9b14c77e49e9fca7afc4fe6b98389b26cb17dc1617213f38d7655b990a49
+  data.tar.gz: bbaa999265ac212f90ab60d57ec772fe7ade0e47f264a136130c679b85a46952
 SHA512:
-  metadata.gz: 6b61672c6acc2048420b3f19688a6e72ee1069feb84b7938074cbc2fc39bc9409734d72895317a1b9af1095cc72c138ef0da61ff2b08bcbb05509f239133fd2f
-  data.tar.gz: 66c1bc5804c7e4646fc9cd1ad9fe8e089e311f42a7251b4b4ff398217fcb25b6d7aa9f7166e35067b9bfecb94cd52b2e66585cede7a3d136cd38ef38232a793d
+  metadata.gz: 120828736edcf7eef9d78410914651edeb41ae85eadef012050b105b03c80f07f835d812105d3cfe954c7237e344b3bbc540af8840a7dde1a69f590b008a759e
+  data.tar.gz: f29b0399c65f180b05bf6c0c3d5f253689ff08c734f60ee7681b57c060d99e36dd85fc275f9652354933478b8139aa76c8ad854f6963fd1c074a8a260ffb6bde

data/.gitattributes

@@ -0,0 +1,2 @@
+template-replace/**/* linguist-documentation
+sig/* linguist-generated

data/.github/workflows/build_version.yml

@@ -21,8 +21,8 @@ jobs:
           bundler-cache: true
       - name: Set up git settings
         run: |
-          git config --global user.email "action@github.com"
-          git config --global user.name "GitHub Action"
+          git config --global user.email "actions@github.com"
+          git config --global user.name "GitHub Actions"
       - name: Clone pages
         env:
           SSH_SECRET: ${{ secrets.SSH }}
@@ -33,7 +33,7 @@ jobs:
           git clone git@github.com:discorb-lib/discorb-lib.github.io /tmp/pages
       - name: Install dependencies
         run: |
-          bundle config --local with 'docs'
+          bundle config --local with 'docs development'
           bundle install
           gem update uri
       - name: Generate document

data/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '20 10 * * 3'
+
+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' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      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.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, 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@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/lint-push.yml

@@ -0,0 +1,18 @@
+name: Lint with RuboCop
+on:
+  - push
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: Install gems
+        run: |
+          gem install rubocop
+      - name: Run rubocop
+        run: |
+          rubocop lib

data/.github/workflows/lint.yml

@@ -0,0 +1,16 @@
+name: Lint with RuboCop
+on:
+  - pull_request
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.0
+      - name: rubocop
+        uses: reviewdog/action-rubocop@v2
+        with:
+          rubocop_version: 1.25

data/.rubocop.yml

@@ -0,0 +1,70 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - examples/**/*.rb
+
+Layout:
+  Enabled: false
+Metrics:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:  # Disabled for rufo
+  Enabled: false
+
+Style/StringLiterals:  # Disabled for rufo
+  Enabled: false
+
+Style/TrailingCommaInArguments:  # Disabled for rufo
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:  # Disabled for rufo
+  Enabled: false
+
+Style/StringConcatenation:  # + looks better
+  Enabled: false
+
+Lint/MissingSuper:  # For abstract classes
+  Enabled: false
+
+Lint/AssignmentInCondition:  # Looks bad
+  Enabled: false
+
+Style/PerlBackrefs:  # It will be longer
+  Enabled: false
+
+Style/RedundantSelf:  # Looks local variable
+  Enabled: false
+
+Naming/VariableNumber:  # Discord API docs naming
+  Enabled: false
+
+Style/ParallelAssignment:  # It will be longer
+  Enabled: false
+
+Style/RedundantInterpolation:  # For make it extendable
+  Enabled: false
+
+Style/Next:  # For make it extendable
+  Enabled: false
+
+Lint/ShadowedException:  # False positive
+  Enabled: false
+
+Lint/AmbiguousOperatorPrecedence:  # Not needed
+  Enabled: false
+
+Style/GlobalVars: # For /exe
+  Enabled: false
+
+Lint/Debugger: # For /exe
+  Enabled: false
+
+Style/GuardClause: # For make it extendable
+  Enabled: false
+
+Layout/EndOfLine: # For git
+  EnforcedStyle: lf
+
+Lint/ScriptPermission: # For GitHub Actions
+  Enabled: false

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+Official Discord.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Changelog.md

@@ -4,8 +4,41 @@
 
 # Changelog
 
+## v0.14
+
+### v0.14.0
+
+- Add: Support Modal interaction
+- Add: Support attachment option type in slash command
+- Fix: Connections will no longer stacked
+- Fix: Fix Client#fetch_nitro_sticker_packs returning 404
+- Fix: Fix `self` reference in subcommand of extension
+- Refactor: Refactored many things
+- Refactor: Add Rubocop
+
 ## v0.13
 
+### v0.13.4
+
+- Add: Show command on `discorb setup`
+- Fix: Fix issue when logging in to file(#6, thanks `deanpcmad`)
+- Fix: Fix rate limit handing
+- Fix: Fix `Client#users`, it was always empty
+- Fix: Fix sorting dictionary
+
+### v0.13.3
+
+- Fix: Fix INTEGRATION_xxx event
+- Change: Change description
+
+### v0.13.2
+
+- Fix: Fix MESSAGE_DELETE_BULK event
+- Fix: Delete VoiceState from `Guild#voice_states` when member leaves
+- Add: Add `VoiceChannel#members`, `VoiceChannel#voice_states`
+- Add: Add `StageChannel#members`, `StageChannel#voice_states`, `StageChannel#audiences`, `StageChannel#speakers`
+- Fix: Ignore errors on closing websocket
+
 ### v0.13.1
 
 - Add: `Discorb::Integration#locale`, `Discorb::Integration#guild_locale`

data/Gemfile

@@ -13,9 +13,13 @@ group :development, optional: true do
 end
 
 group :docs, optional: true do
-  gem "redcarpet"
-  gem "yard", "~> 0.9.26"
-  gem "gettext", "~> 3.4.1"
   gem "crowdin-api", "~> 1.0"
+  gem "gettext", "~> 3.4.1"
+  gem "redcarpet"
   gem "rubyzip", "~> 2.3"
+  gem "yard", "~> 0.9.26"
+end
+
+group :lint, optional: true do
+  gem "rubocop", "~> 1.25"
 end

data/README.md

@@ -9,7 +9,7 @@
 
 ----
 
-discorb is a Discord API wrapper written in Ruby.
+discorb is a Discord API wrapper for Ruby, Using [socketry/async](https://github.com/socketry/async).
 
 ## Installation
 

data/Rakefile

@@ -5,15 +5,14 @@ require_relative "lib/discorb/utils/colored_puts"
 task default: %i[]
 
 # @private
-def get_version
+def current_version
   require_relative "lib/discorb/common"
   tag = `git tag --points-at HEAD`.force_encoding("utf-8").strip
   if tag.empty?
-    version = "main"
+    "main"
   else
-    version = Discorb::VERSION
+    Discorb::VERSION
   end
-  version
 end
 
 desc "Build emoji_table.rb"
@@ -63,8 +62,7 @@ end
 
 desc "Generate document and replace"
 namespace :document do
-  version = get_version
-
+  version = current_version
   desc "Just generate document"
   task :yard do
     sh "bundle exec yardoc -o doc/#{version} --locale #{ENV["rake_locale"] or "en"}"
@@ -86,12 +84,12 @@ namespace :document do
 
     desc "Replace HTML"
     task :html do
-      require_relative "template-replace/scripts/sidebar.rb"
-      require_relative "template-replace/scripts/version.rb"
-      require_relative "template-replace/scripts/index.rb"
-      require_relative "template-replace/scripts/yard_replace.rb"
-      require_relative "template-replace/scripts/favicon.rb"
-      require_relative "template-replace/scripts/arrow.rb"
+      require_relative "template-replace/scripts/sidebar"
+      require_relative "template-replace/scripts/version"
+      require_relative "template-replace/scripts/index"
+      require_relative "template-replace/scripts/yard_replace"
+      require_relative "template-replace/scripts/favicon"
+      require_relative "template-replace/scripts/arrow"
       iputs "Resetting changes"
       Dir.glob("doc/#{version}/**/*.html") do |f|
         next if (m = f.match(/[0-9]+\.[0-9]+\.[0-9]+(-[a-z]+)?/)) && m[0] != version
@@ -143,37 +141,35 @@ namespace :document do
       replace_locale("doc/main")
     end
   end
-  task :replace => %i[replace:css replace:html replace:eol]
+  task replace: %i[replace:css replace:html replace:eol]
 
   desc "Build all versions"
   task :build_all do
     require "fileutils"
 
-    class Bundler::Definition
-      def validate_platforms!
-        # noop
-      end
-    end
-
     iputs "Building all versions"
-    FileUtils.rm_rf("doc") rescue nil
+    begin
+      FileUtils.rm_rf("doc")
+    rescue StandardError
+      nil
+    end
     FileUtils.cp_r("./template-replace/.", "./tmp-template-replace")
-    Rake::Task["document:yard"].invoke
-    Rake::Task["document:replace:html"].invoke
-    Rake::Task["document:replace:css"].invoke
-    Rake::Task["document:replace:eol"].invoke
-    Rake::Task["document:replace:locale"].invoke
+    Rake::Task["document:yard"].execute
+    Rake::Task["document:replace:html"].execute
+    Rake::Task["document:replace:css"].execute
+    Rake::Task["document:replace:eol"].execute
+    Rake::Task["document:replace:locale"].execute
     tags = `git tag`.force_encoding("utf-8").split("\n").sort_by { |t| t[1..].split(".").map(&:to_i) }
     tags.each do |tag|
       sh "git checkout #{tag} -f"
       iputs "Building #{tag}"
       FileUtils.cp_r("./tmp-template-replace/.", "./template-replace")
       version = tag.delete_prefix("v")
-      Rake::Task["document:yard"].invoke
-      Rake::Task["document:replace:html"].invoke
-      Rake::Task["document:replace:css"].invoke
-      Rake::Task["document:replace:eol"].invoke
-      Rake::Task["document:replace:locale"].invoke
+      Rake::Task["document:yard"].execute
+      Rake::Task["document:replace:html"].execute
+      Rake::Task["document:replace:css"].execute
+      Rake::Task["document:replace:eol"].execute
+      Rake::Task["document:replace:locale"].execute
       FileUtils.cp_r("./doc/.", "./tmp-doc")
       FileUtils.rm_rf("doc")
     end
@@ -181,7 +177,7 @@ namespace :document do
     FileUtils.cp_r("./tmp-doc/.", "./doc")
     FileUtils.cp_r("./doc/#{tags.last.delete_prefix("v")}/.", "./doc")
     sputs "Successfully built all versions"
-  rescue => e
+  rescue StandardError => e
     sh "git switch main -f"
     raise e
   end
@@ -216,12 +212,12 @@ namespace :document do
         end
       end
       ENV["rake_locale"] = "ja"
-      Rake::Task["document:yard"].invoke
-      Rake::Task["document:replace"].invoke
+      Rake::Task["document:yard"].execute
+      Rake::Task["document:replace"].execute
     end
 
     task :en do
-      Rake::Task["document"].invoke("locale:en")
+      Rake::Task["document"].execute("locale:en")
     end
   end
 end
@@ -322,4 +318,8 @@ task :rbs do
   File.write("sig/discorb.rbs", base)
 end
 
-task :document => %i[document:yard document:replace]
+task document: %i[document:yard document:replace]
+
+task :lint do
+  sh "rubocop lib"
+end

data/discorb.gemspec

@@ -8,7 +8,18 @@ Gem::Specification.new do |spec|
   spec.authors = ["sevenc-nanashi"]
   spec.email = ["sevenc-nanashi@sevenbot.jp"]
 
-  spec.summary = "A discord API wrapper written in Ruby"
+  spec.summary = "A Discord API wrapper for Ruby, Using socketry/async."
+  spec.description = <<~RDOC
+    == discorb
+    discorb is a Discord API wrapper for Ruby, Using {socketry/async}[https://github.com/socketry/async].
+
+    === Contributing
+    Bug reports, feature requests, and pull requests are welcome on {the GitHub repository}[https://github.com/discorb-lib/discorb].
+
+    === License
+    This gem is licensed under the MIT License.
+
+  RDOC
   spec.homepage = "https://github.com/discorb-lib/discorb"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
@@ -35,4 +46,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mime-types", "~> 3.3"
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/examples/commands/bookmarker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 require "json"
 
@@ -20,7 +21,7 @@ def build_embed_from_message(message)
   embed
 end
 
-client.message_command("Bookmark", guild_ids: [857373681096327180]) do |interaction, message|
+client.message_command("Bookmark", guild_ids: [857_373_681_096_327_180]) do |interaction, message|
   unless channel = bookmark_channel(interaction.guild)
     interaction.post("Bookmark channel not found. Please create one called `bookmarks`.", ephemeral: true)
     next

data/examples/commands/hello.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new

data/examples/commands/inspect.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -6,7 +7,7 @@ client.once :standby do
   puts "Logged in as #{client.user}"
 end
 
-client.user_command("Info", guild_ids: [857373681096327180]) do |interaction|
+client.user_command("Info", guild_ids: [857_373_681_096_327_180]) do |interaction|
   interaction.post(embed: Discorb::Embed.new(
                      "Information of #{interaction.target.to_s_user}",
                      fields: [
@@ -14,7 +15,7 @@ client.user_command("Info", guild_ids: [857373681096327180]) do |interaction|
                        Discorb::Embed::Field.new("ID", interaction.target.id),
                        Discorb::Embed::Field.new("Bot", interaction.target.bot? ? "Yes" : "No"),
                        Discorb::Embed::Field.new("Joined at", interaction.target.joined_at.to_df("F")),
-                       Discorb::Embed::Field.new("Created at", interaction.target.created_at.to_df("F")),
+                       Discorb::Embed::Field.new("Created at", interaction.target.created_at.to_df("F"))
                      ],
                      thumbnail: interaction.target.avatar&.url,
 

data/examples/components/authorization_button.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -27,7 +28,7 @@ client.on :message do |message|
     components: [
       Discorb::Button.new(
         "Get role", custom_id: "auth:#{role.id}",
-      ),
+      )
     ],
   )
 end

data/examples/components/select_menu.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -21,7 +22,7 @@ SECTIONS = [
     > So I decided to make it.
     Matsumoto describes the design of Ruby as being like a simple Lisp language at its core, with an object system like that of Smalltalk, blocks inspired by higher-order functions, and practical utility like that of Perl.
   WIKI
-  ["First publication", <<~WIKI],
+  ["First publication", <<~WIKI]
     The first public release of Ruby 0.95 was announced on Japanese domestic newsgroups on December 21, 1995.
     Subsequently, three more versions of Ruby were released in two days.
     The release coincided with the launch of the Japanese-language ruby-list mailing list, which was the first mailing list for the new language.

data/examples/extension/main.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 require_relative "message_expander"
 

data/examples/extension/message_expander.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 class MessageExpander

data/examples/simple/eval.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "discorb"
 
 client = Discorb::Client.new
@@ -24,8 +25,8 @@ client.on :message do |message|
     res = res.wait if res.is_a? Async::Task
     message.channel.post("```rb\n#{res.inspect[...1990]}\n```")
   end
-rescue Exception => error
-  message.reply embed: Discorb::Embed.new("Error!", "```rb\n#{error.full_message(highlight: false)[...1990]}\n```",
+rescue Exception => e
+  message.reply embed: Discorb::Embed.new("Error!", "```rb\n#{e.full_message(highlight: false)[...1990]}\n```",
                                           color: Discorb::Color[:red])
 end