mediawiki-butt 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8287cc51bbd45b0b63fb8c16b5b86b74848b3e85
-  data.tar.gz: 33b65213c477787cbfbf00ae5c834cf2d24705f0
+  metadata.gz: 213456f1170993110a675e00652fb5a4319797dd
+  data.tar.gz: f43f85a958898445e7690dadeb99b5d30cfd56df
 SHA512:
-  metadata.gz: c14f1a0202eb3e5c4614fb1c43e59556162215162cdb1b22f570e00030254377f5cf3c61fbabbc2d4a75ffb38081f9f6e8674648262a1a2431c0834fb828df1e
-  data.tar.gz: 5fb48bb4ef5ab53fa247581a05132e46e7de00a7a81a90a03c87d1024bdd52210fd159032b12659fe3002cb3dfa2980e329cc5f444047644158efffe093993c8
+  metadata.gz: 7911cdaa9abcd01d41f048e2b422e1cf55d1302e768286ffeb891b90e699774f8a94dd90e646fd216b7bcde61ddaa51c0e52d1bea02240eed01f8c0a98eb9a04
+  data.tar.gz: 4f740f7718b7de3934c8374463d37f1d2ebd1c21d969bcb0f321736093e7168c5f3bbf10b8ec93643a34bf340d544a3dd9811330274159942cc1050f6762321b

data/lib/mediawiki/administration.rb

@@ -5,6 +5,8 @@ module MediaWiki
     # @param expiry [String] The expiry timestamp using a relative expiry time.
     # @param reason [String] The reason to show in the block log.
     # @param nocreate [Boolean] Whether to allow them to create an account.
+    # @see https://www.mediawiki.org/wiki/API:Block MediaWiki Block API Docs
+    # @since 0.5.0
     # @return [String] The error code.
     # @return [Int] The block ID.
     def block(user, expiry = '2 weeks', reason = nil, nocreate = true)
@@ -31,6 +33,8 @@ module MediaWiki
     # Unblocks the user.
     # @param user [String] The user to unblock.
     # @param reason [String] The reason to show in the block log.
+    # @see https://www.mediawiki.org/wiki/API:Block MediaWiki Block API Docs
+    # @since 0.5.0
     # @return [String] The error code.
     # @return [Int] The block ID.
     def unblock(user, reason = nil)

data/lib/mediawiki/auth.rb

@@ -3,11 +3,26 @@ require_relative 'exceptions'
 module MediaWiki
   module Auth
     # Checks the login result for errors. Returns true if it is successful,
-    #   else false with an error raised.
+    # else false with an error raised.
     # @param result [String] The parsed version of the result.
     # @param secondtry [Boolean] Whether this login is the first or second try.
     #   False for first, true for second.
-    # @return [Boolean] true if successful. Does not return anything if not.
+    # @raise [NeedTokenMoreThanOnceError] When secondtry is true and the wiki
+    #   still returns 'NeedToken'
+    # @raise [NoNameError] When the username is nil or undefined.
+    # @raise [IllegalUsernameError] When the username is illegal.
+    # @raise [UsernameNotExistsError] When the username does not exist.
+    # @raise [EmptyPassError] When the password is nil or undefined.
+    # @raise [WrongPassError] When the password is incorrect.
+    # @raise [WrongPluginPassError] When an authentication plugin, not
+    #   MediaWiki, claims that the password is incorrect.
+    # @raise [CreateBlockedError] When the wiki tries to automatically create
+    #   an account, but the user's IP address is already blocked.
+    # @raise [ThrottledError] When the user has logged in, or tried to, too
+    #   much in a particular amount of time.
+    # @raise [BlockedError] When the user is blocked from the wiki.
+    # @since 0.1.0
+    # @return [Boolean] true if successful. Does not return anything otherwise.
     def check_login(result, secondtry)
       case result
       when 'Success'
@@ -37,8 +52,29 @@ module MediaWiki
     end
 
     # Checks the account creation result's error and raises the corresponding
-    #   exception.
+    # exception.
     # @param error [String] The parsed error code string
+    # @raise [NoNameError] When the username was either not provided or is
+    #   invalid.
+    # @raise [UserExistsError] When the username is already in use.
+    # @raise [UserPassMatchError] When the username and password are identical.
+    # @raise [PasswordLoginForbiddenError] When the use of the username and
+    #   password has been forbidden.
+    # @raise [NoEmailTitleError] When there is no provided email address.
+    # @raise [InvalidEmailAddressError] When the email address has an invalid
+    #   format.
+    # @raise [PasswordTooShortError] When the password is shorter than the
+    #   $wgMinimumPasswordLength option.
+    # @raise [NoEmailError] When there is no email address set for the user.
+    # @raise [ThrottledError] When the user has created too many accounts in one
+    #   day.
+    # @raise [AbortedError] When an extension has aborted this action.
+    # @raise [BlockedError] When the IP or logged in user is blocked.
+    # @raise [PermDeniedError] When the user does not have the right to create
+    #   accounts.
+    # @raise [HookAbortedError] Same as AbortedError.
+    # @since 0.1.1
+    # @return [void]
     def check_create(error)
       case error
       when 'noname'
@@ -74,6 +110,9 @@ module MediaWiki
     #   getting restricted data. Will return the result of #check_login
     # @param username [String] The username
     # @param password [String] The password
+    # @see check_login
+    # @see https://www.mediawiki.org/wiki/API:Login MediaWiki Login API Docs
+    # @since 0.1.0
     # @return [Boolean] True if the login was successful, false if not.
     def login(username, password)
       params = {
@@ -106,6 +145,8 @@ module MediaWiki
     end
 
     # Logs the current user out.
+    # @see https://www.mediawiki.org/wiki/API:Logout MediaWiki Logout API Docs
+    # @since 0.1.0
     # @return [Boolean] True if it was able to log anyone out, false if not
     #   (basically, if someone was logged in, it returns true).
     def logout
@@ -131,6 +172,10 @@ module MediaWiki
     #   the name.
     # @param reason [String] The reason for creating the account, as shown in
     #   the account creation log. Optional.
+    # @see check_create
+    # @see https://www.mediawiki.org/wiki/API:Account_creation MediaWiki Account
+    #   Creation Docs
+    # @since 0.1.0
     # @return [Boolean] True if successful, false if not.
     def create_account(username, password, language = 'en', *reason)
       params = {
@@ -179,6 +224,10 @@ module MediaWiki
     #   the name.
     # @param reason [String] The reason for creating the account, as shown in
     #   the account creation log. Optional.
+    # @see check_create
+    # @see https://www.mediawiki.org/wiki/API:Account_creation MediaWiki Account
+    #   Creation Docs
+    # @since 0.1.0
     # @return [Boolean] True if successful, false if not.
     def create_account_email(username, email, language = 'en', *reason)
       params = {

data/lib/mediawiki/butt.rb

@@ -20,11 +20,12 @@ module MediaWiki
     include MediaWiki::Administration
 
     # Creates a new instance of MediaWiki::Butt. To work with any
-    #   MediaWiki::Butt methods, you must first create an instance of it.
+    # MediaWiki::Butt methods, you must first create an instance of it.
     # @param url [String] The FULL wiki URL. api.php can be omitted, but it
     #   will make harsh assumptions about your wiki configuration.
     # @param use_ssl [Boolean] Whether or not to use SSL. Will default to true.
     # @param custom_agent [String] A custom User-Agent to use. Optional.
+    # @since 0.1.0
     def initialize(url, use_ssl = true, custom_agent = nil)
       @url = url =~ /api.php$/ ? url : "#{url}/api.php"
       @client = HTTPClient.new
@@ -36,24 +37,17 @@ module MediaWiki
     end
 
     # Performs a generic HTTP POST action and provides the response. This
-    #   method generally should not be used by the user, unless there is not a
-    #   method provided by the Butt developers for a particular action.
+    # method generally should not be used by the user, unless there is not a
+    # method provided by the Butt developers for a particular action.
     # @param params [Hash] A basic hash containing MediaWiki API parameters.
     #   Please see the MediaWiki API for more information.
     # @param autoparse [Boolean] Whether or not to provide a parsed version
     #   of the response's JSON. Will default to true.
     # @param header [Hash] The header hash. Optional.
+    # @since 0.1.0
     # @return [JSON/HTTPMessage] Parsed JSON if autoparse is true.
     # @return [HTTPMessage] Raw HTTP response.
     def post(params, autoparse = true, header = nil)
-      # Note that defining the header argument as a splat argument (*header)
-      #   causes errors in HTTPClient. We must use header.nil? rather than a
-      #   splat argument and defined? header due to this error. For those
-      #   interested, the error is:
-      #     undefined method `downcase' for {"Set-Cookie"=>"cookie"}:Hash
-      #   This is obvisouly an error in HTTPClient, but we must work around it
-      #   until there is a fix in the gem.
-
       params[:format] = 'json'
       header = {} if header.nil?
 
@@ -69,13 +63,14 @@ module MediaWiki
       end
     end
 
-    # Returns true if the currently logged in user is in the "bot" group.
-    #   This can be helpful to some developers, but it is mostly for use
-    #   internally in MediaWiki::Butt.
+    # Gets whether the currently logged in user is a bot.
     # @param username [String] The username to check. Optional. Defaults to
     #   the currently logged in user if nil.
     # @return [Boolean] true if logged in as a bot, false if not logged in or
     #   logged in as a non-bot
+    # @since 0.1.0 as is_current_user_bot
+    # @since 0.3.0 as is_user_bot?
+    # @since 0.4.1 as user_bot?
     def user_bot?(username = nil)
       groups = false
 

data/lib/mediawiki/constants.rb

@@ -1,6 +1,10 @@
 module MediaWiki
   module Constants
-    # Taken from https://www.mediawiki.org/wiki/Extension_default_namespaces
+    # @since 0.2.0 as a module with individual global constants
+    # @since 0.4.0 as a module with a single global hash identical to this.
+    # @since 0.8.0 as its current state.
+    # @see https://www.mediawiki.org/wiki/Extension_default_namespaces
+    #   MediaWiki's list of extension namespace IDs and names.
     NAMESPACES = {
       'MAIN' => 0,
       'TALK' => 1,

data/lib/mediawiki/edit.rb

@@ -1,7 +1,6 @@
 module MediaWiki
   module Edit
-    # Performs a standard edit.
-    #   It cannot create pages. Please use create_page for that.
+    # Performs a standard non-creation edit.
     # @param title [String] The page title.
     # @param text [String] The new content.
     # @param minor [Boolean] Will mark the edit as minor if true.
@@ -9,6 +8,10 @@ module MediaWiki
     # @param bot [Boolean] Will mark the edit as bot edit if true.
     #   Defualts to true, for your convenience, bot developers.
     # @param summary [String] The edit summary. Optional.
+    # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing
+    #   wiki content on the MediaWiki API documentation
+    # @see https://www.mediawiki.org/wiki/API:Edit MediaWiki Edit API Docs
+    # @since 0.2.0
     # @return [String] The new revision ID, or if it failed, the error code.
     def edit(title, text, minor = false, bot = true, *summary)
       params = {
@@ -41,6 +44,10 @@ module MediaWiki
     # @param summary [String] The edit summary. Defaults to 'New page'.
     # @param bot [Boolean] Will mark the edit as a bot edit if true.
     #   Defaults to true, for your convenience, bot developers.
+    # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing
+    #   wiki content on the MediaWiki API documentation
+    # @see https://www.mediawiki.org/wiki/API:Edit MediaWiki Edit API Docs
+    # @since 0.3.0
     # @return [String] The new page ID, or if it failed, the error code.
     def create_page(title, text, summary = 'New page', bot = true)
       params = {
@@ -74,6 +81,10 @@ module MediaWiki
     #   the last slash in the URL.
     # @return [Boolean] True if the upload was successful, false if the
     #   file extension is not valid.
+    # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing
+    #   wiki content on the MediaWiki API documentation
+    # @see https://www.mediawiki.org/wiki/API:Upload MediaWiki Upload API Docs
+    # @since 0.3.0
     # @return [String] The warning's key if it was unsuccessful.
     def upload(url, filename = nil)
       params = {
@@ -115,6 +126,10 @@ module MediaWiki
     # @param talk [Boolean] Whether to move the associated talk page.
     #   Defaults to true.
     # @param redirect [Boolean] Whether to create a redirect. Defaults to false.
+    # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing
+    #   wiki content on the MediaWiki API documentation
+    # @see https://www.mediawiki.org/wiki/API:Move MediaWiki Move API Docs
+    # @since 0.5.0
     # @return [Boolean] True if it was successful.
     # @return [String] The error code if it was unsuccessful.
     def move(from, to, reason = nil, talk = true, redirect = false)
@@ -141,6 +156,10 @@ module MediaWiki
     # Deletes a page.
     # @param title [String] The page to delete.
     # @param reason [String] The reason to be displayed in logs. Optional.
+    # @see https://www.mediawiki.org/wiki/API:Changing_wiki_content Changing
+    #   wiki content on the MediaWiki API documentation
+    # @see https://www.mediawiki.org/wiki/API:Delete MediaWiki Delete API Docs
+    # @since 0.5.0
     # @return [Boolean] True if successful.
     # @return [String] The error code if it was not successful.
     def delete(title, reason = nil)

data/lib/mediawiki/query/lists.rb

@@ -9,6 +9,9 @@ module MediaWiki
       # @param limit [Int] The maximum number of pages to get. Defaults to 500,
       #   and cannot be greater than that unless the user is a bot. If the user
       #   is a bot, the limit cannot be greater than 5000.
+      # @see https://www.mediawiki.org/wiki/API:Backlinks MediaWiki Backlinks
+      #   API Docs
+      # @since 0.1.0
       # @return [Array] All backlinks until the limit
       def what_links_here(title, limit = 500)
         params = {
@@ -32,6 +35,9 @@ module MediaWiki
       # @param limit [Int] The maximum number of members to get. Defaults to
       #   500, and cannot be greater than that unless the user is a bot.
       #   If the user is a bot, the limit cannot be greater than 5000.
+      # @see https://www.mediawiki.org/wiki/API:Categorymembers MediaWiki
+      #   Category Members API Docs
+      # @since 0.1.0
       # @return [Array] All category members until the limit
       def get_category_members(category, limit = 500)
         params = {
@@ -59,6 +65,8 @@ module MediaWiki
       #   or 20 for bots.
       # @param namespace [Int] The namespace ID. Defaults to
       #   0 (the main namespace).
+      # @see https://www.mediawiki.org/wiki/API:Random MediaWiki Random API Docs
+      # @since 0.2.0
       # @return [Array] All members
       def get_random_pages(number_of_pages = 1, namespace = 0)
         params = {
@@ -67,7 +75,7 @@ module MediaWiki
           rnlimit: get_limited(number_of_pages, 10, 20)
         }
 
-        if @namespaces.value?(namespace)
+        if MediaWiki::Constants::NAMESPACES.value?(namespace)
           params[:rnnamespace] = namespace
         else
           params[:rnnamespace] = 0
@@ -81,10 +89,13 @@ module MediaWiki
       end
 
       # Gets user information. This method should rarely be used by
-      #   normal users.
+      # normal users, unless they want a huge amount of user data at once.
       # @param prop [String] The usprop parameter.
       # @param username [String] The username to get info for. Optional.
       #   Defaults to the currently logged in user if ommitted.
+      # @see https://www.mediawiki.org/wiki/API:Users MediaWiki User Lists API
+      #   Docs
+      # @since 0.3.0
       # @return [String] Parsed full response if successful.
       # @return [Nil] If the username is nil and the Butt is not logged in.
       def get_userlists(prop, username = nil)
@@ -111,6 +122,8 @@ module MediaWiki
       # Gets an array of all the user's groups.
       # @param username [String] The username to get groups of. Optional.
       #   Defaults to the currently logged in user.
+      # @see get_userlists
+      # @since 0.3.0
       # @return [Array] All of the user's groups.
       # @return [Boolean] False if username is nil and not logged in.
       def get_usergroups(username = nil)
@@ -135,6 +148,8 @@ module MediaWiki
       # Gets the user rights for the user.
       # @param username [String] The user to get the rights for. Optional.
       #   Defaults to the currently logged in user.
+      # @see get_userlists
+      # @since 0.3.0
       # @return [Array] All of the user's groups.
       # @return [Boolean] False if username is nil and not logged in.
       def get_userrights(username = nil)
@@ -161,6 +176,8 @@ module MediaWiki
       # Gets contribution count for the user.
       # @param username [String] The username to get the contribution count of.
       #   Optional. Defaults to the currently logged in user.
+      # @see get_userlists
+      # @since 0.3.0
       # @return [Boolean] False if username is nil and not logged in.
       # @return [Int] The number of contributions the user has made.
       def get_contrib_count(username = nil)
@@ -183,6 +200,8 @@ module MediaWiki
       # Gets when the user registered.
       # @param username [String] The username to get the registration date and
       #   time of. Optional. Defaults to the currently logged in user.
+      # @see get_userlists
+      # @since 0.4.0
       # @return [DateTime] The registration date and time as a DateTime object.
       def get_registration_time(username = nil)
         time = nil
@@ -211,6 +230,8 @@ module MediaWiki
 
       # Gets the gender for the provded user.
       # @param username [String] The user.
+      # @see get_userlists
+      # @since 0.4.0
       # @return [String] The gender. 'male', 'female', or 'unknown'.
       def get_user_gender(username)
         gender = nil
@@ -224,6 +245,8 @@ module MediaWiki
       # @param search_value [String] The thing to search for.
       # @param namespace [Int] The namespace to search in.
       #   Defaults to 0 (the main namespace).
+      # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API Docs
+      # @since 0.4.0
       # @return [Int] The number of pages that matched the search.
       def get_search_result_amount(search_value, namespace = 0)
         params = {
@@ -246,6 +269,8 @@ module MediaWiki
       # @param search_value [String] The thing to search for.
       # @param namespace [Int] The namespace to search in.
       #   Defaults to 0 (the main namespace).
+      # @see https://www.mediawiki.org/wiki/API:Search MediaWiki Search API Docs
+      # @since 0.4.0
       # @return [Array] The page titles that matched the search.
       def get_search_results(search_value, namespace = 0)
         params = {
@@ -271,6 +296,9 @@ module MediaWiki
       # Gets all categories on the entire wiki.
       # @param limit [Int] The maximum number of categories to get. Defaults to
       #   500. Cannot be greater than 500 for normal users, or 5000 for bots.
+      # @see https://www.mediawiki.org/wiki/API:Allcategories MediaWiki
+      #   Allcategories API Docs
+      # @since 0.7.0
       # @return [Array] An array of all categories.
       def get_all_categories(limit = 500)
         params = {
@@ -290,6 +318,9 @@ module MediaWiki
       # Gets all the images on the wiki.
       # @param limit [Int] The maximum number of images to get. Defaults to 500.
       #   Cannot be greater than 500 for normal users, or 5000 for bots.
+      # @see https://www.mediawiki.org/wiki/API:Allimages MediaWiki Allimages
+      #   API Docs
+      # @since 0.7.0
       # @return [Array] An array of all images.
       def get_all_images(limit = 500)
         params = {
@@ -309,6 +340,9 @@ module MediaWiki
       # Gets all pages within a namespace integer.
       # @param namespace [Int] The namespace ID.
       # @param limit [Int] See #get_all_images
+      # @see https://www.mediawiki.org/wiki/API:Allpages MediaWiki Allpages
+      #   API Docs
+      # @since 0.8.0
       # @return [Array] An array of all page titles.
       def get_all_pages_in_namespace(namespace, limit = 500)
         params = {
@@ -329,6 +363,9 @@ module MediaWiki
       # Gets all users, or all users in a group.
       # @param group [String] The group to limit this query to.
       # @param limit [Int] See #get_all_images.
+      # @see https://www.mediawiki.org/wiki/API:Allusers MediaWiki Allusers
+      #   API Docs
+      # @since 0.8.0
       # @return [Hash] A hash of all users, names are keys, IDs are values.
       def get_all_users(group = nil, limit = 500)
         params = {
@@ -349,6 +386,8 @@ module MediaWiki
       # Gets all block IDs on the wiki. It seems like this only gets non-IP
       #   blocks, but the MediaWiki docs are a bit unclear.
       # @param limit [Int] See #get_all_images.
+      # @see https://www.mediawiki.org/wiki/API:Blocks MediaWiki Blocks API Docs
+      # @since 0.8.0
       # @return [Array] All block IDs as strings.
       def get_all_blocks(limit = 500)
         params = {
@@ -369,6 +408,9 @@ module MediaWiki
       # Gets all page titles that transclude a given page.
       # @param page [String] The page name.
       # @param limit [Int] See #get_all_images.
+      # @see https://www.mediawiki.org/wiki/API:Embeddedin MediaWiki Embeddedin
+      #   API Docs
+      # @since 0.8.0
       # @return [Array] All transcluder page titles.
       def get_all_transcluders(page, limit = 500)
         params = {
@@ -388,6 +430,9 @@ module MediaWiki
 
       # Gets an array of all deleted or archived files on the wiki.
       # @param limit [Int] See #get_all_images
+      # @see https://www.mediawiki.org/wiki/API:Filearchive MediaWiki
+      #   Filearchive API Docs
+      # @since 0.8.0
       # @return [Array] All deleted file names. These are not titles, so they do
       #   not include "File:".
       def get_all_deleted_files(limit = 500)
@@ -408,6 +453,9 @@ module MediaWiki
       # Gets a list of all protected pages, by protection level if provided.
       # @param protection_level [String] The protection level, e.g., sysop
       # @param limit [Int] See #get_all_images.
+      # @see https://www.mediawiki.org/wiki/API:Protectedtitles MediaWiki
+      #   Protectedtitles API Docs
+      # @since 0.8.0
       # @return [Array] All protected page titles.
       def get_all_protected_titles(protection_level = nil, limit = 500)
         params = {
@@ -428,6 +476,9 @@ module MediaWiki
       # Gets the latest contributions by the user until the limit.
       # @param user [String] The username.
       # @param limit [Int] See #get_all_images.
+      # @see https://www.mediawiki.org/wiki/API:Usercontribs MediaWiki
+      #   User Contributions API Docs
+      # @since 0.8.0
       # @return [Hash] Each contribution by its revid, containing the title,
       #   summary, total contribution size, and the size change relative to the
       #   previous edit.
@@ -459,6 +510,9 @@ module MediaWiki
       #   currently logged in user, according to the MediaWiki API.
       # @param user [String] The username.
       # @param limit [Int] See #get_all_images.
+      # @see https://www.mediawiki.org/wiki/API:Watchlist MediaWiki Watchlist
+      #   API Docs
+      # @since 0.8.0
       # @return [Array] All the watchlist page titles.
       def get_full_watchlist(user = nil, limit = 500)
         params = {

data/lib/mediawiki/query/meta/filerepoinfo.rb

@@ -1,9 +1,12 @@
 module MediaWiki
   module Query
     module Meta
+      # @see https://www.mediawiki.org/wiki/API:Filerepoinfo MediaWiki
+      #   Filerepoinfo API Docs
       module FileRepoInfo
         # Gets FileRepoInfo for the property.
         # @param prop [String] The friprop to get.
+        # @since 0.7.0
         # @return [Response] The full parsed response.
         def get_filerepoinfo(prop)
           params = {
@@ -16,6 +19,7 @@ module MediaWiki
         end
 
         # Returns an array of all the wiki's file repository names.
+        # @since 0.1.0
         # @return [Array] All wiki's file repository names.
         def get_filerepo_names
           response = get_filerepoinfo('name|displayname')
@@ -25,6 +29,7 @@ module MediaWiki
         end
 
         # Gets the root URLs for the file repositories.
+        # @since 0.7.0
         # @return [Hash] A hash containing keys of the names, and values of the
         #   root URLs.
         def get_filerepo_rooturls
@@ -35,6 +40,7 @@ module MediaWiki
         end
 
         # Gets an array containing all local repositories.
+        # @since 0.7.0
         # @return [Array] All repositories that are marked as local.
         def get_local_filerepos
           response = get_filerepoinfo('name|local')
@@ -47,6 +53,7 @@ module MediaWiki
         end
 
         # Gets an array containing all repositories that aren't local.
+        # @since 0.7.0
         # @return [Array] All repositories that are not marked as local.
         def get_nonlocal_filerepos
           response = get_filerepoinfo('name|local')
@@ -59,6 +66,7 @@ module MediaWiki
         end
 
         # Gets the repository names and their according URLs.
+        # @since 0.7.0
         # @return [Hash] Names as the keys, with their URLs as the values.
         def get_filerepo_urls
           response = get_filerepoinfo('name|url')
@@ -68,6 +76,7 @@ module MediaWiki
         end
 
         # Gets the repository names and their accoring thumbnail URLs.
+        # @since 0.7.0
         # @return [Hash] Names as the keys, with their URLs as the values.
         def get_filerepo_thumburls
           response = get_filerepoinfo('name|thumbUrl')
@@ -77,6 +86,7 @@ module MediaWiki
         end
 
         # Gets the repository names and their according favicon URLs.
+        # @since 0.7.0
         # @return [Hash] Names as the keys, with their favicons as the values.
         def get_filerepo_favicons
           response = get_filerepoinfo('name|favicon')

data/lib/mediawiki/query/meta/siteinfo.rb

@@ -1,10 +1,13 @@
 module MediaWiki
   module Query
     module Meta
+      # @see https://www.mediawiki.org/wiki/API:Siteinfo MediaWiki Siteinfo
+      #   API Docs
       module SiteInfo
         # Gets wiki information. This method should rarely be used by
         #   normal users.
         # @param prop [String] The siprop parameter.
+        # @since 0.6.0
         # @return [Response] Parsed full response.
         def get_siteinfo(prop)
           params = {
@@ -17,6 +20,7 @@ module MediaWiki
         end
 
         # Gets the statistics for the wiki.
+        # @since 0.6.0
         # @return [Hash] The statistics and their according values.
         def get_statistics
           response = get_siteinfo('statistics')
@@ -26,6 +30,7 @@ module MediaWiki
         end
 
         # Gets the general information for the wiki.
+        # @since 0.6.0
         # @return [Hash] The general info and their according values.
         def get_general
           response = get_siteinfo('general')
@@ -35,6 +40,7 @@ module MediaWiki
         end
 
         # Gets all extensions installed on the wiki.
+        # @since 0.6.0
         # @return [Array] All extension names.
         def get_extensions
           response = get_siteinfo('extensions')
@@ -44,6 +50,7 @@ module MediaWiki
         end
 
         # Gets all languages and their codes.
+        # @since 0.6.0
         # @return [Hash] All languages. Hash key value pair formatted as
         #   code => name.
         def get_languages
@@ -55,6 +62,7 @@ module MediaWiki
 
         # Gets all namespaces on the wiki and their IDs. Different from the
         #   Namespaces module.
+        # @since 0.6.0
         # @return [Hash] All namespaces, formatted as ID => Name.
         def get_namespaces
           response = get_siteinfo('namespaces')
@@ -68,6 +76,7 @@ module MediaWiki
         end
 
         # Gets all namespace aliases and their IDs.
+        # @since 0.6.0
         # @return [Hash] All aliases, formatted as ID => Alias.
         def get_namespace_aliases
           response = get_siteinfo('namespacealiases')
@@ -79,6 +88,7 @@ module MediaWiki
         end
 
         # Gets all special page aliases.
+        # @since 0.6.0
         # @return [Hash] All aliases, formatted as RealName => Alias.
         def get_special_page_aliases
           response = get_siteinfo('specialpagealiases')
@@ -90,6 +100,7 @@ module MediaWiki
         end
 
         # Gets all magic words and their aliases.
+        # @since 0.6.0
         # @return [Hash] All magic words, formatted as Name => Alias.
         def get_magic_words
           response = get_siteinfo('magicwords')
@@ -101,6 +112,7 @@ module MediaWiki
         end
 
         # Gets all user groups total.
+        # @since 0.6.0
         # @return [Hash] All groups, formatted as Name => [Rights].
         def get_all_usergroups
           response = get_siteinfo('usergroups')
@@ -112,6 +124,7 @@ module MediaWiki
         end
 
         # Gets all file extensions that are allowed to be uploaded.
+        # @since 0.6.0
         # @return [Array] All file extensions.
         def get_allowed_file_extensions
           response = get_siteinfo('fileextensions')
@@ -124,12 +137,14 @@ module MediaWiki
 
         # Gets the response for the restrictions siteinfo API. Not really for
         #   use by users, mostly for the other two restriction methods.
+        # @since 0.6.0
         def get_restrictions_data
           response = get_siteinfo('restrictions')
           response['query']['restrictions']
         end
 
         # Gets all restriction/protection types.
+        # @since 0.6.0
         # @return [Array] All protection types.
         def get_restriction_types
           restrictions = get_restrictions_data
@@ -139,6 +154,7 @@ module MediaWiki
         end
 
         # Gets all restriction/protection levels.
+        # @since 0.6.0
         # @return [Array] All protection levels.
         def get_restriction_levels
           restrictions = get_restrictions_data
@@ -148,6 +164,7 @@ module MediaWiki
         end
 
         # Gets all skins and their codes.
+        # @since 0.6.0
         # @return [Hash] All skins, formatted as Code => Name
         def get_skins
           response = get_siteinfo('skins')
@@ -159,6 +176,7 @@ module MediaWiki
         end
 
         # Gets all HTML tags added by installed extensions.
+        # @since 0.6.0
         # @return [Array] All extension tags.
         def get_extension_tags
           response = get_siteinfo('extensiontags')
@@ -170,6 +188,7 @@ module MediaWiki
         end
 
         # Gets all function hooks.
+        # @since 0.6.0
         # @return [Array] All function hooks.
         def get_function_hooks
           response = get_siteinfo('functionhooks')
@@ -181,6 +200,7 @@ module MediaWiki
         end
 
         # Gets all variables that are usable on the wiki, such as NUMBEROFPAGES.
+        # @since 0.6.0
         # @return [Array] All variable string values.
         def get_variables
           response = get_siteinfo('variables')

data/lib/mediawiki/query/meta/userinfo.rb

@@ -1,9 +1,12 @@
 module MediaWiki
   module Query
     module Meta
+      # @see https://www.mediawiki.org/wiki/API:Userinfo MediaWiki Userinfo
+      #   API Docs
       module UserInfo
         # Gets meta information for the currently logged in user.
         # @param prop [String] The uiprop to get. Optional.
+        # @since 0.4.0
         # @return [Response/Boolean] Either a full, parsed response.
         # @return [Boolean] False if not logged in.
         def get_current_user_meta(prop = nil)
@@ -21,6 +24,7 @@ module MediaWiki
         end
 
         # Gets the current user's username.
+        # @since 0.7.0
         # @return [String] Returns the username.
         # @return [Boolean] False if...
         def get_current_user_name
@@ -36,6 +40,7 @@ module MediaWiki
 
         # Returns whether or not the currently logged in user has any unread
         #   messages on their talk page.
+        # @since 0.7.0
         # @return [Boolean] True if they have unreads, else false.
         def current_user_hasmsg?
           response = get_current_user_meta('hasmsg')
@@ -52,6 +57,7 @@ module MediaWiki
 
         # Gets a hash-of-arrays containing all the groups the user can add and
         #   remove people from.
+        # @since 0.7.0
         # @return [Boolean] False if get_current_user_meta is false
         # @return [Hash] All the groups that the user can add, remove, add-self,
         #   and remove-self.
@@ -79,6 +85,7 @@ module MediaWiki
         end
 
         # Gets the currently logged in user's real name.
+        # @since 0.7.0
         # @return [String] The user's real name.
         # @return [Nil] If they don't have a real name set.
         def get_realname
@@ -91,6 +98,7 @@ module MediaWiki
         end
 
         # Gets the currently logged in user's email address.
+        # @since 0.7.0
         # @return [String] The user's email address.
         # @return [Nil] If their email address is not set.
         def get_email_address
@@ -103,6 +111,7 @@ module MediaWiki
         end
 
         # Gets the user's options.
+        # @since 0.7.0
         # @return [Hash] The user's options.
         def get_current_user_options
           response = get_current_user_meta('options')

data/lib/mediawiki/query/properties/contributors.rb

@@ -9,6 +9,9 @@ module MediaWiki
         # @param limit [Int] The maximum number of users to get. Defaults to 500
         #   and cannot be greater than that unless the user is a bot. If the
         #   user is a bot, the limit cannot be greater than 5000.
+        # @see get_anonymous_contributors_count
+        # @see get_logged_in_contributors
+        # @since 0.8.0
         # @return [Int] The number of contributors to that page.
         def get_total_contributors(title, limit = 500)
           anon_users = get_anonymous_contributors_count(title, limit)
@@ -20,6 +23,8 @@ module MediaWiki
         # Gets the non-anonymous contributors for the given page.
         # @param title [String] See #get_total_contributors
         # @param limit [Int] See #get_total_contributors
+        # @see get_contributors_response
+        # @since 0.8.0
         # @return [Array] All usernames for the contributors.
         def get_logged_in_contributors(title, limit = 500)
           response = get_contributors_response(title, limit)
@@ -42,6 +47,9 @@ module MediaWiki
         # Gets the parsed response for the contributors property.
         # @param title [String] See #get_total_contributors
         # @param limit [Int] See #get_total_contributors
+        # @see https://www.mediawiki.org/wiki/API:Contributors MediaWiki
+        #   Contributors Property API Docs
+        # @since 0.8.0
         # @return [JSON] See #post
         def get_contributors_response(title, limit = 500)
           params = {
@@ -57,6 +65,8 @@ module MediaWiki
         # Gets the total number of anonymous contributors for the given page.
         # @param title [String] See #get_total_contributors
         # @param limit [Int] See #get_total_contributors
+        # @see get_contributors_response
+        # @since 0.8.0
         # @return [Int] The number of anonymous contributors for the page.
         def get_anonymous_contributors_count(title, limit = 500)
           response = get_contributors_response(title, limit)

data/lib/mediawiki/query/properties/files.rb

@@ -7,6 +7,9 @@ module MediaWiki
         # Gets the duplicated files of the title.
         # @param title [String] The title to get duplicated files of.
         # @param limit [Int] The maximum number of files to get.
+        # @see https://www.mediawiki.org/wiki/API:Duplicatefiles MediaWiki
+        #   Duplicate Files API Docs
+        # @since 0.8.0
         # @return [Array] Array of all the duplicated file names.
         # @return [Nil] If there aren't any duplicated files.
         def get_duplicated_files_of(title, limit = 500)
@@ -30,6 +33,9 @@ module MediaWiki
 
         # Gets all duplicated files on the wiki.
         # @param limit [Int] The maximum number of files to get.
+        # @see https://www.mediawiki.org/wiki/API:Duplicatefiles MediaWiki
+        #   Duplicate Files API Docs
+        # @since 0.8.0
         # @return [Array] All duplicate file titles on the wiki.
         def get_all_duplicated_files(limit = 500)
           params = {
@@ -49,6 +55,8 @@ module MediaWiki
 
         # Gets the size of an image in bytes.
         # @param image [String] The image to get info for.
+        # @see get_image_sizes
+        # @since 0.8.0
         # @return [Fixnum] The number of bytes.
         # @return [Nil] If the image does not exist.
         def get_image_bytes(image)
@@ -59,6 +67,8 @@ module MediaWiki
 
         # Gets the dimensions of an image as width, height.
         # @param image [String] The image to get info for.
+        # @see get_image_sizes
+        # @since 0.8.0
         # @return [Array] The dimensions as width, height.
         # @return [Nil] If the image does not exist.
         def get_image_dimensions(image)
@@ -71,6 +81,9 @@ module MediaWiki
 
         # Gets the imageinfo property 'size' for the image.
         # @param image [String] The image to get info for.
+        # @see https://www.mediawiki.org/wiki/API:Imageinfo MediaWiki Imageinfo
+        #   API Docs
+        # @since 0.8.0
         # @return [Hash] A hash of the size, width, and height.
         # @return [Nil] If the image does not exist.
         def get_image_sizes(image)

data/lib/mediawiki/query/properties/pages.rb

@@ -6,6 +6,9 @@ module MediaWiki
       module Pages
         # Gets all categories in the page.
         # @param title [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Property/Categories
+        #   MediaWiki Categories Property API Docs
+        # @since 0.8.0
         # @return [Array] All the categories
         # @return [Nil] If the title does not exist.
         def get_categories_in_page(title)
@@ -33,6 +36,9 @@ module MediaWiki
         # Gets the wiki text for the given page. Returns nil if it for some
         #   reason cannot get the text, for example, if the page does not exist.
         # @param title [String] The page title
+        # @see https://www.mediawiki.org/wiki/API:Revisions MediaWiki Revisions
+        #   API Docs
+        # @since 0.8.0
         # @return [String/nil] String containing page contents.
         # @return [Nil] If the page does not exist.
         def get_text(title)
@@ -56,6 +62,9 @@ module MediaWiki
 
         # Gets the revision ID for the given page.
         # @param title [String] The page title
+        # @see https://www.mediawiki.org/wiki/API:Revisions MediaWiki Revisions
+        #   API Docs
+        # @since 0.8.0
         # @return [Int/nil] The page's ID
         # @return [Nil] If the page does not exist.
         def get_id(title)
@@ -81,6 +90,9 @@ module MediaWiki
         # @param limit [Int] The maximum number of members to get. Defaults to
         #   500, and cannot be greater than that unless the user is a bot.
         #   If the user is a bot, the limit cannot be greater than 5000.
+        # @see https://www.mediawiki.org/wiki/API:Extlinks MediaWiki Extlinks
+        #   API Docs
+        # @since 0.8.0
         # @return [Array] All external link URLs.
         def get_external_links(page, limit = 500)
           params = {
@@ -107,6 +119,8 @@ module MediaWiki
 
         # Gets whether the current user watches the page.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Boolean] Whether the user watches the page.
         # @return [Boolean] False if the user is not logged in.
         # @return [Nil] If the page does not exist.
@@ -134,6 +148,8 @@ module MediaWiki
 
         # Gets whether the current user (can be anonymous) can read the page.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Boolean] Whether the user can read the page.
         # @return [Nil] If the page does not exist.
         def can_i_read?(page)
@@ -156,6 +172,8 @@ module MediaWiki
 
         # Gets whether the given page is a redirect.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Boolean] Whether the page is a redirect.
         # @return [Nil] If the page does not exist.
         def page_redirect?(page)
@@ -177,6 +195,8 @@ module MediaWiki
 
         # Gets whether the given page only has one edit.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Boolean] Whether the page only has one edit.
         # @return [Nil] If the page does not exist.
         def page_new?(page)
@@ -198,6 +218,8 @@ module MediaWiki
 
         # Gets the number of users that watch the given page.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Fixnum] The number of watchers.
         # @return [Nil] If the page does not exist.
         def get_number_of_watchers(page)
@@ -222,6 +244,8 @@ module MediaWiki
         #   changes to its display, e.g., using a template to make the first
         #   letter lowercase, in cases like iPhone.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [String] The page's display title.
         # @return [Nil] If the page does not exist.
         def get_display_title(page)
@@ -250,6 +274,8 @@ module MediaWiki
         #   that is needed to perform that type of edit, like 'sysop'. Expiry
         #   refers to when the protection will expire, if never, it will be
         #   'infinity'.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Nil] If the page does not exist.
         def get_protection_levels(page)
           params = {
@@ -275,6 +301,8 @@ module MediaWiki
 
         # Gets the size, in bytes, of the page.
         # @param page [String] The page title.
+        # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+        # @since 0.8.0
         # @return [Fixnum] The number of bytes.
         # @return [Nil] If the page does not exist.
         def get_page_size(page)
@@ -297,6 +325,9 @@ module MediaWiki
         # Gets all of the images in the given page.
         # @param page [String] The page title.
         # @param limit [Fixnum] See #get_external_links
+        # @see https://www.mediawiki.org/wiki/API:Images MediaWiki Images API
+        #   Docs
+        # @since 0.8.0
         # @return [Array] All of the image titles in the page.
         # @return [Nil] If the page does not exist.
         def get_images_in_page(page, limit = 500)
@@ -325,6 +356,9 @@ module MediaWiki
         # Gets all of the templates in the given page.
         # @param page [String] The page title.
         # @param limit [Fixnum] See #get_external_links
+        # @see https://www.mediawiki.org/wiki/API:Templates MediaWiki Templates
+        #   API Docs
+        # @since 0.8.0
         # @return [Array] All of the templte titles in the page.
         # @return [Nil] If the page does not exist.
         def get_templates_in_page(page, limit = 500)
@@ -353,6 +387,9 @@ module MediaWiki
         # Gets all of the interwiki links on the given page.
         # @param page [String] The page title.
         # @param limit [Fixnum] See #get_external_links.
+        # @see https://www.mediawiki.org/wiki/API:Iwlinks MediaWiki Interwiki
+        #   Links API Docs
+        # @since 0.8.0
         # @return [Array] All interwiki link titles.
         # @return [Nil] If the page does not exist.
         def get_interwiki_links_in_page(page, limit = 500)
@@ -383,6 +420,9 @@ module MediaWiki
         #   title. This method does not work with the Translate extension.
         # @param page [String] The page title.
         # @param limit [Fixnum] See #get_external_links
+        # @see https://www.mediawiki.org/wiki/API:Langlinks MediaWiki Langlinks
+        #   API Docs
+        # @since 0.8.0
         # @return [Hash] The data described previously.
         # @return [Nil] If the page does not exist.
         def get_other_langs_of_page(page, limit = 500)
@@ -417,6 +457,8 @@ module MediaWiki
         # Gets every single link in a page.
         # @param page [String] The page title.
         # @param limit [Fixnum] See #get_external_links.
+        # @see https://www.mediawiki.org/wiki/API:Links MediaWiki Links API Docs
+        # @since 0.8.0
         # @return [Array] All link titles.
         # @return [Nil] If the page does not exist.
         def get_all_links_in_page(page, limit = 500)

data/lib/mediawiki/query/properties/properties.rb

@@ -13,6 +13,8 @@ module MediaWiki
       #   used by normal users.
       # @param type [String] The type of token.
       # @param title [String] The page title for the token. Optional.
+      # @see https://www.mediawiki.org/wiki/API:Info MediaWiki Info API Docs
+      # @since 0.5.0
       # @return [String] The token. If the butt isn't logged in, it returns
       #   with '+\\'.
       def get_token(type, title = nil)

data/lib/mediawiki/query/query.rb

@@ -11,10 +11,11 @@ module MediaWiki
     protected
 
     # Gets the limited version of the integer, to ensure nobody provides an int
-    #   that is too large.
+    # that is too large.
     # @param integer [Int] The number to limit.
     # @param max_user [Int] The maximum limit for normal users.
     # @param max_bot [Int] The maximum limit for bot users.
+    # @since 0.8.0
     # @return [Int] The capped number.
     def get_limited(integer, max_user = 500, max_bot = 5000)
       if integer > max_user

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2015-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient