client_for_poslynx 0.2.6 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzhiNDI0YzUzYjUzNTZjMTQ0ZDQ0ZmYzOTk1MmY2ZWUyNjY4ZjNlNw==
+    MDIyYTM1NTlkMTFhYTllNzI4ZDNlZjBlMGJjY2E3MzcxNjQ1ODJmNA==
   data.tar.gz: !binary |-
-    N2Y1MDE0NGU2NDczOWNiYzVjMTU0ODMwMWQ5MDNjNTM3NWE5NDVjNg==
+    ZGM2ODlhZmQ2ZDZiMWM5ODkwM2QyNjc4MTdmMzFhMGU4OTVkYmNmZg==
 SHA512:
   metadata.gz: !binary |-
-    OWJmOGE4ZWFiZWJkNDIwMDgzYzhkOTdhNDYyOGI5NjA1ZjRhYjllMzM5OGUx
-    MzVjNjkyNmEzOGUyNWQxNThjM2Q0MWM0ZjJjMjNlYWZkODMxNmY0YTA4ZDhh
-    ZDNkOTA1ZTc3NWU1MjA3MWY5OGMwZGFmOWRkYjgxOTExODMxZmI=
+    MDE0NDIxOTM5NWI3YTU5OTg5OGM2ZDRhYzMzNDcxNzdkMzQ1NGY2OGQ2MTNl
+    ZDk5ZjBiZTVjMzE2Mzc0ZGRkM2JjZmFjZjBkZWEzOGYyOTM0N2RhYWE4ZDM0
+    ZGE2YjYzOWU1OGE0MzkyMzQwYTIwYWI4NjQzZmYwMjJiNTMyYmE=
   data.tar.gz: !binary |-
-    Mjk2YjA5MWU2Zjg4NTQ3M2YxMDEwOGM5YzJjYjc2MTAwYWNlNDJjMmQwMDM5
-    NGJkNDEzM2I2YmNlZDRkMDNiMWU0YWQ5MmYwYjBiM2JmMWQ5YjdlODI5NDhm
-    MmMwMDlkMTAzMzgzOWExM2ZlNWZiMGE0Mjc2Mzk2YmIzNTE5OTk=
+    NzA1ZmFiMDc1MDYyNTc4NTQyODZjZGNlZWI5N2U2OWE2NzkzNjM4MjYxZjBm
+    MjYzMmM5NDZjMjY3MTBmNGQyYjdlYWU0NDk1NWE3MjZiZTJhMmJlZjQyZmYz
+    YjA1NmJlNGUyOTIzNTY1MGMyYTQyNzY4MGZlMDE3YzFhYWQzMTM=

data/CHANGELOG

@@ -32,6 +32,14 @@ Version 0.2.5
 
 Version 0.2.6
 - Add enhanced-format signature data handling.
-- Fix misconception about signed number representation in
-  signature image data.
+- Fix misconception about signed number representation in signa-
+  ture image data.
 - Bring signature image handling out of experimental status.
+
+Version 0.3.0
+- Allow user to cancel waiting for reply in
+  poslynx_client_console.
+- Support SSL connections from poslynx_client_console.
+- Change word separators in poslynx_client_console from under-
+  scores to dashes.
+- Fake Poslynx includes signature image data in response.

data/README.md

@@ -16,11 +16,11 @@ Features:
 
 The best introduction to this gem is probably to play around with
 with the POSLynx client console.  Assuming you have a POSLynx
-unit with IP address 192.168.1.123, listening on port 54321, with
-a registered client MAC of 000000000000, an example poslynx
-client session might look like...
+unit with IP address 192.168.1.123, listening on port 54321 using
+SSL encryption, with a registered client MAC of 000000000000, an
+example poslynx client session might look like...
 
-    $ bundle exec poslynx_client_console 173.195.60.144:14270 --client_mac=000000000000
+    $ bundle exec poslynx_client_console 173.195.60.144:14270 --use-ssl --client_mac=000000000000
     1.9.3-p545 :001 > req = poslynx_client.example_pin_pad_display_message_request
      => #<ClientForPoslynx::Data::Requests::PinPadDisplayMessage:0x007f941b4b1fe8 @client_mac="001C42E644FE", @text_lines=["First example line", "Second example line"], @line_count=2, @button_labels=["1st of optional buttons", "2nd button"]>
     1.9.3-p545 :002 > resp = poslynx_client.send_request(req)
@@ -29,8 +29,8 @@ client session might look like...
 
 This gem also provides a fake POS/terminal application that you
 can run in a separate console window when you are working without
-the necessary access to an actual POSLynx unit and PIN pad.  To
-start the fake POS/terminal listening on port 3010...
+access to an actual POSLynx unit and PIN pad.  To start the fake
+POS/terminal listening on port 3010...
 
     bundle exec fake_pos_terminal 3010
 

data/bin/poslynx_client_console

@@ -13,10 +13,15 @@ end
 $*.replace []
 
 # Take --client_mac=<hexadecimal-value> if present.
-client_mac_opts = option_args.select{ |opt| opt =~ /^--client_mac=[0-9a-fA-F]+$/ }
+client_mac_opts = option_args.select{ |opt| opt =~ /^--client-mac=[0-9a-fA-F]+$/ }
 option_args -= client_mac_opts
 client_mac_option = client_mac_opts.last
 
+# Take --use-ssl or --no-ssl if present.
+ssl_opts = option_args.select{ |opt| opt =~ /^--(use|no)-ssl$/ }
+option_args -= ssl_opts
+ssl_option = ssl_opts.last
+
 # The only remaining option we care about is --help, so we either
 # show usage for --help or because an unrecognized option was given.
 show_usage = option_args.length > 0
@@ -46,9 +51,16 @@ assumed.
 
 Options:
 
-  --client_mac=<hexadecimal>  The client MAC value to be assigned
+  --client-mac=<hexadecimal>  The client MAC value to be assigned
                               to example-request objects.
 
+  --use-ssl                   Use SSL encryption for the connec-
+                              tion to the POSLynx.
+
+  --no-ssl                    Don't use SSL encryption for the
+                              connection to the POSLynx. This is
+                              the default behavior.
+
   --help                      Prints this usage information.
 
 Opens an interactive Ruby shell with a globally acccessible
@@ -82,6 +94,7 @@ else
   config = poslynx_client.config
   config.host = host
   config.port = port
+  config.use_ssl = ssl_option == '--use-ssl'
 
   if client_mac_option
     config.client_mac_for_examples = client_mac_option.split('=').last

data/lib/client_for_poslynx/data/responses/credit_card_sale.rb

@@ -28,12 +28,26 @@ module ClientForPoslynx
         attr_element_mapping attribute: :customer_receipt,         element: 'ReceiptCustomer', numbered_lines: 'Receipt%d'
 
         def signature=(value)
+          # Extract content from CDATA section XML improperly encoded
+          # as text node content by some POSLynx versions.
           if value =~ /^<!\[CDATA\[(.*)\]\]>$/
             @signature = $1
           else
             @signature = value
           end
         end
+
+        def signature_image=(img)
+          self.signature = img.nil? ?
+                                    nil :
+                                    img.serialize
+        end
+
+        def signature_image
+          return nil if signature.nil?
+          SignatureImage.deserialize( signature )
+        end
+
       end
 
     end

data/lib/client_for_poslynx/fake_pos_terminal/request_handlers/credit_card_sale.rb

@@ -18,6 +18,7 @@ module ClientForPoslynx
           response.input_method = 'SWIPED'
           confirmed = get_confirmation
           response.card_type = 'Visa'
+          response.signature_image = signature_image if request.capture_signature == 'Yes'
           assemble_supported_source_response confirmed
         end
 
@@ -25,6 +26,31 @@ module ClientForPoslynx
           request.amount
         end
 
+        def signature_image
+          SignatureImage.new.tap { |si|
+            si.metrics = SignatureImage::Metrics.new( [2048, 256], [20_000, 2_500] )
+
+            # Say "Hi"
+
+            si.move 40, 40
+            si.draw -5, 30
+            si.draw -5, 30
+
+            si.move 70, 40
+            si.draw -5, 30
+            si.draw -5, 30
+
+            si.move 35, 70
+            si.draw 30,  0
+
+
+            si.move 80, 70
+            si.draw -5, 30
+
+            si.move 81, 64
+          }
+        end
+
         def assemble_request_response_passthrough
           response.merchant_supplied_id = request.merchant_supplied_id
           response.client_id            = request.client_id

data/lib/client_for_poslynx/fake_pos_terminal/request_handlers/handles_card_sale.rb

@@ -21,6 +21,10 @@ module ClientForPoslynx
           raise NotImplementedError
         end
 
+        def handle_supported_source_request
+          raise NotImplementedError, "Including class responsibility"
+        end
+
         def handle_unsupported_source_request
           set_result '0135', 'Transaction Not Supported'
           response.result_text = "Fake POSLynx doesn't currently support input source other than EXTERNAL"

data/lib/client_for_poslynx/has_client_console_support/connection.rb

@@ -0,0 +1,56 @@
+require 'socket'
+require 'openssl'
+require 'forwardable'
+
+module ClientForPoslynx
+  module HasClientConsoleSupport
+
+    class Connection
+      def self.connect(config)
+        new(config).connect
+      end
+
+      attr_accessor :io
+      private       :io=
+
+      def initialize(config)
+        self.config = config
+      end
+
+      def connect
+        self.tcp_connection = TCPSocket.new( config.host, config.port )
+        self.io = config.use_ssl ?
+          connect_ssl_socket :
+          tcp_connection
+        self
+      rescue StandardError
+        close
+        raise
+      end
+
+      def close
+        tcp_connection.close unless tcp_connection.closed?
+        self.io = self.tcp_connection = nil
+      end
+
+      def puts(*args)
+        io.puts *args
+      end
+
+      def ===(other)
+        self == other || self.io == other
+      end
+
+      private
+
+      def connect_ssl_socket
+        OpenSSL::SSL::SSLSocket.new( tcp_connection ).tap { |ssl_conn|
+          ssl_conn.connect
+        }
+      end
+
+      attr_accessor :config, :tcp_connection
+    end
+
+  end
+end

data/lib/client_for_poslynx/has_client_console_support/response_ready_monitor.rb

@@ -0,0 +1,44 @@
+module ClientForPoslynx
+  module HasClientConsoleSupport
+
+    class ResponseReadyMonitor
+      def self.ready?(conn)
+        new( conn ).ready?
+      end
+
+      def initialize(conn)
+        self.conn = conn
+      end
+
+      def ready?
+        # Wait up to 1 second for data ready to read or error.
+        ready = !! IO.select( [conn.io], [], [conn.io], 1 )
+        return true if ready
+
+        puts "Waiting for response. Press Enter to cancel."
+        print "Waiting: "
+        while true do
+          print '.'
+
+          # Wait up to 1 second for data or for line of input from user.
+          select_state = IO.select( [conn.io, $stdin], [], [conn.io], 1 )
+          next unless select_state
+
+          read_state, _, error_state = select_state
+          any_state = read_state + error_state
+
+          ( ready = true ; break ) if any_state.any? { |io| conn === io }
+          ( gets         ; break ) if read_state.include?( $stdin )
+        end
+        puts
+
+        ready
+      end
+
+      private
+
+      attr_accessor :conn
+    end
+
+  end
+end

data/lib/client_for_poslynx/has_client_console_support.rb

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'client_for_poslynx'
-require 'socket'
+require_relative 'has_client_console_support/connection'
+require_relative 'has_client_console_support/response_ready_monitor'
 
 module ClientForPoslynx
 
@@ -17,10 +18,11 @@ module ClientForPoslynx
       end
 
       def send_request(request)
-        conn = TCPSocket.new( config.host, config.port )
+        conn = Connection.connect( config )
         conn.puts request.xml_serialize
-        response = get_response_from( conn )
-        conn.close unless conn.closed?
+        ready = ResponseReadyMonitor.ready?( conn )
+        response = get_response_from( conn.io ) if ready
+        conn.close
         response
       end
 
@@ -52,6 +54,7 @@ module ClientForPoslynx
           req.merchant_supplied_id = 'INVC-123-MERCH-SUPPL'
           req.amount               = '101.25'
           req.input_source         = 'EXTERNAL'
+          req.capture_signature    = 'Yes'
         }
       end
 
@@ -99,7 +102,7 @@ module ClientForPoslynx
     end
 
     class Config
-      attr_accessor :host, :port, :client_mac_for_examples
+      attr_accessor :host, :port, :use_ssl, :client_mac_for_examples
     end
 
   end

data/lib/client_for_poslynx/version.rb

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

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

@@ -147,6 +147,39 @@ module ClientForPoslynx
     end
 
 
+    context "signature image conveniences" do
+      let( :signature_image ) {
+        SignatureImage.new.tap { |si|
+          si.metrics = SignatureImage::Metrics.new( [3_000, 200], [30_000, 2_000] )
+          si.move 20, 15
+          si.draw 30, 15
+          si.draw 30, 15
+        }
+      }
+      let( :base_64_regex ) { /^[A-Za-z0-9\+\/]+={0,2}$/ }
+
+      it "sets signature to nil for nil signature image" do
+        subject.signature_image = nil
+        expect( subject.signature ).to be_nil
+      end
+
+      it "gets nil signature image for nil signature" do
+        subject.signature = nil
+        expect( subject.signature_image ).to be_nil
+      end
+
+      it "Supports setting/getting signature data as signature image" do
+        subject.signature_image = signature_image
+        expect( subject.signature ).to match( base_64_regex )
+
+        subject2 = described_class.new
+        subject2.signature = subject.signature
+        expect( subject2.signature_image ).to eq( signature_image )
+      end
+
+    end
+
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client_for_poslynx
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Jorgensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-10 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -128,6 +128,8 @@ files:
 - lib/client_for_poslynx/fake_pos_terminal/result_assemblers/card_sale_receipt.rb
 - lib/client_for_poslynx/fake_pos_terminal/server.rb
 - lib/client_for_poslynx/has_client_console_support.rb
+- lib/client_for_poslynx/has_client_console_support/connection.rb
+- lib/client_for_poslynx/has_client_console_support/response_ready_monitor.rb
 - lib/client_for_poslynx/message_handling.rb
 - lib/client_for_poslynx/message_handling/data_extractor.rb
 - lib/client_for_poslynx/message_handling/stream_data_writer.rb