slack-ruby-client 0.5.3 → 0.5.4

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

@@ -14,6 +14,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.close.json
           def im_close(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('im.close', options)
           end
 
@@ -36,6 +37,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.history.json
           def im_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('im.history', options)
           end
 
@@ -60,6 +62,7 @@ module Slack
           def im_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('im.mark', options)
           end
 
@@ -72,6 +75,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/im.open.json
           def im_open(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('im.open', options)
           end
         end

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

@@ -14,6 +14,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim.close.json
           def mpim_close(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('mpim.close', options)
           end
 
@@ -36,6 +37,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/mpim.history.json
           def mpim_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('mpim.history', options)
           end
 
@@ -60,6 +62,7 @@ module Slack
           def mpim_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('mpim.mark', options)
           end
 

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

@@ -21,6 +21,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/pins.add.json
           def pins_add(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('pins.add', options)
           end
 
@@ -33,6 +34,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/pins.list.json
           def pins_list(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('pins.list', options)
           end
 
@@ -52,6 +54,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/pins.remove.json
           def pins_remove(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('pins.remove', options)
           end
         end

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

@@ -23,6 +23,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.add.json
           def reactions_add(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('reactions.add', options)
           end
 
@@ -42,6 +43,7 @@ module Slack
           # @see https://api.slack.com/methods/reactions.get
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.get.json
           def reactions_get(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('reactions.get', options)
           end
 
@@ -55,6 +57,7 @@ module Slack
           # @see https://api.slack.com/methods/reactions.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.list.json
           def reactions_list(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('reactions.list', options)
           end
 
@@ -76,6 +79,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/reactions.remove.json
           def reactions_remove(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('reactions.remove', options)
           end
         end

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

@@ -20,6 +20,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.add
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.add.json
           def stars_add(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('stars.add', options)
           end
 
@@ -31,6 +32,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.list.json
           def stars_list(options = {})
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('stars.list', options)
           end
 
@@ -49,6 +51,7 @@ module Slack
           # @see https://api.slack.com/methods/stars.remove
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.remove.json
           def stars_remove(options = {})
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('stars.remove', options)
           end
         end

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

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

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

@@ -15,6 +15,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.getPresence.json
           def users_getPresence(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.getPresence', options)
           end
 
@@ -27,6 +28,7 @@ module Slack
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.info.json
           def users_info(options = {})
             throw ArgumentError.new('Required arguments :user missing') if options[:user].nil?
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
             post('users.info', options)
           end
 

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

@@ -4,7 +4,7 @@ module Slack
       class Error < ::Faraday::Error
         attr_reader :response
 
-        def initialize(message, response)
+        def initialize(message, response = nil)
           @response = response
           super message
         end

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

@@ -0,0 +1,3 @@
+require 'slack/web/api/mixins/channels.id'
+require 'slack/web/api/mixins/users.id'
+require 'slack/web/api/mixins/groups.id'

data/lib/slack/web/api/mixins/channels.id.json

@@ -0,0 +1,20 @@
+{
+  "mixin": true,
+  "group": "channels",
+  "name": "channels.id",
+  "desc": "This method returns the ID of a team channel.",
+  "args": {
+    "channel": {
+      "required": true,
+      "example": "#general",
+      "desc": "Channel to get ID for, prefixed with #.",
+      "type": "channel"
+    }
+  },
+  "errors": {
+    "channel_not_found": "Value passed for channel was invalid.",
+    "not_authed": "No authentication token provided.",
+    "invalid_auth": "Invalid authentication token.",
+    "account_inactive": "Authentication token is for a deleted user or team."
+  }
+}

data/lib/slack/web/api/mixins/channels.id.rb

@@ -0,0 +1,26 @@
+module Slack
+  module Web
+    module Api
+      module Mixins
+        module Channels
+          #
+          # This method returns a channel ID given a channel name.
+          #
+          # @option options [channel] :channel
+          #   Channel to get ID for, prefixed with #.
+          def channels_id(options = {})
+            name = options[:channel]
+            throw ArgumentError.new('Required arguments :channel missing') if name.nil?
+            return { 'ok' => true, 'channel' => { 'id' => name } } unless name[0] == '#'
+            channels_list.tap do |list|
+              list['channels'].each do |channel|
+                return { 'ok' => true, 'channel' => { 'id' => channel['id'] } } if channel['name'] == name[1..-1]
+              end
+            end
+            fail Slack::Web::Api::Error, 'channel_not_found'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/mixins/groups.id.json

@@ -0,0 +1,20 @@
+{
+  "mixin": true,
+  "group": "groups",
+  "name": "groups.id",
+  "desc": "This method returns the ID of a group.",
+  "args": {
+    "channel": {
+      "required": true,
+      "example": "#general",
+      "desc": "Group channel to get ID for, prefixed with #.",
+      "type": "group"
+    }
+  },
+  "errors": {
+    "channel_not_found": "Value passed for group was invalid.",
+    "not_authed": "No authentication token provided.",
+    "invalid_auth": "Invalid authentication token.",
+    "account_inactive": "Authentication token is for a deleted user or team."
+  }
+}

data/lib/slack/web/api/mixins/groups.id.rb

@@ -0,0 +1,26 @@
+module Slack
+  module Web
+    module Api
+      module Mixins
+        module Groups
+          #
+          # This method returns a group ID given a group name.
+          #
+          # @option options [channel] :channel
+          #   Group channel to get ID for, prefixed with #.
+          def groups_id(options = {})
+            name = options[:channel]
+            throw ArgumentError.new('Required arguments :channel missing') if name.nil?
+            return { 'ok' => true, 'group' => { 'id' => name } } unless name[0] == '#'
+            groups_list.tap do |list|
+              list['groups'].each do |group|
+                return { 'ok' => true, 'group' => { 'id' => group['id'] } } if group['name'] == name[1..-1]
+              end
+            end
+            fail Slack::Web::Api::Error, 'channel_not_found'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/mixins/users.id.json

@@ -0,0 +1,20 @@
+{
+  "mixin": true,
+  "group": "users",
+  "name": "users.id",
+  "desc": "This method returns the ID of a team user.",
+  "args": {
+    "user": {
+      "required": true,
+      "example": "#general",
+      "desc": "User to get ID for, prefixed with @.",
+      "type": "user"
+    }
+  },
+  "errors": {
+    "user_not_found": "Value passed for user was invalid.",
+    "not_authed": "No authentication token provided.",
+    "invalid_auth": "Invalid authentication token.",
+    "account_inactive": "Authentication token is for a deleted user or team."
+  }
+}

data/lib/slack/web/api/mixins/users.id.rb

@@ -0,0 +1,26 @@
+module Slack
+  module Web
+    module Api
+      module Mixins
+        module Users
+          #
+          # This method returns a user ID given a user name.
+          #
+          # @option options [user] :user
+          #   User to get ID for, prefixed with '@'.
+          def users_id(options = {})
+            name = options[:user]
+            throw ArgumentError.new('Required arguments :user missing') if name.nil?
+            return { 'ok' => true, 'user' => { 'id' => name } } unless name[0] == '@'
+            users_list.tap do |list|
+              list['members'].each do |user|
+                return { 'ok' => true, 'user' => { 'id' => user['id'] } } if user['name'] == name[1..-1]
+              end
+            end
+            fail Slack::Web::Api::Error, 'user_not_found'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/slack/web/api/patches/chat.1.text-attachments-required.patch

@@ -10,4 +10,4 @@ index 1f7a8d7..2ec4bed 100644
 +            throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
              post('chat.postMessage', options)
            end
- 
+

data/lib/slack/web/api/tasks/generate.rake

@@ -22,7 +22,10 @@ namespace :slack do
         end
 
         method_schema = JSON.parse(File.read('lib/slack/web/api/schema/method.json'))
-        data = Dir.glob('lib/slack/web/api/slack-api-ref/methods/**/*.json').each_with_object({}) do |path, result|
+        data = [
+          Dir.glob('lib/slack/web/api/slack-api-ref/methods/**/*.json'),
+          Dir.glob('lib/slack/web/api/mixins/**/*.json')
+        ].flatten.each_with_object({}) do |path, result|
           name = File.basename(path, '.json')
           prefix, name = name.split('.')
           result[prefix] ||= {}

data/lib/slack/web/api/templates/endpoints.erb

@@ -8,6 +8,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
+
 <% files.each do |f| %>
         include <%= f.capitalize %>
 <% end %>

data/lib/slack/web/api/templates/method.erb

@@ -6,17 +6,18 @@ module Slack
       module Endpoints
         module <%= group.capitalize %>
 <% names.each_with_index do |(name, data), index| %>
+<% next if data['mixin'] %>
 <% if index > 0 %>
 
 <% end %>
           #
-<% data["desc"].split("\n").each do |line| %>
+<% data['desc'].split("\n").each do |line| %>
           # <%= line %>
 <% end %>
           #
-<% data["args"].each do |arg_name, arg_v| %>
-          # @option options [<%= arg_v["type"] %>] :<%= arg_name %>
-<% arg_v["desc"].lines.each do |l| %>
+<% data['args'].each do |arg_name, arg_v| %>
+          # @option options [<%= arg_v['type'] %>] :<%= arg_name %>
+<% arg_v['desc'].lines.each do |l| %>
 <% if l.strip.length > 0 %>
           #   <%= l.strip %>
 <% else %>
@@ -27,8 +28,16 @@ module Slack
           # @see https://api.slack.com/methods/<%= group %>.<%= name %>
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/<%= group %>.<%= name %>.json
           def <%= group %>_<%= name %>(options = {})
-<% data["args"].select{|k,v| v["required"]}.each do |arg_name, arg_v| %>
+<% data['args'].select{ |k, v| v['required'] }.each do |arg_name, arg_v| %>
             throw ArgumentError.new('Required arguments :<%= arg_name %> missing') if options[:<%= arg_name %>].nil?
+<% end %>
+<% if data['group'] == 'groups' && data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
+            options = options.merge(channel: groups_id(options)['group']['id']) if options[:channel]
+<% elsif data['args']['channel'] && !data['args']['channel']['desc'].include?('Can be an encoded ID, or a name.') %>
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
+<% end %>
+<% if data['args']['user'] %>
+            options = options.merge(user: users_id(options)['user']['id']) if options[:user]
 <% end %>
             post('<%= group %>.<%= name %>', options)
           end

data/spec/fixtures/slack/web/channels_info.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://slack.com/api/channels.list
+    body:
+      encoding: UTF-8
+      string: token=token
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: '{"ok":true,"channels":[{"id":"C04KB5X4D","name":"general","is_channel":true,"created":1430222230,"creator":"U04KB5WQR","is_archived":false,"is_general":true,"is_member":true,"last_read":"1435863302.000026","latest":{"type":"message","user":"U0HPMN0GY","text":"```\n{\"ok\":true,\"args\":{\"token\":\"xoxb-17803748576-H794PZkqOo4DkjYddb438F2J\"}}```","ts":"1452025068.000045"},"unread_count":321,"unread_count_display":283,"members":["U04JPQ0JS","U04JZBDQQ","U04KB5WQR"],"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"This
+        channel is for team-wide communication and announcements. All team members
+        are in this channel.","creator":"","last_set":0}}]}'
+    http_version:
+  recorded_at: Fri, 22 Jan 2016 19:01:46 GMT
+- request:
+    method: post
+    uri: https://slack.com/api/channels.info
+    body:
+      encoding: UTF-8
+      string: channel=C04KB5X4D&token=token
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: '{"ok":true,"channel":{"id":"C04KB5X4D","name":"general","is_channel":true,"created":1430222230,"creator":"U04KB5WQR","is_archived":false,"is_general":true,"is_member":true,"last_read":"1435863302.000026","latest":{"type":"message","user":"U0HPMN0GY","text":"```\n{\"ok\":true,\"args\":{\"token\":\"xoxb-17803748576-H794PZkqOo4DkjYddb438F2J\"}}```","ts":"1452025068.000045"},"unread_count":321,"unread_count_display":283,"members":["U04JPQ0JS","U04JZBDQQ","U04KB5WQR","U06JGTU5V","U07518DTL","U07KECJ77","U092BDCLV","U092V4E9L","U0EA7TZJN","U0H701CJZ","U0HLFUZLJ","U0HPMN0GY"],"topic":{"value":"","creator":"","last_set":0},"purpose":{"value":"This
+        channel is for team-wide communication and announcements. All team members
+        are in this channel.","creator":"","last_set":0}}}'
+    http_version:
+  recorded_at: Fri, 22 Jan 2016 19:01:46 GMT
+recorded_with: VCR 3.0.1