slack-ruby-bot-server-events 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3de1463a851b1c0e6cc5daa8b2919211d82bffac137626309ac970b16ec0c85
-  data.tar.gz: 3fccc170cf87469ea75374572ca628629bedf43acbd2ef7844b8a67c1147c9cd
+  metadata.gz: 17a7e4563e7eb26dcd8ca99fbe366c3024d927d0716576984ce7371578148ff7
+  data.tar.gz: 7c366ef08784262accb9de4e9a9432c01a30226c24c4e01f3ff0eb6875593701
 SHA512:
-  metadata.gz: c72a69682bed9b58795030edb2f23356e2734bd046d5cbd61c6785bafcb28f2695409586f8fdc727a4098b53036e7c06a5cb554818440ffe30709f82c605edc6
-  data.tar.gz: 8f3eb21e7ddc06069e0109dffd068d64d0d43bdd89656641ad01be26aeaa2ae2e36d01baa191d42cbae6d861d6260879a78fb2407fab484e129433ea184e0862
+  metadata.gz: fef7839cbbdd0892aebc3177a5996603a2cbf89d54b06ed71fb06d85163f27039f7ece113c2ade62b8d12b49cab24d7dfd31d7c67d39b96dde1bfbb7fab1ac73
+  data.tar.gz: a08625699825f3bbfee9c1ec6929bec5a1f7ecdf3a6a16d111a7d543f151000c4498949da68fec417b05d56d1aad23dcd065bffb2b97a752ca3ea22a3108ef9f

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-07-19 11:07:59 -0400 using RuboCop version 0.81.0.
+# on 2020-07-19 23:46:20 -0400 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
@@ -13,9 +13,8 @@ Naming/FileName:
   Exclude:
     - 'lib/slack-ruby-bot-server-events.rb'
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
   Exclude:
-    - 'spec/slack-ruby-bot-server-events/api/endpoints/slack/actions_endpoint_spec.rb'
     - 'spec/slack-ruby-bot-server-events/api/endpoints/slack/events_endpoint_spec.rb'

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
+#### 0.2.0 (07/19/2020)
+
+* Include action type in actions callbacks - [@dblock](https://github.com/dblock).
+
 #### 0.1.0 (07/19/2020)
 
 * Initial public release - [@dblock](https://github.com/dblock).

data/README.md

@@ -1,10 +1,10 @@
-Slack Ruby Bot Server Slack Extensions
+Slack Ruby Bot Server Events Extension
 ======================================
 
 [![Gem Version](https://badge.fury.io/rb/slack-ruby-bot-server-events.svg)](https://badge.fury.io/rb/slack-ruby-bot-server-events)
 [![Build Status](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-events.svg?branch=master)](https://travis-ci.org/slack-ruby/slack-ruby-bot-server-events)
 
-An extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that enables handling of Slack slash commands, interactive buttons and events.
+An extension to [slack-ruby-bot-server](https://github.com/slack-ruby/slack-ruby-bot-server) that makes it easy to handle Slack slash commands, interactive buttons and events.
 
 ### Sample
 
@@ -43,13 +43,15 @@ This library supports events, actions and commands. When implementing multiple c
 
 #### Events
 
-Respond to [Slack Events](https://api.slack.com/events-api) by implementing `SlackRubyBotServer::Events::Config#on :event`. The following example unfurls URLs and fails any other event type.
+Respond to [Slack Events](https://api.slack.com/events-api) by implementing `SlackRubyBotServer::Events::Config#on :event`.
+
+The following example unfurls URLs.
 
 ```ruby
 SlackRubyBotServer::Events.configure do |config|
-  config.on :event, ['event_callback', 'link_shared'] do |event|
+  config.on :event, 'event_callback', 'link_shared' do |event|
     event[:event][:links].each do |link|
-      Slack::Web::Client.new(token: '...').chat_unfurl(
+      Slack::Web::Client.new(token: ...).chat_unfurl(
         channel: event[:event][:channel],
         ts: event[:event][:message_ts],
         unfurls: {
@@ -62,11 +64,13 @@ SlackRubyBotServer::Events.configure do |config|
   end
 
   config.on :event, 'event_callback' do |event|
-    raise "I don't know how to handle #{event[:event][:type]}."
+    # handle any event callback
+    false
   end
 
   config.on :event do |event|
-    raise "I don't know how to handle #{event[:type]}."
+    # handle any event[:event][:type]
+    false
   end
 end
 ```
@@ -74,17 +78,27 @@ end
 
 #### Actions
 
-Respond to [Interactive Message Buttons](https://api.slack.com/legacy/message-buttons) by implementing `SlackRubyBotServer::Events::Config#on :action`.
+Respond to [Shortcuts](https://api.slack.com/interactivity/shortcuts) and [Interactive Message Buttons](https://api.slack.com/legacy/message-buttons) by implementing `SlackRubyBotServer::Events::Config#on :action`.
+
+The following example posts an ephemeral message that counts the letters in a message shortcut.
 
 ```ruby
 SlackRubyBotServer::Events.configure do |config|
-  config.on :action, 'action_id' do |action|
-    # action[:payload][:callback_id] is 'action_id'
-    { text: 'Success!' }
+  config.on :action, 'interactive_message', 'action_id' do |action|
+    payload = action[:payload]
+    message = payload[:message]
+
+    Faraday.post(payload[:response_url], {
+      text: "The text \"#{message[:text]}\" has #{message[:text].size} letter(s).",
+      response_type: 'ephemeral'
+    }.to_json, 'Content-Type' => 'application/json')
+
+    true
   end
 
   config.on :action do |action|
-    { text: "I don't know how to handle #{action[:payload][:callback_id]}." }
+    # handle any other action
+    false
   end
 end
 ```
@@ -93,14 +107,17 @@ end
 
 Respond to [Slash Commands](https://api.slack.com/interactivity/slash-commands) by implementing `SlackRubyBotServer::Events::Config#on :command`.
 
+The following example responds to `/ping` with `pong`.
+
 ```ruby
 SlackRubyBotServer::Events.configure do |config|
-  config.on :command, '/test' do
-    { text: 'Success!' }
+  config.on :command, '/ping' do
+    { text: 'pong' }
   end
 
   config.on :command do |command|
-    { text: "I don't know how to handle #{command[:command]}." }
+    # handle any other command
+    false
   end
 end
 ```

data/lib/slack-ruby-bot-server-events/api/endpoints/slack/actions_endpoint.rb

@@ -14,7 +14,7 @@ module SlackRubyBotServer
                 optional :type, type: String
                 optional :trigger_id, type: String
                 optional :response_url, type: String
-                requires :channel, type: Hash do
+                optional :channel, type: Hash do
                   requires :id, type: String
                   optional :name, type: String
                 end
@@ -31,7 +31,7 @@ module SlackRubyBotServer
                 end
                 optional :message, type: Hash do
                   requires :type, type: String
-                  requires :user, type: String
+                  optional :user, type: String
                   requires :ts, type: String
                   requires :text, type: String
                 end
@@ -39,8 +39,9 @@ module SlackRubyBotServer
             end
             post '/action' do
               action = SlackRubyBotServer::Events::Requests::Action.new(params, request)
+              payload_type = params[:payload][:type]
               callback_id = params[:payload][:callback_id]
-              SlackRubyBotServer::Events.config.run_callbacks(:action, callback_id, action) || body(false)
+              SlackRubyBotServer::Events.config.run_callbacks(:action, [payload_type, callback_id].compact, action) || body(false)
             end
           end
         end

data/lib/slack-ruby-bot-server-events/config.rb

@@ -23,12 +23,10 @@ module SlackRubyBotServer
         end
       end
 
-      def on(types, value = nil, &block)
-        Array(types).each do |type|
-          value_key = Array(value).compact.join('/') if value
-          key = [type.to_s, value_key].compact.join('/')
-          callbacks[key] << block
-        end
+      def on(type, *values, &block)
+        value_key = values.compact.join('/') if values.any?
+        key = [type.to_s, value_key].compact.join('/')
+        callbacks[key] << block
       end
 
       def run_callbacks(type, value, args)

data/lib/slack-ruby-bot-server-events/version.rb

@@ -2,6 +2,6 @@
 
 module SlackRubyBotServer
   module Events
-    VERSION = '0.1.0'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-ruby-bot-server-events
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Doubrovkine
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-19 00:00:00.000000000 Z
+date: 2020-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-ruby-bot-server