slack-ruby-client-bhe 0.5.4

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

@@ -0,0 +1,47 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Team
+          #
+          # This method is used to get the access logs for users on a team.
+          #
+          # @see https://api.slack.com/methods/team.accessLogs
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team.accessLogs.json
+          def team_accessLogs(options = {})
+            post('team.accessLogs', options)
+          end
+
+          #
+          # This method provides information about your team.
+          #
+          # @see https://api.slack.com/methods/team.info
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/team.info.json
+          def team_info(options = {})
+            post('team.info', options)
+          end
+
+          #
+          # 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] :service_id
+          #   Filter logs to this service. Defaults to all logs.
+          # @option options [Object] :app_id
+          #   Filter logs to this Slack app. Defaults to all logs.
+          # @option options [user] :user
+          #   Filter logs generated by this user's actions. Defaults to all logs.
+          # @option options [Object] :change_type
+          #   Filter logs with this change type. Defaults to all logs.
+          # @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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,113 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Usergroups
+          #
+          # 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.
+          # @option options [Object] :handle
+          #   A mention handle. Must be unique among channels, users and user groups.
+          # @option options [Object] :description
+          #   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.
+          # @option options [Object] :include_count
+          #   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.create.json
+          def usergroups_create(options = {})
+            throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
+            post('usergroups.create', options)
+          end
+
+          #
+          # This method disables an existing user group.
+          #
+          # @option options [Object] :usergroup
+          #   The encoded ID of the user group to disable.
+          # @option options [Object] :include_count
+          #   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.disable.json
+          def usergroups_disable(options = {})
+            throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
+            post('usergroups.disable', options)
+          end
+
+          #
+          # This method enables a user group which was previously disabled.
+          #
+          # @option options [Object] :usergroup
+          #   The encoded ID of the user group to enable.
+          # @option options [Object] :include_count
+          #   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.enable.json
+          def usergroups_enable(options = {})
+            throw ArgumentError.new('Required arguments :usergroup missing') if options[:usergroup].nil?
+            post('usergroups.enable', options)
+          end
+
+          #
+          # 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.
+          # @option options [Object] :include_count
+          #   Include the number of users in each user group.
+          # @option options [Object] :include_users
+          #   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.list.json
+          def usergroups_list(options = {})
+            post('usergroups.list', options)
+          end
+
+          #
+          # This method updates the properties of an existing user group.
+          #
+          # @option options [Object] :usergroup
+          #   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.
+          # @option options [Object] :handle
+          #   A mention handle. Must be unique among channels, users and user groups.
+          # @option options [Object] :description
+          #   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.
+          # @option options [Object] :include_count
+          #   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.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.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
+  end
+end

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

@@ -0,0 +1,73 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Users
+          #
+          # 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.
+          # @see https://api.slack.com/methods/users.getPresence
+          # @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
+
+          #
+          # This method returns information about a team member.
+          #
+          # @option options [user] :user
+          #   User to get info on.
+          # @see https://api.slack.com/methods/users.info
+          # @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
+
+          #
+          # This method returns a list of all users in the team. This includes deleted/deactivated users.
+          #
+          # @option options [Object] :presence
+          #   Whether to include presence data in the output.
+          # @see https://api.slack.com/methods/users.list
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.list.json
+          def users_list(options = {})
+            post('users.list', options)
+          end
+
+          #
+          # This method lets the slack messaging server know that the authenticated user
+          # is currently active. Consult the presence documentation for
+          # more details.
+          #
+          # @see https://api.slack.com/methods/users.setActive
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.setActive.json
+          def users_setActive(options = {})
+            post('users.setActive', options)
+          end
+
+          #
+          # 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.
+          # @see https://api.slack.com/methods/users.setPresence
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.setPresence.json
+          def users_setPresence(options = {})
+            throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
+            post('users.setPresence', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Slack
+  module Web
+    module Api
+      class Error < ::Faraday::Error
+        attr_reader :response
+
+        def initialize(message, response = nil)
+          @response = response
+          super message
+        end
+      end
+    end
+  end
+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

@@ -0,0 +1,13 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index 1f7a8d7..2ec4bed 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -49,7 +49,7 @@ module Slack
+           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat.postMessage.json
+           def chat_postMessage(options = {})
+             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?
+             post('chat.postMessage', options)
+           end
+

data/lib/slack/web/api/patches/chat.2.attachments-json.patch

@@ -0,0 +1,17 @@
+diff --git a/lib/slack/web/api/endpoints/chat.rb b/lib/slack/web/api/endpoints/chat.rb
+index 1f7a8d7..89b1562 100644
+--- a/lib/slack/web/api/endpoints/chat.rb
++++ b/lib/slack/web/api/endpoints/chat.rb
+@@ -50,6 +50,12 @@ module Slack
+           def chat_postMessage(options = {})
+             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?
+             throw ArgumentError.new('Required arguments :text or :attachments missing') if options[:text].nil? && options[:attachments].nil?
++            # 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.postMessage', options)
+           end
+

data/lib/slack/web/api/schema/group.json

@@ -0,0 +1,14 @@
+{
+  "type": "object",
+  "required": [
+    "name"
+  ],
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "desc": {
+      "type": "string"
+    }
+  }
+}