rwikibot 1.0.4 → 1.0.5

data/CHANGELOG

@@ -1,5 +1,12 @@
 RWikiBot ChangeLog
 
+1.0.5
+	- Added parameters for queries to the rdoc - save MediaWiki some bandwidth
+	- Added BACKLINKS, PAGE_EXISTS?, EMBEDDED_IN, IMAGE_EMBEDDED_IN
+	- Fixed a bug in ALL_PAGES, where it wasn't really sending the options hash as part of the request. Oops. 
+	- Removed some debug puts
+	- Premiered the RWikiBot logo. Not in the source, but it exists now.
+	
 1.0.4
 	- Changed config.yaml to sample-config.yaml
 	- Had rake include the sample-config.yaml file

data/lib/rwikibot.rb

@@ -125,7 +125,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.
   # 
   # INPUT:: A hash of API-allowed keys and values. Default is same as API default.
-  #
+  # PARAMETERS:: letype (flt), lefrom (paging timestamp), leto (flt), ledirection (dflt=older), leuser (flt), letitle (flt), lelimit (dflt=10, max=500/5000)
   # OUTPUT:: An array of hashes.
   def recent_changes (options=nil)
     
@@ -133,7 +133,7 @@ class RWikiBot
     # TODO - Persistent timestamp storage
     
     @wikibotlogger.debug("RECENT CHANGES - Preparing request information...")
-    post_me = {"list" => "recentchanges"}
+    post_me = {"list" => "recentchanges", 'rclimit' => '5000'}
     if options != nil
       options.each do |key, value|
         post_me[key] = value
@@ -279,7 +279,7 @@ class RWikiBot
   # Also note that if the username the Bot uses is not of type Bot in the Wiki, you will be limited to 50 articles. Also log in, or you get an error.
   #
   # INPUT:: A hash of API-allowed keys and values. Default is same as API default.
-  # 
+  # PARAMETERS:: apfrom (paging), apnamespace (dflt=0), apredirect (flt), aplimit (dflt=10, max=500/5000)
   # OUTPUT:: An array of hashes with information about the pages. 
   def all_pages (options = nil)
     
@@ -287,10 +287,6 @@ class RWikiBot
     @wikibotlogger.debug "ALL PAGES - Preparing request information..."
     post_me = {'list' => 'allpages', 'apnamespace' => '0', 'aplimit' => '500'}
     
-    #make the request
-    @wikibotlogger.debug "ALL PAGES - Asking make_request to get all pages..."
-    allpages_result = make_request('query', post_me)
-    @wikibotlogger.debug "ALL PAGES - We should have a result now..."    
     
     if options != nil
       @wikibotlogger.debug("ALL PAGES - Additional options added by requestor. Adding to post_me...")
@@ -301,10 +297,108 @@ class RWikiBot
       @wikibotlogger.debug("ALL PAGES - No more additional options. Moving on...")
     end
     
+    #make the request
+    @wikibotlogger.debug "ALL PAGES - Asking make_request to get all pages..."
+    allpages_result = make_request('query', post_me)
+    @wikibotlogger.debug "ALL PAGES - We should have a result now..."
+    
     return allpages_result.fetch('allpages')
     
   end
+
+  # List
+  #
+  # This method fetches any article that links to the article given in 'title'. Returned in alphabetical order.
+  # 
+  # INPUT:: A normalized article title or titles (pipe delimited), and a hash of API-allowed keys and values. Default is same as API default.
+  # PARAMETERS:: blfrom (paging), blnamespace (flt), blredirect (flt), bllimit (dflt=10, max=500/5000)
+  # OUTPUT:: An array of hashes with backlinked articles. 
+  def backlinks (titles, options = nil)
+    
+    # This will get all pages. Limits vary based on user rights of the Bot. Set to bot.
+    @wikibotlogger.debug "BACKLINKS - Preparing request information..."
+    post_me = {'list' => 'backlinks', 'titles' => "#{title}" }
+     
+    
+    if options != nil
+      @wikibotlogger.debug("BACKLINKS - Additional options added by requestor. Adding to post_me...")
+      options.each_pair do |key, value|
+        post_me[key] = value
+        @wikibotlogger.debug "BACKLINKS - Added #{post_me[key]}"
+      end
+      @wikibotlogger.debug("BACKLINKS - No more additional options. Moving on...")
+    end
+    
+    #make the request
+    @wikibotlogger.debug "BACKLINKS - Asking make_request to get backlinks..."
+    backlinks_result = make_request('query', post_me)
+    @wikibotlogger.debug "BACKLINKS - We should have a result now..."
+    return backlinks_result.fetch('backlinks')
+    
+  end
   
+  # List
+  #
+  # This method pulls any page that includes the template requested. Please note - the template must be the full name, like "Template:Disputed" or "Template:Awesome". Just one, please.
+  # 
+  # INPUT:: A normalized template title, and a hash of API-allowed keys and values. Default is same as API default.
+  # PARAMETERS:: eifrom (paging), einamespace (flt), eiredirect (flt), eilimit (dflt=10, max=500/5000)
+  # OUTPUT:: An array of hashes with articles using said template. 
+  def embedded_in (title, options = nil)
+    
+    # This will get all pages. Limits vary based on user rights of the Bot. Set to bot.
+    @wikibotlogger.debug "EMBEDDED IN - Preparing request information..."
+    post_me = {'list' => 'embeddedin', 'titles' => "#{title}" }
+     
+    
+    if options != nil
+      @wikibotlogger.debug("EMBEDDED IN - Additional options added by requestor. Adding to post_me...")
+      options.each_pair do |key, value|
+        post_me[key] = value
+        @wikibotlogger.debug "EMBEDDED IN - Added #{post_me[key]}"
+      end
+      @wikibotlogger.debug("EMBEDDED IN - No more additional options. Moving on...")
+    end
+    
+    #make the request
+    @wikibotlogger.debug "EMBEDDED IN - Asking make_request to get backlinks..."
+    embeddedin_result = make_request('query', post_me)
+    @wikibotlogger.debug "EMBEDDED IN - We should have a result now..."
+    return embeddedin_result.fetch('embeddedin')
+    
+  end
+  
+  # List
+  #
+  # A whole lot like EMBEDDED_IN, except this bad boy has the job of handling Image: instead of Template:. I guess bots may want to watch images. Its really for completeness. But, people do do things with pictures. Maybe it handles Media: as well, but no promisesses.
+  # 
+  # INPUT:: A normalized image title, and a hash of API-allowed keys and values. Default is same as API default.
+  # PARAMETERS:: iefrom (paging), ienamespace (flt), ielimit (dflt=10, max=500/5000)
+  # OUTPUT:: An array of hashes with images page links
+  # def image_embedded_in (title, options = nil) :nodoc:
+  #   
+  #   # This will get all pages. Limits vary based on user rights of the Bot. Set to bot.
+  #   @wikibotlogger.debug "IMAGE EMBEDDED IN - Preparing request information..."
+  #   post_me = {'list' => 'embeddedin', 'titles' => "#{title}" }
+  #    
+  #   
+  #   if options != nil
+  #     @wikibotlogger.debug("IMAGE EMBEDDED IN - Additional options added by requestor. Adding to post_me...")
+  #     options.each_pair do |key, value|
+  #       post_me[key] = value
+  #       @wikibotlogger.debug "IMAGE EMBEDDED IN - Added #{post_me[key]}"
+  #     end
+  #     @wikibotlogger.debug("IMAGE EMBEDDED IN - No more additional options. Moving on...")
+  #   end
+  #   
+  #   #make the request
+  #   @wikibotlogger.debug "IMAGE EMBEDDED IN - Asking make_request to get backlinks..."
+  #   imageembeddedin_result = make_request('query', post_me)
+  #   @wikibotlogger.debug "IMAGE EMBEDDED IN - We should have a result now..."
+  #   return imageembeddedin_result.fetch('embeddedin')
+  #   
+  # end
+    
   # Prop = Info
   #
   # 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. 
@@ -433,6 +527,35 @@ class RWikiBot
     return array
   end
   
+  # This is a little something I cooked up because it seems like a totally logical thing for bots to want to do. Basically, you feed it a page title - any you want (that's the point) - and it returns TRUE or FALSE if the page exists inside the wiki. Technically, it pulls an attribute "missing", and in its presense, reports TRUE since the page is fake.
+  # That's something a bot would want to do, right?
+  #
+  # INPUT:: A title. Just one! 
+  #
+  # OUTPUT:: TRUE/FALSE, depending on which is correct
+  def page_exists? (title)
+    
+    # Prepare the request
+    @wikibotlogger.debug "PAGE EXISTS? - Preparing request information..."
+    post_me = {'titles' => title}
+    
+    #Make the request
+    @wikibotlogger.debug "PAGE EXISTS? - Asking make_request to verify page existence..."
+    page_exists_result = make_request('query', post_me)
+    @wikibotlogger.debug "PAGE EXISTS? - We should have a result now..."
+  
+    @wikibotlogger.debug "PAGE EXISTS? - Processing result..."
+    
+    
+    if page_exists_result.fetch('pages')[0].has_key?('missing')
+      @wikibotlogger.debug "PAGE EXISTS? - The page #{title} does NOT exist. Sorry."
+      return false
+    else
+      @wikibotlogger.debug "PAGE EXISTS? - The page #{title} DOES exist. You lucky, lucky bot."
+      return true
+    end
+    
+  end
   
   private 
   
@@ -445,6 +568,11 @@ class RWikiBot
       #Housekeeping. We need to add format and action to the request hash
       post_this['format'] = 'yaml'
       post_this['action'] = action
+      if @config.fetch('logged_in')
+        post_this['lgusername'] = @config.fetch('lgusername')
+        post_this['lgtoken'] = @config.fetch('lgtoken')
+        post_this['lguserid'] = @config.fetch('lguserid')
+      end
     
       #change - preparing a POST string instead of hash. 
       post_string = ''
@@ -456,7 +584,7 @@ class RWikiBot
     
       #Send the actual request    
       @wikibotlogger.debug "MAKE REQUEST - Sending request..."
-      resp = @http.post( @config.fetch('uri').path , post_string ,  {'User-agent' => 'RWikiBot/0.1','Cookie' => bake(@config.fetch('cookie')) } )
+      resp = @http.post( @config.fetch('uri').path , post_string ,  {'User-agent' => 'RWikiBot/0.1', 'Cookie' => bake(@config.fetch('cookie')) } ) #
       @wikibotlogger.info "MAKE REQUEST - Response: "
       @wikibotlogger.info resp.body
       @wikibotlogger.debug "MAKE REQUEST - End Response "
@@ -490,9 +618,6 @@ class RWikiBot
     
     # Make some dough. Let CGI parse set-cookie, since there's multiple set-cookies and this is hard
     dough = CGI::Cookie::parse(cookie) 
-    dough.each do |key, value|
-      puts "#{key} => #{value}"
-    end
     
     # Take the dough and get my three elements out
     

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rwikibot
 version: !ruby/object:Gem::Version 
-  version: 1.0.4
-date: 2007-03-01 00:00:00 -06:00
+  version: 1.0.5
+date: 2007-03-05 00:00:00 -06:00
 summary: A library for creating MediaWiki bots.
 require_paths: 
 - lib