slack-ruby-client 0.11.0 → 2.7.0

data/bin/slack

@@ -1,52 +1,56 @@
 #!/usr/bin/env ruby
-
 require 'gli'
-require 'slack-ruby-client'
-
-include GLI::App
-
-program_desc 'Slack client.'
-
-default_command :help
-
-switch %i[d debug], desc: 'Enable debug-level logging.', default_value: false
-flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
-flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
-
-pre do |global_options, _command, options, _args|
-  # global Slack configuration
-  Slack.config.token = global_options['slack-api-token']
-  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
-
-  if global_options['debug']
-    require 'logger'
-    logger = Logger.new(STDOUT)
-    logger.level = Logger::DEBUG
-    Slack::Web::Client.config.logger = logger
-  end
-
-  $client = Slack::Web::Client.new
-
-  # Offline VCR cassette
-  if global_options['vcr-cassette-name']
-    require 'webmock'
-    WebMock.enable!
-    require 'vcr'
-    VCR.configure do |config|
-      config.cassette_library_dir = 'spec/fixtures/slack'
-      config.hook_into :webmock
-      config.default_cassette_options = { record: :new_episodes }
+require 'slack_ruby_client'
+
+module Slack
+  module Cli
+    class App
+      extend GLI::App
+
+      program_desc 'Slack client.'
+
+      default_command :help
+
+      switch %i[d debug], desc: 'Enable debug-level logging.', default_value: false
+      flag [:t, 'slack-api-token'], desc: 'Slack API token.', default_value: ENV['SLACK_API_TOKEN']
+      flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
+
+      commands_from File.expand_path('commands', __dir__)
+
+      pre do |global_options, _command, options, _args|
+        # global Slack configuration
+        Slack.config.token = global_options['slack-api-token']
+        help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
+
+        if global_options['debug']
+          require 'logger'
+          logger = Logger.new(STDOUT)
+          logger.level = Logger::DEBUG
+          Slack::Web::Client.config.logger = logger
+        end
+
+        @client = Slack::Web::Client.new
+
+        # Offline VCR cassette
+        if global_options['vcr-cassette-name']
+          require 'webmock'
+          WebMock.enable!
+          require 'vcr'
+          VCR.configure do |config|
+            config.cassette_library_dir = 'spec/fixtures/slack'
+            config.hook_into :webmock
+            config.default_cassette_options = { record: :new_episodes }
+          end
+          VCR.insert_cassette global_options['vcr-cassette-name']
+        end
+
+        # remove any nil values from options
+        options.compact!
+
+        true
+      end
     end
-    VCR.insert_cassette global_options['vcr-cassette-name']
   end
-
-  # remove any nil values from options
-  options.select! { |_k, v| v }
-
-  true
 end
 
-$LOAD_PATH.push File.expand_path('..', __FILE__)
-require 'commands'
-
-exit run(ARGV)
+exit Slack::Cli::App.run(ARGV)

data/examples/files_upload_v2/.env.example

@@ -0,0 +1 @@
+SLACK_API_TOKEN=

data/examples/{hi_real_time → files_upload_v2}/Gemfile

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
+gem 'dotenv'
 gem 'slack-ruby-client', path: '../..'
-
-gem 'celluloid-io', require: ['celluloid/current', 'celluloid/io']

data/examples/files_upload_v2/README.md

@@ -0,0 +1,13 @@
+Samples for using `files_upload_v2`.
+
+## Usage
+
+Create a Slack app and obtain a User OAuth Token [here](https://api.slack.com/tutorials/tracks/getting-a-token) or use the [oauth_v2](../oauth_v2) example to obtain a User OAuth Token.
+Make sure to select `files:write` and `files:read` scopes under "User Token Scopes".
+
+Create `.env` file with `SLACK_API_TOKEN` or set the `SLACK_API_TOKEN` environment variable.
+
+```
+bundle install
+bundle exec dotenv ruby files_upload_v2.rb
+```

data/examples/files_upload_v2/files_upload_v2.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+require 'slack-ruby-client'
+require 'securerandom'
+
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+end
+
+client = Slack::Web::Client.new
+
+auth = client.auth_test
+puts "Connected to team #{auth.team} (#{auth.team_id}) as #{auth.user}."
+
+puts client.files_upload_v2(
+  filename: 'files_upload_v2.txt',
+  content: SecureRandom.hex
+).files.first.permalink_public
+
+puts client.files_upload_v2(
+  filename: 'files_upload_v2_to_general_channel.txt',
+  content: SecureRandom.hex,
+  channel: '#general'
+).files.first.permalink_public
+
+puts client.files_upload_v2(
+  filename: 'files_upload_v2_to_general_and_random_channels.txt',
+  content: SecureRandom.hex,
+  channels: ['#general', '#random']
+).files.first.permalink_public
+
+channel_id = client.conversations_id(channel: '#general')['channel']['id']
+puts client.files_upload_v2(
+  filename: 'files_upload_v2_to_general_by_id.txt',
+  content: SecureRandom.hex,
+  channel_id: channel_id
+).files.first.permalink_public
+
+client.files_upload_v2(
+  files: [
+    { filename: 'files_upload_v2_to_general_first_file.txt', content: SecureRandom.hex },
+    { filename: 'files_upload_v2_to_general_second_file.txt', content: SecureRandom.hex }
+  ],
+  channels: ['#general']
+).files.each { |file| puts file.permalink_public }

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_eventmachine → hi_real_time_async_async}/Gemfile

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'
 
-gem 'faye-websocket'
+gem 'async-websocket'
 gem 'foreman'

data/examples/{hi_real_time_async_eventmachine → hi_real_time_async_async}/hi.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
+require 'async'
 
 raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
 
@@ -6,13 +8,18 @@ $stdout.sync = true
 logger = Logger.new($stdout)
 logger.level = Logger::DEBUG
 
+threads = []
+
 ENV['SLACK_API_TOKENS'].split.each do |token|
   logger.info "Starting #{token[0..12]} ..."
 
   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|
@@ -21,16 +28,14 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     client.typing channel: data.channel
 
     case data.text
-    when 'bot hi' then
+    when /hi/
       client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    when /^bot/ then
+    else
       client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
     end
   end
 
-  client.start_async
+  threads << client.start_async
 end
 
-loop do
-  Thread.pass
-end
+threads.each(&:join)

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/examples/oauth_v2/.env.example

@@ -0,0 +1,4 @@
+SLACK_CLIENT_ID=
+SLACK_CLIENT_SECRET=
+REDIRECT_URI=https://...ngrok-free.app
+SCOPE=files:read,files:write,files:write:user

data/examples/oauth_v2/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gem 'activesupport'
+gem 'dotenv'
+gem 'slack-ruby-client', path: '../..'
+gem 'webrick'

data/examples/oauth_v2/README.md

@@ -0,0 +1,33 @@
+Obtain a user OAuth token from Slack.
+
+Create a Slack app [here](https://api.slack.com/tutorials/tracks/getting-a-token). 
+
+The new app has a pre-configured User OAuth Token which you can use for most of the examples.
+However you may want to obtain a token for a different user, which can be accomplished as follows.
+
+To test locally use [ngrok](https://ngrok.com/) to expose your local server to the internet. 
+
+```sh
+ngrok http 4242
+```
+
+Add the ngrok URL to the app's "Redirect URLs" under "OAuth & Permissions" in the app's settings.
+
+Create a `.env` file with the following:
+
+```
+SLACK_CLIENT_ID=[App Client ID]
+SLACK_CLIENT_SECRET=[App Client Secret]
+REDIRECT_URI=[Your ngrok URL, e.g. https://...ngrok-free.app]
+SCOPE=[Bot User OAuth Scopes Requested]
+USER_SCOPE=[User OAuth Token Scopes Requested]
+```
+
+Run the example.
+
+```sh
+bundle install
+bundle exec dotenv ruby oauth_v2.rb 
+```
+
+A browser window will open to complete the OAuth flow.

data/examples/oauth_v2/oauth_v2.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'dotenv/load'
+require 'webrick'
+require 'slack-ruby-client'
+require 'active_support'
+require 'active_support/core_ext/object/to_query'
+
+server = WEBrick::HTTPServer.new(Port: ENV['PORT'] || 4242)
+
+trap 'INT' do
+  server.shutdown
+end
+
+server.mount_proc '/' do |req, res|
+  client = Slack::Web::Client.new
+
+  response = client.oauth_v2_access(
+    req.query.merge(
+      client_id: ENV['SLACK_CLIENT_ID'],
+      client_secret: ENV['SLACK_CLIENT_SECRET'],
+      grant_type: 'authorization_code'
+    )
+  )
+
+  pp response
+
+  res.body = %(
+<html>
+  <body>
+    <ul>
+      <li>bot access_token: #{response.access_token}</li>
+      <li>token_type: #{response.token_type}</li>
+      <li>app_id: #{response.app_id}</li>
+      <li>scope: #{response.scope}</li>
+      <li>user: #{response.authed_user.id}</li>
+      <li>user access token: #{response.authed_user.access_token}</li>
+    </ul>
+  <body>
+</html>
+  )
+
+  pp Slack::Web::Client.new(token: response.authed_user.access_token || response.access_token).auth_test
+
+  server.shutdown
+end
+
+query = {
+  client_id: ENV['SLACK_CLIENT_ID'],
+  redirect_uri: ENV['REDIRECT_URI'],
+  scope: ENV['SCOPE'],
+  user_scope: ENV['USER_SCOPE']
+}
+
+url = "https://slack.com/oauth/v2/authorize?#{query.to_query}"
+puts "Opening browser at #{url}."
+system 'open', url
+
+server.start

data/lib/slack/config.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
 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/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+module Slack
+  module Events
+    module Config
+      extend self
+
+      ATTRIBUTES = %i[
+        signing_secret
+        signature_expires_in
+      ].freeze
+
+      attr_accessor(*Config::ATTRIBUTES)
+
+      def reset
+        self.signing_secret = ENV['SLACK_SIGNING_SECRET']
+        self.signature_expires_in = 5 * 60
+      end
+    end
+
+    class << self
+      def configure
+        block_given? ? yield(Config) : Config
+      end
+
+      def config
+        Config
+      end
+    end
+  end
+end
+
+Slack::Events::Config.reset

data/lib/slack/events/request.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Slack
+  module Events
+    class Request
+      class MissingSigningSecret < StandardError; end
+
+      class TimestampExpired < StandardError; end
+
+      class InvalidSignature < StandardError; end
+
+      attr_reader :http_request,
+                  :signing_secret,
+                  :signature_expires_in
+
+      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
+      end
+
+      # Request timestamp.
+      def 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.get_header('HTTP_X_SLACK_SIGNATURE')
+      end
+
+      # Signature version.
+      def version
+        'v0'
+      end
+
+      # Request body.
+      def body
+        @body ||= begin
+          input = http_request.body
+          input.rewind
+          body = input.read
+          input.rewind
+          body
+        end
+      end
+
+      # Returns true if the signature coming from Slack has expired.
+      def expired?
+        timestamp.nil? || (Time.now.to_i - timestamp.to_i).abs > signature_expires_in
+      end
+
+      # Returns true if the signature coming from Slack is valid.
+      def valid?
+        raise MissingSigningSecret unless signing_secret
+        raise InvalidSignature unless signature
+
+        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('=')
+        Utils::Security.secure_compare(computed_signature, signature)
+      end
+
+      # Validates the request signature and its expiration.
+      def verify!
+        raise TimestampExpired if expired?
+        raise InvalidSignature unless valid?
+
+        true
+      end
+    end
+  end
+end

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,4 +1,4 @@
-
+# frozen_string_literal: true
 module Slack
   module Messages
     module Formatting
@@ -24,6 +24,71 @@ module Slack
               end
             end)
         end
+
+        #
+        # Escape a message.
+        # @see https://api.slack.com/reference/surfaces/formatting#escaping
+        #
+        def escape(message)
+          message
+            .gsub('&', '&')
+            .gsub('>', '>')
+            .gsub('<', '&lt;')
+        end
+
+        #
+        # Format a DateTime or Time object as a date and time in a Slack message
+        # @see https://api.slack.com/reference/surfaces/formatting#date-formatting
+        #
+        def date(time, format: '{date_num} {time_secs}', link: nil, text: nil)
+          args = [time.to_i, format, link].compact
+          "<!date^#{args.join('^')}|#{text || time}>"
+        end
+
+        #
+        # Embed a link to a Slack channel in a message by channel ID
+        # @see https://api.slack.com/reference/surfaces/formatting#linking-channels
+        #
+        def channel_link(channel_id)
+          "<##{channel_id}>"
+        end
+
+        #
+        # Embed a link to a user in a message by user ID
+        # @see https://api.slack.com/reference/surfaces/formatting#mentioning-users
+        #
+        def user_link(user_id)
+          "<@#{user_id}>"
+        end
+
+        #
+        # Embed a link to a group in a message by group ID
+        # @see https://api.slack.com/reference/surfaces/formatting#mentioning-groups
+        #
+        def group_link(group_id)
+          "<!subteam^#{group_id}>"
+        end
+
+        #
+        # Embed a URL with custom link text in a message
+        # @see https://api.slack.com/reference/surfaces/formatting#linking-urls
+        #
+        def url_link(text, url)
+          "<#{url}|#{text}>"
+        end
+
+        #
+        # Converts text from basic markdown into Slack's mishmash
+        # @see https://api.slack.com/reference/surfaces/formatting#basic-formatting
+        #
+        def markdown(text)
+          text
+            .gsub(/(?<!\*)\*([^*\n]+)\*(?!\*)/, '_\1_') # italic
+            .gsub(/\*\*\*(.*?)\*\*\*/, '*_\1_*') # bold & italic
+            .gsub(/\*\*(.*?)\*\*/, '*\1*') # bold
+            .gsub(/~~(.*?)~~/, '~\1~') # strikethrough
+            .gsub(/\[(.*?)\]\((.*?)\)/, '<\2|\1>') # links
+        end
       end
     end
   end

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,12 +7,14 @@ 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 = {})
-          throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
-          throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+          raise ArgumentError, 'Required arguments :text missing' if options[:text].nil?
+
           send_json({ type: 'message', id: next_id }.merge(options))
         end
       end

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

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