mirror of https://github.com/d0zingcat/gocryptotrader.git synced 2026-05-19 15:10:05 +00:00

Files

cranktakular 415332b446 Slack.go improvements and increasing coverage (#193 )

* Slack.go improvements and increasing converage

Slack.go Adding handling for trying to send responses when the websocket isn't connected
Slack.go Adding handling for an error response other than "Socket URL has expired"
Slack.go Making handleErrorResponse return an error
Slack.go Making use of s.Connected
Slack.go Making HandleMessage return an error
Slack.go Removing SendHTTPGetRequestSlack, code now calls SendHTTPGetRequest from common.go instead

More coverage for slack GetChannelsString test
More coverage for slack GetUsernameByID test
Improving slack GetIDByName test
Adding slack GetGroupIDByName test
Improving slack GetChannelIDByName test
More coverage for slack GetUsersInGroup test
Adding slack WebSocketConnect test
Adding slack handlePresenceChange test
Adding slack handleMessageResponse test
Adding slack handleErrorResponse test
Adding slack handleHelloResponse test
Adding slack handleReconnectResponse test
Adding slack WebsocketSend test
Adding slack HandleMessage test
Adding slack SendHTTPGetRequestSlack test

* Fixing race conditions and missing exclamation mark.

2018-10-18 17:33:24 +11:00

README.md

Updated documentation tool (#155 )

2018-07-19 16:02:24 +10:00

slack_test.go

Slack.go improvements and increasing coverage (#193 )

2018-10-18 17:33:24 +11:00

slack_types.go

Port from idoall's codebase (#161 )

2018-08-04 08:30:20 +10:00

slack.go

Slack.go improvements and increasing coverage (#193 )

2018-10-18 17:33:24 +11:00

README.md

GoCryptoTrader package Slack

This slack package is part of the GoCryptoTrader codebase.

This is still in active development

You can track ideas, planned features and what's in progresss on this Trello board: https://trello.com/b/ZAhMhpOy/gocryptotrader.

Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack

Slack Communications package

What is Slack?

Slack is a code-centric collaboration hub that allows users to connect via an app and share different types of data
Please visit: Slack for more information and account setup

Current Features

Basic communication to your slack channel information includes:
- Working status of bot
- Recent ANX ticker
- Current ANX orderbook

How to enable

Enable via configuration
Individual package example below:

import (
"github.com/thrasher-/gocryptotrader/communications/slack"
"github.com/thrasher-/gocryptotrader/config"
)

s := new(slack.Slack)

// Define slack configuration
commsConfig := config.CommunicationsConfig{SlackConfig: config.SlackConfig{
  Name: "Slack",
	Enabled: true,
	Verbose: false,
	TargetChannel: "targetChan",
	VerificationToken: "slackGeneratedToken",
}}

s.Setup(commsConfig)
err := s.Connect
// Handle error

Once the bot has started you can interact with the bot using these commands via Slack:

!status 		- Displays current working status of bot
!help 			- Displays help text
!settings		- Displays current settings
!ticker			- Displays recent ANX ticker
!portfolio	- Displays portfolio data
!orderbook	- Displays current ANX orderbook

Please click GoDocs chevron above to view current GoDoc information for this package

Contribution

Please feel free to submit any pull requests or suggest any desired features to be added.

When submitting a PR, please abide by our coding guidelines:

Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
Code must be documented adhering to the official Go commentary guidelines.
Code must adhere to our coding style.
Pull requests need to be based on and opened against the master branch.

Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:

1F5zVDgNjorJ51oGebSvNCrSAHpwGkUdDB