slack-ruby-client 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdfb697bdb471743bc8c46c29e685af650570952
-  data.tar.gz: 0e0b770c177930831491961f36097cf6fc1c1c17
+  metadata.gz: 0d6e26bc5f3e7e53c67ece14f51482ba24bfbbd1
+  data.tar.gz: c83f574cf4041f1507c3ffdf9a0716669306ead9
 SHA512:
-  metadata.gz: 1e79611aef6f955e67f2a250a7c0a48080634ba61066375cbca7882897b41e5f0043f60d5bd878dddaa67ca0b8cc66bde5a48cb4edc9bb82c567b5e216aa8c59
-  data.tar.gz: 38d866a7132a1981866bb055a24ef8ba6ee8661007b46662dc97e669f335850fa69c01bdd57dd84c2caa0278afff6e70a7eb669e20d2307cff83bef5f836aa9b
+  metadata.gz: 6753176ae587da7add086f67a6d51f9451e4160283ac369bef881743c1930c0b571b048d6c25bc54c8d2347ddf42f32024a46ed1cc93207fee346b55a7dfe8d5
+  data.tar.gz: a1e45d53c9e0e1bb04369f4ad3f94fd7f061d92a0d8f2974fa89861c75a001cbfb7ea5cac63812ea4cab4fe3c7e9e411408731047d1d2be3f259b744b2e24153

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -1,31 +1,43 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-11-08 16:15:14 -0500 using RuboCop version 0.35.0.
+# on 2015-12-06 15:38:34 -0500 using RuboCop version 0.35.0.
 # 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
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 3
+Lint/HandleExceptions:
+  Exclude:
+    - 'lib/slack/real_time/concurrency/celluloid.rb'
+    - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
+    - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
+
+# Offense count: 2
 Metrics/AbcSize:
-  Max: 19
+  Max: 20
 
-# Offense count: 178
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 112
+
+# Offense count: 324
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
-  Max: 174
+  Max: 288
 
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 19
+  Max: 15
 
 # Offense count: 1
 Style/AsciiComments:
   Exclude:
     - 'lib/slack/web/api/endpoints/team.rb'
 
-# Offense count: 36
+# Offense count: 41
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -36,6 +48,11 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
+# Offense count: 74
+# Configuration parameters: AllowedVariables.
+Style/GlobalVars:
+  Enabled: false
+
 # Offense count: 11
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:

data/.travis.yml

@@ -15,3 +15,6 @@ matrix:
 git:
   submodules: false
 
+env:
+  - CONCURRENCY=celluloid-io
+  - CONCURRENCY=faye-websocket

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 0.5.0 (12/7/2015)
+
+* Added `usergroups_create`, `usergroups_disable`, `usergroups_enable`, `usergroups_list`, `usergroups_update` and `usergroups_users` to Web API - [@dblock](https://github.com/dblock).
+* Added command-line `slack` client - [@dblock](https://github.com/dblock).
+* [#5](https://github.com/dblock/slack-ruby-client/issues/5): Added Celluloid support - [@mikz](https://github.com/mikz), [@dblock](https://github.com/dblock).
+* [#34](https://github.com/dblock/slack-ruby-client/pull/34): Added `Slack::RealTime::Client#start_async` - [@mikz](https://github.com/mikz), [@dblock](https://github.com/dblock).
+* `Slack::RealTime::Client` supports `:open` and `:close` callbacks - [@dblock](https://github.com/dblock).
+* [#32](https://github.com/dblock/slack-ruby-client/issues/32): Fix: `on_complete: undefined method [] for nil:NilClass` when responding to Slack 400-500 errors - [@dblock](https://github.com/dblock).
+* [#22](https://github.com/dblock/slack-ruby-client/issues/22): Added `Slack::Web::Api::Error#response` - [@dblock](https://github.com/dblock).
+* Added `logger` to `Slack::Web::Client` configuration that logs HTTP requests - [@dblock](https://github.com/dblock).
+
 ### 0.4.0 (11/8/2015)
 
 * Added `team_integrationLogs` to Web API - [@dblock](https://github.com/dblock).

data/Gemfile

@@ -1,3 +1,5 @@
 source 'http://rubygems.org'
 
 gemspec
+
+gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')

data/README.md

@@ -3,13 +3,18 @@ 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.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. 
+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.
 
 Writing a bot? Try [slack-ruby-bot](https://github.com/dblock/slack-ruby-bot) instead.
 
 ![](slack.png)
 
+## Stable Release
+
+You're reading the documentation for [stable release, v0.5.0](https://github.com/dblock/slack-ruby-client/blob/v0.5.0/README.md). See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+
 ## Installation
 
 Add to Gemfile.
@@ -18,6 +23,13 @@ Add to Gemfile.
 gem 'slack-ruby-client'
 ```
 
+If you're going to be using the RealTime client, add either `eventmachine` and `faye-websocket` or `celluloid-io`. See below for more information about concurrency.
+
+```
+gem 'eventmachine'
+gem 'faye-websocket'
+```
+
 Run `bundle install`.
 
 ## Usage
@@ -80,6 +92,7 @@ proxy        | Optional HTTP proxy.
 ca_path      | Optional SSL certificates path.
 ca_file      | Optional SSL certificates file.
 endpoint     | Slack endpoint, default is _https://slack.com/api_.
+logger       | Optional `Logger` instance that logs HTTP requests.
 
 ### RealTime Client
 
@@ -178,6 +191,81 @@ See a fullly working example in [examples/hi_real_time_and_web](examples/hi_real
 
 ![](examples/hi_real_time_and_web/hi.gif)
 
+#### Concurrency
+
+`Slack::RealTime::Client` needs help from a concurrency library and supports [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine) and [Celluloid](https://github.com/celluloid/celluloid). It will auto-detect one or the other depending on the gems in your Gemfile, but you can also set concurrency explicitly.
+
+```ruby
+Slack::RealTime.configure do |config|
+  config.concurrency = Slack::RealTime::Concurrency::Eventmachine
+end
+```
+
+Use `client.start_async` instead of `client.start!` if you don't want the library to control the event run loop, such as when integrating into other applications that already use Eventmachine or Celluloid. A good example of such application is [slack-bot-server](https://github.com/dblock/slack-bot-server).
+
+```ruby
+client = Slack::RealTime::Client.new
+
+EM.run do
+  client.start_async
+end
+```
+
+See a fullly working example in [examples/hi_real_time_async](examples/hi_real_time_async/hi.rb).
+
+##### Faye::Websocket with Eventmachine
+
+Add the following to your Gemfile.
+
+```
+gem 'faye-websocket'
+```
+
+##### Celluloid
+
+Add the following to your Gemfile.
+
+```
+gem 'celluloid-io'
+```
+
+### Command-Line Client
+
+The slack command-line client returns JSON data from the Slack API.
+
+#### Authenticate with Slack
+
+```
+$ slack --slack-api-token=[token] auth test
+{"ok":true,"url":"...","team":"...","user":"...","team_id":"...","user_id":"..."}
+```
+
+#### Send a Message
+
+```
+export SLACK_API_TOKEN=...
+$ slack chat postMessage --text="hello world" --channel="#general"
+{"ok":true,"channel":"...","ts":"...","message":{"text":"hello world","username":"bot","type":"message","subtype":"bot_message","ts":"..."}}
+```
+
+#### List Users
+
+Combine with [jq](http://stedolan.github.io/jq), a command-line JSON parser.
+
+```
+$ slack users list | jq '.members | map({(.id): .name})'
+[
+  {
+    "U04KB5WQR": "dblock"
+  },
+  {
+    "U07518DTL": "rubybot"
+  }
+]
+```
+
+See `slack help` for a complete command-line reference.
+
 ## History
 
 This gem is based on [slack-ruby-gem](https://github.com/aki017/slack-ruby-gem), but it more clearly separates the Web and RTM APIs, is more thoroughly tested and is in active development.

data/RELEASING.md

@@ -26,10 +26,12 @@ Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
 
 Remove the line with "Your contribution here.", since there will be no more contributions to this release.
 
+Remove the "Stable Release" section in README that warns users that they are reading the documentation for an unreleased version.
+
 Commit your changes.
 
 ```
-git add CHANGELOG.md lib/slack/version.rb
+git add README.md CHANGELOG.md lib/slack/version.rb
 git commit -m "Preparing for release, 0.2.2."
 git push origin master
 ```

data/UPGRADING.md

@@ -0,0 +1,26 @@
+Upgrading Slack-Ruby-Client
+===========================
+
+### Upgrading to >= 0.5.0
+
+#### Changes to Real Time Concurrency
+
+Since 0.5.0 `Slack::RealTime::Client` supports [Celluloid](https://github.com/celluloid/celluloid) and no longer defaults to [Faye::WebSocket](https://github.com/faye/faye-websocket-ruby) with [Eventmachine](https://github.com/eventmachine/eventmachine). It will auto-detect one or the other depending on the gems in your Gemfile, which means you may need to add one or the other to your Gemfile.
+
+##### Faye::Websocket with Eventmachine
+
+```
+gem 'faye-webSocket'
+```
+
+##### Celluloid
+
+```
+gem 'celluloid-io'
+```
+
+When in doubt, use Faye::WebSocket with Eventmachine.
+
+See [#5](https://github.com/dblock/slack-ruby-client/issues/5) for more information.
+
+

data/bin/commands.rb

@@ -0,0 +1,20 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+require 'commands/api'
+require 'commands/auth'
+require 'commands/channels'
+require 'commands/chat'
+require 'commands/emoji'
+require 'commands/files'
+require 'commands/groups'
+require 'commands/im'
+require 'commands/mpim'
+require 'commands/oauth'
+require 'commands/pins'
+require 'commands/reactions'
+require 'commands/rtm'
+require 'commands/search'
+require 'commands/stars'
+require 'commands/team'
+require 'commands/usergroups'
+require 'commands/users'

data/bin/commands/api.rb

@@ -0,0 +1,14 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Api methods.'
+command 'api' do |g|
+  g.desc 'This method helps you test your calling code.'
+  g.long_desc %( This method helps you test your calling code. )
+  g.command 'test' do |c|
+    c.flag 'error', desc: 'Error response to return.'
+    c.flag 'foo', desc: 'example property to return.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.api_test(options))
+    end
+  end
+end

data/bin/commands/auth.rb

@@ -0,0 +1,12 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Auth methods.'
+command 'auth' do |g|
+  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|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.auth_test(options))
+    end
+  end
+end

data/bin/commands/channels.rb

@@ -0,0 +1,140 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc "Get info on your team's Slack channels, create or archive channels, invite users, set the topic and purpose, and mark a channel as read."
+command 'channels' do |g|
+  g.desc 'This method archives a channel.'
+  g.long_desc %( This method archives a channel. )
+  g.command 'archive' do |c|
+    c.flag 'channel', desc: 'Channel to archive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_archive(options))
+    end
+  end
+
+  g.desc 'This method is used to create a channel.'
+  g.long_desc %( This method is used to create a channel. )
+  g.command 'create' do |c|
+    c.flag 'name', desc: 'Name of channel to create.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_create(options))
+    end
+  end
+
+  g.desc 'This method returns a portion of messages/events from the specified channel.'
+  g.long_desc %( 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. )
+  g.command 'history' do |c|
+    c.flag 'channel', desc: 'Channel to fetch history for.'
+    c.flag 'latest', desc: 'End of time range of messages to include in results.'
+    c.flag 'oldest', desc: 'Start of time range of messages to include in results.'
+    c.flag 'inclusive', desc: 'Include messages with latest or oldest timestamp in results.'
+    c.flag 'unreads', desc: 'Include unread_count_display in the output?.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_history(options))
+    end
+  end
+
+  g.desc 'This method returns information about a team channel.'
+  g.long_desc %( This method returns information about a team channel. )
+  g.command 'info' do |c|
+    c.flag 'channel', desc: 'Channel to get info on.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_info(options))
+    end
+  end
+
+  g.desc 'This method is used to invite a user to a channel. The calling user must be a member of the channel.'
+  g.long_desc %( This method is used to invite a user to a channel. The calling user must be a member of the channel. )
+  g.command 'invite' do |c|
+    c.flag 'channel', desc: 'Channel to invite user to.'
+    c.flag 'user', desc: 'User to invite to channel.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_invite(options))
+    end
+  end
+
+  g.desc 'This method is used to join a channel. If the channel does not exist, it is'
+  g.long_desc %( This method is used to join a channel. If the channel does not exist, it is created. )
+  g.command 'join' do |c|
+    c.flag 'name', desc: 'Name of channel to join.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_join(options))
+    end
+  end
+
+  g.desc 'This method allows a user to remove another member from a team channel.'
+  g.long_desc %( This method allows a user to remove another member from a team channel. )
+  g.command 'kick' do |c|
+    c.flag 'channel', desc: 'Channel to remove user from.'
+    c.flag 'user', desc: 'User to remove from channel.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_kick(options))
+    end
+  end
+
+  g.desc 'This method is used to leave a channel.'
+  g.long_desc %( This method is used to leave a channel. )
+  g.command 'leave' do |c|
+    c.flag 'channel', desc: 'Channel to leave.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_leave(options))
+    end
+  end
+
+  g.desc 'This method returns a list of all channels in the team. This includes channels the caller is in, channels'
+  g.long_desc %( 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. )
+  g.command 'list' do |c|
+    c.flag 'exclude_archived', desc: "Don't return archived channels."
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_list(options))
+    end
+  end
+
+  g.desc 'This method moves the read cursor in a channel.'
+  g.long_desc %( This method moves the read cursor in a channel. )
+  g.command 'mark' do |c|
+    c.flag 'channel', desc: 'Channel to set reading cursor in.'
+    c.flag 'ts', desc: 'Timestamp of the most recently seen message.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_mark(options))
+    end
+  end
+
+  g.desc 'This method renames a team channel.'
+  g.long_desc %( This method renames a team channel. )
+  g.command 'rename' do |c|
+    c.flag 'channel', desc: 'Channel to rename.'
+    c.flag 'name', desc: 'New name for channel.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_rename(options))
+    end
+  end
+
+  g.desc 'This method is used to change the purpose of a channel. The calling user must be a member of the channel.'
+  g.long_desc %( This method is used to change the purpose of a channel. The calling user must be a member of the channel. )
+  g.command 'setPurpose' do |c|
+    c.flag 'channel', desc: 'Channel to set the purpose of.'
+    c.flag 'purpose', desc: 'The new purpose.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_setPurpose(options))
+    end
+  end
+
+  g.desc 'This method is used to change the topic of a channel. The calling user must be a member of the channel.'
+  g.long_desc %( This method is used to change the topic of a channel. The calling user must be a member of the channel. )
+  g.command 'setTopic' do |c|
+    c.flag 'channel', desc: 'Channel to set the topic of.'
+    c.flag 'topic', desc: 'The new topic.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_setTopic(options))
+    end
+  end
+
+  g.desc 'This method unarchives a channel. The calling user is added to the channel.'
+  g.long_desc %( This method unarchives a channel. The calling user is added to the channel. )
+  g.command 'unarchive' do |c|
+    c.flag 'channel', desc: 'Channel to unarchive.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_unarchive(options))
+    end
+  end
+end