slack-ruby-client 0.13.1 → 2.0.0

data/bin/commands/views.rb

@@ -0,0 +1,50 @@
+# 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 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.flag 'interactivity_pointer', desc: 'Exchange an interactivity pointer to post to the user.'
+    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 'view', desc: 'A view payload. This must be a JSON-encoded string.'
+    c.flag 'trigger_id', desc: 'Exchange a trigger to post to the user.'
+    c.flag 'interactivity_pointer', desc: 'Exchange an interactivity pointer to post to the user.'
+    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 'view_id', desc: 'A unique identifier of the view to be updated. 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.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/commands.rb

@@ -1,25 +1,53 @@
+# 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_audit_anomaly_allow'
+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/admin_users_unsupportedVersions'
 require 'commands/api'
-require 'commands/apps_permissions'
-require 'commands/apps_permissions_resources'
-require 'commands/apps_permissions_scopes'
-require 'commands/apps_permissions_users'
+require 'commands/apps'
+require 'commands/apps_connections'
+require 'commands/apps_event_authorizations'
+require 'commands/apps_manifest'
 require 'commands/auth'
+require 'commands/auth_teams'
+require 'commands/bookmarks'
 require 'commands/bots'
-require 'commands/channels'
+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'
 require 'commands/files_comments'
-require 'commands/groups'
-require 'commands/im'
+require 'commands/files_remote'
 require 'commands/migration'
-require 'commands/mpim'
 require 'commands/oauth'
+require 'commands/oauth_v2'
+require 'commands/openid_connect'
 require 'commands/pins'
 require 'commands/reactions'
 require 'commands/reminders'
@@ -27,10 +55,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
 
@@ -41,12 +40,12 @@ pre do |global_options, _command, options, _args|
   end
 
   # remove any nil values from options
-  options.select! { |_k, v| v }
+  options.compact!
 
   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,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_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/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,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,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

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,8 @@
         # <%= desc %>
         # @see https://api.slack.com/events/<%= name %>
         # @see https://github.com/slack-ruby/slack-api-ref/blob/master/events/<%= name %>.json
-        # on :<%= name %> do |data|
+<% if hook %>
+<%= hook %>
+<% else %>
+          # on :<%= name %> do |data|
+<% end %>

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Slack
   module RealTime
     module Api
@@ -6,9 +7,11 @@ 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?
+          raise ArgumentError, 'Required arguments :channel missing' if options[:channel].nil?
+
           send_json({ type: 'typing', id: next_id }.merge(options))
         end
       end