slack-ruby-client 2.7.0 → 3.1.0

data/lib/slack/web/faraday/response/raise_error.rb

@@ -5,7 +5,7 @@ module Slack
       module Response
         class RaiseError < ::Faraday::Middleware
           def on_complete(env)
-            raise Slack::Web::Api::Errors::TooManyRequestsError, env.response if env.status == 429
+            raise Slack::Web::Api::Errors::TooManyRequestsError, redact_response(env.response) if env.status == 429
 
             return unless env.success?
 
@@ -16,7 +16,25 @@ module Slack
             error_message = body['error'] || body['errors'].map { |message| message['error'] }.join(',')
             error_class = Slack::Web::Api::Errors::ERROR_CLASSES[error_message]
             error_class ||= Slack::Web::Api::Errors::SlackError
-            raise error_class.new(error_message, env.response)
+            raise error_class.new(error_message, redact_response(env.response))
+          end
+
+          private
+
+          def redact_response(response)
+            return response unless response&.env
+
+            redacted_env = response.env.dup
+
+            # redact Authorization header if it exists
+            if redacted_env[:request_headers]&.key?('Authorization')
+              redacted_env[:request_headers] = redacted_env[:request_headers].dup
+              redacted_env[:request_headers]['Authorization'] = '[REDACTED]'
+            end
+
+            redacted_response = ::Faraday::Response.new(redacted_env)
+            redacted_response.env[:response] = redacted_response
+            redacted_response
           end
         end
       end

data/lib/slack-ruby-client.rb

@@ -42,18 +42,6 @@ require_relative 'slack/web/api/helpers'
 require_relative 'slack/web/pagination/cursor'
 require_relative 'slack/web/client'
 
-# RealTime API
-require_relative 'slack/real_time/concurrency'
-require_relative 'slack/real_time/socket'
-require_relative 'slack/real_time/api/message_id'
-require_relative 'slack/real_time/api/ping'
-require_relative 'slack/real_time/api/message'
-require_relative 'slack/real_time/api/typing'
-require_relative 'slack/real_time/models'
-require_relative 'slack/real_time/stores'
-require_relative 'slack/real_time/config'
-require_relative 'slack/real_time/client'
-
 # Events API
 require_relative 'slack/events/config'
 require_relative 'slack/events/request'

data/lib/tasks/update.rake

@@ -3,7 +3,6 @@ namespace :slack do
   namespace :api do
     desc 'Auto-generate automatic portions of the Slack API client.'
     task :update do
-      Rake::Task['slack:real_time:api:update'].invoke
       Rake::Task['slack:web:api:update'].invoke
     end
   end

data/lib/tasks/web.rake

@@ -27,16 +27,14 @@ namespace :slack do
           Dir.glob('lib/slack/web/api/mixins/**/*.json')
         ].flatten.each_with_object({}) do |path, result|
           file_name = File.basename(path, '.json')
+          next if File.dirname(path).split('/').last.start_with?('_') # skip _common, _errors, etc.
+
           prefix = file_name.split('.')[0..-2].join('.')
           name = file_name.split('.')[-1]
           result[prefix] ||= {}
           parsed = JSON.parse(File.read(path))
           parsed['undocumented'] = true if path =~ /undocumented/
           JSON::Validator.validate(method_schema, parsed, insert_defaults: true)
-          if parsed['deprecated'] && parsed['deprecation']['deprecation_warning'] =~ /It will stop functioning in February 2021/
-            next
-          end
-
           result[prefix][name] = parsed
         end
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-20 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,7 +93,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email: dblock@dblock.org
 executables:
 - slack
@@ -104,7 +102,6 @@ files:
 - ".coveralls.yml"
 - ".github/FUNDING.yml"
 - ".github/dependabot.yml"
-- ".github/workflows/integration_test.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/pr_lint.yml"
 - ".github/workflows/test.yml"
@@ -186,6 +183,7 @@ files:
 - bin/commands/dialog.rb
 - bin/commands/dnd.rb
 - bin/commands/emoji.rb
+- bin/commands/entity.rb
 - bin/commands/files.rb
 - bin/commands/files_comments.rb
 - bin/commands/files_remote.rb
@@ -202,6 +200,10 @@ files:
 - bin/commands/reminders.rb
 - bin/commands/rtm.rb
 - bin/commands/search.rb
+- bin/commands/slackLists.rb
+- bin/commands/slackLists_access.rb
+- bin/commands/slackLists_download.rb
+- bin/commands/slackLists_items.rb
 - bin/commands/stars.rb
 - bin/commands/team.rb
 - bin/commands/team_billing.rb
@@ -217,19 +219,13 @@ files:
 - bin/commands/users_prefs.rb
 - bin/commands/users_profile.rb
 - bin/commands/views.rb
-- bin/commands/workflows.rb
+- bin/commands/workflows_featured.rb
 - bin/commands/workflows_triggers_permissions.rb
 - bin/slack
 - examples/files_upload_v2/.env.example
 - examples/files_upload_v2/Gemfile
 - examples/files_upload_v2/README.md
 - examples/files_upload_v2/files_upload_v2.rb
-- examples/hi_real_time_and_web/Gemfile
-- examples/hi_real_time_and_web/hi.gif
-- examples/hi_real_time_and_web/hi.rb
-- examples/hi_real_time_async_async/Gemfile
-- examples/hi_real_time_async_async/Procfile
-- examples/hi_real_time_async_async/hi.rb
 - examples/hi_web/Gemfile
 - examples/hi_web/hi.gif
 - examples/hi_web/hi.rb
@@ -247,29 +243,6 @@ files:
 - lib/slack/logger.rb
 - lib/slack/messages/formatting.rb
 - lib/slack/messages/message.rb
-- lib/slack/real_time/api/message.rb
-- lib/slack/real_time/api/message_id.rb
-- lib/slack/real_time/api/ping.rb
-- lib/slack/real_time/api/schema/event.json
-- lib/slack/real_time/api/templates/event_handler.erb
-- lib/slack/real_time/api/typing.rb
-- lib/slack/real_time/client.rb
-- lib/slack/real_time/concurrency.rb
-- lib/slack/real_time/concurrency/async.rb
-- lib/slack/real_time/config.rb
-- lib/slack/real_time/models.rb
-- lib/slack/real_time/models/base.rb
-- lib/slack/real_time/models/bot.rb
-- lib/slack/real_time/models/channel.rb
-- lib/slack/real_time/models/im.rb
-- lib/slack/real_time/models/mpim.rb
-- lib/slack/real_time/models/team.rb
-- lib/slack/real_time/models/user.rb
-- lib/slack/real_time/socket.rb
-- lib/slack/real_time/stores.rb
-- lib/slack/real_time/stores/base.rb
-- lib/slack/real_time/stores/starter.rb
-- lib/slack/real_time/stores/store.rb
 - lib/slack/utils/security.rb
 - lib/slack/version.rb
 - lib/slack/web/api/endpoints.rb
@@ -333,6 +306,7 @@ files:
 - lib/slack/web/api/endpoints/dialog.rb
 - lib/slack/web/api/endpoints/dnd.rb
 - lib/slack/web/api/endpoints/emoji.rb
+- lib/slack/web/api/endpoints/entity.rb
 - lib/slack/web/api/endpoints/files.rb
 - lib/slack/web/api/endpoints/files_comments.rb
 - lib/slack/web/api/endpoints/files_remote.rb
@@ -349,6 +323,10 @@ files:
 - lib/slack/web/api/endpoints/reminders.rb
 - lib/slack/web/api/endpoints/rtm.rb
 - lib/slack/web/api/endpoints/search.rb
+- lib/slack/web/api/endpoints/slackLists.rb
+- lib/slack/web/api/endpoints/slackLists_access.rb
+- lib/slack/web/api/endpoints/slackLists_download.rb
+- lib/slack/web/api/endpoints/slackLists_items.rb
 - lib/slack/web/api/endpoints/stars.rb
 - lib/slack/web/api/endpoints/team.rb
 - lib/slack/web/api/endpoints/team_billing.rb
@@ -364,7 +342,7 @@ files:
 - lib/slack/web/api/endpoints/users_prefs.rb
 - lib/slack/web/api/endpoints/users_profile.rb
 - lib/slack/web/api/endpoints/views.rb
-- lib/slack/web/api/endpoints/workflows.rb
+- lib/slack/web/api/endpoints/workflows_featured.rb
 - lib/slack/web/api/endpoints/workflows_triggers_permissions.rb
 - lib/slack/web/api/error.rb
 - lib/slack/web/api/errors.rb
@@ -399,7 +377,6 @@ files:
 - lib/slack/web/pagination/cursor.rb
 - lib/slack_ruby_client.rb
 - lib/tasks/git.rake
-- lib/tasks/real_time.rake
 - lib/tasks/update.rake
 - lib/tasks/web.rake
 - slack-ruby-client.gemspec
@@ -410,7 +387,6 @@ licenses:
 metadata:
   rubygems_mfa_required: 'true'
   changelog_uri: https://github.com/slack-ruby/slack-ruby-client/blob/master/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -425,8 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Slack Web and RealTime API client.
 test_files: []

data/.github/workflows/integration_test.yml

@@ -1,45 +0,0 @@
-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/bin/commands/workflows.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-# This file was auto-generated by lib/tasks/web.rake
-
-module Slack
-  module Cli
-    class App
-      desc 'Workflows methods.'
-      command 'workflows' do |g|
-        g.desc "Indicate that an app's step in a workflow completed execution."
-        g.long_desc %( Indicate that an app's step in a workflow completed execution. )
-        g.command 'stepCompleted' do |c|
-          c.flag 'workflow_step_execute_id', desc: 'Context identifier that maps to the correct workflow step execution.'
-          c.flag 'outputs', desc: 'Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object.'
-          c.action do |_global_options, options, _args|
-            puts JSON.dump(@client.workflows_stepCompleted(options))
-          end
-        end
-
-        g.desc "Indicate that an app's step in a workflow failed to execute."
-        g.long_desc %( Indicate that an app's step in a workflow failed to execute. )
-        g.command 'stepFailed' do |c|
-          c.flag 'error', desc: 'A JSON-based object with a message property that should contain a human readable error message.'
-          c.flag 'workflow_step_execute_id', desc: 'Context identifier that maps to the correct workflow step execution.'
-          c.action do |_global_options, options, _args|
-            puts JSON.dump(@client.workflows_stepFailed(options))
-          end
-        end
-
-        g.desc 'Update the configuration for a workflow step.'
-        g.long_desc %( Update the configuration for a workflow step. )
-        g.command 'updateStep' do |c|
-          c.flag 'workflow_step_edit_id', desc: 'A context identifier provided with view_submission payloads used to call back to workflows.updateStep.'
-          c.flag 'inputs', desc: 'A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.'
-          c.flag 'outputs', desc: 'An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.'
-          c.flag 'step_image_url', desc: 'An optional field that can be used to override app image that is shown in the Workflow Builder.'
-          c.flag 'step_name', desc: 'An optional field that can be used to override the step name that is shown in the Workflow Builder.'
-          c.action do |_global_options, options, _args|
-            puts JSON.dump(@client.workflows_updateStep(options))
-          end
-        end
-      end
-    end
-  end
-end

data/examples/hi_real_time_and_web/Gemfile

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-source 'http://rubygems.org'
-
-gem 'slack-ruby-client', path: '../..'
-
-gem 'faye-websocket'

data/examples/hi_real_time_and_web/hi.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-require 'slack-ruby-client'
-
-Slack.configure do |config|
-  config.token = ENV['SLACK_API_TOKEN']
-  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
-end
-
-client = Slack::RealTime::Client.new
-
-client.on :hello do
-  puts(
-    "Successfully connected, welcome '#{client.self.name}' " \
-    "to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-  )
-end
-
-client.on :message do |data|
-  puts data
-  case data.text
-  when 'bot hi'
-    client.web_client.chat_postMessage channel: data.channel, text: "Hi <@#{data.user}>!"
-  when /^bot/
-    client.web_client.chat_postMessage channel: data.channel, text: "Sorry <@#{data.user}>, what?"
-  end
-end
-
-client.start!

data/examples/hi_real_time_async_async/Gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-source 'http://rubygems.org'
-
-gem 'slack-ruby-client', path: '../..'
-
-gem 'async-websocket'
-gem 'foreman'

data/examples/hi_real_time_async_async/Procfile

@@ -1,2 +0,0 @@
-console: bundle exec ruby hi.rb
-

data/examples/hi_real_time_async_async/hi.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-require 'slack-ruby-client'
-require 'async'
-
-raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
-
-$stdout.sync = true
-logger = Logger.new($stdout)
-logger.level = Logger::DEBUG
-
-threads = []
-
-ENV['SLACK_API_TOKENS'].split.each do |token|
-  logger.info "Starting #{token[0..12]} ..."
-
-  client = Slack::RealTime::Client.new(token: token)
-
-  client.on :hello do
-    logger.info(
-      "Successfully connected, welcome '#{client.self.name}' to " \
-      "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
-    )
-  end
-
-  client.on :message do |data|
-    logger.info data
-
-    client.typing channel: data.channel
-
-    case data.text
-    when /hi/
-      client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    else
-      client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
-    end
-  end
-
-  threads << client.start_async
-end
-
-threads.each(&:join)

data/lib/slack/real_time/api/message.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-module Slack
-  module RealTime
-    module Api
-      module Message
-        #
-        # Sends a message to a channel.
-        #
-        # @option options [channel] :channel
-        #   Channel to send message to. Can be a public channel, private group or IM channel.
-        #   Can be an encoded ID, or a name.
-        # @option options [Object] :text
-        #   Text of the message to send. See below for an explanation of formatting.
-        def message(options = {})
-          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
-          raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
-
-          send_json({ type: 'message', id: next_id }.merge(options))
-        end
-      end
-    end
-  end
-end

data/lib/slack/real_time/api/message_id.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-module Slack
-  module RealTime
-    module Api
-      module MessageId
-        private
-
-        def next_id
-          @next_id ||= 0
-          @next_id += 1
-        end
-      end
-    end
-  end
-end

data/lib/slack/real_time/api/ping.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-module Slack
-  module RealTime
-    module Api
-      module Ping
-        #
-        # Clients should try to quickly detect disconnections, even in idle periods, so that users
-        # can easily tell the
-        # difference between being disconnected and everyone being quiet. Not all web browsers
-        # support the WebSocket
-        # ping spec, so the RTM protocol also supports ping/pong messages.
-        #
-        def ping(options = {})
-          send_json({ type: 'ping', id: next_id }.merge(options))
-        end
-      end
-    end
-  end
-end

data/lib/slack/real_time/api/schema/event.json

@@ -1,23 +0,0 @@
-{
-  "type": "object",
-  "required": [
-    "name",
-    "desc"
-  ],
-  "properties": {
-    "name": {
-      "type": "string"
-    },
-    "desc": {
-      "type": "string"
-    },
-    "long_desc": {
-      "type": "string"
-    },
-    "example": {
-      "type": "object",
-      "default": {}
-    }
-  }
-}
-

data/lib/slack/real_time/api/templates/event_handler.erb

@@ -1,8 +0,0 @@
-        # <%= desc %>
-        # @see https://api.slack.com/events/<%= name %>
-        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/<%= name %>.json
-<% if hook %>
-<%= hook %>
-<% else %>
-          # on :<%= name %> do |data|
-<% end %>

data/lib/slack/real_time/api/typing.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-module Slack
-  module RealTime
-    module Api
-      module Typing
-        #
-        # Send a typing indicator to indicate that the user is currently writing a message.
-        #
-        # @option options [channel] :channel
-        #   Channel to send message to. Can be a public channel, private group or IM channel.
-        #   Can be an encoded ID, or a name.
-        def typing(options = {})
-          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
-
-          send_json({ type: 'typing', id: next_id }.merge(options))
-        end
-      end
-    end
-  end
-end