acpc_poker_basic_proxy 0.0.3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e362ce7f2796d6a1dc1b1905e9651abf064ac4ca
+  data.tar.gz: 61a6d8823a269da8e878fc79a82c5f8a519ea6a8
+SHA512:
+  metadata.gz: c2d00ac00fdb9190c10f1bf1ecbac9a15eae3e75dc4877ad224dc5da70c89b04e73b85fb1f6e0b54f56006413fc0fa474370a609648bb223c38f6761cc7ed99f
+  data.tar.gz: e9974f98efcd84cec40a42dcb4699efb781a2470a6339e38dd0da7c2f3a4a1caf3690f388da44a4e8a55a171b461c88baf1d4b2031b4d305e9ea630cedb7e29f

data/Rakefile

@@ -1,32 +1,12 @@
-require 'bundler/gem_tasks'
-require 'rake'
-require 'rspec/core/rake_task'
-
-require File.expand_path('../lib/acpc_poker_basic_proxy/version', __FILE__)
-require File.expand_path('../tasks', __FILE__)
-
-include Tasks
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-   ruby_opts = "-w"
-end
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
-task :build => :spec do
-   system "gem build acpc_poker_basic_proxy.gemspec"
-end
+require 'rake'
+require 'rake/testtask'
 
-task :tag => :build do
-   tag_gem_version AcpcPokerBasicProxy::VERSION
+Rake::TestTask.new do |t|
+  t.libs << "lib" << 'spec/support'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = false
+  t.warning = false # pry-rescue has a lot of warnings
 end
-
-#desc "release gem to gemserver"
-#task :release => [:tag, :deploy] do
-#  puts "congrats, the gem is now tagged, pushed, deployed and released! Rember to up the VERSION number"
-#end
-
-#task :deploy do
-#  puts "Deploying to gemserver@mygemserver.mycompany.com"
-#  system "scp my_private_gem-#{AcpcPokerType::VERSION}.gem gemserver@mygemserver.mycompany.com:gems/."
-#  puts "installing on gemserver"
-#  system "ssh gemserver@mygemserver.mycompany.com \"cd gems && gem install my_private_gem-#{AcpcPokerType::VERSION}.gem --ignore-dependencies\""
-#end

data/acpc_poker_basic_proxy.gemspec

@@ -9,19 +9,22 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/dmorrill10/acpc_poker_basic_proxy"
   s.summary     = %q{ACPC Poker Basic Proxy}
   s.description = %q{Basic proxy to connect to the ACPC Dealer.}
-  
-  s.add_dependency 'acpc_poker_types'
-  s.add_dependency 'dmorrill10-utils'
-  
+
+  s.add_dependency 'acpc_poker_types', '~> 3.0'
+  s.add_dependency 'dmorrill10-utils', '~> 1.0'
+
   s.rubyforge_project = "acpc_poker_basic_proxy"
 
-  s.files         = Dir.glob("lib/**/*") + Dir.glob("ext/**/*") + %w(Rakefile acpc_poker_basic_proxy.gemspec tasks.rb README.md)
+  s.files         = Dir.glob("lib/**/*") + Dir.glob("ext/**/*") + %w(Rakefile acpc_poker_basic_proxy.gemspec README.md)
   s.test_files    = Dir.glob "spec/**/*"
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'mocha'
-  s.add_development_dependency 'simplecov'
-  s.add_development_dependency 'acpc_dealer_data'
-  s.add_development_dependency 'acpc_dealer'
+  s.add_development_dependency 'turn', '~> 0.9'
+  s.add_development_dependency 'minitest', '~> 4.7'
+  s.add_development_dependency 'mocha', '~> 0.13'
+  s.add_development_dependency 'acpc_dealer', '~> 0.0'
+  s.add_development_dependency 'awesome_print', '~> 1.0'
+  s.add_development_dependency 'pry-rescue', '~> 1.0'
+  s.add_development_dependency 'simplecov', '~> 0.7'
+  s.add_development_dependency 'acpc_dealer', '~> 0.0'
 end

data/lib/acpc_poker_basic_proxy.rb

@@ -1,10 +1,6 @@
-require File.expand_path("../acpc_poker_basic_proxy/version", __FILE__)
+require 'acpc_poker_basic_proxy/version'
 
-require File.expand_path("../acpc_poker_basic_proxy/basic_proxy", __FILE__)
-require File.expand_path("../acpc_poker_basic_proxy/communication_logic/acpc_dealer_communicator", __FILE__)
-require File.expand_path("../acpc_poker_basic_proxy/communication_logic/acpc_dealer_information", __FILE__)
-require File.expand_path("../acpc_poker_basic_proxy/communication_logic/match_state_receiver", __FILE__)
-require File.expand_path("../acpc_poker_basic_proxy/communication_logic/action_sender", __FILE__)
+require 'acpc_poker_basic_proxy/basic_proxy'
 
 module AcpcPokerBasicProxy
 end

data/lib/acpc_poker_basic_proxy/basic_proxy.rb

@@ -1,29 +1,31 @@
 
-require File.expand_path('../communication_logic/acpc_dealer_communicator', __FILE__)
-require File.expand_path('../communication_logic/acpc_dealer_information', __FILE__)
-require File.expand_path('../communication_logic/action_sender', __FILE__)
-require File.expand_path('../communication_logic/match_state_receiver', __FILE__)
+require 'acpc_poker_basic_proxy/communication_logic/acpc_dealer_communicator'
+require 'acpc_poker_basic_proxy/communication_logic/acpc_dealer_information'
+require 'acpc_poker_basic_proxy/communication_logic/action_sender'
+require 'acpc_poker_basic_proxy/communication_logic/match_state_receiver'
 
 # A bot that connects to a dealer as a proxy.
-class BasicProxy
-  exceptions :initial_match_state_not_yet_received
+module AcpcPokerBasicProxy
+  class BasicProxy
+    exceptions :initial_match_state_not_yet_received
 
-  # @param [AcpcDealerInformation] dealer_information Information about the dealer to which this bot should connect.
-  def initialize(dealer_information)
-    @dealer_communicator = AcpcDealerCommunicator.new dealer_information.port_number, dealer_information.host_name, dealer_information.millisecond_response_timeout
-  end
+    # @param [AcpcDealerInformation] dealer_information Information about the dealer to which this bot should connect.
+    def initialize(dealer_information)
+      @dealer_communicator = CommunicationLogic::AcpcDealerCommunicator.new dealer_information.port_number, dealer_information.host_name, dealer_information.millisecond_response_timeout
+    end
 
-  # @param [PokerAction] action The action to be sent.
-  # @return (see ActionSender#send_action)
-  # @raise InitialMatchStateNotYetReceived
-  # @raise (see ActionSender#send_action)
-  def send_action(action)
-    raise InitialMatchStateNotYetReceived unless @match_state
-    ActionSender.send_action @dealer_communicator, @match_state, action
-  end
+    # @param [PokerAction] action The action to be sent.
+    # @return (see ActionSender#send_action)
+    # @raise InitialMatchStateNotYetReceived
+    # @raise (see ActionSender#send_action)
+    def send_action(action)
+      raise InitialMatchStateNotYetReceived unless @match_state
+      CommunicationLogic::ActionSender.send_action @dealer_communicator, @match_state, action
+    end
 
-  # @see MatchStateReceiver#receive_match_state
-  def receive_match_state!
-    @match_state = MatchStateReceiver.receive_match_state @dealer_communicator
+    # @see MatchStateReceiver#receive_match_state
+    def receive_match_state!
+      @match_state = CommunicationLogic::MatchStateReceiver.receive_match_state @dealer_communicator
+    end
   end
-end
+end

data/lib/acpc_poker_basic_proxy/communication_logic.rb

@@ -0,0 +1,9 @@
+require 'acpc_poker_basic_proxy/communication_logic/acpc_dealer_communicator'
+require 'acpc_poker_basic_proxy/communication_logic/acpc_dealer_information'
+require 'acpc_poker_basic_proxy/communication_logic/match_state_receiver'
+require 'acpc_poker_basic_proxy/communication_logic/action_sender'
+
+module AcpcPokerBasicProxy
+  module CommunicationLogic
+  end
+end

data/lib/acpc_poker_basic_proxy/communication_logic/acpc_dealer_communicator.rb

@@ -2,122 +2,126 @@
 require 'socket'
 require 'dmorrill10-utils/class'
 
-require File.expand_path('../../mixins/socket_with_ready_methods', __FILE__)
+require 'acpc_poker_basic_proxy/mixins/socket_with_ready_methods'
 
 # Communication service to the ACPC Dealer.
 # It acts solely as an abstraction of the communication protocol and
 # implements the main Ruby communication interface through 'gets' and 'puts'
 # methods.
-class AcpcDealerCommunicator
-  exceptions :acpc_dealer_connection_error, :put_to_acpc_dealer_error, :get_from_acpc_dealer_error
-
-  # @return [String] The ACPC dealer version label.
-  VERSION_LABEL = 'VERSION'
-  
-  # @return [Hash] The ACPC dealer version numbers.
-  VERSION_NUMBERS = {:major => 2, :minor => 0, :revision => 0}
-   
-  # @return [String] Dealer specified string terminator.
-  TERMINATION_STRING = "\r\n"
-
-  # @param [Integer] port The port on which to connect to the dealer.
-  # @param [String] host_name The host on which the dealer is running.
-  # @param [Integer] millisecond_response_timeout The dealer's response timeout, in milleseconds.
-  # @raise AcpcDealerConnectionError, PutToAcpcDealerError
-  def initialize(port, host_name='localhost', millisecond_response_timeout=nil)
-    begin
-      @dealer_socket = TCPSocket.new(host_name, port)
-      @response_timeout_in_seconds = if millisecond_response_timeout
-        millisecond_response_timeout/(10**3)
-      else
-        nil
+module AcpcPokerBasicProxy
+  module CommunicationLogic
+    class AcpcDealerCommunicator
+      exceptions :acpc_dealer_connection_error, :put_to_acpc_dealer_error, :get_from_acpc_dealer_error
+
+      # @return [String] The ACPC dealer version label.
+      VERSION_LABEL = 'VERSION'
+
+      # @return [Hash] The ACPC dealer version numbers.
+      VERSION_NUMBERS = {:major => 2, :minor => 0, :revision => 0}
+
+      # @return [String] Dealer specified string terminator.
+      TERMINATION_STRING = "\r\n"
+
+      # @param [Integer] port The port on which to connect to the dealer.
+      # @param [String] host_name The host on which the dealer is running.
+      # @param [Integer] millisecond_response_timeout The dealer's response timeout, in milleseconds.
+      # @raise AcpcDealerConnectionError, PutToAcpcDealerError
+      def initialize(port, host_name='localhost', millisecond_response_timeout=nil)
+        begin
+          @dealer_socket = TCPSocket.new(host_name, port)
+          @response_timeout_in_seconds = if millisecond_response_timeout
+            millisecond_response_timeout/(10**3)
+          else
+            nil
+          end
+          send_version_string_to_dealer
+        rescue PutToAcpcDealerError
+          raise
+        rescue
+          handle_error AcpcDealerConnectionError, "Unable to connect to the dealer on #{host_name} through port #{port}: #{$?}"
+        end
       end
-      send_version_string_to_dealer
-    rescue PutToAcpcDealerError
-      raise
-    rescue
-      handle_error AcpcDealerConnectionError, "Unable to connect to the dealer on #{host_name} through port #{port}: #{$?}"
-    end
-  end
 
-  # Closes the connection to the dealer.
-  def close
-    @dealer_socket.close if @dealer_socket
-  end
+      # Closes the connection to the dealer.
+      def close
+        @dealer_socket.close if @dealer_socket
+      end
 
-  # Retrieves a string from the dealer.
-  #
-  # @return [String] A string from the dealer.
-  # @raise GetFromAcpcDealerError
-  def gets
-    begin
-      raw_match_state = string_from_dealer
-    rescue
-      handle_error GetFromAcpcDealerError, "Unable to get a string from the dealer: #{$?}"
-    end
-    raw_match_state
-  end
+      # Retrieves a string from the dealer.
+      #
+      # @return [String] A string from the dealer.
+      # @raise GetFromAcpcDealerError
+      def gets
+        begin
+          raw_match_state = string_from_dealer
+        rescue
+          handle_error GetFromAcpcDealerError, "Unable to get a string from the dealer: #{$?}"
+        end
+        raw_match_state
+      end
 
-  # Sends a given +string+ to the dealer.
-  #
-  # @param [String] string The string to send.
-  # @return (see #send_string_to_dealer)
-  # @raise WriteToAcpcDealerError
-  def write(string)
-    begin
-      bytes_written = send_string_to_dealer string
-    rescue
-      handle_error GetFromAcpcDealerError, "Unable to send the string, \"#{string}\", to the dealer: #{$?}."
-    end
-    bytes_written
-  end
+      # Sends a given +string+ to the dealer.
+      #
+      # @param [String] string The string to send.
+      # @return (see #send_string_to_dealer)
+      # @raise WriteToAcpcDealerError
+      def write(string)
+        begin
+          bytes_written = send_string_to_dealer string
+        rescue
+          handle_error GetFromAcpcDealerError, "Unable to send the string, \"#{string}\", to the dealer: #{$?}."
+        end
+        bytes_written
+      end
 
-  # @see TCPSocket#ready_to_write?
-  def ready_to_write?
-    @dealer_socket.ready_to_write? @response_timeout_in_seconds
-  end
+      # @see TCPSocket#ready_to_write?
+      def ready_to_write?
+        @dealer_socket.ready_to_write? @response_timeout_in_seconds
+      end
 
-  # @see TCPSocket#ready_to_read?
-  def ready_to_read?
-    @dealer_socket.ready_to_read? @response_timeout_in_seconds
-  end
+      # @see TCPSocket#ready_to_read?
+      def ready_to_read?
+        @dealer_socket.ready_to_read? @response_timeout_in_seconds
+      end
 
-  private
+      private
 
-  def handle_error(exception, message)
-    close
-    raise exception, message
-  end
+      def handle_error(exception, message)
+        close
+        raise exception, message
+      end
 
-  # @return (see #send_string_to_dealer)
-  def send_version_string_to_dealer
-    version_string = "#{VERSION_LABEL}:#{VERSION_NUMBERS[:major]}.#{VERSION_NUMBERS[:minor]}.#{VERSION_NUMBERS[:revision]}"
-    begin
-      bytes_written = send_string_to_dealer version_string
-    rescue
-      handle_error PutToAcpcDealerError, "Unable to send version string, \"#{version_string}\", to the dealer"
-    end
-    bytes_written
-  end
+      # @return (see #send_string_to_dealer)
+      def send_version_string_to_dealer
+        version_string = "#{VERSION_LABEL}:#{VERSION_NUMBERS[:major]}.#{VERSION_NUMBERS[:minor]}.#{VERSION_NUMBERS[:revision]}"
+        begin
+          bytes_written = send_string_to_dealer version_string
+        rescue
+          handle_error PutToAcpcDealerError, "Unable to send version string, \"#{version_string}\", to the dealer"
+        end
+        bytes_written
+      end
 
-  # @return [Integer] The number of bytes written to the dealer.
-  def send_string_to_dealer(string)
-    raise unless ready_to_write?
-    begin
-      bytes_written = @dealer_socket.write(string + TERMINATION_STRING)
-    rescue
-      raise
-    end
-    bytes_written
-  end
+      # @return [Integer] The number of bytes written to the dealer.
+      def send_string_to_dealer(string)
+        raise unless ready_to_write?
+        begin
+          bytes_written = @dealer_socket.write(string + TERMINATION_STRING)
+        rescue
+          raise
+        end
+        bytes_written
+      end
 
-  def string_from_dealer
-    raise unless ready_to_read?
-    begin
-      string = @dealer_socket.gets.chomp
-    rescue
-      raise
+      def string_from_dealer
+        raise unless ready_to_read?
+        begin
+          string = @dealer_socket.gets.chomp
+        rescue
+          raise
+        end
+        string
+      end
     end
-    string
   end
-end
+end

data/lib/acpc_poker_basic_proxy/communication_logic/acpc_dealer_information.rb

@@ -1,18 +1,22 @@
 
 # Information about a dealer instance.
-class AcpcDealerInformation
-  # @return [String] The host name of the dealer associated with this table.
-  attr_reader :host_name
+module AcpcPokerBasicProxy
+  module CommunicationLogic
+    class AcpcDealerInformation
+      # @return [String] The host name of the dealer associated with this table.
+      attr_reader :host_name
 
-  # @return [Integer] The port number of the dealer associated with this table.
-  attr_reader :port_number
+      # @return [Integer] The port number of the dealer associated with this table.
+      attr_reader :port_number
 
-  # @return [Integer] The dealer's response timeout.
-  attr_reader :millisecond_response_timeout
+      # @return [Integer] The dealer's response timeout.
+      attr_reader :millisecond_response_timeout
 
-  def initialize(host_name, port_number, millisecond_response_timeout=nil)
-    @host_name = host_name
-    @port_number = port_number
-    @millisecond_response_timeout = millisecond_response_timeout
+      def initialize(host_name, port_number, millisecond_response_timeout=nil)
+        @host_name = host_name
+        @port_number = port_number
+        @millisecond_response_timeout = millisecond_response_timeout
+      end
+    end
   end
-end
+end

data/lib/acpc_poker_basic_proxy/communication_logic/action_sender.rb

@@ -1,41 +1,43 @@
 
 require 'dmorrill10-utils/class'
 require 'acpc_poker_types/poker_action'
-require 'acpc_poker_types/rank'
-require 'acpc_poker_types/suit'
+require 'acpc_poker_types/match_state'
 
 # Sends poker actions according to the ACPC protocol.
-class ActionSender
-
-  exceptions :illegal_action_format
-
-  # Sends the given +action+ to through the given +connection+ in the ACPC
-  # format.
-  # @param [#write, #ready_to_write?] connection The connection through which the +action+
-  #  should be sent.
-  # @param [#to_s] match_state The current match state.
-  # @param [#to_acpc] action The action to be sent through the +connection+.
-  # @return [Integer] The number of bytes written.
-  # @raise (see #validate_match_state)
-  # @raise (see #validate_action)
-  def self.send_action(connection, match_state, action)
-    validate_action action
-
-    full_action = "#{MatchState.parse(match_state.to_s)}:#{action.to_acpc}"
-    connection.write full_action
+module AcpcPokerBasicProxy
+  module CommunicationLogic
+    class ActionSender
+      exceptions :illegal_action_format
+
+      CONCATENATED_MODIFIABLE_ACTIONS = AcpcPokerTypes::PokerAction::MODIFIABLE_ACTIONS.to_a.join
+
+      # Sends the given +action+ to through the given +connection+ in the ACPC
+      # format.
+      # @param [#write, #ready_to_write?] connection The connection through which the +action+
+      #  should be sent.
+      # @param [#to_s] match_state The current match state.
+      # @param [#to_s] action The action to be sent through the +connection+.
+      # @return [Integer] The number of bytes written.
+      # @raise (see #validate_match_state)
+      # @raise (see #validate_action)
+      def self.send_action(connection, match_state, action)
+        validate_action action
+
+        full_action = "#{AcpcPokerTypes::MatchState.parse(match_state.to_s)}:#{action.to_s}"
+        connection.write full_action
+      end
+
+      private
+
+      # @raise IllegalActionFormat
+      def self.validate_action(action)
+        raise IllegalActionFormat unless self.valid_action?(action)
+      end
+
+      def self.valid_action?(action)
+        action.to_s.match(/^[#{AcpcPokerTypes::PokerAction::CONCATONATED_ACTIONS}]$/) ||
+        action.to_s.match(/^[#{CONCATENATED_MODIFIABLE_ACTIONS}]\d+$/)
+      end
+    end
   end
-
-  private
-
-  # @raise IllegalActionFormat
-  def self.validate_action(action)
-    raise IllegalActionFormat unless self.valid_action?(action)
-  end
-
-  def self.valid_action?(action)
-    all_actions = PokerAction::LEGAL_ACPC_CHARACTERS.to_a.join('')
-    modifiable_actions = PokerAction::MODIFIABLE_ACTIONS.values.to_a.join('')
-
-    action.to_acpc.match(/^[#{all_actions}]$/) || action.to_acpc.match(/^[#{modifiable_actions}]\d+$/)
-  end
-end
+end