slack-ruby-client 0.13.0 → 0.17.0

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/socket.rb

@@ -1,25 +1,25 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     class Socket
       attr_accessor :url
       attr_accessor :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 +28,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 +60,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 +98,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.rb

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

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

@@ -1,9 +1,12 @@
+# 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

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Stores
@@ -14,6 +15,16 @@ module Slack
 
         ### RealTime Events
 
+        # 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

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,44 @@ 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
 
+        # 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
@@ -151,7 +152,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.
@@ -333,7 +334,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.
@@ -368,7 +369,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
 
@@ -393,7 +395,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/version.rb

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

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

@@ -1,25 +1,55 @@
+# 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'
 require_relative 'endpoints/conversations'
 require_relative 'endpoints/dialog'
 require_relative 'endpoints/dnd'
 require_relative 'endpoints/emoji'
 require_relative 'endpoints/files'
 require_relative 'endpoints/files_comments'
+require_relative 'endpoints/files_remote'
 require_relative 'endpoints/groups'
 require_relative 'endpoints/im'
 require_relative 'endpoints/migration'
 require_relative 'endpoints/mpim'
 require_relative 'endpoints/oauth'
+require_relative 'endpoints/oauth_v2'
 require_relative 'endpoints/pins'
 require_relative 'endpoints/reactions'
 require_relative 'endpoints/reminders'
@@ -34,35 +64,67 @@ require_relative 'endpoints/users'
 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
         include Conversations
         include Dialog
         include Dnd
         include Emoji
         include Files
         include FilesComments
+        include FilesRemote
         include Groups
         include Im
         include Migration
         include Mpim
         include Oauth
+        include OauthV2
         include Pins
         include Reactions
         include Reminders
@@ -77,6 +139,8 @@ module Slack
         include UsersAdmin
         include UsersPrefs
         include UsersProfile
+        include Views
+        include Workflows
       end
     end
   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 [Object] :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 [Object] :date
+          #   Date to retrieve the analytics data for, expressed as YYYY-MM-DD in UTC.
+          # @option options [Object] :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