slack-ruby-client 0.2.1 → 0.3.0

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

@@ -6,19 +6,19 @@ module Slack
       module Endpoints
         module Oauth
           #
-          # Exchanges a temporary OAuth code for an API token.
+          # This method allows you to exchange a temporary OAuth code for an API access token.
+          # This is used as part of the OAuth authentication flow.
           #
           # @option options [Object] :client_id
           #   Issued when you created your application.
           # @option options [Object] :client_secret
           #   Issued when you created your application.
           # @option options [Object] :code
-          #   The `code` param returned via the OAuth callback.
+          #   The code param returned via the OAuth callback.
           # @option options [Object] :redirect_uri
           #   This must match the originally submitted URI (if one was sent).
           # @see https://api.slack.com/methods/oauth.access
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/oauth.access.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/oauth.access.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/oauth.access.json
           def oauth_access(options = {})
             throw ArgumentError.new('Required arguments :client_id missing') if options[:client_id].nil?
             throw ArgumentError.new('Required arguments :client_secret missing') if options[:client_secret].nil?

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

@@ -0,0 +1,61 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Pins
+          #
+          # This method pins an item (file, file comment, channel message, or group message) to a particular channel.
+          # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
+          #
+          # @option options [Object] :channel
+          #   Channel to pin the item in.
+          # @option options [Object] :file
+          #   File to pin.
+          # @option options [Object] :file_comment
+          #   File comment to pin.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to pin.
+          # @see https://api.slack.com/methods/pins.add
+          # @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?
+            post('pins.add', options)
+          end
+
+          #
+          # This method lists the items pinned to a channel.
+          #
+          # @option options [Object] :channel
+          #   Channel to get pinned items for.
+          # @see https://api.slack.com/methods/pins.list
+          # @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?
+            post('pins.list', options)
+          end
+
+          #
+          # This method un-pins an item (file, file comment, channel message, or group message) from a channel.
+          # The channel argument is required and one of file, file_comment, or timestamp must also be specified.
+          #
+          # @option options [Object] :channel
+          #   Channel where the item is pinned to.
+          # @option options [Object] :file
+          #   File to un-pin.
+          # @option options [Object] :file_comment
+          #   File comment to un-pin.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to un-pin.
+          # @see https://api.slack.com/methods/pins.remove
+          # @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?
+            post('pins.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,13 +6,12 @@ module Slack
       module Endpoints
         module Presence
           #
-          # Manually set user presence
+          # Manually set user presence.
           #
           # @option options [Object] :presence
-          #   Either `active` or `away`
+          #   Either `active` or `away`.
           # @see https://api.slack.com/methods/presence.set
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/presence.set.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/presence.set.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/presence.set.json
           def presence_set(options = {})
             throw ArgumentError.new('Required arguments :presence missing') if options[:presence].nil?
             post('presence.set', options)

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

@@ -0,0 +1,85 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+module Slack
+  module Web
+    module Api
+      module Endpoints
+        module Reactions
+          #
+          # This method adds a reaction (emoji) to an item (file, file comment, channel message, group message, or direct message).
+          # One of file, file_comment, or the combination of channel and timestamp must be specified.
+          #
+          # @option options [Object] :name
+          #   Reaction (emoji) name.
+          # @option options [Object] :file
+          #   File to add reaction to.
+          # @option options [Object] :file_comment
+          #   File comment to add reaction to.
+          # @option options [Object] :channel
+          #   Channel where the message to add reaction to was posted.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to add reaction to.
+          # @see https://api.slack.com/methods/reactions.add
+          # @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?
+            post('reactions.add', options)
+          end
+
+          #
+          # This method returns a list of all reactions for a single item (file, file comment, channel message, group message, or direct message).
+          #
+          # @option options [Object] :file
+          #   File to get reactions for.
+          # @option options [Object] :file_comment
+          #   File comment to get reactions for.
+          # @option options [Object] :channel
+          #   Channel where the message to get reactions for was posted.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to get reactions for.
+          # @option options [Object] :full
+          #   If true always return the complete reaction list.
+          # @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 = {})
+            post('reactions.get', options)
+          end
+
+          #
+          # This method returns a list of all items (file, file comment, channel message, group message, or direct message) reacted to by a user.
+          #
+          # @option options [Object] :user
+          #   Show reactions made by this user. Defaults to the authed user.
+          # @option options [Object] :full
+          #   If true always return the complete reaction list.
+          # @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 = {})
+            post('reactions.list', options)
+          end
+
+          #
+          # This method removes a reaction (emoji) from an item (file, file comment, channel message, group message, or direct message).
+          # One of file, file_comment, or the combination of channel and timestamp must be specified.
+          #
+          # @option options [Object] :name
+          #   Reaction (emoji) name.
+          # @option options [Object] :file
+          #   File to remove reaction from.
+          # @option options [Object] :file_comment
+          #   File comment to remove reaction from.
+          # @option options [Object] :channel
+          #   Channel where the message to remove reaction from was posted.
+          # @option options [Object] :timestamp
+          #   Timestamp of the message to remove reaction from.
+          # @see https://api.slack.com/methods/reactions.remove
+          # @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?
+            post('reactions.remove', options)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,11 +6,15 @@ module Slack
       module Endpoints
         module Rtm
           #
-          # Starts a Real Time Messaging session.
+          # This method starts a Real Time Messaging API session. Refer to the
+          # RTM API documentation for full details on how to use the RTM API.
           #
+          # @option options [Object] :simple_latest
+          #   Return timestamp only for latest message object of each channel (improves performance).
+          # @option options [Object] :no_unreads
+          #   Skip unread counts for each channel (improves performance).
           # @see https://api.slack.com/methods/rtm.start
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/rtm.start.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/rtm.start.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/rtm.start.json
           def rtm_start(options = {})
             post('rtm.start', options)
           end

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

@@ -6,57 +6,54 @@ module Slack
       module Endpoints
         module Search
           #
-          # Searches for messages and files matching a query.
+          # This method allows to to search both messages and files in a single call.
           #
           # @option options [Object] :query
           #   Search query. May contains booleans, etc.
           # @option options [Object] :sort
-          #   Return matches sorted by either `score` or `timestamp`.
+          #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
-          #   Change sort direction to ascending (`asc`) or descending (`desc`).
+          #   Change sort direction to ascending (asc) or descending (desc).
           # @option options [Object] :highlight
-          #   Pass a value of `1` to enable query highlight markers (see below).
+          #   Pass a value of 1 to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.all
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.all.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.all.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search.all.json
           def search_all(options = {})
             throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
             post('search.all', options)
           end
 
           #
-          # Searches for files matching a query.
+          # This method returns files matching a search query.
           #
           # @option options [Object] :query
-          #   Search query. May contains booleans, etc.
+          #   Search query. May contain booleans, etc.
           # @option options [Object] :sort
-          #   Return matches sorted by either `score` or `timestamp`.
+          #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
-          #   Change sort direction to ascending (`asc`) or descending (`desc`).
+          #   Change sort direction to ascending (asc) or descending (desc).
           # @option options [Object] :highlight
-          #   Pass a value of `1` to enable query highlight markers (see below).
+          #   Pass a value of 1 to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.files
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.files.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.files.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search.files.json
           def search_files(options = {})
             throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
             post('search.files', options)
           end
 
           #
-          # Searches for messages matching a query.
+          # This method returns messages matching a search query.
           #
           # @option options [Object] :query
           #   Search query. May contains booleans, etc.
           # @option options [Object] :sort
-          #   Return matches sorted by either `score` or `timestamp`.
+          #   Return matches sorted by either score or timestamp.
           # @option options [Object] :sort_dir
-          #   Change sort direction to ascending (`asc`) or descending (`desc`).
+          #   Change sort direction to ascending (asc) or descending (desc).
           # @option options [Object] :highlight
-          #   Pass a value of `1` to enable query highlight markers (see below).
+          #   Pass a value of 1 to enable query highlight markers (see below).
           # @see https://api.slack.com/methods/search.messages
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.messages.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/search.messages.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/search.messages.json
           def search_messages(options = {})
             throw ArgumentError.new('Required arguments :query missing') if options[:query].nil?
             post('search.messages', options)

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

@@ -6,13 +6,12 @@ module Slack
       module Endpoints
         module Stars
           #
-          # Lists stars for a user.
+          # This method lists the items starred by a user.
           #
-          # @option options [user] :user
+          # @option options [Object] :user
           #   Show stars by this user. Defaults to the authed user.
           # @see https://api.slack.com/methods/stars.list
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/stars.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/stars.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/stars.list.json
           def stars_list(options = {})
             post('stars.list', options)
           end

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

@@ -0,0 +1,29 @@
+# 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
+        end
+      end
+    end
+  end
+end

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

@@ -6,59 +6,60 @@ module Slack
       module Endpoints
         module Users
           #
-          # Gets user presence information.
+          # This method lets you find out information about a user's presence.
+          # Consult the presence documentation for more details.
           #
-          # @option options [user] :user
+          # @option options [Object] :user
           #   User to get presence info on. Defaults to the authed user.
           # @see https://api.slack.com/methods/users.getPresence
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.getPresence.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.getPresence.json
+          # @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?
             post('users.getPresence', options)
           end
 
           #
-          # Gets information about a user.
+          # This method returns information about a team member.
           #
-          # @option options [user] :user
-          #   User to get info on
+          # @option options [Object] :user
+          #   User to get info on.
           # @see https://api.slack.com/methods/users.info
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.info.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.info.json
+          # @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?
             post('users.info', options)
           end
 
           #
-          # Lists all users in a Slack team.
+          # 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/slackhq/slack-api-docs/blob/master/methods/users.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.list.json
           def users_list(options = {})
             post('users.list', options)
           end
 
           #
-          # Marks a user as active.
+          # 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/slackhq/slack-api-docs/blob/master/methods/users.setActive.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setActive.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users.setActive.json
           def users_setActive(options = {})
             post('users.setActive', options)
           end
 
           #
-          # Manually sets user presence.
+          # 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`
+          #   Either auto or away.
           # @see https://api.slack.com/methods/users.setPresence
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setPresence.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/users.setPresence.json
+          # @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)

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

@@ -5,7 +5,7 @@ require 'erubis'
 namespace :slack do
   namespace :web do
     namespace :api do
-      # update slack-api-docs from https://github.com/slackhq/slack-api-docs
+      # update slack-api-ref from https://github.com/dblock/slack-api-ref
       task :git_update do
         sh 'git submodule update --init --recursive'
         sh 'git submodule foreach git pull origin master'
@@ -14,7 +14,7 @@ namespace :slack do
       desc 'Update API.'
       task update: [:git_update] do
         method_schema = JSON.parse(File.read('lib/slack/web/api/schema/method.json'))
-        data = Dir.glob('lib/slack/web/api/slack-api-docs/methods/*.json').each_with_object({}) do |path, result|
+        data = Dir.glob('lib/slack/web/api/slack-api-ref/methods/*.json').each_with_object({}) do |path, result|
           name = File.basename(path, '.json')
           prefix, name = name.split('.')
           result[prefix] ||= {}

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

@@ -10,7 +10,9 @@ module Slack
 
 <% end %>
           #
-          # <%= data["desc"] %>
+<% data["desc"].split("\n").each do |line| %>
+          # <%= line %>
+<% end %>
           #
 <% data["args"].each do |arg_name, arg_v| %>
           # @option options [<%= arg_v["type"] %>] :<%= arg_name %>
@@ -23,8 +25,7 @@ module Slack
 <% end %>
 <% end %>
           # @see https://api.slack.com/methods/<%= group %>.<%= name %>
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/<%= group %>.<%= name %>.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/<%= group %>.<%= name %>.json
+          # @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| %>
             throw ArgumentError.new('Required arguments :<%= arg_name %> missing') if options[:<%= arg_name %>].nil?