butler 1.8.0 → 1.8.1

data/data/butler/dialogs/botcontrol.rb

@@ -1,4 +1,9 @@
 say(:configuring, :name => variables.user)
-response(:option, :config, variables.installer.user_config_suggestions)
-response(:option, :bots, variables.installer.user_data_suggestions.map { |sug| sug+"/bots" })
-response(:option, :run,  variables.installer.user_pid_suggestions)
+suggestions = variables.installer.user_config_suggestions(variables.user)
+response(:suggestion, :config, suggestions, suggestions.first)
+
+suggestions = variables.installer.user_data_suggestions(variables.user).map { |sug| sug+"/bots" }
+response(:suggestion, :bots, suggestions, suggestions.first)
+
+suggestions = variables.installer.user_pid_suggestions(variables.user)
+response(:suggestion, :run, suggestions, suggestions.first)

data/data/butler/dialogs/create.rb

@@ -11,25 +11,25 @@ Butler.create(nil, name)
 bot    = Butler.new(nil, name)
 		
 #if prompt(:quicksetup, true) then
-	bot.config["connections.main.server"]          = server=ask(:server, "irc.freenode.org", String, :min => 3)
-	bot.config["connections.main.port"]            = 6667
-	bot.config["connections.main.host"]            = nil
-	bot.config["connections.main.reconnect_delay"] = 60
-	bot.config["connections.main.reconnect_tries"] = -1
-	bot.config["connections.main.charset"]         = 'utf-8'
-	bot.config["connections.main.language"]        = lang=ask(:language, "en", String, :matching => /\A#[A-Za-z0-9_-]{2,40}\z/)
-	bot.config["connections.main.nick"]            = name
-	bot.config["connections.main.alternative"]     = name[0,7]+"_"
-	bot.config["connections.main.user"]            = name
-	bot.config["connections.main.real"]            = name+" (Butler IRC bot)"
-	bot.config["connections.main.password"]        = ask(:nickpass, nil, String)
-	bot.config["connections.main.identify"]        = :auto
-	bot.config["connections.main.channels"]        = channels=ask(:channels, (server == "irc.freenode.org" ? ["#butler"] : nil), Array, String, :matching => /\A#[^\0\s,]+\z/)
+	bot.config["connections/main/server"]          = server=ask(:server, "irc.freenode.org", String, :min => 3)
+	bot.config["connections/main/port"]            = 6667
+	bot.config["connections/main/host"]            = nil
+	bot.config["connections/main/reconnect_delay"] = 60
+	bot.config["connections/main/reconnect_tries"] = -1
+	bot.config["connections/main/charset"]         = 'utf-8'
+	bot.config["connections/main/language"]        = lang=ask(:language, "en", String, :matching => /\A#[A-Za-z0-9_-]{2,40}\z/)
+	bot.config["connections/main/nick"]            = name
+	bot.config["connections/main/alternative"]     = name[0,7]+"_"
+	bot.config["connections/main/user"]            = name
+	bot.config["connections/main/real"]            = name+" (Butler IRC bot)"
+	bot.config["connections/main/password"]        = ask(:nickpass, nil, String)
+	bot.config["connections/main/identify"]        = :auto
+	bot.config["connections/main/channels"]        = channels=ask(:channels, (server == "irc.freenode.org" ? ["#butler"] : nil), Array, String, :matching => /\A#[^\0\s,]+\z/)
 	channels.each { |channel|
-		prefix = "channels.#{server.config_key}.#{channel.config_key}"
-		bot.config["#{prefix}.password"] = nil
-		bot.config["#{prefix}.language"] = lang
-		bot.config["#{prefix}.charset"]  = 'utf-8'
+		prefix = "channels/#{server.config_key}/#{channel.config_key}"
+		bot.config["#{prefix}/password"] = nil
+		bot.config["#{prefix}/language"] = lang
+		bot.config["#{prefix}/charset"]  = 'utf-8'
 	}
 	user = ask(:user, nil, String, :min => 3)
 	pass = ask(:pass, nil, String, :min => 3)

data/data/butler/dialogs/create_config.rb

@@ -0,0 +1,8 @@
+begin
+	user = variables.user || variables.botcontrol.user
+	variables.botcontrol.configure_user unless variables.botcontrol.configured?(user)
+	Butler.path = variables.botcontrol.butler_path
+rescue Errno::EACCES
+	say :cant_configure, :user => user, :app => $0
+	exit
+end

data/data/butler/dialogs/en/create_config.yaml

@@ -0,0 +1,2 @@
+--- 
+:cant_configure: "Can't configure for '<%= user %>', you should run <%= app %> with sudo."

data/data/butler/dialogs/en/list.yaml

@@ -1,4 +1,5 @@
 --- 
-:nobots: "No bots available."
+:nobots: "<%= user %> has no bots."
+:nouser: "<%= user %> is not registered to botcontrol."
 :bots:   "Available bots (<%= bot_count %>):"
 :abot:   " -<%= bot %>"

data/data/butler/dialogs/info.rb

@@ -1,5 +1,5 @@
-if variables.user && botcontrol.configured?(variables.user) then
-	user_config = botcontrol.user_config(variables.user)
+if variables.user && variables.botcontrol.configured?(variables.user) then
+	user_config = variables.botcontrol.user_config(variables.user)
 	say(:user,
 		:name     => variables.user,
 		:bots     => user_config[:bots],

data/data/butler/dialogs/list.rb

@@ -1,10 +1,15 @@
-user_config = variables.botcontrol.user_config(variables.user)
-bot_list    = Butler.list(user_config)
-if bot_list.empty? then
-	say(:nobots)
+user = variables.user || variables.botcontrol.user
+if variables.botcontrol.configured?(user) then
+	user_config = variables.botcontrol.user_config(user)
+	bot_list    = Butler.list(user_config)
+	if bot_list.empty? then
+		say(:nobots, :user => user)
+	else
+		say(:bots, :bot_count => bot_list.size)
+		bot_list.each { |bot|
+			say(:abot, :bot => bot)
+		}
+	end
 else
-	say(:bots, :bot_count => bot_list.size)
-	bot_list.each { |bot|
-		say(:abot, :bot => bot)
-	}
+	say(:nouser, :user => user)
 end

data/data/butler/plugins/games/countdown.rb

@@ -0,0 +1,41 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+def on_countdown
+	return answer(usage) if @message.arguments.length < 2
+	answer = Answers[rand(Answers.length)]
+	@butler.irc.action(_(:shake), message.channel ? message.channel : message.from)
+	sleep(1.5)
+	answer(answer)
+end
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+:summary:
+  en: Start counting down.
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:strings:
+:xmap:
+  :on_countdown
+    :en:
+    - countdown :from
+    - countdown from :from :to
+    - countdown from :from to :to
+    - countdown from :from
+:usage:
+  en: |
+    ![b]countdown![o]
+:help:
+  en:
+    "": |
+      Start counting down.

data/data/butler/plugins/games/roll.rb

@@ -0,0 +1,59 @@
+#--
+# Copyright 2007 by Stefan Rusterholz.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#++
+
+
+
+trigger "roll"
+
+def on_trigger
+	answer(:roll, :result => roll(@message.post_arguments[1]))
+end
+
+def dices(dices, sides)
+  dices = 1 if dices.zero?
+  sides = 6 if sides.zero?
+  (0..dices).inject { |sum,i| sum+rand(sides) }
+end
+
+def chance(from, to)
+  from = 0 if from.zero?
+  to   = 100 if to.zero?
+  rand(to-from)+from
+end
+
+def roll(str)
+  str.scan(/(\d*)d(\d*)|(%)(?:\[(\d*)(?::(\d+))?\])?/).map { |dices, sides, percent, from, to|
+ 	  percent ? chance(from.to_i, to.to_i) : dices(dices.to_i, sides.to_i)
+  }
+end
+
+
+__END__
+--- 
+:revision:
+  :plugin: 1
+:summary:
+  en: Roll dices.
+:about:
+  :mail: "apeiros@gmx.net"
+  :version: "1.0.0"
+  :author: "Stefan Rusterholz"
+:strings:
+  :roll:
+    en: "You rolled: <%= result.join(', ') %>"
+:usage:
+  en: |
+    ![b]roll![o] *![c(blue)]dice serie![o]
+:help:
+  en:
+    "": |
+      Ask butler a question and get an answer from the magic eightball.
+    "roll": |
+      Roll a series of dices and chances. Try 'roll d 4d10 % %[20:80]'
+    "dices": |
+      3d10 rolls 3 dices with 10 sides and shows the sum.
+    "chances": |
+      Chances are esentially 100 sided dices.

data/lib/access.rb

@@ -15,6 +15,11 @@ require 'access/privilege'
 
 
 class Access
+	attr_reader   :user
+	attr_reader   :role
+	attr_reader   :privilege
+	attr_accessor :default_user
+
 	# =Description
 	# Provides methods to create a user or authenticate
 	# an existing.
@@ -47,11 +52,6 @@ class Access
 	#   user.authorized?('news/edit')   # => true  # only users created via Access#login are authorized
 	#   user.authorized?('news/create') # => false
 	#
-	attr_reader   :user
-	attr_reader   :role
-	attr_reader   :privilege
-	attr_accessor :default_user
-
 	def initialize(user, role, privilege)
 		@user      = user
 		@role      = role
@@ -61,6 +61,7 @@ class Access
 		}
 	end
 	
+	# Access users by their id.
 	def [](user_id)
 		@user[user_id]
 	end
@@ -83,105 +84,3 @@ class Access
 		Digest::MD5.hexdigest(credentials+user_id.downcase).upcase
 	end
 end
-
-if __FILE__ == $0 then
-	require 'fileutils'
-	require 'test/unit'
-	class TestAccess < Test::Unit::TestCase
-		TestDir = "test_access"
-		def setup
-			#raise "#{TestDir} already exists, aborting test" if File.exist?(TestDir)
-			_teardown if File.exist?(TestDir)
-			Dir.mkdir(TestDir)
-			Dir.mkdir("#{TestDir}/user")
-			Dir.mkdir("#{TestDir}/role")
-			Dir.mkdir("#{TestDir}/privilege")
-		end
-		
-		def _teardown
-			FileUtils.rm_r(TestDir)
-		end
-		
-		def test_all
-			access = Access.new(
-				Access::YAMLBase.new(Access::User::Base,      "#{TestDir}/user"),
-				Access::YAMLBase.new(Access::Role::Base,      "#{TestDir}/role"),
-				Access::YAMLBase.new(Access::Privilege::Base, "#{TestDir}/privilege")
-				#:channel => Access::YAMLBase.new("#{TestDir}/channel", Access::Location)
-			)
-			assert(!access.user.exists?("test"))
-			access.user.create("test", "pass")
-			assert(access.user.exists?("test"))
-
-			%w(news news/read news/create news/edit news/delete banners banners/statistics
-			statistics statistics/web statistics/ftp paid_content).each { |priv|
-				assert(!access.privilege.exists?(priv))
-				access.privilege.create(priv, "test-privilege #{priv}")
-				assert(access.privilege.exists?(priv))
-			}
-			
-			access.role.create("editor", "testrole description", %w(news/create news/edit statistics))
-			access.role.create("chiefeditor", "testrole description 2", %w(news), %w(editor))
-
-			user = access.login("test", "pass")
-			assert(user)
-			assert(user.logged?)
-			assert(!user.active?)
-			assert(user.inactive?)
-			user.active = true
-			assert(user.active?)
-			assert(!user.inactive?)
-			user = access.user["test", true]
-			assert(user)
-			assert(user.active?)
-			assert(!user.inactive?)
-			assert(!user.logged?)
-			
-			assert(!user.privileged?("foo"))
-			assert(!user.privileged?("foo/bar"))
-			assert(!user.privileged?("foo/baz"))
-			assert(!user.privileged?("bar"))
-			assert(!user.privileged?("bar/foo"))
-			assert(!user.privileged?("baz"))
-
-			assert(!user.authorized?("foo"))
-			assert(!user.authorized?("foo/bar"))
-			assert(!user.authorized?("foo/baz"))
-			assert(!user.authorized?("bar"))
-			assert(!user.authorized?("bar/foo"))
-			assert(!user.authorized?("baz"))
-
-			user.privileges.add(%w(banners statistics/web paid_content))
-
-			assert(user.privileged?("banners"))
-			assert(user.privileged?("banners/statistics"))
-			assert(user.privileged?("statistics/web"))
-			assert(!user.privileged?("statistics"))
-			assert(user.privileged?("bar/foo"))
-			assert(user.privileged?("baz"))
-
-			assert(!user.authorized?("foo"))
-			assert(!user.authorized?("foo/bar"))
-			assert(!user.authorized?("foo/baz"))
-			assert(!user.authorized?("bar"))
-			assert(!user.authorized?("bar/foo"))
-			assert(!user.authorized?("baz"))
-			
-			user = access.login("test", "pass")
-
-			assert(user.privileged?("foo"))
-			assert(user.privileged?("foo/bar"))
-			assert(user.privileged?("foo/baz"))
-			assert(!user.privileged?("bar"))
-			assert(user.privileged?("bar/foo"))
-			assert(user.privileged?("baz"))
-
-			assert(user.authorized?("foo"))
-			assert(user.authorized?("foo/bar"))
-			assert(user.authorized?("foo/baz"))
-			assert(!user.authorized?("bar"))
-			assert(user.authorized?("bar/foo"))
-			assert(user.authorized?("baz"))
-		end
-	end
-end

data/lib/access/admin.rb

@@ -7,7 +7,10 @@
 
 
 class Access
+	# Extend Admin users with this plugin, speeds up privileged?
+	# by statically returning true and not performing any lookup.
 	module Admin
+
 		# admins have all privileges
 		def privileged?(*args)
 			true

data/lib/access/role.rb

@@ -7,11 +7,19 @@
 
 
 class Access
+
 	# Access::Role's are a set of privileges with (optionally)
 	# an additional restriction (which is applied globally).
+	#
 	class Role
+
+		# The module to extend the Database manager
 		module Base
+
 			# Create a new Role
+			# role is a role-id, should be \w+
+			# description is a piece of text describing the role
+			# privileges are the privileges the role provides
 			def create(role, description=nil, privileges=[])
 				raise "Role #{role} already exists" if exists?(role)
 				role        = Role.new(role, description)
@@ -35,9 +43,16 @@ class Access
 			end
 		end
 
+		# The record-id
 		attr_reader :id
+		
+		# The description of the role
 		attr_reader :description
 
+		# Create a new Role
+		# role is a role-id, should be \w+
+		# description is a piece of text describing the role
+		# other: a hash that accepts the keys :privileges and :roles
 		def initialize(role, description=nil, other={})
 			@id          = role
 			@privileges  = Privileges.new(self, other[:privileges])
@@ -45,6 +60,8 @@ class Access
 			@description = description || "No description"
 		end
 		
+		# :nodoc:
+		# serialize to column => value for storage
 		def storable
 			{
 				:id          => @id,
@@ -54,47 +71,65 @@ class Access
 			}
 		end
 
+		# recursively tests the role and its contained roles if any of them
+		# allows a given privilege under given conditions (may be nil to indicate
+		# no condition)
 		def allows?(privilege, condition=nil)
 			@privileges.allow?(privilege, condition) || @roles.allow?(privilege, condition)
 		end
 
+		# :nodoc:
 		def eql?(other)
 			self.class == other.class && @id.eql?(other.id)
 		end
 		
+		# :nodoc:
 		def hash
 			@id.hash
 		end
 	end
 	
+	# A list of roles
 	class Roles
+		include Enumerable
+
+		# owner must be capable of #save
+		# roles is the list of Role instances (array)
 		def initialize(owner, roles=nil)
 			@owner = owner
 			@roles = roles || []
 		end
-		
+
+		# Tests if any of the roles in self allows a privilege under
+		# given conditions (may be nil to indicate no condition)
 		def allow?(privilege, condition=nil)
 			@roles.any? { |role| role.allows?(privilege, condition) }
 		end
 
+		# add a role (Role instance)
 		def add(role)
 			@roles << role
 			@owner.save
 		end
 		
+		# delete a role (Role instance)
 		def delete(role)
 			@roles.delete(role)
 			@owner.save
 		end
 		
+		# all roles
 		def list
-			@roles
+			@roles.dup
 		end
 
+		# Iterate over the roles
 		def each(&block)
 			@roles.each(&block)
 		end
 		
+		# :nodoc:
+		# prepare for storage
 		def storable
 			@roles.map { |role| role.id }
 		end