mediawiki-butt 0.7.0 → 0.8.0

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

@@ -0,0 +1,45 @@
+require_relative 'contributors'
+require_relative 'pages'
+require_relative 'files'
+
+module MediaWiki
+  module Query
+    module Properties
+      include MediaWiki::Query::Properties::Contributors
+      include MediaWiki::Query::Properties::Pages
+      include MediaWiki::Query::Properties::Files
+
+      # Gets the token for the given type. This method should rarely be
+      #   used by normal users.
+      # @param type [String] The type of token.
+      # @param title [String] The page title for the token. Optional.
+      # @return [String] The token. If the butt isn't logged in, it returns
+      #   with '+\\'.
+      def get_token(type, title = nil)
+        if @logged_in == true
+          # There is some weird thing with MediaWiki where you must pass a valid
+          #   inprop parameter in order to get any response at all. This is why
+          #   there is a displaytitle inprop as well as gibberish in the titles
+          #   parameter. And to avoid normalization, it's capitalized.
+          params = {
+            action: 'query',
+            prop: 'info',
+            inprop: 'displaytitle',
+            intoken: type
+          }
+
+          title = 'Somegibberish' if title.nil?
+          params[:titles] = title
+          response = post(params)
+          revid = nil
+          response['query']['pages'].each { |r, _| revid = r }
+
+          # URL encoding is not needed for some reason.
+          return response['query']['pages'][revid]["#{type}token"]
+        else
+          return '+\\'
+        end
+      end
+    end
+  end
+end

data/lib/mediawiki/query/query.rb

@@ -1,11 +1,37 @@
 require_relative 'meta/meta'
 require_relative 'lists'
-require_relative 'properties'
+require_relative 'properties/properties'
 
 module MediaWiki
   module Query
     include MediaWiki::Query::Meta
     include MediaWiki::Query::Lists
     include MediaWiki::Query::Properties
+
+    protected
+
+    module_function
+
+    # Gets the limited version of the integer, to ensure nobody provides an int
+    #   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.
+    # @return [Int] The capped number.
+    def get_limited(integer, max_user = 500, max_bot = 5000)
+      if integer > 500
+        if user_bot? == true
+          if integer > 5000
+            return 5000
+          else
+            return integer
+          end
+        else
+          return 500
+        end
+      else
+        return integer
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,36 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: string-utility
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: httpclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0.1
 description: "    MediaWiki::Butt is a Ruby Gem that provides a fully-featured MediaWiki
   API     interface. It includes methods for changing wiki content, authentication,
   \    and queries.\n\n"
@@ -47,7 +33,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
 - lib/mediawiki-butt.rb
 - lib/mediawiki/administration.rb
 - lib/mediawiki/auth.rb
@@ -60,7 +45,10 @@ files:
 - lib/mediawiki/query/meta/meta.rb
 - lib/mediawiki/query/meta/siteinfo.rb
 - lib/mediawiki/query/meta/userinfo.rb
-- lib/mediawiki/query/properties.rb
+- lib/mediawiki/query/properties/contributors.rb
+- lib/mediawiki/query/properties/files.rb
+- lib/mediawiki/query/properties/pages.rb
+- lib/mediawiki/query/properties/properties.rb
 - lib/mediawiki/query/query.rb
 homepage: https://github.com/ftb-gamepedia/mediawiki-butt-ruby
 licenses:
@@ -88,3 +76,4 @@ signing_key:
 specification_version: 4
 summary: Interacting with the MediaWiki API
 test_files: []
+has_rdoc: 

data/CHANGELOG.md

@@ -1,119 +0,0 @@
-# Changelog
-## Version 0
-### Version 0.7.0
-* upload's filename argument is no longer splat, because arrays.
-* Fix incorrect regex $ when ^ should be used in upload.
-* New get_all_categories method.
-* New get_all_images method.
-* Fix some user_bot? calls.
-* user_bot? returns false when not logged in and username is not set.
-* Refactor Query module to have its own folder, and subfolder for meta. This shouldn't change anything on the user's end.
-* A couple methods no longer stupidly print stuff.
-* New get_categories_in_page method.
-
-### Version 0.6.0
-* Slightly expanded Gem description.
-* Finished all Meta modules and their methods, except for the allmessages meta query. [#6](https://github.com/ftb-gamepedia/mediawiki-butt-ruby/issues/6)
-  * New get_variables method.
-  * New get_function_hooks method.
-  * New get_extension_tags method.
-  * New get_skins method.
-  * New get_restriction_levels method.
-  * New get_restriction_types method.
-  * New get_restrictions_data method for the above methods.
-  * New get_allowed_file_extensions method, and refactored #upload to only allow files with those extensions.
-  * New get_all_usergroups method.
-  * New get_magic_words method.
-  * New get_special_page_aliases method.
-  * New get_namespace_aliases method.
-  * New get_namespaces method.
-  * New get_filerepo_favicons method.
-  * New get_filerepo_thumburls method.
-  * New get_nonlocal_filerepos method.
-  * New get_local_filerepos method.
-  * New get_filerepo_urls method.
-  * New get_filerepo_rooturls method.
-  * Refactor get_filerepo_names to use new get_filerepoinfo method.
-  * New get_filerepoinfo method, in a similar style to get_userlists.
-  * New get_current_user_options for getting a hash containing all of the currently logged in user's preferences.
-  * New get_email_address method for getting the currently logged in user's email address.
-  * New get_realname method for getting the currently logged in user's real name.
-  * New get_changeable_groups method for getting the currently logged in user's groups that they can change (add/remove people from)
-  * New current_user_hasmsg? method for checking if the user has any unread messages.
-  * check_login no longer returns false, ever, because any code after a fail is unreachable.
-  * prop parameter in get_current_user_meta is now optional, for get_current_user_name.
-  * New get_current_user_name method, for something fairly obvious.
-  * New get_siteinfo method, in a similar style to get_userlists.
-  * New get_statistics method, for getting a hash of the wiki's statistics.
-  * New get_general method, for getting hash of the 'general' wiki information.
-  * New get_extensions method, for getting an array of all extension names installed.
-  * New get_languages method, for getting a hash of all the languages, formatted as code => name.
-* User-Agent header is now set for each post. It defaults to 'NotLoggedIn/MediaWiki::Butt', or "#{name}/MediaWiki::Butt" if logged in. This might cause some slight performance issues ([#5](https://github.com/FTB-Gamepedia/MediaWiki-Butt-Ruby/issues/5))
-
-### Version 0.5.0
-* New Administration module for administrative methods.
-* New block and unblock methods, for (un)blocking users.
-* Refactor token stuff. It still doesn't work exactly how I'd like yet, but it's better than it was before. Ideally I'd like to have it get the login-specific tokens on login and set them to some well-named instance variables. Then clear those on logout.
-* Single-line each `do end` loops have been converted into `{...}` style loops.
-* New delete method for deleting pages.
-* New move method for moving pages.
-
-### Version 0.4.1
-* params[:format] is now automatically set to 'json', so it no longer needs to be defined in each method.
-* Fixed a lot of styling issues thanks to Rubocop.
-* check_login and check_create now use case/when statements instead of elsifs.
-* check_create no longer returns anything.
-* Update minimum Ruby version to 2.1, for refinements.
-* Fix $namespaces hash syntax.
-* Generally improved if statement syntax.
-* Generally shortened a lot of code by using better syntax.
-
-### Version 0.4.0
-* New get_userrights method for getting an array of all user rights that user has.
-* New get_user_gender method for getting the gender of the provided user.
-* New get_current_user_meta for getting userlists about the currently logged in user. Essentially the equivalent of get_userlists for logged in users.
-* Fix all userlist methods to work without supplying a username.
-* New get_registration_time method to get when the user registered.
-* Update to work with latest version of string-utility.
-* Namespaces are now in a hash instead of just a bunch of variables.
-* Namespace parameters are now actually limited to the valid namespaces constant. It will default to the main namespace (0) if the integer provided is not in the namespaces hash.
-* get_random_pages no longer wrongly sets the rnlimit to the namespaces argument rather than the namespace argument.
-
-### Version 0.3.1
-* Fix edit and create_page NoMethodErrors.
-* Remove dependency for JSON as the version we use is included in the Ruby standard library.
-
-### Version 0.3.0
-* New upload method to upload by URL.
-* New create_page method.
-* New get_userlists method.
-* New get_usergroups method.
-* New get_contrib_count method.
-* Refactor get_usergroups and is_current_user_bot? to use new get_userinfo method.
-* Minor refactors to make optional arguments more Ruby-like with splat arguments.
-* #edit no longer prints the edit token, because that's stupid.
-* #edit no longer sets the summary if it is nil.
-
-### Version 0.2.1
-* Fix gemspec. You should actually have the new stuff now.
-
-### Version 0.2.0
-* New get_id method to get the pageid from the title.
-* New get_random_pages method to get an array of random articles.
-* New Namespace module full of constants.
-* is_current_user_bot is now called as is_current_user_bot?.
-* New get_edit_token method for obtaining an edit token based on the page title.
-* New edit method and module for editing pages.
-* Fix logout parsing error
-
-### Version 0.1.1
-* Got rid of pointless array in is_current_user_bot
-* Potentially fixed docs
-* Raise errors on unsuccessful account creation
-* #login properly returns true if the login is successful on the first try
-* #logout returns true/false if it logs the user out. Basically returns true if @logged_in is true, and false if not, because the logout action has no errors.
-* Account creation stuff actually returns true/false on success/fail. It also handles errors now.
-* Better Category title regex in get_category_members
-
-### Version 0.1.0
-* Initial version.

data/lib/mediawiki/query/properties.rb

@@ -1,107 +0,0 @@
-module MediaWiki
-  module Query
-    module Properties
-      # 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
-      # @return [String/nil] String containing page contents, or nil
-      def get_text(title)
-        params = {
-          action: 'query',
-          prop: 'revisions',
-          rvprop: 'content',
-          titles: title
-        }
-
-        response = post(params)
-        revid = nil
-        response['query']['pages'].each { |r, _| revid = r }
-
-        if response['query']['pages'][revid]['missing'] == ''
-          return nil
-        else
-          return response['query']['pages'][revid]['revisions'][0]['*']
-        end
-      end
-
-      # Gets the revision ID for the given page.
-      # @param title [String] The page title
-      # @return [Int/nil] the ID or nil
-      def get_id(title)
-        params = {
-          action: 'query',
-          prop: 'revisions',
-          rvprop: 'content',
-          titles: title
-        }
-
-        response = post(params)
-        response['query']['pages'].each do |revid, _|
-          if revid != '-1'
-            return revid.to_i
-          else
-            return nil
-          end
-        end
-      end
-
-      # Gets the token for the given type. This method should rarely be
-      #   used by normal users.
-      # @param type [String] The type of token.
-      # @param title [String] The page title for the token. Optional.
-      # @return [String] The token. If the butt isn't logged in, it returns
-      #   with '+\\'.
-      def get_token(type, title = nil)
-        if @logged_in == true
-          # There is some weird thing with MediaWiki where you must pass a valid
-          #   inprop parameter in order to get any response at all. This is why
-          #   there is a displaytitle inprop as well as gibberish in the titles
-          #   parameter. And to avoid normalization, it's capitalized.
-          params = {
-            action: 'query',
-            prop: 'info',
-            inprop: 'displaytitle',
-            intoken: type
-          }
-
-          title = 'Somegibberish' if title.nil?
-          params[:titles] = title
-          response = post(params)
-          revid = nil
-          response['query']['pages'].each { |r, _| revid = r }
-
-          # URL encoding is not needed for some reason.
-          return response['query']['pages'][revid]["#{type}token"]
-        else
-          return '+\\'
-        end
-      end
-
-      # Gets all categories in the page.
-      # @param title [String] The page title.
-      # @return [Array/Nil] An array of all the categories, or nil if the title
-      #   is not an actual page.
-      def get_categories_in_page(title)
-        params = {
-          action: 'query',
-          prop: 'categories',
-          titles: title
-        }
-
-        response = post(params)
-        pageid = nil
-        ret = []
-        response['query']['pages'].each { |r, _| pageid = r }
-        if response['query']['pages'][pageid]['missing'] == ''
-          return nil
-        else
-          response['query']['pages'][pageid]['categories'].each do |c|
-            ret.push(c['title'])
-          end
-        end
-
-        ret
-      end
-    end
-  end
-end