slack-ruby-client 0.9.0 → 0.9.1

data/bin/commands/users_profile.rb

@@ -2,22 +2,22 @@
 
 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 'user', desc: 'User to retrieve profile info for.'
     c.flag 'include_labels', desc: 'Include labels for each ID in custom profile fields.'
+    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 the profile information for a user.'
+  g.long_desc %( Set the profile information for a user. )
   g.command 'set' do |c|
-    c.flag 'user', desc: 'ID of user to change. This argument may only be specified by team admins on paid teams.'
-    c.flag 'profile', desc: 'Collection of key:value pairs presented as a URL-encoded JSON hash.'
     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.'
+    c.flag 'user', desc: 'ID of user to change. This argument may only be specified by team admins on paid teams.'
     c.flag 'value', desc: 'Value to set a single key to. Usable only if profile is not passed.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.users_profile_set(options))

data/lib/slack/real_time/stores/starter.rb

@@ -14,6 +14,26 @@ module Slack
 
         ### RealTime Events
 
+        # The membership of an existing User Group has changed.
+        # @see https://api.slack.com/events/subteam_members_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/subteam_members_changed.json
+        # on :subteam_members_changed do |data|
+
+        # Subscribe to presence events for the specified users.
+        # @see https://api.slack.com/events/presence_sub
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/presence_sub.json
+        # on :presence_sub do |data|
+
+        # A user left a public or private channel.
+        # @see https://api.slack.com/events/member_left_channel
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/member_left_channel.json
+        # on :member_left_channel do |data|
+
+        # A user joined a public or private channel.
+        # @see https://api.slack.com/events/member_joined_channel
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/member_joined_channel.json
+        # on :member_joined_channel do |data|
+
         # The server intends to close the connection soon..
         # @see https://api.slack.com/events/goodbye
         # @see https://github.com/dblock/slack-api-ref/blob/master/events/goodbye.json

data/lib/slack/real_time/stores/store.rb

@@ -54,6 +54,26 @@ module Slack
 
         ### RealTime Events
 
+        # The membership of an existing User Group has changed.
+        # @see https://api.slack.com/events/subteam_members_changed
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/subteam_members_changed.json
+        # on :subteam_members_changed do |data|
+
+        # Subscribe to presence events for the specified users.
+        # @see https://api.slack.com/events/presence_sub
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/presence_sub.json
+        # on :presence_sub do |data|
+
+        # A user left a public or private channel.
+        # @see https://api.slack.com/events/member_left_channel
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/member_left_channel.json
+        # on :member_left_channel do |data|
+
+        # A user joined a public or private channel.
+        # @see https://api.slack.com/events/member_joined_channel
+        # @see https://github.com/dblock/slack-api-ref/blob/master/events/member_joined_channel.json
+        # on :member_joined_channel do |data|
+
         # The server intends to close the connection soon..
         # @see https://api.slack.com/events/goodbye
         # @see https://github.com/dblock/slack-api-ref/blob/master/events/goodbye.json

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.9.1'.freeze
 end

data/lib/slack/web/api/endpoints.rb

@@ -1,6 +1,7 @@
 # This file was auto-generated by lib/tasks/web.rake
 
 require_relative 'endpoints/api'
+require_relative 'endpoints/apps_permissions'
 require_relative 'endpoints/auth'
 require_relative 'endpoints/bots'
 require_relative 'endpoints/channels'
@@ -35,6 +36,7 @@ module Slack
         include Slack::Web::Api::Mixins::Groups
 
         include Api
+        include AppsPermissions
         include Auth
         include Bots
         include Channels

data/lib/slack/web/api/endpoints/api.rb

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Api
           #
-          # This method helps you test your calling code.
+          # Checks API calling code.
           #
           # @option options [Object] :error
           #   Error response to return.

data/lib/slack/web/api/endpoints/apps_permissions.rb

@@ -0,0 +1,35 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module AppsPermissions
+          #
+          # Returns list of permissions this app has on a team.
+          #
+          # @see https://api.slack.com/methods/apps.permissions.info
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.info.json
+          def apps_permissions_info(options = {})
+            post('apps.permissions.info', options)
+          end
+
+          #
+          # Allows an app to request additional scopes
+          #
+          # @option options [Object] :scopes
+          #   A comma separated list of scopes to request for.
+          # @option options [Object] :trigger_id
+          #   Token used to trigger the permissions API.
+          # @see https://api.slack.com/methods/apps.permissions.request
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/apps.permissions/apps.permissions.request.json
+          def apps_permissions_request(options = {})
+            throw ArgumentError.new('Required arguments :scopes missing') if options[:scopes].nil?
+            throw ArgumentError.new('Required arguments :trigger_id missing') if options[:trigger_id].nil?
+            post('apps.permissions.request', options)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/endpoints/auth.rb

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Auth
           #
-          # This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.
+          # Revokes a token.
           #
           # @option options [Object] :test
           #   Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
@@ -17,7 +17,7 @@ module Slack
           end
 
           #
-          # This method checks authentication and tells you who you are.
+          # Checks authentication & identity.
           #
           # @see https://api.slack.com/methods/auth.test
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/auth/auth.test.json

data/lib/slack/web/api/endpoints/bots.rb

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Bots
           #
-          # This method returns information about a bot user.
+          # Gets information about a bot user.
           #
           # @option options [Object] :bot
           #   Bot user to get info on.

data/lib/slack/web/api/endpoints/channels.rb

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Channels
           #
-          # This method archives a channel.
+          # Archives a channel.
           #
           # @option options [channel] :channel
           #   Channel to archive.
@@ -19,7 +19,7 @@ module Slack
           end
 
           #
-          # This method is used to create a channel.
+          # Creates a channel.
           #
           # @option options [Object] :name
           #   Name of channel to create.
@@ -33,16 +33,16 @@ module Slack
           end
 
           #
-          # This method returns a portion of message events from the specified channel.
+          # Fetches history of messages and events from a channel.
           #
           # @option options [channel] :channel
           #   Channel to fetch history for.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @option options [timestamp] :latest
           #   End of time range of messages to include in results.
           # @option options [timestamp] :oldest
           #   Start of time range of messages to include in results.
-          # @option options [Object] :inclusive
-          #   Include messages with latest or oldest timestamp in results.
           # @option options [Object] :unreads
           #   Include unread_count_display in the output?.
           # @see https://api.slack.com/methods/channels.history
@@ -54,7 +54,7 @@ module Slack
           end
 
           #
-          # This method returns information about a team channel.
+          # Gets information about a channel.
           #
           # @option options [channel] :channel
           #   Channel to get info on.
@@ -67,7 +67,7 @@ module Slack
           end
 
           #
-          # This method is used to invite a user to a channel. The calling user must be a member of the channel.
+          # Invites a user to a channel.
           #
           # @option options [channel] :channel
           #   Channel to invite user to.
@@ -84,8 +84,7 @@ module Slack
           end
 
           #
-          # This method is used to join a channel. If the channel does not exist, it is
-          # created.
+          # Joins a channel, creating it if needed.
           #
           # @option options [Object] :name
           #   Name of channel to join.
@@ -99,7 +98,7 @@ module Slack
           end
 
           #
-          # This method allows a user to remove another member from a team channel.
+          # Removes a user from a channel.
           #
           # @option options [channel] :channel
           #   Channel to remove user from.
@@ -116,7 +115,7 @@ module Slack
           end
 
           #
-          # This method is used to leave a channel.
+          # Leaves a channel.
           #
           # @option options [channel] :channel
           #   Channel to leave.
@@ -129,7 +128,7 @@ module Slack
           end
 
           #
-          # This method returns a list of all channels in the team. This includes channels the caller is in, channels they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned.
+          # Lists all channels in a Slack team.
           #
           # @option options [Object] :exclude_archived
           #   Exclude archived channels from the list.
@@ -142,7 +141,7 @@ module Slack
           end
 
           #
-          # This method moves the read cursor in a channel.
+          # Sets the read cursor in a channel.
           #
           # @option options [channel] :channel
           #   Channel to set reading cursor in.
@@ -158,7 +157,7 @@ module Slack
           end
 
           #
-          # This method renames a team channel.
+          # Renames a channel.
           #
           # @option options [channel] :channel
           #   Channel to rename.
@@ -176,7 +175,7 @@ module Slack
           end
 
           #
-          # This method returns an entire thread (a message plus all the messages in reply to it).
+          # Retrieve a thread of messages posted to a channel
           #
           # @option options [channel] :channel
           #   Channel to fetch thread from.
@@ -192,7 +191,7 @@ module Slack
           end
 
           #
-          # This method is used to change the purpose of a channel. The calling user must be a member of the channel.
+          # Sets the purpose for a channel.
           #
           # @option options [channel] :channel
           #   Channel to set the purpose of.
@@ -208,7 +207,7 @@ module Slack
           end
 
           #
-          # This method is used to change the topic of a channel. The calling user must be a member of the channel.
+          # Sets the topic for a channel.
           #
           # @option options [channel] :channel
           #   Channel to set the topic of.
@@ -224,7 +223,7 @@ module Slack
           end
 
           #
-          # This method unarchives a channel. The calling user is added to the channel.
+          # Unarchives a channel.
           #
           # @option options [channel] :channel
           #   Channel to unarchive.

data/lib/slack/web/api/endpoints/chat.rb

@@ -6,25 +6,25 @@ module Slack
       module Endpoints
         module Chat
           #
-          # This method deletes a message from a channel.
+          # Deletes a message.
           #
-          # @option options [timestamp] :ts
-          #   Timestamp of the message to be deleted.
           # @option options [channel] :channel
           #   Channel containing the message to be deleted.
+          # @option options [timestamp] :ts
+          #   Timestamp of the message to be deleted.
           # @option options [Object] :as_user
           #   Pass true to delete the message as the authed user. Bot users in this context are considered authed users.
           # @see https://api.slack.com/methods/chat.delete
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.delete.json
           def chat_delete(options = {})
-            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('chat.delete', options)
           end
 
           #
-          # This method sends a me message to a channel from the calling user.
+          # Share a me message into 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.
@@ -39,34 +39,67 @@ module Slack
           end
 
           #
-          # This method posts a message to a public channel, private channel, or direct message/IM channel.
+          # Sends an ephemeral message to a user in a channel.
           #
           # @option options [channel] :channel
-          #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
+          #   Channel, private group, or IM channel to send message to. 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. This field is usually required, unless you're providing only attachments instead.
+          # @option options [user] :user
+          #   id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.
+          # @option options [Object] :as_user
+          #   Pass true to post the message as the authed bot. Defaults to false.
+          # @option options [Object] :attachments
+          #   A JSON-based array of structured attachments, presented as a URL-encoded string.
+          # @option options [Object] :link_names
+          #   Find and link channel names and usernames.
           # @option options [Object] :parse
           #   Change how messages are treated. Defaults to none. See below.
+          # @see https://api.slack.com/methods/chat.postEphemeral
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.postEphemeral.json
+          def chat_postEphemeral(options = {})
+            throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+            throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            # attachments must be passed as an encoded JSON string
+            if options.key?(:attachments)
+              attachments = options[:attachments]
+              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
+              options = options.merge(attachments: attachments)
+            end
+            post('chat.postEphemeral', options)
+          end
+
+          #
+          # Sends a message to a channel.
+          #
+          # @option options [channel] :channel
+          #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
+          # @option options [Object] :text
+          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.
+          # @option options [Object] :as_user
+          #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
+          # @option options [Object] :attachments
+          #   A JSON-based array of structured attachments, presented as a URL-encoded string.
+          # @option options [Object] :icon_emoji
+          #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
+          # @option options [Object] :icon_url
+          #   URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames.
-          # @option options [Object] :attachments
-          #   Structured message attachments.
+          # @option options [Object] :parse
+          #   Change how messages are treated. Defaults to none. See below.
+          # @option options [Object] :reply_broadcast
+          #   Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
+          # @option options [Object] :thread_ts
+          #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
           # @option options [Object] :unfurl_links
           #   Pass true to enable unfurling of primarily text-based content.
           # @option options [Object] :unfurl_media
           #   Pass false to disable unfurling of media content.
           # @option options [Object] :username
           #   Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
-          # @option options [Object] :as_user
-          #   Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See authorship below.
-          # @option options [Object] :icon_url
-          #   URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
-          # @option options [Object] :icon_emoji
-          #   Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.
-          # @option options [Object] :thread_ts
-          #   Provide another message's ts value to make this message a reply. Avoid using a reply's ts value; use its parent instead.
-          # @option options [Object] :reply_broadcast
-          #   Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.
           # @see https://api.slack.com/methods/chat.postMessage
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.postMessage.json
           def chat_postMessage(options = {})
@@ -82,16 +115,20 @@ module Slack
           end
 
           #
-          # This method attaches Slack app unfurl behavior to a specified and relevant message. A user token is required as this method does not support bot user tokens.
+          # Provide custom unfurl behavior for user-posted URLs
           #
           # @option options [channel] :channel
           #   Channel ID of the message.
           # @option options [timestamp] :ts
           #   Timestamp of the message to add unfurl behavior to.
           # @option options [Object] :unfurls
-          #   JSON mapping a set of URLs from the message to their unfurl attachments.
+          #   URL-encoded JSON map with keys set to URLs featured in the the message, pointing to their unfurl message attachments.
+          # @option options [Object] :user_auth_message
+          #   Provide a simply-formatted string to send as an ephemeral message to the user as invitation to authenticate further and enable full unfurling behavior.
           # @option options [Object] :user_auth_required
           #   Set to true or 1 to indicate the user must install your Slack app to trigger unfurls for this domain.
+          # @option options [Object] :user_auth_url
+          #   Send users to this custom URL where they will complete authentication in your app to fully trigger unfurling. Value should be properly URL-encoded.
           # @see https://api.slack.com/methods/chat.unfurl
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.unfurl.json
           def chat_unfurl(options = {})
@@ -103,28 +140,28 @@ module Slack
           end
 
           #
-          # This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.
+          # Updates a message.
           #
-          # @option options [timestamp] :ts
-          #   Timestamp of the message to be updated.
           # @option options [channel] :channel
           #   Channel containing the message to be updated.
           # @option options [Object] :text
           #   New text for the message, using the default formatting rules.
+          # @option options [timestamp] :ts
+          #   Timestamp of the message to be updated.
+          # @option options [Object] :as_user
+          #   Pass true to update the message as the authed user. Bot users in this context are considered authed users.
           # @option options [Object] :attachments
-          #   Structured message attachments.
-          # @option options [Object] :parse
-          #   Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
+          #   A JSON-based array of structured attachments, presented as a URL-encoded string.
           # @option options [Object] :link_names
           #   Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.
-          # @option options [Object] :as_user
-          #   Pass true to update the message as the authed user. Bot users in this context are considered authed users.
+          # @option options [Object] :parse
+          #   Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.
           # @see https://api.slack.com/methods/chat.update
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat/chat.update.json
           def chat_update(options = {})
-            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
+            throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
             options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             # attachments must be passed as an encoded JSON string
             if options.key?(:attachments)