sunflower 0.2 → 0.3

data/lib/sunflower/commontasks.rb

@@ -101,7 +101,7 @@ class Page
 	
 	def code_cleanup
 	# simple, safe code cleanup
-	# use $alwaysDoCodeCleanup=true to do it automatically just before saving page
+	# use Sunflower.always_do_code_cleanup=true to do it automatically just before saving page
 	# based on Nux's cleaner: http://pl.wikipedia.org/wiki/Wikipedysta:Nux/wp_sk.js
 		str=self.text.gsub(/\r\n/,"\n")
 		

data/lib/sunflower/core.rb

@@ -12,18 +12,31 @@ require 'cgi'
 #   s = Sunflower.new.login
 #
 # Then you can request data from API using #API method.
-# To log data to file, use #log method (works like puts, append new line if needed) of #log2 (like print).
+#
+# To log data to file, use #log method (works like puts). Use RestClient.log=<io> to log all requests.
+#
 # You can use multiple Sunflowers at once, to work on multiple wikis.
+
+class SunflowerError < StandardError; end
+
 class Sunflower
+	VERSION = '0.3'
+	
+	INVALID_CHARS = %w(# < > [ ] | { })
+	INVALID_CHARS_REGEX = Regexp.union *INVALID_CHARS
+	
 	# Path to user data file.
 	def self.path
 		File.join(ENV['HOME'], 'sunflower-userdata')
 	end
 
+	# Options for this Sunflower.
+	attr_accessor :summary, :always_do_code_cleanup
+	
 	attr_accessor :cookie, :headers, :wikiURL, :warnings, :log
 	
 	# Initialize a new Sunflower working on a wiki with given URL, for ex. "pl.wikipedia.org".
-	def initialize url=''
+	def initialize url=nil
 		begin
 			r=File.read(Sunflower.path)
 			@userdata=r.split(/\r?\n/).map{|i| i.strip}
@@ -31,30 +44,34 @@ class Sunflower
 			@userdata=[]
 		end
 		
-		if url==''
+		if !url
 			if !@userdata.empty?
 				url=@userdata[0]
 			else
-				raise RuntimeError, 'Sunflower - initialize: no URL supplied and no userdata found!'
+				raise SunflowerError, 'initialize: no URL supplied and no userdata found!'
 			end
 		end
 		
 		@warnings=true
-		@log=true
+		@log=false
 		
 		@wikiURL=url
-		@logData=''
 		
 		@loggedin=false
 	end
 	
-	# Call the API. Returns a hash of JSON response.
+	# Call the API. Returns a hash of JSON response. Request can be a HTTP request string or a hash.
 	def API request
-		#$stderr.puts 'Warning: Sunflower: API request before logging in! ('+request+')' unless @loggedin || !@warnings
-		self.log 'http://'+@wikiURL+'/w/api.php?'+request+'&format=jsonfm'
-		resp = RestClient.get(
-			'http://'+@wikiURL+'/w/api.php?'+request+'&format=json',
-			{:user_agent => 'Sunflower alpha', :cookies => @cookies}
+		if request.is_a? String
+			request += '&format=json'
+		elsif request.is_a? Hash
+			request.merge!({format:'json'})
+		end
+		
+		resp = RestClient.post(
+			'http://'+@wikiURL+'/w/api.php',
+			request,
+			{:user_agent => "Sunflower #{VERSION} alpha", :cookies => @cookies}
 		)
 		JSON.parse resp.to_str
 	end
@@ -66,13 +83,11 @@ class Sunflower
 				user=@userdata[1] if user==''
 				password=@userdata[2] if password==''
 			else
-				raise RuntimeError, 'Sunflower - login: no user/pass supplied and no userdata found!'
+				raise SunflowerError, 'login: no user/pass supplied and no userdata found!'
 			end
 		end
 		
-		if user.index(/[#<>\[\]\|\{\}]/)
-			raise RuntimeError, 'Sunflower - bad username!'
-		end
+		raise SunflowerError, 'bad username!' if user =~ INVALID_CHARS_REGEX
 		
 		
 		# 1. get the login token
@@ -103,55 +118,52 @@ class Sunflower
 		})
 		
 		
-		raise RuntimeError, 'Sunflower - unable to log in (no cookies received)!' if !@cookies
+		raise SunflowerError, 'unable to log in (no cookies received)!' if !@cookies
 		
 		
-		@loggedin=true		
+		# 3. confirm you did log in by checking the watchlist.
+		@loggedin=true
 		r=self.API('action=query&list=watchlistraw')
 		if r['error'] && r['error']['code']=='wrnotloggedin'
 			@loggedin=false
-			raise RuntimeError, 'Sunflower - unable to log in!'
+			raise SunflowerError, 'unable to log in!'
 		end
 		
+		# 4. check bot rights
 		r=self.API('action=query&list=allusers&aulimit=1&augroup=bot&aufrom='+user)
 		unless r['query']['allusers'][0]['name']==user
-			$stderr.puts 'Warning: Sunflower - this user does not have bot rights!' if @warnings
-			@haveBotRights=false
+			warn 'Sunflower - this user does not have bot rights!' if @warnings
+			@is_bot=false
 		else
-			@haveBotRights=true
+			@is_bot=true
 		end
 		
 		return self
 	end
 	
-	def log2(t)
-		@logData+=t
-		if @log
-			f=File.open('log.txt','a')
-			f.write t
-			f.close
-		end
+	def log t
+		File.open('log.txt','a'){|f| f.puts t}
 	end
 	
-	def log(t)
-		self.log2(t.to_s.chomp+"\n")
-	end
-	
-	def isBot?
-		@haveBotRights
+	def is_bot?
+		@is_bot
 	end
 end
 
 # Class representng single Wiki page. To load specified page, use #new/#get/#load method.
 #
+# When calling Page.new, at first only the text will be loaded - attributes and edit token will be loaded when needed, or when you call #preload_attrs.
+#
 # If you are using multiple Sunflowers, you have to specify which wiki this page belongs to using second argument of function; you can pass whole URL (same as when creating new Sunflower) or just language code.
 #
-# To save page, use #save/#put method. Optional argument is new title page, if ommited, page is saved at old title. Summary can be passed as second parameter. If it's ommited, global variable $summary is used. If it's empty too, error is raised.
+# To save page, use #save/#put method. Optional argument is new title page, if ommited, page is saved at old title. Summary can be passed as second parameter. If it's ommited, s.summary is used. If it's empty too, error is raised.
 #
 # To get Sunflower instance which this page belongs to, use #sunflower of #belongs_to.
 class Page
-	attr_accessor :text
+	INVALID_CHARS = %w(# < > [ ] | { })
+	INVALID_CHARS_REGEX = Regexp.union *INVALID_CHARS
 	
+	attr_accessor :text
 	attr_reader :orig_text
 	
 	attr_reader :sunflower
@@ -159,8 +171,16 @@ class Page
 	
 	attr_reader :pageid, :ns, :title, :touched, :lastrevid, :counter, :length, :starttimestamp, :edittoken, :protection #prop=info
 	
+	# calling any of these accessors will fetch the data.
+	[:pageid, :ns, :title, :touched, :lastrevid, :counter, :length, :starttimestamp, :edittoken, :protection].each do |meth|
+		define_method meth do
+			preload_attrs unless @preloaded_attrs
+			instance_variable_get "@#{meth}"
+		end
+	end
+	
 	def initialize title='', wiki=''
-		raise RuntimeError, 'Sunflower - title invalid: '+title if title.index(/[#<>\[\]\|\{\}]/)
+		raise SunflowerError, 'title invalid: '+title if title =~ INVALID_CHARS_REGEX
 		
 		@modulesExecd=[] #used by sunflower-commontasks.rb
 		@summaryAppend=[] #used by sunflower-commontasks.rb
@@ -170,7 +190,7 @@ class Page
 		
 		if wiki=='' 
 			count=ObjectSpace.each_object(Sunflower){|o| @sunflower=o}
-			raise RuntimeError, 'Sunflower - you must pass wiki name if using multiple Sunflowers at once!' if count>1
+			raise SunflowerError, 'you must pass wiki name if using multiple Sunflowers at once!' if count>1
 		else
 			ObjectSpace.each_object(Sunflower){|o| @sunflower=o if o.wikiURL==wiki}
 		end
@@ -181,46 +201,60 @@ class Page
 			return
 		end
 		
-		r=@sunflower.API('action=query&prop=info&inprop=protection&intoken=edit&titles='+CGI.escape(@title))
-		r=r['query']['pages'][r['query']['pages'].keys[0] ]
-		r.each{|key,value|
+		preload_text
+	end
+	
+	def preload_text
+		r = @sunflower.API('action=query&prop=revisions&rvprop=content&titles='+CGI.escape(@title))
+		r = r['query']['pages'].first
+		if r['missing']
+			@text = ''
+		else
+			@text = r['revisions'][0]['*']
+		end
+		
+		@orig_text = @text
+		
+		@preloaded_text = true
+	end
+	
+	def preload_attrs
+		r = @sunflower.API('action=query&prop=info&inprop=protection&intoken=edit&titles='+CGI.escape(@title))
+		r = r['query']['pages'].first
+		r.each{|key, value|
 			self.instance_variable_set('@'+key, value)
 		}
 		
-		r=@sunflower.API('action=query&prop=revisions&rvprop=content&titles='+CGI.escape(@title))
-		
-		begin
-			@text=r['query']['pages'][@pageid.to_s]['revisions'][0]['*']
-		rescue Exception
-			@text=''
-		end
-		@orig_text=@text
+		@preloaded_attrs = true
 	end
 	
-	def dumpto file
+	def dump_to file
 		if file.respond_to? :write #probably file or IO
 			file.write @text
 		else #filename?
-			f=File.open(file.to_s, 'w')
-			f.write @text
-			f.close
+			File.open(file.to_s, 'w'){|f| f.write @text}
 		end
 	end
 	
 	def dump
-		self.dumpto @title.gsub(/[^a-zA-Z0-9\-]/,'_')+'.txt'
+		self.dump_to @title.gsub(/[^a-zA-Z0-9\-]/,'_')+'.txt'
 	end
 	
-	def save title=@title, summary=$summary
-		raise RuntimeError, 'Sunflower - title invalid: '+title if title.index(/[#<>\[\]\|\{\}]/)
-		raise RuntimeError, 'Sunflower - no summary!' if (summary==nil || summary=='') && @summaryAppend==[]
+	def save title=@title, summary=nil
+		preload_attrs unless @preloaded_attrs
 		
-		summary='' if summary==nil
-		for i in @summaryAppend.uniq
-			summary+=', '+i
-		end
-		summary.sub!(/^, /,'')
+		summary = @sunflower.summary if !summary
 		
+		raise SunflowerError, 'title invalid: '+title if title =~ INVALID_CHARS_REGEX
+		raise SunflowerError, 'no summary!' if (!summary or summary=='') && @summaryAppend.empty?
+		
+		unless @summaryAppend.empty?
+			if !summary or summary==''
+				summary = @summaryAppend.uniq.join(', ')
+			else
+				summary =  summary.sub(/,\s*\Z/, '') + ', ' + @summaryAppend.uniq.join(', ')
+			end
+		end
 		
 		if @orig_text==@text && title==@title
 			@sunflower.log('Page '+title+' not saved - no changes.')
@@ -229,7 +263,7 @@ class Page
 		
 		
 		
-		self.code_cleanup if $alwaysDoCodeCleanup && self.respond_to?('code_cleanup')
+		self.code_cleanup if @sunflower.always_do_code_cleanup && self.respond_to?('code_cleanup')
 		
 		r=@sunflower.API("action=edit&bot=1&title=#{CGI.escape(title)}&text=#{CGI.escape(@text)}&summary=#{CGI.escape(summary)}&token=#{CGI.escape(@edittoken)}")# if @sunflower.isBot?
 	end

data/lib/sunflower/listmaker.rb

@@ -4,7 +4,7 @@ class Sunflower
 	def make_list type, *parameters
 		type=type.downcase.gsub(/[^a-z]/, '')
 		first=parameters[0]
-		firstE=CGI.escape first
+		firstE=CGI.escape first.to_s
 		
 		case type
 		when 'file'
@@ -29,11 +29,11 @@ class Sunflower
 			
 		when 'categorieson'
 			r=self.API('action=query&prop=categories&cllimit=500&titles='+firstE)
-			list=r['query']['pages'].first['categories'].map{|v| v['title']} #extract titles
+			list=r['query']['pages'].first['categories'].map{|v| v['title']}
 			
 		when 'category'
 			r=self.API('action=query&list=categorymembers&cmprop=title&cmlimit=5000&cmtitle='+firstE)
-			list=r['query']['categorymembers'].map{|v| v['title']} #extract titles
+			list=r['query']['categorymembers'].map{|v| v['title']}
 			
 		when 'categoryr', 'categoryrecursive'
 			list=[] #list of articles
@@ -48,43 +48,43 @@ class Sunflower
 			
 		when 'linkson'
 			r=self.API('action=query&prop=links&pllimit=5000&titles='+firstE)
-			list=r['query']['pages'].first['links'].map{|v| v['title']} #extract titles
+			list=r['query']['pages'].first['links'].map{|v| v['title']}
 			
 		when 'transclusionson', 'templateson'
 			r=self.API('action=query&prop=templates&tllimit=5000&titles='+firstE)
-			list=r['query']['pages'].first['templates'].map{|v| v['title']} #extract titles
+			list=r['query']['pages'].first['templates'].map{|v| v['title']}
 			
 		when 'usercontribs', 'contribs'
 			r=self.API('action=query&list=usercontribs&uclimit=5000&ucprop=title&ucuser='+firstE)
-			list=r['query']['usercontribs'].map{|v| v['title']} #extract titles
+			list=r['query']['usercontribs'].map{|v| v['title']}
 			
 		when 'whatlinksto', 'whatlinkshere'
 			r=self.API('action=query&list=backlinks&bllimit=5000&bltitle='+firstE)
-			list=r['query']['backlinks'].map{|v| v['title']} #extract titles
+			list=r['query']['backlinks'].map{|v| v['title']}
 			
 		when 'whattranscludes', 'whatembeds'
 			r=self.API('action=query&list=embeddedin&eilimit=5000&eititle='+firstE)
-			list=r['query']['embeddedin'].map{|v| v['title']} #extract titles
+			list=r['query']['embeddedin'].map{|v| v['title']}
 			
 		when 'image', 'imageusage'
 			r=self.API('action=query&list=imageusage&iulimit=5000&iutitle='+firstE)
-			list=r['query']['imageusage'].map{|v| v['title']} #extract titles
+			list=r['query']['imageusage'].map{|v| v['title']}
 			
 		when 'search'
 			r=self.API('action=query&list=search&srwhat=text&srlimit=5000&srnamespace='+(parameters[1]=='allns' ? CGI.escape('0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|100|101|102|103') : '0')+'&srsearch='+firstE)
-			list=r['query']['search'].map{|v| v['title']} #extract titles
+			list=r['query']['search'].map{|v| v['title']}
 			
 		when 'searchtitles'
 			r=self.API('action=query&list=search&srwhat=title&srlimit=5000&srnamespace='+(parameters[1]=='allns' ? CGI.escape('0|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|100|101|102|103') : '0')+'&srsearch='+firstE)
-			list=r['query']['search'].map{|v| v['title']} #extract titles
+			list=r['query']['search'].map{|v| v['title']}
 		
 		when 'random'
-			r=self.API('action=query&list=random&rnnamespace=0&rnlimit='+first.gsub(/\D/))
-			list=r['query']['random'].map{|v| v['title']} #extract titles
+			r=self.API('action=query&list=random&rnnamespace=0&rnlimit='+firstE)
+			list=r['query']['random'].map{|v| v['title']}
 			
 		when 'external', 'linksearch'
 			r=self.API('action=query&euprop=title&list=exturlusage&eulimit=5000&euquery='+firstE)
-			list=r['query']['exturlusage'].map{|v| v['title']} #extract titles
+			list=r['query']['exturlusage'].map{|v| v['title']}
 			
 		when 'google'
 			limit=[parameters[1].to_i,999].min

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sunflower
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Matma Rex
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.7.1
 signing_key: 
 specification_version: 3
 summary: Sunflower is a lightweight library to provide access to MediaWiki API from Ruby.