rwikibot 1.0.0 → 1.0.1

data/CHANGELOG

@@ -0,0 +1,10 @@
+RWikiBot ChangeLog
+
+1.0.1
+	- Added very basic error handing around the MAKE_REQUEST method since MediaWiki returns invalid YAML 
+	- Fixed login method to accept domain value
+	- Check for domain being present and set in config.yaml
+	- Added redirect? method to return true/false if title is a redirect page
+	- Changed from "framework" to "library"
+
+1.0.0 - Initial Version

data/lib/rwikibot.rb

@@ -65,6 +65,9 @@ class RWikiBot
     
     @wikibotlogger.debug("LOGIN - Preparing login information...")
     post_me = {'lgname'=>@config.fetch('username'),'lgpassword'=>@config.fetch('password')}
+    if @config.has_key?('domain') && (@config.fetch('domain') != nil)
+      post_me['lgdomain'] = @config.fetch('domain')
+    end
     
     @wikibotlogger.debug("LOGIN - Asking make_request to perform login...")
     login_result = make_request('login', post_me)
@@ -221,6 +224,31 @@ class RWikiBot
   end
   
   
+  # Query
+  #
+  # This is a lot like REDIRECTS method, except its just a true/false to validate whether or not an article is a redirect. We could write the logic into the final bot app, but we're awesome and we include a quicky method.
+  #
+  # INPUT:: Title (please, just one!)
+  # OUTPUT:: True/False
+  def redirect? (title)
+    
+    # Prepare the request
+    @wikibotlogger.debug "REDIRECT? - Preparing request information..."
+    post_me = {'titles' => title, 'redirects'=>'', 'prop' => 'info'}
+    
+    
+    #Make the request
+    @wikibotlogger.debug "REDIRECT? - Asking make_request find redirects..."
+    redirects_result = make_request('query', post_me)
+    @wikibotlogger.debug "REDIRECT? - We should have a result now..."
+  
+    @wikibotlogger.debug "REDIRECT? - Processing result..."
+    
+    
+    return redirects_result.has_key?('redirects')
+    
+  end
+  
   
   # Query
   #
@@ -412,41 +440,51 @@ class RWikiBot
   
   # Make Request is a method that actually handles making the request to the API. Since the API is somewhat standardized, this method is able to accept the action and a hash of variables, and it handles all the fun things MediaWiki likes to be weird over, like cookies and limits and actions. Its very solid, but I didn't want it public because it also does some post processing, and that's not very OO. 
   def make_request (action, post_this)
-      
-    #Housekeeping. We need to add format and action to the request hash
-    post_this['format'] = 'yaml'
-    post_this['action'] = action
-    
-    #change - preparing a POST string instead of hash. 
-    post_string = ''
-    post_this.each_pair do |key, value|
-      post_string << "#{key}=#{value}&"
-    end
-    @wikibotlogger.info("MAKE REQUEST - Post String is: #{post_string}")
-    @wikibotlogger.debug "MAKE REQUEST - Sending request to: #{@config.fetch('uri')}"
-    
-    #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'))})
-    @wikibotlogger.info "MAKE REQUEST - Response: "
-    @wikibotlogger.info resp.body
-    @wikibotlogger.debug "MAKE REQUEST - End Response "
-    result = YAML.load(resp.body)
-    
-    #Process response
-    @wikibotlogger.debug "MAKE REQUEST - Response received. Processing..."
-    return_result = result.fetch(action)
-    
-    # A small check to make sure we don't need to save cookie data. Because usually, we don't
-    if @config.fetch('logged_in') == FALSE
-      @config['cookie'] = resp.header['set-cookie']
-      @wikibotlogger.debug "MAKE REQUEST - Received login cookie. Cookie is: #{resp.header['set-cookie']}"
-    end
     
-    #Return the response
-    @wikibotlogger.debug "MAKE REQUEST - Response cleaned. Returning result."
-    return return_result
+    # Now, we do error handling. We're big like that.
+    begin
+     
+      #Housekeeping. We need to add format and action to the request hash
+      post_this['format'] = 'yaml'
+      post_this['action'] = action
+    
+      #change - preparing a POST string instead of hash. 
+      post_string = ''
+      post_this.each_pair do |key, value|
+        post_string << "#{key}=#{value}&"
+      end
+      @wikibotlogger.info("MAKE REQUEST - Post String is: #{post_string}")
+      @wikibotlogger.debug "MAKE REQUEST - Sending request to: #{@config.fetch('uri')}"
+    
+      #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'))})
+      @wikibotlogger.info "MAKE REQUEST - Response: "
+      @wikibotlogger.info resp.body
+      @wikibotlogger.debug "MAKE REQUEST - End Response "
+      result = YAML.load(resp.body)
+    
+      #Process response
+      @wikibotlogger.debug "MAKE REQUEST - Response received. Processing..."
+      return_result = result.fetch(action)
+    
+      # A small check to make sure we don't need to save cookie data. Because usually, we don't
+      if @config.fetch('logged_in') == FALSE
+        @config['cookie'] = resp.header['set-cookie']
+        @wikibotlogger.debug "MAKE REQUEST - Received login cookie. Cookie is: #{resp.header['set-cookie']}"
+      end
+    
+      #Return the response
+      @wikibotlogger.debug "MAKE REQUEST - Response cleaned. Returning result."
+      return return_result
     
+    # The short form is that the API's error message causes an ArgumentError, so we gotta handle that. I notified  MediaWiki
+    rescue ArgumentError
+      @wikibotlogger.error "MAKE REQUEST - The request has failed."
+      @wikibotlogger.error "MAKE REQUEST - Error is: #{$!}"
+      
+      raise ArgumentError, "Problem processing returned YAML result"
+    end
   end
   
   # For some odd reason, MediaWiki sends back three cookies the first time you establis a session. For some even more odd, Net::HTTP doesn't treat the set-cookie headers individually the way that normal borowsers do. So, I have this processing method to handle cookie logic - when to send, when to set, etc. And it bakes cookies. Get it? Bake.

metadata

@@ -3,9 +3,9 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: rwikibot
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
-date: 2007-02-25 00:00:00 -06:00
-summary: A framework for creating MediaWiki bots.
+  version: 1.0.1
+date: 2007-02-26 00:00:00 -06:00
+summary: A library for creating MediaWiki bots.
 require_paths: 
 - lib
 email: eddieroger @nospam@ gmail.com
@@ -30,14 +30,14 @@ authors:
 files: 
 - lib/rwikibot.rb
 - README
-- config.yaml
+- CHANGELOG
 test_files: []
 
 rdoc_options: 
 - --inline-source
 extra_rdoc_files: 
 - README
-- config.yaml
+- CHANGELOG
 executables: []
 
 extensions: []

data/config.yaml

@@ -1,5 +0,0 @@
-:source:use: 'default'
-:source:default:
-    username: "RWikiBot"
-    password: "rwikibot"
-    api_path: "http://localhost:8888/wiki/api.php"