clawrock/slack-api

Slack Integration

Slack-API

Introduction

Slack-API lets you build simple response system for slack's slash command API., _(*1)

Installation

For production make sure you have composer installed. Then run:, _(*2)

composer require clawrock/slack-api

After installing, you need to require Composer's autoloader:, _(*3)

require 'vendor/autoload.php';

Code Examples

Basic example with anonymous function., _(*4)

use ClawRock\Slack\SlackFactory;

//Create new dispatcher
$dispatcher = SlackFactory::dispatcher();


//Add commands to respond to your request
$dispatcher->addCommand(SlackFactory::slashCommand('your-command-token')
          ->run(function ($req, $res){
                $res->addText('Hello world!');
          }))->dispatch(SlackFactory::getRequest())
      ->create()
      ->toRequest()
      ->serve();

You can also add Guard to manage the user/team/channel permissions., _(*5)

use ClawRock\Slack\Enums\Permissions;

$dispatcher->addGuard(SlackFactory::guard()
        ->defaultBehavior(Permissions::DenyAll())
        ->allowUserIds(['U01'])
        ->allowTeamIds(['T01']))
    ->addCommand(//commands)
    ->dispatch(SlackFactory::getRequest())
    ->create()
    ->toRequest()
    ->serve();

It's worth to notice that every callable object can be used in addCommand() method., _(*6)

You can send messages via Incoming webhooks, _(*7)

use ClawRock\Slack\SlackFactory;

SlackFactory::getMessageService('')->sendText("Hello world!");

Documentation

There are very well documented examples in examples/ directory. You should take a look on them., _(*8)

Tests

Simply run, _(*9)

vendor/bin/phpunit

Requirements

Slack API requires server with SSL enabled. Please refer to the Slack's API reference to get more informations., _(*10)

Contributing

If you wish to participate in the development, you may use grunt to generate the documentation files. To do so make sure you have node and npm installed., _(*11)

$ node -v
v4.7.0
$ npm -v
2.15.11

Then run, _(*12)

$ npm install
$ grunt init

And then to generate docs run, _(*13)

grunt build

This will also launch unit tests., _(*14)

Credits

Slack-API was initiated with generator-composer, a Yeoman generator that builds a PHP Composer project., _(*15)

This project uses the following as development dependencies:, _(*16)

• PHPUnit
• PhpDocumentor
• Php Copy/Paste Detector

License

Author: cr-team office@clawrock.com, _(*17)