slack-ruby-client 0.14.5 → 0.17.0

data/bin/commands/team.rb

@@ -7,6 +7,7 @@ command 'team' do |g|
   g.long_desc %( Gets the access logs for the current team. )
   g.command 'accessLogs' do |c|
     c.flag 'before', desc: 'End of time range of logs to include in results (inclusive).'
+    c.flag 'team_id', desc: 'encoded team id to get logs from, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.team_accessLogs(options))
     end
@@ -15,6 +16,7 @@ command 'team' do |g|
   g.desc 'Gets billable users information for the current team.'
   g.long_desc %( Gets billable users information for the current team. )
   g.command 'billableInfo' do |c|
+    c.flag 'team_id', desc: 'encoded team id to get the billable information from, required if org token is used.'
     c.flag 'user', desc: 'A user to retrieve the billable information for. Defaults to all users.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.team_billableInfo(options))
@@ -36,6 +38,7 @@ command 'team' do |g|
     c.flag 'app_id', desc: 'Filter logs to this Slack app. Defaults to all logs.'
     c.flag 'change_type', desc: 'Filter logs with this change type. Defaults to all logs.'
     c.flag 'service_id', desc: 'Filter logs to this service. Defaults to all logs.'
+    c.flag 'team_id', desc: 'encoded team id to get logs from, required if org token is used.'
     c.flag 'user', desc: "Filter logs generated by this user's actions. Defaults to all logs."
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.team_integrationLogs(options))

data/bin/commands/usergroups.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Usergroups methods.'
+desc "Get info on your team's User Groups."
 command 'usergroups' do |g|
   g.desc 'Create a User Group'
   g.long_desc %( Create a User Group )
@@ -11,6 +11,7 @@ command 'usergroups' do |g|
     c.flag 'description', desc: 'A short description of the User Group.'
     c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
     c.flag 'include_count', desc: 'Include the number of users in each User Group.'
+    c.flag 'team_id', desc: 'Encoded team id where the user group has to be created, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_create(options))
     end
@@ -21,6 +22,7 @@ command 'usergroups' do |g|
   g.command 'disable' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+    c.flag 'team_id', desc: 'Encoded team id where the user group is, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_disable(options))
     end
@@ -31,6 +33,7 @@ command 'usergroups' do |g|
   g.command 'enable' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+    c.flag 'team_id', desc: 'Encoded team id where the user group is, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_enable(options))
     end
@@ -42,6 +45,7 @@ command 'usergroups' do |g|
     c.flag 'include_count', desc: 'Include the number of users in each User Group.'
     c.flag 'include_disabled', desc: 'Include disabled User Groups.'
     c.flag 'include_users', desc: 'Include the list of users for each User Group.'
+    c.flag 'team_id', desc: 'encoded team id to list user groups in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_list(options))
     end
@@ -56,6 +60,7 @@ command 'usergroups' do |g|
     c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
     c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
+    c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_update(options))
     end

data/bin/commands/usergroups_users.rb

@@ -8,6 +8,7 @@ command 'usergroups_users' do |g|
   g.command 'list' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
+    c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_users_list(options))
     end
@@ -19,6 +20,7 @@ command 'usergroups_users' do |g|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the User Group.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+    c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_users_update(options))
     end

data/bin/commands/users.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Users methods.'
+desc 'Get info on members of your Slack team.'
 command 'users' do |g|
   g.desc 'List conversations the calling user may access.'
   g.long_desc %( List conversations the calling user may access. )
@@ -9,6 +9,7 @@ command 'users' do |g|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
     c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000."
+    c.flag 'team_id', desc: 'encoded team id to list conversations in, required if org token is used.'
     c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
     c.flag 'user', desc: "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
     c.action do |_global_options, options, _args|
@@ -65,7 +66,8 @@ command 'users' do |g|
   g.command 'list' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
-    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
+    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors."
+    c.flag 'team_id', desc: 'encoded team id to list users in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_list(options))
     end
@@ -100,10 +102,10 @@ command 'users' do |g|
   g.desc 'Set the user profile photo'
   g.long_desc %( Set the user profile photo )
   g.command 'setPhoto' do |c|
-    c.flag 'image', desc: 'File contents via multipart/form-data.'
     c.flag 'crop_w', desc: 'Width/height of crop box (always square).'
     c.flag 'crop_x', desc: 'X coordinate of top-left corner of crop box.'
     c.flag 'crop_y', desc: 'Y coordinate of top-left corner of crop box.'
+    c.flag 'image', desc: 'File contents via multipart/form-data.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_setPhoto(options))
     end

data/bin/commands/users_profile.rb

@@ -3,18 +3,18 @@
 
 desc 'UsersProfile methods.'
 command 'users_profile' do |g|
-  g.desc "Retrieves a user's profile information."
-  g.long_desc %( Retrieves a user's profile information. )
+  g.desc "Retrieve a user's profile information, including their custom status."
+  g.long_desc %( Retrieve a user's profile information, including their custom status. )
   g.command 'get' do |c|
-    c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
+    c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.'
     c.flag 'user', desc: 'User to retrieve profile info for.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_profile_get(options))
     end
   end
 
-  g.desc 'Set the profile information for a user.'
-  g.long_desc %( Set the profile information for a user. )
+  g.desc "Set a user's profile information, including custom status."
+  g.long_desc %( Set a user's profile information, including custom status. )
   g.command 'set' do |c|
     c.flag 'name', desc: 'Name of a single key to set. Usable only if profile is not passed.'
     c.flag 'profile', desc: 'Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.'

data/bin/commands/views.rb

@@ -37,7 +37,7 @@ command 'views' do |g|
   g.desc 'Update an existing view.'
   g.long_desc %( Update an existing view. )
   g.command 'update' do |c|
-    c.flag 'view', desc: 'A view payload This must be a JSON-encoded string.'
+    c.flag 'view', desc: 'A view object. This must be a JSON-encoded string.'
     c.flag 'external_id', desc: 'A unique identifier of the view set by the developer. Must be unique for all views on a team. Max length of 255 characters. Either view_id or external_id is required.'
     c.flag 'hash', desc: 'A string that represents view state to protect against possible race conditions.'
     c.flag 'view_id', desc: 'A unique identifier of the view to be updated. Either view_id or external_id is required.'

data/bin/commands/workflows.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+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

data/lib/slack-ruby-client.rb

@@ -15,19 +15,22 @@ require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # ignore, only used in users_search
 end
 begin
   require 'openssl'
-rescue LoadError # rubocop:disable Lint/HandleExceptions
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # Used in slack/web/config
 end
 require_relative 'slack/web/config'
 require_relative 'slack/web/api/errors/slack_error'
 require_relative 'slack/web/api/errors/too_many_requests_error'
 require_relative 'slack/web/api/error'
+require_relative 'slack/web/api/errors'
+require_relative 'slack/web/api/errors/internal_error'
 require_relative 'slack/web/faraday/response/raise_error'
+require_relative 'slack/web/faraday/response/wrap_error'
 require_relative 'slack/web/faraday/connection'
 require_relative 'slack/web/faraday/request'
 require_relative 'slack/web/api/mixins'
@@ -36,8 +39,6 @@ require_relative 'slack/web/pagination/cursor'
 require_relative 'slack/web/client'
 
 # RealTime API
-require 'active_support'
-require 'active_support/core_ext'
 require_relative 'slack/real_time/concurrency'
 require_relative 'slack/real_time/socket'
 require_relative 'slack/real_time/api/message_id'

data/lib/slack/events/request.rb

@@ -19,13 +19,13 @@ module Slack
 
       # Request timestamp.
       def timestamp
-        @timestamp ||= http_request.headers['X-Slack-Request-Timestamp']
+        @timestamp ||= http_request.get_header('HTTP_X_SLACK_REQUEST_TIMESTAMP')
       end
 
       # The signature is created by combining the signing secret with the body of the request
       # Slack is sending using a standard HMAC-SHA256 keyed hash.
       def signature
-        @signature ||= http_request.headers['X-Slack-Signature']
+        @signature ||= http_request.get_header('HTTP_X_SLACK_SIGNATURE')
       end
 
       # Signature version.
@@ -35,7 +35,11 @@ module Slack
 
       # Request body.
       def body
-        @body ||= http_request.body.read
+        @body ||= begin
+          body = http_request.body.read
+          http_request.body.rewind
+          body
+        end
       end
 
       # Returns true if the signature coming from Slack has expired.

data/lib/slack/messages/message.rb

@@ -2,10 +2,6 @@
 module Slack
   module Messages
     class Message < Hashie::Mash
-      def presence
-        super['presence']
-      end
-
       def to_s
         keys.sort_by(&:to_s).map do |key|
           "#{key}=#{self[key]}"

data/lib/slack/real_time/client.rb

@@ -20,7 +20,6 @@ module Slack
       attr_accessor :store
       attr_accessor :url
       attr_accessor(*Config::ATTRIBUTES)
-      attr_accessor :logger
 
       protected :store_class, :store_class=
 
@@ -251,6 +250,8 @@ module Slack
       end
 
       def run_handlers(type, data)
+        return unless store.class.events
+
         handlers = store.class.events[type.to_s]
         handlers&.each do |handler|
           store.instance_exec(data, &handler)

data/lib/slack/real_time/concurrency.rb

@@ -3,8 +3,6 @@ module Slack
   module RealTime
     module Concurrency
       autoload :Async, 'slack/real_time/concurrency/async'
-      autoload :Eventmachine, 'slack/real_time/concurrency/eventmachine'
-      autoload :Celluloid, 'slack/real_time/concurrency/celluloid'
     end
   end
 end

data/lib/slack/real_time/concurrency/async.rb

@@ -114,9 +114,7 @@ module Slack
 
           def build_endpoint
             endpoint = ::Async::IO::Endpoint.tcp(addr, port)
-            if secure?
-              endpoint = ::Async::IO::SSLEndpoint.new(endpoint, ssl_context: build_ssl_context)
-            end
+            endpoint = ::Async::IO::SSLEndpoint.new(endpoint, ssl_context: build_ssl_context) if secure?
             endpoint
           end
 

data/lib/slack/real_time/config.rb

@@ -17,7 +17,8 @@ module Slack
         logger
       ].freeze
 
-      attr_accessor(*Config::ATTRIBUTES)
+      attr_accessor(*Config::ATTRIBUTES - [:concurrency])
+      attr_writer :concurrency
 
       def reset
         self.websocket_ping = 30
@@ -37,19 +38,9 @@ module Slack
       private
 
       def detect_concurrency
-        %i[Async Eventmachine Celluloid].each do |concurrency|
-          begin
-            return Slack::RealTime::Concurrency.const_get(concurrency)
-          rescue LoadError, NameError
-            false # could not be loaded, missing dependencies
-          end
-        end
-
-        raise(
-          NoConcurrencyError,
-          'Missing concurrency. Add async-websocket, faye-websocket ' \
-          'or celluloid-io to your Gemfile.'
-        )
+        Slack::RealTime::Concurrency.const_get(:Async)
+      rescue LoadError, NameError
+        raise NoConcurrencyError, 'Missing concurrency. Add async-websocket to your Gemfile.'
       end
     end
 

data/lib/slack/real_time/models/base.rb

@@ -3,10 +3,6 @@ module Slack
   module RealTime
     module Models
       class Base < Hashie::Mash
-        def presence
-          super['presence']
-        end
-
         # see https://github.com/intridea/hashie/issues/394
         def log_built_in_message(*); end
       end

data/lib/slack/real_time/socket.rb

@@ -8,9 +8,9 @@ module Slack
 
       def initialize(url, options = {})
         @url = url
-        @options = options
+        @options = options.dup
         @driver = nil
-        @logger = options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
+        @logger = @options.delete(:logger) || Slack::RealTime::Config.logger || Slack::Config.logger
         @last_message_at = nil
       end
 

data/lib/slack/real_time/stores/base.rb

@@ -4,7 +4,9 @@ module Slack
     module Stores
       # Doesn't store anything.
       class Base
-        class_attribute :events
+        class << self
+          attr_accessor :events
+        end
 
         attr_accessor :users
         attr_accessor :bots

data/lib/slack/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Slack
-  VERSION = '0.14.5'
+  VERSION = '0.17.0'
 end

data/lib/slack/web/api/endpoints.rb

@@ -1,17 +1,39 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
+require_relative 'endpoints/admin_analytics'
 require_relative 'endpoints/admin_apps'
+require_relative 'endpoints/admin_apps_approved'
 require_relative 'endpoints/admin_apps_requests'
+require_relative 'endpoints/admin_apps_restricted'
+require_relative 'endpoints/admin_barriers'
+require_relative 'endpoints/admin_conversations'
+require_relative 'endpoints/admin_conversations_ekm'
+require_relative 'endpoints/admin_conversations_restrictAccess'
+require_relative 'endpoints/admin_emoji'
+require_relative 'endpoints/admin_inviteRequests'
+require_relative 'endpoints/admin_inviteRequests_approved'
+require_relative 'endpoints/admin_inviteRequests_denied'
+require_relative 'endpoints/admin_teams'
+require_relative 'endpoints/admin_teams_admins'
+require_relative 'endpoints/admin_teams_owners'
+require_relative 'endpoints/admin_teams_settings'
+require_relative 'endpoints/admin_usergroups'
+require_relative 'endpoints/admin_users'
 require_relative 'endpoints/admin_users_session'
 require_relative 'endpoints/api'
 require_relative 'endpoints/apps'
+require_relative 'endpoints/apps_connections'
+require_relative 'endpoints/apps_event_authorizations'
 require_relative 'endpoints/apps_permissions'
 require_relative 'endpoints/apps_permissions_resources'
 require_relative 'endpoints/apps_permissions_scopes'
 require_relative 'endpoints/apps_permissions_users'
 require_relative 'endpoints/auth'
+require_relative 'endpoints/auth_teams'
 require_relative 'endpoints/bots'
+require_relative 'endpoints/calls'
+require_relative 'endpoints/calls_participants'
 require_relative 'endpoints/channels'
 require_relative 'endpoints/chat'
 require_relative 'endpoints/chat_scheduledMessages'
@@ -43,26 +65,50 @@ require_relative 'endpoints/users_admin'
 require_relative 'endpoints/users_prefs'
 require_relative 'endpoints/users_profile'
 require_relative 'endpoints/views'
+require_relative 'endpoints/workflows'
 
 module Slack
   module Web
     module Api
       module Endpoints
+        include Slack::Web::Api::Mixins::Conversations
         include Slack::Web::Api::Mixins::Channels
         include Slack::Web::Api::Mixins::Users
         include Slack::Web::Api::Mixins::Groups
 
+        include AdminAnalytics
         include AdminApps
+        include AdminAppsApproved
         include AdminAppsRequests
+        include AdminAppsRestricted
+        include AdminBarriers
+        include AdminConversations
+        include AdminConversationsEkm
+        include AdminConversationsRestrictaccess
+        include AdminEmoji
+        include AdminInviterequests
+        include AdminInviterequestsApproved
+        include AdminInviterequestsDenied
+        include AdminTeams
+        include AdminTeamsAdmins
+        include AdminTeamsOwners
+        include AdminTeamsSettings
+        include AdminUsergroups
+        include AdminUsers
         include AdminUsersSession
         include Api
         include Apps
+        include AppsConnections
+        include AppsEventAuthorizations
         include AppsPermissions
         include AppsPermissionsResources
         include AppsPermissionsScopes
         include AppsPermissionsUsers
         include Auth
+        include AuthTeams
         include Bots
+        include Calls
+        include CallsParticipants
         include Channels
         include Chat
         include ChatScheduledmessages
@@ -94,6 +140,7 @@ module Slack
         include UsersPrefs
         include UsersProfile
         include Views
+        include Workflows
       end
     end
   end