slack-ruby-bot 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22dc3beb892b34e2ac402dda4e3406b06ad7b60d25c6db1098517934f599a000
-  data.tar.gz: 8d089bd14bf6a096a89711627f459504bc3ba6a1dc04d1c45eff4c40476cf8ab
+  metadata.gz: f7cdc662d2370824e2b531aecde4c20b1f55e895e8e10d9c1804ca44a160b884
+  data.tar.gz: 3b5e9e13786df070f3d400c96e4752b4a6e2608472ab889d30e20e3ba95df6d1
 SHA512:
-  metadata.gz: ff99ab182faab024601afe41a40fa8b66c589aeaf66d02819ad05196200e4ef3d6cd7e5fae6c670630f3b7225d96fc33d0031e370852b3ba6bdd33acfc182a22
-  data.tar.gz: dd313bbae823189799d92888222f9433a6cba629aba7ac7e922dfd7154317c3332ad1ff1246a6537ec2000626826866bb4ebcf2fb857aac614609cedcd6ba0b2
+  metadata.gz: 1018f35fb9be750feaf55a420b7ed6faa305e3e3ff6ea6e271db16951e898893b1a96ad184103e37a47e24f28adef7cecee02788821c37ac34e0f7f916620d5a
+  data.tar.gz: a838815a6d65920fe1e1602e606e3bb73ab55c0176c9f565166f87d8cc643b42e37ab785f672ea651d2a156e93de68bf0eeff16b5237da0e6a75b7a98d7c2490

data/.gitignore

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

data/.rubocop.yml

@@ -1,4 +1,5 @@
 AllCops:
+  TargetRubyVersion: 2.3
   Exclude:
     - vendor/**/*
     - examples/**/vendor/**/*
@@ -7,10 +8,22 @@ AllCops:
 Metrics:
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 512
 
 Style/Documentation:
   Enabled: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,36 +1,29 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-08-27 14:16:34 +0200 using RuboCop version 0.58.2.
+# on 2020-03-28 18:37:09 -0400 using RuboCop version 0.80.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: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
-Layout/IndentHeredoc:
-  Exclude:
-    - 'lib/slack-ruby-bot/commands/help.rb'
-    - 'spec/slack-ruby-bot/commands/help_spec.rb'
-
 # Offense count: 1
 Lint/DuplicateMethods:
   Exclude:
     - 'lib/slack-ruby-bot/hooks/set.rb'
 
 # Offense count: 2
-Lint/HandleExceptions:
+# Configuration parameters: AllowComments.
+Lint/SuppressedException:
   Exclude:
     - 'lib/initializers/giphy.rb'
     - 'lib/initializers/giphy_client.rb'
 
 # Offense count: 1
-# Cop supports --auto-correct.
-Lint/UnneededCopEnableDirective:
+# 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:
-    - 'Gemfile'
+    - 'lib/slack-ruby-bot.rb'
 
 # Offense count: 2
 # Configuration parameters: EnforcedStyle.
@@ -51,27 +44,11 @@ Style/DoubleNegation:
   Exclude:
     - 'lib/slack-ruby-bot/commands/base.rb'
 
-# Offense count: 5
-# Cop supports --auto-correct.
-Style/ExpandPathArguments:
-  Exclude:
-    - 'lib/config/application.rb'
-    - 'lib/config/environment.rb'
-    - 'lib/slack-ruby-bot.rb'
-    - 'slack-ruby-bot.gemspec'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/slack-ruby-bot/commands/support/match.rb'
-    - 'lib/slack-ruby-bot/mvc/controller/base.rb'
-
-# Offense count: 2
+# Offense count: 1
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: module_function, extend_self
-Style/ModuleFunction:
+# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
   Exclude:
-    - 'lib/initializers/giphy_client.rb'
-    - 'lib/slack-ruby-bot/config.rb'
+    - 'spec/**/*'
+    - 'examples/market/marketbot.rb'

data/.travis.yml

@@ -4,7 +4,7 @@ cache: bundler
 
 matrix:
   include:
-    - rvm: 2.3.0
+    - rvm: 2.6.5
       script:
         - bundle exec danger
     - rvm: 2.3.0
@@ -12,14 +12,16 @@ matrix:
     - rvm: 2.3.0
       env: CONCURRENCY=faye-websocket
     - rvm: 2.3.0
+      env: CONCURRENCY=async-websocket
+    - rvm: 2.6.5
       env: CONCURRENCY=celluloid-io WITH_GIPHY=true
-    - rvm: 2.3.0
+    - rvm: 2.6.5
       env: CONCURRENCY=faye-websocket WITH_GIPHY=true
-    - rvm: 2.3.0
+    - rvm: 2.6.5
       env: CONCURRENCY=celluloid-io WITH_GIPHY_CLIENT=true
-    - rvm: 2.3.0
+    - rvm: 2.6.5
       env: CONCURRENCY=faye-websocket WITH_GIPHY_CLIENT=true
-    - rvm: 2.5
+    - rvm: 2.6.5
       env: CONCURRENCY=async-websocket WITH_GIPHY_CLIENT=true
     - rvm: ruby-head
     - rvm: jruby-head

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.13.0 (2020/3/28)
+
+* [#244](https://github.com/slack-ruby/slack-ruby-bot/pull/244): Change log message when the bot is reconnected - [@wasabigeek](https://github.com/wasabigeek).
+* [#209](https://github.com/slack-ruby/slack-ruby-bot/pull/209): Allow `respond_to_slack_message` and `respond_to_slack_messages` without arguments - [@dblock](https://github.com/dblock).
+* [#216](https://github.com/slack-ruby/slack-ruby-bot/pull/216): Added `start_typing` RSpec matcher - [@dblock](https://github.com/dblock).
+* [#214](https://github.com/slack-ruby/slack-ruby-bot/pull/214): Add passenger deployment documentation - [@cybercrediators](https://github.com/cybercrediators).
+* [#220](https://github.com/slack-ruby/slack-ruby-bot/pull/220): Updated examples/market to pull from IEX instead of defunct yahoo service - [@corprew](https://github.com/corprew).
+* [#246](https://github.com/slack-ruby/slack-ruby-bot/pull/246): Drop support for Ruby 2.2 - [@dblock](https://github.com/dblock).
+
 ### 0.12.0 (2019/2/25)
 
 * [#203](https://github.com/slack-ruby/slack-ruby-bot/pull/203): Removing restart logic - [@RodneyU215](https://github.com/RodneyU215).

data/DEPLOYMENT.md

@@ -1,16 +1,20 @@
 ## Installation
 
-Create a new Bot Integration under [services/new/bot](http://slack.com/services/new/bot).
+To integrate your bot with Slack, you must first create a new [Slack App](https://api.slack.com/apps).
 
-![](screenshots/register-bot.png)
-
-On the next screen, note the API token.
+![](screenshots/create-app.png)
 
 ### Environment
 
+#### OAuth Code Grant
+
+Once created, go to the app's Basic Info tab and grab the Client ID and Client Secret.  You'll need these in order complete an [OAuth code grant flow](https://api.slack.com/docs/oauth#flow) as described at [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server).  A successful flow will result in the receipt of an API token for the specific team that is granting access.
+
+Alternatively, you can still [generate a legacy API token](https://api.slack.com/custom-integrations/legacy-tokens) for your app and use it for some interactions.
+
 #### SLACK_API_TOKEN
 
-Set SLACK_API_TOKEN from the Bot integration settings on Slack.
+Set the SLACK_API_TOKEN environment variable using the token received above.
 
 ```
 heroku config:add SLACK_API_TOKEN=...
@@ -31,3 +35,55 @@ heroku config:add SLACK_RUBY_BOT_ALIASES=":pong: table-tennis ping-pong"
 ### Heroku Idling
 
 Heroku free tier applications will idle. Either pay 7$ a month for the hobby dyno or use [UptimeRobot](http://uptimerobot.com) or similar to prevent your instance from sleeping or pay for a production dyno.
+
+### Passenger Deployment
+
+Deploying on your self-hosted server is fairly easy, it's pretty much following the [tutorial](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby), but there are some configuration details to pay attention to.
+
++ Change or add the `gem 'puma'` entry in your `Gemfile` to `gem 'passenger'` and `bundle` it
+  + OPTIONAL: To use passenger for developing too, change the `Procfile` to `web: bundle exec passenger start`, to configure the local passenger you could provide an optional `Passenger.json` file ([configuration options](https://www.phusionpassenger.com/library/config/standalone/reference/))
++ If you want to keep your logs etc. in the correct folders, you could add empty `public/`, `tmp/` and `log` directories. Passenger e.g. will automatically use them for local log files.
++ Make sure, the right ruby version is [installed](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_language_runtime.html) and your passenger is [ready](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/install_passenger_main.html) to go.
++ Clone the repository on your server (You could create a separate user for this) and install the dependencies, by running `bundle install` ([More information](https://www.phusionpassenger.com/library/walkthroughs/deploy/ruby/ownserver/nginx/oss/xenial/deploy_app.html))
++ Edit the web-server configuration according to the examples below
+  + `PassengerMaxPreloaderIdleTime 0` or `passenger_max_preloader_idle_time 0;` makes sure to not automatically shut down the process after 5 minutes
+  + `PassengerPreStart http://url:port` or `passenger_pre_start http://url:port` will startup the application instantly, without the first HTTP GET-request needed for passenger
+  + To get the `/path/to/ruby` run `passenger-config about ruby-command` and copy the displayed path
+  + Check the config (`nginx -t`) and restart the server with `service nginx restart`
+  + Execute `passenger-status --verbose` to check if your app is working correctly
+  + Optional: restart the passenger app via `passenger-config restart-app /var/www/bot`
+
+#### Nginx
+
+```
+server {
+  listen 80;
+  server_name example.com;
+  root /var/www/bot/public;
+  passenger_enabled on;
+  passenger_ruby /path/to/ruby
+  passenger_max_preloader_idle_time 0;
+  passenger_app_type rack;
+}
+
+passenger_pre_start http://example.com:80/;
+```
+
+#### Apache
+
+```
+<VirtualHost *:80>
+  ServerName example.com
+  DocumentRoot /var/www/bot/public
+  PassengerRuby /path/to/ruby
+  PassengerMaxPreloaderIdleTime 0
+
+  <Directory /var/www/bot/public>
+    Allow from all
+    Options -MultiViews
+    Require all granted    
+  </Directory>
+</VirtualHost>
+
+PassengerPreStart http://example.com:80/
+```

data/Dangerfile

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

data/Gemfile

@@ -1,10 +1,17 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 gemspec
 
-gem ENV['CONCURRENCY'], require: false if ENV.key?('CONCURRENCY')
-
-# rubocop:enable Bundler/OrderedGems
+if ENV.key?('CONCURRENCY')
+  case ENV['CONCURRENCY']
+  when 'async-websocket'
+    gem 'async-websocket', '~> 0.8.0', require: false
+  else
+    gem ENV['CONCURRENCY'], require: false
+  end
+end
 
 gem 'giphy', require: false if ENV.key?('WITH_GIPHY')
 gem 'GiphyClient', require: false if ENV.key?('WITH_GIPHY_CLIENT')

data/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2016 Daniel Doubrovkine, Artsy and Contributors
+Copyright (c) 2015-2020 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

data/README.md

@@ -19,8 +19,7 @@ If you are not familiar with Slack bots or Slack API concepts, you might want to
 
 ## Stable Release
 
-You're reading the documentation for the **stable** release of slack-ruby-bot, v0.12.0.
-See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
+You're reading the documentation for the **stable** release of slack-ruby-bot, v0.13.0. See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING.md) for how to upgrade to more recent versions.
 
 ## Usage
 
@@ -32,7 +31,7 @@ See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING
 source 'https://rubygems.org'
 
 gem 'slack-ruby-bot'
-gem 'async-websocket'
+gem 'async-websocket', '~>0.8.0'
 ```
 
 #### pongbot.rb
@@ -269,7 +268,7 @@ class Market < SlackRubyBot::Bot
   command 'help' do |client, data, match|
     user_command = match[:expression]
     help_attrs = SlackRubyBot::Commands::Support::Help.instance.find_command_help_attrs(user_command)
-    client.say(channel: data.channel, text: "#{help_attrs.command_desc}\n\n#{help_attrs.command_long_desc}"
+    client.say(channel: data.channel, text: "#{help_attrs.command_desc}\n\n#{help_attrs.command_long_desc}")
   end
 end
 ```
@@ -381,7 +380,7 @@ Get help.
 
 Hooks are event handlers and respond to Slack RTM API [events](https://api.slack.com/events), such as [hello](lib/slack-ruby-bot/hooks/hello.rb) or [message](lib/slack-ruby-bot/hooks/message.rb). You can implement your own in a couple of ways:
 
-#### Implement and register a Hook Handler
+#### Implementing and registering a Hook Handler
 
 A Hook Handler is any object that respond to a `call` message, like a proc, instance of an object, class with a `call` class method, etc.
 
@@ -625,7 +624,7 @@ class MyView < SlackRubyBot::MVC::View::Base
 
   def react_thumbsup
     client.web_client.reactions_add(
-      name: :thumbs_up,
+      name: :thumbsup,
       channel: data.channel,
       timestamp: data.ts,
       as_user: true)
@@ -633,7 +632,7 @@ class MyView < SlackRubyBot::MVC::View::Base
 
   def react_thumbsdown
     client.web_client.reactions_remove(
-      name: :thumbs_up,
+      name: :thumbsup,
       channel: data.channel,
       timestamp: data.ts,
       as_user: true)
@@ -652,14 +651,17 @@ Again, the View will have access to the most up to date `client`, `data`, and `m
 
 View methods are not matched to routes, so there is no restriction on how to name methods as there is in Controllers.
 
-### RSpec Shared Behaviors
+### Testing
+
+#### RSpec Shared Behaviors
 
-Slack-ruby-bot ships with a number of shared RSpec behaviors that can be used in your RSpec tests.
+Slack-ruby-bot comes with a number of shared RSpec behaviors that can be used in your RSpec tests.
 
 * [behaves like a slack bot](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/it_behaves_like_a_slack_bot.rb): A bot quacks like a Slack Ruby bot.
 * [respond with slack message](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_message.rb): The bot responds with a message.
 * [respond with slack messages](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_slack_messages.rb): The bot responds with a multiple messages.
 * [respond with error](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/respond_with_error.rb): An exception is raised inside a bot command.
+* [start typing](lib/slack-ruby-bot/rspec/support/slack-ruby-bot/start_typing.rb): The bot calls `client.start_typing`.
 
 Require `slack-ruby-bot/rspec` in your `spec_helper.rb` along with the following dependencies in Gemfile.
 
@@ -672,6 +674,72 @@ group :development, :test do
 end
 ```
 
+Use the `respond_with_slack_message` matcher.
+
+```ruby
+describe SlackRubyBot::Commands do
+  it 'responds with any message' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message
+  end
+  it 'says hi' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message('hi')
+  end
+end
+```
+
+Use the `respond_with_slack_messages` matcher for multiple messages.
+
+```ruby
+describe SlackRubyBot::Commands do
+  it 'responds with more than one message' do
+    expect(message: "#{SlackRubyBot.config.user} count").to respond_with_slack_messages
+  end
+  it 'says one and two' do
+    expect(message: "#{SlackRubyBot.config.user} count").to respond_with_slack_messages(['one', 'two'])
+  end
+end
+```
+
+Message matchers support regular expressions.
+
+```ruby
+describe SlackRubyBot::Commands do
+  it 'says hi' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to respond_with_slack_message(/hi/)
+  end
+end
+```
+
+Check that the bot called `client.start_typing(channel: 'channel')`.
+
+```ruby
+describe SlackRubyBot::Commands do
+ it 'starts typing on channel' do
+    expect(message: "#{SlackRubyBot.config.user} hi").to start_typing(channel: 'channel')
+  end
+end
+```
+
+#### Testing Lower Level Messages
+
+You can test client behavior at a lower level by fetching the message hook. The following example expects a bot command to call `client.typing(channel: data.channel)`.
+
+```ruby
+describe SlackRubyBot::Commands do
+  let(:app) { Server.new }
+  let(:client) { app.send(:client) }
+  let(:message_hook) { SlackRubyBot::Hooks::Message.new }
+  it 'receives a typing event' do
+      expect(client).to receive(:typing)
+      message_hook.call(
+        client,
+        Hashie::Mash.new(text: "#{SlackRubyBot.config.user} type something", channel: 'channel')
+      )
+    end
+  end
+end
+```
+
 ### Useful Libraries
 
 * [newrelic-slack-ruby-bot](https://github.com/dblock/newrelic-slack-ruby-bot): NewRelic instrumentation for slack-ruby-bot.
@@ -686,6 +754,6 @@ See [CHANGELOG](CHANGELOG.md) for a history of changes and [UPGRADING](UPGRADING
 
 ## Copyright and License
 
-Copyright (c) 2015-2016, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
+Copyright (c) 2015-2020, [Daniel Doubrovkine](https://twitter.com/dblockdotorg), [Artsy](https://www.artsy.net) and [Contributors](CHANGELOG.md).
 
 This project is licensed under the [MIT License](LICENSE.md).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'bundler'
 require 'bundler/gem_tasks'