Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theckman/slackmech
slackmech provides help for mechanizing request to the Slack Web/Electron UI API
https://github.com/theckman/slackmech
golang golang-library mechanize slack slack-api
Last synced: 11 days ago
JSON representation
slackmech provides help for mechanizing request to the Slack Web/Electron UI API
- Host: GitHub
- URL: https://github.com/theckman/slackmech
- Owner: theckman
- License: mit
- Created: 2018-04-09T07:36:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-01-21T16:08:47.000Z (almost 6 years ago)
- Last Synced: 2024-11-24T14:22:52.554Z (about 1 month ago)
- Topics: golang, golang-library, mechanize, slack, slack-api
- Language: Go
- Homepage:
- Size: 1.71 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slackmech
[](https://github.com/theckman/slackmech/blob/master/LICENSE)
[](https://godoc.org/github.com/theckman/slackmech)
[](https://github.com/theckman/slackmech/releases)
[](https://travis-ci.org/theckman/slackmech/branches)
[](https://gocover.io/github.com/theckman/slackmech)
[](https://goreportcard.com/report/github.com/theckman/slackmech)
Package `slackmech` is a package for mechanizing requests to the Slack API. It
helps imitate a web session with Slack, to present you with a session API token.
This token has different API access, including undocumented behaviors, to allow
special features of the Web/Electron UI. This package will also abstract away
some of those API calls, making it easier to consume them.
As of now, the features of this project are focused towards a bot for moderating
Open Source Slack communities. Things will be added as they are needed to
support that effort, or as contributions from others are made.
This package is still under active development.
### Compatibility Notice
The behaviors and functions relied on by this package are largely undocumented,
and the usage of them fall outside of any compatibility guarantees provided by
Slack. While the functionality provided by this package is necessary, it's
reasonable to assume it may break unexpectedly in the future.
As such, at the time of writing, it seems unlikely that this package will ever
be able to see a 1.0.0 release. However, efforts will be made to retain API
compatibility as long as possible. The package will have releases, using git
tags, following the [Semantic Version v2.0.0 spec](https://semver.org/spec/v2.0.0.html).
## License
This source code of this package is released under the MIT License. Please see
the [LICENSE](https://github.com/theckman/slackmech/blob/master/LICENSE) for the
full content of the license.
## Usage
To be a respectful user of the Slack APIs, be sure to use an `*http.Client` with
a cookiejar set, preferably one that makes use of
[persistence](https://github.com/juju/persistent-cookiejar). In our example,
we'll use the standard cookiejar implementation.
Here we'll create a cookiekar, create an HTTP client, create a new slackmech
client, log in, and then use the Session Token to create a new API client:
```Go
import (
"log"
"net/http"
"net/http/cookiejar"
"os"
"github.com/nlopes/slack"
"github.com/theckman/slackmech"
"golang.org/x/net/publicsuffix"
)
func main() {
email := os.Getenv("SLACK_EMAIL")
password := os.Getenv("SLACK_PASSWORD")
subdomain := os.Getenv("SLACK_SUBDOMAIN")
cj, err := cookiejar.New(&cookiejar.Options{PublicSuffixList: publicsuffix.List})
if err != nil {
log.Fatal(err)
}
// new http client with cookiejar set
client := &http.Client{
Jar: cj,
}
// don't follow redirects -- needed by slackmech
client.CheckRedirect = func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
}
// new slackmech client
sm, err := slackmech.New(client, subdomain)
if err != nil {
log.Fatal(err)
}
// log in and get a new session
err = sm.StartSession(email, password)
if err != nil {
log.Fatal(err)
}
// use the slackmech SessionToken to build a new Slack API client
// also pass in the HTTP client used to log in to continue using cookies
api := slack.New(sm.SessionToken(), slack.OptionHTTPClient(client))
}
```