xenofem/python-zulip-api
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Split out Trac plugin configuration (and de-duplicate the plugin).

Browse source 
(imported from commit aa3cd2c5a376315a463bf564ba57d751e36431d6)
This commit is contained in:
Tim Abbott 2013-02-13 13:47:23 -05:00
parent eb98c14af6
commit f30e28dd20
4 changed files with 80 additions and 158 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

135
bots/humbug_trac.py
View file

@ -1,135 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# Humbug trac plugin -- sends humbugs when tickets change.
#
# Install by copying this file to the trac plugins/ subdirectory,
# customizing the constants below this comment, and then adding
# "humbug_trac" to the [components] section of the conf/trac.ini
# file, like so:
#
# [components]
# humbug_trac = enabled
#
# You may then need to restart trac (or restart Apache) for the bot
# (or changes to the bot) to actually be loaded by trac.
# Change these constants:
HUMBUG_USER = "humbug+trac@humbughq.com"
HUMBUG_API_KEY = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
STREAM_FOR_NOTIFICATIONS = "trac"
TRAC_BASE_TICKET_URL = "https://trac.humbughq.com/ticket"
# This should not need to change unless you have a custom Humbug subdomain.
HUMBUG_SITE = "https://staging.humbughq.com"
## If properly installed, the Humbug API should be in your import
## path, but if not, set a custom path below
HUMBUG_API_PATH = "/home/humbug/humbug/api"
from trac.core import Component, implements
from trac.ticket import ITicketChangeListener
import sys
if HUMBUG_API_PATH is not None:
sys.path.append(HUMBUG_API_PATH)
import humbug
client = humbug.Client(
email=HUMBUG_USER,
site=HUMBUG_SITE,
api_key=HUMBUG_API_KEY)
def markdown_ticket_url(ticket, heading="ticket"):
return "[%s #%s](%s/%s)" % (heading, ticket.id, TRAC_BASE_TICKET_URL, ticket.id)
def markdown_block(desc):
return "\n\n>" + "\n> ".join(desc.split("\n")) + "\n"
def truncate(string, length):
if len(string) <= length:
return string
return string[:length - 3] + "..."
def trac_subject(ticket):
return truncate("#%s: %s" % (ticket.id, ticket.values.get("summary")), 60)
def send_update(ticket, content):
client.send_message({
"type": "stream",
"to": STREAM_FOR_NOTIFICATIONS,
"content": content,
"subject": trac_subject(ticket)
})
class HumbugPlugin(Component):
implements(ITicketChangeListener)
def ticket_created(self, ticket):
"""Called when a ticket is created."""
content = "%s created %s in component **%s**, priority **%s**:\n" % \
(ticket.values.get("reporter"), markdown_ticket_url(ticket),
ticket.values.get("component"), ticket.values.get("priority"))
if ticket.values.get("description") != "":
content += "%s" % markdown_block(ticket.values.get("description"))
send_update(ticket, content)
def ticket_changed(self, ticket, comment, author, old_values):
"""Called when a ticket is modified.
`old_values` is a dictionary containing the previous values of the
fields that have changed.
"""
if not comment and set(old_values.keys()) <= set(["priority", "milestone",
"cc", "keywords",
"component"]):
# This is probably someone going through trac and updating
# the priorities; this can result in a lot of messages
# nobody wants to read, so don't send them without a comment.
return
content = "%s updated %s" % (author, markdown_ticket_url(ticket))
if comment:
content += ' with comment: %s\n\n' % (markdown_block(comment,))
else:
content += ":\n\n"
field_changes = []
for key in old_values.keys():
if key == "description":
content += '- Changed %s from %s to %s' % (key, markdown_block(old_values.get(key)),
markdown_block(ticket.values.get(key)))
elif old_values.get(key) == "":
field_changes.append('%s: => **%s**' % (key, ticket.values.get(key)))
elif ticket.values.get(key) == "":
field_changes.append('%s: **%s** => ""' % (key, old_values.get(key)))
else:
field_changes.append('%s: **%s** => **%s**' % (key, old_values.get(key),
ticket.values.get(key)))
content += ", ".join(field_changes)
send_update(ticket, content)
def ticket_deleted(self, ticket):
"""Called when a ticket is deleted."""
content = "%s was deleted." % markdown_ticket_url(ticket, heading="Ticket")
send_update(ticket, content)

33
bots/humbug_trac_config.py Normal file
View file

@ -0,0 +1,33 @@
# -*- coding: utf-8 -*-
#
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# Change these constants:
HUMBUG_USER = "humbug+trac@humbughq.com"
HUMBUG_API_KEY = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
STREAM_FOR_NOTIFICATIONS = "trac"
TRAC_BASE_TICKET_URL = "https://trac.humbughq.com/ticket"
# This should not need to change unless you have a custom Humbug subdomain.
HUMBUG_SITE = "https://staging.humbughq.com"
## If properly installed, the Humbug API should be in your import
## path, but if not, set a custom path below
HUMBUG_API_PATH = "/home/humbug/humbug/api"

35
integrations/humbug_trac.py
View file

@ -24,10 +24,10 @@
# Humbug trac plugin -- sends humbugs when tickets change. # Humbug trac plugin -- sends humbugs when tickets change.
# #
# Install by copying this file to the trac plugins/ subdirectory, # Install by copying this file and humbug_trac_config.py to the trac
# customizing the constants below this comment, and then adding # plugins/ subdirectory, customizing the constants in
# "humbug_trac" to the [components] section of the conf/trac.ini # humbug_trac_config.py, and then adding "humbug_trac" to the
# file, like so: # components section of the conf/trac.ini file, like so:
# #
# [components] # [components]
# humbug_trac = enabled # humbug_trac = enabled
@ -35,33 +35,22 @@
# You may then need to restart trac (or restart Apache) for the bot # You may then need to restart trac (or restart Apache) for the bot
# (or changes to the bot) to actually be loaded by trac. # (or changes to the bot) to actually be loaded by trac.
# Change these constants:
HUMBUG_USER = "trac-notifications@example.com"
HUMBUG_API_KEY = "0123456789abcdef0123456789abcdef"
STREAM_FOR_NOTIFICATIONS = "trac"
TRAC_BASE_TICKET_URL = "https://trac.example.com/ticket"
# This should not need to change unless you have a custom Humbug subdomain.
HUMBUG_SITE = "https://humbughq.com"
## If properly installed, the Humbug API should be in your import
## path, but if not, set a custom path below
HUMBUG_API_PATH = None
from trac.core import Component, implements from trac.core import Component, implements
from trac.ticket import ITicketChangeListener from trac.ticket import ITicketChangeListener
import sys import sys
import humbug_trac_config as config
if HUMBUG_API_PATH is not None: if config.HUMBUG_API_PATH is not None:
sys.path.append(HUMBUG_API_PATH) sys.path.append(config.HUMBUG_API_PATH)
import humbug import humbug
client = humbug.Client( client = humbug.Client(
email=HUMBUG_USER, email=config.HUMBUG_USER,
site=HUMBUG_SITE, site=config.HUMBUG_SITE,
api_key=HUMBUG_API_KEY) api_key=config.HUMBUG_API_KEY)
def markdown_ticket_url(ticket, heading="ticket"): def markdown_ticket_url(ticket, heading="ticket"):
return "[%s #%s](%s/%s)" % (heading, ticket.id, TRAC_BASE_TICKET_URL, ticket.id) return "[%s #%s](%s/%s)" % (heading, ticket.id, config.TRAC_BASE_TICKET_URL, ticket.id)
def markdown_block(desc): def markdown_block(desc):
return "\n\n>" + "\n> ".join(desc.split("\n")) + "\n" return "\n\n>" + "\n> ".join(desc.split("\n")) + "\n"
@ -77,7 +66,7 @@ def trac_subject(ticket):
def send_update(ticket, content): def send_update(ticket, content):
client.send_message({ client.send_message({
"type": "stream", "type": "stream",
"to": STREAM_FOR_NOTIFICATIONS, "to": config.STREAM_FOR_NOTIFICATIONS,
"content": content, "content": content,
"subject": trac_subject(ticket) "subject": trac_subject(ticket)
}) })

35
integrations/humbug_trac_config.py Normal file
View file

@ -0,0 +1,35 @@
# -*- coding: utf-8 -*-
#
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
# See humbug_trac.py for installation and configuration instructions
# Change these constants to configure the plugin:
HUMBUG_USER = "trac@example.com"
HUMBUG_API_KEY = "0123456789abcdef0123456789abcdef"
STREAM_FOR_NOTIFICATIONS = "trac"
TRAC_BASE_TICKET_URL = "https://trac.example.com/ticket"
# This should not need to change unless you have a custom Humbug subdomain.
HUMBUG_SITE = "https://humbughq.com"
## If properly installed, the Humbug API should be in your import
## path, but if not, set a custom path below
HUMBUG_API_PATH = None