bitpoker 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0f3c1729b675b7cc63c6332c40720b0b905a093
+  data.tar.gz: f7ab633639edce93cac5b8484d0d029d44459d18
+SHA512:
+  metadata.gz: 4d88295c37e073213753f5da61be201d11c3b7fc6c75cdef9c3b49395138cc3221717f8de061fac64b09b253409416f08d7fc152e9a2cbb65989adedb18cd8bf
+  data.tar.gz: 3f573f8b0d3e5554b7166b5e2dca847735d96e11ad9eca04b55baed535fcc9d534e2688174bb1a11eb90cec05421d6091061e0a56da0dde5d581aa467e294e7c

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+ruby "2.1.0"
+
+gem "parallel", "~> 0.9.2"
+
+group :develop do
+   gem "yard", "~> 0.8.7.3"
+end
+
+group :test do
+  gem "shoulda", "~> 3.5.0"
+  gem "mocha", "~> 1.0.0"
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    i18n (0.6.9)
+    metaclass (0.0.2)
+    minitest (4.7.5)
+    mocha (1.0.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.4)
+    parallel (0.9.2)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.5.0)
+      activesupport (>= 3.0.0)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha (~> 1.0.0)
+  parallel (~> 0.9.2)
+  shoulda (~> 3.5.0)
+  yard (~> 0.8.7.3)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Maciej Komorowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# BitPoker
+
+Ruby implementation of [BitPoker](http://bitpoker.sfi.org.pl/tutorial/pokaz/4) (polish readers only) game.
+
+## Idea
+
+**In general**: let computer programs play in simplified version of poker.
+
+**For devs**: create an bot that will beat the crap out of opponents.
+
+##Rules of game
+
+In a BitPoker duel participate two bots. Duel has `1000` rounds. Each round consists of following steps.
+
+1. **Rules introduction:** croupier introduces bots with round rules. Bots are sent information about `minimal` and `maximal` number from the card range, `maximal stake` they can bet during betting rounds and `timeout` - maximal duration of bot response.
+2. **Card deal:** bots receive random card from `0..4` (min_card .. max_card) range .
+3. **First betting round:** bots have to set their bets. Bet value must be from `10..200` (min_stake .. max_stake) range.
+	1. If both bets are already `200` (max_stake) go to **step 5**. If bets are even, go to **step 4**.
+	2. Otherwise, lower bidder is ask to call the round stake (opponents higher bid). If he agrees, go to next step. If he does not agree, lower bidder folds and loses points equal to his last bet. Higher bidder is a winner and receives score equal to last bet of folding bot. **Round is over**.
+4. **Second betting round:** is performed alike first one, however bet minimal value is equal to the stake determined after previous betting round.
+5. **Showdown:** croupier sends information to bots about opponent card. If cards are equal, round ends with a draw and result is 0 to 0. Otherwise, bot with lower card loses number of points equal to the round stake and winner receives the equivalent amount of points. **Round is over**.
+6. Round result is appended to a total score of the duel. 
+
+It is important for a bot to respect duel rules, otherwise the bot will be disqualified.
+
+**NOTE:** All of highlighted values are fully customizable. Take a peak at `BitPoker::Croupier#setup` method. Also they can be altered during duel (not recommenced so far), so each round can be different. 
+
+##How to start?
+
+Before any action is taken, use [Bundler](http://bundler.io/) to make sure your ruby environment is ready to play BitPoker.
+
+```
+gem update --system; gem install bundler # If you don't have Bundler installed
+bundle install
+```
+
+It's very simple. First of all we need to build our own bot. To do so, create class that implements `BitPoker::BotInterface`. When you finished, place your bot file to `./bot` dir. To be sure that your bot is ready
+for all game scenarios, play test duel with `DummyBot`. Enter following commands in your console:
+
+```
+rake bitpoker:duel[your_bot_name,dummy_bot]
+```
+When duel is over, you should see result of the duel.
+
+```
+[45795, -45795]
+```
+Now you are ready to fight your friends bots!
+##TCPoker
+Main reason of creating BitPoker is to create solid foundation for TCPoker - BitPoker over TCP. More to come very soon.

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake/testtask' 
+
+task :default => "bitpoker:duel"
+
+namespace :bitpoker do
+   
+   desc "Setup BitPocket"
+   task :setup do
+      require_relative 'lib/bitpoker'
+   end
+   
+   desc "Play BitPoker"
+   task :duel, [:bot_one, :bot_two] => :setup do |t, args|
+      
+      # Load bots
+      bot_one = BitPoker::load_bot( args.bot_one )
+      bot_two = BitPoker::load_bot( args.bot_two )
+      
+      # Init local bot proxy
+      proxy_one = BitPoker::BotProxy.new( bot_one )
+      proxy_two = BitPoker::BotProxy.new( bot_two )
+      
+      croupier = BitPoker::Croupier.new
+      
+      # Init new duel
+      duel = BitPoker::Duel.new( croupier, proxy_one, proxy_two )
+      
+      begin
+         until duel.finished? do
+            duel.play_round
+         end
+      rescue BitPoker::BotError => e
+         puts "Bot #{e.bot.trigger(:name)} is disqualified. Reason: \"#{e.message}\"."
+      end
+      p duel.total_score
+      
+   end
+   
+   Rake::TestTask.new( :unit ) do |t|
+     t.test_files = FileList['test/test_*.rb']
+   end
+   
+end

data/bitpoker.gemspec

@@ -0,0 +1,16 @@
+require_relative 'lib/bitpoker'
+
+Gem::Specification.new do |s|
+   s.name         = 'bitpoker'
+   s.version      = BitPoker::VERSION
+   s.license      = 'MIT'
+   s.summary      = "Bots play poker!"
+   s.description  = "Ruby implementation of BitPoker game."
+   s.author       = "Maciej Komorowski"
+   s.email        = 'mckomo@gmail.com'
+   s.files        = `git ls-files`.split("\n") - %w[.gitignore]
+   s.test_files   = s.files.select { |p| p =~ /^test\/test_.*.rb/ }
+   s.homepage     = 'https://github.com/mckomo/BitPoker'
+   s.add_dependency 'parallel', '~> 0.9', '>= 0.9.2'
+end
+

data/bot/README.md

@@ -0,0 +1 @@
+This is a place for your bots.

data/bot/dummy_bot.rb

@@ -0,0 +1,50 @@
+module Bot
+   
+  class DummyBot < BitPoker::BotInterface
+     
+     def initialize
+        @prng = Random.new # Init Pseudo-Random Number Generator
+     end
+     
+     def introduce( rules )
+        @min_card = rules["min_card"]
+        @max_card = rules["max_card"]
+        @max_stake = rules["max_stake"]
+        @timeout = rules["timeout"]
+     end
+     
+     def get_card( card )
+        # @card = card - I could do that, but I won't.
+     end
+     
+     def bet_one( min_stake )
+       @prng.rand( min_stake .. @max_stake ) # Bet random number, no logic here :)
+     end
+     
+     def agree_one( opponent_stake )
+        [true, false].sample # Call it or not. It's all to PRNG
+     end
+
+     def bet_two( min_stake )
+        @prng.rand( min_stake .. @max_stake )
+     end
+
+     def agree_two( opponent_stake )
+        [true, false].sample
+     end
+
+     def showdown( opponent_card )
+        # I could here analyze opponent's strategy, but I'm to dummy for that!
+     end
+
+     def end_of_round( score )
+        # Is it good idea to keep score history?
+     end
+
+     def end_of_duel( total_score, opponent_score )
+        # Finally, it's over!
+     end
+     
+  end
+  
+end

data/lib/bitpoker.rb

@@ -0,0 +1,61 @@
+require "timeout"
+require "parallel"
+
+require_relative 'bitpoker/bot_interface'
+require_relative 'bitpoker/bot_proxy_interface'
+require_relative 'bitpoker/bot_proxy'
+require_relative 'bitpoker/rules'
+require_relative 'bitpoker/game_logic'
+require_relative 'bitpoker/croupier'
+require_relative 'bitpoker/duel'
+require_relative 'bitpoker/round'
+
+# Great game of the BitPoker
+#
+# @author Mckomo
+module BitPoker
+   
+   VERSION = "0.1.1"
+   
+   # Load bot from file
+   #
+   # @raise ArrgumentError
+   # @param bot_file [String]
+   # @return [BotInterface]
+   def self.load_bot( bot_file, bot_dir = "./bot", module_prefix = "Bot" )
+   
+      # Get path to bot file
+      bot_path = "#{bot_dir}/#{bot_file}.rb"      
+      
+      # Raise exception if bot's file doesn't exist
+      raise ArgumentError, "Bot \"#{bot_file}\" does not exist in path \"#{bot_path}\"." unless File.exist?( bot_path )
+      
+      # Load bot
+      require bot_path
+      
+      # Convert file name to class name
+      module_prefix += "::" unless ! module_prefix or module_prefix.empty? 
+      klass_name = bot_file.split( '_' ).map { |s| s.capitalize }.join  
+      klass = Kernel.const_get( "#{module_prefix}#{klass_name}" )
+      
+      # Check if bot class implements BotInterface
+      raise ArgumentError, "Bot \"#{bot_file}\" does not implement BotInterface." unless klass.ancestors.include?( BitPoker::BotInterface )
+      
+      # Init bot
+      klass.new
+      
+   end
+   
+   # Exception raised when a bot breaks rules of the BitPoker
+   class BotError < RuntimeError
+      
+      attr_reader :bot
+      
+      def initialize( bot, message = "" )
+         super( message )
+         @bot = bot
+      end
+      
+   end
+   
+end

data/lib/bitpoker/bot_interface.rb

@@ -0,0 +1,99 @@
+module BitPoker
+   
+   class BotInterface
+      
+      # Name of the bot (should be a class name)
+      #
+      # @return [String]
+      def name
+         self.class.to_s.split( '::' ).last
+      end
+      
+      # Bot gets to know about duel rules
+      #  Rules hash have following structure:
+      #     {
+      #           "min_card"  => ?, - Minimal value from a card range
+      #           "max_card"  => ?, - Maximal value from the card range
+      #           "max_stake" => ? - Maximal stake value to set during betting rounds
+      #           "timeout"   => ?, - Maximal duration (in seconds) of bot response
+      #     }
+      # @param    [Hash]      rules 
+      # @return   [NilKlass]  Response is not required
+      def introduce( rules )
+         raise NotImplementedError
+      end
+      
+      # Bot receives card from a croupier
+      # 
+      # @param    [Integer]   card  Random number from the card range
+      # @param    [Integer]   card  Minimal number from the card range
+      # @param    [Integer]   card  Maximal number from the card range
+      # @return   [NilKlass]  Response is not required
+      def get_card( card )
+         raise NotImplementedError
+      end
+      
+      # Bot decides on a first bet
+      # 
+      # @param    [Integer]   min_stake   Minimal stake to bet
+      # @return   [Integer]   Bet value that is a number from range (min_stake; max_stake)
+      def bet_one( min_stake )
+         raise NotImplementedError
+      end
+      
+      # Bot decides whether to call opponent's bet after first betting
+      # 
+      # @param    [Integer]   stake_to_call  Opponent's bet after betting round
+      # @return   [Mixed]     True of false
+      def agree_one( stake_to_call )
+         raise NotImplementedError
+      end
+
+      # Bot decides on a second bet
+      # 
+      # @param    [Integer]   min_stake   Minimal stake to bet
+      # @return   [Integer]   Bet value that is a number from range (min_stake; max_stake)
+      def bet_two( min_stake )
+         raise NotImplementedError
+      end
+      
+      # Bot decides whether to call opponent's stake after second betting
+      # 
+      # @param    [Integer]   stake_to_call  Opponent's bet 
+      # @return   [Mixed]     True of false
+      def agree_two( stake_to_call )
+         raise NotImplementedError
+      end
+      
+      # Bot gets to know about opponent's card 
+      #
+      # @param    [Integer]   opponent_card
+      # @return   [NilKlass]  Response is not required
+      def showdown( opponent_card )
+         raise NotImplementedError
+      end
+      
+      # Bot receives his score after round 
+      #  0 when round ended with draw,
+      #  - last_bet_value when folded or lost
+      #  + opponent_last_bet_value when opponent folded
+      #  + last_bet_value or when won in a showdown
+      #
+      # @param    [Integer]   
+      # @return   [NilKlass]  Response is not required
+      def end_of_round( score )
+          raise NotImplementedError
+      end
+      
+      # Bot receives result of a duel when it is over
+      #
+      # @param    [Integer]   total_score    Total score received in the duel
+      # @param    [Integer]   opponent_score Total score received by a opponent
+      # @return   [NilKlass]  Response is not required
+      def end_of_duel( total_score, opponent_score )
+          raise NotImplementedError
+      end
+      
+   end
+   
+end

data/lib/bitpoker/bot_proxy.rb

@@ -0,0 +1,21 @@
+module BitPoker
+   
+   #
+   #
+   # @author Mckomo
+   class BotProxy
+      
+      include BotProxyInterface
+      
+      def initialize( bot )
+         raise ArgumentError unless bot.kind_of?( BitPoker::BotInterface )
+         @bot = bot
+      end
+      
+      def trigger( action, args = [] )
+         @bot.send( action, *args )
+      end
+      
+   end
+   
+end

data/lib/bitpoker/bot_proxy_interface.rb

@@ -0,0 +1,18 @@
+module BitPoker
+   
+   module BotProxyInterface
+      
+      # Trigger bot action
+      #
+      # @raise TCPoker::BotError
+      # @param bot [String]
+      # @param action [String]
+      # @param args [Array]
+      # @return [Mixed]
+      def trigger( action, args = [] )
+         raise NotImplementedError
+      end
+   
+   end
+   
+end