butler-mainframe 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 905103b0a75c74a621416783ca7640547705ffc8
-  data.tar.gz: 96016897c77be9676a6fe2de3bd6871e004a6ce7
+  metadata.gz: 7ef1f82ef019d80d63559e5c67ca6f5caf190916
+  data.tar.gz: 7560a4984f33ff6505a6cec3b08e4eb928a3bba2
 SHA512:
-  metadata.gz: 1c859409e7690859468559bfa7bd5f25bdb884d0c0f28305e45bf953df01e508b86bd4fe3198f1f6d8c4f51439ec67c102fb8169a48c0ecf28aa681a51395661
-  data.tar.gz: 28ccc959ee5931b50d123e2d173be2ba6f898c136f4ccb6c5c068a0b5219622801b366ad16058c26fdf78347979e89c677eb6171ef6506582a79fd4cfc959ca5
+  metadata.gz: fdbecce1c86b27f41c7d0a94d6a6a49437620e81b3c4ced0a047554547235be86f506a253bfaf6a8c810e914c09526127fce0c620f6b6c35a528934fc4b0ecd1
+  data.tar.gz: 2e2023ac2ddfbefff4dc76b3914d840b49202bd4a9cffe03bf078564b6df516c882f5bb502479838af6d0ec935510f9dd68dadf9d5980814ca11ae5f14350e78

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.9.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.8.0...v0.9.0) June 20th, 2016
+------------------------------
+* PComm emulator: it attempts to start the connection if the terminal is present
+
 0.8.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.7.5...v0.8.0) May 3th, 2016
 ------------------------------
 * PComm emulator: the write param 'clean_chars_before_writing' didn't work

data/Gemfile

@@ -1,3 +1,4 @@
 source 'https://rubygems.org'
 
-gem "butler-mainframe", path: "."
+gem 'rake'
+gem 'butler-mainframe', path: '.'

data/lib/mainframe/customization/generic_functions.rb

@@ -17,7 +17,7 @@ module ButlerMainframe
     # :user             => ButlerMainframe::Settings.user,
     # :password         => ButlerMainframe::Settings.password,
     # :raise_on_abend   => false raise an exception if an abend is occured
-    def navigate destination, options={}
+    def navigate(destination, options={})
       options = {
           :session_user     => ButlerMainframe::Settings.session_user,
           :session_password => ButlerMainframe::Settings.session_password,
@@ -138,7 +138,7 @@ module ButlerMainframe
     # Login to mainframe
     # param1 user(array)        [text, y, x]
     # param2 password(array)    [text, y, x]
-    def session_login ar_user, ar_password
+    def session_login(ar_user, ar_password)
       puts "Starting session login..." if @debug
       user,     y_user,     x_user      = ar_user
       raise "Check session user configuration! #{user} #{y_user} #{x_user}" unless user && y_user && x_user
@@ -148,8 +148,8 @@ module ButlerMainframe
       wait_session
       #inizializza_sessione
       raise "It was waiting session login map instead of: #{catch_title}" unless session_login?
-      write user,      :y => y_user,      :x => x_user
-      write password,  :y => y_password,  :x => x_password, :sensible_data => true
+      write(user,      :y => y_user,      :x => x_user)
+      write(password,  :y => y_password,  :x => x_password, :sensible_data => true)
       do_enter
     end
 
@@ -167,7 +167,7 @@ module ButlerMainframe
 
       wait_session
       raise "It was waiting cics selezion map instead of: #{catch_title}, message: #{catch_message}" unless cics_selection?
-      write cics, :y => y_cics,   :x => x_cics
+      write(cics, :y => y_cics,   :x => x_cics)
       do_enter
       wait_session 1
     end
@@ -186,7 +186,7 @@ module ButlerMainframe
 
       wait_session
       raise "It was waiting company menu map instead of: #{catch_title}, message: #{catch_message}" unless company_menu?
-      write menu, :y => y_menu, :x => x_menu
+      write(menu, :y => y_menu, :x => x_menu)
       do_enter
     end
 
@@ -214,31 +214,27 @@ module ButlerMainframe
 
     # Get the title usually the first row
     # You can change default option :rows to get more lines starting from the first
-    def catch_title options={}
+    def catch_title(options={})
       options = {
           :rows                      => 1
       }.merge(options)
       scan(:y1 => 1, :x1 => 1, :y2 => options[:rows], :x2 => 80)
     end
-    def screen_title options={}
+    def screen_title(options={})
       show_deprecated_method 'catch_title'
-      catch_title options
+      catch_title(options)
     end
 
-    def execute_cics name
-      write name, :y => 1, :x => 2
+    def execute_cics(name)
+      write(name, :y => 1, :x => 2)
       do_enter
     end
 
-    def do_enter;   exec_command "ENTER"      end
-
-    def go_back;    exec_command "PA2"        end
-
-    def do_confirm; exec_command "PF3"        end
-
-    def do_quit;    exec_command "CLEAR"      end
-
-    def do_erase;   exec_command "ERASE EOF"  end
+    def do_enter;   exec_command("ENTER")     end
+    def go_back;    exec_command("PA2")       end
+    def do_confirm; exec_command("PF3")       end
+    def do_quit;    exec_command("CLEAR")     end
+    def do_erase;   exec_command("ERASE EOF") end
 
   end
 

data/lib/mainframe/emulators/passport.rb

@@ -8,7 +8,7 @@ module ButlerMainframe
     private
 
     # Create objects from emulator library
-    def sub_create_object options={}
+    def sub_create_object(options={})
       str_obj = 'PASSPORT.System'
       puts "#{Time.now.strftime "%H:%M:%S"} Creating object #{str_obj}..." if @debug == :full
       @action[:object] = WIN32OLE.new(str_obj)
@@ -45,19 +45,19 @@ module ButlerMainframe
     end
 
     #Execute keyboard command like PF1 or PA2 or ENTER ...
-    def sub_exec_command cmd, options={}
+    def sub_exec_command(cmd, options={})
       # Cast cmd to_s cause it could be passed as label
       @screen.SendKeys "<#{cmd.gsub /\s/, ''}>"
       @screen.WaitHostQuiet
     end
 
     #It reads one line part of the screen
-    def sub_scan_row y, x, len
+    def sub_scan_row(y, x, len)
       @screen.GetString(y, x, len)
     end
 
     #It reads a rectangle on the screen
-    def sub_scan_area y1, x1, y2, x2
+    def sub_scan_area(y1, x1, y2, x2)
       @screen.Area(y1, x1, y2, x2).Value
     end
 
@@ -67,31 +67,31 @@ module ButlerMainframe
     end
 
     # Move cursor to given coordinates
-    def sub_set_cursor_axes y, x, options={}
+    def sub_set_cursor_axes(y, x, options={})
       options = {
           :wait                     => true
       }.merge(options)
-      @screen.MoveTo y, x
+      @screen.MoveTo(y, x)
       @screen.WaitForCursor(y, x) if options[:wait]
     end
 
     # Write text on the screen at given coordinates
     # :check_protect => true add sensitivity to protected areas
-    def sub_write_text text, y, x, options={}
+    def sub_write_text(text, y, x, options={})
       options = {
           :check_protect              => true
       }.merge(options)
       if options[:check_protect]
         # This method is sensitive to protected areas
-        sub_set_cursor_axes y, x
-        @screen.SendKeys text
+        sub_set_cursor_axes(y, x)
+        @screen.SendKeys(text)
       else
         @screen.PutString(text, y, x)
       end
     end
 
     # Wait text at given coordinates and wait the session is available again
-    def sub_wait_for_string text, y, x
+    def sub_wait_for_string(text, y, x)
       @screen.WaitForString(text, y, x).Value == -1
     end
 

data/lib/mainframe/emulators/pcomm.rb

@@ -10,13 +10,17 @@ module ButlerMainframe
     private
 
     # Create objects from emulator library
-    def sub_create_object options={}
+    def sub_create_object(options={})
       str_obj = 'PComm.autECLSession'
       puts "#{Time.now.strftime "%H:%M:%S"} Creating object #{str_obj}..." if @debug == :full
       @action[:object] = WIN32OLE.new(str_obj)
       @action[:object].SetConnectionByName @session_tag
       @space  = @action[:object].autECLPS
       @screen = @action[:object].autECLOIA
+      if @action[:object] && @action[:object].Started && !@action[:object].CommStarted
+        @action[:object].StartCommunication
+        wait_session(WAIT_AFTER_START_CONNECTION)
+      end
     end
 
     # Check is session is started
@@ -49,29 +53,29 @@ module ButlerMainframe
         # See http://www-01.ibm.com/support/knowledgecenter/SSEQ5Y_6.0.0/com.ibm.pcomm.doc/books/html/admin_guide10.htm?lang=en
         cmd_stop = "PCOMSTOP /S=#{@session_tag} /q"
         if /^1.8/ === RUBY_VERSION
-          Thread.new {system cmd_stop}
+          Thread.new { system cmd_stop }
         else
-          Process.spawn cmd_stop
+          Process.spawn(cmd_stop)
         end
         # Process.kill 9, @pid #Another way is to kill the process but the session start 2nd process pcscm.exe
       end
     end
 
     #Execute keyboard command like PF1 or PA2 or ENTER ...
-    def sub_exec_command cmd, options={}
+    def sub_exec_command(cmd, options={})
       # Cast cmd to_s cause it could be passed as label
-      @space.SendKeys "[#{cmd}]"
-      @screen.WaitForAppAvailable @timeout
-      @screen.WaitForInputReady @timeout
+      @space.SendKeys("[#{cmd}]")
+      @screen.WaitForAppAvailable(@timeout)
+      @screen.WaitForInputReady(@timeout)
     end
 
     #It reads one line part of the screen
-    def sub_scan_row y, x, len
+    def sub_scan_row(y, x, len)
       @space.GetText(y, x, len)
     end
 
     #It reads a rectangle on the screen
-    def sub_scan_area y1, x1, y2, x2
+    def sub_scan_area(y1, x1, y2, x2)
       @space.GetTextRect(y1, x1, y2, x2)
     end
 
@@ -81,17 +85,17 @@ module ButlerMainframe
     end
 
     # Move cursor to given coordinates
-    def sub_set_cursor_axes y, x, options={}
+    def sub_set_cursor_axes(y, x, options={})
       options = {
           :wait                     => true
       }.merge(options)
-      @space.SetCursorPos y, x
+      @space.SetCursorPos(y, x)
       @space.WaitForCursor(y, x, @timeout) if options[:wait]
     end
 
     # Write text on the screen at given coordinates
     # :check_protect => true add sensitivity to protected areas
-    def sub_write_text text, y, x, options={}
+    def sub_write_text(text, y, x, options={})
       options = {
           :check_protect              => true
       }.merge(options)
@@ -105,9 +109,9 @@ module ButlerMainframe
     end
 
     # Wait text at given coordinates and wait the session is available again
-    def sub_wait_for_string text, y, x
-      @space.WaitForString text, y, x, @timeout
-      @screen.WaitForInputReady @timeout
+    def sub_wait_for_string(text, y, x)
+      @space.WaitForString(text, y, x, @timeout)
+      @screen.WaitForInputReady(@timeout)
     end
 
   end

data/lib/mainframe/emulators/x3270.rb

@@ -8,14 +8,14 @@ module ButlerMainframe
 
     private
 
-    def sub_create_object options={}
+    def sub_create_object(options={})
       str_obj = "#{options[:session_path]}"
       puts "#{Time.now.strftime "%H:%M:%S"} Creating object #{str_obj}..." if @debug == :full
       @action = {}
       @action[:in], @action[:out], @action[:thr] = Open3.popen2e(str_obj)
       @action[:object] = true
       sleep WAIT_AFTER_START_SESSION
-      @pid    = @action[:thr].pid
+      @pid = @action[:thr].pid
     end
 
     # Check is session is started
@@ -56,7 +56,7 @@ module ButlerMainframe
       x_cmd cmd
 
       command_skip_wait = %w(^erase ^delete)
-      x_cmd "Wait(#{@timeout}, Output)" unless /(#{command_skip_wait.join('|')})/i === cmd
+      x_cmd("Wait(#{@timeout}, Output)") unless /(#{command_skip_wait.join('|')})/i === cmd
     end
 
     #It reads one line part of the screen
@@ -71,29 +71,29 @@ module ButlerMainframe
 
     # Get cursor coordinates
     def sub_get_cursor_axes
-      res = x_cmd "Query(Cursor)"
-      res.split.map{|c| c.to_i + 1}
+      res = x_cmd("Query(Cursor)")
+      res.split.map { |c| c.to_i + 1 }
     end
 
     # Move cursor to given coordinates
-    def sub_set_cursor_axes y, x, options={}
+    def sub_set_cursor_axes(y, x, options={})
       options = {
           :wait                     => true
       }.merge(options)
-      x_cmd "MoveCursor(#{y-1},#{x-1})"
+      x_cmd("MoveCursor(#{y-1},#{x-1})")
       if options[:wait]
-        x_cmd "Wait(#{@timeout},InputField)"
+        x_cmd("Wait(#{@timeout},InputField)")
         raise "Positioning the cursor at the coordinates (#{y}, #{x}) failed!" unless sub_get_cursor_axes == [y, x]
       end
     end
 
     # Write text on the screen at given coordinates
     # :check_protect => true add sensitivity to protected areas
-    def sub_write_text text, y, x, options={}
+    def sub_write_text(text, y, x, options={})
       options = {
           :check_protect              => true
       }.merge(options)
-      sub_set_cursor_axes y, x
+      sub_set_cursor_axes(y, x)
       x_cmd "String(\"#{text}\")", options
       # TODO
       # if options[:check_protect]
@@ -101,7 +101,7 @@ module ButlerMainframe
     end
 
     # Wait text at given coordinates
-    def sub_wait_for_string text, y, x
+    def sub_wait_for_string(text, y, x)
       x_cmd "Wait(#{@timeout},InputField)"
       total_time = 0.0
       sleep_time = 0.5
@@ -115,7 +115,7 @@ module ButlerMainframe
     end
 
     # To communicate with executable
-    def x_cmd cmd, options={}
+    def x_cmd(cmd, options={})
       puts "x_cmd in: #{options[:sensible_data] ? ('*' * cmd.size) : cmd}" if @debug == :full
       @action[:in].print "#{cmd}\n"
       @action[:in].flush

data/lib/mainframe/host_base.rb

@@ -9,11 +9,12 @@ module ButlerMainframe
     attr_reader :action, :wait
     attr_accessor :debug, :close_session
 
-    MAX_TERMINAL_COLUMNS      = 80
-    MAX_TERMINAL_ROWS         = 24
-    WAIT_AFTER_START_SESSION  = 3 #SECONDS
+    MAX_TERMINAL_COLUMNS        = 80
+    MAX_TERMINAL_ROWS           = 24
+    WAIT_AFTER_START_CONNECTION = 1 #SECONDS
+    WAIT_AFTER_START_SESSION    = 3 #SECONDS
 
-    def initialize options={}
+    def initialize(options={})
       options = {
           :session_tag          => ButlerMainframe.configuration.session_tag,
           :wait                 => 0.01,  # wait screen in seconds
@@ -74,33 +75,33 @@ module ButlerMainframe
 
 
     # Sleep time between operations
-    def wait_session wait=nil
+    def wait_session(wait=nil)
       sleep(wait || (@debug ? @wait_debug : @wait))
     end
 
     # Execute keyboard command like PF1 or PA2 or ENTER ...
-    def exec_command cmd
+    def exec_command(cmd)
       puts "Command: #{cmd}" if @debug
       sub_exec_command cmd
       wait_session
     end
 
     # It reads one line or an area on the screen according to parameters supplied
-    def scan options={}
+    def scan(options={})
       options = {
           :y  => nil, :x  => nil, :len => nil,
           :y1 => nil, :x1 => nil, :y2  => nil, :x2 => nil,
       }.merge(options)
       if options[:len]
-        scan_row options[:y], options[:x], options[:len]
+        scan_row(options[:y], options[:x], options[:len])
       else
-        scan_area options[:y1], options[:x1], options[:y2], options[:x2]
+        scan_area(options[:y1], options[:x1], options[:y2], options[:x2])
       end
     end
 
     # Scans and returns the text of the entire page
     def scan_page
-      scan_area 1, 1, MAX_TERMINAL_ROWS, MAX_TERMINAL_COLUMNS
+      scan_area(1, 1, MAX_TERMINAL_ROWS, MAX_TERMINAL_COLUMNS)
     end
 
     # Write text on screen at the coordinates
@@ -114,7 +115,7 @@ module ButlerMainframe
     #     :sensible_data              => nil,
     #     :clean_chars_before_writing => nil, # clean x chars before writing a value, it switch off erase_before_writing
     #     :erase_before_writing       => nil  # execute an erase until end of field before write a text
-    def write text, options={}
+    def write(text, options={})
       options = show_deprecated_param(:erase_field_first, :erase_before_writing, options)       if options[:erase_field_first]
       options = show_deprecated_param(:clean_first_chars, :clean_chars_before_writing, options) if options[:clean_first_chars]
       options = {
@@ -129,10 +130,8 @@ module ButlerMainframe
       }.merge(options)
       options[:erase_before_writing] = false if options[:clean_chars_before_writing]
 
-      y           = options[:y]
-      x           = options[:x]
-      y         ||= get_cursor_axes[0]
-      x         ||= get_cursor_axes[1]
+      y   = options[:y] || get_cursor_axes[0]
+      x   = options[:x] || get_cursor_axes[1]
 
       hooked_rows = 2
       raise "Missing coordinates! y(row)=#{y} x(column)=#{x} "  unless x && y
@@ -143,7 +142,7 @@ module ButlerMainframe
         (y-hooked_rows..y+hooked_rows).each do |row_number|
           if /#{options[:hook]}/ === scan_row(row_number, 1, MAX_TERMINAL_COLUMNS)
             puts "Change y from #{y} to #{row_number} cause hook to:#{options[:hook]}" if row_number != y && @debug
-            bol_written = write_text_on_map text, row_number, x, options
+            bol_written = write_text_on_map(text, row_number, x, options)
             break
           end
         end
@@ -160,8 +159,8 @@ module ButlerMainframe
     end
 
     # Move the cursor at given coordinates
-    def set_cursor_axes y, x, options={}
-      sub_set_cursor_axes y, x, options
+    def set_cursor_axes(y, x, options={})
+      sub_set_cursor_axes(y, x, options)
     end
 
     private
@@ -171,7 +170,7 @@ module ButlerMainframe
     # These are the options with default values:
     #     :session_tag      => Fixnum, String or null depending on emulator
     #     :debug            => boolean
-    def create_object options={}
+    def create_object(options={})
       connection_attempts       = 10
       seconds_between_attempts  = 1
 
@@ -224,7 +223,7 @@ module ButlerMainframe
     #     :browser_path     => browser executable path, default value ButlerMainframe::Settings.browser_path (used by web emulator)
     #     :session_url      => the session url used by browser
     #     :session_path     => terminal session executable path, default value ButlerMainframe::Settings.session_path
-    def start_terminal_session options
+    def start_terminal_session(options)
       # Check configuration to know emulator starting type
       executable, args =  if options[:browser_path] && !options[:browser_path].empty?
                             [options[:browser_path], options[:session_url]]
@@ -248,22 +247,22 @@ module ButlerMainframe
     end
 
     #It reads one line on the screen
-    def scan_row y, x, len
-      str = sub_scan_row y, x, len
+    def scan_row(y, x, len)
+      str = sub_scan_row(y, x, len)
       puts "Scan row y:#{y} x:#{x} lungo:#{len} = #{str}" if @debug
       str
     end
 
     #It reads a rectangle on the screen
-    def scan_area y1, x1, y2, x2
-      str = sub_scan_area y1, x1, y2, x2
+    def scan_area(y1, x1, y2, x2)
+      str = sub_scan_area(y1, x1, y2, x2)
       puts "Scan area y1:#{y1} x1:#{x1} y2:#{y2} x2:#{x2} = #{str}" if @debug
       str
     end
 
     # Write a text on the screen
     # It also contains the logic to control the successful writing
-    def write_text_on_map text, y, x, options={}
+    def write_text_on_map(text, y, x, options={})
       options = {
           :check                      => true,
           :raise_error_on_check       => true,
@@ -281,17 +280,17 @@ module ButlerMainframe
       end
 
       if options[:erase_before_writing]
-        set_cursor_axes y, x
+        set_cursor_axes(y, x)
         do_erase
       end
 
-      sub_write_text text, y, x, :check_protect => options[:check]
+      sub_write_text(text, y, x, :check_protect => options[:check])
       res = true
       # If check is required it verify text is on the screen at given coordinates
       # Sensible data option disable the check because it could be on hidden fields
       if options[:check] && !options[:sensible_data]
         # It expects the string is present on the session at the specified coordinates
-        unless sub_wait_for_string text, y, x
+        unless sub_wait_for_string(text, y, x)
           if options[:raise_error_on_check]
             raise "write_text_on_map: Impossible to write #{options[:sensible_data] ? ('*' * text.size) : text} at row #{y} column #{x}"
           else
@@ -302,18 +301,18 @@ module ButlerMainframe
       res
     end
 
-    def show_deprecated_param old, new, params={}
+    def show_deprecated_param(old, new, params={})
       #Ruby 2+ caller_locations(1,1)[0].label
       puts "[DEPRECATION] please use param :#{new} instead of :#{old} for method #{caller[0][/`([^']*)'/, 1]}"
       # Creating new param with the value of the old param
       {new => params[old]}.merge(params)
     end
-    def show_deprecated_method new
+    def show_deprecated_method(new)
       puts "[DEPRECATION] please use #{new} method instead of #{caller[0][/`([^']*)'/, 1]}"
     end
 
     # If is called a not existing method there is the chance that an optional module may not have been added
-    def method_missing method_name, *args
+    def method_missing(method_name, *args)
       raise NoMethodError, "Method #{method_name} not found! Please check you have included any optional modules"
     end
 

data/test/test.rake

@@ -99,7 +99,7 @@ def simple_iteration options={}
 
   navigate host, :session_login
 
-  host.close_session
+  host.quit
 end
 
 # Easy navigation for rake test

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: butler-mainframe
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Marco Mastrodonato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-06-20 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides a virtual butler which can perform your custom tasks
   on a 3270 emulator. Choose your emulator, configure your task and discover a new