butler-mainframe 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e16b62e1fe43ac913e3abf67d472103f7cfb1a6
-  data.tar.gz: b9939a2aeea193b0fa8e1fa398d615796044a481
+  metadata.gz: c5b3e86c2581052e59a8f1e74ff1da11a09ebb3c
+  data.tar.gz: ddb71edc9e79c6b0a487e975f9bf9b2074b80beb
 SHA512:
-  metadata.gz: 913d2e2e8ee7bf21878261a1a883afaef16bce3eabb4a65cf70f5d7624d2dbc081db01b88f071d525435cb2d7e49b9f2e96056955905b1e061a367f84ac294bf
-  data.tar.gz: dd1c7ab32a76f4448d32fe859e22a31d7c520dd9ef4e60883a3906781f17ca3ef616682dcfcba1967559b6ac6520276ade306531142a8f7eb7d78dd6d7797785
+  metadata.gz: 542c1c9854d0163f5562cbc1bf2216ddf5294599362c8a8dc27d8fa2aeb82798c6d12c0dac9b8d2aaec842f3c71628306432e64a45ef3df1b234eacf471a381c
+  data.tar.gz: 2a176d220c4f589313277eb8674c255ce1fff43e0d61a004e8919f9b0406ea0885d0a9cc1e04c59dadfa77fa10c461de0805ad5ea11769c0d49355f2699cf17a

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.5.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.4.0...v0.5.0) October 26th, 2015
+------------------------------
+* Moved sensible parameters in a separate yml file (private.yml) do not share it
+* Added coordinates to some setting variables
+* Little improvements to navigation method
+
 0.4.0 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.3.0...v0.4.0) October 22th, 2015
 ------------------------------
 * Improved x3270 sub class stability. Added a delay after session starting

data/README.md

@@ -31,10 +31,11 @@ At the moment are managed the below emulators. First two are commercial which mu
 
 ## Configuration
 
-In the config folder there are two files:
+In the config folder there are three files:
 
    * config.rb
    * settings.yml
+   * private.yml
 
 ### Emulator configuration
 
@@ -73,9 +74,9 @@ ButlerMainframe.configure do |config|
 end
 ```
 
-### Use configuration
+### Configure the navigation
 
-settings.yml for the variables necessary to use the emulator like user, password, cics selection and everything else. It has one section for every environment in rails style.
+settings.yml and private.yml for the variables necessary to use the emulator like user, password, cics selection and everything else. Put sensible data in the second one and remember to not share it. Both have one section for every environment in rails style.
 
     foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
         bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
@@ -126,7 +127,7 @@ host.scan x: 10, y: 10, len: 10
 host.write 'ruby on rails', :y => 6, :x => 15
 
 # write a text using a hook
-# With the hook you can use a regular expression to search a label on the y axis (3 rows up and down)
+# With the hook you can use a regular expression to search a label on the y axis (2 rows up and down)
 # It is usefull when the y position could change (atm it does not use x axis)
 host.write 'ruby on rails', :y => 6, :x => 15, hook: 'SYSTEM='
 ```
@@ -252,7 +253,7 @@ I'll try to comment supported emulators based on my experience of about 11 years
 
 2. **IBM Personal communication**: it happened that the session got stuck even if it was extremely rare event and i could not never attribute the blame to it. I must also mention the fact that two different processes creates only troubles. High price but at the moment seems to be the best choice.
 
-3. **x3270**: support is improving, it's free and open source. In future may become the best choice.
+3. **x3270**: support is improving, it's free and open source. In the future may become the best choice.
 
 ## More informations about supported emulators
 
@@ -384,20 +385,24 @@ Read the methods list documentation: [windows](http://x3270.bgp.nu/Windows/wc327
 ## ToDo
 
 * <s>Improve unit test</s> **Done** although it is still a simple rake
+* Improve write extending hooks to x axis and other ideas I have in mind
 * Improve static navigation
 * Add meta class to choose your host method name and multi language support as well
 
-## License
-
-The GNU Lesser General Public License, version 3.0 (LGPL-3.0)
-See LICENSE file
-Custom files are yours and not under license.
-
-
 ## Found a bug?
 
 If you are having a problem please open an issue. You can also send an email to m.mastrodonato@gmail.com
 
+## Contributing
 
+1. Fork it
+2. Create your feature branch (`git checkout -b my-feature`)
+3. Commit your changes (`git commit -am 'I made extensive use of all my creativity'`)
+4. Push to the branch (`git push origin my-feature`)
+5. Create new Pull Request
 
+## License
 
+The GNU Lesser General Public License, version 3.0 (LGPL-3.0)
+See LICENSE file
+Custom files are yours and not under license.

data/lib/butler-mainframe.rb

@@ -30,7 +30,10 @@ debug = env == "development" ? true : false
 require "mainframe/emulators/#{ButlerMainframe.configuration.host_gateway.to_s.downcase}"
 
 
-ButlerMainframe::Settings.load!(File.join(ButlerMainframe.root,'lib','config','settings.yml'), :env => env)
+%w(settings.yml private.yml).each  do |file|
+  filepath = File.join(ButlerMainframe.root,'lib','config',file)
+  ButlerMainframe::Settings.load!(filepath, :env => env) if File.exist? filepath
+end
 
 require 'mainframe/customization/active_record'
 # puts "Extending Host class with #{Host3270::ActiveRecord}" if debug

data/lib/config/config.rb

@@ -1,6 +1,6 @@
 ButlerMainframe.configure do |config|
   config.host_gateway   = :x3270
   config.session_path   = '"C:/Program Files (x86)/wc3270/ws3270.exe" YOUR_HOST_IP -model 2 --'
-  config.timeout        = 5 # In seconds
+  config.timeout        = 6 # In seconds
 end
 

data/lib/config/config_EXAMPLE_passport.rb

@@ -1,7 +1,7 @@
 ButlerMainframe.configure do |config|
   config.host_gateway   = :passport
   config.browser_path   = 'c:/Program Files (x86)/Internet Explorer/iexplore.exe'
-  config.session_url    = 'https://localhost/zephyr/Ecomes.zwh?sessionprofile=3270dsp/Sessions/host3270'
+  config.session_url    = 'https://YOUR_HOST_IP/zephyr/Ecomes.zwh?sessionprofile=3270dsp/Sessions/host3270'
   config.session_tag    = 1
   config.timeout        = 6000
 end

data/lib/config/config_EXAMPLE_pcomm.rb

@@ -1,6 +1,10 @@
 ButlerMainframe.configure do |config|
   config.host_gateway   = :pcomm
-  config.session_path   = '"C:/Program Files (x86)/IBM/Personal Communications/pcsws.exe" "C:/Users/XXXXXXXXXX/AppData/Roaming/IBM/Personal Communications/host3270.ws" /Q /H /S=A'
+  # These the used parameters:
+  # /Q to suppress starting logo
+  # /H for hidden session
+  # /S=A to select the session A (must be the same in session_tag)
+  config.session_path   = '"C:/Program Files (x86)/IBM/Personal Communications/pcsws.exe" "C:/Users/YOUR_USER/AppData/Roaming/IBM/Personal Communications/host3270.ws" /Q /H /S=A'
   config.session_tag    = 'A'
   config.timeout        = 6000
 end

data/lib/config/private.yml

@@ -0,0 +1,16 @@
+defaults: &defaults
+  session_user:     ['YOUR_USER', 16, 36]
+  session_password: ['YOUR_PASSWORD', 17, 36]
+  #foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
+  #  bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+  session_user:     ['YOUR_USER', 16, 36]
+  session_password: ['YOUR_PASSWORD', 17, 36]

data/lib/config/settings.yml

@@ -1,19 +1,18 @@
 defaults: &defaults
-  # The number of iteration through static screen
-  navigation_iterations: 10
-  cics: '7'
-  user: 'YOURUSER'
-  password: 'YOURPASSWORD'
-  #foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
-  #  bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
+  # The max number of iteration through static screen
+  max_attempts_number: 20
+  session_login_tag:  'EMSP00'                                  # Use a regular expression
+  cics_selection_tag: 'EMSP01'                                  # Use a regular expression
+  cics:               ['7', 23, 14]                             # Text to write at coordinates y, x
+  company_menu:       ['01', 24, 43]
   logoff_cics:        'cesf logoff'
-  session_login_tag:  'EMSP00' #use a regular expression
-  cics_selection_tag: 'EMSP01' #use a regular expression
-  company_menu_tag:   '\*\*       \*\*        \*\*        \*\*' #use a regular expression
+  company_menu_tag:   '\*\*       \*\*        \*\*        \*\*' # Use a regular expression
   # Starts these transactions from blank cics in order to move forward
   transactions_cics:
     company_menu:     'vita'
     main_application: 'life'
+  #foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
+  #  bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
 
 development:
   <<: *defaults
@@ -23,4 +22,4 @@ test:
 
 production:
   <<: *defaults
-  cics: 4
+  cics: ['4', 23, 14]

data/lib/config/settings_EXAMPLE.yml

@@ -1,19 +1,18 @@
 defaults: &defaults
-  # The number of iteration through static screen
-  navigation_iterations: 10
-  cics: '7'
-  user: 'YOURUSER'
-  password: 'YOURPASSWORD'
-  #foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
-  #  bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
+  # The max number of iteration through static screen
+  max_attempts_number: 20
+  session_login_tag:  'EMSP00'                                  # Use a regular expression
+  cics_selection_tag: 'EMSP01'                                  # Use a regular expression
+  cics:               ['7', 23, 14]                             # Text to write at coordinates y, x
+  company_menu:       ['01', 24, 43]
   logoff_cics:        'cesf logoff'
-  session_login_tag:  'EMSP00' #use a regular expression
-  cics_selection_tag: 'EMSP01' #use a regular expression
-  company_menu_tag:   '\*\*       \*\*        \*\*        \*\*' #use a regular expression
+  company_menu_tag:   '\*\*       \*\*        \*\*        \*\*' # Use a regular expression
   # Starts these transactions from blank cics in order to move forward
   transactions_cics:
     company_menu:     'vita'
     main_application: 'life'
+  #foo: add every variable you need and use it with => ButlerMainframe::Settings.foo
+  #  bar: sub variable are accessible with hash => ButlerMainframe::Settings.foo[:bar]
 
 development:
   <<: *defaults
@@ -23,4 +22,4 @@ test:
 
 production:
   <<: *defaults
-  cics: 4
+  cics: ['4', 23, 14]

data/lib/mainframe/customization/generic_functions.rb

@@ -30,19 +30,23 @@ module Host3270
     # :raise_on_abend   => false raise an exception if an abend is occured
     def navigate destination, options={}
       options = {
+          :session_user     => ButlerMainframe::Settings.session_user,
+          :session_password => ButlerMainframe::Settings.session_password,
           :cics             => ButlerMainframe::Settings.cics,
-          :user             => ButlerMainframe::Settings.user,
-          :password         => ButlerMainframe::Settings.password,
+          :company_menu     => ButlerMainframe::Settings.company_menu,
           :raise_on_abend   => false
       }.merge(options)
-      attempts_number       = ButlerMainframe::Settings.navigation_iterations
+      max_attempts_number   = ButlerMainframe::Settings.max_attempts_number
       transactions_cics     = ButlerMainframe::Settings.transactions_cics
 
       raise "Destination #{destination} not valid, please use: #{destination_list.join(', ')}" unless destination_list.include? destination
 
       puts "Navigating to #{destination}" if @debug
-      bol_found = nil
-      attempts_number.times do
+      destination_found = nil
+      attempt_number    = 0
+      while !destination_found do
+        attempt_number += 1
+
         if abend?
           puts "Navigate: abend" if @debug
           options[:raise_on_abend] ? raise(catch_abend) : do_quit
@@ -54,14 +58,14 @@ module Host3270
               do_quit
             when  :back               then
               do_quit
-              bol_found = true; break
+              destination_found = true
             when :next                then
-              company_menu
-              bol_found = true; break
-            when :company_menu        then bol_found = true; break
+              company_menu options[:company_menu]
+              destination_found = true
+            when :company_menu        then destination_found = true
             else
               # Every other destination is forward
-              company_menu
+              company_menu options[:company_menu]
           end
         elsif cics?
           puts "Navigating to #{destination} from cics" if @debug
@@ -71,10 +75,10 @@ module Host3270
               execute_cics ButlerMainframe::Settings.logoff_cics
             when :back                then
               execute_cics ButlerMainframe::Settings.logoff_cics
-              bol_found = true; break
+              destination_found = true
             when :next                then
               execute_cics transactions_cics[:main_application]
-              bol_found = true; break
+              destination_found = true
             when :company_menu        then
               execute_cics transactions_cics[:company_menu]
             else
@@ -84,14 +88,14 @@ module Host3270
         elsif cics_selection?
           puts "Navigating to #{destination} from cics selection" if @debug
           case destination
-            when :cics_selection      then bol_found = true; break
+            when :cics_selection      then destination_found = true
             when :session_login       then exec_command("PF3")
             when :next                then
               cics_selection options[:cics] if options[:cics]
-              bol_found = true; break
+              destination_found = true
             when :back                then
               exec_command("PF3")
-              bol_found = true; break
+              destination_found = true
             else
               cics_selection options[:cics] if options[:cics]
           end
@@ -99,25 +103,25 @@ module Host3270
           puts "Navigating to #{destination} from session login" if @debug
           case destination
             when :session_login,
-                 :back                then bol_found = true; break
+                 :back                then destination_found = true
             when :next                then
-              session_login options[:user], options[:password] if options[:user] && options[:password]
-              bol_found = true; break
+              session_login options[:session_user], options[:session_password]
+              destination_found = true
             else
-              session_login options[:user], options[:password] if options[:user] && options[:password]
+              session_login options[:session_user], options[:session_password]
           end
         else
           puts "Navigating to #{destination} from unknown screen" if @debug
           # If we do not know where we are...
           case destination
-            when  :session_login    then
+            when  :session_login      then
               # ...to come back to the first screen we surely have to go back
               go_back
             when  :back               then
               # ...we can try to go back (not all the screen may go back in the same way)
               go_back
-              bol_found = true; break
-            when :next              then
+              destination_found = true
+            when :next                then
               # ...but we dont know how to move forward
               raise "Define how to go forward in the navigation method on generic function module"
             else
@@ -125,10 +129,11 @@ module Host3270
               raise "Destination #{destination} not defined in the current screen"
           end
         end
+        break if attempt_number > max_attempts_number
         wait_session
       end
 
-      raise "It was waiting #{destination} map instead of: #{screen_title(:rows => 2).strip}" unless bol_found
+      raise "It was waiting #{destination} map instead of: #{screen_title(:rows => 2).strip}" unless destination_found
     end
 
     # Check if we are the first blank cics screen
@@ -142,15 +147,20 @@ module Host3270
     end
 
     # Login to mainframe
-    # param1 user
-    # param2 password [sensible data]
-    def session_login user, password
+    # param1 user(array)        [text, y, x]
+    # param2 password(array)    [text, y, x]
+    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
+      password, y_password, x_password  = ar_password
+      raise "Check session password configuration! #{password} #{y_password} #{x_password}" unless password && y_password && x_password
+
       wait_session
       #inizializza_sessione
       raise "It was waiting session login map instead of: #{screen_title}" unless session_login?
-      write user,      :y => 16, :x => 36
-      write password,  :y => 17, :x => 36, :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
 
@@ -160,12 +170,15 @@ module Host3270
     end
 
     # On this map, we have to select the cics environment
-    # param1 cics usually is a number
-    def cics_selection cics
+    # param1 cics(array)        [text, y, x]
+    def cics_selection ar_cics
       puts "Starting selezione_cics..." if @debug
+      cics, y_cics, x_cics = ar_cics
+      raise "Check cics configuration! #{cics} #{y_cics} #{x_cics}" unless cics && y_cics && x_cics
+
       wait_session
       raise "It was waiting cics selezion map instead of: #{screen_title}, message: #{catch_message}" unless cics_selection?
-      write cics, :y => 23, :x => 14
+      write cics, :y => y_cics,   :x => x_cics
       do_enter
       wait_session 1
     end
@@ -177,11 +190,14 @@ module Host3270
 
     # On this map, we have to select the cics environment
     # param1 cics usually is a number
-    def company_menu
+    def company_menu ar_menu
       puts "Starting company menu..." if @debug
+      menu, y_menu, x_menu = ar_menu
+      raise "Check company menu configuration! #{menu} #{y_menu} #{x_menu}" unless menu && y_menu && x_menu
+
       wait_session
       raise "It was waiting company menu map instead of: #{screen_title}, message: #{catch_message}" unless company_menu?
-      write "01", :y => 24, :x => 43
+      write menu, :y => y_menu, :x => x_menu
       do_enter
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: butler-mainframe
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Marco Mastrodonato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2015-10-26 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
@@ -28,6 +28,7 @@ files:
 - lib/config/config_EXAMPLE_passport.rb
 - lib/config/config_EXAMPLE_pcomm.rb
 - lib/config/config_EXAMPLE_x3270.rb
+- lib/config/private.yml
 - lib/config/settings.yml
 - lib/config/settings_EXAMPLE.yml
 - lib/core/configuration.rb