slack-ruby-client 0.16.0 → 1.1.0

data/bin/commands/stars.rb

@@ -3,8 +3,8 @@
 
 desc 'Stars methods.'
 command 'stars' do |g|
-  g.desc 'Adds a star to an item.'
-  g.long_desc %( Adds a star to an item. )
+  g.desc 'Save an item for later. Formerly known as _adding a star_.'
+  g.long_desc %( Save an item for later. Formerly known as _adding a star_. )
   g.command 'add' do |c|
     c.flag 'channel', desc: 'Channel to add star to, or channel where the message to add star to was posted (used with timestamp).'
     c.flag 'file', desc: 'File to add star to.'
@@ -15,18 +15,19 @@ command 'stars' do |g|
     end
   end
 
-  g.desc 'Lists stars for a user.'
-  g.long_desc %( Lists stars for a user. )
+  g.desc "List a user's saved items, formerly known as _stars_."
+  g.long_desc %( List a user's saved items, formerly known as _stars_. )
   g.command 'list' do |c|
     c.flag 'cursor', desc: "Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first 'page' of the collection. See pagination for more details."
     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."
+    c.flag 'team_id', desc: 'encoded team id to list stars in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.stars_list(options))
     end
   end
 
-  g.desc 'Removes a star from an item.'
-  g.long_desc %( Removes a star from an item. )
+  g.desc 'Removes a saved item (star) from an item.'
+  g.long_desc %( Removes a saved item (star) from an item. )
   g.command 'remove' do |c|
     c.flag 'channel', desc: 'Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).'
     c.flag 'file', desc: 'File to remove star from.'

data/bin/commands/team.rb

@@ -26,6 +26,7 @@ command 'team' do |g|
   g.desc 'Gets information about the current team.'
   g.long_desc %( Gets information about the current team. )
   g.command 'info' do |c|
+    c.flag 'domain', desc: 'Query by domain instead of team (only when team is null). This only works for domains in the same enterprise as the querying team token. This also expects the domain to belong to a team and not the enterprise itself.'
     c.flag 'team', desc: 'Team to get info on, if omitted, will return information about the current team. Will only return team that the authenticated token is allowed to see through external shared channels.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.team_info(options))

data/bin/commands/team_billing.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'TeamBilling methods.'
+command 'team_billing' do |g|
+  g.desc "Reads a workspace's billing plan information."
+  g.long_desc %( Reads a workspace's billing plan information. )
+  g.command 'info' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_billing_info(options))
+    end
+  end
+end

data/bin/commands/team_preferences.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'TeamPreferences methods.'
+command 'team_preferences' do |g|
+  g.desc "Retrieve a list of a workspace's team preferences."
+  g.long_desc %( Retrieve a list of a workspace's team preferences. )
+  g.command 'list' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.team_preferences_list(options))
+    end
+  end
+end

data/bin/commands/tooling_tokens.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'ToolingTokens methods.'
+command 'tooling_tokens' do |g|
+  g.desc 'Exchanges a refresh token for a new app configuration token.'
+  g.long_desc %( Exchanges a refresh token for a new app configuration token. )
+  g.command 'rotate' do |c|
+    c.flag 'refresh_token', desc: 'The xoxe refresh token that was issued along with the old app configuration token.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.tooling_tokens_rotate(options))
+    end
+  end
+end

data/bin/commands/usergroups.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc "Get info on your team's User Groups."
+desc 'Usergroups methods.'
 command 'usergroups' do |g|
   g.desc 'Create a User Group'
   g.long_desc %( Create a User Group )

data/bin/commands/users.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Get info on members of your Slack team.'
+desc 'Users methods.'
 command 'users' do |g|
   g.desc 'List conversations the calling user may access.'
   g.long_desc %( List conversations the calling user may access. )

data/bin/commands/views.rb

@@ -39,8 +39,8 @@ command 'views' do |g|
   g.command 'update' do |c|
     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.'
+    c.flag 'hash', desc: 'A string that represents view state to protect against possible race conditions.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.views_update(options))
     end

data/bin/commands.rb

@@ -6,11 +6,11 @@ require 'commands/admin_apps'
 require 'commands/admin_apps_approved'
 require 'commands/admin_apps_requests'
 require 'commands/admin_apps_restricted'
+require 'commands/admin_auth_policy'
 require 'commands/admin_barriers'
 require 'commands/admin_conversations'
 require 'commands/admin_conversations_ekm'
 require 'commands/admin_conversations_restrictAccess'
-require 'commands/admin_conversations_whitelist'
 require 'commands/admin_emoji'
 require 'commands/admin_inviteRequests'
 require 'commands/admin_inviteRequests_approved'
@@ -22,20 +22,18 @@ require 'commands/admin_teams_settings'
 require 'commands/admin_usergroups'
 require 'commands/admin_users'
 require 'commands/admin_users_session'
+require 'commands/admin_users_unsupportedVersions'
 require 'commands/api'
 require 'commands/apps'
 require 'commands/apps_connections'
 require 'commands/apps_event_authorizations'
-require 'commands/apps_permissions'
-require 'commands/apps_permissions_resources'
-require 'commands/apps_permissions_scopes'
-require 'commands/apps_permissions_users'
+require 'commands/apps_manifest'
 require 'commands/auth'
 require 'commands/auth_teams'
+require 'commands/bookmarks'
 require 'commands/bots'
 require 'commands/calls'
 require 'commands/calls_participants'
-require 'commands/channels'
 require 'commands/chat'
 require 'commands/chat_scheduledMessages'
 require 'commands/conversations'
@@ -45,12 +43,10 @@ require 'commands/emoji'
 require 'commands/files'
 require 'commands/files_comments'
 require 'commands/files_remote'
-require 'commands/groups'
-require 'commands/im'
 require 'commands/migration'
-require 'commands/mpim'
 require 'commands/oauth'
 require 'commands/oauth_v2'
+require 'commands/openid_connect'
 require 'commands/pins'
 require 'commands/reactions'
 require 'commands/reminders'
@@ -58,7 +54,10 @@ require 'commands/rtm'
 require 'commands/search'
 require 'commands/stars'
 require 'commands/team'
+require 'commands/team_billing'
+require 'commands/team_preferences'
 require 'commands/team_profile'
+require 'commands/tooling_tokens'
 require 'commands/usergroups'
 require 'commands/usergroups_users'
 require 'commands/users'

data/lib/slack/config.rb

@@ -3,8 +3,7 @@ module Slack
   module Config
     extend self
 
-    attr_accessor :token
-    attr_accessor :logger
+    attr_accessor :token, :logger
 
     def reset
       self.token = nil

data/lib/slack/events/request.rb

@@ -3,7 +3,9 @@ module Slack
   module Events
     class Request
       class MissingSigningSecret < StandardError; end
+
       class TimestampExpired < StandardError; end
+
       class InvalidSignature < StandardError; end
 
       attr_reader :http_request,
@@ -19,13 +21,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.
@@ -51,7 +53,7 @@ module Slack
       def valid?
         raise MissingSigningSecret unless signing_secret
 
-        digest = OpenSSL::Digest::SHA256.new
+        digest = OpenSSL::Digest.new('SHA256')
         signature_basestring = [version, timestamp, body].join(':')
         hex_hash = OpenSSL::HMAC.hexdigest(digest, signing_secret, signature_basestring)
         computed_signature = [version, hex_hash].join('=')

data/lib/slack/real_time/client.rb

@@ -3,6 +3,7 @@ module Slack
   module RealTime
     class Client
       class ClientNotStartedError < StandardError; end
+
       class ClientAlreadyStartedError < StandardError; end
 
       include Api::MessageId
@@ -16,10 +17,7 @@ module Slack
         attr_accessor :events
       end
 
-      attr_accessor :web_client
-      attr_accessor :store
-      attr_accessor :url
-      attr_accessor(*Config::ATTRIBUTES)
+      attr_accessor :web_client, :store, :url, *Config::ATTRIBUTES
 
       protected :store_class, :store_class=
 
@@ -46,7 +44,7 @@ module Slack
 
       # Start RealTime client and block until it disconnects.
       def start!(&block)
-        @callback = block if block_given?
+        @callback = block if block
         build_socket
         @socket.start_sync(self)
       end
@@ -54,7 +52,7 @@ module Slack
       # Start RealTime client and return immediately.
       # The RealTime::Client will run in the background.
       def start_async(&block)
-        @callback = block if block_given?
+        @callback = block if block
         build_socket
         @socket.start_async(self)
       end
@@ -133,7 +131,7 @@ module Slack
       rescue Slack::Web::Api::Errors::SlackError => e
         # stop pinging if bot was uninstalled
         case e.message
-        when 'account_inactive', 'invalid_auth' then
+        when 'account_inactive', 'invalid_auth'
           logger.warn(to_s) { e.message }
           raise e
         end
@@ -201,6 +199,7 @@ module Slack
       end
 
       attr_reader :callbacks
+
       def socket_class
         concurrency::Socket
       end

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

@@ -45,14 +45,12 @@ module Slack
                 @client_task&.stop
 
                 @client_task = task.async do |subtask|
-                  begin
-                    subtask.annotate "#{client} run-loop"
-                    client.run_loop
-                  rescue ::Async::Wrapper::Cancelled => e
-                    # Will get restarted by ping worker.
-                  rescue StandardError => e
-                    client.logger.error(subtask.to_s) { e.message }
-                  end
+                  subtask.annotate "#{client} run-loop"
+                  client.run_loop
+                rescue ::Async::Wrapper::Cancelled => e
+                # Will get restarted by ping worker.
+                rescue StandardError => e
+                  client.logger.error(subtask.to_s) { e.message }
                 end
 
                 @restart.wait

data/lib/slack/real_time/config.rb

@@ -38,19 +38,9 @@ module Slack
       private
 
       def detect_concurrency
-        %i[Async].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 or faye-websocket ' \
-          '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/socket.rb

@@ -2,8 +2,7 @@
 module Slack
   module RealTime
     class Socket
-      attr_accessor :url
-      attr_accessor :options
+      attr_accessor :url, :options
       attr_reader :driver
 
       def initialize(url, options = {})

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

@@ -8,12 +8,7 @@ module Slack
           attr_accessor :events
         end
 
-        attr_accessor :users
-        attr_accessor :bots
-        attr_accessor :channels
-        attr_accessor :groups
-        attr_accessor :teams
-        attr_accessor :ims
+        attr_accessor :users, :bots, :channels, :groups, :teams, :ims
 
         def self
           nil

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

@@ -4,9 +4,7 @@ module Slack
     module Stores
       # Only stores initial information.
       class Starter < Base
-        attr_reader :self
-
-        attr_reader :team
+        attr_reader :self, :team
 
         def initialize(attrs)
           @team = Models::Team.new(attrs.team)
@@ -15,6 +13,11 @@ module Slack
 
         ### RealTime Events
 
+        # A shared channel invite was sent to a Slack user.
+        # @see https://api.slack.com/events/shared_channel_invite_received
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/shared_channel_invite_received.json
+        # on :shared_channel_invite_received do |data|
+
         # An enterprise grid migration has started on an external workspace..
         # @see https://api.slack.com/events/external_org_migration_started
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/external_org_migration_started.json

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

@@ -55,6 +55,11 @@ module Slack
 
         ### RealTime Events
 
+        # A shared channel invite was sent to a Slack user.
+        # @see https://api.slack.com/events/shared_channel_invite_received
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/shared_channel_invite_received.json
+        # on :shared_channel_invite_received do |data|
+
         # An enterprise grid migration has started on an external workspace..
         # @see https://api.slack.com/events/external_org_migration_started
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/external_org_migration_started.json

data/lib/slack/version.rb

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

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

@@ -9,10 +9,12 @@ module Slack
           #
           # Retrieve analytics data for a given date, presented as a compressed JSON file
           #
-          # @option options [Object] :type
-          #   The type of analytics to retrieve. The options are currently limited to member.
-          # @option options [Object] :date
+          # @option options [string] :type
+          #   The type of analytics to retrieve. The options are currently limited to member (for grid member analytics) and public_channel (for public channel analytics).
+          # @option options [date] :date
           #   Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.
+          # @option options [boolean] :metadata_only
+          #   Retrieve metadata for the type of analytics indicated. Can be used only with type set to public_channel analytics. See detail below. Omit the date parameter when using this argument.
           # @see https://api.slack.com/methods/admin.analytics.getFile
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.analytics/admin.analytics.getFile.json
           def admin_analytics_getFile(options = {})

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

@@ -9,11 +9,11 @@ module Slack
           #
           # Approve an app for installation on a workspace.
           #
-          # @option options [Object] :app_id
+          # @option options [string] :app_id
           #   The id of the app to approve.
           # @option options [Object] :enterprise_id
           #   The ID of the enterprise to approve the app on.
-          # @option options [Object] :request_id
+          # @option options [string] :request_id
           #   The id of the request to approve.
           # @option options [Object] :team_id
           #   The ID of the workspace to approve the app on.
@@ -26,7 +26,7 @@ module Slack
           #
           # Clear an app resolution
           #
-          # @option options [Object] :app_id
+          # @option options [string] :app_id
           #   The id of the app whose resolution you want to clear/undo.
           # @option options [Object] :enterprise_id
           #   The enterprise to clear the app resolution from.
@@ -42,11 +42,11 @@ module Slack
           #
           # Restrict an app for installation on a workspace.
           #
-          # @option options [Object] :app_id
+          # @option options [string] :app_id
           #   The id of the app to restrict.
           # @option options [Object] :enterprise_id
           #   The ID of the enterprise to approve the app on.
-          # @option options [Object] :request_id
+          # @option options [string] :request_id
           #   The id of the request to restrict.
           # @option options [Object] :team_id
           #   The ID of the workspace to approve the app on.
@@ -55,6 +55,22 @@ module Slack
           def admin_apps_restrict(options = {})
             post('admin.apps.restrict', options)
           end
+
+          #
+          # Uninstall an app from one or many workspaces, or an entire enterprise organization.
+          #
+          # @option options [string] :app_id
+          #   The ID of the app to uninstall.
+          # @option options [string] :enterprise_id
+          #   The enterprise to completely uninstall the application from (across all workspaces). With an org-level token, this or team_ids is required.
+          # @option options [string] :team_ids
+          #   IDs of the teams to uninstall from (max 100). With an org-level token, this or enterprise_id is required.
+          # @see https://api.slack.com/methods/admin.apps.uninstall
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.uninstall.json
+          def admin_apps_uninstall(options = {})
+            throw ArgumentError.new('Required arguments :app_id missing') if options[:app_id].nil?
+            post('admin.apps.uninstall', options)
+          end
         end
       end
     end

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

@@ -9,11 +9,11 @@ module Slack
           #
           # List approved apps for an org or workspace.
           #
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [Object] :enterprise_id
           #   .
-          # @option options [Object] :limit
+          # @option options [integer] :limit
           #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
           # @option options [Object] :team_id
           #   .

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

@@ -6,12 +6,30 @@ module Slack
     module Api
       module Endpoints
         module AdminAppsRequests
+          #
+          # Cancel approval request for team
+          #
+          # @option options [string] :request_id
+          #   The id of the request to cancel.
+          # @option options [Object] :enterprise_id
+          #   The ID of the enterprise where this request belongs.
+          # @option options [Object] :team_id
+          #   The ID of the workspace where this request belongs.
+          # @see https://api.slack.com/methods/admin.apps.requests.cancel
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.requests/admin.apps.requests.cancel.json
+          def admin_apps_requests_cancel(options = {})
+            throw ArgumentError.new('Required arguments :request_id missing') if options[:request_id].nil?
+            post('admin.apps.requests.cancel', options)
+          end
+
           #
           # List app requests for a team/workspace.
           #
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
-          # @option options [Object] :limit
+          # @option options [Object] :enterprise_id
+          #   .
+          # @option options [integer] :limit
           #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
           # @option options [Object] :team_id
           #   .

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

@@ -9,11 +9,11 @@ module Slack
           #
           # List restricted apps for an org or workspace.
           #
-          # @option options [Object] :cursor
+          # @option options [string] :cursor
           #   Set cursor to next_cursor returned by the previous call to list items in the next page.
           # @option options [Object] :enterprise_id
           #   .
-          # @option options [Object] :limit
+          # @option options [integer] :limit
           #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
           # @option options [Object] :team_id
           #   .

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAuthPolicy
+          #
+          # Assign entities to a particular authentication policy.
+          #
+          # @option options [array] :entity_ids
+          #   Array of IDs to assign to the policy.
+          # @option options [Object] :entity_type
+          #   The type of entity to assign to the policy. Currently, USER is supported.
+          # @option options [string] :policy_name
+          #   The name of the authentication policy to assign the entities to. Currently, email_password is the only policy that may be used with this method.
+          # @see https://api.slack.com/methods/admin.auth.policy.assignEntities
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.auth.policy/admin.auth.policy.assignEntities.json
+          def admin_auth_policy_assignEntities(options = {})
+            throw ArgumentError.new('Required arguments :entity_ids missing') if options[:entity_ids].nil?
+            throw ArgumentError.new('Required arguments :entity_type missing') if options[:entity_type].nil?
+            throw ArgumentError.new('Required arguments :policy_name missing') if options[:policy_name].nil?
+            post('admin.auth.policy.assignEntities', options)
+          end
+
+          #
+          # Fetch all the entities assigned to a particular authentication policy by name.
+          #
+          # @option options [string] :policy_name
+          #   The name of the policy to fetch entities for. Currently, email_password is the only policy that may be used with this method.
+          # @option options [string] :cursor
+          #   Set cursor to next_cursor returned by the previous call to list items in the next page.
+          # @option options [Object] :entity_type
+          #   The type of entity to assign to the policy. Currently, USER is supported.
+          # @option options [integer] :limit
+          #   The maximum number of items to return. Must be between 1 and 1000, both inclusive.
+          # @see https://api.slack.com/methods/admin.auth.policy.getEntities
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.auth.policy/admin.auth.policy.getEntities.json
+          def admin_auth_policy_getEntities(options = {})
+            throw ArgumentError.new('Required arguments :policy_name missing') if options[:policy_name].nil?
+            if block_given?
+              Pagination::Cursor.new(self, :admin_auth_policy_getEntities, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.auth.policy.getEntities', options)
+            end
+          end
+
+          #
+          # Remove specified entities from a specified authentication policy.
+          #
+          # @option options [array] :entity_ids
+          #   Encoded IDs of the entities you'd like to remove from the policy.
+          # @option options [Object] :entity_type
+          #   The type of entity to assign to the policy. Currently, USER is supported.
+          # @option options [string] :policy_name
+          #   The name of the policy to remove entities from. Currently, email_password is the only policy that may be used with this method.
+          # @see https://api.slack.com/methods/admin.auth.policy.removeEntities
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.auth.policy/admin.auth.policy.removeEntities.json
+          def admin_auth_policy_removeEntities(options = {})
+            throw ArgumentError.new('Required arguments :entity_ids missing') if options[:entity_ids].nil?
+            throw ArgumentError.new('Required arguments :entity_type missing') if options[:entity_type].nil?
+            throw ArgumentError.new('Required arguments :policy_name missing') if options[:policy_name].nil?
+            post('admin.auth.policy.removeEntities', options)
+          end
+        end
+      end
+    end
+  end
+end