slack-ruby-client 0.7.9 → 0.16.0

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 object. 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/commands/workflows.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Workflows methods.'
+command 'workflows' do |g|
+  g.desc "Indicate that an app's step in a workflow completed execution."
+  g.long_desc %( Indicate that an app's step in a workflow completed execution. )
+  g.command 'stepCompleted' do |c|
+    c.flag 'workflow_step_execute_id', desc: 'Context identifier that maps to the correct workflow step execution.'
+    c.flag 'outputs', desc: 'Key-value object of outputs from your step. Keys of this object reflect the configured key properties of your outputs array from your workflow_step object.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.workflows_stepCompleted(options))
+    end
+  end
+
+  g.desc "Indicate that an app's step in a workflow failed to execute."
+  g.long_desc %( Indicate that an app's step in a workflow failed to execute. )
+  g.command 'stepFailed' do |c|
+    c.flag 'error', desc: 'A JSON-based object with a message property that should contain a human readable error message.'
+    c.flag 'workflow_step_execute_id', desc: 'Context identifier that maps to the correct workflow step execution.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.workflows_stepFailed(options))
+    end
+  end
+
+  g.desc 'Update the configuration for a workflow step.'
+  g.long_desc %( Update the configuration for a workflow step. )
+  g.command 'updateStep' do |c|
+    c.flag 'workflow_step_edit_id', desc: 'A context identifier provided with view_submission payloads used to call back to workflows.updateStep.'
+    c.flag 'inputs', desc: 'A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.'
+    c.flag 'outputs', desc: 'An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.'
+    c.flag 'step_image_url', desc: 'An optional field that can be used to override app image that is shown in the Workflow Builder.'
+    c.flag 'step_name', desc: 'An optional field that can be used to override the step name that is shown in the Workflow Builder.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.workflows_updateStep(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
 
@@ -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_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_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

data/lib/slack-ruby-client.rb

@@ -1,11 +1,12 @@
-require 'slack/version'
-require 'slack/logger'
-require 'slack/config'
+# frozen_string_literal: true
+require_relative 'slack/version'
+require_relative 'slack/logger'
+require_relative 'slack/config'
 
 # Messages
 require 'hashie'
-require 'slack/messages/message'
-require 'slack/messages/formatting'
+require_relative 'slack/messages/message'
+require_relative 'slack/messages/formatting'
 
 # Web API
 require 'faraday'
@@ -14,28 +15,41 @@ require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/SuppressedException
   # ignore, only used in users_search
 end
-require 'slack/web/config'
-require 'slack/web/api/error'
-require 'slack/web/faraday/response/raise_error'
-require 'slack/web/faraday/connection'
-require 'slack/web/faraday/request'
-require 'slack/web/api/mixins'
-require 'slack/web/api/endpoints'
-require 'slack/web/client'
+begin
+  require 'openssl'
+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/api/errors/internal_error'
+require_relative 'slack/web/faraday/response/raise_error'
+require_relative 'slack/web/faraday/response/wrap_error'
+require_relative 'slack/web/faraday/connection'
+require_relative 'slack/web/faraday/request'
+require_relative 'slack/web/api/mixins'
+require_relative 'slack/web/api/endpoints'
+require_relative 'slack/web/pagination/cursor'
+require_relative 'slack/web/client'
 
 # RealTime API
-require 'active_support'
-require 'active_support/core_ext'
-require 'slack/real_time/concurrency'
-require 'slack/real_time/socket'
-require 'slack/real_time/api/message_id'
-require 'slack/real_time/api/ping'
-require 'slack/real_time/api/message'
-require 'slack/real_time/api/typing'
-require 'slack/real_time/models'
-require 'slack/real_time/stores'
-require 'slack/real_time/config'
-require 'slack/real_time/client'
+require_relative 'slack/real_time/concurrency'
+require_relative 'slack/real_time/socket'
+require_relative 'slack/real_time/api/message_id'
+require_relative 'slack/real_time/api/ping'
+require_relative 'slack/real_time/api/message'
+require_relative 'slack/real_time/api/typing'
+require_relative 'slack/real_time/models'
+require_relative 'slack/real_time/stores'
+require_relative 'slack/real_time/config'
+require_relative 'slack/real_time/client'
+
+# Events API
+require_relative 'slack/events/config'
+require_relative 'slack/events/request'

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

@@ -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,70 @@
+# 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.headers['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.headers['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::SHA256.new
+        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