slack-ruby-client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3ede2b9aafcaacd0d2186d80106272f0faa2857
-  data.tar.gz: 171278a9d042e8c5ef793bebe7b844152bf0f263
+  metadata.gz: 2bf6b0db1a59d9c336613fe0c25e943d781e55fb
+  data.tar.gz: 2880cb0e09e43f59d09632dad24299b9ea4cb062
 SHA512:
-  metadata.gz: 0f6e90d7c8a2242f2ccb912824f9de373f5a0100cac4f9caf543e62b2029fee95ced93948422a3bd8c44e15f455e96ae650606697e1962784748346c03ad840c
-  data.tar.gz: 8c3506854646e6608207a00fdc9968087378b7e090ec14f7dee0c450368c051dd358c32b66c079c52f6be57149982490f877714537b65ee490fc3ca83fcfa5fa
+  metadata.gz: eb17e037a1107ebb93ac331b56f7bfcf2f576ae8377a5ac109745b6cc9b3574e2bb40b7983e24d335f60e10e66adae75d0d2b2a609eb48f89f6ef661ad59f715
+  data.tar.gz: 67a0056a3ca5a76350ecc0f997858492f7cc6cffae68f469c4cae8a4f1f2a34c5c8233c61bdc86afdd2195fb8f3cb1e4dc22cfa2d603e94d931862b165a41f34

data/.gitmodules

@@ -1,3 +1,3 @@
-[submodule "lib/slack/web/api/slack-api-docs"]
-	path = lib/slack/web/api/slack-api-docs
-	url = git@github.com:slackhq/slack-api-docs.git
+[submodule "lib/slack/web/api/slack-api-ref"]
+	path = lib/slack/web/api/slack-api-ref
+	url = git@github.com:dblock/slack-api-ref.git

data/.rubocop.yml

@@ -2,5 +2,6 @@ AllCops:
   Exclude:
     - vendor/**/*
     - bin/**/*
+    - lib/slack/web/api/slack-api-ref/**/*
 
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,5 +1,5 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-07-30 11:21:36 +0200 using RuboCop version 0.32.1.
+# on 2015-09-01 18:02:38 -0400 using RuboCop version 0.32.1.
 # 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
@@ -9,17 +9,17 @@
 Metrics/AbcSize:
   Max: 21
 
-# Offense count: 102
+# Offense count: 152
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 153
+  Max: 149
 
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 19
 
-# Offense count: 32
+# Offense count: 35
 Style/Documentation:
   Enabled: false
 
@@ -28,7 +28,7 @@ Style/Documentation:
 Style/FileName:
   Enabled: false
 
-# Offense count: 9
+# Offense count: 10
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 0.3.0 (9/1/2015)
+
+* Added `team.info` and `accessLogs` - [@dblock](https://github.com/dblock).
+* Removed obsolete `presence` API - [@dblock](https://github.com/dblock).
+* Added `pins.add`, `list` and `remove` - [@dblock](https://github.com/dblock).
+* Added `users.list#presence` - [@dblock](https://github.com/dblock).
+* Added `groups.info` - [@dblock](https://github.com/dblock).
+* Added `groups.history#inclusive` and `im.history#inclusive` - [@dblock](https://github.com/dblock).
+* Added `files.delete` - [@dblock](https://github.com/dblock).
+* Added `chat.postMessage#as_user` - [@dblock](https://github.com/dblock).
+* Use API reference schema from [github.com/dblock/slack-api-ref](https://github.com/dblock/slack-api-ref) - [@dblock](https://github.com/dblock).
+* Added `reactions.add`, `.list`, `.get` and `.remove` - [@jakedahn](https://github.com/jakedahn)
+
 ### 0.2.1 (8/2/2015)
 
 * Set Slack API token via `Slack::RealTime::Client.new(token: 'token')` and `Slack::Web::Client.new(token: 'token')` - [@dblock](https://github.com/dblock).

data/README.md

@@ -2,7 +2,7 @@ Slack Ruby Client
 =================
 
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-client.svg)](http://badge.fury.io/rb/slack-ruby-client)
-[![Build Status](https://travis-ci.org/dblock/slack-ruby-client.png)](https://travis-ci.org/dblock/slack-ruby-client)
+[![Build Status](https://travis-ci.org/dblock/slack-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/slack-ruby-client)
 
 A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messaging](https://api.slack.com/rtm) APIs.
 

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

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

@@ -9,10 +9,12 @@ require 'slack/web/api/endpoints/files'
 require 'slack/web/api/endpoints/groups'
 require 'slack/web/api/endpoints/im'
 require 'slack/web/api/endpoints/oauth'
-require 'slack/web/api/endpoints/presence'
+require 'slack/web/api/endpoints/pins'
+require 'slack/web/api/endpoints/reactions'
 require 'slack/web/api/endpoints/rtm'
 require 'slack/web/api/endpoints/search'
 require 'slack/web/api/endpoints/stars'
+require 'slack/web/api/endpoints/team'
 require 'slack/web/api/endpoints/users'
 
 module Slack
@@ -28,10 +30,12 @@ module Slack
         include Groups
         include Im
         include Oauth
-        include Presence
+        include Pins
+        include Reactions
         include Rtm
         include Search
         include Stars
+        include Team
         include Users
       end
     end

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

@@ -6,15 +6,14 @@ module Slack
       module Endpoints
         module Api
           #
-          # Checks API calling code.
+          # This method helps you test your calling code.
           #
           # @option options [Object] :error
-          #   Error response to return
+          #   Error response to return.
           # @option options [Object] :foo
-          #   example property to return
+          #   example property to return.
           # @see https://api.slack.com/methods/api.test
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/api.test.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/api.test.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/api.test.json
           def api_test(options = {})
             post('api.test', options)
           end

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

@@ -6,11 +6,10 @@ module Slack
       module Endpoints
         module Auth
           #
-          # Checks authentication & identity.
+          # This method checks authentication and tells you who you are.
           #
           # @see https://api.slack.com/methods/auth.test
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/auth.test.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/auth.test.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/auth.test.json
           def auth_test(options = {})
             post('auth.test', options)
           end

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

@@ -6,73 +6,70 @@ module Slack
       module Endpoints
         module Channels
           #
-          # Archives a channel.
+          # This method archives a channel.
           #
-          # @option options [channel] :channel
-          #   Channel to archive
+          # @option options [Object] :channel
+          #   Channel to archive.
           # @see https://api.slack.com/methods/channels.archive
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.archive.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.archive.json
+          # @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?
             post('channels.archive', options)
           end
 
           #
-          # Creates a channel.
+          # This method is used to create a channel.
           #
           # @option options [Object] :name
-          #   Name of channel to create
+          #   Name of channel to create.
           # @see https://api.slack.com/methods/channels.create
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.create.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.create.json
           def channels_create(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
             post('channels.create', options)
           end
 
           #
-          # Fetches history of messages and events from a channel.
+          # This method returns a portion of messages/events from the specified channel.
+          # To read the entire history for a channel, call the method with no latest or
+          # oldest arguments, and then continue paging using the instructions below.
           #
-          # @option options [channel] :channel
+          # @option options [Object] :channel
           #   Channel to fetch history for.
-          # @option options [timestamp] :latest
-          #   Latest message timestamp to include in results.
-          # @option options [timestamp] :oldest
-          #   Oldest message timestamp to include in results.
-          # @option options [Object] :count
-          #   Number of messages to return, between 1 and 1000.
+          # @option options [Object] :latest
+          #   End of time range of messages to include in results.
+          # @option options [Object] :oldest
+          #   Start of time range of messages to include in results.
+          # @option options [Object] :inclusive
+          #   Include messages with latest or oldest timestamp in results.
           # @see https://api.slack.com/methods/channels.history
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.history.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.history.json
+          # @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?
             post('channels.history', options)
           end
 
           #
-          # Gets information about a channel.
+          # This method returns information about a team channel.
           #
-          # @option options [channel] :channel
-          #   Channel to get info on
+          # @option options [Object] :channel
+          #   Channel to get info on.
           # @see https://api.slack.com/methods/channels.info
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.info.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.info.json
+          # @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?
             post('channels.info', options)
           end
 
           #
-          # Invites a user to a channel.
+          # This method is used to invite a user to a channel. The calling user must be a member of the channel.
           #
-          # @option options [channel] :channel
+          # @option options [Object] :channel
           #   Channel to invite user to.
-          # @option options [user] :user
+          # @option options [Object] :user
           #   User to invite to channel.
           # @see https://api.slack.com/methods/channels.invite
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.invite.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.invite.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.invite.json
           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?
@@ -80,28 +77,27 @@ module Slack
           end
 
           #
-          # Joins a channel, creating it if needed.
+          # This method is used to join a channel. If the channel does not exist, it is
+          # created.
           #
           # @option options [Object] :name
-          #   Name of channel to join
+          #   Name of channel to join.
           # @see https://api.slack.com/methods/channels.join
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.join.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.join.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.join.json
           def channels_join(options = {})
             throw ArgumentError.new('Required arguments :name missing') if options[:name].nil?
             post('channels.join', options)
           end
 
           #
-          # Removes a user from a channel.
+          # This method allows a user to remove another member from a team channel.
           #
-          # @option options [channel] :channel
+          # @option options [Object] :channel
           #   Channel to remove user from.
-          # @option options [user] :user
+          # @option options [Object] :user
           #   User to remove from channel.
           # @see https://api.slack.com/methods/channels.kick
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.kick.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.kick.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.kick.json
           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?
@@ -109,40 +105,39 @@ module Slack
           end
 
           #
-          # Leaves a channel.
+          # This method is used to leave a channel.
           #
-          # @option options [channel] :channel
-          #   Channel to leave
+          # @option options [Object] :channel
+          #   Channel to leave.
           # @see https://api.slack.com/methods/channels.leave
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.leave.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.leave.json
+          # @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?
             post('channels.leave', options)
           end
 
           #
-          # Lists all channels in a Slack team.
+          # This method returns a list of all channels in the team. This includes channels the caller is in, channels
+          # they are not currently in, and archived channels. The number of (non-deactivated) members in each channel
+          # is also returned.
           #
           # @option options [Object] :exclude_archived
           #   Don't return archived channels.
           # @see https://api.slack.com/methods/channels.list
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.list.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.list.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.list.json
           def channels_list(options = {})
             post('channels.list', options)
           end
 
           #
-          # Sets the read cursor in a channel.
+          # This method moves the read cursor in a channel.
           #
-          # @option options [channel] :channel
+          # @option options [Object] :channel
           #   Channel to set reading cursor in.
-          # @option options [timestamp] :ts
+          # @option options [Object] :ts
           #   Timestamp of the most recently seen message.
           # @see https://api.slack.com/methods/channels.mark
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.mark.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.mark.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.mark.json
           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?
@@ -150,15 +145,14 @@ module Slack
           end
 
           #
-          # Renames a channel.
+          # This method renames a team channel.
           #
-          # @option options [channel] :channel
-          #   Channel to rename
+          # @option options [Object] :channel
+          #   Channel to rename.
           # @option options [Object] :name
           #   New name for channel.
           # @see https://api.slack.com/methods/channels.rename
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.rename.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.rename.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.rename.json
           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?
@@ -166,15 +160,14 @@ module Slack
           end
 
           #
-          # Sets the purpose for a channel.
+          # This method is used to change the purpose of a channel. The calling user must be a member of the channel.
           #
-          # @option options [channel] :channel
-          #   Channel to set the purpose of
+          # @option options [Object] :channel
+          #   Channel to set the purpose of.
           # @option options [Object] :purpose
-          #   The new purpose
+          #   The new purpose.
           # @see https://api.slack.com/methods/channels.setPurpose
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setPurpose.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setPurpose.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.setPurpose.json
           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?
@@ -182,15 +175,14 @@ module Slack
           end
 
           #
-          # Sets the topic for a channel.
+          # This method is used to change the topic of a channel. The calling user must be a member of the channel.
           #
-          # @option options [channel] :channel
-          #   Channel to set the topic of
+          # @option options [Object] :channel
+          #   Channel to set the topic of.
           # @option options [Object] :topic
-          #   The new topic
+          #   The new topic.
           # @see https://api.slack.com/methods/channels.setTopic
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setTopic.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.setTopic.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/channels.setTopic.json
           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?
@@ -198,13 +190,12 @@ module Slack
           end
 
           #
-          # Unarchives a channel.
+          # This method unarchives a channel. The calling user is added to the channel.
           #
-          # @option options [channel] :channel
-          #   Channel to unarchive
+          # @option options [Object] :channel
+          #   Channel to unarchive.
           # @see https://api.slack.com/methods/channels.unarchive
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.unarchive.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/channels.unarchive.json
+          # @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?
             post('channels.unarchive', options)

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

@@ -6,15 +6,14 @@ module Slack
       module Endpoints
         module Chat
           #
-          # Deletes a message.
+          # This method deletes a message from a channel.
           #
           # @option options [Object] :ts
           #   Timestamp of the message to be deleted.
-          # @option options [channel] :channel
+          # @option options [Object] :channel
           #   Channel containing the message to be deleted.
           # @see https://api.slack.com/methods/chat.delete
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.delete.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.delete.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat.delete.json
           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?
@@ -22,14 +21,16 @@ module Slack
           end
 
           #
-          # Sends a message to a channel.
+          # This method posts a message to a public channel, private group, or IM channel.
           #
-          # @option options [channel] :channel
-          #   Channel to send message to. Can be a public channel, private group or IM channel. Can be an encoded ID, or a name.
+          # @option options [Object] :channel
+          #   Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.
           # @option options [Object] :text
           #   Text of the message to send. See below for an explanation of formatting.
           # @option options [Object] :username
           #   Name of bot.
+          # @option options [Object] :as_user
+          #   Pass true to post the message as the authed user, instead of as a bot.
           # @option options [Object] :parse
           #   Change how messages are treated. See below.
           # @option options [Object] :link_names
@@ -41,12 +42,11 @@ module Slack
           # @option options [Object] :unfurl_media
           #   Pass false to disable unfurling of media content.
           # @option options [Object] :icon_url
-          #   URL to an image to use as the icon for this message
+          #   URL to an image to use as the icon for this message.
           # @option options [Object] :icon_emoji
-          #   emoji to use as the icon for this message. Overrides `icon_url`.
+          #   emoji to use as the icon for this message. Overrides icon_url.
           # @see https://api.slack.com/methods/chat.postMessage
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.postMessage.json
+          # @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?
@@ -54,17 +54,16 @@ module Slack
           end
 
           #
-          # Updates a message.
+          # This method updates a message in a channel.
           #
           # @option options [Object] :ts
           #   Timestamp of the message to be updated.
-          # @option options [channel] :channel
+          # @option options [Object] :channel
           #   Channel containing the message to be updated.
           # @option options [Object] :text
-          #   New text for the message, using the [default formatting rules](/docs/formatting).
+          #   New text for the message, using the default formatting rules.
           # @see https://api.slack.com/methods/chat.update
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.update.md
-          # @see https://github.com/slackhq/slack-api-docs/blob/master/methods/chat.update.json
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/chat.update.json
           def chat_update(options = {})
             throw ArgumentError.new('Required arguments :ts missing') if options[:ts].nil?
             throw ArgumentError.new('Required arguments :channel missing') if options[:channel].nil?