slackify 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d1e93f4b0ce3d49b5f99a9299b8d6a188ec05214dbd64d862270d57d1b1d676
-  data.tar.gz: b86db43ec488d1a2bb92cbba7cb3c3daae39aca2b5ea01808d3ca60b26574ce3
+  metadata.gz: a9eb0e55419a369b830a072f4755238a259368914b4acfb68c6f590f87c5622f
+  data.tar.gz: 1504168aaae4c0b69df9d56757abf8ee44792929146aaeb78e2b8c1726b096d3
 SHA512:
-  metadata.gz: 9d6829fab21c24bbc5af54344ff4ca1e868506ea12c2556c4013440ffff034d7a026430571285808e2d0f742c88ba548ff55680348d69974a9a0c765926a738f
-  data.tar.gz: c5b55b8c19a0d0d24b71792292248da8da76af43ba35594448c1a5322a4b986fb7a04449982230acce954bea52fb4eee19c476ea1a8e2e68813b8272ccbc86b7
+  metadata.gz: 2055ad77d1a5a50f910f8371e45a13524ebb32ccacd519e35b2fc51aea82846ff986c5b5628891965efbb83d6807fc912419febff85cd46e25a7c3df22ec86da
+  data.tar.gz: da892b1e5f85dbe93b97649ceda4dbbc8bd6086205beb82a2b2b24554e9fc86695b78fef5d32f2e0e6331af62b02e4c781f55d4b09d00f0e0fafcfc43016d500

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+##V0.1.3
+Added `remove_unhandled_handler` as a configuration option to disable the unhandled handler.
+
 ## V0.1.2
 
 * Renaming the gem from toddlerbot to slackify.

data/README.md

@@ -9,6 +9,7 @@ Slackify is a gem that allows to build slackbots on Rails using the [Event API](
     * [Interactive messages](#handling-interactive-messages)
     * [Slash Command](#handling-slash-commands)
     * [Custom handler for event subtypes](#custom-handler-for-event-subtypes)
+    * [Custom unhandled handler](#custom-unhandled-handler)
   * [Slack client](#slack-client)
     * [Sending a simple message](#sending-a-simple-message)
     * [Sending an interactive message](#sending-an-interactive-message)
@@ -96,6 +97,29 @@ Slackify.configuration.custom_event_subtype_handlers = {
 
 In this example, all events of subtype `file_share` will be sent to the `ImageHandler` class.
 
+### Custom unhandled handler
+
+By default, the Slackify has a handler that will be called if there is no regex match for a plain text message. `Slackify::Handlers::UnhandledHandler#unhandled` is called and it replies to the user by saying "This command is not handled at the moment". You can update this in the configuration by specifying a handler class for `unhandled_handler` that responds to a class method named `unhandled`. If you do not wish to use any handler for unhandled message, you can call `remove_unhandled_handler`
+
+```ruby
+# config/application.rb
+Slackify.configure do |config|
+  # ...
+  config.unhandled_handler = MyCustomHandlerClass # enables a custom unhandled handler
+
+  config.remove_unhandled_handler # removes the unhandled_handler
+end
+```
+
+```ruby
+# app/handlers/my_custom_handler_class.rb
+class MyCustomHandlerClass
+  def self.unhandled(params)
+    # ...
+  end
+end
+```
+
 ## Slack client
 In order to send messages, the [slack ruby client gem](https://github.com/slack-ruby/slack-ruby-client) was used. You can send plain text messages, images and interactive messages. Since the bot was envisioned being more repsonsive than proactive, the client was made available for handlers to call using the `slack_client` method. If you wish to send messages outside of handlers, you can get the slack client by calling `Slackify.configuration.slack_client`
 

data/lib/slackify/configuration.rb

@@ -23,7 +23,7 @@ module Slackify
       @unhandled_handler = handler
     end
 
-    def disable_unhandled_handler
+    def remove_unhandled_handler
       @unhandled_handler = nil
     end
 

data/lib/slackify/handlers/unhandled_handler.rb

@@ -7,7 +7,7 @@ module Slackify
         slack_client.chat_postMessage(
           as_user: true,
           channel: params[:event][:user],
-          text: "This command is not currently handled at the moment",
+          text: "This command is not handled at the moment",
         )
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackify
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Justin Leger
@@ -95,7 +95,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Slackbot framework for Rails using the Events API
+description: Slackbot framework for Rails using the Events API. Supports events, interactive
+  messages and slash commands.
 email: hey@justinleger.ca
 executables: []
 extensions: []
@@ -141,5 +142,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Rails slackbot framework
+summary: Slackbot framework for Rails using the Events API
 test_files: []