te3270-jruby 0.1-x86-mingw32

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0f0098ace54a7e8096d10bf8bd299049547189c
+  data.tar.gz: 8ba9e549544c8f1d87e3290ce5534708584470a4
+SHA512:
+  metadata.gz: 74fdd9bf36403bbbc924ab75d7deebd3157ce74589ce6952992a7a5bcd53341ec98e33d58c95814bd749774c9a9a967f794055bb764b161c7f2dbf2bbb80ad2d
+  data.tar.gz: 580038c7636473ee0f29a9a64990b932ae9b774f500d034a55a7ff4350b2ea11461053fe187931c4827d620440ba8c021a4a3c9de5f7c5f5cb29c383a6a28e32

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: jruby
+rvm:
+  - 1.7.10

data/ChangeLog

@@ -0,0 +1,2 @@
+=== Version 0.1 / 2014-2-9
+* Initial release with basic functionality for EXTRA X-treme! and Quick3270

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+require 'rbconfig'
+
+gem 'rake'
+gem 'fuubar'
+gem 'guard-rspec'
+gem 'wdm', '>= 0.1.0'
+gem 'rb-inotify'
+
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+
+guard :rspec, :all_on_start => true, :cmd => 'rspec --color --format Fuubar' do
+  watch(%r{^spec/*/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Pradeep K. Macharla
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# TE3270 for jruby
+
+This gem can be used to drive a 3270 terminal emulator in a ruby environment (jruby and non-jruby). The code has been tested on jruby 1.7.10 and mruby 2.0.x
+You have to have a supported emulator installed on the
+machines on which you use the gem.  Currently the only supported emulators are
+[EXTRA! X-treme](http://www.attachmate.com/Products/Terminal+Emulation/Extra/xtreme/extra-x-treme.htm) by
+Attachmate and [Quick3270](http://www.dn-computing.com/Quick3270.htm) by DN-Computing.  These are commercial
+products and you will need to purchase one of them in order to use this gem.  We do plan to support other
+emulators as time permits.
+
+## Documentation
+
+You can view the RDocs for this project [here](http://rubydoc.info/gems/te3270-jruby/0.1/frames).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'te3270-jruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install te3270-jruby
+
+## Usage
+
+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
+      include TE3270
+
+      text_field(:userid, 10, 30, 20)
+      text_field(:password, 12, 30, 20)
+
+      def login(username, password)
+        self.userid = username
+        self.password = password
+      end
+    end
+
+    emulator = TE3270.emulator_for :extra do |platform|
+      platform.session_file = 'sessionfile.edp'
+    end
+    my_screen = MainframeScreen.new(emulator)
+    my_screen.userid = 'the_id'
+    my_screen.password = 'the_password'
+
+If you are using this gem with cucumber then you can register the ScreenFactory module with the
+cucumber World like this:
+
+    World(TE3270::ScreenFactory)
+
+You also need to setup some hooks to start and stop the emulator:
+
+    Begin do
+      @emulator = TE3270.emulator_for :extra do |platform|
+        platform.session_file = 'sessionfile.edp'
+      end
+    end
+
+    After do
+      TE3270.disconnect(@emulator)
+    end
+
+This allows you to use the `on` method in your step definitions like this:
+
+    on(MainframeScreen).login('the_user', 'the_password')
+
+or you can use the version of `on` that takes a block like this:
+
+    on(MainframeScreen) do |screen|
+      screen.userid = 'the_id'
+      screen.password = 'the_password'
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ext/mkrf_conf.rb

@@ -0,0 +1,19 @@
+# Borrowed from http://www.programmersparadox.com/2012/05/21/gemspec-loading-dependent-gems-based-on-the-users-system/
+# The author mentions that this is not the right way to do when installing on different rubies like mruby, jruby, but
+# seems there is no other solution at this time, if a single gem has to work on both mruby and jruby
+
+begin
+  if RUBY_VERSION > "1.7" and RUBY_PLATFORM == "java"
+    installer.install "jruby-win32ole", ">=0"
+  else
+    installer.install "win32screenshot", ">=0"
+  end
+
+rescue
+  #Exit with a non-zero value to let rubygems know something went wrong
+  exit(1)
+end
+
+f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")
+f.write("task :default\n")
+f.close

data/lib/te3270/accessors.rb

@@ -0,0 +1,30 @@
+
+module TE3270
+  module Accessors
+
+    #
+    # adds two methods to the screen object - one to set text in a text field,
+    # another to retrieve text from a text field.
+    #
+    # @example
+    #   text_field(:first_name, 23,45,20)
+    #   # will generate 'first_name', 'first_name=' method
+    #
+    # @param  [String] the name used for the generated methods
+    # @param [FixedNum] row number of the location
+    # @param [FixedNum] column number of the location
+    # @param [FixedNum] length of the text field
+    # @param [true|false] editable is by default true
+    #
+  def text_field(name, row, column, length, editable=true)
+      define_method(name) do
+        platform.get_string(row, column, length)
+      end
+
+      define_method("#{name}=") do |value|
+        platform.put_string(value, row, column)
+      end if editable
+    end
+
+  end
+end

data/lib/te3270/emulator_factory.rb

@@ -0,0 +1,21 @@
+require 'te3270/emulators/extra'
+require 'te3270/emulators/quick3270'
+
+module TE3270
+  #
+  # Provides a mapping between a key used in the +emulator_for+ method
+  # and the class that implements the access to the emulator.
+  #
+  module EmulatorFactory
+
+    EMULATORS = {
+        extra: TE3270::Emulators::Extra,
+        quick3270: TE3270::Emulators::Quick3270
+    }
+
+    def self.emulator_for(platform)
+      EMULATORS[platform]
+    end
+
+  end
+end

data/lib/te3270/emulators/extra.rb

@@ -0,0 +1,224 @@
+module TE3270
+  module Emulators
+    #
+    # This class has the code necessary to communicate with the terminal emulator called EXTRA! X-treme.
+    # You can use this emulator by providing the +:extra+ parameter to the constructor of your screen
+    # object or by passing the same value to the +emulator_for+ method on the +TE3270+ module.
+    #
+    class Extra
+
+      attr_writer :session_file, :visible, :window_state, :max_wait_time
+
+      def initialize
+        if RUBY_PLATFORM == "java"
+          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 Extra System. This method expects a block in which certain
+      # platform specific values can be set.  Extra can take the following parameters.
+      #
+      # * session_file - this value is required and should be the filename of the session.
+      # * 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+.
+      #
+      # @example Example calling screen object constructor with a block
+      #   screen_object = MyScreenObject.new(:extra)
+      #   screen_object.connect do |emulator|
+      #     emulator.session_file = 'path_to_session_file'
+      #     emulator.visible = true
+      #     emulator.window_state = :maximized
+      #   end
+      #
+      def connect
+        start_extra_system
+
+        yield self if block_given?
+        raise 'The session file must be set in a block when calling connect with the Extra emulator.' if @session_file.nil?
+        open_session
+        @screen = session.Screen
+        @area = screen.SelectAll
+      end
+
+      #
+      # Disconnects the Extra System connection
+      #
+      def disconnect
+        system.Quit
+      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)
+        screen.GetString(row, column, length)
+      end
+
+      #
+      # Puts string at the coordinates specified.
+      #
+      # @param [String] str the string to set
+      # @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(str, row, column)
+        screen.PutString(str, row, column)
+        quiet_period
+      end
+
+      #
+      # Sends keystrokes to the host, including function keys.
+      #
+      # @param [String] keys keystokes up to 255 in length
+      #
+      def send_keys(keys)
+        screen.SendKeys(keys)
+        quiet_period
+      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)
+        wait_for do
+          screen.WaitForString(str, row, column)
+        end
+      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)
+        wait_for(seconds) do
+          screen.WaitHostQuiet
+        end
+      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)
+        wait_for do
+          screen.WaitForCursor(row, column)
+        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)
+        session.Visible = true unless visible
+
+        if RUBY_PLATFORM == "java"
+        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 = session.WindowHandle
+          Win32::Screenshot::Take.of(:window, hwnd: hwnd).write(filename)
+        end
+
+        session.Visible = false unless visible
+      end
+
+      #
+      # Returns the text of the active screen
+      #
+      # @return [String]
+      #
+      def text
+        area.Value
+      end
+
+      private
+
+      attr_reader :system, :sessions, :session, :screen, :area
+
+      WINDOW_STATES = {
+          minimized: 0,
+          normal: 1,
+          maximized: 2
+      }
+
+      def wait_for(seconds = system.TimeoutValue / 1000)
+        wait_collection = yield
+        wait_collection.Wait(seconds * 1000)
+      end
+
+      def quiet_period
+        wait_for_host(max_wait_time)
+      end
+
+      def max_wait_time
+        @max_wait_time ||= 1
+      end
+
+      def window_state
+        @window_state.nil? ? 1 : WINDOW_STATES[@window_state]
+      end
+
+      def visible
+        @visible.nil? ? true : @visible
+      end
+
+      def hide_splash_screen
+        version = system.Version
+        sessions.VisibleOnStartup = true if version.to_i >= 9
+      end
+
+      def open_session
+        @sessions = system.Sessions
+        hide_splash_screen
+        @session = sessions.Open @session_file
+        @session.WindowState = window_state
+        @session.Visible = visible
+      end
+
+      def start_extra_system
+        begin
+          @system = WIN32OLE.new('EXTRA.System')
+        rescue Exception => e
+          $stderr.puts e
+        end
+      end
+    end
+  end
+end

data/lib/te3270/emulators/quick3270.rb

@@ -0,0 +1,206 @@
+module TE3270
+  module Emulators
+
+    #
+    # This class has the code necessary to communicate with the terminal emulator called Quick3270.
+    # You can use this emulator by providing the +:quick+ parameter to the constructor of your screen
+    # object or by passing the same value to the +emulator_for+ method on the +TE3270+ module.
+    #
+
+    class Quick3270
+
+      attr_writer :session_file, :visible, :max_wait_time
+
+      def initialize
+        if RUBY_PLATFORM == "java"
+          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 Quick System. This method expects a block in which certain
+      # platform specific values can be set.  Quick can take the following parameters.
+      #
+      # * session_file - this value is required and should be the filename of the session.
+      # * visible - determines if the emulator is visible or not. If not set it will default to +true+.
+      #
+      # @example Example calling screen object constructor with a block
+      #   screen_object = MyScreenObject.new(:quick3270)
+      #   screen_object.connect do |emulator|
+      #     emulator.session_file = 'path_to_session_file'
+      #     emulator.visible = true
+      #   end
+      #
+      def connect
+        start_quick_system
+        yield self if block_given?
+        raise "The session file must be set in a block when calling connect with the Quick3270 emulator." if @session_file.nil?
+        establish_session
+      end
+
+      #
+      # Disconnects the Quick System connection
+      #
+      def disconnect
+        session.Disconnect
+        system.Application.Quit
+      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)
+        screen.GetString(row, column, length)
+      end
+
+      #
+      # Puts string at the coordinates specified.
+      #
+      # @param [String] str the string to set
+      # @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(str, row, column)
+        screen.MoveTo(row, column)
+        screen.PutString(str)
+        quiet_period
+      end
+
+      #
+      # Sends keystrokes to the host, including function keys.
+      #
+      # @param [String] keys keystokes up to 255 in length
+      #
+      def send_keys(keys)
+        screen.SendKeys(keys)
+        quiet_period
+      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)
+        screen.WaitForString(str, row, column)
+      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)
+        screen.WaitHostQuiet(seconds * 1000)
+      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)
+        screen.WaitForCursor(row, column)
+      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)
+        system.Visible = true unless visible
+
+        if RUBY_PLATFORM == "java"
+          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)
+          system.Visible = false unless visible
+        else
+          hwnd = session.WindowHandle
+          Win32::Screenshot::Take.of(:window, hwnd: hwnd).write(filename)
+        end
+      end
+
+      #
+      # Returns the text of the active screen
+      #
+      # @return [String]
+      #
+      def text
+        rows = screen.Rows
+        columns = screen.Cols
+        result = ''
+        rows.times { |row| result += "#{screen.GetString(row+1, 1, columns)}\\n" }
+        result
+      end
+
+      private
+
+      attr_reader :system, :session, :screen
+
+      def quiet_period
+        screen.WaitHostQuiet(max_wait_time)
+      end
+
+      def max_wait_time
+        @max_wait_time ||= 3000
+      end
+
+      def visible
+        @visible.nil? ? true : @visible
+      end
+
+      def start_quick_system
+        begin
+          @system = WIN32OLE.new('Quick3270.Application')
+        rescue Exception => e
+          $stderr.puts e
+        end
+      end
+
+      def establish_session
+        system.Visible = visible
+        @session = system.ActiveSession
+        session.Open @session_file
+        @screen = session.Screen
+        session.Connect
+        connected = session.Connected
+        while not connected
+          screen.WaitHostQuiet(1000)
+          connected = session.Connected
+        end
+      end
+
+    end
+  end
+end