slack-ruby-client 0.14.4 → 0.14.5

data/bin/commands/usergroups_users.rb

@@ -1,9 +1,10 @@
+# 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.'
@@ -12,8 +13,8 @@ command 'usergroups_users' do |g|
     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.'

data/bin/commands/users.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 # This file was auto-generated by lib/tasks/web.rake
 
 desc 'Users methods.'
 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.'
@@ -15,16 +16,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 +42,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,8 +60,8 @@ 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.'
@@ -70,8 +71,8 @@ command 'users' do |g|
     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,16 +89,16 @@ 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).'
@@ -108,8 +109,8 @@ command 'users' do |g|
     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,9 +1,10 @@
+# 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 "Retrieves a user's profile information."
+  g.long_desc %( Retrieves a user's profile information. )
   g.command 'get' do |c|
     c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
     c.flag 'user', desc: 'User to retrieve profile info for.'
@@ -12,8 +13,8 @@ command 'users_profile' do |g|
     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 the profile information for a user.'
+  g.long_desc %( Set the profile information for a user. )
   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 payload 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/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/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 Slack.configure do |config|
@@ -10,7 +11,10 @@ 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|
@@ -19,9 +23,9 @@ client.on :message do |data|
   client.typing channel: data.channel
 
   case data.text
-  when 'bot hi' then
+  when 'bot hi'
     client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-  when /^bot/ then
+  when /^bot/
     client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end

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_real_time_async_celluloid/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_async_celluloid/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
@@ -13,7 +14,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|
@@ -22,9 +26,9 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     client.typing channel: data.channel
 
     case data.text
-    when 'bot hi' then
+    when 'bot hi'
       client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    when /^bot/ then
+    when /^bot/
       client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
     end
   end

data/examples/hi_real_time_async_eventmachine/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'http://rubygems.org'
 
 gem 'slack-ruby-client', path: '../..'

data/examples/hi_real_time_async_eventmachine/hi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'
 
 raise 'Missing ENV[SLACK_API_TOKENS]!' unless ENV.key?('SLACK_API_TOKENS')
@@ -13,7 +14,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|
@@ -22,9 +26,9 @@ ENV['SLACK_API_TOKENS'].split.each do |token|
     client.typing channel: data.channel
 
     case data.text
-    when 'bot hi' then
+    when 'bot hi'
       client.message channel: data.channel, text: "Hi <@#{data.user}>!"
-    when /^bot/ then
+    when /^bot/
       client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
     end
   end

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,12 +15,12 @@ require 'json'
 require 'logger'
 begin
   require 'picky'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
   # ignore, only used in users_search
 end
 begin
   require 'openssl'
-rescue LoadError
+rescue LoadError # rubocop:disable Lint/HandleExceptions
   # Used in slack/web/config
 end
 require_relative 'slack/web/config'

data/lib/slack.rb

@@ -1 +1,2 @@
+# frozen_string_literal: true
 require 'slack-ruby-client'