slack-ruby-client 0.7.0 → 0.7.1

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'.freeze
 end

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

@@ -12,6 +12,8 @@ module Slack
           #   Timestamp of the message to be deleted.
           # @option options [channel] :channel
           #   Channel containing 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 = {})
@@ -82,8 +84,14 @@ module Slack
           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 missing') if options[:text].nil?
+            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].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)
+              attachments = options[:attachments]
+              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
+              options = options.merge(attachments: attachments)
+            end
             post('chat.update', options)
           end
         end

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

@@ -5,24 +5,6 @@ module Slack
     module Api
       module Endpoints
         module Files
-          #
-          # Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.
-          #
-          # @option options [file] :file
-          #   File containing the comment to edit.
-          # @option options [Object] :id
-          #   The comment to edit.
-          # @option options [Object] :comment
-          #   Text of the comment to edit.
-          # @see https://api.slack.com/methods/files.comments
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files/files.comments.json
-          def files_comments(options = {})
-            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
-            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
-            throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
-            post('files.comments', options)
-          end
-
           #
           # This method deletes a file from your team.
           #
@@ -108,11 +90,11 @@ module Slack
           # This method allows you to create or upload an existing file.
           #
           # @option options [file] :file
-          #   File contents via multipart/form-data.
+          #   File contents via multipart/form-data. If omitting this parameter, you must submit content.
           # @option options [Object] :content
-          #   File contents via a POST var.
+          #   File contents via a POST variable. If omitting this parameter, you must provide a file.
           # @option options [Object] :filetype
-          #   Slack-internal file type identifier.
+          #   A file type identifier.
           # @option options [Object] :filename
           #   Filename of file.
           # @option options [Object] :title
@@ -124,7 +106,6 @@ module Slack
           # @see https://api.slack.com/methods/files.upload
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files/files.upload.json
           def files_upload(options = {})
-            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             throw ArgumentError.new('Required arguments :filename missing') if options[:filename].nil?
             post('files.upload', options)
           end

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

@@ -0,0 +1,59 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module FilesComments
+          #
+          # Add a comment to an existing file.
+          #
+          # @option options [file] :file
+          #   File to add a comment to.
+          # @option options [Object] :comment
+          #   Text of the comment to add.
+          # @see https://api.slack.com/methods/files.comments.add
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.add.json
+          def files_comments_add(options = {})
+            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
+            throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
+            post('files.comments.add', options)
+          end
+
+          #
+          # Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.
+          #
+          # @option options [file] :file
+          #   File to delete a comment from.
+          # @option options [Object] :id
+          #   The comment to delete.
+          # @see https://api.slack.com/methods/files.comments.delete
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.delete.json
+          def files_comments_delete(options = {})
+            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            post('files.comments.delete', options)
+          end
+
+          #
+          # Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.
+          #
+          # @option options [file] :file
+          #   File containing the comment to edit.
+          # @option options [Object] :id
+          #   The comment to edit.
+          # @option options [Object] :comment
+          #   Text of the comment to edit.
+          # @see https://api.slack.com/methods/files.comments.edit
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.edit.json
+          def files_comments_edit(options = {})
+            throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
+            throw ArgumentError.new('Required arguments :id missing') if options[:id].nil?
+            throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
+            post('files.comments.edit', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Reminders
+          #
+          # This method creates a reminder.
+          #
+          # @option options [Object] :text
+          #   The content of the reminder.
+          # @option options [Object] :time
+          #   When this reminder should happen: the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. "in 15 minutes," or "every Thursday").
+          # @option options [user] :user
+          #   The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.
+          # @see https://api.slack.com/methods/reminders.add
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.add.json
+          def reminders_add(options = {})
+            throw ArgumentError.new('Required arguments :text missing') if options[:text].nil?
+            throw ArgumentError.new('Required arguments :time missing') if options[:time].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
+            post('reminders.add', options)
+          end
+
+          #
+          # This method completes a reminder.
+          #
+          # @option options [Object] :reminder
+          #   The ID of the reminder to be marked as complete.
+          # @see https://api.slack.com/methods/reminders.complete
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.complete.json
+          def reminders_complete(options = {})
+            throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
+            post('reminders.complete', options)
+          end
+
+          #
+          # This method deletes a reminder.
+          #
+          # @option options [Object] :reminder
+          #   The ID of the reminder.
+          # @see https://api.slack.com/methods/reminders.delete
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.delete.json
+          def reminders_delete(options = {})
+            throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
+            post('reminders.delete', options)
+          end
+
+          #
+          # This method returns information about a reminder.
+          #
+          # @option options [Object] :reminder
+          #   The ID of the reminder.
+          # @see https://api.slack.com/methods/reminders.info
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.info.json
+          def reminders_info(options = {})
+            throw ArgumentError.new('Required arguments :reminder missing') if options[:reminder].nil?
+            post('reminders.info', options)
+          end
+
+          #
+          # This method lists all reminders created by or for a given user.
+          #
+          # @see https://api.slack.com/methods/reminders.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reminders/reminders.list.json
+          def reminders_list(options = {})
+            post('reminders.list', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,18 +6,18 @@ module Slack
       module Endpoints
         module Usergroups
           #
-          # This method is used to 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.
+          #   A name for the User Group. Must be unique among User Groups.
           # @option options [Object] :handle
-          #   A mention handle. Must be unique among channels, users and user groups.
+          #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [Object] :description
-          #   A short description of the user group.
+          #   A short description of the User Group.
           # @option options [Object] :channels
-          #   A comma separated string of encoded channel IDs for which the user group uses as a default.
+          #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
           # @option options [Object] :include_count
-          #   Include the number of users in each user group.
+          #   Include the number of users in each User Group.
           # @see https://api.slack.com/methods/usergroups.create
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.create.json
           def usergroups_create(options = {})
@@ -26,12 +26,12 @@ module Slack
           end
 
           #
-          # This method disables an existing user group.
+          # This method disables an existing User Group.
           #
           # @option options [Object] :usergroup
-          #   The encoded ID of the user group to disable.
+          #   The encoded ID of the User Group to disable.
           # @option options [Object] :include_count
-          #   Include the number of users in the user group.
+          #   Include the number of users in the User Group.
           # @see https://api.slack.com/methods/usergroups.disable
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.disable.json
           def usergroups_disable(options = {})
@@ -40,12 +40,12 @@ module Slack
           end
 
           #
-          # This method enables a user group which was previously disabled.
+          # This method enables a User Group which was previously disabled.
           #
           # @option options [Object] :usergroup
-          #   The encoded ID of the user group to enable.
+          #   The encoded ID of the User Group to enable.
           # @option options [Object] :include_count
-          #   Include the number of users in the user group.
+          #   Include the number of users in the User Group.
           # @see https://api.slack.com/methods/usergroups.enable
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.enable.json
           def usergroups_enable(options = {})
@@ -54,14 +54,14 @@ module Slack
           end
 
           #
-          # This method returns a list of all user groups in the team. This can optionally include disabled user groups.
+          # This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.
           #
           # @option options [Object] :include_disabled
-          #   Include disabled user groups.
+          #   Include disabled User Groups.
           # @option options [Object] :include_count
-          #   Include the number of users in each user group.
+          #   Include the number of users in each User Group.
           # @option options [Object] :include_users
-          #   Include the list of users for each user group.
+          #   Include the list of users for each User Group.
           # @see https://api.slack.com/methods/usergroups.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.list.json
           def usergroups_list(options = {})
@@ -69,43 +69,26 @@ module Slack
           end
 
           #
-          # This method updates the properties of 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.
+          #   The encoded ID of the User Group to update.
           # @option options [Object] :name
-          #   A name for the user group. Must be unique among user groups.
+          #   A name for the User Group. Must be unique among User Groups.
           # @option options [Object] :handle
-          #   A mention handle. Must be unique among channels, users and user groups.
+          #   A mention handle. Must be unique among channels, users and User Groups.
           # @option options [Object] :description
-          #   A short description of the user group.
+          #   A short description of the User Group.
           # @option options [Object] :channels
-          #   A comma separated string of encoded channel IDs for which the user group uses as a default.
+          #   A comma separated string of encoded channel IDs for which the User Group uses as a default.
           # @option options [Object] :include_count
-          #   Include the number of users in the user group.
+          #   Include the number of users in the User Group.
           # @see https://api.slack.com/methods/usergroups.update
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.update.json
           def usergroups_update(options = {})
             throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
             post('usergroups.update', options)
           end
-
-          #
-          # 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.
-          # @option options [Object] :users
-          #   A comma separated string of encoded user IDs that represent the entire list of users for the user group.
-          # @option options [Object] :include_count
-          #   Include the number of users in the user group.
-          # @see https://api.slack.com/methods/usergroups.users
-          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups/usergroups.users.json
-          def usergroups_users(options = {})
-            throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
-            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
-            post('usergroups.users', options)
-          end
         end
       end
     end

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

@@ -0,0 +1,42 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module UsergroupsUsers
+          #
+          # 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.
+          # @option options [Object] :include_disabled
+          #   Allow results that involve disabled User Groups.
+          # @see https://api.slack.com/methods/usergroups.users.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.list.json
+          def usergroups_users_list(options = {})
+            throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
+            post('usergroups.users.list', options)
+          end
+
+          #
+          # 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.
+          # @option options [Object] :users
+          #   A comma separated string of encoded user IDs that represent the entire list of users for the User Group.
+          # @option options [Object] :include_count
+          #   Include the number of users in the User Group.
+          # @see https://api.slack.com/methods/usergroups.users.update
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/usergroups.users/usergroups.users.update.json
+          def usergroups_users_update(options = {})
+            throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
+            throw ArgumentError.new('Required arguments :users missing') if options[:users].nil?
+            post('usergroups.users.update', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ require 'slack/web/api/endpoints/channels'
 require 'slack/web/api/endpoints/chat'
 require 'slack/web/api/endpoints/dnd'
 require 'slack/web/api/endpoints/emoji'
+require 'slack/web/api/endpoints/files_comments'
 require 'slack/web/api/endpoints/files'
 require 'slack/web/api/endpoints/groups'
 require 'slack/web/api/endpoints/im'
@@ -13,11 +14,13 @@ require 'slack/web/api/endpoints/mpim'
 require 'slack/web/api/endpoints/oauth'
 require 'slack/web/api/endpoints/pins'
 require 'slack/web/api/endpoints/reactions'
+require 'slack/web/api/endpoints/reminders'
 require 'slack/web/api/endpoints/rtm'
 require 'slack/web/api/endpoints/search'
 require 'slack/web/api/endpoints/stars'
 require 'slack/web/api/endpoints/team'
 require 'slack/web/api/endpoints/usergroups'
+require 'slack/web/api/endpoints/usergroups_users'
 require 'slack/web/api/endpoints/users'
 
 module Slack
@@ -34,6 +37,7 @@ module Slack
         include Chat
         include Dnd
         include Emoji
+        include FilesComments
         include Files
         include Groups
         include Im
@@ -41,11 +45,13 @@ module Slack
         include Oauth
         include Pins
         include Reactions
+        include Reminders
         include Rtm
         include Search
         include Stars
         include Team
         include Usergroups
+        include UsergroupsUsers
         include Users
       end
     end

data/lib/slack/web/api/patches/chat.3.update-attachments-support.patch

@@ -0,0 +1,20 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index 0db7e67..1c3b2ee 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -82,8 +82,14 @@ module Slack
+           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 missing') if options[:text].nil?
++            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].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)
++              attachments = options[:attachments]
++              attachments = JSON.dump(attachments) unless attachments.is_a?(String)
++              options = options.merge(attachments: attachments)
++            end
+             post('chat.update', options)
+           end
+         end