te3270 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a8b2b1732325e0f1d627e16fd988c80944d739b
+  data.tar.gz: 4b8ce799ad173f61a8c5a77d53b581c859c766b4
+SHA512:
+  metadata.gz: 4e26aa6363315d7e23430fb27e9a2591bcac4d4d260d670b227b13361a4ea16c8f77edfe8d91a8d6a2e777a071ffa900e5aecd4706f4dbbfce96639b0f0a000d
+  data.tar.gz: 0903b33a885395ba1f5f60a02ed8816e228ce30a19cedb6a2f8c43fb6e5d5c209e0f51ccd83b9bab2b5478542e1894275566330331e683fa142ce344d5174877

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: ruby
+rvm:
+  - 2.0.0

data/ChangeLog

@@ -0,0 +1,29 @@
+=== Version 0.6.0 / 2015/4/21
+* Platform Independent Release
+
+=== Version 0.5.1 / 2015/4/19
+* Fixes
+  * Created release that will install on Windows platform
+
+=== Version 0.5.0 / 2015-4-14
+* Enhancements
+  * Added X3270 emulator support
+
+=== Version 0.4.1 / 2014-2-26
+* Fixes
+  * Fixed small issue with ordering of events in last release
+
+=== Version 0.4 / 2014-2-26
+* Enhancements
+  * calling super when factory method called with class that is not from TE3270
+
+=== Version 0.3 / 2014-2-25
+* Enhancements
+  * disconnect does not close all open sessions with Extra now - only the one that connect opened
+
+=== Version 0.2 / 2014-2-9
+* Enhancements
+  * Added populate_screen_with method to TE3270 to populate all fields that are included in provided Hash
+
+=== Version 0.1 / 2014-2-7
+* 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 Jeffrey S. Morgan
+
+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,110 @@
+# 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
+[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,
+and [X3270](http://x3270.bgp.nu/).
+The first two are commercial products and need to be purchased.
+X3270 is open source. Support for other
+emulators will be added as time permits.
+
+## Documentation
+
+You can view the RDocs for this project [here](http://rdoc.info/gems/te3270/frames).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'te3270'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install te3270
+
+## 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:
+
+    Before do
+      @emulator = TE3270.emulator_for :extra do |platform|
+        platform.session_file = 'sessionfile.edp'
+      end
+    end
+
+    After do
+      TE3270.disconnect(@emulator)
+    end
+
+The X3270 emulator supports these hooks:
+
+    Before do
+      @emulator = TE3270.emulator_for :x3270 do |platform|
+        platform.executable_command = 'path to the x3270 executable'
+        platform.host = 'name of host to connect to'
+        platform.max_wait_time = 42  # defaults to 10
+        platform.trace = true # turns on trace output from the emulator
+      end
+    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
+
+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.
+
+    # given this Hash
+    my_data = { userid: 'the_id', password: 'the_password' }
+
+    # you can simply call this method
+    on(MainframeScreen).populate_screen_with my_data
+
+
+## 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,17 @@
+require 'rubygems/dependency_installer.rb'
+
+installer = Gem::DependencyInstaller.new
+begin
+  if RUBY_PLATFORM == 'java'
+    installer.install "jruby-win32ole"
+  else 
+    installer.install "win32screenshot"
+  end
+
+  rescue
+    exit(1)
+end  
+
+f = File.open(File.join(File.dirname(__FILE__), "Rakefile"), "w")
+f.write("task :default\n")
+f.close

data/lib/te3270.rb

@@ -0,0 +1,166 @@
+require 'te3270/version'
+require 'te3270/accessors'
+require 'te3270/screen_factory'
+require 'te3270/screen_populator'
+require 'te3270/function_keys'
+require 'te3270/emulator_factory'
+
+#
+# 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 only supported emulators are EXTRA! X-treme by Attachmate and
+# Quick3270 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.
+#
+# This gem has been designed to work very similar to the page-object gem.  You will use it to create screen objects
+# for each screen in your application.  Here is an example of one and how it can be used:
+#
+# @example Example mainframe page
+#   class MainframeScreen
+#     include TE3270
+#
+#     text_field(:userid, 10, 30, 20, true)
+#     text_field(:password, 12, 30, 20, true)
+#   end
+#
+#    ...
+#
+#   emulator = TN3270.emulator_for :extra do |emulator|
+#     emulator.session_file = 'path_to_session_file'
+#   end
+#   my_screen = MainframeScreen.new(emulator)
+#   my_screen.userid = 'the_id'
+#   my_screen.password = 'the_password'
+#
+# Another option is to mixin the +TE3270::ScreenFactory+ module on use the factory methods to create the screen
+# objects.  If you are using Cucumber you can do this by calling the +World+ method in your env.rb file.  Then
+# you can use the factory and navigation methods in your step definitions.
+#
+# @example Registering the ScreenFactory with Cucumber World
+#   World(TE3270::ScreenFactory)
+#
+#   Before do
+#     @emulator = TE3270.emulator_for :quick3270 do |emulator|
+#       emulator.session_file = 'path_to_session_file'
+#     end
+#   end
+#
+#
+# @example Using the factory method in a step definition
+#   on(MainframeScreen).do_something
+#
+#
+# @see  #TE3270::ScreenFactory for more details on using the factory and navigation methods
+#
+module TE3270
+  include ScreenPopulator
+  extend FunctionKeys
+
+  def self.included(cls)
+    cls.extend TE3270::Accessors
+  end
+
+  #
+  # Starts the terminal emulator and makes the connection.  This method requires a block
+  # that has emulator specific information that is necessary to complete the connection.
+  # To know what information you should provide in the block please see the classes in
+  # the TE3270::Emulators package.
+  #
+  #@param platform =[:extra,:quick3270] use :extra for Extra emulator and :quick3270 for quick emulator
+  #
+  def self.emulator_for(platform, &block)
+    platform_class = TE3270::EmulatorFactory.emulator_for(platform)
+    @platform = platform_class.new
+    @platform.connect &block
+    @platform
+  end
+
+  #
+  # Disconnects and closes the emulator
+  #
+  def self.disconnect(emulator)
+    emulator.disconnect
+  end
+
+  def initialize(platform)
+    @platform = platform
+    initialize_screen if respond_to? :initialize_screen
+  end
+
+  #
+  # Open a new screen and connect to the host.  Platform specific values are set by
+  # passing a block to this method.  To see the valid platform specific values please
+  # read the documentation for your emulator class in the TE3270::Emulators module.
+  #
+  def connect
+    platform.connect
+  end
+
+  #
+  # Disconnect from platform (extra or quick)
+  #
+  def disconnect
+    platform.disconnect
+  end
+
+  #
+  # Send keys on the emulator
+  #
+  def send_keys(keys)
+    platform.send_keys(keys)
+  end
+
+  #
+  # Retrieves the text from the current screen
+  #
+  def text
+    platform.text
+  end
+
+  #
+  # Takes screenshot and saves to the filename specified.  If you have visibility set to false
+  # then this method will first of all make the screen visible, take the screenshot, and then
+  # make set visibility to false again.
+  #
+  # @param [String] filename of the file to be saved.
+  #
+  def screenshot(filename)
+    platform.screenshot(filename)
+  end
+
+  #
+  # Waits for the string to appear at the specified location
+  #
+  # @param [String] String to wait for
+  # @param [FixedNum] row number
+  # @param [FixedNum] column number
+  #
+  def wait_for_string(str, row, column)
+    platform.wait_for_string(str, row, column)
+  end
+
+  #
+  # Waits for the host for specified # of seconds. Default is 5 seconds
+  #
+  # @param [FixedNum] seconds to wait for
+  #
+  def wait_for_host(seconds=5)
+    platform.wait_for_host(seconds)
+  end
+
+  #
+  # Waits for the cursor to appear at the specified location
+  #
+  # @param [FixedNum] row number
+  # @param [FixedNum] column number
+  #
+  def wait_until_cursor_at(row, column)
+    platform.wait_until_cursor_at(row, column)
+  end
+
+  private
+
+  def platform
+    @platform ||= Extra.new
+  end
+
+end

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