mediawiki-butt 0.11.1 → 1.0.0

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

@@ -9,38 +9,33 @@ module MediaWiki
       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.
+      # 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.
       # @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 '+\\'.
+      # @return [String] The token. If the butt isn't logged in, it returns  with '+\\'.
       def get_token(type, title = nil)
-        if @logged_in
-          # 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
-          }
+        return '+\\' unless @logged_in
 
-          title = 'Somegibberish' if title.nil?
-          params[:titles] = title
-          response = post(params)
-          revid = nil
-          response['query']['pages'].each { |r, _| revid = r }
+        # 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
+        }
 
-          # URL encoding is not needed for some reason.
-          return response['query']['pages'][revid]["#{type}token"]
-        else
-          return '+\\'
-        end
+        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.
+        response['query']['pages'][revid]["#{type}token"]
       end
     end
   end

data/lib/mediawiki/query/query.rb

@@ -7,30 +7,5 @@ module MediaWiki
     include MediaWiki::Query::Meta
     include MediaWiki::Query::Lists
     include MediaWiki::Query::Properties
-
-    protected
-
-    # 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.
-    # @since 0.8.0
-    # @return [Int] The capped number.
-    def get_limited(integer, max_user = 500, max_bot = 5000)
-      if integer > max_user
-        if user_bot?
-          if integer > max_bot
-            return max_bot
-          else
-            return integer
-          end
-        else
-          return max_user
-        end
-      else
-        return integer
-      end
-    end
   end
 end

data/lib/mediawiki/utils.rb

@@ -3,17 +3,18 @@ module MediaWiki
   # requiring 'mediawiki-butt' or 'mediawiki/butt'; you must require it explicitly.
   class Utils
     # Encodes the URL like mw.util.rawurlencode JS.
-    # @todo Perhaps write a StringUtility method for better gsubs?
+    # @todo Require StringUtility and use its safely_gsub method.
     # @param str [String] The string to replace (typically a page title).
     # @return [String] The encoded string.
     def self.encode_url(str)
-      str.gsub!(/!/,'%21') || str
-      str.gsub!(/'/,'%27') || str
-      str.gsub!(/\(/,'%28') || str
-      str.gsub!(/\)/,'%29') || str
-      str.gsub!(/\*/,'%2A') || str
-      str.gsub!(/~/,'%7E') || str
-      return str
+      str.gsub!(/!/, '%21') || str
+      str.gsub!(/'/, '%27') || str
+      str.gsub!(/\(/, '%28') || str
+      str.gsub!(/\)/, '%29') || str
+      str.gsub!(/\*/, '%2A') || str
+      str.gsub!(/~/, '%7E') || str
+
+      str
     end
   end
 end

data/lib/mediawiki/watch.rb

@@ -0,0 +1,52 @@
+module MediaWiki
+  module Watch
+    # Adds a page or an array of pages to the current user's watchlist.
+    # @param titles [Array<String>, String] An array of page titles, or a page title as a string.
+    # @return [Hash{String => Nil, Boolean}] Keys are page titles. Nil value means the page was missing, but it
+    #   was watched anyway. True means the page was watched and it exists. False means the page was not watched.
+    # @see https://www.mediawiki.org/wiki/API:Watch MediaWiki Watch API
+    def watch(titles)
+      watch_request(titles)
+    end
+
+    # Removes a page or an array of pages from the current user's watchlist.
+    # @param (see #watch)
+    # @return (see #watch)
+    # @see https://www.mediawiki.org/wiki/API:Watch MediaWiki Watch API
+    def unwatch(titles)
+      watch_request(titles, true)
+    end
+
+    private
+
+    # Submits a watch action request.
+    # @param (see #watch)
+    # @param unwatch [Boolean] Whether the request should unwatch the pages or not.
+    # @return (see #watch)
+    def watch_request(titles, unwatch = false)
+      titles = titles.is_a?(Array) ? titles : [titles]
+      params = {
+        action: 'watch',
+        titles: titles.shift(get_limited(titles.length, 50, 500)).join('|'),
+        token: get_token('watch')
+      }
+      success_key = 'watched'
+      if unwatch
+        params[:unwatch] = 1
+        success_key = 'unwatched'
+      end
+
+      response = post(params)
+      ret = {}
+      response['watch'].each do |entry|
+        title = entry['title']
+        if entry.key?(success_key)
+          ret[title] = entry.key?('missing') ? nil : true
+        else
+          ret[title] = false
+        end
+      end
+      ret
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mediawiki-butt
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Eli Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-02 00:00:00.000000000 Z
+date: 2016-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -72,6 +72,7 @@ files:
 - lib/mediawiki/query/properties/properties.rb
 - lib/mediawiki/query/query.rb
 - lib/mediawiki/utils.rb
+- lib/mediawiki/watch.rb
 homepage: https://github.com/ftb-gamepedia/mediawiki-butt-ruby
 licenses:
 - MIT
@@ -85,7 +86,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -93,8 +94,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Interacting with the MediaWiki API
 test_files: []
+has_rdoc: