butler-mainframe 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 584e7daebabd56842bf77991014705e4d6ffab12
-  data.tar.gz: 6ac836fd5345d15b47d87c3410573dc1d108e3ad
+  metadata.gz: 085b558f62f9e73d71a58c099a92d7b828423c26
+  data.tar.gz: 0d12a14211f14239d4e2f529ff43f08b68b46069
 SHA512:
-  metadata.gz: 9129d7293a4c6db02dbd068b9606b5162d8b5ad88be4a178be9fdfc0e6be6137a467b844de90f7b18364a3a20834309264ecab8832e182e2fc7cb92e2ff2277a
-  data.tar.gz: f379c6be4ab6f2787bb4a3247b3fc48514d9374313391267cf9ca9c5ebbfaf790f5dc465f87fe5a1269a69960c654c0ddf2330877a35dc1bbc00ba70184fe196
+  metadata.gz: 9d32a0fbdfbf5a18db0cd23dad43faa60fb742fe15308a06b5d1473fc62ee3b293d42dfa6e011f1efcbf2c0f8cc2c9cd6c07752f8103ce455cb0e48f2f01ee2f
+  data.tar.gz: 239c066d0da603a86c8794d79688fcde4f4f85aea0dce5df711143b21cc512a158c037bd866c22c8c8480736402a865ac039ba2501e6d87264f8ac063f200e71

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+0.7.4 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.7.3...v0.7.4) April 13th, 2016
+------------------------------
+* You can now let the session open with the new quit parameter :never
+* Now you can change the close session parameter after the object was created
+* Improved documentation
+* PComm emulator: removed StopCommunication from quit due to session stuck if it will not be closed
+
 0.7.3 [☰](https://github.com/marcomd/butler-mainframe/compare/v0.7.2...v0.7.3) March 29th, 2016
 ------------------------------
 * PComm emulator: fixed a bug when closing the session with ruby 1.8

data/README.md

@@ -13,7 +13,7 @@ Developed on a windows plaftorm.
 
 ## Install
 
-Instal the gem from rubygems
+Install the gem from rubygems
 
     gem install butler-mainframe
 
@@ -49,7 +49,7 @@ ButlerMainframe.configure do |config|
   config.browser_path   = 'c:/Program Files (x86)/Internet Explorer/iexplore.exe'
   config.session_path   = 'https://localhost/zephyr/Ecomes.zwh?sessionprofile=3270dsp/Sessions/host3270'
   config.session_tag    = 1
-  config.timeout        = 3000
+  config.timeout        = 6000
 end
 ```
 
@@ -58,9 +58,12 @@ Example to configure Personal communication:
 ```ruby
 ButlerMainframe.configure do |config|
   config.host_gateway   = :pcomm
-  config.session_path   = '"C:/Program Files (x86)/IBM/Personal Communications/pcsws.exe" "C:/Users/Marco/AppData/Roaming/IBM/Personal Communications/host3270.ws"'
+  config.session_path   = '"C:/Program Files (x86)/IBM/Personal Communications/pcsws.exe" "C:/Users/Marco/AppData/Roaming/IBM/Personal Communications/host3270.ws" /Q /H /S=A'
+  # /Q to suppress starting logo
+  # /H for hidden session
+  # /S=A to select the session A (WARNING: must be the same in session_tag)
   config.session_tag    = 'A'
-  config.timeout        = 3000
+  config.timeout        = 6000
 end
 ```
 
@@ -70,7 +73,7 @@ Example to configure X3270:
 ButlerMainframe.configure do |config|
   config.host_gateway   = :x3270
   config.session_path   = '"C:/Program Files (x86)/wc3270/ws3270.exe" 127.0.0.1 -model 2 --'
-  config.timeout        = 5 # In seconds
+  config.timeout        = 6 # In seconds
 end
 ```
 
@@ -162,6 +165,23 @@ This is possible because it is configured in the navigate method which have to b
 
 My advice is to use navigate method for generic navigation and use a specific module (or rails model) for each task.
 
+### Quit
+
+At the end butler close the session considering how it is opened:
+
+```ruby
+host.quit
+```
+
+The default closing method is `evaluate` but you can force `always` (alias yes) or `never` (alias no)
+
+```ruby
+# How to force close session parameter
+host = ButlerMainframe::Host.new(close_session: :always)
+# or simply
+host.close_session = :always
+```
+
 ## With Rails
 
 This gem can be use on rails project.

data/lib/config/config_EXAMPLE_pcomm.rb

@@ -1,10 +1,9 @@
 ButlerMainframe.configure do |config|
   config.host_gateway   = :pcomm
-  # These the used parameters:
+  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'
   # /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'
+  # /S=A to select the session A (WARNING: must be the same in session_tag)
   config.session_tag    = 'A'
   config.timeout        = 6000
  #config.env            = 'production'

data/lib/mainframe/emulators/pcomm.rb

@@ -43,7 +43,7 @@ module ButlerMainframe
 
     #Ends the connection and closes the session
     def sub_close_session
-      @action[:object].StopCommunication
+      #@action[:object].StopCommunication #Removed due to session stuck if it will not be closed
       @action[:object] = nil
       if @pid
         # See http://www-01.ibm.com/support/knowledgecenter/SSEQ5Y_6.0.0/com.ibm.pcomm.doc/books/html/admin_guide10.htm?lang=en

data/lib/mainframe/host_base.rb

@@ -7,7 +7,7 @@ module ButlerMainframe
     include ButlerMainframe::GenericFunctions
 
     attr_reader :action, :wait
-    attr_accessor :debug
+    attr_accessor :debug, :close_session
 
     MAX_TERMINAL_COLUMNS      = 80
     MAX_TERMINAL_ROWS         = 24
@@ -51,10 +51,16 @@ module ButlerMainframe
     def quit
       puts "Closing session with criterion \"#{@close_session}\"" if @debug
       case @close_session
-        when :always
+        when :always, :yes
           sub_close_session
           puts "Session closed" if @debug
           wait_session 0.1
+        when :never, :no
+          if @pid
+            puts "Session forced to stay open" if @debug
+          else
+            puts "Session not closed because it was already existing anyway it would not been closed" if @debug
+          end
         when :evaluate
           if @pid
             sub_close_session

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: butler-mainframe
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Marco Mastrodonato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-13 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