slack-ruby-client 0.14.4 → 0.16.0

data/bin/commands/usergroups_users.rb

@@ -1,23 +1,26 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'UsergroupsUsers methods.'
 command 'usergroups_users' do |g|
-  g.desc 'This method returns a list of all users within a User Group.'
-  g.long_desc %( This method returns a list of all users within a User Group. )
+  g.desc 'List all users in a User Group'
+  g.long_desc %( List all users in a User Group )
   g.command 'list' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'include_disabled', desc: 'Allow results that involve disabled User Groups.'
+    c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_users_list(options))
     end
   end
 
-  g.desc 'This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter.'
-  g.long_desc %( This method updates the list of users that belong to a User Group. This method replaces all users in a User Group with the list of users provided in the users parameter. )
+  g.desc 'Update the list of users for a User Group'
+  g.long_desc %( Update the list of users for a User Group )
   g.command 'update' do |c|
     c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
     c.flag 'users', desc: 'A comma separated string of encoded user IDs that represent the entire list of users for the User Group.'
     c.flag 'include_count', desc: 'Include the number of users in the User Group.'
+    c.flag 'team_id', desc: 'encoded team id where the user group exists, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_users_update(options))
     end

data/bin/commands/users.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
-desc 'Users methods.'
+desc 'Get info on members of your Slack team.'
 command 'users' do |g|
-  g.desc 'This method helps answer questions like:'
-  g.long_desc %( This method helps answer questions like: - Which conversations am I a member of? - Which public channels is my bot user in? - Do I have any direct messages open with my friend Suzy? - Is my bot a member of any private channels? )
+  g.desc 'List conversations the calling user may access.'
+  g.long_desc %( List conversations the calling user may access. )
   g.command 'conversations' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'exclude_archived', desc: 'Set to true to exclude archived channels from the list.'
     c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer no larger than 1000."
+    c.flag 'team_id', desc: 'encoded team id to list conversations in, required if org token is used.'
     c.flag 'types', desc: 'Mix and match channel types by providing a comma-separated list of any combination of public_channel, private_channel, mpim, im.'
     c.flag 'user', desc: "Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership."
     c.action do |_global_options, options, _args|
@@ -15,16 +17,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'This method allows the user to delete their profile image. It will clear whatever image is currently set.'
-  g.long_desc %( This method allows the user to delete their profile image. It will clear whatever image is currently set. )
+  g.desc 'Delete the user profile photo'
+  g.long_desc %( Delete the user profile photo )
   g.command 'deletePhoto' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_deletePhoto(options))
     end
   end
 
-  g.desc "This method lets you find out information about a user's presence."
-  g.long_desc %( This method lets you find out information about a user's presence. Consult the presence documentation for more details. )
+  g.desc 'Gets user presence information.'
+  g.long_desc %( Gets user presence information. )
   g.command 'getPresence' do |c|
     c.flag 'user', desc: 'User to get presence info on. Defaults to the authed user.'
     c.action do |_global_options, options, _args|
@@ -41,16 +43,16 @@ command 'users' do |g|
     end
   end
 
-  g.desc "After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity."
-  g.long_desc %( After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity. )
+  g.desc "Get a user's identity."
+  g.long_desc %( Get a user's identity. )
   g.command 'identity' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_identity(options))
     end
   end
 
-  g.desc 'This method returns information about a member of a workspace.'
-  g.long_desc %( This method returns information about a member of a workspace. )
+  g.desc 'Gets information about a user.'
+  g.long_desc %( Gets information about a user. )
   g.command 'info' do |c|
     c.flag 'user', desc: 'User to get info on.'
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for this user. Defaults to false.'
@@ -59,19 +61,20 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'This method returns a list of all users in the workspace. This includes deleted/deactivated users.'
-  g.long_desc %( This method returns a list of all users in the workspace. This includes deleted/deactivated users. )
+  g.desc 'Lists all users in a Slack team.'
+  g.long_desc %( Lists all users in a Slack team. )
   g.command 'list' do |c|
     c.flag 'cursor', desc: "Paginate through collections of data by setting the cursor parameter to a next_cursor attribute returned by a previous request's response_metadata. Default value fetches the first 'page' of the collection. See pagination for more detail."
     c.flag 'include_locale', desc: 'Set this to true to receive the locale for users. Defaults to false.'
-    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached."
+    c.flag 'limit', desc: "The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no limit value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience limit_required or HTTP 500 errors."
+    c.flag 'team_id', desc: 'encoded team id to list users in, required if org token is used.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_list(options))
     end
   end
 
-  g.desc 'Retrieve a single user by looking them up by their registered email address. Requires users:read.email.'
-  g.long_desc %( Retrieve a single user by looking them up by their registered email address. Requires users:read.email. )
+  g.desc 'Find a user with an email address.'
+  g.long_desc %( Find a user with an email address. )
   g.command 'lookupByEmail' do |c|
     c.flag 'email', desc: 'An email address belonging to a user in the workspace.'
     c.action do |_global_options, options, _args|
@@ -88,28 +91,28 @@ command 'users' do |g|
     end
   end
 
-  g.desc 'This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018.'
-  g.long_desc %( This method is no longer functional and the behavior it controlled is no longer offered. The method will no longer exist beginning May 8, 2018. )
+  g.desc 'Marked a user as active. Deprecated and non-functional.'
+  g.long_desc %( Marked a user as active. Deprecated and non-functional. )
   g.command 'setActive' do |c|
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_setActive(options))
     end
   end
 
-  g.desc 'This method allows the user to set their profile image. The caller can pass image data via image.'
-  g.long_desc %( This method allows the user to set their profile image. The caller can pass image data via image. )
+  g.desc 'Set the user profile photo'
+  g.long_desc %( Set the user profile photo )
   g.command 'setPhoto' do |c|
-    c.flag 'image', desc: 'File contents via multipart/form-data.'
     c.flag 'crop_w', desc: 'Width/height of crop box (always square).'
     c.flag 'crop_x', desc: 'X coordinate of top-left corner of crop box.'
     c.flag 'crop_y', desc: 'Y coordinate of top-left corner of crop box.'
+    c.flag 'image', desc: 'File contents via multipart/form-data.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_setPhoto(options))
     end
   end
 
-  g.desc "This method lets you set the calling user's manual presence."
-  g.long_desc %( This method lets you set the calling user's manual presence. Consult the presence documentation for more details. )
+  g.desc 'Manually sets user presence.'
+  g.long_desc %( Manually sets user presence. )
   g.command 'setPresence' do |c|
     c.flag 'presence', desc: 'Either auto or away.'
     c.action do |_global_options, options, _args|

data/bin/commands/users_admin.rb

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

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,19 +1,20 @@
+# 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 "Retrieve a user's profile information, including their custom status."
+  g.long_desc %( Retrieve a user's profile information, including their custom status. )
   g.command 'get' do |c|
-    c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
+    c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.'
     c.flag 'user', desc: 'User to retrieve profile info for.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_profile_get(options))
     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 a user's profile information, including custom status."
+  g.long_desc %( Set a user's profile information, including custom status. )
   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 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
 

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-ruby-client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require_relative 'slack/version'
 require_relative 'slack/logger'
 require_relative 'slack/config'
@@ -14,19 +15,22 @@ 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/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'
@@ -35,8 +39,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.
@@ -33,7 +35,11 @@ module Slack
 
       # Request body.
       def body
-        @body ||= http_request.body.read
+        @body ||= begin
+          body = http_request.body.read
+          http_request.body.rewind
+          body
+        end
       end
 
       # Returns true if the signature coming from Slack has expired.