slack-ruby-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bfc38c6f34626b363ad4323f0fab5a791e77ca3b
+  data.tar.gz: dc37a02ec0492a1191f7fe1f495b704be45e344d
+SHA512:
+  metadata.gz: 0b37c6b2289f5337239d52b199cbf0b224f1a7d8f4c510de22295ca2686f04f15aab992eead738cc69799e63230accdea1636ca9e3e2d9e9723f9ee3985f7e2c
+  data.tar.gz: 5441b5ebb561df58e6233b7444f154f76bd6227b7657c4d402eb444ca709954315e771dbfc99683e481a606b3897f4a14f41bc3e91f79d81380dcee61b03086d

data/.gitignore

@@ -0,0 +1,4 @@
+.env
+pkg
+Gemfile.lock
+.DS_Store

data/.gitmodules

@@ -0,0 +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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,34 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-07-25 14:51:14 -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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 77
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 153
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 16
+
+# Offense count: 26
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Offense count: 9
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/MethodName:
+  Enabled: false
+
+# Offense count: 2
+Style/ModuleFunction:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 2.2
+
+git:
+  submodules: false
+

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 0.1.0 (7/25/2015)
+
+* Initial public release with Web and RealTime Messaging API support - [@dblock](https://github.com/dblock).
+

data/CONTRIBUTING.md

@@ -0,0 +1,139 @@
+# Contributing to Slack
+
+This project is work of [many contributors](https://github.com/dblock/slack-ruby-client/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/dblock/slack-ruby-client/pulls), [propose features and discuss issues](https://github.com/dblock/slack-ruby-client/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+## Fork the Project
+
+Fork the [project on Github](https://github.com/dblock/slack-ruby-client) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-client.git
+cd slack-ruby-client
+git remote add upstream https://github.com/dblock/slack-ruby-client.git
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## Run Slack in Development
+
+Create a private slack group for yourself.
+
+Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
+
+![](screenshots/register-bot.png)
+
+On the next screen, note the API token.
+
+Run `SLACK_API_TOKEN=<your API token> foreman start`.
+
+You can also create a `.env` file with `SLACK_API_TOKEN=<your API token>` and just run `foreman start`.
+
+## Create a Topic Branch
+
+Make sure your fork is up-to-date and create a topic branch for your feature or bug fix.
+
+```
+git checkout master
+git pull upstream master
+git checkout -b my-feature-branch
+```
+
+## Write Tests
+
+Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
+Add to [spec](spec).
+
+We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
+
+## Write Code
+
+Implement your feature or bug fix.
+
+Ruby style is enforced with [Rubocop](https://github.com/bbatsov/rubocop).
+Run `bundle exec rubocop` and fix any style issues highlighted.
+
+Make sure that `bundle exec rake` completes without errors.
+
+## Write Documentation
+
+Document any external behavior in the [README](README.md).
+
+## Update Changelog
+
+Add a line to [CHANGELOG](CHANGELOG.md) under *Next Release*.
+Make it look like every other line, including your name and link to your Github account.
+
+## Commit Changes
+
+Make sure git knows your name and email address:
+
+```
+git config --global user.name "Your Name"
+git config --global user.email "contributor@example.com"
+```
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+
+```
+git add ...
+git commit
+```
+
+## Push
+
+```
+git push origin my-feature-branch
+```
+
+## Make a Pull Request
+
+Go to https://github.com/contributor/slack-ruby-client and select your feature branch.
+Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
+
+## Rebase
+
+If you've been working on a change for a while, rebase with upstream/master.
+
+```
+git fetch upstream
+git rebase upstream/master
+git push origin my-feature-branch -f
+```
+
+## Update CHANGELOG Again
+
+Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
+
+```
+* [#123](https://github.com/dblock/slack-ruby-client/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+```
+
+Amend your previous commit and force push the changes.
+
+```
+git commit --amend
+git push origin my-feature-branch -f
+```
+
+## Check on Your Pull Request
+
+Go back to your pull request after a few minutes and see whether it passed muster with Travis-CI. Everything should look green, otherwise fix issues and amend your commit as described above.
+
+## Be Patient
+
+It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang on there!
+
+## Thank You
+
+Please do know that we really appreciate and value your time and work. We love you, really.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2015 Daniel Doubrovkine, Artsy and Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+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)
+
+A Ruby client for the Slack [Web](https://api.slack.com/web) and [RealTime Messaging](https://api.slack.com/rtm) APIs.
+
+## Installation
+
+Add to Gemfile.
+
+```
+gem 'slack-ruby-client'
+```
+
+Run `bundle install`.
+
+## Usage
+
+### Create a New Bot Integration
+
+This is something done in Slack, under [integrations](https://artsy.slack.com/services). Create a [new bot](https://artsy.slack.com/services/new/bot), and note its API token.
+
+![](screenshots/register-bot.png)
+
+### Use the API Token
+
+```ruby
+Slack.configure do |config|
+  config.token = ENV['SLACK_API_TOKEN']
+end
+```
+
+### Web Client
+
+The Slack Web API allows you to build applications that interact with Slack. For example, send messages with [chat_PostMessage](https://api.slack.com/methods/chat.postMessage).
+
+```ruby
+client = Slack::Web::Client.new
+
+client.auth_test
+
+general_channel = client.channels_list['channels'].detect { |c| c['name'] == 't3' }
+
+client.chat_postMessage(channel: general_channel['id'], text: 'Hello World', as_user: true)
+```
+
+See a fully working example in [examples/hi_web](examples/hi_web/hi.rb).
+
+![](examples/hi_web/hi.gif)
+
+Refer to the [Slack Web API Method Reference](https://api.slack.com/methods) for the list of all available functions.
+
+### RealTime Client
+
+The Real Time Messaging API is a WebSocket-based API that allows you to receive events from Slack in real time and send messages as user.
+
+```ruby
+client = Slack::RealTime::Client.new
+
+client.on :hello do
+  puts 'Successfully connected.'
+end
+
+client.on :message do |data|
+  case data['text']
+  when 'bot hi' then
+    client.message channel: data['channel'], text: "Hi <@#{data['user']}>!"
+  when /^bot/ then
+    client.message channel: data['channel'], text: "Sorry <@#{data['user']}>, what?"
+  end
+end
+
+client.start!
+```
+
+You can also send typing indicators.
+
+```ruby
+client.typing channel: data['channel']
+```
+
+See a fullly working example in [examples/hi_real_time](examples/hi_real_time/hi.rb).
+
+![](examples/hi_real_time/hi.gif)
+
+### Combinging RealTime and Web Clients
+
+Since the web client is used to obtain the RealTime client's WebSocket URL, you can continue using the web client in combination with the RealTime client.
+
+```ruby
+client = Slack::RealTime::Client.new
+
+client.on :message do |data|
+  case data['text']
+  when 'bot hi' then
+    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?"
+  end
+end
+
+client.start!
+```
+
+See a fullly working example in [examples/hi_real_time_and_web](examples/hi_real_time_and_web/hi.rb).
+
+![](examples/hi_real_time_and_web/hi.gif)
+
+## 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.
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## Copyright and License
+
+Copyright (c) 2015, Daniel Doubrovkine, Artsy and [Contributors](CHANGELOG.md).
+
+This project is licensed under the [MIT License](LICENSE.md).

data/RELEASING.md

@@ -0,0 +1,67 @@
+# Releasing SlackRubyClient
+
+There're no particular 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.
+
+Commit your changes.
+
+```
+git add 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'