Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaplean/slack-client-bundle
https://github.com/chaplean/slack-client-bundle
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/chaplean/slack-client-bundle
- Owner: chaplean
- License: mit
- Created: 2019-07-05T15:36:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-05T15:37:16.000Z (over 5 years ago)
- Last Synced: 2024-04-22T18:24:20.517Z (9 months ago)
- Language: PHP
- Size: 42 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# slack-client-bundle
[](https://git.chaplean.coop/open-source/bundle/slack-client-bundle/commits/master)
[](https://git.chaplean.coop/open-source/bundle/slack-client-bundle/commits/master)
[](https://github.com/chaplean/slack-client-bundle/issues)
This bundle allows you to use the [slack api](https://api.slack.com/web) easily from your php code.
## Table of content
* [Installation](#Installation)
* [Configuration](#Configuration)
* [Usage](#Usage)
* [Versioning](#Versioning)
* [Contributing](#Contributing)
* [Hacking](#Hacking)
* [License](#License)
## Installation
This bundle requires at least Symfony 3.0.
You can use [composer](https://getcomposer.org) to install slack-client-bundle:
```bash
composer require chaplean/slack-client-bundle
```
Then add to your AppKernel.php:
```php
new Chaplean\Bundle\SlackClientBundle\ChapleanSlackClientBundle(),
```
## Configuration
First you will need to import the bundle configuration.
config.yml:
```yaml
imports:
- { resource: '@ChapleanSlackClientBundle/Resources/config/config.yml' }
```
You must also create some parameters.
parameters.yml:
```yaml
parameters:
chaplean_slack_client.access_token: 'your access token'
```
## Usage
See the rest-client-bundle's [usage documentation](https://github.com/chaplean/rest-client-bundle#using-a-bundle-based-on-rest-client-bundle).
### Available functions:
> Note: Slack uses the POST method for all api endpoints.
* [Chat](https://api.slack.com/methods#chat)
* [postMessage()](https://api.slack.com/methods/chat.postMessage)
* [postDeleteMessage()](https://api.slack.com/methods/chat.delete)
* [Team](https://api.slack.com/methods#team)
* [postGetTeamInfos()](https://api.slack.com/methods/team.info)
* [Users](https://api.slack.com/methods#users)
* [postListUsers()](https://api.slack.com/methods/users.list)
* [User Groups](https://api.slack.com/methods#usergroups)
* [postListGroups()](https://api.slack.com/methods/usergroups.list)
* [postListUsersForGroup()](https://api.slack.com/methods/usergroups.users.list)
* [Channels](https://api.slack.com/methods#channels)
* [postChannel()](https://api.slack.com/methods/channels.create)
* [postListChannel()](https://api.slack.com/methods/channels.list)
* [postChannelInvitation()](https://api.slack.com/methods/channels.invite)
## Versioning
slack-client-bundle follows [semantic versioning](https://semver.org/). In short the scheme is MAJOR.MINOR.PATCH where
1. MAJOR is bumped when there is a breaking change,
2. MINOR is bumped when a new feature is added in a backward-compatible way,
3. PATCH is bumped when a bug is fixed in a backward-compatible way.
Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.
## Contributing
Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:
* [Bug Reports](https://github.com/chaplean/slack-client-bundle/issues): While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
* [Feature Request](https://github.com/chaplean/slack-client-bundle/issues): You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
* [Pull Request](https://github.com/chaplean/slack-client-bundle/pulls): Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as [documentation](https://help.github.com/articles/about-pull-requests/) on pull requests. We use the ["fork and pull model"](https://help.github.com/articles/about-collaborative-development-models/) were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the `master` branch.
As a reminder, all contributors are expected to follow our [Code of Conduct](CODE_OF_CONDUCT.md).
## Hacking
You might find the following commands usefull when hacking on this project:
```bash
# Install dependencies
composer install
# Run tests
bin/phpunit
```
## License
slack-client-bundle is distributed under the terms of the MIT license.
See [LICENSE](LICENSE.md) for details.