capistrano_sentinel 0.0.10 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a1e41110f550198e8926d85040fbb9d0f0b38d0
-  data.tar.gz: 07873dc3a8d1b6af8a55ab057f311e39d2d4aeaa
+  metadata.gz: 4e4d9c618056cbd81c8dee0e97618556667d96b5
+  data.tar.gz: ef5b1e1ca9665476e3fdb22d983fcbb9688c32f9
 SHA512:
-  metadata.gz: b8f644fd6adf08e70b9144b07ba6f78c500284c1ffa268d86566c8dbac0b99504a3eb794ea853763199a44c384abf262e448a75b9cf9d835b485c5a37cda9826
-  data.tar.gz: f4e8d7168145b03a75e45d0bf6a5ad93e1cc22988893d9796615c18f4445bb202cdbb4cfdf4b8eb44dad703df591276f40edc41a512ab1d48338c5d8f562c7f4
+  metadata.gz: 29c6022aec16df8834decd08a20323b3d79a1bb16ec196d4e5c81f5a387789af8d3aaed4dcaa7a3f9ec9d307d2e50a9e8a3b48655901308fb9e67cab9471623b
+  data.tar.gz: 8a9bb2c9224d2adb7824029d01dad477a2288e961044a67062f0a59737c98c5c9e23a6a77610cb4b0e0694dd54f0c97d380460087da0233670c00aac2a40fa14

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+before_install:
+  - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
+  - gem install bundler
+rvm:
+  - 2.0.0
+  - 2.1.5
+  - 2.2.3
+  - 2.2.4
+  - 2.3.0
+  - 2.3.1
+env:
+ - RAILS_ENV=test RACK_ENV=test
+notifications:
+  email: false

data/README.md

@@ -6,9 +6,9 @@ Overview
 
 CapistranoSentinel is a simple ruby implementation that allows you to emit websocket events before a task is invoked by Capistrano.
 
-This gem only has the websocket client that emit events to a host (default 0.0.0.0 port 1234 and path /ws)
+This gem only has the websocket client that emit events to a default host and port , see here more details: **[Configuration options](#configuration-options)**
 
-Currently there is no posibility to change the default configuration becasue this was just released few days ago, but this will be added soon
+You can change that configuration following the description below
 
 Requirements
 ------------
@@ -39,6 +39,44 @@ Add the following to your Capfile
   require 'capistrano_sentinel'
 ```
 
+Configuration options
+=====================
+
+```ruby
+  CapistranoSentinel.configure do |config|
+
+    # if the connection needs to be secure ( using port 443)
+    config.secure  = false
+
+    # the host on  which the server is listening to connections
+    config.host    = '0.0.0.0'
+
+    # the port on  which the server is listening to connections
+    config.port    = 1234
+
+    # the path to which the server is listening to connections
+    config.path    = '/ws'
+
+    # if it receives a ping message, does it need to respond automatically
+    config.auto_pong = true
+
+    # how many bites can it read from the connection
+    config.read_buffer_size = 2048
+
+    # if the conection can reconnect in case the connection was unsuccessful
+    config.reconnect = false
+
+    # how many times can retry the connection
+    config.retry_time = 0  
+
+    # 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)
+    config.wait_execution = true
+  end
+```
+
 Usage Instructions
 ==================
 

data/lib/capistrano_sentinel/all.rb

@@ -13,6 +13,7 @@ require 'forwardable'
 require 'thread'
 require 'monitor'
 require 'logger'
+require 'securerandom'
 
 require 'websocket'
 require_relative './classes/gem_finder'
@@ -21,7 +22,7 @@ require_relative './classes/gem_finder'
   Gem.find_files("#{CapistranoSentinel::GemFinder.get_current_gem_name}/#{folder_name}/**/*.rb").each { |path| require path }
 end
 
-if !CapistranoSentinel::GemFinder.value_blank?(ENV[CapistranoSentinel::RequestHooks::ENV_KEY_JOB_ID])
+if !CapistranoSentinel::GemFinder.value_blank?(CapistranoSentinel::RequestHooks.job_id)
 
   if CapistranoSentinel::GemFinder.fetch_gem_version('capistrano')
     if CapistranoSentinel::GemFinder.capistrano_version_2?

data/lib/capistrano_sentinel/classes/configuration.rb

@@ -0,0 +1,32 @@
+module CapistranoSentinel
+  class Configuration
+    SETTINGS = [:host, :port, :path, :secure, :auto_pong, :read_buffer_size,:reconnect, :retry_time, :wait_execution]
+
+    SETTINGS.each do |setting|
+      attr_reader setting
+      attr_accessor setting
+    end
+
+    def initialize
+      @secure  = false
+      @host    = '0.0.0.0'
+      @port    = 1234
+      @path    = '/ws'
+      @auto_pong = true
+      @read_buffer_size = 2048
+      @reconnect = false
+      @retry_time = 0
+      @wait_execution = true
+    end
+
+    def update(settings_hash)
+      settings_hash.each do |setting, value|
+        unless SETTINGS.include? setting.to_sym
+          raise ArgumentError, "invalid setting: #{setting}"
+        end
+
+        self.public_send "#{setting}=", value
+      end
+    end
+  end
+end

data/lib/capistrano_sentinel/classes/request_hooks.rb

@@ -6,7 +6,7 @@ module CapistranoSentinel
   class RequestHooks
 
     def self.job_id
-      ENV[CapistranoSentinel::RequestHooks::ENV_KEY_JOB_ID]
+      @@job_id ||= ENV.fetch(CapistranoSentinel::RequestHooks::ENV_KEY_JOB_ID, nil) || SecureRandom.uuid
     end
 
     def self.socket_client
@@ -28,7 +28,9 @@ module CapistranoSentinel
       if job_id.present? && @task.present?
         subscribed_already = defined?(@@socket_client)
         actor_start_working(action: 'invoke', subscribed: subscribed_already)
-        actor.wait_execution until actor.task_approved
+        if CapistranoSentinel.config.wait_execution
+          actor.wait_execution until actor.task_approved
+        end
         actor_execute_block(&block)
       else
         block.call
@@ -49,7 +51,7 @@ module CapistranoSentinel
       yield if block_given?
     end
 
-  private
+    private
 
     def actor
       @actor ||= CapistranoSentinel::RequestWorker.new

data/lib/capistrano_sentinel/classes/request_worker.rb

@@ -122,7 +122,7 @@ module CapistranoSentinel
       question: question,
       default: default.present? ? default.delete('()') : '',
       job_id: @job_id)
-      wait_for_stdin_input
+      wait_for_stdin_input if CapistranoSentinel.config.wait_execution
     end
   end
 end

data/lib/capistrano_sentinel/classes/websocket_client.rb

@@ -4,20 +4,8 @@ module CapistranoSentinel
   class WebsocketClient
     include CapistranoSentinel::ApplicationHelper
 
-    HOST = '0.0.0.0'
-    PORT = 1234
-    PATH = '/ws'
-
-    DEFAULT_OPTS = {
-      auto_pong: true,
-      read_buffer_size: 2048,
-      reconnect: false,
-      secure: false,
-      retry_time: 0
-    }
-
-    attr_reader :socket, :read_thread,  :protocol_version, :actor
-    attr_accessor :auto_pong, :on_ping, :on_error, :on_message, :actor
+    attr_reader :socket, :read_thread,  :protocol_version, :actor, :read_buffer_size, :reconnect, :retry_time
+    attr_accessor :auto_pong, :on_ping, :on_error, :on_message, :actor, :read_buffer_size, :reconnect, :retry_time
 
     ##
     # +host+:: Host of request. Required if no :url param was provided.
@@ -32,19 +20,25 @@ module CapistranoSentinel
     def initialize(opts)
 
       # Initializing with a single hash
-      @options = CapistranoSentinel::WebsocketClient::DEFAULT_OPTS.merge(opts).symbolize_keys
-      @secure  = @options.delete :secure
+      @options = opts.symbolize_keys
+
+      @auto_pong   = @options.fetch(:auto_pong, nil) || CapistranoSentinel.config.auto_pong
+      @read_buffer_size = @options.fetch(:read_buffer_size, nil) ||  CapistranoSentinel.config.read_buffer_size
+      @reconnect = @options.fetch(:reconnect, nil) ||  CapistranoSentinel.config.reconnect
+      @retry_time = @options.fetch(:retry_time, nil) ||  CapistranoSentinel.config.retry_time
+
+
+      @secure  = @options.fetch(:secure, nil) || CapistranoSentinel.config.secure
 
-      @host    = @options.fetch(:host, nil) || CapistranoSentinel::WebsocketClient::HOST
-      @port    = @secure ? 443 : (@options.fetch(:port, nil) || CapistranoSentinel::WebsocketClient::PORT)
-      @path    = @options.fetch(:path, nil).to_s || CapistranoSentinel::WebsocketClient::PATH
-      @query   = @options.fetch(:query, nil).to_s
+      @host    = @options.fetch(:host, nil) || CapistranoSentinel.config.host
+      @port    = @secure ? 443 : (@options.fetch(:port, nil) ||  CapistranoSentinel.config.port)
+      @path    = @options.fetch(:path, nil) ||  CapistranoSentinel.config.path
+      @query   = @options.fetch(:query, nil)
 
       @actor ||=  @options.fetch(:actor, nil)
       @channel ||= @options.fetch(:channel, nil)
 
 
-      @auto_pong   = @options.fetch(:auto_pong, true) || true
       @closed      = false
       @opened      = false
 
@@ -224,7 +218,7 @@ module CapistranoSentinel
           connect
         rescue ::Errno::ECONNREFUSED => e
           log_to_file("#{self.class} got ECONNREFUSED #{e.inspect} ")
-          sleep @options[:retry_time]
+          sleep @retry_time
         rescue => e
           fire_on_error e
         end
@@ -287,7 +281,7 @@ module CapistranoSentinel
         frame = ::WebSocket::Frame::Incoming::Client.new(:version => @protocol_version)
         loop do
           begin
-            frame << @socket.readpartial(@options[:read_buffer_size])
+            frame << @socket.readpartial(@read_buffer_size)
             while message = frame.next
               #"text", "binary", "ping", "pong" and "close" (according to websocket/base.rb)
               determine_message_type(message)
@@ -362,7 +356,7 @@ module CapistranoSentinel
         @on_close.call(message) if @on_close
         @socket.close unless @socket.closed?
 
-        reconnect if @options[:reconnect]
+        reconnect if @reconnect
       end
 
     end # class

data/lib/capistrano_sentinel/version.rb

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

data/lib/capistrano_sentinel.rb

@@ -1 +1,12 @@
 require 'capistrano_sentinel/all'
+
+module CapistranoSentinel
+
+  def self.configure
+    yield config
+  end
+
+  def self.config
+    @config ||= CapistranoSentinel::Configuration.new
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano_sentinel
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.12
 platform: ruby
 authors:
 - bogdanRada
@@ -31,6 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -38,6 +39,7 @@ files:
 - capistrano_sentinel.gemspec
 - lib/capistrano_sentinel.rb
 - lib/capistrano_sentinel/all.rb
+- lib/capistrano_sentinel/classes/configuration.rb
 - lib/capistrano_sentinel/classes/gem_finder.rb
 - lib/capistrano_sentinel/classes/input_stream.rb
 - lib/capistrano_sentinel/classes/output_stream.rb