LBRYCommunity/lbry-tipbot
1
0
Fork 0
Code Issues 4 Pull requests 4 Projects Releases Packages Wiki Activity

Added Tipbot Privacy Mode

Browse source 
Allow for Tipbot to be used privately while still notifying the user that has received the tip, via private message.

Updates the Help message for new usage instructions, fixes misspelling of 'address' and adds a Key for the [ ] and < > syntax, as some users may not understand their usage.

Reworks the subcommand parsing by using a more compact Switch Function. Necessitates the use of 'break;' but is far more compact and legible, presumed the old if else block is from early development with fewer features available. Switch statement should allow for easier expansion.

Modifies doTip() to avoid requiring code duplication, includes two new variables used to indicate that the tip should be done in privacy mode and where the tip value is located in the 'words' array.

Significant change to sendLbc and it's function call, requirement for private message for recipient required User object, thus the function now requires the actual GuildMember object, not only the ID. While this marginally increases overhead, it should also allow access to the send() function for that Guild Member, allowing for private message to be sent. Further the addition of a privacy flag (0 for non-private, 1 for private) was added so that the function can determine whether to send a public or private response. this required updating references to the Guild Member's id to 'member.id', but otherwise operation remains the same until the transaction is completed, following which it will check the privacy flag and if it is set, will privately send the successful tip message to both author and recipient, otherwise it will simply reply via the normal '.reply()' function.
This commit is contained in:
ProfessorDey 2017-11-14 18:33:17 +01:00 committed by GitHub
parent 59b66dc12a
commit ec48f114d8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
bot/modules/tipbot.js
View file

@ -10,26 +10,17 @@ exports.commands = [
]
exports.tip = {
usage: "<subcommand>",
description: 'balance: get your balance\n deposit: get adress for your deposits\n withdraw ADDRESS AMOUNT: withdraw AMOUNT credits to ADDRESS\n <user> <amount>: mention a user with @ and then the amount to tip them',
description: 'balance: get your balance\n deposit: get address for your deposits\n withdraw ADDRESS AMOUNT: withdraw AMOUNT credits to ADDRESS\n [private] <user> <amount>: mention a user with @ and then the amount to tip them, or put private before the user to tip them privately.\n Key: [] : Optionally include contained keyword, <> : Replace with appropriate value.',
process: async function(bot,msg,suffix){
let tipper = msg.author.id,
words = msg.content.trim().split(' ').filter( function(n){return n !== "";} ),
subcommand = words.length >= 2 ? words[1] : 'help';
if (subcommand === 'help') {
doHelp(msg);
}
else if (subcommand === 'balance') {
doBalance(msg, tipper);
}
else if (subcommand === 'deposit') {
doDeposit(msg, tipper);
}
else if (subcommand === 'withdraw') {
doWithdraw(msg, tipper, words);
}
else {
doTip(msg, tipper, words);
}
switch subcommand {
case 'help': doHelp(msg); break;
case 'balance': doBalance(msg, tipper); break;
case 'deposit': doDeposit(msg, tipper); break;
case 'withdraw': doWithdraw(msg, tipper, words); break;
default: doTip(msg, tipper, words);
}
}
@ -97,7 +88,14 @@ function doTip(message, tipper, words) {
return;
}
let amount = getValidatedAmount(words[2]);
let prv = 0;
let amountOffset = 2;
if (words.length >= 4 && words[1] === 'private') {
prv = 1;
amountOffset = 3;
}
let amount = getValidatedAmount(words[amountOffset]);
if (amount === null) {
message.reply('I dont know how to tip that many credits');
@ -105,8 +103,8 @@ function doTip(message, tipper, words) {
}
if (message.mentions.members.first().id) {
let id = message.mentions.members.first().id;
sendLbc(message, tipper, id, amount);
let member = message.mentions.members.first();
sendLbc(message, tipper, member, amount, prv);
}
else
{
@ -125,8 +123,8 @@ function doHelp(message) {
}
function sendLbc(message, tipper, id, amount) {
getAddress(id, function(err, address){
function sendLbc(message, tipper, member, amount, privacyFlag) {
getAddress(member.id, function(err, address){
if (err) {
message.reply(err.message);
}
@ -137,9 +135,14 @@ function sendLbc(message, tipper, id, amount) {
}
else {
var imessage =
'Wubba lubba dub dub! <@' + tipper + '> tipped <@' + id + '> ' + amount + ' LBC (' + txLink(txId) + '). ' +
'Wubba lubba dub dub! <@' + tipper + '> tipped <@' + member.id + '> ' + amount + ' LBC (' + txLink(txId) + '). ' +
'DM me `!tip` for tipbot instructions.'
if (privacyFlag) {
message.author.send(imessage);
member.send(imessage);
} else {
message.reply(imessage);
}
}
});
}