slack-ruby-client 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f97d44d55767e0fbbe09b77361f94b2893283192
-  data.tar.gz: bfec69bffc973d6895feac2b74d1ed330374dd79
+  metadata.gz: b77bc84985aeaa9109f41148ebfc2ef720c55232
+  data.tar.gz: b6a097a441ec9255f3b1b062bceca5b29888fd34
 SHA512:
-  metadata.gz: cd2c5f47750c4adda9439145cc2e84cb13f78e0b73f48ac0ddd6e4b5489b16e32b392858d73fb15a85c2aee71fce394103072afa12c4b6d7edacc3b398bbb247
-  data.tar.gz: c307c1cab8e48397597947aca5c70db67d3a2986893d5e3628f4f2442fb6e59baf503a3208ebf9ae66a9c5481a28477efae7795a767602a06e81082a7895c585
+  metadata.gz: b6f08da6827379462c86c589af7b4dd38b108b14a31d537bf740c727f16830d76ef982fd69ef6e573b26be8ebdeefe05d74eee7bfbebebc6a3814b965829c43c
+  data.tar.gz: 6b0f320fa1985a987e54f793d61463ad2780771db8871a8848140e912cc5f5fc817213a8885f80fc7e08ca10db81b17890a785e2e0223f28e6fe655293865717

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-01-08 09:24:26 -0500 using RuboCop version 0.35.0.
+# on 2016-01-22 14:19:14 -0500 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
@@ -20,16 +20,20 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/slack/messages/formatting.rb'
 
-# Offense count: 2
+# Offense count: 7
 Metrics/AbcSize:
-  Max: 20
+  Max: 22
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 112
 
-# Offense count: 380
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+# Offense count: 438
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 288
@@ -39,7 +43,7 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 15
 
-# Offense count: 44
+# Offense count: 46
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -50,7 +54,7 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 85
+# Offense count: 86
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.5.4 (1/23/2016)
+
+* [#45](https://github.com/dblock/slack-ruby-client/issues/45): Added `channels_id`, `groups_id` and `users_id` - [@dblock](https://github.com/dblock).
+* [#45](https://github.com/dblock/slack-ruby-client/issues/45): Automatically lookup channel, group and user ID in Web API methods when Slack API doesn't accept #channel or @user names - [@dblock](https://github.com/dblock).
+* [#49](https://github.com/dblock/slack-ruby-client/pull/49): Fix: Celluloid `#connected?` method. - [@mikz](https://github.com/mikz), [@kandadaboggu](https://github.com/kandadaboggu).
+
 ### 0.5.3 (1/11/2016)
 
 * [#47](https://github.com/dblock/slack-ruby-client/pull/47): Fix: default to Celluloid newer API - [@jlyonsmith](https://github.com/jlyonsmith), [@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.5.3. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.5.4. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -103,6 +103,30 @@ client.files_upload(
 )
 ```
 
+### Get Channel Info
+
+You can use a channel ID or name (prefixed with `#`) in all functions that take a `:channel` argument. Lookup by name is not supported by the Slack API and the `channels_id` method called invokes `channels_list` in order to locate the channel ID.
+
+```ruby
+client.channels_info(channel: 'C04KB5X4D') # calls channels_info
+```
+
+```ruby
+client.channels_info(channel: '#general') # calls channels_list followed by channels_info
+```
+
+### Get User Info
+
+You can use a user ID or name (prefixed with `@`) in all functions that take a `:user` argument. Lookup by name is not supported by the Slack API and the `users_id` method called invokes `users_list` in order to locate the user ID.
+
+```ruby
+client.users_info(user: 'U092BDCLV') # calls users_info
+```
+
+```ruby
+client.users_info(user: '@dblock') # calls users_list followed by users_info
+```
+
 #### Other
 
 Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for the list of all available functions.
@@ -207,7 +231,7 @@ See a fullly working example in [examples/hi_real_time](examples/hi_real_time/hi
 
 ![](examples/hi_real_time/hi.gif)
 
-### Combinging RealTime and Web Clients
+### Combining RealTime and Web Clients
 
 Since the Web client is used to obtain the RealTime client's WebSocket URL, you can continue using the Web client in combination with the RealTime client.
 
@@ -314,6 +338,20 @@ $ slack chat postMessage --text="hello world" --channel="#general"
 {"ok":true,"channel":"...","ts":"...","message":{"text":"hello world","username":"bot","type":"message","subtype":"bot_message","ts":"..."}}
 ```
 
+#### Get Channel Id
+
+```
+$ slack channels id --channel=#general
+{"ok":true,"channel":{"id":"C04KB5X4D"}}
+```
+
+#### Get Channel Info
+
+```
+$ slack channels info --channel=#general
+{"ok":true,"channel":{"id":"C04KB5X4D","name":"general", ...}}
+```
+
 #### List Users
 
 Combine with [jq](http://stedolan.github.io/jq), a command-line JSON parser.

data/bin/commands/channels.rb

@@ -137,4 +137,13 @@ command 'channels' do |g|
       puts JSON.dump($client.channels_unarchive(options))
     end
   end
+
+  g.desc 'This method returns the ID of a team channel.'
+  g.long_desc %( This method returns the ID of a team channel. )
+  g.command 'id' do |c|
+    c.flag 'channel', desc: 'Channel to get ID for, prefixed with #.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_id(options))
+    end
+  end
 end

data/bin/commands/groups.rb

@@ -155,4 +155,13 @@ command 'groups' do |g|
       puts JSON.dump($client.groups_unarchive(options))
     end
   end
+
+  g.desc 'This method returns the ID of a group.'
+  g.long_desc %( This method returns the ID of a group. )
+  g.command 'id' do |c|
+    c.flag 'channel', desc: 'Group channel to get ID for, prefixed with #.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.groups_id(options))
+    end
+  end
 end

data/bin/commands/users.rb

@@ -45,4 +45,13 @@ command 'users' do |g|
       puts JSON.dump($client.users_setPresence(options))
     end
   end
+
+  g.desc 'This method returns the ID of a team user.'
+  g.long_desc %( This method returns the ID of a team user. )
+  g.command 'id' do |c|
+    c.flag 'user', desc: 'User to get ID for, prefixed with @.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_id(options))
+    end
+  end
 end

data/examples/hi_real_time/hi.rb

@@ -24,4 +24,9 @@ client.on :message do |data|
   end
 end
 
+client.on :close do |_data|
+  puts 'Connection closed, exiting.'
+  EM.stop
+end
+
 client.start!

data/lib/slack-ruby-client.rb

@@ -14,6 +14,7 @@ require 'slack/web/api/error'
 require 'slack/web/faraday/response/raise_error'
 require 'slack/web/faraday/connection'
 require 'slack/web/faraday/request'
+require 'slack/web/api/mixins'
 require 'slack/web/api/endpoints'
 require 'slack/web/client'
 

data/lib/slack/real_time/concurrency/celluloid.rb

@@ -50,6 +50,10 @@ module Slack
             Actor.new(future)
           end
 
+          def connected?
+            !@connected.nil?
+          end
+
           protected
 
           class Actor
@@ -64,10 +68,6 @@ module Slack
             end
           end
 
-          def connected?
-            !@connected.nil?
-          end
-
           def build_socket
             socket = TCPSocket.new(addr, port)
             socket = SSLSocket.new(socket, build_ssl_context) if secure?

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.5.3'
+  VERSION = '0.5.4'
 end

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

@@ -24,6 +24,10 @@ module Slack
   module Web
     module Api
       module Endpoints
+        include Slack::Web::Api::Mixins::Channels
+        include Slack::Web::Api::Mixins::Users
+        include Slack::Web::Api::Mixins::Groups
+
         include Api
         include Auth
         include Channels

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

@@ -14,6 +14,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.archive.json
           def channels_archive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.archive', options)
           end
 
@@ -48,6 +49,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.history.json
           def channels_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.history', options)
           end
 
@@ -60,6 +62,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.info.json
           def channels_info(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.info', options)
           end
 
@@ -75,6 +78,8 @@ module Slack
           def channels_invite(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('channels.invite', options)
           end
 
@@ -103,6 +108,8 @@ module Slack
           def channels_kick(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('channels.kick', options)
           end
 
@@ -115,6 +122,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.leave.json
           def channels_leave(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.leave', options)
           end
 
@@ -141,6 +149,7 @@ module Slack
           def channels_mark(options = {})
             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('channels.mark', options)
           end
 
@@ -156,6 +165,7 @@ module Slack
           def channels_rename(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.rename', options)
           end
 
@@ -171,6 +181,7 @@ module Slack
           def channels_setPurpose(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.setPurpose', options)
           end
 
@@ -186,6 +197,7 @@ module Slack
           def channels_setTopic(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.setTopic', options)
           end
 
@@ -198,6 +210,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.unarchive.json
           def channels_unarchive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('channels.unarchive', options)
           end
         end

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

@@ -17,6 +17,7 @@ module Slack
           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?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('chat.delete', options)
           end
 
@@ -80,6 +81,7 @@ module Slack
             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?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('chat.update', options)
           end
         end

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

@@ -31,6 +31,7 @@ module Slack
           # @see https://api.slack.com/methods/dnd.info
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/dnd.info.json
           def dnd_info(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('dnd.info', options)
           end
 

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

@@ -73,6 +73,7 @@ module Slack
           # @see https://api.slack.com/methods/files.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.list.json
           def files_list(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('files.list', options)
           end
 

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

@@ -14,6 +14,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.archive.json
           def groups_archive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.archive', options)
           end
 
@@ -26,6 +27,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.close.json
           def groups_close(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.close', options)
           end
 
@@ -50,6 +52,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.createChild.json
           def groups_createChild(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.createChild', options)
           end
 
@@ -72,6 +75,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.history.json
           def groups_history(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.history', options)
           end
 
@@ -84,6 +88,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.info.json
           def groups_info(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.info', options)
           end
 
@@ -99,6 +104,8 @@ module Slack
           def groups_invite(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('groups.invite', options)
           end
 
@@ -114,6 +121,8 @@ module Slack
           def groups_kick(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('groups.kick', options)
           end
 
@@ -126,6 +135,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.leave.json
           def groups_leave(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.leave', options)
           end
 
@@ -153,6 +163,7 @@ module Slack
           def groups_mark(options = {})
             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: groups_id(options)['group']['id']) if options[:channel]
             post('groups.mark', options)
           end
 
@@ -165,6 +176,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.open.json
           def groups_open(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.open', options)
           end
 
@@ -180,6 +192,7 @@ module Slack
           def groups_rename(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.rename', options)
           end
 
@@ -195,6 +208,7 @@ module Slack
           def groups_setPurpose(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :purpose missing') if options[:purpose].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.setPurpose', options)
           end
 
@@ -210,6 +224,7 @@ module Slack
           def groups_setTopic(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
             throw ArgumentError.new('Required arguments :topic missing') if options[:topic].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.setTopic', options)
           end
 
@@ -222,6 +237,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/groups.unarchive.json
           def groups_unarchive(options = {})
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
             post('groups.unarchive', options)
           end
         end