eddieroger-rwikibot 2.0.3 → 2.0.4

data/CHANGELOG

@@ -1,5 +1,16 @@
 RWikiBot ChangeLog  
 
+2.0.4
+	- I get it - I just suck at keeping versions consistent. And Github requires incremental gemspecs.
+
+2.0.3
+	- Removed an extra puts. Oops.
+	- Added Page::protect
+	- Reimplemented meets_version_requirement and references to it
+	
+2.0.2
+	- Random little changes. Forgot to document. Sorry. 
+	
 2.0.1 
 	- Changing gemspec so MAYBE it will be included in github gems.
 

data/lib/pages.rb

@@ -12,7 +12,7 @@ module Pages
     # Creates a new Page object.
     def initialize(bot, title='')
       @bot = bot
-      puts @bot.config
+      #puts @bot.config
       
       info = info(title)
       @title      = info['title']
@@ -95,6 +95,8 @@ module Pages
     # I decided to split this up since I wanted to normalize the bot framework as much as possible, or in other words, make it as easy to use as possible. I think the sacrifice of more methods is worth having more English looking code. Its the Ruby way.
     # Info will return information about the page, from namespace to normalized title, last touched, etc.
     def info(titles)
+      raise RWBErrors::VersionTooLowError unless @bot.meets_version_requirement(1,9)
+      
       post_me = {"prop" => "info", 'titles' => titles}
       info_result = @bot.make_request('query', post_me)
       info_result.fetch('pages').fetch('page')
@@ -118,12 +120,34 @@ module Pages
       post_me['noredirect'] = '' if noredirect
 
       @bot.make_request('move', post_me)
-    end
+    end # move
+    
+    # This method is used to protect (and unprotect!) pages. See the API for 
+    # possible values. By default, it will lock a page to require sysop level 
+    # privledge and never expire. 
+    def protect(protections='edit=sysop', expiry='infinite', reason='', cascade=true)
+      raise RWBErrors::VersionTooLowError unless @bot.meets_version_requirement(1,12)
+      raise RWBErrors::NotLoggedInError unless @bot.logged_in?
+
+      post_me = {
+        'title'         => @title ,
+        'token'         => get_token('protect') ,
+        'protections'   => protections ,
+        'expiry'        => expiry ,
+        'reason'        => reason ,
+      }
+      
+      post_me['cascade'] = '' if cascade
+      @bot.make_request('protect', post_me)
+    end # protect
 
     # Rollback does what it says - rolls back an article one version in the
     # wiki. This is a function that requires not only a token, but a previous
     # user.
     def rollback(summary="", markbot=true)
+      raise RWBErrors::VersionTooLowError unless @bot.meets_version_requirement(1,12)
+      raise RWBErrors::NotLoggedInError unless @bot.logged_in?
+
       temp_token = get_token("rollback") # special for rollback. Stupid rollback.
       post_me = {
         'title'     => @title,
@@ -140,6 +164,8 @@ module Pages
     # sure you're logged in and got a token (get_token). Options is an array
     # (or hash) of extra values allowed by the API.
     def save(content, summary=nil, options=nil)
+      raise RWBErrors::VersionTooLowError unless @bot.meets_version_requirement(1,13)
+      raise RWBErrors::NotLoggedInError unless @bot.logged_in?
 
       post_me = {
         'text'     => "#{content}" ,

data/lib/rwikibot.rb

@@ -58,7 +58,7 @@ class RWikiBot
   # always necessary, but bots need to log in to save changes or retrieve
   # watchlists.
   def login
-    # raise VersionTooLowError unless meets_version_requirement(0,0)
+    raise VersionTooLowError unless meets_version_requirement(0,0)
 
     post_me = {'lgname'=>@config.fetch('username'),'lgpassword'=>@config.fetch('password')}
     if @config.has_key?('domain') && (@config.fetch('domain') != nil)
@@ -99,7 +99,7 @@ class RWikiBot
   # elsewhere. Accepts all parameters from the API in Hash form. Default is
   # namespace => 0, which is just plain pages. Nothing 'special'.
   def all_pages(options = nil)
-    # raise VersionTooLowError unless meets_version_requirement(1,9) 
+    raise VersionTooLowError unless meets_version_requirement(1,9) 
     # This will get all pages. Limits vary based on user rights of the Bot. Set to bot.
     post_me = {'list' => 'allpages', 'apnamespace' => '0', 'aplimit' => '5000'}
     post_me.merge!(options) if options
@@ -112,7 +112,7 @@ class RWikiBot
   # pages, and would require the bot maintainer to login to the wiki as the
   # bot to set the watchlist.
   def watchlist(options=nil)
-    # raise VersionTooLowError unless meets_version_requirement(1,10)
+    raise VersionTooLowError unless meets_version_requirement(1,10)
     raise NotLoggedInError unless logged_in?
     post_me = {'list'=>'watchlist'}
     post_me.merge!(options) if options
@@ -121,7 +121,7 @@ class RWikiBot
 
   # This method will return Wiki-wide recent changes, almost as if looking at the Special page Recent Changes. But, in this format, a bot can handle it. Also we're using the API. And bots can't read.
   def recent_changes(options=nil)
-    # raise VersionTooLowError unless meets_version_requirement(1,10)
+    raise VersionTooLowError unless meets_version_requirement(1,10)
     post_me = {"list" => "recentchanges", 'rclimit' => '5000'}
     post_me.merge!(options) if options
     make_request('query' , post_me).fetch('recentchanges').fetch('rc')
@@ -131,7 +131,7 @@ class RWikiBot
   # want to validate log events, or even just a notify bot that checks for
   # events and sends them off.
   def log_events(options=nil)
-    # raise VersionTooLowError unless meets_version_requirement(1,11)
+    raise VersionTooLowError unless meets_version_requirement(1,11)
     post_me = {"list" => "logevents"}
     post_me.merge!(options) if options
     make_request('query', post_me).fetch('logevents').fetch('item')
@@ -140,7 +140,7 @@ class RWikiBot
   # This is the only meta method. It will return site information. I chose not
   # to allow it to specify, and it will only return all known properties.
   def site_info(siprop='general')
-    # raise VersionTooLowError unless meets_version_requirement(1,9)
+    raise VersionTooLowError unless meets_version_requirement(1,9)
     post_me = {"meta" => "siteinfo" , "siprop" => siprop}
     siteinfo_result = make_request('query', post_me)
     siprop == 'general' ?
@@ -150,7 +150,7 @@ class RWikiBot
 
   # Get information about the current user
   def user_info(uiprop=nil)
-    # raise VersionTooLowError unless meets_version_requirement(1,11)
+    raise VersionTooLowError unless meets_version_requirement(1,11)
     post_me = {"meta" => "userinfo" }
     post_me['uiprop'] =  uiprop unless uiprop.nil?
 

data/lib/utilities.rb

@@ -1,8 +1,16 @@
 module RWBUtilities
 
 
-  # is_redirect?
-  #
+  def meets_version_requirement(maj, min)
+    major, minor = @config['api_version'].to_s.split('.')
+    puts "#{major} > #{maj}"
+    if ( major.to_i > maj.to_i ) || ( (major.to_i == maj.to_i) && (minor.to_i > min.to_i) )
+      return true
+    else 
+      return false
+    end
+  end # meets_version_requirement
+
   # Tests to see if a given page title is redirected to another page. Very Ruby.
   def is_redirect?(title)
     post_me = {'titles' => title, 'redirects'=>'', 'prop' => 'info'}
@@ -10,8 +18,6 @@ module RWBUtilities
     (result['result'] == "Success") && result.has_key?("redirects")
   end
 
-  # logged_in?
-  #
   # A quick (and public) method of checking whether or not we're logged in, since I don't want @config exposed
   def logged_in?
     @config['logged_in']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: eddieroger-rwikibot
 version: !ruby/object:Gem::Version 
-  version: 2.0.3
+  version: 2.0.4
 platform: ruby
 authors: 
 - Eddie Roger