slack-ruby-client 0.7.2 → 1.0.0

data/bin/commands.rb

@@ -1,17 +1,50 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
+require 'commands/admin_analytics'
+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_emoji'
+require 'commands/admin_inviteRequests'
+require 'commands/admin_inviteRequests_approved'
+require 'commands/admin_inviteRequests_denied'
+require 'commands/admin_teams'
+require 'commands/admin_teams_admins'
+require 'commands/admin_teams_owners'
+require 'commands/admin_teams_settings'
+require 'commands/admin_usergroups'
+require 'commands/admin_users'
+require 'commands/admin_users_session'
 require 'commands/api'
+require 'commands/apps'
+require 'commands/apps_connections'
+require 'commands/apps_event_authorizations'
+require 'commands/apps_manifest'
 require 'commands/auth'
-require 'commands/channels'
+require 'commands/auth_teams'
+require 'commands/bots'
+require 'commands/calls'
+require 'commands/calls_participants'
 require 'commands/chat'
+require 'commands/chat_scheduledMessages'
+require 'commands/conversations'
+require 'commands/dialog'
 require 'commands/dnd'
 require 'commands/emoji'
-require 'commands/files_comments'
 require 'commands/files'
-require 'commands/groups'
-require 'commands/im'
-require 'commands/mpim'
+require 'commands/files_comments'
+require 'commands/files_remote'
+require 'commands/migration'
 require 'commands/oauth'
+require 'commands/oauth_v2'
+require 'commands/openid_connect'
 require 'commands/pins'
 require 'commands/reactions'
 require 'commands/reminders'
@@ -19,6 +52,15 @@ 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'
+require 'commands/users_admin'
+require 'commands/users_prefs'
+require 'commands/users_profile'
+require 'commands/views'
+require 'commands/workflows'

data/bin/slack

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-
 require 'gli'
-require 'slack-ruby-client'
+require 'slack_ruby_client'
 
 include GLI::App
 
@@ -9,7 +8,7 @@ program_desc 'Slack client.'
 
 default_command :help
 
-switch [:d, :debug], desc: 'Enable debug-level logging.', default_value: false
+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.'
 
@@ -46,7 +45,7 @@ pre do |global_options, _command, options, _args|
   true
 end
 
-$LOAD_PATH.push File.expand_path('..', __FILE__)
+$LOAD_PATH.push File.expand_path(__dir__)
 require 'commands'
 
 exit run(ARGV)

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,22 +1,26 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|
   config.token = ENV['SLACK_API_TOKEN']
-  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 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_celluloid → hi_real_time_async_async}/Gemfile

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

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

@@ -1,18 +1,25 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
+require 'async'
 
-fail 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
+raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
 
 $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,8 +1,9 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|
   config.token = ENV['SLACK_API_TOKEN']
-  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 end
 
 client = Slack::Web::Client.new

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,8 +1,9 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|
   config.token = ENV['SLACK_API_TOKEN']
-  fail 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
+  raise 'Missing ENV[SLACK_API_TOKEN]!' unless config.token
 end
 
 client = Slack::Web::Client.new
@@ -14,7 +15,7 @@ client.chat_postMessage(
   as_user: true,
   attachments: [
     {
-      fallback: "Ticket #1943: Can't rest my password - https://groove.hq/path/to/ticket/1943",
+      fallback: "Ticket #1943: Can't reset my password - https://groove.hq/path/to/ticket/1943",
       pretext: 'New ticket from Andrea Lee',
       title: "Ticket #1943: Can't reset my password",
       title_link: 'https://groove.hq/path/to/ticket/1943',

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,72 @@
+# 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
+          body = http_request.body.read
+          http_request.body.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
+
+        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('=')
+        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 @@
-# encoding: utf-8
+# frozen_string_literal: true
 module Slack
   module Messages
     module Formatting
@@ -10,9 +10,9 @@ module Slack
         def unescape(message)
           CGI.unescapeHTML(message.gsub(/[“”]/, '"')
             .gsub(/[‘’]/, "'")
-            .gsub(/<(?<sign>[?@#!]?)(?<dt>.*?)>/) do |match|
-              sign = $~[:sign]
-              dt = $~[:dt]
+            .gsub(/<(?<sign>[?@#!]?)(?<dt>.*?)>/) do
+              sign = Regexp.last_match[:sign]
+              dt = Regexp.last_match[:dt]
               rhs = dt.split('|', 2).last
               case sign
               when '@', '!'

data/lib/slack/messages/message.rb

@@ -1,15 +1,17 @@
+# 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]}"
         end.join(', ')
       end
+
+      private
+
+      # see https://github.com/intridea/hashie/issues/394
+      def log_built_in_message(*); end
     end
   end
 end

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/templates/event_handler.erb

@@ -1,4 +1,4 @@
         # <%= desc %>
         # @see https://api.slack.com/events/<%= name %>
-        # @see https://github.com/dblock/slack-api-ref/blob/master/events/<%= name %>.json
+        # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/<%= name %>.json
         # on :<%= name %> do |data|

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))