ficsr 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ficsr.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,4 @@
+# ficsr
+
+Ficsr is a ruby library for the "Free internet chess server".
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/autotest/discover.rb

@@ -0,0 +1,4 @@
+require "autotest/growl"
+require "autotest/fsevent"
+
+Autotest.add_discovery { "rspec2" }

data/ficsr.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ficsr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ficsr"
+  s.version     = Ficsr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Thilko Richter"]
+  s.email       = [""]
+  s.homepage    = ""
+  s.summary     = %q{Ruby library for the free internet chess server}
+  s.description = %q{Administration of games any other various thing are possible}
+
+  s.rubyforge_project = "ficsr"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency('rspec', "~> 2.6.0")
+  s.add_development_dependency('autotest', "~> 4.4.6")
+  s.add_development_dependency('autotest-growl', "~> 0.2.9")
+  s.add_development_dependency('autotest-fsevent', "~> 0.2.5")
+end

data/lib/ficsr.rb

@@ -0,0 +1,4 @@
+require "ficsr/session"
+require "ficsr/game"
+
+require "net/telnet"

data/lib/ficsr/game.rb

@@ -0,0 +1,74 @@
+module Ficsr
+
+  CATEGORIES =  { :b => :blitz, :s => :standard, :B => :Bughouse, :l => :lightning, 
+                  :w => :wild,  :L => :losers,   :u => :untimed,  :x => :atomic,
+                  :S => :Suicide, :e => :examined_game, :z => :crazyhouse
+                }
+  class Game
+    def initialize(game_def)
+      game_regexp = %r{
+      (?<number>^\d*){0}
+      (?<white_rating>\S*){0}                  
+      (?<white_handle>\S*){0}                  
+      (?<black_rating>\S*){0}                  
+      (?<black_handle>\S*){0}                  
+      (?<private>p?){0}                  
+      (?<category>\w?){0}                  
+      (?<rated>\w?){0}                  
+      (?<start_minutes>\d*){0}                  
+      (?<increment_seconds>\d*){0}                  
+      (?<time_white>\d*:\d*:?\d*){0}                  
+      (?<time_black>\d*:\d*:?\d*){0}                  
+      (?<strength_white>\d*){0}                  
+      (?<strength_black>\d*){0}                  
+      (?<turn>[WB]){0}                  
+      (?<move_number>\d*){0}                  
+      
+      \g<number>\s*\g<white_rating>\s*\g<white_handle>\s*\g<black_rating>\s*\g<black_handle>\s*\[\g<private>\s*
+      \g<category>\s*\g<rated>\s*\g<start_minutes>\s*\g<increment_seconds>\]\s*\g<time_white>\s*-\s*
+      \g<time_black>\s*\(\s*\g<strength_white>\s*-\s*\g<strength_black>\)\s\g<turn>:\s*\g<move_number>$
+      
+      }x
+
+      match_data = game_def.match(game_regexp)
+      if match_data
+        self.number             = match_data[:number].to_i
+        self.white_rating       = match_data[:white_rating]
+        self.white_handle       = match_data[:white_handle]
+        self.black_rating       = match_data[:black_rating]
+        self.black_handle       = match_data[:black_handle]
+        self.private            = !match_data[:private].empty?
+        self.category_id        = match_data[:category].to_sym
+        self.rated              = match_data[:rated]
+        self.start_minutes      = match_data[:start_minutes].to_i
+        self.increment_seconds  = match_data[:increment_seconds].to_i
+        self.time_white         = match_data[:time_white]
+        self.time_black         = match_data[:time_black]
+        self.strength_white     = match_data[:strength_white].to_i
+        self.strength_black     = match_data[:strength_black].to_i
+        self.turn               = match_data[:turn]
+        self.move_number        = match_data[:move_number].to_i
+      else
+        p "ignoring game '#{game_def}'"
+      end
+    end
+
+    attr_accessor :number, :white_rating, :white_handle, :black_rating, :black_handle, :private, :category_id, :rated, :start_minutes, :increment_seconds, :time_white, :time_black, :strength_white, :strength_black, :turn, :move_number
+
+    def private?
+      self.private
+    end
+
+    def category
+      CATEGORIES[self.category_id]
+    end
+
+    def rated?
+      self.rated == "r"
+    end
+
+    def whites_turn?
+      self.turn == "W"
+    end
+  end
+end

data/lib/ficsr/session.rb

@@ -0,0 +1,84 @@
+module Ficsr 
+  class Session
+
+    class << self
+      def login(username, password="")
+        new(username, password) 
+      end
+    end
+
+    attr_reader :username, :password
+
+    def initialize(username, password)
+      @username = username
+      @password = password
+
+      send username, /password|is not a registered name/
+
+      if registered? 
+        send password, /fics|login/
+      else
+        send "\n", /#{username}/
+      end
+      raise "Unable to login with username #{username} " unless logged_in? 
+    end
+
+    def games
+      send "games", /fics/
+      last_result.split("\n\r").select { |line| line =~ /^\d{3}\s\w{1,4}.*$/ }.collect do |game|
+        Ficsr::Game.new game
+      end
+    end
+
+    def observe(game_number, &action)
+      t = Thread.new do
+        send "observe #{game_number}", /fics/
+        last_result.each_line("\n\r") do |line|
+          action.call(line) if line =~/^<12>/ 
+        end
+      end
+
+      t.join
+    end
+
+    private
+
+    def connection
+      @connection ||= Net::Telnet.new "Host" => host, "Port" => port, "Prompt" => default_prompt
+    end
+
+    def logged_in?
+      last_result.include?("Starting FICS session as #{username}")
+    end
+
+    def send(cmd, match="", opts={}, &actions)
+      all_opts = {"String" => cmd, "Match" => match}.merge opts
+
+      if block_given?
+        @last_result = connection.cmd(all_opts, &actions)
+      else
+        @last_result = connection.cmd(all_opts)
+      end
+    end
+
+    def last_result
+      @last_result
+    end
+
+    def registered?
+       last_result =~ /is a registered name/ 
+    end
+
+    def host
+      "freechess.org"
+    end
+
+    def port
+      5000
+    end
+
+    def default_prompt
+      /fics/
+    end
+  end
+end

data/lib/ficsr/version.rb

@@ -0,0 +1,3 @@
+module Ficsr
+  VERSION = "0.0.1"
+end

data/spec-integration/ficsr_spec.rb

@@ -0,0 +1,44 @@
+require "ficsr"
+
+describe Ficsr::Session do
+  describe ".login" do
+    context "with valid credentials" do
+      it "performs a successful login" do
+        @session = Ficsr::Session.login ENV["ficsr_username"], ENV["ficsr_password"]
+        @session.should_not be_nil
+      end
+    end
+
+    context "with invalid credentials" do
+      it "does not login" do
+        expect { Ficsr::Session.login "blackhacker", "xxx" }.to
+          raise_error
+      end
+    end
+    
+    context "with an anonymous user" do
+      it "does a login" do
+        @session = Ficsr::Session.login "someanonymous"
+        @session.should_not be_nil
+      end
+    end
+  end
+
+  let(:session) { Ficsr::Session.login ENV["ficsr_username"], ENV["ficsr_password"] }
+  
+  describe "#games" do
+    it "returns a list of games" do
+      session.games.each { |game| game.should be_a Ficsr::Game }
+    end
+  end
+
+  describe "#observe" do
+    let(:game_number) { session.games.first.number }
+    it "starts observing the game" do
+      session.observe game_number do |move|
+        p "MOVE: #{move}"  
+      end
+    end
+  end
+
+end

data/spec/game_spec.rb

@@ -0,0 +1,108 @@
+require "ficsr"
+
+GAME = "302 1221 vinayakghol ++++ Bhuvi      [psr 15  20]  16:38 - 15:08 (37-39) W: 13"
+
+describe Ficsr::Game do
+  describe ".new" do
+    it "creates a new game object from the given string"  do 
+      Ficsr::Game.new(GAME).should be_a Ficsr::Game 
+    end
+  end
+
+  let(:game) { Ficsr::Game.new GAME }
+
+  describe "#number" do
+    it "returns the number of the game " do
+      game.number.should == 302
+    end
+  end
+
+  describe "#white_handle" do
+    it "returns the handle of the white player " do
+      game.white_handle.should == "vinayakghol"
+    end
+  end
+
+  describe "#white_rating" do
+    it "returns the rating of the white player " do
+      game.white_rating.should == "1221"
+    end
+  end
+  describe "#black_handle" do
+    it "returns the handle of the black player " do
+      game.black_handle.should == "Bhuvi"
+    end
+  end
+
+  describe "#black_rating" do
+    it "returns the rating of the white player " do
+      game.black_rating.should == "++++"
+    end
+  end
+
+  describe "#private?" do
+    it "returns true if the game is private" do
+      game.should be_private
+    end
+  end
+
+  describe "#category" do
+    it "returns the category" do
+      game.category.should == :standard
+    end
+  end
+
+  describe "#rated?" do
+    it "returns true for a rated game" do
+      game.should be_rated
+    end
+  end
+
+  describe "#start_minutes" do
+    it "returns the minuted each player get at the beginning" do
+      game.start_minutes.should == 15
+    end
+  end
+
+  describe "#increment_seconds" do
+    it "returns true for a rated game" do
+      game.increment_seconds.should == 20
+    end
+  end
+
+  describe "#time_white" do
+    it "returns the remaining time of white" do
+      game.time_white.should == "16:38"
+    end
+  end
+
+  describe "#time_black" do
+    it "returns the remaining time of black" do
+      game.time_black.should == "15:08"
+    end
+  end
+
+  describe "#strength_white" do
+    it "returns the strength of white" do
+      game.strength_white.should == 37
+    end
+  end
+
+  describe "#strength_black" do
+    it "returns the strength of black" do
+      game.strength_black.should == 39
+    end
+  end
+
+  describe "#whites_turn?" do
+    it "return true if it is whites turn" do
+      game.should be_whites_turn
+    end
+  end
+
+  describe "#move_number" do
+    it "return the current move number of white/black"  do
+      game.move_number == 13
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: ficsr
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thilko Richter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 4.4.6
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest-growl
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: autotest-fsevent
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.5
+  type: :development
+  version_requirements: *id004
+description: Administration of games any other various thing are possible
+email: 
+- ""
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- autotest/discover.rb
+- ficsr.gemspec
+- lib/ficsr.rb
+- lib/ficsr/game.rb
+- lib/ficsr/session.rb
+- lib/ficsr/version.rb
+- spec-integration/ficsr_spec.rb
+- spec/game_spec.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: ficsr
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Ruby library for the free internet chess server
+test_files: 
+- spec/game_spec.rb