library laravel-slack-api {🖫 414, ⚐ 25, ★ 1}

wgmv/laravel-slack-api

Wrapper for Slack.com WEB API. Based on code from Vagner do Carmo.

Sunday, February 11, 2018
by wgmv
Repository
1 Watchers
1 Stars
414 Installations

PHP
1 Dependents
0 Suggesters
0 Forks
0 Open issues
25 Versions
204 % Grown

The README.md

Laravel 5 and Lumen - Slack API

, _(*1)

, _(*2)

This package provides a simple way to use the Slack API., _(*3)

The package is a fork from https://github.com/Vluzrmos/laravel-slack-api The original package is not maintained and I made several changes that possibly make this version incompatible to the original., _(*4)

Changes made:

removed functionality to lookup user by nickname: this package provides basic functionality
removed cache as it was not needed anymore
added basic tests
updated slack api options on a couple of methods
fixed minor bugs

Installation

composer require wgmv/laravel-slack-api, _(*5)

Installation on Laravel 5

The package has autodiscovery enabled. (A laravel 5.5 feature), _(*6)

[
    'providers' => [
        Wgmv\SlackApi\SlackApiServiceProvider::class,
    ]
]

Configuration

This package uses slacks legacy tokens. Get you token here:, _(*7)

https://api.slack.com/custom-integrations/legacy-tokens, _(*8)

Configure your slack team token in config/services.php, _(*9)


[
    //...,
    'slack' => [
        'token' => 'your token here'
    ]
]

Installation on Lumen

I have not tested the lumen installation! Documentation from the original package:, _(*10)

Add the following line on bootstrap/app.php:, _(*11)

// $app->register('App\Providers\AppServiceProvider'); (by default that comes commented)
$app->register('Wgmv\SlackApi\SlackApiServiceProvider');

If you want to use facades, add this lines on bootstrap/app.php, _(*12)

class_alias('Wgmv\SlackApi\Facades\SlackApi', 'SlackApi');
//... and others

Otherwise, just use the singleton shortcuts:, _(*13)

/** @var \Wgmv\SlackApi\Contracts\SlackApi $slackapi */
$slackapi     = app('slack.api');

/** @var \Wgmv\SlackApi\Contracts\SlackChannel $slackchannel */
$slackchannel = app('slack.channel');

etc

Example Usage

//Lists all users on your team
SlackUser::lists(); 

//Lists all channels on your team
SlackChannel::lists(); 

//List all groups
SlackGroup::lists();

//Invite a new member to your team
SlackUserAdmin::invite("example@example.com", [
    'first_name' => 'John', 
    'last_name' => 'Doe'
]);

// or just use the helper

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

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

All Injectable Contracts:

Generic API

Wgmv\SlackApi\Contracts\SlackApi, _(*14)

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., _(*15)

Channels API

Wgmv\SlackApi\Contracts\SlackChannel, _(*16)

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

Chat API

Wgmv\SlackApi\Contracts\SlackChat, _(*18)

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

Files API

Wgmv\SlackApi\Contracts\SlackFile, _(*20)

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

Groups API

Wgmv\SlackApi\Contracts\SlackGroup, _(*22)

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

Instant Messages API (Direct Messages)

Wgmv\SlackApi\Contracts\SlackInstantMessage, _(*24)

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

Real Time Messages API

Wgmv\SlackApi\Contracts\SlackRealTimeMessage, _(*26)

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

Search API

Wgmv\SlackApi\Contracts\SlackSearch, _(*28)

Find messages or files., _(*29)

Stars API

Wgmv\SlackApi\Contracts\SlackStar, _(*30)

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

Team API

Wgmv\SlackApi\Contracts\SlackTeam, _(*32)

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

Users API

Wgmv\SlackApi\Contracts\SlackUser, _(*34)

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

Users Admin API

Wgmv\SlackApi\Contracts\SlackUserAdmin, _(*36)

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

License

DBAD License., _(*38)

The Versions

11/02 2018

dev-master

9999999-dev

Wrapper for Slack.com WEB API. Based on code from Vagner do Carmo.

library laravel-slack-api

Wrapper for Slack.com WEB API. Based on code from Vagner do Carmo.

wgmv/laravel-slack-api

The README.md

Laravel 5 and Lumen - Slack API

Changes made:

Installation

Installation on Laravel 5

Configuration

Installation on Lumen

Example Usage

All Injectable Contracts:

Generic API

Channels API

Chat API

Files API

Groups API

Instant Messages API (Direct Messages)

Real Time Messages API

Search API

Stars API

Team API

Users API

Users Admin API

License

The Versions

dev-master

The Requires

The Development Requires

by Vagner do Carmo

by Walter Vogel

v0.5.0

The Requires

The Development Requires

by Vagner do Carmo

by Walter Vogel

v0.4.8

The Requires

by Vagner do Carmo

v0.4.7

The Requires

by Vagner do Carmo

v0.4.6

The Requires

by Vagner do Carmo

v0.4.5

The Requires

by Vagner do Carmo

v0.4.4

The Requires

by Vagner do Carmo

v0.4.3

The Requires

by Vagner do Carmo

v0.4.2

The Requires

by Vagner do Carmo

v0.4.1

The Requires

by Vagner do Carmo

v0.4.0

The Requires

by Vagner do Carmo

v0.3.1

The Requires

by Vagner do Carmo

v0.3.0

The Requires

by Vagner do Carmo

v0.2.0

The Requires

by Vagner do Carmo

v0.1.0

The Requires

by Vagner do Carmo

v0.0.10

The Requires

by Vagner do Carmo

v0.0.9

The Requires