module MediaWiki::Administration
Public Instance Methods
block(user, expiry = '2 weeks', reason = nil, nocreate = true)
click to toggle source
Blocks the user. @param (see unblock
) @param expiry [String] The expiry timestamp using a relative expiry time. @param nocreate [Boolean] Whether to allow them to create an account. @see www.mediawiki.org/wiki/API:Block MediaWiki
Block API Docs @since 0.5.0 @raise [BlockError] @return (see unblock
)
# File lib/mediawiki/administration.rb, line 13 def block(user, expiry = '2 weeks', reason = nil, nocreate = true) params = { action: 'block', user: user, expiry: expiry } token = get_token params[:reason] = reason if reason params[:nocreate] = '1' if nocreate params[:token] = token response = post(params) if response.key?('error') raise MediaWiki::Butt::BlockError.new(response.dig('error', 'code') || 'Unknown error code') end response['id'].to_i end
unblock(user, reason = nil)
click to toggle source
Unblocks the user. @param user [String] The user affected. @param reason [String] The reason to show in the block log. @see www.mediawiki.org/wiki/API:Block MediaWiki
Block API Docs @since 0.5.0 @raise [BlockError] @return [Fixnum] The block ID.
# File lib/mediawiki/administration.rb, line 41 def unblock(user, reason = nil) params = { action: 'unblock', user: user } token = get_token params[:reason] = reason if reason params[:token] = token response = post(params) if response.key?('error') raise MediaWiki::Butt::BlockError.new(response.dig('error', 'code') || 'Unknown error code') end response['id'].to_i end