mediawiki-butt 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 213456f1170993110a675e00652fb5a4319797dd
-  data.tar.gz: f43f85a958898445e7690dadeb99b5d30cfd56df
+  metadata.gz: a7fcf2ef47e61692db61d985c91b7cd22bcc1051
+  data.tar.gz: d806db7d3a63c4654322b30cae4ae98ce68e2eb9
 SHA512:
-  metadata.gz: 7911cdaa9abcd01d41f048e2b422e1cf55d1302e768286ffeb891b90e699774f8a94dd90e646fd216b7bcde61ddaa51c0e52d1bea02240eed01f8c0a98eb9a04
-  data.tar.gz: 4f740f7718b7de3934c8374463d37f1d2ebd1c21d969bcb0f321736093e7168c5f3bbf10b8ec93643a34bf340d544a3dd9811330274159942cc1050f6762321b
+  metadata.gz: 31c4e56c5104e4758fbe710bdec577feb3c16a2f9c620a9ccd45fbd8b47afa10e19027b114c2c06c9a6363822b1de964e0d7e7c84640ec33ef85414250964a9d
+  data.tar.gz: 915a073ac9f0d9654e46f4976b352c2318a56c939be7e1282bd8099c67f2a2c054af735d28342ee601f1aab27d76537897b52c57e42f15c26c187aa15692789a

data/lib/mediawiki/query/lists.rb

@@ -28,23 +28,30 @@ module MediaWiki
         ret
       end
 
-      # Returns an array of all page titles that belong to a given category.
+      # Returns an array of all page titles that belong to a given category. By
+      #   default, it will only get the pages. Files and subcategories can be
+      #   gotten through {#get_subcategories} and {#get_files_in_category} or
+      #   setting the type parameter.
       # @param category [String] The category title. It can include "Category:",
       #   or not, it doesn't really matter because we will add it if it is
       #   missing.
       # @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.
+      # @param type [String] The type of stuff to get. There are 3 valid values:
+      #   page, file, and subcat. Separate these with a pipe character, e.g.,
+      #   'page|file|subcat'.
       # @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)
+      def get_category_members(category, limit = 500, type = 'page')
         params = {
           action: 'query',
           list: 'categorymembers',
           cmprop: 'title',
-          cmlimit: get_limited(limit)
+          cmlimit: get_limited(limit),
+          cmtype: type
         }
 
         if category =~ /[Cc]ategory\:/
@@ -59,6 +66,26 @@ module MediaWiki
         ret
       end
 
+      # Gets the subcategories of a given category.
+      # @param category [String] See {#get_category_members}
+      # @param limit [Int] See {#get_category_members}
+      # @see {#get_category_members}
+      # @since 0.9.0
+      # @return [Array<String>] All subcategories.
+      def get_subcategories(category, limit = 500)
+        get_category_members(category, limit, 'subcat')
+      end
+
+      # Gets all of the files in a given category.
+      # @param category [String] See {#get_category_members}
+      # @param limit [Int] See {#get_category_members}
+      # @see {#get_category_members}
+      # @since 0.9.0
+      # @return [Array<String>] All files in the category.
+      def get_files_in_category(category, limit = 500)
+        get_category_members(category, limit, 'file')
+      end
+
       # Returns an array of random pages titles.
       # @param number_of_pages [Int] The number of articles to get.
       #   Defaults to 1. Cannot be greater than 10 for normal users,

metadata

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