client_for_poslynx 0.3.0 → 0.9.0

data/lib/client_for_poslynx/fake_pos_terminal.rb

@@ -1,12 +1,12 @@
 # coding: utf-8
 
 require 'client_for_poslynx'
-require_relative 'fake_pos_terminal/format'
-require_relative 'fake_pos_terminal/console_user_interface'
-require_relative 'fake_pos_terminal/server'
-require_relative 'fake_pos_terminal/request_dispatcher'
+require_relative 'fake_pos_terminal/value_formatting'
+require_relative 'fake_pos_terminal/context'
 require_relative 'fake_pos_terminal/result_assemblers'
-require_relative 'fake_pos_terminal/request_handlers'
+require_relative 'fake_pos_terminal/console_user_interface'
+require_relative 'fake_pos_terminal/net_handler'
+require_relative 'fake_pos_terminal/keyboard_handler'
 
 module ClientForPoslynx
 
@@ -17,9 +17,33 @@ module ClientForPoslynx
   module FakePosTerminal
 
     def self.start(port_number)
-      user_interface = ConsoleUserInterface.new
-      server = Server.new(port_number, user_interface)
-      server.start
+      context = self::Context.new
+      context.port_number = port_number
+
+      user_interface = self::ConsoleUserInterface.new( context )
+      user_interface.engage
+      user_interface.show_starting_up
+
+      EM.run do
+        EM.start_server(
+          "127.0.0.1", port_number, self::NetHandler,
+          user_interface
+        )
+
+        EM.open_keyboard(
+          self::KeyboardHandler,
+          user_interface
+        )
+
+        EM.error_handler do |e|
+          raise e
+        end
+
+        user_interface.client_disconnected
+      end
+
+    ensure
+      user_interface.disengage if user_interface
     end
 
   end

data/lib/client_for_poslynx/message_handling/xml_extractor.rb

@@ -3,6 +3,10 @@
 module ClientForPoslynx
   module MessageHandling
 
+    # TODO: This is now obsolete and being replaced by a combina-
+    # tion of EventMachine's LineProtocol and XmlLinesBuffer.
+    # This class should be removed as soon as the fake POS
+    # terminal code has been re-built as an EM server.
     class XmlExtractor
       attr_reader :stream
 

data/lib/client_for_poslynx/message_handling/xml_lines_buffer.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+module ClientForPoslynx
+  module MessageHandling
+
+    class XmlLinesBuffer
+      def initialize
+        reset
+      end
+
+      def add_line(line)
+        message << line
+        if (! root_name) && line =~ /^(?:<\?.+?\?>)?<([A-Za-z_][^\s>]*)[ >]/
+          self.root_name = $1
+        end
+        if root_name && line =~ /<\/#{root_name}\s*>\s*$/
+          complete_message = message
+          reset
+          yield complete_message
+        end
+      end
+
+      private
+
+      attr_reader   :message
+      attr_accessor :root_name
+
+      def reset
+        @message   = ''
+        @root_name = nil
+      end
+    end
+
+  end
+end

data/lib/client_for_poslynx/message_handling.rb

@@ -3,6 +3,7 @@
 require_relative 'message_handling/xml_extractor'
 require_relative 'message_handling/data_extractor'
 require_relative 'message_handling/stream_data_writer'
+require_relative 'message_handling/xml_lines_buffer'
 
 module ClientForPoslynx
 

data/lib/client_for_poslynx/net/em_protocol.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+require 'eventmachine'
+
+module EventMachine
+  module Protocols
+
+    # Sends requests to and receives responses from a Precidia
+    # POSLynx system over TCP/IP.
+    module POSLynx
+      include EM::Protocols::LineProtocol
+
+      # Called by user code to send a request to the POSLynx
+      # system.
+      # The request object is expected to behave like an
+      # instance of a descendant class of
+      # ClientForPoslynx::Data::Requests::AbstractRequest.
+      def send_request(request)
+        serial_data = request.xml_serialize
+        send_data serial_data
+      end
+
+      # Invoked with responses received from the POSLynx system.
+      # Each response will be an instance of a descendent class
+      # of
+      # ClientForPoslynx::Data::Responses::AbstractResponse.
+      def receive_response(response)
+        # stub
+      end
+
+      # @private
+      def receive_line(line)
+        _response_buffer.add_line line do |complete_message|
+          response = ClientForPoslynx::Data::AbstractData.xml_parse( complete_message )
+          receive_response response
+        end
+      end
+
+      # @private
+      def _response_buffer
+        @_response_buffer ||= ClientForPoslynx::MessageHandling::XmlLinesBuffer.new
+      end
+    end
+
+  end
+end

data/lib/client_for_poslynx/net/structured_client/em_connection.rb

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+require 'eventmachine'
+
+module ClientForPoslynx
+  module Net
+    class StructuredClient
+
+      class EM_Connection < EM::Connection
+        include EM::Protocols::POSLynx
+
+        attr_reader :use_ssl, :directive_queue, :activity_queue
+
+        def initialize(use_ssl, directive_queue, activity_queue)
+          @use_ssl         = use_ssl
+          @directive_queue = directive_queue
+          @activity_queue  = activity_queue
+        end
+
+        def connection_completed
+          if use_ssl
+            start_tls verify_peer: false
+          else
+            handle_next_directive
+          end
+        end
+
+        def ssl_handshake_completed
+          handle_next_directive
+        end
+
+        def unbind
+          EM.stop_event_loop
+        end
+
+        def receive_response(response)
+          activity_queue << [ :received_response, response ]
+        end
+
+        def handle_next_directive
+          EM.defer(
+            ->{ directive_queue.shift },
+            ->(directive){
+              process_directive directive
+            }
+          )
+        end
+
+        def process_directive(directive)
+          kind, *args = Array( directive )
+          case kind
+          when :end_session
+            end_session
+          when :send_request
+            begin
+              send_request *args
+            ensure
+              handle_next_directive
+            end
+          end
+        end
+
+        def end_session
+          after_writing = true
+          close_connection after_writing
+        end
+
+      end
+
+    end
+  end
+end

data/lib/client_for_poslynx/net/structured_client.rb

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+require_relative 'structured_client/em_connection'
+
+module ClientForPoslynx
+  module Net
+
+    # A network client API suitable for use in a Structured (as
+    # oppoesed to Event-Driven) context such as from within an
+    # irb console session.
+    class StructuredClient
+
+      class SessionEndedError  < StandardError ; end
+      class SessionEndingError < StandardError ; end
+
+      # Initializes a new instance, given a host name or address
+      # and a host IP port number. If an SSL connection is
+      # required, then supply true for the use_ssl argument.
+      def initialize(host, port, use_ssl = false)
+        @directive_queue = Queue.new
+        @activity_queue  = Queue.new
+        @em_thread = Thread.new do
+          EM.run do
+            EM.connect host, port, EM_Connection, use_ssl, directive_queue, activity_queue
+            EM.error_handler do |e|
+              raise e
+            end
+          end
+        end
+      end
+
+      # Close the server connection if it is open and end the
+      # session managed by the receiving instance.
+      def end_session
+        return unless em_thread.status
+        directive_queue << :end_session
+        self.session_end_initiated = true
+        em_thread.join
+        nil
+      end
+
+      # Sends a request to the POSLynx system and returns
+      # immediately.
+      # The request object is expected to behave like an
+      # instance of a descendant class of
+      # ClientForPoslynx::Data::Requests::AbstractRequest.
+      def send_request(request_data)
+        if session_ended?
+          raise SessionEndedError, "The session has been closed and cannot be used to send requests"
+        elsif session_ending?
+          raise SessionEndingError, "The session is ending and cannot be used to send requests"
+        end
+        directive_queue << [ :send_request, request_data ]
+        nil
+      end
+
+      # Returns the next available received response, if any.
+      # Returns nil is there are no remaining received responses
+      # to get.
+      # Each response will be an instance of a descendent class
+      # of
+      # ClientForPoslynx::Data::Responses::AbstractResponse.
+      def get_response
+        process_new_activity
+        received_responses.shift
+      end
+
+      # Returns true if the managed session has ended, either
+      # as a result of a call to #end_session or because the
+      # connection was closed by the server or otherwise lost.
+      def session_ended?
+        ! em_thread.status
+      end
+
+      private
+
+      attr_reader :em_thread, :directive_queue, :activity_queue
+      attr_accessor :session_end_initiated
+
+      def session_ending?
+        session_end_initiated && ! session_ended?
+      end
+
+      def process_new_activity
+        until activity_queue.empty?
+          process_activity_entry *activity_queue.shift
+        end
+      end
+
+      def process_activity_entry(kind, data=nil)
+        case kind
+        when :received_response
+          received_responses << data
+        end
+      end
+
+      def received_responses
+        @received_responses ||= []
+      end
+
+    end
+
+  end
+end

data/lib/client_for_poslynx/net.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+
+require_relative 'net/em_protocol'
+require_relative 'net/structured_client'
+
+module ClientForPoslynx
+
+  module Net
+  end
+
+end

data/lib/client_for_poslynx/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module ClientForPoslynx
-  VERSION = '0.3.0'
+  VERSION = '0.9.0'
 end

data/lib/client_for_poslynx.rb

@@ -5,6 +5,8 @@ require "client_for_poslynx/data"
 require "client_for_poslynx/message_handling"
 require "client_for_poslynx/bit_sequence"
 require "client_for_poslynx/signature_image"
+require "client_for_poslynx/net"
+require "client_for_poslynx/example_request_factory"
 
 module ClientForPoslynx
 

data/spec/client_for_poslynx/data/requests/credit_card_sale_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Requests::CreditCardSale do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a request data object"
 
     it "Serializes to an XML document for a CCSALE request" do
       mac = Data::Requests::DEFAULT_CLIENT_MAC

data/spec/client_for_poslynx/data/requests/debit_card_sale_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Requests::DebitCardSale do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a request data object"
 
     it "Serializes to an XML document for a DCSALE request" do
       mac = Data::Requests::DEFAULT_CLIENT_MAC

data/spec/client_for_poslynx/data/requests/pin_pad_display_message_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Requests::PinPadDisplayMessage do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a request data object"
 
     it "Serializes to a PLRequest XML document for a PPDISPLAY request" do
       mac = Data::Requests::DEFAULT_CLIENT_MAC

data/spec/client_for_poslynx/data/requests/pin_pad_display_specified_form_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Requests::PinPadDisplaySpecifiedForm do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a request data object"
 
     it "Serializes to an XML document for a PPSPECIFIEDFORM request" do
       mac = Data::Requests::DEFAULT_CLIENT_MAC

data/spec/client_for_poslynx/data/requests/pin_pad_get_signature_spec.rb

@@ -6,7 +6,7 @@ module ClientForPoslynx
 
   describe Data::Requests::PinPadGetSignature do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a request data object"
 
     it "Serializes to a PLRequest XML document for a PPGETSIGNATURE request" do
       mac = Data::Requests::DEFAULT_CLIENT_MAC

data/spec/client_for_poslynx/data/requests/pin_pad_initialize_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Requests::PinPadInitialize do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a request data object"
 
     it "Serializes to a PLRequest XML document for a CCSALE request" do
       mac = Data::Requests::DEFAULT_CLIENT_MAC

data/spec/client_for_poslynx/data/requests/pin_pad_reset_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+module ClientForPoslynx
+
+  describe Data::Requests::PinPadReset do
+
+    it_behaves_like "a request data object"
+
+    it "Serializes to a PLRequest XML document for a PPRESET request" do
+      mac = Data::Requests::DEFAULT_CLIENT_MAC
+      expected_xml =
+        "<PLRequest><Command>PPRESET</Command><ClientMAC>#{mac}</ClientMAC></PLRequest>\n"
+
+      expect( subject.xml_serialize ).to eq( expected_xml )
+    end
+
+
+    it "Serializes all assigned members to appropriate elements" do
+      subject.client_mac  = 'the-mac'
+
+      expected_xml =
+        "<PLRequest><Command>PPRESET</Command><ClientMAC>the-mac</ClientMAC></PLRequest>\n"
+
+      expect( subject.xml_serialize ).to eq( expected_xml )
+    end
+
+
+    it "parses XML data" do
+      xml_input = <<-XML
+<PLRequest>
+  <Command>PPRESET</Command>
+</PLRequest>
+      XML
+
+      actual_instance = described_class.xml_deserialize xml_input
+    end
+
+
+    it "accepts a canonical visitor" do
+      visitor = Object.new
+      visitor.extend Data::Requests::CanVisit
+      expect{ subject.accept_visitor visitor }.not_to raise_exception
+    end
+
+    it "sends itself to an accepted visitor" do
+      visitor = double :visitor
+      expect( visitor ).to receive( :visit_PinPadReset ).with( subject )
+      subject.accept_visitor visitor
+    end
+
+  end
+
+end

data/spec/client_for_poslynx/data/responses/credit_card_sale_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Responses::CreditCardSale do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a response data object"
 
     # At least one revision of the POSLynx returns signature
     # data surrounded by &lt[CDATA[...]]&gt which is obviously

data/spec/client_for_poslynx/data/responses/debit_card_sale_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Responses::DebitCardSale do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a response data object"
 
     it "Serializes to a PLResponse XML document for a DCSALE response" do
       expected_xml = "<PLResponse><Command>DCSALE</Command></PLResponse>\n"

data/spec/client_for_poslynx/data/responses/pin_pad_display_message_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Responses::PinPadGetSignature do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a response data object"
 
     it "Serializes to a PLResponse XML document for a PPGETSIGNATURE response" do
       expected_xml = "<PLResponse><Command>PPGETSIGNATURE</Command></PLResponse>\n"

data/spec/client_for_poslynx/data/responses/pin_pad_display_specified_form_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Responses::PinPadDisplaySpecifiedForm do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a response data object"
 
     it "Serializes to a PLResponse XML document for a PPSPECIFIEDFORM response" do
       expected_xml = "<PLResponse><Command>PPSPECIFIEDFORM</Command></PLResponse>\n"

data/spec/client_for_poslynx/data/responses/pin_pad_initialize_spec.rb

@@ -4,7 +4,7 @@ module ClientForPoslynx
 
   describe Data::Responses::PinPadInitialize do
 
-    it_behaves_like "a data object"
+    it_behaves_like "a response data object"
 
     it "Serializes to a PLResponse XML document for a PPINIT response" do
       expected_xml = "<PLResponse><Command>PPINIT</Command></PLResponse>\n"

data/spec/client_for_poslynx/data/responses/pin_pad_reset_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+module ClientForPoslynx
+
+  describe Data::Responses::PinPadReset do
+
+    it_behaves_like "a response data object"
+
+    it "Serializes to a PLResponse XML document for a PPRESET response" do
+      expected_xml = "<PLResponse><Command>PPRESET</Command></PLResponse>\n"
+      expect( subject.xml_serialize ).to eq( expected_xml )
+    end
+
+
+    it "Serializes all assigned members to appropriate elements" do
+      subject.result = 'the-result'
+      subject.result_text = 'the-text'
+      subject.error_code = 'the-code'
+
+      expected_xml =
+        "<PLResponse>" +
+          "<Command>PPRESET</Command>" +
+          "<Result>the-result</Result>" +
+          "<ResultText>the-text</ResultText>" +
+          "<ErrorCode>the-code</ErrorCode>" +
+        "</PLResponse>\n"
+
+      expect( subject.xml_serialize ).to eq( expected_xml )
+    end
+
+
+    it "parses minimally acceptable XML data" do
+      xml_input = <<-XML
+<PLResponse>
+  <Command>PPRESET</Command>
+</PLResponse>
+      XML
+
+      actual_instance = described_class.xml_deserialize xml_input
+      expect( actual_instance.result ).to be_nil
+    end
+
+
+    it "parses XML data with all property elements supplied" do
+      xml_input = <<-XML
+<PLResponse>
+  <Command>PPRESET</Command>
+  <Result>the-result</Result>
+  <ResultText>the-text</ResultText>
+  <ErrorCode>the-code</ErrorCode>
+</PLResponse>
+      XML
+
+      actual_instance = described_class.xml_deserialize xml_input
+
+      expect( actual_instance.result      ).to eq( 'the-result' )
+      expect( actual_instance.result_text ).to eq( 'the-text'   )
+      expect( actual_instance.error_code  ).to eq( 'the-code'   )
+    end
+
+
+  end
+
+end

data/spec/client_for_poslynx/net/em_protocol_spec.rb

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+require 'spec_helper'
+require 'stringio'
+
+module ClientForPoslynx
+
+  describe EM::Protocols::POSLynx do
+
+    let( :connection_class ) {
+      subj = subject
+      connection_class =
+        Class.new do
+          include subj
+
+          def send_data(data) ; end
+        end
+    }
+
+    let( :connection ) { connection_class.new }
+
+    it "sends a request" do
+      request = Data::Requests::PinPadDisplayMessage.new.tap do |req|
+        req.client_mac = 'cdef'
+      end
+
+      expect( connection ).to receive( :send_data ){ |serial_data|
+        got_data = Data::AbstractData.xml_parse( serial_data )
+        expect( got_data ).to be_kind_of( Data::Requests::PinPadDisplayMessage )
+        expect( got_data.client_mac ).to eq( 'cdef' )
+      }
+
+      connection.send_request request
+    end
+
+    it "receives a response" do
+      response = Data::Responses::PinPadDisplayMessage.new.tap do |req|
+        req.result = "Hooya"
+      end
+
+      expect( connection ).to receive( :receive_response ){ |got_data|
+        expect( got_data ).to be_kind_of( Data::Responses::PinPadDisplayMessage )
+        expect( got_data.result ).to eq( 'Hooya' )
+      }
+
+      connection.receive_data response.xml_serialize.rstrip
+      connection.receive_data "\n"
+    end
+
+  end
+
+end