wikibot 0.2.0 → 0.2.1.1

data/Manifest

@@ -6,4 +6,5 @@ lib/hash_ext.rb
 lib/openhash.rb
 lib/page.rb
 lib/wikibot.rb
+wikibot.gemspec
 Manifest

data/README.textile

@@ -4,14 +4,16 @@ h2. About
 
 WikiBot was originally a PHP-based framework for bots I run on Wikipedia, however when it broke due to changes in mediawiki code, I decided to rewrite it in Ruby, using the MediaWiki API instead of screen-scraping. This is the result.
 
-As you'll notice, the features it provides are rather sparse at the moment, as I've only been adding features that I require. When I get more time, I'll flesh it out more.
+As you'll notice, the features it provides are somewhat sparse at the moment, as I've only been adding features that I require. When I get more time, I'll flesh it out more.
 
 h2. Gem Requirements
 
 * "taf2-curb":taf2 (a fork of curb; using the base curb gem might work but is untested)
 * "xml-simple":xml
 * "deep_merge":dm
+* "andand":aa
 
 [taf2]http://github.com/taf2/curb/tree/master
 [xml]http://xml-simple.rubyforge.org/
 [dm]http://rubyforge.org/projects/deepmerge/
+[aa]http://andand.rubyforge.org/

data/Rakefile

@@ -2,14 +2,14 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('wikibot', '0.2.0') do |p|
+Echoe.new('wikibot', '0.2.1.1') do |p|
   p.description    = "Mediawiki Bot framework"
   p.url            = "http://github.com/dvandersluis/wiki_bot"
   p.author         = "Daniel Vandersluis"
   p.email          = "daniel@codexed.com"
   p.ignore_pattern = ["tmp/*", "script/*"]
   p.development_dependencies = []
-  p.runtime_dependencies = ['taf2-curb', 'xml-simple', 'deep_merge']
+  p.runtime_dependencies = ['taf2-curb >=0.5.4.0', 'xml-simple >=1.0.12', 'deep_merge >=0.1.0', 'andand >=1.3.1']
 end
 
 Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/category.rb

@@ -1,48 +1,54 @@
 module WikiBot
   class Category < Page
     def category_info
-      data = {
-        :action => :query,
-        :titles => @name,
-        :prop => :categoryinfo
-      }
+      @category_info ||= begin
+        data = {
+          :action => :query,
+          :titles => @name,
+          :prop => :categoryinfo
+        }
 
-      # The query API returns nothing for an empty cat, so we'll return a hash with all the normal
-      # properties set to 0 instead
-      empty_cat = { "pages" => 0, "size" => 0, "files" => 0, "subcats" => 0, "hidden" => "" }
-      @wiki_bot.query_api(:get, data).query.pages.page.categoryinfo || empty_cat
+        # The query API returns nothing for an empty cat, so we'll return a hash with all the normal
+        # properties set to 0 instead
+        empty_cat = { :pages => 0, :size => 0, :files => 0, :subcats => 0, :hidden => "" }.to_openhash
+        @wiki_bot.query_api(:get, data).query.pages.page.categoryinfo || empty_cat
+      end
     end
 
     def members(sort = :sortkey, dir = :desc, namespace = nil)
-      data = {
-        :action => :query,
-        :list => :categorymembers,
-        :cmtitle => @name,
-        :cmsort => sort,
-        :cmdir => dir,
-        :cmnamespace => namespace
-      }
+      @members ||= begin
+        data = {
+          :action => :query,
+          :list => :categorymembers,
+          :cmtitle => @name,
+          :cmsort => sort,
+          :cmdir => dir,
+          :cmnamespace => namespace
+        }
 
-      @wiki_bot.query_api(:get, data).query.categorymembers.cm
+        @wiki_bot.query_api(:get, data).query.categorymembers.cm.map { |m| Page.new(@wiki_bot, m["title"]) }
+      end
     end
 
     # Returns a hash of how many pages live in a category
     def count(include_subcats = false)
-      out = {}
-      ci = category_info
+      @count ||= begin
+        out = {}
+        ci = category_info
 
-      out[@name] = {
-        :pages => ci.pages.to_i
-      }
+        out[@name] = {
+          :pages => ci.pages.to_i
+        }
 
-      if include_subcats and ci.subcats.to_i > 0
-        out[@name][:subcats] = {}
-        members.each do |m|
-          out[@name][:subcats].merge! WikiPage.new(@wiki_bot, m.title).count(include_subcats)
+        if include_subcats and ci.subcats.to_i > 0
+          out[@name][:subcats] = {}
+          members.each do |m|
+            out[@name][:subcats].merge! self.class.new(@wiki_bot, m["title"]).count(include_subcats)
+          end
         end
-      end
 
-      out
+        out
+      end
     end
   end
 end

data/lib/hash_ext.rb

@@ -14,4 +14,8 @@ class Hash
       memo.push "#{CGI::escape(key.to_s)}=#{CGI::escape(val.to_s)}"
     end.join("&")
   end
+
+  def to_openhash
+    OpenHash.new(self)
+  end
 end

data/lib/openhash.rb

@@ -14,10 +14,14 @@ class OpenHash < Hash
   # Allow hash properties to be referenced by dot notation
   def method_missing(name, *args)
     name = name.to_s
-    if self.include? name
-      self[name]
-    elsif self.include? name.to_sym
-      self[name.to_sym]
+    k = name.sub(/[?!=]$/, '')
+
+    if name =~ /=$/ && !args.empty?
+      self[k] = args.first
+    elsif self.include? k
+      self[k]
+    elsif self.include? k.to_sym
+      self[k.to_sym]
     end
   end
 end

data/lib/page.rb

@@ -1,3 +1,6 @@
+require 'rubygems'
+require 'andand'
+
 module WikiBot
   class Page
     class WriteError < StandardError; end
@@ -12,7 +15,8 @@ module WikiBot
 
     ###
     # Read from page
-    def content
+    def content(reload = false)
+      @content = nil if reload
       @content ||= begin
         data = {
           :action => :query,
@@ -26,7 +30,8 @@ module WikiBot
     end
 
     # Parse page content
-    def text
+    def text(reload = false)
+      @text = nil if reload
       @text ||= begin
         data = {
           :action => :parse,
@@ -42,7 +47,8 @@ module WikiBot
     def categories(show = :all)
       # Cache hidden and non-hidden categories separately
       @categories ||= begin
-        puts "Loading category data"
+        @category_names = nil # Reset @category_names
+
         data = {
           :action => :query,
           :titles => @name,
@@ -50,9 +56,10 @@ module WikiBot
           :clshow => "!hidden"
         }
 
-        categories = @wiki_bot.query_api(:get, data).query.pages.page.categories.cl
+        categories = @wiki_bot.query_api(:get, data).query.pages.page.categories.andand.cl || []
+
         categories = categories.inject([]) do |memo, category|
-          memo.push(WikiBot::Category.new(@wiki_bot, category.title))
+          memo.push(WikiBot::Category.new(@wiki_bot, category["title"]))
         end
         
         data = {
@@ -62,9 +69,9 @@ module WikiBot
           :clshow => "hidden"
         }
 
-        hidden_categories = @wiki_bot.query_api(:get, data).query.pages.page.categories.cl
+        hidden_categories = @wiki_bot.query_api(:get, data).query.pages.page.categories.andand.cl || []
         hidden_categories = hidden_categories.inject([]) do |memo, category|
-          memo.push(WikiBot::Category.new(@wiki_bot, category.title))
+          memo.push(WikiBot::Category.new(@wiki_bot, category["title"]))
         end
 
         {:nonhidden => categories, :hidden => hidden_categories}
@@ -76,7 +83,7 @@ module WikiBot
     end
 
     def category_names(show = :all)
-      categories(show).map{ |c| c.name }
+      @category_names ||= categories(show).map{ |c| c.name }
     end
 
     ###

data/lib/wikibot.rb

@@ -28,20 +28,19 @@ module WikiBot
   class Bot
     class LoginError < StandardError; end
 
-    @@version = "0.2.0"       # WikiBot version
+    @@version = "0.2.1"       # WikiBot version
 
     cattr_reader :version
-    cattr_accessor :cookiejar # Filename where cookies will be stored
+    #cattr_accessor :cookiejar # Filename where cookies will be stored
 
     attr_reader :config
-    attr_reader :api_hits
-    attr_accessor :page_writes
-    attr_accessor :debug      # In debug mode, no writes will be made to the wiki
-    attr_accessor :readonly   # Writes will not be made
+    attr_reader :api_hits       # How many times the API was queried
+    attr_accessor :page_writes  # How many write operations were performed
+    attr_accessor :debug        # In debug mode, no writes will be made to the wiki
+    attr_accessor :readonly     # Writes will not be made
 
     def initialize(username, password, options = {})
-      @config = Hash.new
-      @cookies = Hash.new
+      @cookies = OpenHash.new
       @api_hits = 0
       @page_writes = 0
 
@@ -55,11 +54,11 @@ module WikiBot
         :password   => password,
         :api        => api,
         :logged_in  => false
-      }
+      }.to_openhash
 
       # Set up cURL:
       @curl = Curl::Easy.new do |c|
-        c.headers["User-Agent"] = "Mozilla/5.0 Curb/Taf2/0.2.8 WikiBot/#{config[:username]}/#{@@version}"
+        c.headers["User-Agent"] = "Mozilla/5.0 Curb/Taf2/0.2.8 WikiBot/#{@config.username}/#{@@version}"
         #c.enable_cookies        = true
         #c.cookiejar             = @@cookiejar
        end
@@ -68,10 +67,13 @@ module WikiBot
     end
 
     def query_api(method, raw_data = {})
-      url = @config[:api]
+      # Send a query to the API and handle the response
+      url = @config.api
+      raw_data = raw_data.to_openhash
 
-      raw_data[:format] = :xml if !(raw_data.include? :format and raw_data.include? 'format')
+      raw_data[:format] = :xml if raw_data.format.nil?
 
+      # Setup cookie headers for the request
       @curl.headers["Cookie"] = @cookies.inject([]) do |memo, pair|
         key, val = pair
         memo.push(CGI::escape(key) + "=" + CGI::escape(val))
@@ -107,11 +109,9 @@ module WikiBot
           data.length
         end
 
-        if data.nil? or (data.is_a? Array and data.empty?)
-          @curl.send("http_#{method}".to_sym)
-        else
-          @curl.send("http_#{method}".to_sym, *data)
-        end
+        params = ["http_#{method}".to_sym]
+        params.push(*data) unless data.nil? or (data.is_a? Array and data.empty?)
+        @curl.send(*params)
         @api_hits += 1
 
         raise CurbError.new(@curl) unless @curl.response_code == 200
@@ -127,16 +127,20 @@ module WikiBot
         end
       end
 
-      OpenHash.new(response_xml)
+      response_xml.to_openhash
     end
     
+    def logged_in?
+      @config.logged_in 
+    end
+
     def login
-      return if @config[:logged_in]
+      return if logged_in?
 
       data = {
         :action     => :login, 
-        :lgname     => @config[:username],
-        :lgpassword => @config[:password]
+        :lgname     => @config.username,
+        :lgpassword => @config.password
       }
 
       response = query_api(:post, data).login
@@ -144,8 +148,8 @@ module WikiBot
       if response.result == "NeedToken"
         data = {
           :action     => :login, 
-          :lgname     => @config[:username],
-          :lgpassword => @config[:password],
+          :lgname     => @config.username,
+          :lgpassword => @config.password,
           :lgtoken    => response.token
         }
 
@@ -154,20 +158,21 @@ module WikiBot
 
       raise LoginError, response.result unless response.result == "Success"
 
-      @config[:cookieprefix] = response.cookieprefix 
-      @config[:logged_in] = true
+      @config.cookieprefix = response.cookieprefix 
+      @config.logged_in = true
     end
 
     def logout
-      return if !@config[:logged_in]
+      return unless logged_in?
 
       query_api(:post, { :action => :logout })
-      @config[:logged_in] = false
-      @config[:edit_token] = nil
+      @config.logged_in = false
+      @config.edit_token = nil
     end
 
     def edit_token(page = "Main Page")
-      @config[:edit_token] ||= begin
+      return nil unless logged_in?
+      @config.edit_token ||= begin
         data = {
           :action     => :query, 
           :prop       => :info,

data/wikibot.gemspec

@@ -2,20 +2,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wikibot}
-  s.version = "0.2.0"
+  s.version = "0.2.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Daniel Vandersluis"]
-  s.date = %q{2010-04-09}
+  s.date = %q{2010-07-29}
   s.description = %q{Mediawiki Bot framework}
   s.email = %q{daniel@codexed.com}
   s.extra_rdoc_files = ["README.textile", "lib/category.rb", "lib/class_ext.rb", "lib/hash_ext.rb", "lib/openhash.rb", "lib/page.rb", "lib/wikibot.rb"]
-  s.files = ["README.textile", "Rakefile", "lib/category.rb", "lib/class_ext.rb", "lib/hash_ext.rb", "lib/openhash.rb", "lib/page.rb", "lib/wikibot.rb", "Manifest", "wikibot.gemspec"]
+  s.files = ["README.textile", "Rakefile", "lib/category.rb", "lib/class_ext.rb", "lib/hash_ext.rb", "lib/openhash.rb", "lib/page.rb", "lib/wikibot.rb", "wikibot.gemspec", "Manifest"]
   s.homepage = %q{http://github.com/dvandersluis/wiki_bot}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Wikibot", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{wikibot}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{Mediawiki Bot framework}
 
   if s.respond_to? :specification_version then
@@ -23,17 +23,20 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<taf2-curb>, [">= 0"])
-      s.add_runtime_dependency(%q<xml-simple>, [">= 0"])
-      s.add_runtime_dependency(%q<deep_merge>, [">= 0"])
+      s.add_runtime_dependency(%q<taf2-curb>, [">= 0.5.4.0"])
+      s.add_runtime_dependency(%q<xml-simple>, [">= 1.0.12"])
+      s.add_runtime_dependency(%q<deep_merge>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<andand>, [">= 1.3.1"])
     else
-      s.add_dependency(%q<taf2-curb>, [">= 0"])
-      s.add_dependency(%q<xml-simple>, [">= 0"])
-      s.add_dependency(%q<deep_merge>, [">= 0"])
+      s.add_dependency(%q<taf2-curb>, [">= 0.5.4.0"])
+      s.add_dependency(%q<xml-simple>, [">= 1.0.12"])
+      s.add_dependency(%q<deep_merge>, [">= 0.1.0"])
+      s.add_dependency(%q<andand>, [">= 1.3.1"])
     end
   else
-    s.add_dependency(%q<taf2-curb>, [">= 0"])
-    s.add_dependency(%q<xml-simple>, [">= 0"])
-    s.add_dependency(%q<deep_merge>, [">= 0"])
+    s.add_dependency(%q<taf2-curb>, [">= 0.5.4.0"])
+    s.add_dependency(%q<xml-simple>, [">= 1.0.12"])
+    s.add_dependency(%q<deep_merge>, [">= 0.1.0"])
+    s.add_dependency(%q<andand>, [">= 1.3.1"])
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wikibot
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  - 1
+  version: 0.2.1.1
 platform: ruby
 authors: 
 - Daniel Vandersluis
@@ -9,39 +15,66 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 -06:00
+date: 2010-07-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: taf2-curb
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        segments: 
+        - 0
+        - 5
+        - 4
+        - 0
+        version: 0.5.4.0
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: xml-simple
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        segments: 
+        - 1
+        - 0
+        - 12
+        version: 1.0.12
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: deep_merge
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: andand
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :runtime
+  version_requirements: *id004
 description: Mediawiki Bot framework
 email: daniel@codexed.com
 executables: []
@@ -65,8 +98,8 @@ files:
 - lib/openhash.rb
 - lib/page.rb
 - lib/wikibot.rb
-- Manifest
 - wikibot.gemspec
+- Manifest
 has_rdoc: true
 homepage: http://github.com/dvandersluis/wiki_bot
 licenses: []
@@ -85,18 +118,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: wikibot
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Mediawiki Bot framework