slack-ruby-client 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b77bc84985aeaa9109f41148ebfc2ef720c55232
-  data.tar.gz: b6a097a441ec9255f3b1b062bceca5b29888fd34
+  metadata.gz: b713ee1b5bbc32bbb54b434199c8245d1edcc528
+  data.tar.gz: 7122943dc5dabf15ccf656be06b3df08c24e39ba
 SHA512:
-  metadata.gz: b6f08da6827379462c86c589af7b4dd38b108b14a31d537bf740c727f16830d76ef982fd69ef6e573b26be8ebdeefe05d74eee7bfbebebc6a3814b965829c43c
-  data.tar.gz: 6b0f320fa1985a987e54f793d61463ad2780771db8871a8848140e912cc5f5fc817213a8885f80fc7e08ca10db81b17890a785e2e0223f28e6fe655293865717
+  metadata.gz: 8e9b7148626db6c19db75a8688f6f4233158ce7dc7162d084525516ceb8d458e14a8a2dca875d64ac88cad5913e60f3923b28038b54201de7bfa28bb625cb99d
+  data.tar.gz: 464204c4a4285827791b0c166d958f2fafe7cdadc38af68e40f3db8798e746fd78f70eed0dc5c649f93c8523a2fe8bdda6328ee75456d872cffa7201f1b7fc48

data/.rubocop_todo.yml

@@ -1,14 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-01-22 14:19:14 -0500 using RuboCop version 0.35.0.
+# on 2016-02-02 17:03:58 -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
+# Offense count: 4
 Lint/HandleExceptions:
   Exclude:
+    - 'lib/slack-ruby-client.rb'
     - 'lib/slack/real_time/concurrency/celluloid.rb'
     - 'spec/slack/real_time/concurrency/celluloid_spec.rb'
     - 'spec/slack/real_time/concurrency/eventmachine_spec.rb'
@@ -20,30 +21,26 @@ Lint/UnusedBlockArgument:
   Exclude:
     - 'lib/slack/messages/formatting.rb'
 
-# Offense count: 7
+# Offense count: 12
 Metrics/AbcSize:
-  Max: 22
+  Max: 31
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 112
-
-# Offense count: 1
-Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 131
 
-# Offense count: 438
+# Offense count: 586
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 288
 
-# Offense count: 4
+# Offense count: 6
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 15
+  Max: 24
 
-# Offense count: 46
+# Offense count: 80
 # Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
@@ -54,11 +51,17 @@ Style/FileName:
   Exclude:
     - 'lib/slack-ruby-client.rb'
 
-# Offense count: 86
+# Offense count: 90
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Enabled: false
 
+# Offense count: 1
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/slack/real_time/store.rb'
+
 # Offense count: 15
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 Style/MethodName:

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.6.0 (2/4/2016)
+
+* [#54](https://github.com/dblock/slack-ruby-client/issues/54): RealTime client maintains a local store of team data for `client.self`, `team`, `users`, `channels`, `groups`, `ims` and `bots` data - [@dblock](https://github.com/dblock).
+* [#56](https://github.com/dblock/slack-ruby-client/issues/56): API responses in both Web and RealTime clients are now instances of [Slack::Messages::Message](lib/slack/messages/message), which provides method access to properties - [@dblock](https://github.com/dblock).
+* [#57](https://github.com/dblock/slack-ruby-client/issues/57): Configure arguments to pass to `rtm.start` via `config.start_options` - [@dblock](https://github.com/dblock).
+* [#52](https://github.com/dblock/slack-ruby-client/issues/52): Added `users_search` - [@dblock](https://github.com/dblock).
+
 ### 0.5.4 (1/23/2016)
 
 * [#45](https://github.com/dblock/slack-ruby-client/issues/45): Added `channels_id`, `groups_id` and `users_id` - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -68,7 +68,7 @@ Make sure that `bundle exec rake` completes without errors.
 Slack Web API is updated from https://github.com/dblock/slack-api-ref, a maintained, machine-readable version of Slack API Docs, generated by scraping [api.slack.com](https://api.slack.com). To update the Web API from the latest definition run the following Rake task.
 
 ```
-rake slack:web:api:update
+rake slack:api:update
 ```
 
 #### Patching Slack Web API
@@ -81,7 +81,7 @@ Make a change to a generated file, for example `lib/slack/web/api/endpoints/chat
 git diff HEAD lib/slack/web/api/endpoints/chat.rb > lib/slack/web/api/patches/chat.1.patch
 ```
 
-Run `rake slack:web:api:update` to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.
+Run `rake slack:api:update` to ensure that the patch is cleanly applied. Implement a test for the added or modified functionality and commit the patch file.
 
 ### Write Documentation
 

data/Gemfile

@@ -3,3 +3,4 @@ source 'http://rubygems.org'
 gemspec
 
 gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
+gem 'picky' unless RUBY_PLATFORM == 'java'

data/README.md

@@ -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 **stable** release of slack-ruby-client, 0.5.4. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
+You're reading the documentation for the **stable** release of slack-ruby-client, 0.6.0. See [UPGRADING](UPGRADING.md) when upgrading from an older version.
 
 ## Installation
 
@@ -83,9 +83,9 @@ See a fully working example in [examples/hi_web](examples/hi_web/hi.rb).
 List channels with [channels_list](https://api.slack.com/methods/channels.list).
 
 ```ruby
-channels = client.channels_list['channels']
+channels = client.channels_list.channels
 
-general_channel = channels.detect { |c| c['name'] == 'general' }
+general_channel = channels.detect { |c| c.name == 'general' }
 ```
 
 #### Upload a File
@@ -127,6 +127,14 @@ client.users_info(user: 'U092BDCLV') # calls users_info
 client.users_info(user: '@dblock') # calls users_list followed by users_info
 ```
 
+### Search for a User
+
+Constructs an in-memory index of users and searches it. If you want to use this functionality, add the [picky](https://github.com/floere/picky) gem to your project's Gemfile.
+
+```ruby
+client.users_search(user: 'dblock')
+```
+
 #### Other
 
 Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for the list of all available functions.
@@ -165,15 +173,15 @@ The Real Time Messaging API is a WebSocket-based API that allows you to receive
 client = Slack::RealTime::Client.new
 
 client.on :hello do
-  puts "Successfully connected, welcome '#{client.self['name']}' to the '#{client.team['name']}' team at https://#{client.team['domain']}.slack.com."
+  puts "Successfully connected, welcome '#{client.self.name}' to the '#{client.team.name}' team at https://#{client.team.domain}.slack.com."
 end
 
 client.on :message do |data|
-  case data['text']
+  case data.text
   when 'bot hi' then
-    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+    client.message channel: data.channel, text: "Hi <@#{data.user}>!"
   when /^bot/ then
-    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+    client.message channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end
 
@@ -183,7 +191,7 @@ client.start!
 You can send typing indicators with `typing`.
 
 ```ruby
-client.typing channel: data['channel']
+client.typing channel: data.channel
 ```
 
 You can send a ping with `ping`.
@@ -192,19 +200,23 @@ You can send a ping with `ping`.
 client.ping
 ```
 
-The client exposes the properties of [rtm.start](https://api.slack.com/methods/rtm.start) upon a successful connection.
+By default, the RealTime client exposes and maintains a local store with the properties of [rtm.start](https://api.slack.com/methods/rtm.start) upon a successful connection.
 
 property | description
 ---------|-------------------------------------------------------------------------------------------------
 url      | A WebSocket Message Server URL.
-self     | Details on the authenticated user.
+self     | The authenticated bot user.
 team     | Details on the authenticated user's team.
-users    | A list of user objects, one for every member of the team.
-channels | A list of channel objects, one for every channel visible to the authenticated user.
-groups   | A list of group objects, one for every group the authenticated user is in.
-ims      | A list of IM objects, one for every direct message channel visible to the authenticated user.
+users    | A hash of user objects by user ID.
+channels | A hash of channel objects, one for every channel visible to the authenticated user.
+groups   | A hash of group objects, one for every group the authenticated user is in.
+ims      | A hash of IM objects, one for every direct message channel visible to the authenticated user.
 bots     | Details of the integrations set up on this team.
 
+It also tracks changes, such as users being renamed, added or deleted, therefore `client.users` is always up-to-date.
+
+Tracking with a local store can be disabled with `Slack::RealTime::Client.new(store_class: nil)`
+
 You can configure the RealTime client either globally or via the initializer.
 
 ```ruby
@@ -224,10 +236,12 @@ setting         | description
 token           | Slack API token.
 websocket_ping  | The number of seconds that indicates how often the WebSocket should send ping frames, default is 30.
 websocket_proxy | Connect via proxy, include `:origin` and `:headers`.
+store_class     | Local store class name, default is an in-memory `Slack::RealTime::Store`.
+start_options   | Options to pass into `rtm.start`, default is `{}`.
 
 Note that the RealTime client uses a Web client to obtain the WebSocket URL via [rtm.start](https://api.slack.com/methods/rtm.start), configure Web client options via `Slack::Web::Client.configure` as described above.
 
-See a fullly working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
+See a fully working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
 
 ![](examples/hi_real_time/hi.gif)
 
@@ -239,11 +253,11 @@ Since the Web client is used to obtain the RealTime client's WebSocket URL, you
 client = Slack::RealTime::Client.new
 
 client.on :message do |data|
-  case data['text']
+  case data.text
   when 'bot hi' then
-    client.web_client.chat_postMessage channel: data['channel'], text: "Hi <@#{data['user']}>!"
+    client.web_client.chat_postMessage channel: data.channel, text: "Hi <@#{data.user}>!"
   when /^bot/ then
-    client.web_client.chat_postMessage channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+    client.web_client.chat_postMessage channel: data.channel, text: "Sorry <@#{data.user}>, what?"
   end
 end
 

data/Rakefile

@@ -16,4 +16,7 @@ RuboCop::RakeTask.new
 
 task default: [:rubocop, :spec]
 
-load 'slack/web/api/tasks/generate.rake'
+load 'tasks/git.rake'
+load 'tasks/web.rake'
+load 'tasks/real_time.rake'
+load 'tasks/update.rake'

data/UPGRADING.md

@@ -1,16 +1,54 @@
 Upgrading Slack-Ruby-Client
 ===========================
 
+### Upgrading to >= 0.6.0
+
+#### Changes to API Response Data
+
+API responses in both Web and RealTime clients are now instances of [Slack::Messages::Message](lib/slack/messages/message.rb), which provides method access to properties.
+
+Before:
+
+```ruby
+puts "Welcome '#{client.self['name']}' to the '#{client.team['name']}' team."
+```
+
+After:
+
+```ruby
+puts "Welcome #{client.self.name} to the #{client.team.name} team."
+```
+
+See [#56](https://github.com/dblock/slack-ruby-client/issues/56) for more information.
+
+#### Changes to RealTime Local Store
+
+Upon a successful `rtm.start` the RealTime client keeps a local cache of objects, including `self` or `users`. It will now also track changes to these objects. The following changes have been made to the data structures.
+
+##### client.self
+
+The `client.self` object is now a `Slack::RealTime::Models::User`, which is a child of `Hashie::Mash`, so no code changes should be required.
+
+##### client.team
+
+The `client.team` object is now a `Slack::RealTime::Models::Team`, which is a child of `Hashie::Mash`, so no code changes should be required.
+
+##### client .users, .channels, .groups, .ims
+
+The `client.users`, `.channels`, `.groups` and `.ims` collections have been changed from `Array` to `Hash`, with object ID as key. Replace any code iterating over the array, eg. `client.users.values.each` or `client.channels.each_pair { |id, channel| ... }`.
+
+See [#55](https://github.com/dblock/slack-ruby-client/issues/55) for more information.
+
 ### 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
+##### Faye::WebSocket with Eventmachine
 
 ```
-gem 'faye-webSocket'
+gem 'faye-websocket'
 ```
 
 ##### Celluloid
@@ -19,7 +57,7 @@ gem 'faye-webSocket'
 gem 'celluloid-io'
 ```
 
-When in doubt, use Faye::WebSocket with Eventmachine.
+When in doubt, use `faye-websocket`.
 
 See [#5](https://github.com/dblock/slack-ruby-client/issues/5) for more information.
 

data/bin/commands.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 require 'commands/api'
 require 'commands/auth'

data/bin/commands/api.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Api methods.'
 command 'api' do |g|

data/bin/commands/auth.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Auth methods.'
 command 'auth' do |g|

data/bin/commands/channels.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.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|
@@ -20,8 +20,8 @@ command 'channels' do |g|
     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.desc 'This method returns a portion of message events from the specified channel.'
+  g.long_desc %( This method returns a portion of message events from the specified channel. )
   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.'

data/bin/commands/chat.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Post chat messages to Slack.'
 command 'chat' do |g|

data/bin/commands/dnd.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Adjust and view Do Not Disturb settings for team members'
 command 'dnd' do |g|

data/bin/commands/emoji.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Emoji methods.'
 command 'emoji' do |g|

data/bin/commands/files.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Get info on files uploaded to Slack, upload new files to Slack.'
 command 'files' do |g|
@@ -35,6 +35,7 @@ command 'files' do |g|
   g.long_desc %( This method returns a list of files within the team. It can be filtered and sliced in various ways. )
   g.command 'list' do |c|
     c.flag 'user', desc: 'Filter files created by a single user.'
+    c.flag 'channel', desc: 'Filter files appearing in a specific channel, indicated by its ID.'
     c.flag 'ts_from', desc: 'Filter files created after this timestamp (inclusive).'
     c.flag 'ts_to', desc: 'Filter files created before this timestamp (inclusive).'
     c.flag 'types', desc: 'Filter files by type:

data/bin/commands/groups.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc "Get info on your team's private channels."
 command 'groups' do |g|

data/bin/commands/im.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Get info on your direct messages.'
 command 'im' do |g|

data/bin/commands/mpim.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Get info on your multiparty direct messages.'
 command 'mpim' do |g|

data/bin/commands/oauth.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Oauth methods.'
 command 'oauth' do |g|

data/bin/commands/pins.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Pins methods.'
 command 'pins' do |g|

data/bin/commands/reactions.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Reactions methods.'
 command 'reactions' do |g|

data/bin/commands/rtm.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc 'Rtm methods.'
 command 'rtm' do |g|

data/bin/commands/search.rb

@@ -1,4 +1,4 @@
-# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+# This file was auto-generated by lib/tasks/web.rake
 
 desc "Search your team's files and messages."
 command 'search' do |g|