slack-ruby-client 0.14.3 → 0.15.1

data/bin/commands/users_prefs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'UsersPrefs methods.'

data/bin/commands/users_profile.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'UsersProfile methods.'
 command 'users_profile' do |g|
-  g.desc "Use this method to retrieve a user's profile information."
-  g.long_desc %( Use this method to retrieve a user's profile information. )
+  g.desc "Retrieves a user's profile information."
+  g.long_desc %( Retrieves a user's profile information. )
   g.command 'get' do |c|
     c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
     c.flag 'user', desc: 'User to retrieve profile info for.'
@@ -12,8 +13,8 @@ command 'users_profile' do |g|
     end
   end
 
-  g.desc "Use this method to set a user's profile information, including name, email, current status, and other attributes."
-  g.long_desc %( Use this method to set a user's profile information, including name, email, current status, and other attributes. )
+  g.desc 'Set the profile information for a user.'
+  g.long_desc %( Set the profile information for a user. )
   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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Views methods.'
+command 'views' do |g|
+  g.desc 'Open a view for a user.'
+  g.long_desc %( Open a view for a user. )
+  g.command 'open' do |c|
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.flag 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.views_open(options))
+    end
+  end
+
+  g.desc 'Publish a static view for a User.'
+  g.long_desc %( Publish a static view for a User. )
+  g.command 'publish' do |c|
+    c.flag 'user_id', desc: 'id of the user you want publish a view to.'
+    c.flag 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    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_publish(options))
+    end
+  end
+
+  g.desc 'Push a view onto the stack of a root view.'
+  g.long_desc %( Push a view onto the stack of a root view. )
+  g.command 'push' do |c|
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.flag 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.views_push(options))
+    end
+  end
+
+  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 '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.action do |_global_options, options, _args|
+      puts JSON.dump($client.views_update(options))
+    end
+  end
+end

data/bin/slack

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-
 require 'gli'
-require 'slack-ruby-client'
+require 'slack_ruby_client'
 
 include GLI::App
 

data/examples/hi_real_time/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|
@@ -10,7 +11,10 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+  puts(
+    "Successfully connected, welcome '#{client.self.name}' to " \
+    "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+  )
 end
 
 client.on :message do |data|
@@ -19,9 +23,9 @@ client.on :message do |data|
   client.typing channel: data.channel
 
   case data.text
-  when 'bot hi' then
+  when 'bot hi'
     client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-  when /^bot/ then
+  when /^bot/
     client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end

data/examples/hi_real_time_and_web/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_and_web/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|
@@ -8,15 +9,18 @@ end
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+  puts(
+    "Successfully connected, welcome '#{client.self.name}' " \
+    "to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+  )
 end
 
 client.on :message do |data|
   puts data
   case data.text
-  when 'bot hi' then
+  when 'bot hi'
     client.web_client.chat_postMessage channel: data.channel, text: "Hi <@#{data.user}>!"
-  when /^bot/ then
+  when /^bot/
     client.web_client.chat_postMessage channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end

data/examples/hi_real_time_async_async/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_async_async/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 require 'async'
 
@@ -15,7 +16,10 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
   client = Slack::RealTime::Client.new(token: token)
 
   client.on :hello do
-    logger.info "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+    logger.info(
+      "Successfully connected, welcome '#{client.self.name}' to " \
+      "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+    )
   end
 
   client.on :message do |data|
@@ -24,7 +28,7 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     client.typing channel: data.channel
 
     case data.text
-    when /hi/ then
+    when /hi/
       client.message channel: data.channel, text: "Hi <@#{data.user}>!"
     else
       client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"

data/examples/hi_real_time_async_celluloid/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_async_celluloid/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
@@ -13,7 +14,10 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
   client = Slack::RealTime::Client.new(token: token)
 
   client.on :hello do
-    logger.info "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+    logger.info(
+      "Successfully connected, welcome '#{client.self.name}' to " \
+      "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+    )
   end
 
   client.on :message do |data|
@@ -22,9 +26,9 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     client.typing channel: data.channel
 
     case data.text
-    when 'bot hi' then
+    when 'bot hi'
       client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    when /^bot/ then
+    when /^bot/
       client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
     end
   end

data/examples/hi_real_time_async_eventmachine/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_async_eventmachine/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
@@ -13,7 +14,10 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
   client = Slack::RealTime::Client.new(token: token)
 
   client.on :hello do
-    logger.info "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+    logger.info(
+      "Successfully connected, welcome '#{client.self.name}' to " \
+      "the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
+    )
   end
 
   client.on :message do |data|
@@ -22,9 +26,9 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     client.typing channel: data.channel
 
     case data.text
-    when 'bot hi' then
+    when 'bot hi'
       client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    when /^bot/ then
+    when /^bot/
       client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
     end
   end

data/examples/hi_web/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_web/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|

data/examples/new_ticket/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/new_ticket/new_ticket.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|

data/lib/slack-ruby-client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'slack/version'
 require_relative 'slack/logger'
 require_relative 'slack/config'
@@ -14,18 +15,19 @@ require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # ignore, only used in users_search
 end
 begin
   require 'openssl'
-rescue LoadError
+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/faraday/response/raise_error'
 require_relative 'slack/web/faraday/connection'
 require_relative 'slack/web/faraday/request'
@@ -35,8 +37,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.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'

data/lib/slack/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Config
     extend self

data/lib/slack/events/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Events
     module Config

data/lib/slack/events/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Events
     class Request
@@ -12,7 +13,8 @@ module Slack
       def initialize(http_request, options = {})
         @http_request = http_request
         @signing_secret = options[:signing_secret] || Slack::Events.config.signing_secret
-        @signature_expires_in = options[:signature_expires_in] || Slack::Events.config.signature_expires_in
+        @signature_expires_in =
+          options[:signature_expires_in] || Slack::Events.config.signature_expires_in
       end
 
       # Request timestamp.

data/lib/slack/logger.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
 require 'logger'
 
 module Slack
   class Logger < ::Logger
     def self.default
-      @logger ||= begin
-        logger = new STDOUT
-        logger.level = Logger::WARN
-        logger
-      end
+      return @default if @default
+
+      logger = new STDOUT
+      logger.level = Logger::WARN
+      @default = logger
     end
   end
 end

data/lib/slack/messages/formatting.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module Messages
     module Formatting

data/lib/slack/messages/message.rb

@@ -1,10 +1,7 @@
+# frozen_string_literal: true
 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/api/message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Api
@@ -6,7 +7,8 @@ module Slack
         # Sends a message to a channel.
         #
         # @option options [channel] :channel
-        #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+        #   Channel to send message to. Can be a public channel, private group or IM channel.
+        #   Can be an encoded ID, or a name.
         # @option options [Object] :text
         #   Text of the message to send. See below for an explanation of formatting.
         def message(options = {})

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

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

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

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

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

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

data/lib/slack/real_time/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     class Client
@@ -19,8 +20,8 @@ module Slack
       attr_accessor :store
       attr_accessor :url
       attr_accessor(*Config::ATTRIBUTES)
+      attr_accessor :logger
 
-      protected :logger, :logger=
       protected :store_class, :store_class=
 
       def initialize(options = {})
@@ -35,7 +36,7 @@ module Slack
 
       %i[users self channels team teams groups ims bots].each do |store_method|
         define_method store_method do
-          store.send(store_method) if store
+          store&.send(store_method)
         end
       end
 
@@ -62,11 +63,11 @@ module Slack
       def stop!
         raise ClientNotStartedError unless started?
 
-        @socket.disconnect! if @socket
+        @socket&.disconnect!
       end
 
       def started?
-        @socket && @socket.connected?
+        @socket&.connected?
       end
 
       class << self
@@ -83,7 +84,7 @@ module Slack
         @socket.connect! do |driver|
           driver.on :open do |event|
             logger.debug("#{self}##{__method__}") { event.class.name }
-            open(event)
+            open_event(event)
             callback(event, :open)
           end
 
@@ -100,7 +101,7 @@ module Slack
           end
 
           # This must be called last to ensure any events are registered before invoking user code.
-          @callback.call(driver) if @callback
+          @callback&.call(driver)
         end
       end
 
@@ -130,17 +131,29 @@ module Slack
         logger.warn(to_s) { 'is offline' }
 
         restart_async
+      rescue Slack::Web::Api::Errors::SlackError => e
+        # stop pinging if bot was uninstalled
+        case e.message
+        when 'account_inactive', 'invalid_auth' then
+          logger.warn(to_s) { e.message }
+          raise e
+        end
+        logger.debug("#{self}##{__method__}") { e }
       rescue StandardError => e
         # disregard all ping worker failures, keep pinging
         logger.debug("#{self}##{__method__}") { e }
       end
 
       def run_ping?
-        !websocket_ping.nil? && websocket_ping > 0
+        !websocket_ping.nil? && websocket_ping.positive?
+      end
+
+      def websocket_ping_timer
+        websocket_ping / 2
       end
 
       def to_s
-        if store && store.team
+        if store&.team
           "id=#{store.team.id}, name=#{store.team.name}, domain=#{store.team.domain}"
         else
           super
@@ -200,7 +213,7 @@ module Slack
         @socket.send_data(data.to_json)
       end
 
-      def open(_event); end
+      def open_event(_event); end
 
       def close(_event)
         [@socket, socket_class].each do |s|
@@ -238,11 +251,11 @@ module Slack
       end
 
       def run_handlers(type, data)
+        return unless store.class.events
+
         handlers = store.class.events[type.to_s]
-        if handlers
-          handlers.each do |handler|
-            store.instance_exec(data, &handler)
-          end
+        handlers&.each do |handler|
+          store.instance_exec(data, &handler)
         end
       rescue StandardError => e
         logger.error("#{self}##{__method__}") { e }