slack-ruby-client-bhe 0.5.4

data/RELEASING.md

@@ -0,0 +1,69 @@
+# Releasing Slack-Ruby-Client
+
+There're no hard rules about when to release slack-ruby-client. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/dblock/slack-ruby-client) for all supported platforms.
+
+Increment the version, modify [lib/slack/version.rb](lib/slack/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.2.1` to `0.2.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.2.1` to `0.3.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.2.2 (7/10/2015)
+```
+
+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 README.md CHANGELOG.md lib/slack/version.rb
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+slack-ruby-client 0.2.2 built to pkg/slack-ruby-client-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed slack-ruby-client 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+Next Release
+============
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/slack/version.rb](lib/slack/version.rb).
+
+Comit your changes.
+
+```
+git add CHANGELOG.md lib/slack/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+require 'bundler/gem_tasks'
+
+Bundler.setup :default, :development
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]
+
+load 'slack/web/api/tasks/generate.rake'

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,21 @@
+# 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/dnd'
+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,149 @@
+# 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 they are not currently in, and archived channels but does not include private channels. The number of (non-deactivated) members in each channel is also returned.'
+  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 but does not include private 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
+
+  g.desc 'This method returns the ID of a team channel.'
+  g.long_desc %( This method returns the ID of a team channel. )
+  g.command 'id' do |c|
+    c.flag 'channel', desc: 'Channel to get ID for, prefixed with #.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.channels_id(options))
+    end
+  end
+end

data/bin/commands/chat.rb

@@ -0,0 +1,47 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Post chat messages to Slack.'
+command 'chat' do |g|
+  g.desc 'This method deletes a message from a channel.'
+  g.long_desc %( This method deletes a message from a channel. )
+  g.command 'delete' do |c|
+    c.flag 'ts', desc: 'Timestamp of the message to be deleted.'
+    c.flag 'channel', desc: 'Channel containing the message to be deleted.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.chat_delete(options))
+    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.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 'username', desc: 'Name of bot.'
+    c.flag 'as_user', desc: 'Pass true to post the message as the authed user, instead of as a bot.'
+    c.flag 'parse', desc: 'Change how messages are treated. See below.'
+    c.flag 'link_names', desc: 'Find and link channel names and usernames.'
+    c.flag 'attachments', desc: 'Structured message attachments.'
+    c.flag 'unfurl_links', desc: 'Pass true to enable unfurling of primarily text-based content.'
+    c.flag 'unfurl_media', desc: 'Pass false to disable unfurling of media content.'
+    c.flag 'icon_url', desc: 'URL to an image to use as the icon for this message.'
+    c.flag 'icon_emoji', desc: 'emoji to use as the icon for this message. Overrides icon_url.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.chat_postMessage(options))
+    end
+  end
+
+  g.desc 'This method updates a message in a channel.'
+  g.long_desc %( This method updates a message in a channel. )
+  g.command 'update' do |c|
+    c.flag 'ts', desc: 'Timestamp of the message to be updated.'
+    c.flag 'channel', desc: 'Channel containing the message to be updated.'
+    c.flag 'text', desc: 'New text for the message, using the default formatting rules.'
+    c.flag 'attachments', desc: 'Structured message attachments.'
+    c.flag 'parse', desc: 'Change how messages are treated. See below.'
+    c.flag 'link_names', desc: 'Find and link channel names and usernames.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.chat_update(options))
+    end
+  end
+end

data/bin/commands/dnd.rb

@@ -0,0 +1,47 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Adjust and view Do Not Disturb settings for team members'
+command 'dnd' do |g|
+  g.desc "Ends the user's currently scheduled Do Not Disturb session immediately."
+  g.long_desc %( Ends the user's currently scheduled Do Not Disturb session immediately. )
+  g.command 'endDnd' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.dnd_endDnd(options))
+    end
+  end
+
+  g.desc "Ends the current user's snooze mode immediately."
+  g.long_desc %( Ends the current user's snooze mode immediately. )
+  g.command 'endSnooze' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.dnd_endSnooze(options))
+    end
+  end
+
+  g.desc "Provides information about a user's current Do Not Disturb settings."
+  g.long_desc %( Provides information about a user's current Do Not Disturb settings. )
+  g.command 'info' do |c|
+    c.flag 'user', desc: 'User to fetch status for (defaults to current user).'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.dnd_info(options))
+    end
+  end
+
+  g.desc "Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration."
+  g.long_desc %( Adjusts the snooze duration for a user's Do Not Disturb settings. If a snooze session is not already active for the user, invoking this method will begin one for the specified duration. )
+  g.command 'setSnooze' do |c|
+    c.flag 'num_minutes', desc: 'Number of minutes, from now, to snooze until.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.dnd_setSnooze(options))
+    end
+  end
+
+  g.desc 'Provides information about the current Do Not Disturb settings for users of a Slack team.'
+  g.long_desc %( Provides information about the current Do Not Disturb settings for users of a Slack team. )
+  g.command 'teamInfo' do |c|
+    c.flag 'users', desc: 'Comma-separated list of users to fetch Do Not Disturb status for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.dnd_teamInfo(options))
+    end
+  end
+end

data/bin/commands/emoji.rb

@@ -0,0 +1,12 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Emoji methods.'
+command 'emoji' do |g|
+  g.desc 'This method lists the custom emoji for a team.'
+  g.long_desc %( This method lists the custom emoji for a team. )
+  g.command 'list' do |c|
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.emoji_list(options))
+    end
+  end
+end

data/bin/commands/files.rb

@@ -0,0 +1,72 @@
+# This file was auto-generated by lib/slack/web/api/tasks/generate.rake
+
+desc 'Get info on files uploaded to Slack, upload new files to Slack.'
+command 'files' do |g|
+  g.desc 'Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed.'
+  g.long_desc %( Edit an existing comment on a file. Only the user who created a comment may make edits. Teams may configure a limited time window during which file comment edits are allowed. )
+  g.command 'comments' do |c|
+    c.flag 'file', desc: 'File containing the comment to edit.'
+    c.flag 'id', desc: 'The comment to edit.'
+    c.flag 'comment', desc: 'Text of the comment to edit.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_comments(options))
+    end
+  end
+
+  g.desc 'This method deletes a file from your team.'
+  g.long_desc %( This method deletes a file from your team. )
+  g.command 'delete' do |c|
+    c.flag 'file', desc: 'ID of file to delete.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_delete(options))
+    end
+  end
+
+  g.desc 'This method returns information about a file in your team.'
+  g.long_desc %( This method returns information about a file in your team. )
+  g.command 'info' do |c|
+    c.flag 'file', desc: 'File to fetch info for.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_info(options))
+    end
+  end
+
+  g.desc 'This method returns a list of files within the team. It can be filtered and sliced in various ways.'
+  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 '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:
+
+all - All files
+posts - Posts
+snippets - Snippets
+images - Image files
+gdocs - Google docs
+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.
+.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_list(options))
+    end
+  end
+
+  g.desc 'This method allows you to create or upload an existing file.'
+  g.long_desc %( This method allows you to create or upload an existing file. )
+  g.command 'upload' do |c|
+    c.flag 'file', desc: 'File contents via multipart/form-data.'
+    c.flag 'content', desc: 'File contents via a POST var.'
+    c.flag 'filetype', desc: 'Slack-internal file type identifier.'
+    c.flag 'filename', desc: 'Filename of file.'
+    c.flag 'title', desc: 'Title of file.'
+    c.flag 'initial_comment', desc: 'Initial comment to add to file.'
+    c.flag 'channels', desc: 'Comma-separated list of channel names or IDs where the file will be shared.'
+    c.action do |_global_options, options, _args|
+      puts JSON.dump($client.files_upload(options))
+    end
+  end
+end