slack-ruby-client 0.11.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b4523b02fb8e41e2a529f21283e9631aca6e04bb
-  data.tar.gz: 6324f7a54941b201b7aa729178418241accf836c
+SHA256:
+  metadata.gz: c51153c945fdc89a1aa46ba02eb49256f7f2978277901f4d95e68c4d92197856
+  data.tar.gz: 9c450898f129249fcd6e2ab448830ba6e0f118e74c8af2f3e3e26e9419cc16ea
 SHA512:
-  metadata.gz: 958f43b8c6c3591d81761e60c310c6cf2638b26ab79b9bf56748768a2e8800fdad85733262c5a93d4272b3861f475b2cbb2f1eabb01fadb3a2848a09c82be3d7
-  data.tar.gz: 1787862cbf85c3cd762c8b044afd89d98c92ee0cd959aaf94da5b5d513cd3c24c3d8de005eece992a5f13ed76a8279231d40d8ade39dd32c4efe692c9118b79c
+  metadata.gz: e1df2c875eb165a043823bd911fc2ac585693dc625bd32070081d01a4cbd4667c32252d287f14960a72266e28f2cd9787b59ef34101fb076e551448094bc1385
+  data.tar.gz: c5bce1883b654790df7992f8dec417cf3976ef210f0d35dd219de54666ec556c957fec9762a094149269c3d195f1c0333fab129ba10320d3f959448924bb42d0

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: github
+

data/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: [dblock]
+tidelift: rubygems/slack-ruby-client

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/integration_test.yml

@@ -0,0 +1,45 @@
+name: Integration Tests
+on: push
+jobs:
+  check-slack-api-token:
+    runs-on: ubuntu-latest
+    outputs:
+      SLACK_API_TOKEN_EXISTS: ${{ steps.check-slack-api-token.outputs.SLACK_API_TOKEN_EXISTS }}
+    steps:
+      - name: Check for SLACK_API_TOKEN availability
+        id: check-slack-api-token
+        shell: bash
+        run: |
+          if [ "${{ secrets.SLACK_API_TOKEN }}" != '' ]; then
+            echo "SLACK_API_TOKEN_EXISTS=true" >> $GITHUB_OUTPUT;
+          else
+            echo "SLACK_API_TOKEN_EXISTS=false" >> $GITHUB_OUTPUT;
+          fi
+
+  test:
+    runs-on: ubuntu-latest
+    needs: [check-slack-api-token]
+    if: needs.check-slack-api-token.outputs.SLACK_API_TOKEN_EXISTS == 'true'
+    strategy:
+      matrix:
+        entry:
+          - { ruby: 2.7, concurrency: async-websocket }
+    name: test (ruby=${{ matrix.entry.ruby }}, concurrency=${{ matrix.entry.concurrency || 'none' }})
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.entry.ruby }}
+          bundler-cache: true
+      - name: Run Tests
+        env:
+          CONCURRENCY: ${{ matrix.entry.concurrency }}
+          SLACK_API_TOKEN: ${{ secrets.SLACK_API_TOKEN }}
+          RACK_ENV: test
+          SPEC: "--pattern spec/**/integration/*_spec.rb"
+          SPEC_OPTS: "--pattern spec/**/integration/*_spec.rb"
+        run: |
+          bundle install
+          bundle exec rake

data/.github/workflows/lint.yml

@@ -0,0 +1,14 @@
+name: Lint
+on: [push, pull_request]
+jobs:
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec rubocop

data/.github/workflows/pr_lint.yml

@@ -0,0 +1,21 @@
+name: PR Lint
+on: pull_request
+jobs:
+  danger:
+    name: Dangerfile
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/Gemfile.danger
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: |
+          # Personal access token for dangerpr-bot - public, but base64 encoded to avoid tripping up GitHub
+          TOKEN=$(echo -n Z2hwX0xNQ3VmanBFeTBvYkZVTWh6NVNqVFFBOEUxU25abzBqRUVuaAo= | base64 --decode)
+          DANGER_GITHUB_API_TOKEN=$TOKEN bundle exec danger --verbose

data/.github/workflows/test.yml

@@ -0,0 +1,56 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        entry:
+          - { ruby: "2.7" }
+          - { ruby: "2.7", concurrency: async-websocket }
+          - { ruby: "3.0" }
+          - { ruby: "3.1" }
+          - { ruby: "3.2" }
+          - { ruby: "3.3" }
+          - { ruby: "3.4" }
+          - { ruby: ruby-head, ignore: true }
+          - { ruby: jruby-head, ignore: true }
+    name: test (ruby=${{ matrix.entry.ruby }}${{ matrix.entry.concurrency && ', concurrency=' }}${{ matrix.entry.concurrency }})
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set Concurrency
+        run: |
+          if [[ ! -z "${{ matrix.entry.concurrency }}" ]]; then
+            echo "Setting concurrency to ${{ matrix.entry.concurrency }}."
+            echo "CONCURRENCY=${{ matrix.entry.concurrency }}" >> $GITHUB_ENV
+          fi
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.entry.ruby }}
+          bundler-cache: true # 'bundle install' and cache gems
+        continue-on-error: ${{ matrix.entry.ignore || false }}
+      - name: Run Tests
+        continue-on-error: ${{ matrix.entry.ignore || false }}
+        env:
+          RACK_ENV: test
+        run: bundle exec rake
+      - name: Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: run-${{ matrix.entry.ruby }}${{ matrix.entry.concurrency && '-'}}${{ matrix.entry.concurrency }}
+          allow-empty: ${{ matrix.entry.ignore || false }}
+
+  finish:
+    name: coveralls
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Close Parallel Build
+        uses: coverallsapp/github-action@v2
+        with:
+          parallel-finished: true
+          carryforward: 'run-2.7,run-2.7-async-websocket,run-3.0,run-3.1,run-3.2,run-3.3'

data/.github/workflows/update_api.yml

@@ -0,0 +1,81 @@
+name: Update API
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "15 23 * * 1"
+jobs:
+  update-api:
+    if: ${{ github.repository == 'slack-ruby/slack-ruby-client' }}
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Config git to rebase
+        run: git config --global pull.rebase true
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2"
+          bundler-cache: true
+      - name: Update API from slack-api-ref
+        run: bundle exec rake slack:api:update
+      - name: Remove files added by setup-ruby
+        run: rm -rf vendor
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+      - 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)"
+      - name: GitHub App token
+        if: ${{ github.repository == 'slack-ruby/slack-ruby-client' }}
+        id: github_app_token
+        uses: tibdex/github-app-token@v2.1.0
+        with:
+          app_id: ${{ secrets.CI_APP_ID }}
+          private_key: ${{ secrets.CI_APP_PRIVATE_KEY }}
+          installation_id: 36985419
+      - name: Create pull request
+        id: cpr
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          commit-message: Update API from slack-api-ref@${{ steps.api-ref.outputs.api-ref }} (${{ steps.date.outputs.date }})
+          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 }}
+          branch: automated-api-update
+          base: master
+          committer: slack-ruby-ci-bot <noreply@github.com>
+          author: slack-ruby-ci-bot <noreply@github.com>
+      - name: Check out update branch
+        if: ${{ steps.cpr.outputs.pull-request-number != '' }}
+        run: |
+          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."
+      - 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 push origin automated-api-update -f

data/.gitignore

@@ -1,6 +1,10 @@
-.env
-pkg
-Gemfile.lock
 .DS_Store
 .bundle
+.byebug_history
+.env
 .idea
+.rspec_status
+Gemfile.lock
+Gemfile.danger.lock
+pkg
+coverage

data/.rubocop.yml

@@ -1,9 +1,47 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+  DisplayCopNames: true
   Exclude:
+    - bin/**/*
     - vendor/**/*
     - lib/slack/web/api/slack-api-ref/**/*
+    - lib/slack/web/api/endpoints/* # Auto-generated
+    - lib/slack/web/api/errors.rb # Auto-generated
+    - spec/slack/web/api/endpoints/* # Auto-generated
 
-Naming/MethodName:
+Layout/EmptyLineAfterMagicComment:
   Enabled: false
 
-inherit_from: .rubocop_todo.yml
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Max: 250
+
+Layout/LineLength:
+  Max: 128
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/InstanceVariable:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/slack-ruby-client.rb # Required to match gemspec name

data/.rubocop_todo.yml

@@ -1,94 +1,248 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-11-25 11:28:32 -0500 using RuboCop version 0.51.0.
+# on 2025-07-19 11:04:04 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.
 
-# Offense count: 4
-Lint/HandleExceptions:
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
   Exclude:
-    - 'lib/slack-ruby-client.rb'
-    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
-    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+    - 'lib/tasks/real_time.rake'
+
+# Offense count: 2
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'spec/slack/real_time/concurrency/clients/async_spec.rb'
+    - 'spec/support/real_time/concurrency/mock.rb'
 
 # Offense count: 1
-Lint/RescueWithoutErrorClass:
+# Configuration parameters: AllowComments.
+Lint/EmptyClass:
   Exclude:
-    - 'lib/slack/real_time/concurrency/celluloid.rb'
+    - 'spec/support/real_time/concurrency/mock.rb'
 
-# Offense count: 18
-Metrics/AbcSize:
-  Max: 44
+# Offense count: 2
+Lint/MissingSuper:
+  Exclude:
+    - 'lib/slack/real_time/stores/starter.rb'
+    - 'lib/slack/real_time/stores/store.rb'
 
-# Offense count: 81
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/BlockLength:
-  Max: 421
+# Offense count: 1
+# This cop supports unsafe auto-correction (--auto-correct-all).
+Lint/NonDeterministicRequireOrder:
+  Exclude:
+    - 'spec/spec_helper.rb'
 
 # Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 166
+# This cop supports safe auto-correction (--auto-correct).
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - 'lib/slack-ruby-client.rb'
 
-# Offense count: 4
-Metrics/CyclomaticComplexity:
-  Max: 9
+# Offense count: 13
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 67
 
-# Offense count: 741
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 266
+# Offense count: 6
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 15
 
-# Offense count: 10
-# Configuration parameters: CountComments.
+# Offense count: 17
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 42
+  Max: 45
 
 # Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 113
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
+Metrics/ParameterLists:
+  Max: 6
 
 # Offense count: 3
+# Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 11
+  Max: 17
+
+# Offense count: 2
+# Configuration parameters: MinSize.
+Performance/CollectionLiteralInLoop:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
+    - 'spec/slack/web/api/endpoints/custom/files_spec.rb'
 
 # Offense count: 1
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
-# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
-Naming/FileName:
+# This cop supports safe auto-correction (--auto-correct).
+Performance/MapCompact:
   Exclude:
-    - 'lib/slack-ruby-client.rb'
+    - 'lib/slack/web/api/helpers/files.rb'
+
+# Offense count: 2
+# This cop supports safe auto-correction (--auto-correct).
+Performance/RegexpMatch:
+  Exclude:
+    - 'lib/tasks/web.rake'
+
+# Offense count: 3
+# This cop supports safe auto-correction (--auto-correct).
+Performance/StringInclude:
+  Exclude:
+    - 'lib/tasks/web.rake'
 
-# Offense count: 63
-Style/Documentation:
+# Offense count: 10
+# This cop supports safe auto-correction (--auto-correct).
+RSpec/ContextMethod:
+  Exclude:
+    - 'spec/slack/messages/formatting_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
+
+# Offense count: 86
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
   Enabled: false
 
-# Offense count: 137
-# Configuration parameters: AllowedVariables.
-Style/GlobalVars:
+# Offense count: 75
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 18
+
+# Offense count: 19
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
   Enabled: false
 
-# Offense count: 2
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/slack/real_time/stores/store.rb'
-    - 'lib/slack/web/faraday/response/raise_error.rb'
+# Offense count: 86
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 103
+RSpec/MultipleExpectations:
+  Max: 5
+
+# Offense count: 7
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 9
 
 # Offense count: 3
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
+# Configuration parameters: IgnoreSharedExamples.
+RSpec/NamedSubject:
+  Exclude:
+    - 'spec/slack/web/api/mixins/conversations_list_spec.rb'
+
+# Offense count: 48
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 6
+RSpec/StubbedMock:
+  Exclude:
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/real_time/event_handlers/event_handlers_spec.rb'
+    - 'spec/slack/web/api/endpoints/custom/conversations_spec.rb'
+    - 'spec/slack/web/api/pagination/cursor_spec.rb'
+    - 'spec/slack/web/client_spec.rb'
+
+# Offense count: 14
+RSpec/SubjectStub:
+  Exclude:
+    - 'spec/slack/web/api/mixins/conversations_spec.rb'
+    - 'spec/slack/web/api/mixins/users_spec.rb'
+
+# Offense count: 4
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: .
+# SupportedStyles: constant, string
+RSpec/VerifiedDoubleReference:
+  EnforcedStyle: string
+
+# Offense count: 10
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/slack/events/request_spec.rb'
+    - 'spec/slack/real_time/client_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
+    - 'spec/support/real_time/connected_client.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+Rake/Desc:
+  Exclude:
+    - 'lib/tasks/git.rake'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
+# SupportedStyles: inline, group
+Style/AccessModifierDeclarations:
+  Exclude:
+    - 'lib/slack/real_time/client.rb'
+
+# Offense count: 4
+# Configuration parameters: MaxUnannotatedPlaceholdersAllowed, IgnoredMethods.
+# SupportedStyles: annotated, template, unannotated
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+# Offense count: 5
+# This cop supports safe auto-correction (--auto-correct).
+Style/GlobalStdStream:
   Exclude:
-    - 'lib/slack/config.rb'
-    - 'lib/slack/real_time/config.rb'
-    - 'lib/slack/web/config.rb'
+    - 'lib/slack/logger.rb'
+    - 'lib/tasks/real_time.rake'
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/slack/web/client_spec.rb'
 
 # Offense count: 1
+# This cop supports unsafe auto-correction (--auto-correct-all).
+Style/MapToHash:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom/files_spec.rb'
+
+# Offense count: 1
+Style/MultilineBlockChain:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
 Style/MultilineTernaryOperator:
   Exclude:
-    - 'spec/support/real_time/connected_client.rb'
+    - 'spec/support/vcr.rb'
+
+# Offense count: 3
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/slack/web/api/endpoints/custom/chat_spec.rb'
+    - 'spec/slack/web/api/pagination/cursor_spec.rb'
+    - 'spec/slack/web/faraday/response/raise_error_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'spec/support/queue_with_timeout.rb'
+
+# Offense count: 1
+# This cop supports safe auto-correction (--auto-correct).
+# Configuration parameters: ConvertCodeThatCanStartToReturnNil, AllowedMethods.
+# AllowedMethods: present?, blank?, presence, try, try!
+Style/SafeNavigation:
+  Exclude:
+    - 'lib/slack/web/api/helpers/files.rb'
+
+# Offense count: 1
+# This cop supports unsafe auto-correction (--auto-correct-all).
+Style/SlicingWithRange:
+  Exclude:
+    - 'lib/slack/web/api/mixins/ids.id.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6