client_for_poslynx 0.2.4 → 0.2.5

data/spec/client_for_poslynx/bit_sequence_spec.rb

@@ -0,0 +1,147 @@
+# coding: binary
+# Note that "binary" coding is important for this file
+# since that allows us to write packed binary string
+# literals.
+
+require 'spec_helper'
+require 'stringio'
+
+module ClientForPoslynx
+
+  describe BitSequence do
+    subject{ klass ^ "Do" }
+    let( :klass ) { described_class }
+
+    specify "is unequal to another instance based on different packed bits" do
+      other_instance = klass ^ "Re"
+      expect( subject ).not_to eq( other_instance )
+    end
+
+    specify "is equal to another instance based on same packed bits" do
+      other_instance = klass ^ "Do"
+      expect( subject ).to eq( other_instance )
+    end
+
+    specify "is unequal to another instance based on a non-equivalent binary digit sequence" do
+      other_instance = klass / "1010101010101010"
+      expect( subject ).not_to eq( other_instance )
+    end
+
+    specify "is equal to another instance based on an equivalent binary digit sequence" do
+      other_instance = klass / "0100010001101111"
+      expect( subject ).to eq( other_instance )
+    end
+
+    it "sets extra bits in final byte to zeros when packing bits" do
+      instance = klass / "01110000111"
+      expect( instance.to_packed_bits ).to eq( "\x70\xE0" )
+    end
+
+    it "correctly reports how many bits long it is" do
+      expect(   klass.new_empty     .length ).to eq(  0 )
+      expect( ( klass / '0'        ).length ).to eq(  1 )
+      expect( ( klass / '10'       ).length ).to eq(  2 )
+      expect( ( klass / ('01' * 9) ).length ).to eq( 18 )
+    end
+
+    it "correctly reports what its first bit-digit is" do
+      expect( ( klass /  '101' ).first_bit_digit ).to eq( '1' )
+      expect( ( klass / '1101' ).first_bit_digit ).to eq( '1' )
+      expect( ( klass /  '001' ).first_bit_digit ).to eq( '0' )
+      expect( ( klass / '0101' ).first_bit_digit ).to eq( '0' )
+    end
+
+    it "can have another bit sequence pushed onto its end" do
+      actual =  klass / '10101'
+      actual << klass / '001100'
+      expected = klass / '10101001100'
+      expect( actual ).to eq( expected )
+    end
+
+    it "can have a bit sequence shifted off of its front" do
+      bit_source = klass / '111000111000111000'
+      taken = bit_source.shift(9)
+
+      expected_remaining = klass / '000111000'
+      expected_taken     = klass / '111000111'
+
+      expect( bit_source ).to eq( expected_remaining )
+      expect( taken      ).to eq( expected_taken     )
+    end
+
+    it "can have another bit sequence unshifted onto its fron" do
+      bit_target = klass / '000111000'
+      bit_target.unshift klass / '111000111'
+
+      expected_resulting = klass / '111000111000111000'
+
+      expect( bit_target ).to eq( expected_resulting )
+    end
+
+    it "can be (big-endian) interpreted as an unsigned integer" do
+      expect( ( klass / '111000011110000'  ).as_unsigned ).to eq( 0x70F0 )
+      expect( ( klass / ( '11110000' * 8 ) ).as_unsigned ).to eq( 0xF0F0F0F0F0F0F0F0 )
+    end
+
+    it "fails to be interpreted as unsigned if longer than 64 bits" do
+      bit_seq = klass / ( '11110000' * 8 + '1' )
+      expect{ bit_seq.as_unsigned }.to \
+        raise_exception( klass::TooManyBitsLong, /\b64\b/ )
+    end
+
+    it "can be (big-endian) interpreted as the sign-bit and magnitude of an integer" do
+      expect( ( klass / '000'                  ).as_sign_and_magnitude ).to eq(   0 )
+      expect( ( klass / '0111000011110000'     ).as_sign_and_magnitude ).to eq(   0x70F0 )
+      expect( ( klass / '1111000011110000'     ).as_sign_and_magnitude ).to eq( - 0x70F0 )
+      expect( ( klass / ('1' + '11110000' * 8) ).as_sign_and_magnitude ).to eq( - 0xF0F0F0F0F0F0F0F0 )
+    end
+
+    it "fails to be interpreted as sign-bit and magnitude if longer than 65 bits" do
+      bit_seq = klass / ( '0' + '11110000' * 8 + '1' )
+      expect{ bit_seq.as_sign_and_magnitude }.
+        to raise_exception( klass::TooManyBitsLong, /\b65\b/ )
+    end
+
+    it "can be constructed as the big-endian representation of an unsigned integer" do
+      expect( klass.from_unsigned(  0,             9 ) ).to eq( klass / ( '0' * 9   ) )
+      expect( klass.from_unsigned(  0x23,          7 ) ).to eq( klass / ( '0100011' ) )
+      expect( klass.from_unsigned( (2 ** 64) - 1, 64 ) ).to eq( klass / ( '1' * 64  ) )
+    end
+
+    it "can be constructed as the sign-bit and big-endian magnitude representation of an integer" do
+      expect( klass.from_sign_and_magnitude_of(   0,            10 ) ).to eq( klass / ( '0' * 10   ) )
+      expect( klass.from_sign_and_magnitude_of(   0x23,          8 ) ).to eq( klass / ( '00100011' ) )
+      expect( klass.from_sign_and_magnitude_of( - 0x23,          8 ) ).to eq( klass / ( '10100011' ) )
+      expect( klass.from_sign_and_magnitude_of( -(2 ** 64) + 1, 65 ) ).to eq( klass / ( '1' * 65   ) )
+    end
+
+    it "fails to be constructed as a longer than 64-bit representation of an unsigned number" do
+      expect{ klass.from_unsigned(0x23, 65) }.
+        to raise_exception( klass::TooManyBitsLong, /\b64\b/ )
+    end
+
+    it "fails to be constructed as an unsigned representation a negative number" do
+      expect{ klass.from_unsigned(-1, 5) }.
+        to raise_exception( klass::NumberOutOfBounds )
+    end
+
+    it "fails to be constructed as an under-sized representation of an unsigned number" do
+      expect{ klass.from_unsigned(0x23, 5) }.
+        to raise_exception( klass::NumberOutOfBounds )
+    end
+
+    it "can be build by unpacking bits from a uuencoded string" do
+      actual   = klass.from_uuencoded( "&,C(R,C(R\n" )
+      expected = klass ^ "\x32" * 6
+
+      expect( actual ).to eq( expected )
+    end
+
+    it "can be packed to a uuencoded string" do
+      bit_seq = klass ^ "\x32" * 6
+      expect( bit_seq.uuencode ).to eq( "&,C(R,C(R\n" )
+    end
+
+  end
+
+end

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

@@ -27,6 +27,7 @@ module ClientForPoslynx
       subject.track_2              = 'the-two'
       subject.card_number          = 'the-number'
       subject.expiry_date          = 'the-expiration'
+      subject.capture_signature    = 'the-capture-signature'
 
       expected_xml =
         "<PLRequest>" +
@@ -42,6 +43,7 @@ module ClientForPoslynx
           "<Track1>the-one</Track1>" +
           "<CardNumber>the-number</CardNumber>" +
           "<ExpiryDate>the-expiration</ExpiryDate>" +
+          "<ReqPPSigCapture>the-capture-signature</ReqPPSigCapture>" +
         "</PLRequest>\n"
 
       expect( subject.xml_serialize ).to eq( expected_xml )
@@ -75,22 +77,24 @@ module ClientForPoslynx
   <Track1>the-one</Track1>
   <CardNumber>the-number</CardNumber>
   <ExpiryDate>the-expiration</ExpiryDate>
+  <ReqPPSigCapture>the-capture-signature</ReqPPSigCapture>
 </PLRequest>
       XML
 
       actual_instance = described_class.xml_deserialize xml_input
 
-      expect( actual_instance.client_mac           ).to eq( 'the-MAC'         )
-      expect( actual_instance.merchant_supplied_id ).to eq( 'the-transaction' )
-      expect( actual_instance.client_id            ).to eq( 'the-client'      )
-      expect( actual_instance.tax_amount           ).to eq( 'the-tax'         )
-      expect( actual_instance.customer_code        ).to eq( 'the-code'        )
-      expect( actual_instance.amount               ).to eq( 'the-amount'      )
-      expect( actual_instance.input_source         ).to eq( 'the-source'      )
-      expect( actual_instance.track_1              ).to eq( 'the-one'         )
-      expect( actual_instance.track_2              ).to eq( 'the-two'         )
-      expect( actual_instance.card_number          ).to eq( 'the-number'      )
-      expect( actual_instance.expiry_date          ).to eq( 'the-expiration'  )
+      expect( actual_instance.client_mac           ).to eq( 'the-MAC'               )
+      expect( actual_instance.merchant_supplied_id ).to eq( 'the-transaction'       )
+      expect( actual_instance.client_id            ).to eq( 'the-client'            )
+      expect( actual_instance.tax_amount           ).to eq( 'the-tax'               )
+      expect( actual_instance.customer_code        ).to eq( 'the-code'              )
+      expect( actual_instance.amount               ).to eq( 'the-amount'            )
+      expect( actual_instance.input_source         ).to eq( 'the-source'            )
+      expect( actual_instance.track_1              ).to eq( 'the-one'               )
+      expect( actual_instance.track_2              ).to eq( 'the-two'               )
+      expect( actual_instance.card_number          ).to eq( 'the-number'            )
+      expect( actual_instance.expiry_date          ).to eq( 'the-expiration'        )
+      expect( actual_instance.capture_signature    ).to eq( 'the-capture-signature' )
     end
 
     it "accepts a canonical visitor" do

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

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+module ClientForPoslynx
+
+  describe Data::Requests::PinPadGetSignature do
+
+    it_behaves_like "a data object"
+
+    it "Serializes to a PLRequest XML document for a PPGETSIGNATURE request" do
+      mac = Data::Requests::DEFAULT_CLIENT_MAC
+      expected_xml =
+        "<PLRequest><Command>PPGETSIGNATURE</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>PPGETSIGNATURE</Command>" +
+          "<ClientMAC>the-mac</ClientMAC>" +
+        "</PLRequest>\n"
+
+      expect( subject.xml_serialize ).to eq( expected_xml )
+    end
+
+
+    it "parses minimally acceptable XML data" do
+      xml_input = <<-XML
+<PLRequest>
+  <Command>PPGETSIGNATURE</Command>
+</PLRequest>
+      XML
+
+      actual_instance = described_class.xml_deserialize xml_input
+    end
+
+
+    it "parses XML data with all property elements supplied" do
+      xml_input = <<-XML
+<PLRequest>
+  <Command>PPGETSIGNATURE</Command>
+  <ClientMAC>the-MAC</ClientMAC>
+</PLRequest>
+      XML
+
+      actual_instance = described_class.xml_deserialize xml_input
+
+      expect( actual_instance.client_mac  ).to eq( 'the-MAC'    )
+    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_PinPadGetSignature ).with( subject )
+      subject.accept_visitor visitor
+    end
+
+  end
+
+end

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

@@ -30,6 +30,7 @@ module ClientForPoslynx
       subject.transaction_date        = 'the-date'
       subject.transaction_time        = 'the-time'
       subject.input_method            = 'the-input-method'
+      subject.signature               = 'the-signature'
       subject.receipt                 = [ 'Merchant Receipt', '...' ]
       subject.customer_receipt        = [ 'Customer Receipt', '...' ]
 
@@ -52,6 +53,7 @@ module ClientForPoslynx
           "<TransactionDate>the-date</TransactionDate>" +
           "<TransactionTime>the-time</TransactionTime>" +
           "<InputMethod>the-input-method</InputMethod>" +
+          "<Signature>the-signature</Signature>" +
           "<Receipt>" +
             "<Receipt1>Merchant Receipt</Receipt1>" +
             "<Receipt2>...</Receipt2>" +
@@ -98,6 +100,7 @@ module ClientForPoslynx
   <TransactionDate>the-date</TransactionDate>
   <TransactionTime>the-time</TransactionTime>
   <InputMethod>the-input-method</InputMethod>
+  <Signature>the-signature</Signature>
   <Receipt>
     <Receipt1>Merchant Receipt</Receipt1>
     <Receipt2>...</Receipt2>
@@ -127,6 +130,7 @@ module ClientForPoslynx
       expect( actual_instance.transaction_date        ).to eq( 'the-date'              )
       expect( actual_instance.transaction_time        ).to eq( 'the-time'              )
       expect( actual_instance.input_method            ).to eq( 'the-input-method'      )
+      expect( actual_instance.signature               ).to eq( 'the-signature'      )
       expect( actual_instance.receipt                 ).to eq( ['Merchant Receipt', '...'] )
       expect( actual_instance.customer_receipt        ).to eq( ['Customer Receipt', '...'] )
     end

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

@@ -2,29 +2,27 @@ require 'spec_helper'
 
 module ClientForPoslynx
 
-  describe Data::Responses::PinPadDisplayMessage do
+  describe Data::Responses::PinPadGetSignature do
 
     it_behaves_like "a data object"
 
-    it "Serializes to a PLResponse XML document for a PPDISPLAY response" do
-      expected_xml = "<PLResponse><Command>PPDISPLAY</Command></PLResponse>\n"
+    it "Serializes to a PLResponse XML document for a PPGETSIGNATURE response" do
+      expected_xml = "<PLResponse><Command>PPGETSIGNATURE</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'
-      subject.button_response = 'the-response'
+      subject.result      = 'the-result'
+      subject.result_text = 'the-text'
+      subject.signature   = 'the-signature'
 
       expected_xml =
         "<PLResponse>" +
-          "<Command>PPDISPLAY</Command>" +
+          "<Command>PPGETSIGNATURE</Command>" +
           "<Result>the-result</Result>" +
           "<ResultText>the-text</ResultText>" +
-          "<ErrorCode>the-code</ErrorCode>" +
-          "<Response>the-response</Response>" +
+          "<Signature>the-signature</Signature>" +
         "</PLResponse>\n"
 
       expect( subject.xml_serialize ).to eq( expected_xml )
@@ -34,7 +32,7 @@ module ClientForPoslynx
     it "parses minimally acceptable XML data" do
       xml_input = <<-XML
 <PLResponse>
-  <Command>PPDISPLAY</Command>
+  <Command>PPGETSIGNATURE</Command>
 </PLResponse>
       XML
 
@@ -46,20 +44,18 @@ module ClientForPoslynx
     it "parses XML data with all property elements supplied" do
       xml_input = <<-XML
 <PLResponse>
-  <Command>PPDISPLAY</Command>
+  <Command>PPGETSIGNATURE</Command>
   <Result>the-result</Result>
   <ResultText>the-text</ResultText>
-  <ErrorCode>the-code</ErrorCode>
-  <Response>the-response</Response>
+  <Signature>the-signature</Signature>
 </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'     )
-      expect( actual_instance.button_response ).to eq( 'the-response' )
+      expect( actual_instance.result      ).to eq( 'the-result'    )
+      expect( actual_instance.result_text ).to eq( 'the-text'      )
+      expect( actual_instance.signature   ).to eq( 'the-signature' )
     end
 
 

data/spec/client_for_poslynx/signature_image/to_svg_converter_spec.rb

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+module ClientForPoslynx
+
+  describe SignatureImage::ToSvgConverter do
+    let( :svg_ns ) { 'http://www.w3.org/2000/svg' }
+    let( :signature_image ) { SignatureImage.new }
+    let( :svg_doc_content ) { described_class.convert( signature_image ) }
+    let( :svg_document ) {
+      Nokogiri::XML( svg_doc_content ) do |config|
+        config.options = Nokogiri::XML::ParseOptions::STRICT | Nokogiri::XML::ParseOptions::NONET
+      end
+    }
+    let( :svg_doc_root ) { svg_document.root }
+
+    it "produces SVG document content" do
+      expect( svg_doc_root.name ).to eq( 'svg' )
+      expect( svg_doc_root.namespace.href ).to eq( svg_ns )
+      expect( svg_doc_root['version'] ).to eq( '1.1' )
+    end
+
+    it "specifies physical dimensions in millimeter units" do
+      expected = /^\d+([.]\d*)?mm?$/
+      expect( svg_doc_root['width' ] ).to match( expected )
+      expect( svg_doc_root['height'] ).to match( expected )
+    end
+
+    it "specifies integer logical units for view box start and size" do
+      expect( svg_doc_root['viewBox'] ).to match( /^(\d+\s+){3}\d+$/ )
+    end
+
+    it "treats logical units as fractions of physical dimensions, regardless of resulting pixel aspect ratio" do
+      expect( svg_doc_root['preserveAspectRatio'] ).to eq( 'none' )
+    end
+
+    it "includes a an SVG <path> element" do
+      expect( svg_document.xpath('//ns:svg/ns:path', 'ns' => svg_ns).length ).
+        to eq( 1 )
+    end
+
+    describe "<path> element" do
+      let( :svg_path_element ) {
+        svg_document.at_xpath('//ns:svg/ns:path', 'ns' => svg_ns)
+      }
+
+      it "has a black stroke color" do
+        expect( svg_path_element['stroke'] ).to eq( 'black' )
+      end
+
+      it "is explicitly not filled" do
+        expect( svg_path_element['fill'] ).to eq( 'none' )
+      end
+
+      it "has a stroke width in millimeter units" do
+        expected = /^\d+([.]\d*)?mm?$/
+        expect( svg_path_element['stroke-width'] ).to match( expected )
+      end
+
+      describe "path data" do
+        let( :svg_path_instruction_tokens ) {
+          path_data = svg_path_element['d']
+          path_instructions = path_data.split(/ (?=[Ml])/)
+          path_instructions.map { |pi|
+            instr_type = pi[0..0]
+            instr_values = pi[1..-1].strip.split(/[ ,]+/)
+            [ instr_type ] + instr_values
+          }
+        }
+
+        it "creates path data from signature data steps" do
+          signature_image.move 25, 20
+          signature_image.draw 30,  1
+
+          signature_image.move 10, 20
+          signature_image.draw  0, 30
+          signature_image.draw -1, 25
+
+          expect( svg_path_instruction_tokens ).to eq( [
+            %w[ M 25 20 ],
+            %w[ l 30 1 ],
+
+            %w[ M 10 20 ],
+            %w[ l  0 30
+                  -1 25 ],
+          ] )
+        end
+
+        it "adds zero length line-to after a move without a draw" do
+          signature_image.move 25, 20
+          signature_image.draw 30,  1
+
+          signature_image.move 10, 20
+
+          signature_image.move 90, 30
+          signature_image.draw -1, 25
+
+          expect( svg_path_instruction_tokens ).to eq( [
+            %w[ M 25 20 ],
+            %w[ l 30 1 ],
+
+            %w[ M 10 20 ],
+            %w[ l 0 0 ],
+
+            %w[ M 90 30 ],
+            %w[ l -1 25 ],
+          ] )
+        end
+      end
+    end
+  end
+
+end

data/spec/client_for_poslynx/signature_image_spec.rb

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+require 'spec_helper'
+
+module ClientForPoslynx
+
+  describe SignatureImage do
+
+    def build_example_image
+      described_class.new.tap { |si|
+        si.move  10, 120
+        si.draw   0, -30
+        si.draw   0, -30
+        si.draw   0, -30
+        si.draw   0, -20
+        si.draw  30,  30
+        si.draw -25,  25
+        si.draw   0,  -2
+      }
+    end
+
+    let( :bit_sequence ) {
+      BitSequence.from_bit_digits( bit_digit_sequence )
+    }
+
+    let( :bit_digit_sequence ) {
+      # TODO: Currently assuming that deltas for move are
+      # expressed as sign bit and magnitude, where sign bit
+      # of 1 means negative. Documentation is unclear about
+      # this though except to say that there is a sign bit,
+      # and that values can range from -31 to 31.
+      # Once I can connect to the virtual POSLynx again, I
+      # need to do a test, and find out whether this
+      # assumption is true or not.
+      
+      '1' + '0000001010' + '1111000' + # move  10, 120
+      '0' + '000000' + '111110' +      # draw   0, -30
+      '0' + '000000' + '111110' +      # draw   0, -30
+      '0' + '000000' + '111110' +      # draw   0, -30
+      '0' + '000000' + '110100' +      # draw   0, -20
+      '0' + '011110' + '011110' +      # draw  30,  30
+      '0' + '111001' + '011001' +      # draw -25,  25
+      '0' + '000000' + '100010' +      # draw   0,  -2
+      '000'                            # remaining bits in last byte
+    }
+
+    it "is unequal to another instance with a different sequence of steps" do
+      subject = build_example_image
+
+      other_sig = described_class.new
+      other_sig.move 10, 120
+      other_sig.draw  0, -29
+
+      expect( subject ).not_to eq( other_sig )
+    end
+
+    it "is equal to another instance with the same sequence of steps" do
+      subject   = build_example_image
+      other_sig = build_example_image
+
+      expect( subject ).to eq( other_sig )
+    end
+
+    context "serializing" do
+      subject{ build_example_image }
+
+      it "serializes data in legacy format" do
+        actual_serialized = subject.serialize_legacy
+        actual_bit_sequence = BitSequence.from_uuencoded( actual_serialized )
+
+        expect( actual_bit_sequence ).to eq( bit_sequence )
+      end
+    end
+
+    context "deserializing" do
+      subject{ described_class.new(serialized_data) }
+      let( :serialized_data ) {
+        bit_sequence.uuencode
+      }
+
+      it "deserializes data from legacy format" do
+        actual = described_class.deserialize( serialized_data )
+        expected = build_example_image
+
+        expect( actual ).to eq( expected )
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'client_for_poslynx'
+require 'client_for_poslynx/experimental'
 Dir[File.join( File.dirname(__FILE__), 'support', '**', '*.rb')].each do |script|
   require script
 end