library slack-api

craftyx/slack-api

Wrapper for Slack.com WEB API. Based on Vagner do Carmo one, but compatible with GuzzleHttp6

Slack API for Laravel 5

This package provides a simple way to use Slack API. It's based on the excellent Vluzrmos package, but it's compatible with Guzzle6, _(*1)

Instalation

composer require craftyx/slack-api, _(*2)

Instalation on Laravel 5

Add to config/app.php:, _(*3)

 [
        Craftyx\SlackApi\SlackApiServiceProvider::class,
    ]
]

?>

The ::class notation is optional., _(*4)

and add the Facades to your aliases, if you need it, _(*5)

 [
        'SlackApi'              => Craftyx\SlackApi\Facades\SlackApi::class,
        'SlackChannel'          => Craftyx\SlackApi\Facades\SlackChannel::class,
        'SlackChat'             => Craftyx\SlackApi\Facades\SlackChat::class,
        'SlackGroup'            => Craftyx\SlackApi\Facades\SlackGroup::class,
        'SlackFile'             => Craftyx\SlackApi\Facades\SlackFile::class,
        'SlackSearch'           => Craftyx\SlackApi\Facades\SlackSearch::class,
        'SlackInstantMessage'   => Craftyx\SlackApi\Facades\SlackInstantMessage::class,
        'SlackUser'             => Craftyx\SlackApi\Facades\SlackUser::class,
        'SlackStar'             => Craftyx\SlackApi\Facades\SlackStar::class,
        'SlackUserAdmin'        => Craftyx\SlackApi\Facades\SlackUserAdmin::class,
        'SlackRealTimeMessage'  => Craftyx\SlackApi\Facades\SlackRealTimeMessage::class,
        'SlackTeam'             => Craftyx\SlackApi\Facades\SlackTeam::class,
    ]
]

?>

The ::class notation is optional., _(*6)

Configuration

configure your slack team token in config/services.php, _(*7)

 [
        'token' => 'your token here'
    ]
]

?>

Usage

 'John', 
    'last_name' => 'Doe'
]);

//Send a message to someone or channel or group
SlackChat::message('#general', 'Hello my friends!');

//Upload a file/snippet
SlackFile::upload([
    'filename' => 'sometext.txt', 
    'title' => 'text', 
    'content' => 'Nice contents',
    'channels' => 'C0440SZU6' //can be channel, users, or groups ID
]);

// Search for files or messages
SlackSearch::all('my message');

// Search for files
SlackSearch::files('my file');

// Search for messages
SlackSearch::messages('my message');

// or just use the helper

//Autoload the api
slack()->post('chat.postMessage', [...]);

//Autoload a Slack Method
slack('Chat')->message([...]);
slack('Team')->info();

?>

Using Dependency Injection

slackUser = $slackUser;   
    }
    
    public function controllerMethod(){
        $usersList = $this->slackUser->lists();
    }
}

?>

All Injectable Contracts:

Generic API

Craftyx\SlackApi\Contracts\SlackApi, _(*8)

Allows you to do generic requests to the api with the following http verbs: get, post, put, patch, delete ... all allowed api methods you could see here: Slack Web API Methods., _(*9)

And is also possible load a SlackMethod contract:, _(*10)

load('Channel');
$channel->lists();

/** @var SlackChat $chat **/
$chat = $slack->load('Chat');
$chat->message('D98979F78', 'Hello my friend!');

/** @var SlackUserAdmin $chat **/
$admin = $slack('UserAdmin'); //Minimal syntax (invokable)
$admin->invite('jhon.doe@example.com'); 

?>

Channels API

Craftyx\SlackApi\Contracts\SlackChannel, _(*11)

Allows you to operate channels: invite, archive, rename, join, kick, setPurpose ..., _(*12)

Chat API

Craftyx\SlackApi\Contracts\SlackChat, _(*13)

Allows you to send, update and delete messages with methods: delete, message, update., _(*14)

Files API

Craftyx\SlackApi\Contracts\SlackFile, _(*15)

Allows you to send, get info, delete, or just list files: info, lists, upload, delete., _(*16)

Groups API

Craftyx\SlackApi\Contracts\SlackGroup, _(*17)

Same methods of the SlackChannel, but that operates with groups and have adicional methods: open, close, createChild, _(*18)

Instant Messages API (Direct Messages)

Craftyx\SlackApi\Contracts\SlackInstantMessage, _(*19)

Allows you to manage direct messages to your team members., _(*20)

Real Time Messages API

Craftyx\SlackApi\Contracts\SlackRealTimeMessage, _(*21)

Allows you list all channels and user presence at the moment., _(*22)

Search API

Craftyx\SlackApi\Contracts\SlackSearch, _(*23)

Find messages or files., _(*24)

Stars API

Craftyx\SlackApi\Contracts\SlackStar, _(*25)

List all of starred itens., _(*26)

Team API

Craftyx\SlackApi\Contracts\SlackTeam, _(*27)

Get information about your team., _(*28)

Users API

Craftyx\SlackApi\Contracts\SlackUser, _(*29)

Get information about an user on your team or just check your presence ou status., _(*30)

Users Admin API

Craftyx\SlackApi\Contracts\SlackUserAdmin, _(*31)

Invite new members to your team., _(*32)

License

DBAD License., _(*33)