dragongoserver 0.4.0 → 0.4.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.4.1 2009-08-02
+
+* 4 bug-fixes:
+  * rescued the Timeout-Error at #gameinfo (retry in 30 seconds)
+  * added the config file for new waiting room games to the gem files
+  * Link 'finished games' was changed at dgs
+  * fixed bug String#each to each_line in Ruby 1.9
+ 
 == 0.4.0 2009-07-13
 
 * 1 enhancement:

data/Manifest.txt

@@ -9,6 +9,7 @@ TODO
 bin/dgs
 config/hoe.rb
 config/requirements.rb
+.dgs_default_add_game.yml
 examples/example1.rb
 examples/id.dat
 examples/userlist.out

data/README.txt

@@ -1,4 +1,3 @@
-dragongoserver
     by Thomas Preymesser
     http://dragongoserver.rubyforge.org/ 
 
@@ -8,25 +7,187 @@ The dragongoserver gem allows you to use the Go Server (http://www.dragongoserve
 
 == FEATURES/PROBLEMS:
 
-* test (list of features or problems)
+You can access various features of Dragongoserver either within your own
+Ruby programs or via a command line tool (dgs).
+
+* get your user info
+* get user infos of other users
+* list waiting games
+* add a game to the waiting room
+* ...
 
 == SYNOPSIS:
 
-  test (code sample of usage)
+First you have to set the following environment variables:
+
+  DGS_USERNAME="myname"
+  DGS_PASSWORD="mypassword"
+
+This can be done by inserting the following two line into your .bashrc file (or a similar startup file for your preferred shell).
+
+  export DGS_USERNAME="myname"
+  export DGS_PASSWORD="mypassword"
+
+Alternatively you can pass the username and password to every call of the 
+Dgs.new method: 
+
+  mydgs = Dgs.new("myname","mypassword")
+
+=== Within your ruby code: 
+
+  # some example how you can use this gem within your programs
+
+  require 'rubygems'
+  require 'dragongoserver'
+  require 'gorank'
+
+  dgs = Dgs.new
+
+  # get own user id at DGS
+
+  id = dgs.userid
+  puts "your user-id: #{id}"
+
+  # your rank
+
+  rank = dgs.get_rank
+
+  puts "your rank:"
+  p rank.to_s
+
+  # your user infos
+
+  infos = dgs.userinfo(id)
+
+  puts "your attributes at DGS:"
+  p infos
+
+  # waiting games
+
+  wg = dgs.waiting_games
+
+  puts 'waiting games:'
+  p wg
+
+  # you can get info for every other user
+  # user with user id 8000
+  user_8000 = dgs.userinfo(8000)
+
+  puts "user 8000:"
+  p user_8000
+
+  # see also the homepage of this gem for examples to use the
+  # command line script 'dgs'
+
+  require 'rubygems'
+  require 'dragongoserver'
+
+  dgs = Dgs.new
+  dgs.username      # prints your username at DGS
+
+  dgs.waiting_games # prints your waiting games:
+                    # => [369607, 369303, 369412]
+
+  dgs.get_rank      # your rank as a GoRank object
+                    # => #<GoRank:0xb7a66514 @kd=:kyu, @num="26">
+
+  dgs.get_rank.to_s # your rank as a string
+                    # => "26 kyu"
+
+  dgs.add_game      # adds one or more game in the waiting room
+                    # take the values from the file
+                    # ~/.dgs_default_add_game.yml if it exists
+
+=== The 'dgs' command line tool:
+
+  $ dgs -v
+  dgs 0.0.3
+
+outputs the version of the installed dragongoserver gem
+
+  $ dgs --help
+
+outputs a help of the dgs-script with all current implemented options
+
+  dgs --waiting
+
+prints a list of games where you have to make your next move
+
+You can open a shell, type in the following commands and watch when you have to move in a waiting game.
+Of course you can also write a shellscript with these commands.
+
+  while true
+  do
+    dgs --waiting
+    date
+    sleep 300
+  done
+
+Instead of the script above you can use the '--waiting-loop' feature of this gem:
+
+  $ dgs --waiting-loop
+
+in an endless loop prints a list of games where you have to make your next move.
+The duration until the next request is made at DGS will be dynamically adjusted. It starts with every 60 seconds and will be increased if there are no new moves in this period.
+
+If you want the messages display in big red letters as an On-Screen-Display:
+
+  $ dgs --waiting-loop --osd
+
+To add a new game to the waiting room use
+
+  xxx.add_game 
+
+in your Ruby code or
+
+  $ dgs --add-game
+
+at the command line. 
+The add_game method looks up for a file ~/.dgs_default_add_game.yml where the game parameters will be taken from. If this file does not exists dragongoserver will just submit the new game form at dragongoserver.net without any changes (i.e. 1 game, main time 90 days, ... etc.).
+
+==== Example of this config file
+
+  --- 
+  :number_of_games: 3
+  :size: 19
+  :main_time: 
+  - 15
+  - :days
+  :japanese_byoyomi: 
+  - 1
+  - :hours
+  - 24
+  - :extra_periods
+  :rated_game: true
+  :clock_runs_on_weekend: false
+  :require_rated_opponent: true
+  :relative_range: 9
+  :comment: added by dragongoserver ruby gem
+
+It should be relatively clear what every parameter is meant for.
+If you omit some of these values the corresponding part in the DGS
+form will not be changed.
+Currently there is only the japanese byoyomi implemented.
+Please don't change the indentation in this file, it is important
+in the YAML format.
+
+There is a sample file .dgs_default_add_game.yml delivered with this gem, which you can copy to your home directory and modify it to your own needs.
+
+  $ cp /your/gem/installation/path/.dgs_default_add_game.yml ~ 
 
 == REQUIREMENTS:
 
-* test (list of requirements)
+None. All dependent gems are installed automatically. If you want to use the --osd flag you have to install the osd package for your system.
 
 == INSTALL:
 
-* sudo gem install dragongoserver
+  sudo gem install dragongoserver
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2007,2008,2009
+Copyright (c) 2007-2009
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/dgs

@@ -100,7 +100,7 @@ Choice.options do
 end
 
 if Choice.choices['check_timeout_finished']
-  puts "timeout check für user #{Choice.choices['check_timeout_finished']} ausgewählt"
+  puts "timeout check for user #{Choice.choices['check_timeout_finished']}"
   dgs_username = ENV['DGS_USERNAME']
   dgs_password = ENV['DGS_PASSWORD']
   @dgs = Dgs.new(dgs_username, dgs_password)
@@ -115,7 +115,7 @@ if Choice.choices['check_timeout_finished']
     end
   }
   puts "at least #{finished.size} finished games"
-  puts "#{count} games finished with timeout"  
+  puts "#{count} games finished with timeout (#{count.to_f/finished.size.to_f*100.0} %)"  
   exit
 end
 
@@ -212,7 +212,14 @@ def new_moves?(dgs)
         print "[c] "
       end
       unless gi
-        gi = dgs.gameinfo(game) 
+        begin
+          gi = dgs.gameinfo(game) 
+        rescue Timeout::Error
+          puts "timeout error. retrying in 30 secs"
+          sleep 30
+          retry
+        end
+
         @cache_gameinfos[game] = gi
       end
       print gi[:white][:name]+' ' unless gi[:white][:name].include? "(#{dgs.username})"       

data/lib/dragongoserver.rb

@@ -2,7 +2,7 @@
 module Dragongoserver
 
   # :stopdoc:
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/dragongoserver/dragongoserver.rb

@@ -18,9 +18,10 @@ class Dgs
   # User agent 
   USER_AGENT_ALIAS = 'Mac Safari' # should work with every browser type
 
-  SAVE_WAIT = 15 # wait n seconds before each request
   # if we are doing too many requests at DGS the account (YOUR ACCOUNT)
   # will be temporarily blocked (for about 1 day)
+  # wait n seconds before each request
+  SAVE_WAIT = 15
 
   attr_reader :username
   
@@ -201,12 +202,13 @@ class Dgs
       end
       form = page.forms.first
       form.sf1 = user_id.to_s
-      
+      form.checkbox_with(:name => "active").uncheck # auch inaktive User beruecksichtigen
       page = agent.submit(form)
       #      page = agent.click page.links.text("#{user_id}")
       page = agent.click page.link_with(:text => "#{user_id}")
       #      page = agent.click page.links.text("Show finished games")
-      page = agent.click page.link_with(:text => "Show finished games")
+      # page = agent.click page.link_with(:text => "Show finished games")
+      page = agent.click page.link_with(:text => "Finished games")
     end
     if !page.body.include?("Finished games for")
       #p page.body
@@ -214,7 +216,7 @@ class Dgs
     end
     #page = agent.click page.links.text('Show finished games')
     one_game = {}
-    page.body.each {|line|
+    page.body.each_line {|line|
       #  p line
       #p one_game
       if line =~ /gid=([0-9]+)"/

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dragongoserver
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors: 
 - Thomas Preymesser
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-15 00:00:00 +02:00
+date: 2009-08-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency