slack-ruby-client 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0aaadcdcd3f329bb20548b8041a631bb8a28519
-  data.tar.gz: 27a9e84d26d1934ee603972453f370102554cdce
+  metadata.gz: 98b81ae4b6471c6f769605ec94413778475e2867
+  data.tar.gz: 3f4a212131fbc5042d5eea7399606521ceafef97
 SHA512:
-  metadata.gz: a26e4b6f75a481faa9ff2c2b1d45a0f6922aca6784fa88f0f5772a8ad24df56676cc694e595a7fbdeb6a21fdfcb7a74ed0d9c5b5a54cb76b6b5a8747fcf8490f
-  data.tar.gz: 70c7e4981a819f91e425a4ba19a1769aad0f5260b0b15a8a2b55085eea824bee75c50e18845e89e91265cbdc4b72e91aa34bb2592629a2b7047639ba988d6dbc
+  metadata.gz: 56dff3761a755c63dccb02156317ba099f0e892be2152a3743bae95e04245c272cc55f42dad3d54d635d9e95f4347184fa4dc2a775e8c1e5e638778d71c8e71e
+  data.tar.gz: cf2ce35d6963d68b4c210eb852fe61f51cc9b0933b289fd000142ebfd3278b70dc07aa971da5e448e53ab1b63c00a6cec78a2e11533ecb3ea1be0bffc7550e97

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-02-29 14:50:42 -0500 using RuboCop version 0.35.0.
+# on 2016-05-02 08:01:33 -0400 using RuboCop version 0.35.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -21,34 +21,34 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/slack/messages/formatting.rb'
 
-# Offense count: 14
+# Offense count: 15
 Metrics/AbcSize:
   Max: 44
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 159
+  Max: 155
 
-# Offense count: 1
+# Offense count: 2
 Metrics/CyclomaticComplexity:
   Max: 9
 
-# Offense count: 542
+# Offense count: 571
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 288
 
-# Offense count: 8
+# Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 32
 
-# Offense count: 1
+# Offense count: 2
 Metrics/PerceivedComplexity:
   Max: 11
 
-# Offense count: 52
+# Offense count: 54
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -59,7 +59,7 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 92
+# Offense count: 95
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.7.1 (5/2/2016)
+
+* [#82](https://github.com/dblock/slack-ruby-client/pull/82): Fix `usergroups.users.{list,update}` and `files.comments.{add,edit,delete}` APIs - [@masatomo](https://github.com/masatomo).
+* [#73](https://github.com/dblock/slack-ruby-client/issues/73): Add a `closed` event - [@rkadyb](https://github.com/rkadyb).
+* [#69](https://github.com/dblock/slack-ruby-client/issues/69): Add attachments support for `Slack::Web::Api::Endpoints::Chat.chat_update` - [@nicka](https://github.com/nicka).
+* [#85](https://github.com/dblock/slack-ruby-client/issues/85): Compatibility with WebMock 2.0 - [@dblock](https://github.com/dblock).
+* Added `as_user` to `chat_delete` Web API - [@dblock](https://github.com/dblock).
+* Added `reminders_add`, `reminders_complete`, `reminders_delete`, `reminders_info` and `reminders_list` to Web API - [@dblock](https://github.com/dblock).
+
 ### 0.7.0 (3/6/2016)
 
 * [#68](https://github.com/dblock/slack-ruby-client/issues/68): The `Slack::RealTime::Config#store_class` is now globally configurable - [@dblock](https://github.com/dblock).
@@ -91,4 +100,3 @@
 ### 0.1.0 (7/25/2015)
 
 * Initial public release with Web and RealTime Messaging API support - [@dblock](https://github.com/dblock).
-

data/README.md

@@ -18,7 +18,7 @@ A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messa
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-client, 0.7.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.7.1. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -194,6 +194,14 @@ client.on :message do |data|
   end
 end
 
+client.on :close do |_data|
+  puts "Client is about to disconnect"
+end
+
+client.on :closed do |_data|
+  puts "Client has disconnected successfully!"
+end
+
 client.start!
 ```
 

data/bin/commands/chat.rb

@@ -7,6 +7,7 @@ command 'chat' do |g|
   g.command 'delete' do |c|
     c.flag 'ts', desc: 'Timestamp of the message to be deleted.'
     c.flag 'channel', desc: 'Channel containing the message to be deleted.'
+    c.flag 'as_user', desc: 'Pass true to delete the message as the authed user. Bot users in this context are considered authed users.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.chat_delete(options))
     end

data/bin/commands/files.rb

@@ -2,17 +2,6 @@
 
 desc 'Get info on files uploaded to Slack, upload new files to Slack.'
 command 'files' do |g|
-  g.desc '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.'
-  g.long_desc %( 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. )
-  g.command 'comments' do |c|
-    c.flag 'file', desc: 'File containing the comment to edit.'
-    c.flag 'id', desc: 'The comment to edit.'
-    c.flag 'comment', desc: 'Text of the comment to edit.'
-    c.action do |_global_options, options, _args|
-      puts JSON.dump($client.files_comments(options))
-    end
-  end
-
   g.desc 'This method deletes a file from your team.'
   g.long_desc %( This method deletes a file from your team. )
   g.command 'delete' do |c|
@@ -77,9 +66,9 @@ You can pass multiple values in the types argument, like types=posts,snippets.Th
   g.desc 'This method allows you to create or upload an existing file.'
   g.long_desc %( This method allows you to create or upload an existing file. )
   g.command 'upload' do |c|
-    c.flag 'file', desc: 'File contents via multipart/form-data.'
-    c.flag 'content', desc: 'File contents via a POST var.'
-    c.flag 'filetype', desc: 'Slack-internal file type identifier.'
+    c.flag 'file', desc: 'File contents via multipart/form-data. If omitting this parameter, you must submit content.'
+    c.flag 'content', desc: 'File contents via a POST variable. If omitting this parameter, you must provide a file.'
+    c.flag 'filetype', desc: 'A file type identifier.'
     c.flag 'filename', desc: 'Filename of file.'
     c.flag 'title', desc: 'Title of file.'
     c.flag 'initial_comment', desc: 'Initial comment to add to file.'

data/bin/commands/files_comments.rb

@@ -0,0 +1,35 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'FilesComments methods.'
+command 'files_comments' do |g|
+  g.desc 'Add a comment to an existing file.'
+  g.long_desc %( Add a comment to an existing file. )
+  g.command 'add' do |c|
+    c.flag 'file', desc: 'File to add a comment to.'
+    c.flag 'comment', desc: 'Text of the comment to add.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_comments_add(options))
+    end
+  end
+
+  g.desc 'Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment.'
+  g.long_desc %( Delete an existing comment on a file. Only the original author of the comment or a Team Administrator may delete a file comment. )
+  g.command 'delete' do |c|
+    c.flag 'file', desc: 'File to delete a comment from.'
+    c.flag 'id', desc: 'The comment to delete.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_comments_delete(options))
+    end
+  end
+
+  g.desc '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.'
+  g.long_desc %( 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. )
+  g.command 'edit' do |c|
+    c.flag 'file', desc: 'File containing the comment to edit.'
+    c.flag 'id', desc: 'The comment to edit.'
+    c.flag 'comment', desc: 'Text of the comment to edit.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_comments_edit(options))
+    end
+  end
+end

data/bin/commands/reminders.rb

@@ -0,0 +1,50 @@
+# This file was auto-generated by lib/tasks/web.rake
+
+desc 'Reminders methods.'
+command 'reminders' do |g|
+  g.desc 'This method creates a reminder.'
+  g.long_desc %( This method creates a reminder. )
+  g.command 'add' do |c|
+    c.flag 'text', desc: 'The content of the reminder.'
+    c.flag 'time', desc: '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").'
+    c.flag 'user', desc: 'The user who will receive the reminder. If no user is specified, the reminder will go to user who created it.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.reminders_add(options))
+    end
+  end
+
+  g.desc 'This method completes a reminder.'
+  g.long_desc %( This method completes a reminder. )
+  g.command 'complete' do |c|
+    c.flag 'reminder', desc: 'The ID of the reminder to be marked as complete.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.reminders_complete(options))
+    end
+  end
+
+  g.desc 'This method deletes a reminder.'
+  g.long_desc %( This method deletes a reminder. )
+  g.command 'delete' do |c|
+    c.flag 'reminder', desc: 'The ID of the reminder.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.reminders_delete(options))
+    end
+  end
+
+  g.desc 'This method returns information about a reminder.'
+  g.long_desc %( This method returns information about a reminder. )
+  g.command 'info' do |c|
+    c.flag 'reminder', desc: 'The ID of the reminder.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.reminders_info(options))
+    end
+  end
+
+  g.desc 'This method lists all reminders created by or for a given user.'
+  g.long_desc %( This method lists all reminders created by or for a given user. )
+  g.command 'list' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.reminders_list(options))
+    end
+  end
+end

data/bin/commands/usergroups.rb

@@ -1,73 +1,62 @@
 # This file was auto-generated by lib/tasks/web.rake
 
-desc "Get info on your team's user groups."
+desc "Get info on your team's User Groups."
 command 'usergroups' do |g|
-  g.desc 'This method is used to create a user group.'
-  g.long_desc %( This method is used to create a user group. )
+  g.desc 'This method is used to create a User Group.'
+  g.long_desc %( This method is used to create a User Group. )
   g.command 'create' do |c|
-    c.flag 'name', desc: 'A name for the user group. Must be unique among user groups.'
-    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and user groups.'
-    c.flag 'description', desc: 'A short description of the user group.'
-    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the user group uses as a default.'
-    c.flag 'include_count', desc: 'Include the number of users in each user group.'
+    c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
+    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
+    c.flag 'description', desc: 'A short description of the User Group.'
+    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
+    c.flag 'include_count', desc: 'Include the number of users in each User Group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_create(options))
     end
   end
 
-  g.desc 'This method disables an existing user group.'
-  g.long_desc %( This method disables an existing user group. )
+  g.desc 'This method disables an existing User Group.'
+  g.long_desc %( This method disables an existing User Group. )
   g.command 'disable' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the user group to disable.'
-    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.flag 'usergroup', desc: 'The encoded ID of the User Group to disable.'
+    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_disable(options))
     end
   end
 
-  g.desc 'This method enables a user group which was previously disabled.'
-  g.long_desc %( This method enables a user group which was previously disabled. )
+  g.desc 'This method enables a User Group which was previously disabled.'
+  g.long_desc %( This method enables a User Group which was previously disabled. )
   g.command 'enable' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the user group to enable.'
-    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.flag 'usergroup', desc: 'The encoded ID of the User Group to enable.'
+    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_enable(options))
     end
   end
 
-  g.desc 'This method returns a list of all user groups in the team. This can optionally include disabled user groups.'
-  g.long_desc %( This method returns a list of all user groups in the team. This can optionally include disabled user groups. )
+  g.desc 'This method returns a list of all User Groups in the team. This can optionally include disabled User Groups.'
+  g.long_desc %( This method returns a list of all User Groups in the team. This can optionally include disabled User Groups. )
   g.command 'list' do |c|
-    c.flag 'include_disabled', desc: 'Include disabled user groups.'
-    c.flag 'include_count', desc: 'Include the number of users in each user group.'
-    c.flag 'include_users', desc: 'Include the list of users for each user group.'
+    c.flag 'include_disabled', desc: 'Include disabled User Groups.'
+    c.flag 'include_count', desc: 'Include the number of users in each User Group.'
+    c.flag 'include_users', desc: 'Include the list of users for each User Group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_list(options))
     end
   end
 
-  g.desc 'This method updates the properties of an existing user group.'
-  g.long_desc %( This method updates the properties of an existing user group. )
+  g.desc 'This method updates the properties of an existing User Group.'
+  g.long_desc %( This method updates the properties of an existing User Group. )
   g.command 'update' do |c|
-    c.flag 'usergroup', desc: 'The encoded ID of the user group to update.'
-    c.flag 'name', desc: 'A name for the user group. Must be unique among user groups.'
-    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and user groups.'
-    c.flag 'description', desc: 'A short description of the user group.'
-    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the user group uses as a default.'
-    c.flag 'include_count', desc: 'Include the number of users in the user group.'
+    c.flag 'usergroup', desc: 'The encoded ID of the User Group to update.'
+    c.flag 'name', desc: 'A name for the User Group. Must be unique among User Groups.'
+    c.flag 'handle', desc: 'A mention handle. Must be unique among channels, users and User Groups.'
+    c.flag 'description', desc: 'A short description of the User Group.'
+    c.flag 'channels', desc: 'A comma separated string of encoded channel IDs for which the User Group uses as a default.'
+    c.flag 'include_count', desc: 'Include the number of users in the User Group.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.usergroups_update(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.command 'users' 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.action do |_global_options, options, _args|
-      puts JSON.dump($client.usergroups_users(options))
-    end
-  end
 end

data/bin/commands/usergroups_users.rb

@@ -0,0 +1,25 @@
+# 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.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.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.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.action do |_global_options, options, _args|
+      puts JSON.dump($client.usergroups_users_update(options))
+    end
+  end
+end

data/bin/commands.rb

@@ -6,6 +6,7 @@ require 'commands/channels'
 require 'commands/chat'
 require 'commands/dnd'
 require 'commands/emoji'
+require 'commands/files_comments'
 require 'commands/files'
 require 'commands/groups'
 require 'commands/im'
@@ -13,9 +14,11 @@ require 'commands/mpim'
 require 'commands/oauth'
 require 'commands/pins'
 require 'commands/reactions'
+require 'commands/reminders'
 require 'commands/rtm'
 require 'commands/search'
 require 'commands/stars'
 require 'commands/team'
 require 'commands/usergroups'
+require 'commands/usergroups_users'
 require 'commands/users'

data/bin/slack

@@ -16,7 +16,7 @@ flag ['vcr-cassette-name'], desc: 'Offline VCR cassette.'
 pre do |global_options, _command, options, _args|
   # global Slack configuration
   Slack.config.token = global_options['slack-api-token']
-  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && Slack.config.token.length > 0
+  help_now! 'Set Slack API token via --slack-api-token or SLACK_API_TOKEN.' unless Slack.config.token && !Slack.config.token.empty?
 
   if global_options['debug']
     require 'logger'
@@ -29,6 +29,8 @@ pre do |global_options, _command, options, _args|
 
   # Offline VCR cassette
   if global_options['vcr-cassette-name']
+    require 'webmock'
+    WebMock.enable!
     require 'vcr'
     VCR.configure do |config|
       config.cassette_library_dir = 'spec/fixtures/slack'

data/examples/hi_real_time/hi.rb

@@ -27,8 +27,12 @@ client.on :message do |data|
 end
 
 client.on :close do |_data|
-  puts 'Connection closed, exiting.'
+  puts 'Connection closing, exiting.'
   EM.stop
 end
 
+client.on :closed do |_data|
+  puts 'Connection has been disconnected.'
+end
+
 client.start!

data/lib/slack/real_time/client.rb

@@ -119,6 +119,7 @@ module Slack
             logger.debug("#{self.class}##{__method__}") { event.class.name }
             callback(event, :close)
             close(event)
+            callback(event, :closed)
           end
         end
       end

data/lib/slack/real_time/config.rb

@@ -13,7 +13,7 @@ module Slack
         :start_options,
         :store_class,
         :logger
-      ]
+      ].freeze
 
       attr_accessor(*Config::ATTRIBUTES)