slack-ruby-bot-server-rtm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a105023529b8c8461a6e3cd0c27c28aed730128cc33035d5a6545f4e38c9235
+  data.tar.gz: a83384ddb9ac372730192f8e7fba3c96d3d8c87610c280e7fa566482ecf0a653
+SHA512:
+  metadata.gz: d9b72617f72ad3efd05b8240988d97199d55aeed0e77a11f1a4131fb80903889669133ed3408f3dd137bdedef00c38b5babadc9567277cb711cf87c94d6bf67b
+  data.tar.gz: b3aae099e4b071b44ec2f0e8ac705a66538aa8cb57a62e6e30a7ba9e24e488982d94b423adc71f5c74e153ce0f1b152de299e63c1ecfc24fc63402f1b9df2102

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+.rvmrc
+.irbrc
+.bundle
+log
+.env
+*.swp
+Gemfile.lock
+.ruby-version
+pkg

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=documentation
+

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Metrics:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 500
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+inherit_from: .rubocop_todo.yml
+

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-11-14 17:59:41 -0500 using RuboCop version 0.81.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: 1
+# Configuration parameters: IgnoreImplicitReferences.
+Lint/ShadowedArgument:
+  Exclude:
+    - 'lib/slack-ruby-bot-server-rtm/lifecycle.rb'
+
+# Offense count: 2
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'lib/slack-ruby-bot-server-rtm.rb'
+    - 'lib/slack-ruby-bot-server-rtm/ext/slack-ruby-bot.rb'
+
+# Offense count: 2
+# Configuration parameters: ForbiddenDelimiters.
+# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
+Naming/HeredocDelimiterNaming:
+  Exclude:
+    - 'sample_apps/sample_app_activerecord/commands/help.rb'
+    - 'sample_apps/sample_app_mongoid/commands/help.rb'

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+
+cache: bundler
+
+matrix:
+  include:
+    - rvm: 2.6.6
+      script:
+        - bundle exec danger
+    - rvm: 2.6.6
+      env: DATABASE_ADAPTER=activerecord
+      services:
+        - postgresql
+    - rvm: 2.6.6
+      env: DATABASE_ADAPTER=mongoid
+      services:
+        - mongodb
+
+script:
+  - bundle exec rake
+  - BUNDLE_GEMFILE=Gemfile && cd sample_apps/sample_app_$DATABASE_ADAPTER && bundle && RACK_ENV=test bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### Changelog
+
+#### 0.1.0 (2020/11/15)
+
+* Initial public release - [@dblock](https://github.com/dblock).

data/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to SlackRubyBotServer::RealTime
+
+This project is work of [many contributors](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/graphs/contributors).
+
+You're encouraged to submit [pull requests](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/pulls), [propose features and discuss issues](https://github.com/slack-ruby/slack-ruby-bot-server-rtm/issues).
+
+In the examples below, substitute your Github username for `contributor` in URLs.
+
+## Fork the Project
+
+Fork the [project on Github](https://github.com/slack-ruby/slack-ruby-bot-server-rtm) and check out your copy.
+
+```
+git clone https://github.com/contributor/slack-ruby-bot-server-rtm.git
+cd slack-ruby-bot-server-rtm
+git remote add upstream https://github.com/slack-ruby/slack-ruby-bot-server-rtm.git
+```
+
+## 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
+```
+
+## Bundle Install and Test
+
+Ensure that you can build the project and run tests.
+
+```
+bundle install
+bundle exec rake
+```
+
+## 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-bot-server-rtm 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/slack-ruby/slack-ruby-bot-server-rtm/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/Dangerfile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+danger.import_dangerfile(gem: 'slack-ruby-danger')

data/Gemfile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+case ENV['DATABASE_ADAPTER']
+when 'mongoid' then
+  gem 'kaminari-mongoid'
+  gem 'mongoid'
+  gem 'mongoid-scroll'
+when 'activerecord' then
+  gem 'activerecord', '~> 5.0.0'
+  gem 'otr-activerecord', '~> 1.2.1'
+  gem 'virtus'
+  gem 'cursor_pagination' # rubocop:disable Bundler/OrderedGems
+  gem 'pg'
+when nil
+  warn "Missing ENV['DATABASE_ADAPTER']."
+else
+  warn "Invalid ENV['DATABASE_ADAPTER']: #{ENV['DATABASE_ADAPTER']}."
+end
+
+gemspec
+
+group :development, :test do
+  gem 'bundler'
+  gem 'database_cleaner'
+  gem 'fabrication'
+  gem 'faker'
+  gem 'hyperclient'
+  gem 'rack-test'
+  gem 'rake'
+  gem 'rspec'
+  gem 'rubocop', '0.81.0'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :test do
+  gem 'slack-ruby-danger', '~> 0.2.0', require: false
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Daniel Doubrovkine & 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,61 @@
+Slack Ruby Bot Server RealTime (RTM) Extension
+==============================================
+
+[![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server-rtm.svg)](https://badge.fury.io/rb/slack-ruby-bot-server-rtm)
+[![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-rtm.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-rtm)
+
+An extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that makes it easy to implement Slack RTM bots.
+
+### Sample
+
+See [slack-ruby/slack-ruby-bot-server-rtm-sample](https://github.com/slack-ruby/slack-ruby-bot-server-rtm-sample) for a working sample.
+
+### Usage
+
+#### Gemfile
+
+Add 'slack-ruby-bot-server-rtm' to Gemfile.
+
+```ruby
+gem 'slack-ruby-bot-server-rtm'
+```
+
+#### Configure
+
+```ruby
+SlackRubyBotServer::RealTime.configure do |config|
+  config.server_class = ...
+end
+```
+
+The following settings are supported.
+
+setting               | description
+----------------------|------------------------------------------------------------------
+server_class          | Handler class for additional events.
+
+##### Server Class
+
+You can override the server class to handle additional events, and configure the service to use it.
+
+```ruby
+class MyServer < SlackRubyBotServer::Server
+  on :hello do |client, data|
+    # connected to Slack
+  end
+
+  on :channel_joined do |client, data|
+    # the bot joined a channel in data.channel['id']
+  end
+end
+
+SlackRubyBotServer::RealTime.configure do |config|
+  config.server_class = MyServer
+end
+```
+
+### Copyright & License
+
+Copyright [Daniel Doubrovkine](http://code.dblock.org) and Contributors, 2020
+
+[MIT License](LICENSE)

data/RELEASING.md

@@ -0,0 +1,61 @@
+# Releasing Slack-Ruby-Bot-Server-Rtm
+
+There're no hard rules about when to release slack-ruby-bot-server-rtm. Release bug fixes frequently, 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/slack-ruby/slack-ruby-bot-server-rtm) for all supported platforms.
+
+Change "Next" in [CHANGELOG.md](CHANGELOG.md) to the current date.
+
+```
+### 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
+git commit -m "Preparing for release, 0.2.2."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+slack-ruby-bot-server-rtm 0.2.2 built to pkg/slack-ruby-bot-server-rtm-0.2.2.gem.
+Tagged v0.2.2.
+Pushed git commits and tags.
+Pushed slack-ruby-bot-server-rtm 0.2.2 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.2.3 (Next)
+
+* Your contribution here.
+```
+
+Increment the third version number in [lib/slack-ruby-bot-server-rtm/version.rb](lib/slack-ruby-bot-server-rtm/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/slack-ruby-bot-server-rtm/version.rb
+git commit -m "Preparing for next development iteration, 0.2.3."
+git push origin master
+```

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb'].exclude(%r{ext\/(?!#{ENV['DATABASE_ADAPTER']})})
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/lib/slack-ruby-bot-server-rtm.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'slack-ruby-bot'
+require 'slack-ruby-bot-server'
+
+require_relative 'slack-ruby-bot-server-rtm/version'
+require_relative 'slack-ruby-bot-server-rtm/server'
+require_relative 'slack-ruby-bot-server-rtm/config'
+require_relative 'slack-ruby-bot-server-rtm/ext'
+require_relative 'slack-ruby-bot-server-rtm/lifecycle'