capistrano_sentinel 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e4d9c618056cbd81c8dee0e97618556667d96b5
-  data.tar.gz: ef5b1e1ca9665476e3fdb22d983fcbb9688c32f9
+  metadata.gz: 6567c8c26e82b4daaf31af2640ad504455c0aa23
+  data.tar.gz: 5eb7391d2aac739c1bfba164650e4fc141dde661
 SHA512:
-  metadata.gz: 29c6022aec16df8834decd08a20323b3d79a1bb16ec196d4e5c81f5a387789af8d3aaed4dcaa7a3f9ec9d307d2e50a9e8a3b48655901308fb9e67cab9471623b
-  data.tar.gz: 8a9bb2c9224d2adb7824029d01dad477a2288e961044a67062f0a59737c98c5c9e23a6a77610cb4b0e0694dd54f0c97d380460087da0233670c00aac2a40fa14
+  metadata.gz: f0c0ba51b57e53779ebc8b9f37fe951dfa6c944ba7da17c37500eccca296ca92336f440f0a5056c407b29fbf72994e47338d64eace91fb70ebb7c1ffbc50ca70
+  data.tar.gz: 3d836d4404918d23da570ffb417ac1ed121b9e667d8abc0f7bd22ad34d51afb875b76ba846f7eba86d72bf39624c1a97cbc27165de020a32cac5ff8e1fc80e89

data/README.md

@@ -72,11 +72,54 @@ Configuration options
     # if this is enabled, the task will sleep until the socket receives a message back in this format
     # {"action"=>"invoke", "task"=><task_name>, "job_id"=><job_id>, "approved"=>"yes"},
     # where the task_name needs to be the task that is waiting for approval and
-    # the job_id needs to be set using ENV['multi_cap_job_id'], for parallel processing ( if the job id is missing , will be automatically generated with SecureRandom.uuid)
+    # the job_id needs to be set using ENV['multi_cap_job_id'], for parallel processing
+    # ( if the job id is missing , will be automatically generated with SecureRandom.uuid)
     config.wait_execution = true
+
+    # if this is enabled, this will hook into stdin and stdout before a task is executed and if stdin is needed
+    # than will publish a message in this format {"action":"stdout","question":"<the stdout message>",default:"", "job_id":"<job_id>" }
+    # where question key is done by reading the last message printed by the task and parsing the message to detect
+    # if the message is a question . If it is a question in this format ( e.g. "where do you live?(Y/N)")
+    # then the question will be sent as "where do you live?" and the default will be "Y/N"
+    config.hook_stdin_and_stdout = true
   end
 ```
 
+All websocket messages are published in this format:
+
+```ruby
+{     
+  "client_action":"publish",
+  "channel":"celluloid_worker_<job_id>",
+  "data": {}
+}
+```
+
+Where the **data** will have as value the example listed below when using **wait_execution** set to **TRUE**:
+
+E.g. Mesage sent before a task is executed:
+
+```ruby
+{     
+  "action"=> "invoke",
+  "task"=> <task_name>,
+  "job_id"=> <job_id>
+}
+```
+
+Or when using **hook_stdin_and_stdout** set to **TRUE**:
+
+And E.g.
+
+```ruby
+  {
+    "action": "stdout",
+    "question": < if the stdout contains ? or : will use the text before that character >,
+    'default': <if the stdout message cotains () will use the text from within, otherwise string blank >,
+    "job_id": "<job_id>"
+  }
+```
+
 Usage Instructions
 ==================
 

data/lib/capistrano_sentinel/classes/configuration.rb

@@ -1,6 +1,6 @@
 module CapistranoSentinel
   class Configuration
-    SETTINGS = [:host, :port, :path, :secure, :auto_pong, :read_buffer_size,:reconnect, :retry_time, :wait_execution]
+    SETTINGS = [:host, :port, :path, :secure, :auto_pong, :read_buffer_size,:reconnect, :retry_time, :wait_execution, :hook_stdin_and_stdout]
 
     SETTINGS.each do |setting|
       attr_reader setting
@@ -17,6 +17,7 @@ module CapistranoSentinel
       @reconnect = false
       @retry_time = 0
       @wait_execution = true
+      @hook_stdin_and_stdout = true
     end
 
     def update(settings_hash)

data/lib/capistrano_sentinel/classes/request_hooks.rb

@@ -38,7 +38,7 @@ module CapistranoSentinel
     end
 
     def print_question?(question)
-      if job_id.present?
+      if CapistranoSentinel.config.hook_stdin_and_stdout && job_id.present?
         actor.user_prompt_needed?(question)
       else
         yield if block_given?
@@ -79,9 +79,9 @@ module CapistranoSentinel
     end
 
     def actor_execute_block(&block)
-      before_hooks
+      before_hooks if CapistranoSentinel.config.hook_stdin_and_stdout
       block.call
-      after_hooks
+      after_hooks if CapistranoSentinel.config.hook_stdin_and_stdout
     end
 
     def actor_start_working(additionals = {})

data/lib/capistrano_sentinel/classes/request_worker.rb

@@ -92,7 +92,7 @@ module CapistranoSentinel
     end
 
     def stdin_approval(message)
-      return unless msg_for_stdin?(message)
+      return if !CapistranoSentinel.config.wait_execution || !msg_for_stdin?(message)
       if @job_id == message['job_id']
         @stdin_result = message.fetch('result', '')
       else
@@ -101,7 +101,7 @@ module CapistranoSentinel
     end
 
     def task_approval(message)
-      return if !message_is_about_a_task?(message)
+      return if !CapistranoSentinel.config.wait_execution || !message_is_about_a_task?(message)
       log_to_file("RakeWorker #{@job_id} #{task_name} task_approval : #{message.inspect}")
       if @job_id.to_s == message['job_id'].to_s && message['task'].to_s == task_name.to_s && message['approved'] == 'yes'
         @task_approved = true

data/lib/capistrano_sentinel/version.rb

@@ -17,7 +17,7 @@ module CapistranoSentinel
     # minor release version
     MINOR = 0
     # tiny release version
-    TINY = 12
+    TINY = 14
     # prelease version ( set this only if it is a prelease)
     PRE = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano_sentinel
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - bogdanRada