forked from muesli/beehive
/
slackbeefactory.go
144 lines (130 loc) 路 3.79 KB
/
slackbeefactory.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
* Copyright (C) 2016 Sergio Rubio
* 2017 Christian Muehlhaeuser
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published
* by the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authors:
* Sergio Rubio <rubiojr@frameos.org>
* Christian Muehlhaeuser <muesli@gmail.com>
*/
package slackbee
import "github.com/muesli/beehive/bees"
// SlackBeeFactory is a factory for SlackBees.
type SlackBeeFactory struct {
bees.BeeFactory
}
// New returns a new Bee instance configured with the supplied options.
func (factory *SlackBeeFactory) New(name, description string, options bees.BeeOptions) bees.BeeInterface {
bee := SlackBee{
Bee: bees.NewBee(name, factory.ID(), description, options),
}
bee.ReloadOptions(options)
return &bee
}
// ID returns the ID of this Bee.
func (factory *SlackBeeFactory) ID() string {
return "slackbee"
}
// Name returns the name of this Bee.
func (factory *SlackBeeFactory) Name() string {
return "Slack"
}
// Description returns the description of this Bee.
func (factory *SlackBeeFactory) Description() string {
return "Connects to Slack"
}
// Image returns the filename of an image for this Bee.
func (factory *SlackBeeFactory) Image() string {
return factory.ID() + ".png"
}
// LogoColor returns the preferred logo background color (used by the admin interface).
func (factory *SlackBeeFactory) LogoColor() string {
return "#4b4b4b"
}
// Options returns the options available to configure this Bee.
func (factory *SlackBeeFactory) Options() []bees.BeeOptionDescriptor {
opts := []bees.BeeOptionDescriptor{
{
Name: "api_key",
Description: "Slack API key",
Type: "string",
Mandatory: true,
},
{
Name: "channels",
Description: "Slack channels to listen on",
Type: "[]string",
Mandatory: false,
},
}
return opts
}
// Events describes the available events provided by this Bee.
func (factory *SlackBeeFactory) Events() []bees.EventDescriptor {
events := []bees.EventDescriptor{
{
Namespace: factory.Name(),
Name: "message",
Description: "A message was received over Slack",
Options: []bees.PlaceholderDescriptor{
{
Name: "text",
Description: "The message that was received",
Type: "string",
},
{
Name: "channel",
Description: "The channel the message was received in",
Type: "string",
},
{
Name: "user",
Description: "The user that sent the message",
Type: "string",
},
},
},
}
return events
}
// Actions describes the available actions provided by this Bee.
func (factory *SlackBeeFactory) Actions() []bees.ActionDescriptor {
actions := []bees.ActionDescriptor{
{
Namespace: factory.Name(),
Name: "send",
Description: "Sends a message to a channel",
Options: []bees.PlaceholderDescriptor{
{
Name: "channel",
Description: "Which channel to send the message to",
Type: "string",
Mandatory: true,
},
{
Name: "text",
Description: "Content of the message",
Type: "string",
Mandatory: true,
},
},
},
}
return actions
}
func init() {
f := SlackBeeFactory{}
bees.RegisterFactory(&f)
}