te3270 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0b8ddf072f9f9cd64003ca654af024ad1b6fe2c6
-  data.tar.gz: e78254e04a34431a4da5c4376c860ef06f3c75e6
+SHA256:
+  metadata.gz: ca80832f6e8d872ddeb31fbc12a29ad613ad33ef13b191b9c6cb2f289cbca413
+  data.tar.gz: 36961aadfe3fcf1bf2fc569d1622c48d943aa1b2cc71df24c56cb3232d7d572b
 SHA512:
-  metadata.gz: 478e2822e1b6777d2c353084cadd5ec2bcbef3af290972e38ff9bdb8c676260a15227670a8e878d55e8bdcc22c90ac8f387a5ae9fb30d7da83c0ac0f5afa9ca9
-  data.tar.gz: e94556825730d4176b08d98d880437e1028aac498df571c488b94a8d79f694b8f00c8f402ce8387240ff3a498b592e5c6600ea3cc9fa9fa2be7cdcb3309867cf
+  metadata.gz: '08839017d9d96ad934cbd2295a55aff3e3470aacbe8771139b7429d724119aa75f41a91e998e229e3d890d26d4718f22e690d84abfbb60dc0f938e1080b87ef7'
+  data.tar.gz: c13d41c841a084a4b04a6ba29cf27a35f03ae944c3f453563d8da140a492b7b43aa1ab808a7c9359ab7696a57fc00e8052eae2c6b386c816b336610cf0f3a4de

data/ChangeLog

@@ -1,3 +1,11 @@
+=== Version 0.9.0 / 2020-03-19
+* Enhancements
+  * Added support for BlueZone driver (Thanks Jonathan Knapp)
+  * Add troubleshooting info to README
+* Fixes
+  * No longer limit bundler version in dev dependency
+  * Fix test that only runs on windows
+
 === Version 0.8.1 / 2017-03-06
 * Fixes
   * Fixed get_string method for Virtel (Thanks David West)

data/README.md

@@ -1,11 +1,13 @@
 # TE3270
 
-This gem can be used to drive a 3270 terminal emulator.  You have to have a supported emulator installed on the
-machines on which you use the gem.  Currently the supported emulators are
+This gem can be used to drive a 3270 terminal emulator. You have to have a supported emulator installed on the
+machines on which you use the gem. Currently the supported emulators are
 [EXTRA! X-treme](http://www.attachmate.com/Products/Terminal+Emulation/Extra/xtreme/extra-x-treme.htm) by
-Attachmate, [Quick3270](http://www.dn-computing.com/Quick3270.htm) by DN-Computing, [Virtel Web Access](http://www.virtelweb.com/solutions/3270-terminal-emulation.html),
+Attachmate, [Quick3270](http://www.dn-computing.com/Quick3270.htm) by DN-Computing,
+[Rocket BlueZone](https://www.rocketsoftware.com/products/rocket-bluezonepassport-terminal-emulator/rocket-bluezone-terminal-emulation),
+[Virtel Web Access](http://www.virtelweb.com/solutions/3270-terminal-emulation.html),
 and [X3270](http://x3270.bgp.nu/).
-The first three are commercial products and need to be purchased.
+The first four are commercial products and need to be purchased.
 X3270 is open source. Support for other
 emulators will be added as time permits.
 
@@ -29,7 +31,7 @@ Or install it yourself as:
 
 ## Usage
 
-You can create classes that are similar to page-object classes.  In these classes you can define
+You can create classes that are similar to page-object classes. In these classes you can define
 the various fields that you wish to interact with on the screen.
 
     class MainframeScreen
@@ -90,9 +92,9 @@ or you can use the version of `on` that takes a block like this:
       screen.password = 'the_password'
     end
 
-There is also a way to pass in a `Hash` and have it populate an entire screen.  Just simply
+There is also a way to pass in a `Hash` and have it populate an entire screen. Just simply
 ensure the key for an entry in the `Hash` matches the name you gave a text field and it will
-find and set the value.  This allows the gem to easily work with the DataMagic gem.
+find and set the value. This allows the gem to easily work with the DataMagic gem.
 
     # given this Hash
     my_data = { userid: 'the_id', password: 'the_password' }
@@ -100,6 +102,19 @@ find and set the value.  This allows the gem to easily work with the DataMagic g
     # you can simply call this method
     on(MainframeScreen).populate_screen_with my_data
 
+## Troubleshooting
+
+If you plan to use the BlueZone emulator support, make sure the version of BlueZone
+that you install matches the architecture of the Ruby version you are using.
+
+_ex: x86 for both or 64 bit for both_
+
+Also, if you intend to take screenshots with BlueZone, Extra, or Quick emulators
+you will need to use the x86 version of Ruby as the 64 bit version of
+[win32screenshot](https://rubygems.org/gems/win32screenshot/) depends on
+[rautomation](https://rubygems.org/gems/rautomation/) which
+[does not support 64 bit installs](https://github.com/jarmo/RAutomation/issues/68)
+at this time.
 
 ## Contributing
 

data/lib/te3270/emulator_factory.rb

@@ -1,3 +1,4 @@
+require 'te3270/emulators/bluezone'
 require 'te3270/emulators/extra'
 require 'te3270/emulators/quick3270'
 require 'te3270/emulators/x3270'
@@ -11,6 +12,7 @@ module TE3270
   module EmulatorFactory
 
     EMULATORS = {
+        bluezone: TE3270::Emulators::BlueZone,
         extra: TE3270::Emulators::Extra,
         quick3270: TE3270::Emulators::Quick3270,
         x3270: TE3270::Emulators::X3270,
@@ -22,4 +24,4 @@ module TE3270
     end
 
   end
-end
+end

data/lib/te3270/emulators/bluezone.rb

@@ -0,0 +1,282 @@
+module TE3270
+  module Emulators
+    class BlueZoneError < StandardError; end
+    class InvalidVisibleStateError < BlueZoneError; end
+    class InvalidWindowStateError < BlueZoneError; end
+    class InvalidWriteMethodError < BlueZoneError; end
+    class SessionFileMissingError < BlueZoneError; end
+    class Win32OleRuntimeError < BlueZoneError; end
+
+    #
+    # This class has the code necessary to communicate with the terminal emulator called Rocket BlueZone.
+    # You can use this emulator by providing the +:bluezone+ parameter to the constructor of your screen
+    # object or by passing the same value to the +emulator_for+ method on the +TE3270+ module.
+    #
+    class BlueZone
+      attr_writer :connect_retry_timeout,
+                  :max_column_length,
+                  :max_wait_time,
+                  :session_id,
+                  :session_file,
+                  :timeout,
+                  :write_errors_to_ignore,
+                  :write_method
+
+      #
+      # Initialize the emulator with defaults. This also loads libraries used
+      # to take screenshots on supported platforms.
+      #
+      def initialize
+        @connect_retry_timeout = 30
+        @max_column_length = 80
+        @max_wait_time = 100
+        @session_file = nil
+        @session_id = 1
+        @timeout = 10
+        @visible = true
+        @window_state = :normal
+        @write_errors_to_ignore = [5, 6]
+        @write_method = :full_string
+
+        if jruby?
+          require 'jruby-win32ole'
+          require 'java'
+          include_class 'java.awt.Dimension'
+          include_class 'java.awt.Rectangle'
+          include_class 'java.awt.Robot'
+          include_class 'java.awt.Toolkit'
+          include_class 'java.awt.event.InputEvent'
+          include_class 'java.awt.image.BufferedImage'
+          include_class 'javax.imageio.ImageIO'
+        else
+          require 'win32ole'
+          require 'win32/screenshot'
+        end
+      end
+
+      #
+      # Creates a method to connect to BlueZone. This method expects a block in which certain
+      # platform specific values can be set. BlueZone can take the following parameters.
+      #
+      # * connect_retry_timeout - number of seconds to retry connecting to a session. Defaults to +30+.
+      # * max_column_length - number of columns in a terminal row. Defaults to +80+.
+      # * max_wait_time - number of milliseconds to wait before resuming script execution after sending keys from host. Defaults to +100+.
+      # * session_file - this value is required and should be the filename of the session.
+      # * session_id - numeric identifier for type of session to connect to. From BlueZone's docs: +1 for S1: 2 for S2; 3 for S3; etc.+ Defaults to +1+.
+      # * timeout - numeric number of seconds till system calls timeout. Defaults to +10+.
+      # * visible - determines if the emulator is visible or not. If not set it will default to +true+.
+      # * window_state - determines the state of the session window.  Valid values are +:minimized+,
+      #   +:normal+, and +:maximized+.  If not set it will default to +:normal+.
+      # * write_errors_to_ignore - array of error codes to ignore during "char" write method. Defaults to +[5, 6]+.
+      # * write_method - write strings to the terminal all at once or one character at a time  Valid values are +:full_string+,
+      #   and +:char+.  Default is +:full_string+.
+      #
+      # @example Example calling screen object constructor with a block
+      #   screen_object = MyScreenObject.new(:bluezone)
+      #   screen_object.connect do |emulator|
+      #     emulator.session_file = 'path_to_session_file'
+      #     emulator.visible = true
+      #     emulator.window_state = :maximized
+      #   end
+      #
+      def connect
+        start_bluezone_system
+        yield self if block_given?
+        raise InvalidWriteMethodError unless [:char, :full_string].include?(@write_method)
+        raise SessionFileMissingError if @session_file.nil?
+
+        result = system.OpenSession(SESSION_TYPE[:Mainframe], @session_id, @session_file, @timeout, 1)
+        raise BlueZoneError, "Error opening session: #{result}; #{@session_file}" if result != 0
+
+        result = system.Connect('!', @connect_retry_timeout)
+        raise BlueZoneError, "Error connecting to session: #{result}" if result != 0
+      end
+
+      #
+      # Disconnects the BlueZone connection
+      #
+      def disconnect
+        system.CloseSession(SESSION_TYPE[:Mainframe], @session_id)
+      end
+
+      #
+      # Extracts text of specified length from a start point.
+      #
+      # @param [Fixnum] row the x coordinate of location on the screen.
+      # @param [Fixnum] column the y coordinate of location on the screen.
+      # @param [Fixnum] length the length of string to extract
+      # @return [String]
+      #
+      def get_string(row, column, length)
+        system.PSGetText(length, ((row - 1) * @max_column_length) + column)
+      end
+
+      #
+      # Puts string at the coordinates specified.
+      #
+      # @param [String|Fixnum] input the value to set; value is cast to string
+      # @param [Fixnum] row the x coordinate of the location on the screen.
+      # @param [Fixnum] column the y coordinate of the location on the screen.
+      #
+      def put_string(input, row, column)
+        input_as_string = input.to_s
+
+        if @write_method == :full_string
+          system.WriteScreen(input_as_string, row, column)
+          system.WaitReady(@timeout, @max_wait_time)
+        elsif @write_method == :char
+          input_as_string.chars.each_with_index do |char, index|
+            position = ((row - 1) * @max_column_length) + column + index
+            position_row = (position / @max_column_length.to_f).ceil
+            position_col = position % @max_column_length
+            position_col = position_col == 0 ? @max_column_length : position_col
+            result = system.WriteScreen(char, position_row, position_col)
+            break unless ([0] + @write_errors_to_ignore).include?(result)
+            system.WaitReady(@timeout, @max_wait_time)
+          end
+        else
+          raise InvalidWriteMethodError, @write_method
+        end
+      end
+
+      #
+      # Creates a method to take screenshot of the active screen. If you have set the +:visible+
+      # property to false it will be made visible prior to taking the screenshot and then changed
+      # to invisible after.
+      #
+      # @param [String] filename the path and name of the screenshot file to be saved
+      #
+      def screenshot(filename)
+        File.delete(filename) if File.exists?(filename)
+        original_visibility = @visible
+        self.visible = true
+
+        if jruby?
+          toolkit = Toolkit::getDefaultToolkit()
+          screen_size = toolkit.getScreenSize()
+          rect = Rectangle.new(screen_size)
+          robot = Robot.new
+          image = robot.createScreenCapture(rect)
+          f = java::io::File.new(filename)
+          ImageIO::write(image, "png", f)
+        else
+          hwnd = system.WindowHandle
+          Win32::Screenshot::Take.of(:window, hwnd: hwnd).write(filename)
+        end
+
+        self.visible = false unless original_visibility
+      end
+
+      #
+      # Sends keystrokes to the host, including function keys.
+      #
+      # @param [String] keys keystokes up to 255 in length
+      #
+      def send_keys(keys)
+        system.SendKey(keys)
+        system.WaitReady(@timeout, @max_wait_time)
+      end
+
+      #
+      # Returns the text of the active screen
+      #
+      # @return [String]
+      #
+      def text
+        system.PSText
+      end
+
+      #
+      # Sets the currently connected windows visibility.
+      #
+      # @param [Bool] value
+      #
+      def visible=(value)
+        raise InvalidVisibleStateError, value unless [false, true].include?(value)
+
+        @visible = value
+        window = system.Window
+        window.Visible = value
+      end
+
+      #
+      # Waits for the host to not send data for a specified number of seconds
+      #
+      # @param [Fixnum] seconds the maximum number of seconds to wait
+      #
+      def wait_for_host(seconds)
+        system.Wait(seconds)
+      end
+
+      #
+      # Wait for the string to appear at the specified location
+      #
+      # @param [String] str the string to wait for
+      # @param [Fixnum] row the x coordinate of location
+      # @param [Fixnum] column the y coordinate of location
+      #
+      def wait_for_string(str, row, column)
+        system.WaitForText(str, row, column, @timeout)
+      end
+
+      #
+      # Waits until the cursor is at the specified location.
+      #
+      # @param [Fixnum] row the x coordinate of the location
+      # @param [Fixnum] column the y coordinate of the location
+      #
+      def wait_until_cursor_at(row, column)
+        system.WaitCursor(@timeout, row, column, 3)
+      end
+
+      #
+      # Sets the currently connected windows state.
+      #
+      # @param [Symbol] state
+      #
+      def window_state=(state)
+        raise InvalidWindowStateError, state unless WINDOW_STATE.keys.include?(state)
+
+        @window_state = state
+        system.WindowState = WINDOW_STATE[state]
+      end
+
+      private
+
+      SESSION_TYPE = {
+        Mainframe: 0,
+        iSeries: 1,
+        VT: 2,
+        UTS: 3,
+        T27: 4,
+        '6530': 6
+      }.freeze
+
+      WINDOW_STATE = {
+        maximized: 2,
+        minimized: 1,
+        normal: 0
+      }.freeze
+
+      attr_reader :system
+
+      def jruby?
+        RUBY_PLATFORM == 'java'
+      end
+
+      def start_bluezone_system
+        begin
+          @system = WIN32OLE.new('BZWhll.WhllObj')
+
+          # Default window state.
+          # Once session is "connected" these will be applied unless overwritten.
+          self.window_state = @window_state
+          self.visible = @visible
+        rescue Win32OleRuntimeError => exception
+          $stderr.puts exception
+          raise MissingOleRuntimeError, 'Unable to find BZWhll.WhllObj OLE runtime. Did you install the same BlueZone Desktop architecture as your Ruby runtime? ex: x86 vs 64 bit'
+        end
+      end
+    end
+  end
+end

data/lib/te3270/version.rb

@@ -1,3 +1,3 @@
 module TE3270
-  VERSION = "0.8.1"
+  VERSION = "0.9.0"
 end

data/spec/lib/te3270/emulators/bluezone_spec.rb

@@ -0,0 +1,330 @@
+require 'spec_helper'
+
+describe TE3270::Emulators::BlueZone do
+
+  unless Gem.win_platform?
+    class WIN32OLE
+    end
+  end
+
+  let(:bluezone) do
+    allow_any_instance_of(TE3270::Emulators::BlueZone).to receive(:require) unless Gem.win_platform?
+    TE3270::Emulators::BlueZone.new
+  end
+
+  before(:each) do
+    allow(WIN32OLE).to receive(:new).and_return bluezone_system
+    bluezone.instance_variable_set(:@session_file, 'the_file')
+    allow(File).to receive(:exists).and_return false
+  end
+
+
+  describe "global behaviors" do
+    it 'should start a new terminal' do
+      expect(WIN32OLE).to receive(:new).and_return(bluezone_system)
+      bluezone.connect
+    end
+
+    it 'should open a session' do
+      expect(bluezone_system).to receive(:OpenSession).and_return(0)
+      bluezone.connect
+    end
+
+    it 'should call a block allowing the session file to be set' do
+      expect(bluezone_system).to receive(:OpenSession).with(0, 1, 'blah.edp', 10, 1).and_return(0)
+      bluezone.connect do |platform|
+        platform.session_file = 'blah.edp'
+      end
+    end
+
+    it 'should call a block with custom session number to be set' do
+      expect(bluezone_system).to receive(:OpenSession).with(0, 2, 'blah.edp', 10, 1).and_return(0)
+      bluezone.connect do |platform|
+        platform.session_id = 2
+        platform.session_file = 'blah.edp'
+      end
+    end
+
+    it 'should raise an error when the session file is not set' do
+      bluezone.instance_variable_set(:@session_file, nil)
+      expect { bluezone.connect }.to raise_error(TE3270::Emulators::SessionFileMissingError)
+    end
+
+    it 'should take the visible value from a block' do
+      expect(bluezone_window).to receive(:Visible=).with(false)
+      bluezone.connect do |platform|
+        platform.visible = false
+      end
+    end
+
+    it 'should default to visible when not specified' do
+      expect(bluezone_window).to receive(:Visible=).with(true)
+      bluezone.connect
+    end
+
+    it 'should take the window state value from the block' do
+      expect(bluezone_system).to receive(:WindowState=).with(2)
+      bluezone.connect do |platform|
+        platform.window_state = :maximized
+      end
+    end
+
+    it 'should default to window state normal when not specified' do
+      expect(bluezone_system).to receive(:WindowState=).with(0)
+      bluezone.connect
+    end
+
+    it 'should get the connection for the active session' do
+      expect(bluezone_system).to receive(:Connect).with("!", 30).and_return(0)
+      bluezone.connect
+    end
+
+    it 'should get the connection with custom connection retry timeout for the active session' do
+      expect(bluezone_system).to receive(:Connect).with("!", 0).and_return(0)
+      bluezone.connect_retry_timeout = 0
+      bluezone.connect
+    end
+
+    it 'should disconnect from a session' do
+      expect(bluezone_system).to receive(:CloseSession).with(0, 1)
+      bluezone.connect
+      bluezone.disconnect
+    end
+
+    it 'should disconnect from a custom session id' do
+      expect(bluezone_system).to receive(:CloseSession).with(0, 2)
+      bluezone.connect do |platform|
+        platform.session_id = 2
+      end
+      bluezone.disconnect
+    end
+
+    it 'should set write_method to :full_string by default' do
+      expect(bluezone.instance_variable_get(:@write_method)).to eq(:full_string)
+    end
+
+    it 'should allow setting write_method to :char' do
+      bluezone.connect do |platform|
+        platform.write_method = :char
+      end
+      expect(bluezone.instance_variable_get(:@write_method)).to eq(:char)
+    end
+
+    it 'should raise InvalidWriteMethodError with invalid write_method' do
+      bluezone.instance_variable_set(:@write_method, nil)
+      expect { bluezone.connect }.to raise_error(TE3270::Emulators::InvalidWriteMethodError)
+
+      bluezone.instance_variable_set(:@write_method, :invalid)
+      expect { bluezone.connect }.to raise_error(TE3270::Emulators::InvalidWriteMethodError)
+    end
+
+    it 'should set write_errors_to_ignore to [5, 6] by default' do
+      bluezone = TE3270::Emulators::BlueZone.new
+      expect(bluezone.instance_variable_get(:@write_errors_to_ignore)).to eq([5, 6])
+    end
+
+    it 'should allow setting write_errors_to_ignore to array of integers' do
+      bluezone.connect do |platform|
+        platform.write_errors_to_ignore = [6, 7, 8]
+      end
+      expect(bluezone.instance_variable_get(:@write_errors_to_ignore)).to eq([6, 7, 8])
+    end
+  end
+
+  describe "interacting with text fields" do
+    it 'should get the value from the screen' do
+      expect(bluezone_system).to receive(:PSGetText).with(10, 1532).and_return('blah')
+      bluezone.connect
+      expect(bluezone.get_string(20, 12, 10)).to eql 'blah'
+    end
+
+    it 'should get the value from the screen if columns were set to 100' do
+      expect(bluezone_system).to receive(:PSGetText).with(10, 1912).and_return('blah')
+      bluezone.connect do |platform|
+        platform.max_column_length = 100
+      end
+      expect(bluezone.get_string(20, 12, 10)).to eql 'blah'
+    end
+
+    describe "full_string write method" do
+      before(:each) do
+        bluezone.connect do |platform|
+          platform.write_method = :full_string
+        end
+      end
+
+      it 'should put the value on the screen' do
+        expect(bluezone_system).to receive(:WriteScreen).with('blah', 1, 2)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 100).once
+        bluezone.connect
+        bluezone.put_string('blah', 1, 2)
+      end
+
+      it 'should put the value on the screen with reduced wait delay if overridden' do
+        expect(bluezone_system).to receive(:WriteScreen).with('blah', 1, 2)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 111).once
+        bluezone.connect
+        bluezone.max_wait_time = 111
+        bluezone.put_string('blah', 1, 2)
+      end
+
+      it 'should cast the value to a string before printing to the screen' do
+        expect(bluezone_system).to receive(:WriteScreen).with('1234', 1, 2)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 100).once
+        bluezone.connect
+        bluezone.put_string(1234, 1, 2)
+      end
+    end
+
+    describe "char write method" do
+      before(:each) do
+        bluezone.connect do |platform|
+          platform.write_method = :char
+        end
+      end
+
+      it 'should put the value on the screen' do
+        expect(bluezone_system).to receive(:WriteScreen).with('b', 1, 2).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('l', 1, 3).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('a', 1, 4).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('h', 1, 5).once.and_return(0)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 100).exactly(4).times
+        bluezone.connect
+        bluezone.put_string('blah', 1, 2)
+      end
+
+      it 'should put the value on the screen with reduced wait delay if overridden' do
+        expect(bluezone_system).to receive(:WriteScreen).with('b', 1, 2).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('l', 1, 3).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('a', 1, 4).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('h', 1, 5).once.and_return(0)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 111).exactly(4).times
+        bluezone.connect
+        bluezone.max_wait_time = 111
+        bluezone.put_string('blah', 1, 2)
+      end
+
+      it 'should put the full string on the screen if allowed error codes returned' do
+        expect(bluezone_system).to receive(:WriteScreen).with('b', 1, 2).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('l', 1, 3).once.and_return(6)
+        expect(bluezone_system).to receive(:WriteScreen).with('a', 1, 4).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('h', 1, 5).once.and_return(6)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 100).exactly(4).times
+        bluezone.connect
+        bluezone.put_string('blah', 1, 2)
+      end
+
+      it 'should stop adding characters once an invalid error code is returned' do
+        expect(bluezone_system).to receive(:WriteScreen).with('b', 1, 2).once.and_return(4)
+        expect(bluezone_system).to receive(:WriteScreen).with('l', 1, 3).once.and_return(5)
+        expect(bluezone_system).to receive(:WriteScreen).with('a', 1, 4).once.and_return(10)
+        expect(bluezone_system).not_to receive(:WriteScreen).with('h', 1, 5)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 100).exactly(2).times
+        bluezone.connect do |platform|
+          platform.write_errors_to_ignore = [4, 5, 6]
+        end
+        bluezone.put_string('blah', 1, 2)
+      end
+
+      it 'should cast the value to a string before printing to the screen' do
+        expect(bluezone_system).to receive(:WriteScreen).with('1', 1, 2).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('2', 1, 3).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('3', 1, 4).once.and_return(0)
+        expect(bluezone_system).to receive(:WriteScreen).with('4', 1, 5).once.and_return(0)
+        expect(bluezone_system).to receive(:WaitReady).with(10, 100).exactly(4).times
+        bluezone.connect
+        bluezone.put_string(1234, 1, 2)
+      end
+    end
+  end
+
+  describe "interacting with the screen" do
+    it 'should know how to send function keys' do
+      expect(bluezone_system).to receive(:SendKey).with('<Clear>')
+      expect(bluezone_system).to receive(:WaitReady).with(10, 100)
+      bluezone.connect
+      bluezone.send_keys(TE3270.Clear)
+    end
+
+    it 'should know how to send function keys with reduced wait delay if overridden' do
+      expect(bluezone_system).to receive(:SendKey).with('<Clear>')
+      expect(bluezone_system).to receive(:WaitReady).with(10, 111)
+      bluezone.connect
+      bluezone.max_wait_time = 111
+      bluezone.send_keys(TE3270.Clear)
+    end
+
+    it 'should wait for a string to appear' do
+      expect(bluezone_system).to receive(:WaitForText).with('The String', 3, 10, 10).and_return(0)
+      bluezone.connect
+      bluezone.wait_for_string('The String', 3, 10)
+    end
+
+    it 'should respect custom timeout for a string to appear' do
+      expect(bluezone_system).to receive(:WaitForText).with('The String', 3, 10, 24).and_return(0)
+      bluezone.connect
+      bluezone.timeout = 24
+      bluezone.wait_for_string('The String', 3, 10)
+    end
+
+    it 'should wait for the host to be quiet' do
+      expect(bluezone_system).to receive(:Wait).with(4)
+      bluezone.connect
+      bluezone.wait_for_host(4)
+    end
+
+    it 'should wait until the cursor is at a position' do
+      expect(bluezone_system).to receive(:WaitCursor).with(10, 5, 8, 3).and_return(0)
+      bluezone.connect
+      bluezone.wait_until_cursor_at(5, 8)
+    end
+
+    it 'should respect custom timeout while waiting until the cursor is at a position' do
+      expect(bluezone_system).to receive(:WaitCursor).with(24, 5, 8, 3).and_return(0)
+      bluezone.connect
+      bluezone.timeout = 24
+      bluezone.wait_until_cursor_at(5, 8)
+    end
+
+    it "should get the screen text" do
+      expect(bluezone_system).to receive(:PSText).and_return('blah')
+      bluezone.connect
+      expect(bluezone.text).to eql 'blah'
+    end
+
+    if Gem.win_platform?
+      it 'should take screenshots' do
+        take = double('Take')
+        expect(bluezone_system).to receive(:WindowHandle).and_return(123)
+        expect(Win32::Screenshot::Take).to receive(:of).with(:window, hwnd: 123).and_return(take)
+        expect(take).to receive(:write).with('image.png')
+        bluezone.connect
+        bluezone.screenshot('image.png')
+      end
+
+      it 'should make the window visible before taking a screenshot' do
+        take = double('Take')
+        expect(bluezone_system).to receive(:WindowHandle).and_return(123)
+        expect(Win32::Screenshot::Take).to receive(:of).with(:window, hwnd: 123).and_return(take)
+        expect(take).to receive(:write).with('image.png')
+        expect(bluezone_window).to receive(:Visible=).twice.with(true)
+        expect(bluezone_window).to receive(:Visible=).twice.with(false)
+        bluezone.connect do |emulator|
+          emulator.visible = false
+        end
+        bluezone.screenshot('image.png')
+      end
+
+      it 'should delete the file for the screenshot if it already exists' do
+        expect(File).to receive(:exists?).and_return(true)
+        expect(File).to receive(:delete)
+        take = double('Take')
+        expect(bluezone_system).to receive(:WindowHandle).and_return(123)
+        expect(Win32::Screenshot::Take).to receive(:of).with(:window, hwnd: 123).and_return(take)
+        expect(take).to receive(:write).with('image.png')
+        bluezone.connect
+        bluezone.screenshot('image.png')
+      end
+    end
+  end
+end

data/spec/lib/te3270_spec.rb

@@ -84,13 +84,13 @@ describe TE3270 do
     if Gem.win_platform?
       it 'should accept a block when creating an emulator' do
         expect(WIN32OLE).to receive(:new).and_return(extra_system)
-        expect(extra_session).to receive(:Open).with('blah.edp').and_return(extra_session)
+        expect(extra_system.Sessions).to receive(:Open).with('blah.edp').and_return(extra_session)
         TE3270.emulator_for :extra do |emulator|
           emulator.session_file = 'blah.edp'
         end
       end
     end
-    
+
     it 'should allow one to disconnect using the module' do
       expect(platform).to receive(:disconnect)
       TE3270.disconnect(platform)

data/spec/spec_helper.rb

@@ -7,6 +7,20 @@ if Gem.win_platform?
   require 'win32/screenshot'
 end
 
+def bluezone_system
+  @bluezone_system ||= double('system')
+  allow(@bluezone_system).to receive(:Connect).and_return(0)
+  allow(@bluezone_system).to receive(:OpenSession).and_return(0)
+  allow(@bluezone_system).to receive(:Window).and_return(bluezone_window)
+  allow(@bluezone_system).to receive(:WindowState=)
+  @bluezone_system
+end
+
+def bluezone_window
+  @bluezone_window ||= double('window')
+  allow(@bluezone_window).to receive(:Visible=)
+  @bluezone_window
+end
 
 def extra_system
   @extra_system ||= double('system')

data/te3270.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'watir', '~> 6.0'
   spec.add_dependency 'win32screenshot' if Gem.win_platform?
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: te3270
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Jeffrey S. Morgan
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2020-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: page_navigation
@@ -47,16 +47,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,7 @@ files:
 - lib/te3270.rb
 - lib/te3270/accessors.rb
 - lib/te3270/emulator_factory.rb
+- lib/te3270/emulators/bluezone.rb
 - lib/te3270/emulators/extra.rb
 - lib/te3270/emulators/quick3270.rb
 - lib/te3270/emulators/virtel.rb
@@ -120,6 +121,7 @@ files:
 - lib/te3270/screen_populator.rb
 - lib/te3270/version.rb
 - spec/lib/te3270/accessors_spec.rb
+- spec/lib/te3270/emulators/bluezone_spec.rb
 - spec/lib/te3270/emulators/extra_spec.rb
 - spec/lib/te3270/emulators/quick3270_spec.rb
 - spec/lib/te3270/emulators/x3270_spec.rb
@@ -147,13 +149,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Automates a 3270 Terminal Emulator
 test_files:
 - spec/lib/te3270/accessors_spec.rb
+- spec/lib/te3270/emulators/bluezone_spec.rb
 - spec/lib/te3270/emulators/extra_spec.rb
 - spec/lib/te3270/emulators/quick3270_spec.rb
 - spec/lib/te3270/emulators/x3270_spec.rb