slack-ruby-client 0.11.1 → 1.1.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Models

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Models

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Models

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Models

data/lib/slack/real_time/models.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'models/base'
 require_relative 'models/user'
 require_relative 'models/bot'

data/lib/slack/real_time/socket.rb

@@ -1,25 +1,24 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     class Socket
-      attr_accessor :url
-      attr_accessor :options
+      attr_accessor :url, :options
       attr_reader :driver
-      attr_reader :logger
-      protected :logger
 
       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
 
       def send_data(message)
         logger.debug("#{self.class}##{__method__}") { message }
         case message
-        when Numeric then driver.text(message.to_s)
-        when String  then driver.text(message)
-        when Array   then driver.binary(message)
+        when Numeric then @driver.text(message.to_s)
+        when String  then @driver.text(message)
+        when Array   then @driver.binary(message)
         else false
         end
       end
@@ -28,24 +27,31 @@ module Slack
         return if connected?
 
         connect
-        logger.debug("#{self.class}##{__method__}") { driver.class }
+        logger.debug("#{self.class}##{__method__}") { @driver.class }
+
+        @driver.on :message do
+          @last_message_at = current_time
+        end
 
-        yield driver if block_given?
+        yield @driver if block_given?
       end
 
+      # Gracefully shut down the connection.
       def disconnect!
-        driver.close
+        @driver.close
+      ensure
+        close
       end
 
       def connected?
-        !driver.nil?
+        !@driver.nil?
       end
 
       def start_sync(client)
         thread = start_async(client)
-        thread.join if thread
+        thread&.join
       rescue Interrupt
-        thread.exit if thread
+        thread&.exit
       end
 
       # @return [#join]
@@ -53,12 +59,34 @@ module Slack
         raise NotImplementedError, "Expected #{self.class} to implement #{__method__}."
       end
 
+      def restart_async(_client, _url)
+        raise NotImplementedError, "Expected #{self.class} to implement #{__method__}."
+      end
+
+      def time_since_last_message
+        return 0 unless @last_message_at
+
+        current_time - @last_message_at
+      end
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+
       def close
+        # When you call `driver.emit(:close)`, it will typically end up calling `client.close`
+        # which will call `@socket.close` and end up back here. In order to break this infinite
+        # recursion, we check and set `@driver = nil` before invoking `client.close`.
+        return unless (driver = @driver)
+
         @driver = nil
+        driver.emit(:close)
       end
 
       protected
 
+      attr_reader :logger
+
       def addr
         URI(url).host
       end
@@ -69,9 +97,9 @@ module Slack
 
       def port
         case (uri = URI(url)).scheme
-        when 'wss'.freeze, 'https'.freeze
+        when 'wss', 'https'
           URI::HTTPS::DEFAULT_PORT
-        when 'ws', 'http'.freeze
+        when 'ws', 'http'
           URI::HTTP::DEFAULT_PORT
         else
           uri.port

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

@@ -1,16 +1,14 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Stores
       # Doesn't store anything.
       class Base
-        class_attribute :events
+        class << self
+          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

@@ -1,11 +1,10 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     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)
@@ -14,6 +13,31 @@ 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
+        # on :external_org_migration_started do |data|
+
+        # An enterprise grid migration has finished on an external workspace..
+        # @see https://api.slack.com/events/external_org_migration_finished
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/external_org_migration_finished.json
+        # on :external_org_migration_finished do |data|
+
+        # A private channel was deleted.
+        # @see https://api.slack.com/events/group_deleted
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/group_deleted.json
+        # on :group_deleted do |data|
+
+        # Determine the current presence status for a list of users.
+        # @see https://api.slack.com/events/presence_query
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/presence_query.json
+        # on :presence_query do |data|
+
         # The membership of an existing User Group has changed.
         # @see https://api.slack.com/events/subteam_members_changed
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/subteam_members_changed.json

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Stores
@@ -26,44 +27,59 @@ module Slack
             @users = {}
           end
 
-          if attrs.users
-            attrs.users.each do |data|
-              user = Models::User.new(data)
-              @users[data.id] = @users.key?(data.id) ? @users[data.id].merge(user) : user
-            end
+          attrs.users&.each do |data|
+            user = Models::User.new(data)
+            @users[data.id] = @users.key?(data.id) ? @users[data.id].merge(user) : user
           end
 
           @channels = {}
-          if attrs.channels
-            attrs.channels.each do |data|
-              @channels[data.id] = Models::Channel.new(data)
-            end
+          attrs.channels&.each do |data|
+            @channels[data.id] = Models::Channel.new(data)
           end
 
           @bots = {}
-          if attrs.bots
-            attrs.bots.each do |data|
-              @bots[data.id] = Models::Bot.new(data)
-            end
+          attrs.bots&.each do |data|
+            @bots[data.id] = Models::Bot.new(data)
           end
 
           @groups = {}
-          if attrs.groups
-            attrs.groups.each do |data|
-              @groups[data.id] = Models::Group.new(data)
-            end
+          attrs.groups&.each do |data|
+            @groups[data.id] = Models::Group.new(data)
           end
 
           @ims = {}
-          if attrs.ims
-            attrs.ims.each do |data|
-              @ims[data.id] = Models::Im.new(data)
-            end
+          attrs.ims&.each do |data|
+            @ims[data.id] = Models::Im.new(data)
           end
         end
 
         ### 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
+        # on :external_org_migration_started do |data|
+
+        # An enterprise grid migration has finished on an external workspace..
+        # @see https://api.slack.com/events/external_org_migration_finished
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/external_org_migration_finished.json
+        # on :external_org_migration_finished do |data|
+
+        # A private channel was deleted.
+        # @see https://api.slack.com/events/group_deleted
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/group_deleted.json
+        # on :group_deleted do |data|
+
+        # Determine the current presence status for a list of users.
+        # @see https://api.slack.com/events/presence_query
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/presence_query.json
+        # on :presence_query do |data|
+
         # The membership of an existing User Group has changed.
         # @see https://api.slack.com/events/subteam_members_changed
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/subteam_members_changed.json
@@ -141,7 +157,7 @@ module Slack
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/bot_changed.json
         on :bot_changed do |data|
           bot = bots[data.bot.id]
-          bot.merge!(data.bot) if bot
+          bot&.merge!(data.bot)
         end
 
         # A team channel was archived.
@@ -323,7 +339,7 @@ module Slack
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/group_left.json
         on :group_left do |data|
           channel = groups[data.channel]
-          channel.members.delete(self.self.id) if channel && channel.key?(:members)
+          channel.members.delete(self.self.id) if channel&.key?(:members)
         end
 
         # A private group read marker was updated.
@@ -358,7 +374,8 @@ module Slack
         # @see https://api.slack.com/events/im_close
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/im_close.json
         on :im_close do |data|
-          return unless ims && ims.key?(data.channel)
+          return unless ims&.key?(data.channel)
+
           ims[data.channel].is_open = false
         end
 
@@ -383,7 +400,8 @@ module Slack
         # @see https://api.slack.com/events/im_open
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/im_open.json
         on :im_open do |data|
-          return unless ims && ims.key?(data.channel)
+          return unless ims&.key?(data.channel)
+
           ims[data.channel].is_open = true
         end
 

data/lib/slack/real_time/stores.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'stores/base'
 require_relative 'stores/starter'
 require_relative 'stores/store'

data/lib/slack/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
-  VERSION = '0.11.1'.freeze
+  VERSION = '1.1.0'
 end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAnalytics
+          #
+          # Retrieve analytics data for a given date, presented as a compressed JSON file
+          #
+          # @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 = {})
+            throw ArgumentError.new('Required arguments :type missing') if options[:type].nil?
+            post('admin.analytics.getFile', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminApps
+          #
+          # Approve an app for installation on a workspace.
+          #
+          # @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 [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.
+          # @see https://api.slack.com/methods/admin.apps.approve
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.approve.json
+          def admin_apps_approve(options = {})
+            post('admin.apps.approve', options)
+          end
+
+          #
+          # Clear an app resolution
+          #
+          # @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.
+          # @option options [Object] :team_id
+          #   The workspace to clear the app resolution from.
+          # @see https://api.slack.com/methods/admin.apps.clearResolution
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.clearResolution.json
+          def admin_apps_clearResolution(options = {})
+            throw ArgumentError.new('Required arguments :app_id missing') if options[:app_id].nil?
+            post('admin.apps.clearResolution', options)
+          end
+
+          #
+          # Restrict an app for installation on a workspace.
+          #
+          # @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 [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.
+          # @see https://api.slack.com/methods/admin.apps.restrict
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps/admin.apps.restrict.json
+          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
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsApproved
+          #
+          # List approved apps for an org or workspace.
+          #
+          # @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 [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.approved.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.approved/admin.apps.approved.list.json
+          def admin_apps_approved_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_approved_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.approved.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    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 [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 [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.requests.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.requests/admin.apps.requests.list.json
+          def admin_apps_requests_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_requests_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.requests.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AdminAppsRestricted
+          #
+          # List restricted apps for an org or workspace.
+          #
+          # @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 [integer] :limit
+          #   The maximum number of items to return. Must be between 1 - 1000 both inclusive.
+          # @option options [Object] :team_id
+          #   .
+          # @see https://api.slack.com/methods/admin.apps.restricted.list
+          # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/admin.apps.restricted/admin.apps.restricted.list.json
+          def admin_apps_restricted_list(options = {})
+            if block_given?
+              Pagination::Cursor.new(self, :admin_apps_restricted_list, options).each do |page|
+                yield page
+              end
+            else
+              post('admin.apps.restricted.list', options)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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