def test_karma_positive_neutral():
assert create_transactions('Bar', 'Bar', [
RawKarma(name='Baz', op='++', reason=None),
RawKarma(name='Baz', op='+-', reason=None)
]) == [
KarmaTransaction(name='Baz', self_karma=False, net_karma=1, reasons=[])
]
def test_self_karma_multiple():
assert create_transactions('Baz', 'Baz', [
RawKarma(name='Baz', op='++', reason=None),
RawKarma(name='Baz', op='++', reason=None)
]) == [
KarmaTransaction(name='Baz', self_karma=True, net_karma=1, reasons=[])
]
def test_self_karma_single():
assert create_transactions(
"Baz", "Baz", [RawKarma(name="Baz", op="++", reason=None)]) == [
KarmaTransaction(name="Baz",
self_karma=True,
net_karma=1,
reasons=[])
]
def test_simple_positive():
assert create_transactions(
"Baz", "Baz", [RawKarma(name="Foobar", op="++", reason=None)]) == [
KarmaTransaction(name="Foobar",
self_karma=False,
net_karma=1,
reasons=[])
]
def test_simple_positive():
assert create_transactions(
'Baz', 'Baz', [RawKarma(name='Foobar', op='++', reason=None)]) == [
KarmaTransaction(name='Foobar',
self_karma=False,
net_karma=1,
reasons=[])
]
def test_simple_neutral_reason():
assert create_transactions(
"Bar", "Bar",
[RawKarma(name="Baz", op="+-", reason="Foobar is baz")]) == [
KarmaTransaction(name="Baz",
self_karma=False,
net_karma=0,
reasons=["Foobar is baz"])
]
def test_simple_neutral_reason():
assert create_transactions(
'Bar', 'Bar',
[RawKarma(name='Baz', op='+-', reason='Foobar is baz')]) == [
KarmaTransaction(name='Baz',
self_karma=False,
net_karma=0,
reasons=['Foobar is baz'])
]
def test_self_karma_single_reason_with_comma():
assert create_transactions(
"Bar", "Bar",
[RawKarma(name="Bar", op="++", reason="Is, awesome")]) == [
KarmaTransaction(name="Bar",
self_karma=True,
net_karma=1,
reasons=["Is, awesome"])
]
def test_self_karma_single_reason():
assert create_transactions(
'Bar', 'Bar',
[RawKarma(name='Bar', op='++', reason='Is awesome')]) == [
KarmaTransaction(name='Bar',
self_karma=True,
net_karma=1,
reasons=['Is awesome'])
]
def test_karma_positive_negative_reasons():
assert create_transactions('Bar', 'Bar', [
RawKarma(name='Baz', op='++', reason='Foobar baz 1'),
RawKarma(name='Baz', op='--', reason='Foobar baz 2')
]) == [
KarmaTransaction(name='Baz',
self_karma=False,
net_karma=0,
reasons=['Foobar baz 1', 'Foobar baz 2'])
]
def test_karma_double_negative():
assert create_transactions('Bar', 'Bar', [
RawKarma(name='Baz', op='--', reason=None),
RawKarma(name='Baz', op='--', reason=None)
]) == [
KarmaTransaction(name='Baz',
self_karma=False,
net_karma=-1,
reasons=[])
]
def test_karma_positive_negative():
assert create_transactions(
"Bar",
"Bar",
[
RawKarma(name="Baz", op="++", reason=None),
RawKarma(name="Baz", op="--", reason=None),
],
) == [
KarmaTransaction(name="Baz", self_karma=False, net_karma=0, reasons=[])
]
def test_karma_double_neutral():
assert create_transactions(
"Bar",
"Bar",
[
RawKarma(name="Baz", op="+-", reason=None),
RawKarma(name="Baz", op="-+", reason=None),
],
) == [
KarmaTransaction(name="Baz", self_karma=False, net_karma=0, reasons=[])
]
def test_self_karma_single_with_others():
assert create_transactions('Baz', 'Baz', [
RawKarma(name='Baz', op='++', reason=None),
RawKarma(name='Foobar', op='++', reason=None)
]) == [
KarmaTransaction(name='Baz', self_karma=True, net_karma=1, reasons=[]),
KarmaTransaction(name='Foobar',
self_karma=False,
net_karma=1,
reasons=[])
]
def test_self_karma_single_with_others_and_reasons():
assert create_transactions('Bar', 'Bar', [
RawKarma(name='Bar', op='++', reason='Is awesome'),
RawKarma(name='Foo', op='++', reason='Is awesome too')
]) == [
KarmaTransaction(name='Bar',
self_karma=True,
net_karma=1,
reasons=['Is awesome']),
KarmaTransaction(name='Foo',
self_karma=False,
net_karma=1,
reasons=['Is awesome too'])
]
def test_self_karma_single_with_others():
assert create_transactions(
"Baz",
"Baz",
[
RawKarma(name="Baz", op="++", reason=None),
RawKarma(name="Foobar", op="++", reason=None),
],
) == [
KarmaTransaction(name="Baz", self_karma=True, net_karma=1, reasons=[]),
KarmaTransaction(name="Foobar",
self_karma=False,
net_karma=1,
reasons=[]),
]
def test_karma_positive_negative_reasons():
assert create_transactions(
"Bar",
"Bar",
[
RawKarma(name="Baz", op="++", reason="Foobar baz 1"),
RawKarma(name="Baz", op="--", reason="Foobar baz 2"),
],
) == [
KarmaTransaction(
name="Baz",
self_karma=False,
net_karma=0,
reasons=["Foobar baz 1", "Foobar baz 2"],
)
]
def test_karma_double_neutral_reasons_and_commas():
assert create_transactions(
"Bar",
"Bar",
[
RawKarma(name="Baz", op="+-", reason="Foobar, baz 1"),
RawKarma(name="Baz", op="-+", reason="Foobar, baz 2"),
],
) == [
KarmaTransaction(
name="Baz",
self_karma=False,
net_karma=0,
reasons=["Foobar, baz 1", "Foobar, baz 2"],
)
]
def test_self_karma_multiple_reason():
assert create_transactions(
"Bar",
"Bar",
[
RawKarma(name="Bar", op="++", reason="Is awesome"),
RawKarma(name="Bar", op="++", reason="Is awesome"),
],
) == [
KarmaTransaction(
name="Bar",
self_karma=True,
net_karma=1,
reasons=["Is awesome", "Is awesome"],
)
]
def test_self_karma_single_with_others_and_reasons():
assert create_transactions(
"Bar",
"Bar",
[
RawKarma(name="Bar", op="++", reason="Is awesome"),
RawKarma(name="Foo", op="++", reason="Is awesome too"),
],
) == [
KarmaTransaction(name="Bar",
self_karma=True,
net_karma=1,
reasons=["Is awesome"]),
KarmaTransaction(name="Foo",
self_karma=False,
net_karma=1,
reasons=["Is awesome too"]),
]
def process_karma(message: Message, message_id: int, db_session: Session,
timeout: int):
reply = ""
# Parse the message for karma modifications
raw_karma = parse_message(message.clean_content, db_session)
# If no karma'd items, just return
if not raw_karma:
return reply
# TODO: Protect from byte-limit length chars
# If the author was IRC, set the display name to be the irc user that karma'd, else use original display name
display_name = message.author.display_name
if message.author.id == CONFIG["UWCS_DISCORD_BRIDGE_BOT_ID"]:
# Gets the username of the irc user
display_name = message.content.split(" ")[0][3:-3]
# Process the raw karma tokens into a number of karma transactions
transactions = create_transactions(message.author.name, display_name,
raw_karma)
if not transactions:
return reply
# Get karma-ing user
user = db_session.query(User).filter(
User.user_uid == message.author.id).first()
# Start preparing the reply string
if len(transactions) > 1:
transaction_plural = "s"
else:
transaction_plural = ""
item_str = ""
error_str = ""
# Iterate over the transactions to write them to the database
for transaction in transactions:
# Truncate the name safely so we 2000 char karmas can be used
truncated_name = ((transaction.name[300:] +
".. (truncated to 300 chars)")
if len(transaction.name) > 300 else transaction.name)
# Catch any self-karma transactions early
if transaction.self_karma and transaction.net_karma > -1:
error_str += f' • Could not change "{truncated_name}" because you cannot change your own karma! :angry:\n'
continue
# Get the karma item from the database if it exists
karma_item = (db_session.query(Karma).filter(
func.lower(Karma.name) == func.lower(
transaction.name)).one_or_none())
# Update or create the karma item
if not karma_item:
karma_item = Karma(name=transaction.name)
db_session.add(karma_item)
db_session.commit()
# Get the last change (or none if there was none)
last_change = (db_session.query(KarmaChange).filter(
KarmaChange.karma_id == karma_item.id).order_by(
desc(KarmaChange.created_at)).first())
if not last_change:
# If the bot is being downvoted then the karma can only go up
if transaction.name.lower() == "apollo":
new_score = abs(transaction.net_karma)
else:
new_score = transaction.net_karma
karma_change = KarmaChange(
karma_id=karma_item.id,
user_id=user.id,
message_id=message_id,
reasons=transaction.reasons,
change=new_score,
score=new_score,
created_at=datetime.utcnow(),
)
db_session.add(karma_change)
db_session.commit()
else:
time_delta = datetime.utcnow() - last_change.created_at
if time_delta.seconds >= timeout:
# If the bot is being downvoted then the karma can only go up
if transaction.name.lower() == "apollo":
new_score = last_change.score + abs(transaction.net_karma)
else:
new_score = last_change.score + transaction.net_karma
karma_change = KarmaChange(
karma_id=karma_item.id,
user_id=user.id,
message_id=message_id,
reasons=transaction.reasons,
score=new_score,
change=(new_score - last_change.score),
created_at=datetime.utcnow(),
)
db_session.add(karma_change)
db_session.commit()
else:
# Tell the user that the item is on cooldown
if time_delta.seconds < 60:
error_str += f' • Could not change "{truncated_name}" since it is still on cooldown (last altered {time_delta.seconds} seconds ago).\n'
else:
mins_plural = ""
mins = floor(time_delta.seconds / 60)
if time_delta.seconds >= 120:
mins_plural = "s"
error_str += f' • Could not change "{truncated_name}" since it is still on cooldown (last altered {mins} minute{mins_plural} ago).\n'
continue
# Update karma counts
if transaction.net_karma == 0:
karma_item.neutrals = karma_item.neutrals + 1
elif transaction.net_karma == 1:
karma_item.pluses = karma_item.pluses + 1
elif transaction.net_karma == -1:
# Make sure the changed operation is updated
if transaction.name.lower() == "apollo":
karma_item.pluses = karma_item.pluses + 1
else:
karma_item.minuses = karma_item.minuses + 1
# Give some sass if someone is trying to downvote the bot
if (transaction.name.casefold() == "Apollo".casefold()
and transaction.net_karma < 0):
apollo_response = ":wink:"
else:
apollo_response = ""
# Build the karma item string
if transaction.reasons:
if len(transaction.reasons) > 1:
reasons_plural = "s"
reasons_has = "have"
else:
reasons_plural = ""
reasons_has = "has"
if transaction.self_karma:
item_str += f" • **{truncated_name}** (new score is {karma_change.score}) and your reason{reasons_plural} {reasons_has} been recorded. *Fool!* that's less karma to you. :smiling_imp:\n"
else:
item_str += f" • **{truncated_name}** (new score is {karma_change.score}) and your reason{reasons_plural} {reasons_has} been recorded. {apollo_response}\n"
else:
if transaction.self_karma:
item_str += f" • **{truncated_name}** (new score is {karma_change.score}). *Fool!* that's less karma to you. :smiling_imp:\n"
else:
item_str += f" • **{truncated_name}** (new score is {karma_change.score}). {apollo_response}\n"
# Get the name, either from discord or irc
author_display = get_name_string(message)
# Construct the reply string in totality
# If you have error(s) and no items processed successfully
if not item_str and error_str:
reply = f"Sorry {author_display}, I couldn't karma the requested item{transaction_plural} because of the following problem{transaction_plural}:\n\n{error_str}"
# If you have items processed successfully but some errors too
elif item_str and error_str:
reply = f"Thanks {author_display}, I have made changes to the following item(s) karma:\n\n{item_str}\n\nThere were some issues with the following item(s), too:\n\n{error_str}"
# If all items were processed successfully
else:
reply = f"Thanks {author_display}, I have made changes to the following karma item{transaction_plural}:\n\n{item_str}"
# Commit any changes (in case of any DB inconsistencies)
db_session.commit()
return reply.rstrip()
def process_karma(message: Message, message_id: int, db_session: Session, timeout: int):
reply = ""
# Parse the message for karma modifications
raw_karma = parse_message(message.clean_content, db_session)
# If no karma'd items, just return
if not raw_karma:
return reply
# TODO: Protect from byte-limit length chars
# If the author was IRC, set the display name to be the irc user that karma'd, else use original display name
display_name = get_name_string(message)
# Process the raw karma tokens into a number of karma transactions
transactions = create_transactions(message.author.name, display_name, raw_karma)
if not transactions:
return reply
# Get karma-ing user
user = db_session.query(User).filter(User.user_uid == message.author.id).first()
# Get whether the channel is on mini karma or not
channel = (
db_session.query(MiniKarmaChannel)
.filter(MiniKarmaChannel.channel == message.channel.id)
.one_or_none()
)
if channel is None:
karma_mode = MiniKarmaMode.Normal
else:
karma_mode = MiniKarmaMode.Mini
def own_karma_error(name):
if karma_mode == MiniKarmaMode.Normal:
return f' • Could not change "{name}" because you cannot change your own karma! :angry:'
else:
return f'could not change "**{name}**" (own name)'
def internal_error(name):
if karma_mode == MiniKarmaMode.Normal:
return f' • Could not create "{name}" due to an internal error.'
else:
return f'could not change "**{name}**" (internal error)'
def cooldown_error(name, td):
# Tell the user that the item is on cooldown
if td.seconds < 60:
seconds_plural = f"second{'s' if td.seconds != 1 else ''}"
duration = f"{td.seconds} {seconds_plural}"
else:
mins = td.seconds // 60
mins_plural = f"minute{'s' if mins != 1 else ''}"
duration = f"{mins} {mins_plural}"
if karma_mode == MiniKarmaMode.Normal:
return f' • Could not change "{name}" since it is still on cooldown (last altered {duration} ago).\n'
else:
return f'could not change "**{name}**" (cooldown, last edit {duration} ago)'
def success_item(tr: KarmaTransaction):
# Give some sass if someone is trying to downvote the bot
if tr.name.casefold() == "apollo" and tr.net_karma < 0:
apollo_response = ":wink:"
else:
apollo_response = ""
if tr.net_karma == 1:
op = "++"
elif tr.net_karma == -1:
op = "--"
else:
op = "+-"
# Build the karma item string
if tr.reasons:
if len(tr.reasons) > 1:
reasons_plural = "reasons"
reasons_has = "have"
else:
reasons_plural = "reason"
reasons_has = "has"
if karma_mode == MiniKarmaMode.Normal:
if tr.self_karma:
return f" • **{truncated_name}** (new score is {karma_change.score}) and your {reasons_plural} {reasons_has} been recorded. *Fool!* that's less karma to you. :smiling_imp:"
else:
return f" • **{truncated_name}** (new score is {karma_change.score}) and your {reasons_plural} {reasons_has} been recorded. {apollo_response}"
else:
return f"**{truncated_name}{op}** (now {karma_change.score}, {reasons_plural} recorded)"
else:
if karma_mode == MiniKarmaMode.Normal:
if tr.self_karma:
return f" • **{truncated_name}** (new score is {karma_change.score}). *Fool!* that's less karma to you. :smiling_imp:"
else:
return f" • **{truncated_name}** (new score is {karma_change.score}). {apollo_response}"
else:
return f"**{truncated_name}{op}** (now {karma_change.score})"
# Start preparing the reply string
if len(transactions) > 1:
transaction_plural = "s"
else:
transaction_plural = ""
items = []
errors = []
# Iterate over the transactions to write them to the database
for transaction in transactions:
# Truncate the name safely so we 2000 char karmas can be used
truncated_name = (
(transaction.name[300:] + ".. (truncated to 300 chars)")
if len(transaction.name) > 300
else transaction.name
)
# Catch any self-karma transactions early
if transaction.self_karma and transaction.net_karma > -1:
errors.append(own_karma_error(truncated_name))
continue
# Get the karma item from the database if it exists
karma_item = (
db_session.query(Karma)
.filter(func.lower(Karma.name) == func.lower(transaction.name))
.one_or_none()
)
# Update or create the karma item
if not karma_item:
karma_item = Karma(name=transaction.name)
db_session.add(karma_item)
try:
db_session.commit()
except (ScalarListException, SQLAlchemyError):
db_session.rollback()
errors.append(internal_error(truncated_name))
continue
# Get the last change (or none if there was none)
last_change = (
db_session.query(KarmaChange)
.filter(KarmaChange.karma_id == karma_item.id)
.order_by(desc(KarmaChange.created_at))
.first()
)
if not last_change:
# If the bot is being downvoted then the karma can only go up
if transaction.name.casefold() == "apollo":
new_score = abs(transaction.net_karma)
else:
new_score = transaction.net_karma
karma_change = KarmaChange(
karma_id=karma_item.id,
user_id=user.id,
message_id=message_id,
reasons=transaction.reasons,
change=new_score,
score=new_score,
created_at=datetime.utcnow(),
)
db_session.add(karma_change)
try:
db_session.commit()
except (ScalarListException, SQLAlchemyError):
db_session.rollback()
errors.append(internal_error(truncated_name))
continue
else:
time_delta = datetime.utcnow() - last_change.created_at
if time_delta.seconds >= timeout:
# If the bot is being downvoted then the karma can only go up
if transaction.name.casefold() == "apollo":
new_score = last_change.score + abs(transaction.net_karma)
else:
new_score = last_change.score + transaction.net_karma
karma_change = KarmaChange(
karma_id=karma_item.id,
user_id=user.id,
message_id=message_id,
reasons=transaction.reasons,
score=new_score,
change=(new_score - last_change.score),
created_at=datetime.utcnow(),
)
db_session.add(karma_change)
try:
db_session.commit()
except (ScalarListException, SQLAlchemyError):
db_session.rollback()
errors.append(internal_error(truncated_name))
continue
else:
errors.append(cooldown_error(truncated_name, time_delta))
continue
# Update karma counts
if transaction.net_karma == 0:
karma_item.neutrals = karma_item.neutrals + 1
elif transaction.net_karma == 1:
karma_item.pluses = karma_item.pluses + 1
elif transaction.net_karma == -1:
# Make sure the changed operation is updated
if transaction.name.casefold() == "apollo":
karma_item.pluses = karma_item.pluses + 1
else:
karma_item.minuses = karma_item.minuses + 1
items.append(success_item(transaction))
# Get the name, either from discord or irc
author_display = get_name_string(message)
# Construct the reply string in totality
# If you have error(s) and no items processed successfully
if karma_mode == MiniKarmaMode.Normal:
item_str = "\n".join(items)
error_str = "\n".join(errors)
if not item_str and error_str:
reply = f"Sorry {author_display}, I couldn't karma the requested item{transaction_plural} because of the following problem{transaction_plural}:\n\n{error_str}"
# If you have items processed successfully but some errors too
elif item_str and error_str:
reply = f"Thanks {author_display}, I have made changes to the following item(s) karma:\n\n{item_str}\n\nThere were some issues with the following item(s), too:\n\n{error_str}"
# If all items were processed successfully
else:
reply = f"Thanks {author_display}, I have made changes to the following karma item{transaction_plural}:\n\n{item_str}"
else:
item_str = " ".join(items)
error_str = " ".join(errors)
reply = " ".join(filter(None, ["Changes:", item_str, error_str]))
# Commit any changes (in case of any DB inconsistencies)
try:
db_session.commit()
except (ScalarListException, SQLAlchemyError):
db_session.rollback()
return reply.rstrip()
def test_empty():
assert create_transactions("", "", []) is None
