Skip to content

Commit

Permalink
Add slack-digest script which generates per channel digest emails to …
Browse files Browse the repository at this point in the history
…be emailed to the respective mailing lists.

Original script by merlimat from his [private repo](https://github.com/merlimat/slack-email-digest).
Copied to BK repo for use with the BookKeeper project.

Reviewers: Enrico Olivelli <eolivelli@gmail.com>

This closes #2367 from Ghatage/slack-digest-jenkins
  • Loading branch information
Ghatage committed Jul 8, 2020
1 parent 20eb8d9 commit fbed0db
Show file tree
Hide file tree
Showing 5 changed files with 155 additions and 0 deletions.
1 change: 1 addition & 0 deletions .test-infra/scripts/slack-email-digest/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
configuration.yaml
4 changes: 4 additions & 0 deletions .test-infra/scripts/slack-email-digest/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Slack to email digest bot

This script is responsible for generating daily per channel digests and emailing them to certail mailing lists.

34 changes: 34 additions & 0 deletions .test-infra/scripts/slack-email-digest/configuration-example.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#

slack:
token: xoxp-xxxxxxxxxxxxxx

mail:
fromAddress: '"My Slack" <my.slack@gmail.com>'
smtp: smtp.gmail.com:587
useTLS: true
username: my.slack@gmail.com
password: xxxxxxxxx

channels:
# Maps channels to a particular email address
general: users@my.project.org
dev: dev@my.project.org
random: users@my.project.org
20 changes: 20 additions & 0 deletions .test-infra/scripts/slack-email-digest/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
slacker
PyYAML
96 changes: 96 additions & 0 deletions .test-infra/scripts/slack-email-digest/slack_email_digest.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
#!/usr/bin/env python
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#

import slacker
import yaml
import time
import re
import datetime
import smtplib
from email.mime.text import MIMEText


conf = yaml.load(open('configuration.yaml'))


def send_digest(channel, address, digest):
msg = MIMEText(digest, _charset='utf-8')
msg['From'] = conf['mail']['fromAddress']
msg['To'] = address
msg['Subject'] = 'Slack digest for #%s - %s' % (
channel, datetime.datetime.now().strftime('%Y-%m-%d'))
server = smtplib.SMTP(conf['mail']['smtp'])
if conf['mail']['useTLS']:
server.starttls()
if 'username' in conf['mail']:
server.login(conf['mail']['username'], conf['mail']['password'])

server.sendmail(conf['mail']['fromAddress'], address, msg.as_string())
server.quit()


slack = slacker.Slacker(conf['slack']['token'])

channels = slack.channels.list().body['channels']

# Get a mapping between Slack internal user ids and real names
users = {}
for user in slack.users.list().body['members']:
real_name = user.get('real_name', user.get('name'))
users[user['id']] = real_name

last_day_timestamp = time.time() - (24 * 3600)

for channel in channels:
id = channel['id']
name = channel['name']
topic = channel['topic']['value']

if name not in conf['channels']:
print('Ignoring channel: #%s' % name)
continue

toAddress = conf['channels'][name]
print('Getting digest of #%s --> %s' % (name, toAddress))

messages = slack.channels.history(channel=id,
oldest=last_day_timestamp,
count=1000)
digest = ''
for m in reversed(messages.body['messages']):
if not m['type'] == 'message':
continue

user = m.get('user')
if not user:
user = m['comment']['user']
sender = users.get(user, '')

date = datetime.datetime.utcfromtimestamp(float(m['ts'])).strftime('%Y-%m-%d %H:%M:%S UTC')
# Replace users id mentions with real names
text = re.sub(r'<@(\w+)>', lambda m: '@' + users[m.group(1)], m['text'])

digest += '%s - %s: %s\n' % (date, sender, text)
for reaction in m.get('reactions', []):
digest += '%s : %s\n' % (reaction['name'], ', '.join(map(users.get, reaction['users'])))
digest += '----\n'

if digest:
send_digest(name, toAddress, digest)

0 comments on commit fbed0db

Please sign in to comment.