slack-ruby-client 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e1cd2d1d9cbc3663ae0616b48855f34454e8ad4
-  data.tar.gz: 0e7cc755aa5623005a60d5e2d7d62a8c70596bdb
+  metadata.gz: df64328580f69c890ab8fabff98767786d92b37a
+  data.tar.gz: 4c5ced46b270d5e67295043384bf598cb743c985
 SHA512:
-  metadata.gz: 3080aca20cc3a8d3f2d873f9192842806db73f18297e0b41784f5bd3d028d18eabda168331b1f3d883a1699c39f1776adf3a6d5a0881b402408b480f3156c6fd
-  data.tar.gz: a8b263005432280abf2b89f6d2495eb63890024336ea2d9f19e04d2078c0c45704acdbda38cb018b75d5afd651ae226b9dbe6e7189d2e6caf5e26d33ad0a3fba
+  metadata.gz: 64ca4a04c88a505476b2142fc5054d2560f79ce1fc82303631b5a5baeeab54456ed1edbcfe170489233a0c6e362d83ea1661b3dde3f248ea0d283fc17c9cf8f8
+  data.tar.gz: afacac026a07847c3f4a0e79f8944d7f2a3d2442f7dad8c46cb1b39740749d6a30b6805769d59f17bf517fc100f01e5cc777eb30a7cd13f84f8f5b727bbb6590

data/.travis.yml

@@ -23,3 +23,7 @@ matrix:
 
 git:
   submodules: false
+
+before_install:
+  - gem update bundler
+  - gem update --system

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.7.4 (5/28/2016)
+
+* [#93](https://github.com/dblock/slack-ruby-client/pull/93): Fix: When using Celluloid concurrency, handle input from the TCP socket asynchronously from reading more. - [@benzrf](https://github.com/benzrf).
+* Added `auth_revoke` and `users_identity` to Web API - [@dblock](https://github.com/dblock).
+* Added `channel` parameter to `files_comments_add` Web API - [@dblock](https://github.com/dblock).
+
 ### 0.7.3 (5/14/2016)
 
 * [#90](https://github.com/dblock/slack-ruby-client/issues/90): Fix: Celluloid concurrency handles server-side connection closing - [@dblock](https://github.com/dblock).

data/README.md

@@ -5,7 +5,7 @@ Slack Ruby Client
 [![Build Status](https://travis-ci.org/dblock/slack-ruby-client.svg?branch=master)](https://travis-ci.org/dblock/slack-ruby-client)
 [![Code Climate](https://codeclimate.com/github/dblock/slack-ruby-client/badges/gpa.svg)](https://codeclimate.com/github/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. Comes with a handy command-line client, too.
+A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messaging](https://api.slack.com/rtm) APIs. Comes with a handy command-line client, too. If you are not familiar with these concepts, you might want to watch [this video](http://code.dblock.org/2016/03/11/your-first-slack-bot-service-video.html).
 
 ![](slack.png)
 
@@ -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 **next** release of slack-ruby-client. Please see the documentation for the [last stable release, v0.7.2](https://github.com/dblock/slack-ruby-client/blob/v0.7.2/README.md) unless you're integrating with HEAD. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.7.4. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 

data/bin/commands/auth.rb

@@ -2,6 +2,15 @@
 
 desc 'Auth methods.'
 command 'auth' do |g|
+  g.desc 'This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.'
+  g.long_desc %( This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out. )
+  g.command 'revoke' do |c|
+    c.flag 'test', desc: 'Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.auth_revoke(options))
+    end
+  end
+
   g.desc 'This method checks authentication and tells you who you are.'
   g.long_desc %( This method checks authentication and tells you who you are. )
   g.command 'test' do |c|

data/bin/commands/chat.rb

@@ -13,11 +13,11 @@ command 'chat' do |g|
     end
   end
 
-  g.desc 'This method posts a message to a public channel, private group, or IM channel.'
-  g.long_desc %( This method posts a message to a public channel, private group, or IM channel. )
+  g.desc 'This method posts a message to a public channel, private channel, or direct message/IM channel.'
+  g.long_desc %( This method posts a message to a public channel, private channel, or direct message/IM channel. )
   g.command 'postMessage' do |c|
     c.flag 'channel', desc: 'Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See below for more details.'
-    c.flag 'text', desc: 'Text of the message to send. See below for an explanation of formatting.'
+    c.flag 'text', desc: "Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead."
     c.flag 'parse', desc: 'Change how messages are treated. Defaults to none. See below.'
     c.flag 'link_names', desc: 'Find and link channel names and usernames.'
     c.flag 'attachments', desc: 'Structured message attachments.'

data/bin/commands/files.rb

@@ -30,7 +30,7 @@ command 'files' do |g|
     c.flag 'types', desc: 'Filter files by type:
 
 all - All files
-posts - Posts
+spaces - Posts
 snippets - Snippets
 images - Image files
 gdocs - Google docs
@@ -38,7 +38,7 @@ zips - Zip files
 pdfs - PDF files
 
 
-You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list.
+You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
 .'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_list(options))

data/bin/commands/files_comments.rb

@@ -7,6 +7,7 @@ command 'files_comments' do |g|
   g.command 'add' do |c|
     c.flag 'file', desc: 'File to add a comment to.'
     c.flag 'comment', desc: 'Text of the comment to add.'
+    c.flag 'channel', desc: 'Channel id (encoded) of which location to associate with the new comment.'
     c.action do |_global_options, options, _args|
       puts JSON.dump($client.files_comments_add(options))
     end

data/bin/commands/users.rb

@@ -11,6 +11,14 @@ command 'users' do |g|
     end
   end
 
+  g.desc "After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity."
+  g.long_desc %( After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity. )
+  g.command 'identity' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.users_identity(options))
+    end
+  end
+
   g.desc 'This method returns information about a team member.'
   g.long_desc %( This method returns information about a team member. )
   g.command 'info' do |c|

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

@@ -47,6 +47,10 @@ module Slack
 
           def read
             buffer = socket.readpartial(BLOCK_SIZE)
+            async.handle_read(buffer)
+          end
+
+          def handle_read(buffer)
             logger.debug("#{self.class}##{__method__}") { buffer }
             driver.parse buffer
           end

data/lib/slack/version.rb

@@ -1,3 +1,3 @@
 module Slack
-  VERSION = '0.7.3'.freeze
+  VERSION = '0.7.4'.freeze
 end

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

@@ -5,6 +5,17 @@ module Slack
     module Api
       module Endpoints
         module Auth
+          #
+          # This method revokes an access token. Use it when you no longer need a token. For example, with a Sign In With Slack app, call this to log a user out.
+          #
+          # @option options [Object] :test
+          #   Setting this parameter to 1 triggers a testing mode where the specified token will not actually be revoked.
+          # @see https://api.slack.com/methods/auth.revoke
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/auth/auth.revoke.json
+          def auth_revoke(options = {})
+            post('auth.revoke', options)
+          end
+
           #
           # This method checks authentication and tells you who you are.
           #

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

@@ -24,12 +24,12 @@ module Slack
           end
 
           #
-          # This method posts a message to a public channel, private group, or IM channel.
+          # This method posts a message to a public channel, private channel, or direct message/IM channel.
           #
           # @option options [channel] :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.
+          #   Text of the message to send. See below for an explanation of formatting. This field is usually required, unless you're providing only attachments instead.
           # @option options [Object] :parse
           #   Change how messages are treated. Defaults to none. See below.
           # @option options [Object] :link_names

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

@@ -44,7 +44,7 @@ module Slack
           #   Filter files by type:
           #
           #   all - All files
-          #   posts - Posts
+          #   spaces - Posts
           #   snippets - Snippets
           #   images - Image files
           #   gdocs - Google docs
@@ -52,7 +52,7 @@ module Slack
           #   pdfs - PDF files
           #
           #
-          #   You can pass multiple values in the types argument, like types=posts,snippets.The default value is all, which does not filter the list.
+          #   You can pass multiple values in the types argument, like types=spaces,snippets.The default value is all, which does not filter the list.
           #   .
           # @see https://api.slack.com/methods/files.list
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files/files.list.json

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

@@ -12,11 +12,14 @@ module Slack
           #   File to add a comment to.
           # @option options [Object] :comment
           #   Text of the comment to add.
+          # @option options [channel] :channel
+          #   Channel id (encoded) of which location to associate with the new comment.
           # @see https://api.slack.com/methods/files.comments.add
           # @see https://github.com/dblock/slack-api-ref/blob/master/methods/files.comments/files.comments.add.json
           def files_comments_add(options = {})
             throw ArgumentError.new('Required arguments :file missing') if options[:file].nil?
             throw ArgumentError.new('Required arguments :comment missing') if options[:comment].nil?
+            options = options.merge(channel: channels_id(options)['channel']['id']) if options[:channel]
             post('files.comments.add', options)
           end
 

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

@@ -19,6 +19,15 @@ module Slack
             post('users.getPresence', options)
           end
 
+          #
+          # After your Slack app is awarded an identity token through Sign in with Slack, use this method to retrieve a user's identity.
+          #
+          # @see https://api.slack.com/methods/users.identity
+          # @see https://github.com/dblock/slack-api-ref/blob/master/methods/users/users.identity.json
+          def users_identity(options = {})
+            post('users.identity', options)
+          end
+
           #
           # This method returns information about a team member.
           #

data/spec/slack/web/api/endpoints/files_comments_spec.rb

@@ -9,7 +9,7 @@ RSpec.describe Slack::Web::Api::Endpoints::FilesComments do
       expect { client.files_comments_add(comment: 'Everyone should take a moment to read this file.') }.to raise_error ArgumentError, /Required arguments :file missing/
     end
     it 'requires comment' do
-      expect { client.files_comments_add(file: 'F1234567890') }.to raise_error ArgumentError, /Required arguments :comment missing/
+      expect { client.files_comments_add(file: 'F1234467890') }.to raise_error ArgumentError, /Required arguments :comment missing/
     end
   end
   context 'files.comments_delete' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-client
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-14 00:00:00.000000000 Z
+date: 2016-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport