netsoul 1.9.2 → 1.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ba483e648ea01d6f10b2c42ea661f5ee98085b4
-  data.tar.gz: 17f6d3cdf47b0de26124d9d59170665a27ba334c
+  metadata.gz: 40ae5cdd054a7d3eb6d72265a45714d49367e18f
+  data.tar.gz: 6046d54fe9e388c0dd33ffde354d69205c1bc062
 SHA512:
-  metadata.gz: 13c93b8cf7130261149892a6f199ea35226b6d1c6dfd2869d0ded7afca827305940761e0aef1367d3f270cfb0cff28b8deaf121ef01d735561c932dfb881da68
-  data.tar.gz: 4c7277563962d8f88f4a107ea9bd7a9f56da000907576a0ad22cde8867dc43d657e0bdba88a1061cca4215cc2ce3ef9d629ada7c8c30f80168b16b0b1033f521
+  metadata.gz: e4937e3a77f5d7a3fdd3cf916a5d1d235c05baaf2622ebdcd9d68741f136f97d00d0b39f815b72eef8346e0c6bb9d426ed450edc4978273c1ee6313616014830
+  data.tar.gz: 87271293e474120ff9d712135250b2bcd166bf22c45dbc7a37b60298601ba98c4a7e83de32bf8d483e6ad360293675775d8d41ec21ec4060855fbdb1e2b02740

data/README.md

@@ -86,7 +86,24 @@ netsoul-ruby -config netsoul-config.yml
 ## Use the library in custom Netsoul Ruby client
 
 Look at the client implementation in this gem: [https://github.com/fenicks/netsoul-ruby/blob/master/bin/netsoul-ruby]().
-This client is implemented in less than 150 lines of code ; including option parser, client reconnection, ...
+This client is implemented in less than 80 lines of code ; including option parser, client reconnection, ...
+
+```ruby
+require 'netsou/client'
+
+c = Netsoul::Client.new options[:user_opts]
+c.connect
+# ...
+if c.started
+  # ...
+  c.sock_send str
+  # ...
+  msg = c.sock_get
+  #...
+end
+# ...
+c.disconnect
+```
 
 ## Contributing
 

data/bin/netsoul-ruby

@@ -3,90 +3,7 @@
 lib = File.expand_path('../../lib', __FILE__)
 $LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
 
-require 'netsoul/config'
-require 'netsoul/errors'
-require 'netsoul/logging'
-require 'netsoul/message'
-require 'socket'
-
-module Netsoul
-  class Client
-    include Logging
-    attr_reader :started
-    SOCKET_READ_TIMEOUT = 12 * 60
-    SOCKET_WRITE_TIMEOUT = 10
-
-    def initialize(*args)
-      opts = args.last.is_a?(Hash) ? args.last : {}
-      @config = Config.new(opts)
-      @started = false
-    end
-
-    def auth_ag
-      sock_send(Message.auth_ag)
-      fail Netsoul::IdentificationError, 'Identification failed.'.freeze unless sock_get.split(' ')[1] == '002'.freeze
-    end
-    private :auth_ag
-
-    def auth_method
-      if @config.auth_method == :krb5
-        sock_send(Message.kerberos_auth(@config))
-      else
-        sock_send(Message.standard_auth(@config))
-      end
-      fail Netsoul::AuthenticationError, 'Authentication failed. See your config file or environment variables'.freeze unless sock_get.split(' ')[1] == '002'
-    end
-    private :auth_method
-
-    def auth_status
-      sock_send(Message.attach)
-      sock_send(Message.user_state(@config.state, Time.now.to_i))
-    end
-    private :auth_status
-
-    def connect
-      @sock = TCPSocket.new(@config.server_host, @config.server_port)
-      fail Netsoul::SocketError, 'Could not open a socket. Connection is unavailable.'.freeze unless @sock
-      _cmd, _socket_num, md5_hash, client_ip, client_port, _server_timestamp = sock_get.split
-
-      @config.build_user_connection_info md5_hash: md5_hash, client_ip: client_ip, client_port: client_port
-
-      auth_ag
-      auth_method
-      auth_status
-
-      @started = true
-    end
-
-    def disconnect
-      sock_send(Message.ns_exit)
-    ensure
-      sock_close
-    end
-
-    def sock_send(str)
-      _, sock = IO.select(nil, [@sock], nil, SOCKET_WRITE_TIMEOUT)
-      fail Netsoul::SocketError, 'Timeout or fail on write socket' if sock.nil? || sock.empty?
-      sock.first.puts str
-      log :info, "[send] #{str.chomp}"
-    end
-
-    def sock_get
-      sock, = IO.select([@sock], nil, nil, SOCKET_READ_TIMEOUT)
-      fail Netsoul::SocketError, 'Timeout or fail on read socket' if sock.nil? || sock.empty?
-      res = sock.first.gets
-      log :info, "[get ] #{res.chomp}" if res
-      res || ''
-    end
-
-    def sock_close
-      @started = false
-      @sock.close
-    rescue
-      nil
-    end
-  end
-end
+require 'netsoul/client'
 
 $stderr.sync = true
 require 'optparse'
@@ -110,6 +27,7 @@ OptionParser.new do |opts|
     exit 42
   end
 end.parse!
+
 if options.empty? || options[:user_opts].size == 0
   unless ENV.to_a.count { |k, _v| %w(NETSOUL_LOGIN NETSOUL_SOCKS_PASSWORD NETSOUL_LOGIN NETSOUL_UNIX_PASSWORD NETSOUL_AUTH_METHOD).include?(k) } >= 2
     puts '[ERROR] You have to specify a configuration file or environment variables'
@@ -118,8 +36,8 @@ if options.empty? || options[:user_opts].size == 0
 end
 
 retry_count = 10
-retry_wait_time = 10.0
-RETRY_WAIT_FACTOR = 1.50 # Each time retry is called in Exception, current 'retry_wait_time' is increased with this factor
+retry_wait_time = 1.0
+RETRY_WAIT_FACTOR = 2.0 # Each time retry is called in Exception block, current 'retry_wait_time' is increased with this factor
 begin
   c = Netsoul::Client.new options[:user_opts]
   c.connect

data/lib/netsoul/client.rb

@@ -0,0 +1,81 @@
+require_relative '../netsoul'
+require 'socket'
+
+module Netsoul
+  class Client
+    include Logging
+    attr_reader :started
+    SOCKET_READ_TIMEOUT = 12 * 60
+    SOCKET_WRITE_TIMEOUT = 10
+
+    def initialize(*args)
+      opts = args.last.is_a?(Hash) ? args.last : {}
+      @config = Config.new(opts)
+      @started = false
+    end
+
+    def auth_ag
+      sock_send(Message.auth_ag)
+      fail Netsoul::IdentificationError, 'Identification failed.'.freeze unless sock_get.split(' ')[1] == '002'.freeze
+    end
+    private :auth_ag
+
+    def auth_method
+      if @config.auth_method == :krb5
+        sock_send(Message.kerberos_auth(@config))
+      else
+        sock_send(Message.standard_auth(@config))
+      end
+      fail Netsoul::AuthenticationError, 'Authentication failed. See your config file or environment variables'.freeze unless sock_get.split(' ')[1] == '002'
+    end
+    private :auth_method
+
+    def auth_status
+      sock_send(Message.attach)
+      sock_send(Message.user_state(@config.state, Time.now.to_i))
+    end
+    private :auth_status
+
+    def connect
+      @sock = TCPSocket.new(@config.server_host, @config.server_port)
+      fail Netsoul::SocketError, 'Could not open a socket. Connection is unavailable.'.freeze unless @sock
+      _cmd, _socket_num, md5_hash, client_ip, client_port, _server_timestamp = sock_get.split
+
+      @config.build_user_connection_info md5_hash: md5_hash, client_ip: client_ip, client_port: client_port
+
+      auth_ag
+      auth_method
+      auth_status
+
+      @started = true
+    end
+
+    def disconnect
+      sock_send(Message.ns_exit)
+    ensure
+      sock_close
+    end
+
+    def sock_send(str)
+      _, sock = IO.select(nil, [@sock], nil, SOCKET_WRITE_TIMEOUT)
+      fail Netsoul::SocketError, 'Timeout or fail on write socket' if sock.nil? || sock.empty?
+      sock.first.puts str
+      log :info, "[send] #{str.chomp}"
+    end
+
+    def sock_get
+      sock, = IO.select([@sock], nil, nil, SOCKET_READ_TIMEOUT)
+      fail Netsoul::SocketError, 'Timeout or fail on read socket' if sock.nil? || sock.empty?
+      res = sock.first.gets
+      log :info, "[get ] #{res.chomp}" if res
+      res || ''
+    end
+
+    def sock_close
+      @started = false
+      @sock.close
+    rescue
+      nil
+    end
+  end
+end

data/lib/netsoul/version.rb

@@ -1,3 +1,3 @@
 module Netsoul
-  VERSION = '1.9.2'.freeze
+  VERSION = '1.9.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netsoul
 version: !ruby/object:Gem::Version
-  version: 1.9.2
+  version: 1.9.3
 platform: ruby
 authors:
 - Christian Kakesa
@@ -153,6 +153,7 @@ files:
 - ext/netsoul_kerberos/kerberos.h
 - ext/netsoul_kerberos/netsoul_kerberos.c
 - lib/netsoul.rb
+- lib/netsoul/client.rb
 - lib/netsoul/config.rb
 - lib/netsoul/errors.rb
 - lib/netsoul/location.rb