SlackCommand

A simple Slack slash command builder that integrates with Plug.

Documentation

Documentation can be found at https://hexdocs.pm/slack_command.

If you’re not sure what a Slack slash command is, see the Slack documentation.

Installation

If available in Hex, the package can be installed by adding slack_command to your list of dependencies in mix.exs:

def deps do
  [{:slack_command, "~> 1.0.0"}]
end

Usage

Provides a primary macro defcommand to enable building a Plug that can route inbound requests from Slack with a familiar interface (functions).

Since SlackCommand.Router is just a builder for a Plug, it can be integrated into either a Plug.Router or a Phoenix application.

Example Usage

defmodule SlackBot.SlackRouter do
  use SlackCommand.Router

  defcommand hello(_, name) do
    "Greetings #{name}!"
  end
end

defmodule SlackBot.Router do
  use Plug.Router

  plug :match
  plug Plug.Parsers, parsers: [:json],
                     pass:  ["application/json"],
                     json_decoder: Jason
  plug :dispatch

  forward "/slack", to: SlackBot.SlackRouter
end

License (MIT)

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.