slack-ruby-client 3.1.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2adaaa262bea7ceba8032b2a8ff54c179e1a972a94a34c1ca9fb526fb2e82728
-  data.tar.gz: 12da6b07266549b471b6ca7e07ccb525269a074f0f4f0b8f8fc9fc9563c4a620
+  metadata.gz: 41ed3cba2bb8122e285978e01bdcc9ce1e66c8572734bf90f9bd9c048fab5b27
+  data.tar.gz: 9cd4ec9ee0d7c8ab512491700e7e78133a099ef0be1ed553e63cf766f487f835
 SHA512:
-  metadata.gz: 2998c891be3fc2195b24ff696989fd748695f3350a9f8db14672fc94a66519aac0a3c332f5002adda414a628574094348de2de6b5010fd06cfe61e50fc0eeb08
-  data.tar.gz: 13ece08f3789dbed0edbc3c5e3a150ce171a8b89585b554710165af55008eb798b5a08c7062a5a7735eb0082f67818f02ea428b6653d6959609881bc6794fc17
+  metadata.gz: acf9e865def155ca75f77079bafb8abd1382943a3de640ed2d9eb8462712dfd48c49d61c603872b97158937ae8b769b5f02a976961590f79973369f7cf770b90
+  data.tar.gz: d38d2f774122deb06c9c00c788d511bf9fe2af8664c01f87edce0121f2f23669bbf528784b922f7cbcb4a35e5bdc83a2909038d6635c2ce45fb4001d0762411b

data/.github/prompts/changelog-entries.prompt.yml

@@ -0,0 +1,32 @@
+messages:
+  - role: system
+    content: |-
+      You write CHANGELOG entries describing an automated API update to slack-ruby-client, a
+      Ruby gem whose Web API endpoint methods, argument validations, specs, and bin commands
+      are code-generated from JSON method definitions vendored from
+      https://github.com/slack-ruby/slack-api-ref (via a git submodule and rake task).
+
+      Given a diffstat and a diff of the regenerated files, respond with ONLY a single JSON
+      object (no markdown code fences, no other text) in exactly this shape:
+      {"entries": [string, ...]}
+
+      Rules for entries:
+      - Each entry is a single short line, imperative mood, no leading bullet/dash and no
+        trailing period (the caller adds both).
+      - Group related changes together into one entry per notable change or affected method
+        group (e.g. one entry for "Add chat.appendStream and chat.stopStream methods", one
+        entry for "Add a metadata argument to chat.postEphemeral, chat.postMessage,
+        chat.scheduleMessage, and chat.update"), rather than one entry per file.
+      - Focus on developer-visible API surface changes: new/removed/renamed methods, new/
+        removed/changed arguments (including required/mutually-exclusive validation changes),
+        new/removed error codes, and behavioral changes to generated code.
+      - Skip purely mechanical noise (e.g. reformatted docs/comments with no semantic change).
+      - Produce at most 8 entries. If there are no notable API surface changes, return a single
+        generic entry describing the update in one line.
+  - role: user
+    content: |-
+      Diffstat:
+      {{diff_stat}}
+
+      Diff (may be truncated):
+      {{diff}}

data/.github/workflows/danger-comment.yml

@@ -0,0 +1,11 @@
+name: Danger Comment
+
+on:
+  workflow_run:
+    workflows: [Danger]
+    types: [completed]
+
+jobs:
+  comment:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-comment.yml@v0.1.0
+    secrets: inherit

data/.github/workflows/danger.yml

@@ -0,0 +1,13 @@
+name: Danger
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  danger:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-run.yml@v0.1.0
+    secrets: inherit
+    with:
+      ruby-version: '4.0'
+      bundler-cache: true

data/.github/workflows/lint.yml

@@ -6,9 +6,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v7
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
+          ruby-version: '3.3'
+          bundler: latest
           bundler-cache: true
       - run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
     name: test (ruby=${{ matrix.entry.ruby }})
     steps:
       - name: Checkout
-        uses: actions/checkout@v5
+        uses: actions/checkout@v7
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.github/workflows/update_api.yml

@@ -11,7 +11,7 @@ jobs:
       contents: write
       pull-requests: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v7
         with:
           submodules: recursive
           fetch-depth: 0
@@ -28,10 +28,71 @@ jobs:
         run: rm -rf vendor
       - name: Get current date
         id: date
-        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+        run: echo "date=$(date +'%Y-%m-%d')" >> $GITHUB_OUTPUT
       - name: Get slack-api-ref ref
         id: api-ref
-        run: echo "::set-output name=api-ref::$(git rev-parse --short HEAD:lib/slack/web/api/slack-api-ref)"
+        run: echo "api-ref=$(git rev-parse --short HEAD:lib/slack/web/api/slack-api-ref)" >> $GITHUB_OUTPUT
+      - name: Check for changes
+        id: changes
+        run: |
+          if git diff --quiet; then
+            echo "changed=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "changed=true" >> "$GITHUB_OUTPUT"
+          fi
+      - name: Prepare diff for AI summary
+        if: steps.changes.outputs.changed == 'true'
+        run: |
+          git diff --stat | sed 's/^/      /' > /tmp/diff_stat.txt
+          git diff | head -c 20000 | sed 's/^/      /' > /tmp/diff.txt
+      - name: Set up Node
+        if: steps.changes.outputs.changed == 'true'
+        uses: actions/setup-node@v7
+      - name: Install Copilot CLI
+        if: steps.changes.outputs.changed == 'true'
+        run: npm install -g @github/copilot
+      - name: Generate changelog entries with AI
+        if: steps.changes.outputs.changed == 'true'
+        id: ai
+        uses: actions/ai-inference@v3
+        with:
+          prompt-file: ./.github/prompts/changelog-entries.prompt.yml
+          model: ''
+          file_input: |
+            diff_stat: /tmp/diff_stat.txt
+            diff: /tmp/diff.txt
+        env:
+          COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_PAT }}
+      - name: Build changelog entries
+        id: entries
+        run: |
+          entries=""
+          if [ "${{ steps.changes.outputs.changed }}" = "true" ]; then
+            response_file="${{ steps.ai.outputs.response-file }}"
+            echo "AI changelog response:"
+            cat "$response_file" || true
+            # Copilot CLI's response file may include narration/thinking lines
+            # before the final JSON answer, so grab the last line that looks
+            # like a JSON object rather than trying to parse the whole file.
+            json_line="$(grep -E '^\{.*\}$' "$response_file" 2>/dev/null | tail -n 1)"
+            if [ -z "$json_line" ]; then
+              echo "::error::AI changelog response did not contain a JSON object, see response above."
+              exit 1
+            fi
+            entries="$(printf '%s' "$json_line" | jq -r '.entries[]? // empty')"
+          fi
+          if [ -z "$entries" ]; then
+            entries="Update API from slack-api-ref@${{ steps.api-ref.outputs.api-ref }}"
+          fi
+          body_list="$(printf '%s\n' "$entries" | sed 's/^/- /')"
+          {
+            echo 'entries<<CHANGELOG_ENTRIES_EOF'
+            echo "$entries"
+            echo 'CHANGELOG_ENTRIES_EOF'
+            echo 'body_list<<CHANGELOG_BODY_EOF'
+            echo "$body_list"
+            echo 'CHANGELOG_BODY_EOF'
+          } >> "$GITHUB_OUTPUT"
       - name: GitHub App token
         if: ${{ github.repository == 'slack-ruby/slack-ruby-client' }}
         id: github_app_token
@@ -39,18 +100,26 @@ jobs:
         with:
           app_id: ${{ secrets.CI_APP_ID }}
           private_key: ${{ secrets.CI_APP_PRIVATE_KEY }}
-          installation_id: 36985419
+          installation_retrieval_mode: id
+          installation_retrieval_payload: 36985419
       - name: Create pull request
         id: cpr
-        uses: peter-evans/create-pull-request@v7
+        uses: peter-evans/create-pull-request@v8
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          commit-message: Update API from slack-api-ref@${{ steps.api-ref.outputs.api-ref }} (${{ steps.date.outputs.date }})
+          token: ${{ steps.github_app_token.outputs.token || secrets.GITHUB_TOKEN }}
+          commit-message: |
+            Update API from slack-api-ref@${{ steps.api-ref.outputs.api-ref }} (${{ steps.date.outputs.date }})
+
+            ${{ steps.entries.outputs.body_list }}
           title: Update API from slack-api-ref@${{ steps.api-ref.outputs.api-ref }}
           body: |
             Update API from [slack-api-ref](https://github.com/slack-ruby/slack-api-ref).
             Rev: ${{ steps.api-ref.outputs.api-ref }}
             Date: ${{ steps.date.outputs.date }}
+
+            ## Changes
+
+            ${{ steps.entries.outputs.body_list }}
           branch: automated-api-update
           base: master
           committer: slack-ruby-ci-bot <noreply@github.com>
@@ -61,21 +130,30 @@ jobs:
           git fetch origin automated-api-update
           git checkout automated-api-update
       - name: Update CHANGELOG
-        uses: jacobtomlinson/gha-find-replace@v3
         if: ${{ steps.cpr.outputs.pull-request-number != '' }}
-        with:
-          include: CHANGELOG.md
-          find: "\\* Your contribution here."
-          replace: "* [#${{steps.cpr.outputs.pull-request-number}}](https://github.com/slack-ruby/slack-ruby-client/pull/${{steps.cpr.outputs.pull-request-number}}): Update API from [slack-api-ref@${{ steps.api-ref.outputs.api-ref }}](https://github.com/slack-ruby/slack-api-ref/commit/${{ steps.api-ref.outputs.api-ref }}) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).\n* Your contribution here."
+        env:
+          PR_NUMBER: ${{ steps.cpr.outputs.pull-request-number }}
+          ENTRIES: ${{ steps.entries.outputs.entries }}
+        run: |
+          ruby - <<'RUBYEOF'
+          pr_number = ENV.fetch("PR_NUMBER")
+          pr_url = "https://github.com/slack-ruby/slack-ruby-client/pull/#{pr_number}"
+          entries = ENV.fetch("ENTRIES").each_line.map(&:strip).reject(&:empty?)
+
+          lines = entries.map do |entry|
+            "* [##{pr_number}](#{pr_url}): #{entry} - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot)."
+          end.join("\n")
+
+          content = File.read("CHANGELOG.md")
+          content = content.sub("* Your contribution here.", "#{lines}\n* Your contribution here.")
+          File.write("CHANGELOG.md", content)
+          RUBYEOF
       - name: Commit and Push
         if: ${{ steps.cpr.outputs.pull-request-number != '' }}
         run: |
           git config --local user.name 'slack-ruby-ci-bot'
           git config --local user.email 'noreply@github.com'
-          git config --local --unset-all http.https://github.com/.extraheader || true
-          AUTH=$(echo -n "x-access-token:${{ steps.github_app_token.outputs.token || secrets.GITHUB_TOKEN }}" | base64)
-          echo "::add-mask::${AUTH}"
-          git config --local http.https://github.com/.extraheader "AUTHORIZATION: basic ${AUTH}"
           git add CHANGELOG.md
           git commit --amend --no-edit
+          git remote set-url origin https://x-access-token:${{ steps.github_app_token.outputs.token || secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
           git push origin automated-api-update -f

data/.rubocop.yml

@@ -1,9 +1,10 @@
 inherit_from: .rubocop_todo.yml
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-exception_messages
 
 AllCops:
   TargetRubyVersion: 2.7

data/.rubocop_todo.yml

@@ -1,11 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2025-09-21 17:08:14 UTC using RuboCop version 1.26.1.
+# on 2026-07-05 15:28:32 UTC using RuboCop version 1.26.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Remaining offenses after safe autocorrection with modern RuboCop.
+Naming/PredicateMethod:
+  Exclude:
+    - 'lib/slack/events/request.rb'
+    - 'lib/slack/utils/security.rb'
+
+Style/DirectiveScope:
+  Exclude:
+    - 'lib/slack/utils/security.rb'
+
 # Offense count: 1
 # This cop supports unsafe auto-correction (--auto-correct-all).
 Lint/NonDeterministicRequireOrder:
@@ -33,6 +43,9 @@ Metrics/CyclomaticComplexity:
 Metrics/MethodLength:
   Max: 45
 
+Metrics/ModuleLength:
+  Enabled: false
+
 # Offense count: 1
 # Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
@@ -96,7 +109,7 @@ RSpec/ContextWording:
     - 'spec/slack/web/client_spec.rb'
     - 'spec/slack/web/faraday/request_spec.rb'
 
-# Offense count: 35
+# Offense count: 36
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 17
@@ -104,7 +117,7 @@ RSpec/ExampleLength:
 # Offense count: 10
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
 # Include: **/*_spec*rb*, **/spec/**/*
-RSpec/FilePath:
+RSpec/SpecFilePathFormat:
   Exclude:
     - 'spec/slack/version_spec.rb'
     - 'spec/slack/web/api/endpoints/custom/auth_spec.rb'
@@ -160,7 +173,8 @@ RSpec/SubjectStub:
 # Configuration parameters: .
 # SupportedStyles: constant, string
 RSpec/VerifiedDoubleReference:
-  EnforcedStyle: string
+  Exclude:
+    - 'spec/slack/web/faraday/request_spec.rb'
 
 # Offense count: 2
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.

data/AGENTS.md

@@ -0,0 +1,12 @@
+# Contributor guidance
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) first for setup, tests, lint, changelog, pull request, and API patch instructions. Keep those instructions there rather than duplicating them here.
+
+- Preserve the supported-Ruby test matrix when changing lint dependencies.
+- When upgrading lint tooling, review safe corrections and baseline only remaining unrelated offenses.
+- Exception message corrections can change public error strings. Update matching specs, including handwritten specs under `spec/slack/web/api/endpoints/custom/`.
+- Use lowercase exception messages without a trailing period, including messages passed to `super` in error constructors; the exception-message cops may not detect that form. Preserve upstream Slack error codes and dynamically supplied messages.
+- Load RuboCop extensions through `plugins:`. When upgrading an extension, migrate renamed cops and obsolete parameters, review safe corrections, and preserve existing behavior rather than blindly applying unsafe fixes.
+- Do not edit the API-reference submodule or include existing submodule changes unless requested.
+- The API update task pulls the latest reference and can generate unrelated changes. Verify the patch against both the latest and pinned reference; keep unrelated generated updates out of a focused PR. Custom endpoint specs are handwritten despite their location under `endpoints/`.
+- Do not suppress environment warnings in application code or tests. Report local validation limitations explicitly; CLI specs compare subprocess output and can fail when Bundler emits unrelated warnings.

data/CHANGELOG.md

@@ -1,4 +1,46 @@
-### 3.1.0 (Next)
+### 3.3.0 (2026/10/09)
+
+* [#607](https://github.com/slack-ruby/slack-ruby-client/pull/607): Support non-rewindable Rack 3 request bodies when verifying Events API signatures, with WEBrick integration coverage; follows [#515](https://github.com/slack-ruby/slack-ruby-client/pull/515) - [@olleolleolle](https://github.com/olleolleolle), [@dblock](https://github.com/dblock).
+* [#606](https://github.com/slack-ruby/slack-ruby-client/pull/606): Add configured client copies with error callbacks for Slack and transport failures - [@dblock](https://github.com/dblock).
+* [#605](https://github.com/slack-ruby/slack-ruby-client/pull/605): Add configured client copies with request and response callbacks, including pagination - [@dblock](https://github.com/dblock).
+* [#603](https://github.com/slack-ruby/slack-ruby-client/pull/603): Enforce consistent exception messages with rubocop-exception_messages and run lint separately from the test matrix - [@dblock](https://github.com/dblock).
+* [#602](https://github.com/slack-ruby/slack-ruby-client/pull/602): Make gli an optional dependency; only the `slack` command-line client needs it - [@corsonknowles](https://github.com/corsonknowles).
+* [#599](https://github.com/slack-ruby/slack-ruby-client/pull/599): Set a default filename in `files_upload` so Slack displays image previews correctly when none is specified - [@ts-3156](https://github.com/ts-3156), [@dblock](https://github.com/dblock).
+* [#591](https://github.com/slack-ruby/slack-ruby-client/pull/591): Generate AI CHANGELOG entries and PR summaries for automated API update PRs, lock simplecov below 1.1.0 to avoid breaking Coveralls - [@dblock](https://github.com/dblock).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add entity.acknowledgeCommentAction and entity.presentComments methods - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add admin.apps.mcpServers, admin.apps.mcpServers.permissions, and admin.apps.permissions endpoints - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add a metadata argument to chat.postEphemeral - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Remove required :url validation from admin.emoji.add - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add username, icon_url, and icon_emoji arguments to files.completeUploadExternal - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add format, include_threads, and include_attachments arguments to slackLists.download.start and slackLists.download.get - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add exclude_muted argument to users.conversations - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#590](https://github.com/slack-ruby/slack-ruby-client/pull/590): Add new error codes to errors.rb and update slack-api-ref submodule - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Add admin.conversations.bulkSetProperties method for bulk-setting channel properties - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Add admin.usergroups.removeTeams method for removing default workspaces from an organization-wide IDP Group or Admin Group - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Add unfurl_app_links argument to chat.postMessage - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Remove required team_id argument from admin.users.session.invalidate - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Add AgentsSessions and AppsManagedPermissions endpoint modules for agents.sessions and apps.managedPermissions methods - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Increase conversations.invite users limit from 100 to 1000 - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#597](https://github.com/slack-ruby/slack-ruby-client/pull/597): Add new Slack API error codes - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#600](https://github.com/slack-ruby/slack-ruby-client/pull/600): Add channel_ids argument to admin.apps.permissions.add and admin.apps.permissions.remove, and channel_restriction_mode/channel_ids arguments to admin.apps.permissions.set - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#600](https://github.com/slack-ruby/slack-ruby-client/pull/600): Add oauth.v2.beginShortTokenRotation and oauth.v2.completeShortTokenRotation methods - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#600](https://github.com/slack-ruby/slack-ruby-client/pull/600): Add session_status argument to chat.stopStream - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#600](https://github.com/slack-ruby/slack-ruby-client/pull/600): Add include_list argument to slackLists.items.list - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#600](https://github.com/slack-ruby/slack-ruby-client/pull/600): Update chat.startStream and chat.stopStream chunks argument documentation to mention markdown text, task update, plan update, and blocks chunk objects - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#600](https://github.com/slack-ruby/slack-ruby-client/pull/600): Add new error codes including AgentPromptDisplayNotAllowed, ChannelRestrictionRequiresAppAccess, ChannelRestrictionsNotAvailable, RotationNotFound, TokenTooLong, TooManyChannels, UserIsExternalGuest, and UserNotAuthenticated - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#608](https://github.com/slack-ruby/slack-ruby-client/pull/608): Add admin.usergroups.addUsers, admin.usergroups.removeUsers, admin.usergroups.create, admin.usergroups.fetch, admin.usergroups.update, and admin.usergroups.uploadUsers methods - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#608](https://github.com/slack-ruby/slack-ruby-client/pull/608): Add canvases.getContent method to fetch canvas content as markdown or HTML - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+* [#608](https://github.com/slack-ruby/slack-ruby-client/pull/608): Add new Slack API error codes to Errors - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+### 3.2.0 (2026/07/05)
+
+* [#581](https://github.com/slack-ruby/slack-ruby-client/pull/581): Migrate Danger to use danger-pr-comment workflow - [@dblock](https://github.com/dblock).
+* [#583](https://github.com/slack-ruby/slack-ruby-client/pull/583): Not found errors raised by id_for use more specific error classes when they exist - [@eizengan](https://github.com/eizengan).
+* [#585](https://github.com/slack-ruby/slack-ruby-client/pull/585): Fix ci not triggering on automated api update prs - [@Copilot](https://github.com/Copilot).
+* [#588](https://github.com/slack-ruby/slack-ruby-client/pull/588): Fix text/markdown_text mutual exclusion in chat methods - [@dblock](https://github.com/dblock).
+* [#589](https://github.com/slack-ruby/slack-ruby-client/pull/589): Fix Ruby-version-dependent hash literal syntax in generated specs - [@dblock](https://github.com/dblock).
+* [#578](https://github.com/slack-ruby/slack-ruby-client/pull/578): Update API from [slack-api-ref@38cb2f4](https://github.com/slack-ruby/slack-api-ref/commit/38cb2f4) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).
+
+### 3.1.0 (2025/11/15)
 
 * [#576](https://github.com/slack-ruby/slack-ruby-client/pull/576): Add support for `blocks` in `files_upload_v2` - [@childish-sambino](https://github.com/childish-sambino).
 * [#574](https://github.com/slack-ruby/slack-ruby-client/pull/574): Update API from [slack-api-ref@bd5dd34](https://github.com/slack-ruby/slack-api-ref/commit/bd5dd34) - [@slack-ruby-ci-bot](https://github.com/apps/slack-ruby-ci-bot).

data/CONTRIBUTING.md

@@ -59,7 +59,16 @@ We definitely appreciate pull requests that highlight or reproduce a problem, ev
 
 Implement your feature or bug fix.
 
-Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop). Run `bundle exec rubocop` and fix any style issues highlighted, auto-correct issues when possible with `bundle exec rubocop -a`. To silence generally ignored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+Ruby style is enforced with [RuboCop](https://github.com/rubocop/rubocop), including [exception message conventions](https://github.com/dblock/rubocop-exception_messages). The main Gemfile includes lint dependencies only on Ruby 3.2+ so tests can continue running on older supported Ruby versions.
+
+```bash
+bundle install
+bundle exec rubocop
+```
+
+Fix any style issues highlighted, auto-correcting safe issues with `bundle exec rubocop -a`. Exception message corrections require `-A`; review them and update message expectations in tests. To regenerate the baseline for generally ignored issues, including line lengths or code complexity metrics, run `bundle exec rubocop --auto-gen-config`.
+
+On Ruby 3.2+, `bundle exec rake rubocop` also runs lint. The default `bundle exec rake` runs tests only; CI runs lint separately on Ruby 3.3.
 
 Make sure that `bundle exec rake` completes without errors.
 

data/Dangerfile

@@ -1,3 +1,6 @@
 # frozen_string_literal: true
 
-danger.import_dangerfile(gem: 'slack-ruby-danger')
+danger.import_dangerfile(gem: 'danger-pr-comment')
+
+changelog.check!
+toc.check!

data/Gemfile

@@ -7,20 +7,35 @@ group :test do
   gem 'activesupport'
   gem 'base64'
   gem 'bigdecimal'
+  gem 'danger-changelog', require: false
+  gem 'danger-pr-comment', require: false
+  gem 'danger-toc', require: false
   gem 'erubis'
   gem 'faraday-typhoeus'
+  gem 'gli'
   gem 'json-schema'
   gem 'mutex_m'
   gem 'racc'
+  gem 'rackup', '~> 2.1'
   gem 'rake', '~> 13'
   gem 'rspec'
-  gem 'rubocop', '1.26.1' # Lock to specific version to avoid breaking cops/changes
-  gem 'rubocop-performance'
-  gem 'rubocop-rake'
-  gem 'rubocop-rspec'
-  gem 'simplecov'
+  # Lock below 1.1.0, which started writing float timestamps to
+  # coverage/.resultset.json, breaking coverallsapp/github-action's parser
+  # (coverallsapp/github-action#269, coverallsapp/coverage-reporter#191).
+  gem 'simplecov', '< 1.1.0'
   gem 'simplecov-lcov'
   gem 'timecop'
   gem 'vcr'
   gem 'webmock'
+  gem 'webrick', '~> 1.8'
+end
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.2')
+  group :lint do
+    gem 'rubocop', '~> 1.72'
+    gem 'rubocop-exception_messages', '~> 0.2.0', require: false
+    gem 'rubocop-performance', '~> 1.27'
+    gem 'rubocop-rake', '~> 0.7'
+    gem 'rubocop-rspec', '~> 3.10'
+  end
 end

data/README.md

@@ -70,7 +70,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [Events](https:
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 3.3.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -301,6 +301,41 @@ You can also pass request options, including `timeout` and `open_timeout` into i
 client.conversations_list(request: { timeout: 180 })
 ```
 
+Use `with_request` and `with_response` to create a configured client copy with HTTP callbacks, without changing the original client or parsed-body return values:
+
+```ruby
+scopes = nil
+observed_client = client.with_request do |request|
+  request.headers['X-Custom'] = 'value'
+end.with_response do |response|
+  scopes = response.headers['x-oauth-scopes']&.split(',')&.map(&:strip)
+end
+
+result = observed_client.auth_test
+observed_client.users_list do |page|
+  puts page.members
+end
+```
+
+Request callbacks receive a `Faraday::Request` after authentication and request options are configured, before dispatch. They can change headers, body, and options. Response callbacks receive a `Faraday::Response` with the parsed body, headers, and status after successful completion; they do not run when Slack or transport errors are raised. Callbacks apply to each HTTP call, including pagination pages and requests made by helpers. Endpoint blocks retain their existing meaning.
+
+Chaining registers callbacks in order. Copies preserve client configuration but use independent connections and callback lists; the original client is unchanged. Callback exceptions propagate and request callback failures prevent dispatch. Callbacks are synchronous; avoid storing sensitive authorization headers, and synchronize any shared state if using a client concurrently.
+
+Use `with_error` to observe Slack and transport errors without recovering from them:
+
+```ruby
+observed_client = client.with_error do |error|
+  logger.warn(
+    message: error.message,
+    errors: error.respond_to?(:errors) && error.response ? error.errors : nil,
+    response_metadata: error.respond_to?(:response_metadata) && error.response ? error.response_metadata : nil
+  )
+end
+observed_client.auth_test
+```
+
+Error callbacks receive the exception and then it is re-raised unchanged. They run for every failed HTTP attempt, including failures that pagination subsequently retries. Successful calls and exceptions from request or response callbacks do not trigger them. If an error callback raises, its exception propagates instead and later callbacks are not invoked. As with other callbacks, these methods return a configured copy and can be chained.
+
 You can control what proxy options are used by modifying the `http_proxy` environment variable per [Net::HTTP's documentation](https://docs.ruby-lang.org/en/2.0.0/Net/HTTP.html#class-Net::HTTP-label-Proxies).
 
 Note that Docker on OSX seems to incorrectly set the proxy, causing `Faraday::ConnectionFailed, ERROR -- : Failed to open TCP connection to : (getaddrinfo: Name or service not known)`. You might need to manually unset `http_proxy` in that case, eg. `http_proxy="" bundle exec ruby ./my_bot.rb`.
@@ -426,6 +461,10 @@ Slack::Events::Request.new(
 
 The `verify!` call may raise `Slack::Events::Request::MissingSigningSecret`, `Slack::Events::Request::InvalidSignature` or `Slack::Events::Request::TimestampExpired` errors.
 
+Both rewindable request bodies and non-rewindable streams permitted by Rack 3 are supported. `Slack::Events::Request#body` caches the raw body. Rewindable inputs are rewound before and after reading, preserving access for other consumers. Non-rewindable inputs are consumed once; use `slack_request.body` for subsequent access to the raw body.
+
+Verify the signature before middleware or application code reads a non-rewindable input. Bytes already consumed from a one-shot stream cannot be recovered, and verification will fail. If multiple consumers need to read `rack.input`, install `Rack::RewindableInput::Middleware` (Rack 3) before any body-reading middleware to buffer the input.
+
 ### Message Handling
 
 All text in Slack uses the same [system of formatting and escaping](https://api.slack.com/docs/formatting): chat messages, direct messages, file comments, etc. [Slack::Messages::Formatting](lib/slack/messages/formatting.rb) provides convenience methods to format and parse messages.
@@ -562,7 +601,13 @@ Slack::Messages::Formatting.escape('Hello & <world>')
 
 ### Command-Line Client
 
-The slack command-line client returns JSON data from the Slack API.
+The slack command-line client returns JSON data from the Slack API. It uses [GLI](https://github.com/davetron5000/gli), which is not a dependency of slack-ruby-client, so install it alongside the client.
+
+```
+gem install gli
+```
+
+Or add `gem 'gli'` to your Gemfile.
 
 #### Authenticate with Slack
 

data/RELEASING.md

@@ -16,7 +16,7 @@ Check that the last build succeeded in [GitHub Actions](https://github.com/slack
 Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
 
 ```
-### 0.2.2 (7/10/2015)
+### 0.2.2 (2015/07/10)
 ```
 
 Remove the line with "Your contribution here.", since there will be no more contributions to this release.
@@ -44,7 +44,7 @@ $ rake release
 
 slack-ruby-client 0.2.2 built to pkg/slack-ruby-client-0.2.2.gem.
 Tagged v0.2.2.
-Pushed git commits and tags.
+Pushed git commits and release tag.
 Pushed slack-ruby-client 0.2.2 to rubygems.org.
 ```
 

data/Rakefile

@@ -12,10 +12,14 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = FileList['spec/**/*_spec.rb']
 end
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
+desc 'Run RuboCop (Ruby 3.2+).'
+task :rubocop do
+  abort 'RuboCop requires Ruby 3.2 or newer' if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.2')
 
-task default: %i[spec rubocop]
+  sh 'bundle exec rubocop'
+end
+
+task default: :spec
 
 load 'tasks/git.rake'
 load 'tasks/web.rake'

data/UPGRADING.md

@@ -1,6 +1,22 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 3.3.0
+
+#### Command-Line Client Dependency
+
+[#602](https://github.com/slack-ruby/slack-ruby-client/pull/602) removes [gli](https://github.com/davetron5000/gli) from slack-ruby-client's runtime dependencies. Only the `slack` command-line client uses it. If you use the command-line client, add `gem 'gli'` to your Gemfile or run `gem install gli`. Without it, `slack` exits with a message saying so. The library itself is unaffected.
+
+#### Exception Messages
+
+[#603](https://github.com/slack-ruby/slack-ruby-client/pull/603) standardizes handwritten exception messages to start with lowercase letters and omit trailing periods. Some messages also quote argument names and values with backticks. For example, `TooManyRequestsError` now reports `retry after 3600 seconds` instead of `Retry after 3600 seconds`, and file-upload validation reports ``required argument :`filename` missing in file (`0`)`` instead of `Required argument :filename missing in file (0)`.
+
+Update tests, regular expressions, or application logic that match these messages exactly. Exception classes and rescue behavior are unchanged; upstream Slack error codes (such as `invalid_auth`) and dynamically supplied messages are preserved. Prefer matching exception classes and structured error attributes rather than human-readable message text.
+
+### Upgrading to >= 3.2.0
+
+[#583](https://github.com/slack-ruby/slack-ruby-client/pull/583) modifies the error types raised when a nonexistent #channel-name or @user-handle is looked up. These will now raise `ChannelNotFound` and `UserNotFound` respectively, whereas they previously raised a `SlackError`. If your code relies on these types without accounting for inheritance, it will need to be migrated. Notably, `rescue SlackError` will continue to work as normal, since both error classes inherit from it.
+
 ### Upgrading to >= 3.0.0
 
 Support for the [RTM API](https://docs.slack.dev/tools/java-slack-sdk/guides/rtm/) has been removed in [#573](https://github.com/slack-ruby/slack-ruby-client/pull/573). By now you should have [migrated your app to granular permissions](https://code.dblock.org/2020/11/30/migrating-classic-slack-ruby-bots-to-granular-permissions.html), and you should lock your slack-ruby-client to 2.x for those bots. Next, to remove RTM components we found it more effective to just [write a new version of a bot](https://code.dblock.org/2024/06/30/writing-a-channel-slack-bot.html) and avoid a complex migration.