slack-ruby-client 0.14.1 → 0.14.2

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

@@ -6,7 +6,8 @@ module Slack
       module Endpoints
         module Reactions
           #
-          # Adds a reaction to an item.
+          # This method adds a reaction (emoji) to a message.
+          # Now that file threads work the way you'd expect, the file and file_comment arguments are deprecated. Specify channel and timestamp instead.
           #
           # @option options [Object] :name
           #   Reaction (emoji) name.
@@ -27,7 +28,7 @@ module Slack
           end
 
           #
-          # Gets reactions for an item.
+          # This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).
           #
           # @option options [channel] :channel
           #   Channel where the message to get reactions for was posted.
@@ -47,7 +48,7 @@ module Slack
           end
 
           #
-          # Lists reactions made by a user.
+          # This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -71,7 +72,8 @@ module Slack
           end
 
           #
-          # Removes a reaction from an item.
+          # This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).
+          # One of file, file_comment, or the combination of channel and timestamp must be specified.
           #
           # @option options [Object] :name
           #   Reaction (emoji) name.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Reminders
           #
-          # Creates a reminder.
+          # This method creates a reminder.
           #
           # @option options [Object] :text
           #   The content of the reminder.
@@ -24,7 +24,7 @@ module Slack
           end
 
           #
-          # Marks a reminder as complete.
+          # This method completes a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder to be marked as complete.
@@ -36,7 +36,7 @@ module Slack
           end
 
           #
-          # Deletes a reminder.
+          # This method deletes a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
@@ -48,7 +48,7 @@ module Slack
           end
 
           #
-          # Gets information about a reminder.
+          # This method returns information about a reminder.
           #
           # @option options [Object] :reminder
           #   The ID of the reminder.
@@ -60,7 +60,7 @@ module Slack
           end
 
           #
-          # Lists all reminders created by or for a given user.
+          # This method lists all reminders created by or for a given user.
           #
           # @see https://api.slack.com/methods/reminders.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/reminders/reminders.list.json

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Rtm
           #
-          # Starts a Real Time Messaging session.
+          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
           #
           # @option options [Object] :batch_presence_aware
           #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.
@@ -19,7 +19,7 @@ module Slack
           end
 
           #
-          # Starts a Real Time Messaging session.
+          # This method begins a Real Time Messaging API session and reserves your application a specific URL with which to connect via websocket.
           #
           # @option options [Object] :batch_presence_aware
           #   Batch presence deliveries via subscription. Enabling changes the shape of presence_change events. See batch presence.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Search
           #
-          # Searches for messages and files matching a query.
+          # This method allows users and applications to search both messages and files in a single call.
           #
           # @option options [Object] :query
           #   Search query. May contains booleans, etc.
@@ -24,7 +24,7 @@ module Slack
           end
 
           #
-          # Searches for files matching a query.
+          # This method returns files matching a search query.
           #
           # @option options [Object] :query
           #   Search query.
@@ -42,7 +42,7 @@ module Slack
           end
 
           #
-          # Searches for messages matching a query.
+          # This method returns messages matching a search query.
           #
           # @option options [Object] :query
           #   Search query.

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

@@ -6,7 +6,8 @@ module Slack
       module Endpoints
         module Stars
           #
-          # Adds a star to an item.
+          # This method adds a star to an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
+          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
           #
           # @option options [channel] :channel
           #   Channel to add star to, or channel where the message to add star to was posted (used with timestamp).
@@ -24,7 +25,7 @@ module Slack
           end
 
           #
-          # Lists stars for a user.
+          # This method lists the items starred by the authed user.
           #
           # @option options [Object] :cursor
           #   Parameter for pagination. Set cursor equal to the next_cursor attribute returned by the previous request's response_metadata. This parameter is optional, but pagination is mandatory: the default value simply fetches the first "page" of the collection. See pagination for more details.
@@ -43,7 +44,8 @@ module Slack
           end
 
           #
-          # Removes a star from an item.
+          # This method removes a star from an item (message, file, file comment, channel, private group, or DM) on behalf of the authenticated user.
+          # One of file, file_comment, channel, or the combination of channel and timestamp must be specified.
           #
           # @option options [channel] :channel
           #   Channel to remove star from, or channel where the message to remove star from was posted (used with timestamp).

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Team
           #
-          # Gets the access logs for the current team.
+          # This method is used to retrieve the "access logs" for users on a workspace.
           #
           # @option options [Object] :before
           #   End of time range of logs to include in results (inclusive).
@@ -17,7 +17,8 @@ module Slack
           end
 
           #
-          # Gets billable users information for the current team.
+          # This method lists billable information for each user on the team. Currently this consists solely of whether the user is
+          # subject to billing per Slack's Fair Billing policy.
           #
           # @option options [user] :user
           #   A user to retrieve the billable information for. Defaults to all users.
@@ -29,7 +30,7 @@ module Slack
           end
 
           #
-          # Gets information about the current team.
+          # This method provides information about your team.
           #
           # @see https://api.slack.com/methods/team.info
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/team/team.info.json
@@ -38,7 +39,7 @@ module Slack
           end
 
           #
-          # Gets the integration logs for the current team.
+          # This method lists the integration activity logs for a team, including when integrations are added, modified and removed. This method can only be called by Admins.
           #
           # @option options [Object] :app_id
           #   Filter logs to this Slack app. Defaults to all logs.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module TeamProfile
           #
-          # Retrieve a team's profile.
+          # This method is used to get the profile field definitions for this team.
           #
           # @option options [Object] :visibility
           #   Filter by visibility.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Usergroups
           #
-          # Create a User Group
+          # This method is used to create a User Group.
           #
           # @option options [Object] :name
           #   A name for the User Group. Must be unique among User Groups.
@@ -26,7 +26,7 @@ module Slack
           end
 
           #
-          # Disable an existing User Group
+          # This method disables an existing User Group.
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to disable.
@@ -40,7 +40,7 @@ module Slack
           end
 
           #
-          # Enable a User Group
+          # This method enables a User Group which was previously disabled.
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to enable.
@@ -54,7 +54,7 @@ module Slack
           end
 
           #
-          # List all User Groups for a team
+          # This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.
           #
           # @option options [Object] :include_count
           #   Include the number of users in each User Group.
@@ -69,7 +69,7 @@ module Slack
           end
 
           #
-          # Update an existing User Group
+          # This method updates the properties of an existing User Group.
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module UsergroupsUsers
           #
-          # List all users in a User Group
+          # This method returns a list of all users within a User Group.
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.
@@ -20,7 +20,7 @@ module Slack
           end
 
           #
-          # Update the list of users for a User Group
+          # 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.
           #
           # @option options [Object] :usergroup
           #   The encoded ID of the User Group to update.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module Users
           #
-          # List conversations the calling user may access.
+          # As part of the Conversations API, this method's required scopes depend on the type of channel-like object you're working with. For classic Slack apps, a corresponding channels: scope is required when working with public channels, groups: for private channels, also the same rules are applied for im: and mpim:. For workspace apps, a conversations: scope is all that's needed.
           #
           # @option options [Object] :cursor
           #   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.
@@ -32,7 +32,7 @@ module Slack
           end
 
           #
-          # Delete the user profile photo
+          # This method allows the user to delete their profile image. It will clear whatever image is currently set.
           #
           # @see https://api.slack.com/methods/users.deletePhoto
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.deletePhoto.json
@@ -41,7 +41,8 @@ module Slack
           end
 
           #
-          # Gets user presence information.
+          # This method lets you find out information about a user's presence.
+          # Consult the presence documentation for more details.
           #
           # @option options [user] :user
           #   User to get presence info on. Defaults to the authed user.
@@ -54,7 +55,7 @@ module Slack
           end
 
           #
-          # Get a user's identity.
+          # After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity.
           #
           # @see https://api.slack.com/methods/users.identity
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.identity.json
@@ -63,7 +64,7 @@ module Slack
           end
 
           #
-          # Gets information about a user.
+          # This method returns information about a member of a workspace.
           #
           # @option options [user] :user
           #   User to get info on.
@@ -78,7 +79,7 @@ module Slack
           end
 
           #
-          # Lists all users in a Slack team.
+          # This method returns a list of all users in the workspace. This includes deleted/deactivated users.
           #
           # @option options [Object] :cursor
           #   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.
@@ -86,8 +87,6 @@ module Slack
           #   Set this to true to receive the locale for users. Defaults to false.
           # @option options [Object] :limit
           #   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.
-          # @option options [Object] :presence
-          #   Deprecated. Whether to include presence data in the output. Defaults to false. Setting this to true reduces performance, especially with large teams.
           # @see https://api.slack.com/methods/users.list
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.list.json
           def users_list(options = {})
@@ -101,7 +100,7 @@ module Slack
           end
 
           #
-          # Find a user with an email address.
+          # Retrieve a single user by looking them up by their registered email address. Requires users:read.email.
           #
           # @option options [Object] :email
           #   An email address belonging to a user in the workspace.
@@ -113,7 +112,7 @@ module Slack
           end
 
           #
-          # Marked a user as active. Deprecated and non-functional.
+          # 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.
           #
           # @see https://api.slack.com/methods/users.setActive
           # @see https://github.com/slack-ruby/slack-api-ref/blob/master/methods/users/users.setActive.json
@@ -122,7 +121,7 @@ module Slack
           end
 
           #
-          # Set the user profile photo
+          # This method allows the user to set their profile image. The caller can pass image data via image.
           #
           # @option options [Object] :image
           #   File contents via multipart/form-data.
@@ -140,7 +139,8 @@ module Slack
           end
 
           #
-          # Manually sets user presence.
+          # This method lets you set the calling user's manual presence.
+          # Consult the presence documentation for more details.
           #
           # @option options [Object] :presence
           #   Either auto or away.

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

@@ -6,7 +6,7 @@ module Slack
       module Endpoints
         module UsersProfile
           #
-          # Retrieves a user's profile information.
+          # Use this method to retrieve a user's profile information.
           #
           # @option options [Object] :include_labels
           #   Include labels for each ID in custom profile fields.
@@ -20,7 +20,7 @@ module Slack
           end
 
           #
-          # Set the profile information for a user.
+          # Use this method to set a user's profile information, including name, email, current status, and other attributes.
           #
           # @option options [Object] :name
           #   Name of a single key to set. Usable only if profile is not passed.

data/spec/integration/integration_spec.rb

@@ -19,8 +19,6 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     Slack.configure do |slack|
       slack.logger = logger
     end
-
-    @queue = QueueWithTimeout.new
   end
 
   after do
@@ -29,38 +27,41 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
   let(:client) { Slack::RealTime::Client.new(token: ENV['SLACK_API_TOKEN']) }
 
-  let(:queue) { @queue }
-
-  def start
-    # starts the client and pushes an item on a queue when connected
-    client.start_async do |driver|
-      driver.on :open do |data|
-        logger.debug "connection.on :open, data=#{data}"
-        queue.push nil
-      end
-    end
-  end
+  let!(:queue) { @queue = QueueWithTimeout.new }
 
   before do
     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."
     end
 
+    client.on :message do |event|
+      logger.info " #{event.class}"
+    end
+
     client.on :close do
       logger.info 'Disconnecting ...'
       # pushes another item to the queue when disconnected
-      queue.push nil if @queue
+      queue.push :closed
     end
   end
 
   def start_server
-    dt = rand(2..6)
+    dt = rand(10..20)
     logger.debug "#start_server, waiting #{dt} second(s)"
     sleep dt # prevent Slack 429 rate limit errors
-    # start server and wait for on :open
-    @server = start
+    # starts the client and pushes an item on a queue when connected
+    @server = client.start_async do |driver|
+      driver.on :open do |data|
+        logger.debug "connection.on :open, data=#{data}"
+        queue.push :opened
+      end
+
+      driver.on :hello do |data|
+        logger.debug "connection.on :hello, data=#{data}"
+      end
+    end
     logger.debug "started #{@server}"
-    queue.pop_with_timeout(5)
+    expect(queue.pop_with_timeout(5)).to eq :opened
   end
 
   def wait_for_server
@@ -72,27 +73,16 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     @queue = nil
   end
 
-  def stop_server
-    logger.debug '#stop_server'
-    client.stop!
-    logger.debug '#stop_server, stopped'
-  end
-
   after do
-    wait_for_server
+    wait_for_server # wait for :closed to be pushed on queue
     @server.join if @server.is_a?(::Thread)
   end
 
   context 'client connected' do
-    before do
-      start_server
-    end
-
     let(:channel) { "@#{client.self.id}" }
+    let(:message) { SecureRandom.hex }
 
     it 'responds to message' do
-      message = SecureRandom.hex
-
       client.on :message do |data|
         logger.debug data
         # concurrent execution of tests causes messages to arrive in any order
@@ -105,13 +95,19 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
         client.stop!
       end
 
+      start_server
+
       logger.debug "chat_postMessage, channel=#{channel}, message=#{message}"
       client.web_client.chat_postMessage channel: channel, text: message
     end
 
     it 'sends message' do
-      client.message(channel: channel, text: 'Hello world!')
-      client.stop!
+      client.on :hello do
+        expect(client.message(channel: channel, text: message)).to be true
+        client.stop!
+      end
+
+      start_server
     end
   end
 
@@ -127,19 +123,23 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
 
   context 'with websocket_ping set' do
     before do
-      client.websocket_ping = 2
+      client.websocket_ping = 1
     end
+
     it 'sends pings' do
       @reply_to = nil
       client.on :pong do |data|
         @reply_to = data.reply_to
-        queue.push nil
+        queue.push :pong
         client.stop!
       end
+
       start_server
+
       queue.pop_with_timeout(5)
       expect(@reply_to).to be 1
     end
+
     it 'rebuilds the websocket connection when dropped' do
       @reply_to = nil
       client.on :pong do |data|
@@ -148,11 +148,13 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
           client.instance_variable_get(:@socket).close
         else
           expect(@reply_to).to be 2
-          queue.push nil
+          queue.push :pong
           client.stop!
         end
       end
+
       start_server
+
       queue.pop_with_timeout(10)
       queue.pop_with_timeout(10)
     end
@@ -162,16 +164,21 @@ RSpec.describe 'integration test', skip: (!ENV['SLACK_API_TOKEN'] || !ENV['CONCU
     before do
       client.websocket_ping = 0
     end
+
     it 'does not send pings' do
       @reply_to = nil
+
       client.on :pong do |data|
         @reply_to = data.reply_to
       end
+
       client.on :hello do
         client.stop!
       end
+
       start_server
       wait_for_server
+
       expect(@reply_to).to be nil
     end
   end