Page MenuHomeWickedGov Phorge
Files F4127489

Api.js
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

Api.js
View Options

'use strict';
const MWBot = require( 'mwbot' );
module.exports = {
/**
* Get a logged-in instance of `MWBot` with edit token already set up.
* Default username, password and base URL is used unless specified.
*
* @since 0.5.0
* @param {string} username - Optional
* @param {string} password - Optional
* @param {string} baseUrl - Optional
* @return {Promise<MWBot>}
*/
async bot(
username = browser.config.mwUser,
password = browser.config.mwPwd,
baseUrl = browser.config.baseUrl
) {
const bot = new MWBot();
await bot.loginGetEditToken( {
apiUrl: `${ baseUrl }/api.php`,
username: username,
password: password
} );
return bot;
},
/**
* Shortcut for `MWBot#request( { acount: 'createaccount', .. } )`.
*
* @since 0.1.0
* @see <https://www.mediawiki.org/wiki/API:Account_creation>
* @param {MWBot} adminBot
* @param {string} username New user name
* @param {string} password New user password
* @return {Object} Promise for API action=createaccount response data.
*/
async createAccount( adminBot, username, password ) {
await adminBot.getCreateaccountToken();
// Create the new account
return await adminBot.request( {
action: 'createaccount',
createreturnurl: browser.config.baseUrl,
createtoken: adminBot.createaccountToken,
username: username,
password: password,
retype: password
} );
},
/**
* Shortcut for `MWBot#request( { action: 'block', .. } )`.
*
* @since 0.3.0
* @see <https://www.mediawiki.org/wiki/API:Block>
* @param {MWBot} adminBot
* @param {string} [username] defaults to blocking the admin user
* @param {string} [expiry] default is not set. For format see API docs
* @return {Object} Promise for API action=block response data.
*/
async blockUser( adminBot, username, expiry ) {
return await adminBot.request( {
action: 'block',
user: username || browser.config.mwUser,
reason: 'browser test',
token: adminBot.editToken,
expiry
} );
},
/**
* Shortcut for `MWBot#request( { action: 'unblock', .. } )`.
*
* @since 0.3.0
* @see <https://www.mediawiki.org/wiki/API:Block>
* @param {MWBot} adminBot
* @param {string} [username] defaults to unblocking the admin user
* @return {Object} Promise for API action=unblock response data.
*/
async unblockUser( adminBot, username ) {
return await adminBot.request( {
action: 'unblock',
user: username || browser.config.mwUser,
reason: 'browser test done',
token: adminBot.editToken
} );
},
/**
* Assign a new user group to the given username.
*
* @since 2.7.0
* @param {MWBot} adminBot
* @param {string} username
* @param {string} groupName
*/
async addUserToGroup( adminBot, username, groupName ) {
const userGroupsResponse = await adminBot.request( {
action: 'query',
list: 'users',
usprop: 'groups',
ususers: username,
formatversion: 2
} );
if (
userGroupsResponse.query.users.length &&
userGroupsResponse.query.users[ 0 ].groups.includes( groupName )
) {
return;
}
const tokenResponse = await adminBot.request( {
action: 'query',
meta: 'tokens',
type: 'userrights'
} );
await adminBot.request( {
action: 'userrights',
user: username,
token: tokenResponse.query.tokens.userrightstoken,
add: groupName,
reason: 'Selenium testing'
} );
// If there is an error, the above already throws.
}
};

File Metadata

Mime Type
text/plain
Expires
Wed, Aug 19, 08:40 (2 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2e/84/b27113cb954194eae657da398b2c
Default Alt Text
Api.js (3 KB)

Event Timeline