hrr_rb_ssh 0.4.0.pre1 → 0.4.0.pre2

data/lib/hrr_rb_ssh/codable.rb

@@ -1,12 +1,16 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   module Codable
-    def logger
-      @logger ||= Logger.new self.name
+    class LoggableClass
+      include Loggable
+
+      def initialize logger
+        self.logger = logger
+      end
     end
 
     def common_definition
@@ -22,15 +26,18 @@ module HrrRbSsh
       }
     end
 
-    def encode message, complementary_message={}
-      logger.debug { 'encoding message: ' + message.inspect }
+    def encode message, complementary_message={}, logger: nil
+      loggable_instalce = LoggableClass.new(logger)
+      loggable_instalce.log_key = self.to_s
+
+      loggable_instalce.log_debug { 'encoding message: ' + message.inspect }
       definition = common_definition + conditional_definition(message.merge complementary_message)
       definition.map{ |data_type, field_name|
         begin
           field_value = if message[field_name].instance_of? ::Proc then message[field_name].call else message[field_name] end
-          data_type.encode( field_value )
+          data_type.encode field_value
         rescue => e
-          logger.debug { "'field_name', 'field_value': #{field_name.inspect}, #{field_value.inspect}" }
+          loggable_instalce.log_debug { "'field_name', 'field_value': #{field_name.inspect}, #{field_value.inspect}" }
           raise e
         end
       }.join
@@ -49,20 +56,23 @@ module HrrRbSsh
         decoded_message = definition.map{ |data_type, field_name|
           [
             field_name,
-            data_type.decode( payload_io )
+            data_type.decode(payload_io)
           ]
         }
         decoded_message + decode_recursively(payload_io, decoded_message)
       end
     end
 
-    def decode payload, complementary_message={}
+    def decode payload, complementary_message={}, logger: nil
+      loggable_instalce = LoggableClass.new(logger)
+      loggable_instalce.log_key = self.to_s
+
       payload_io = StringIO.new payload
       decoded_message = decode_recursively(payload_io).inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
       if complementary_message.any?
         decoded_message.merge! decode_recursively(payload_io, complementary_message.to_a).inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
       end
-      logger.debug { 'decoded message: ' + decoded_message.inspect }
+      loggable_instalce.log_debug { 'decoded message: ' + decoded_message.inspect }
       decoded_message
     end
   end

data/lib/hrr_rb_ssh/connection/channel/channel_type/direct_tcpip.rb

@@ -1,17 +1,19 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
     class Channel
       class ChannelType
         class DirectTcpip < ChannelType
+          include Loggable
+
           NAME = 'direct-tcpip'
 
-          def initialize connection, channel, message, socket=nil
-            @logger = Logger.new self.class.name
+          def initialize connection, channel, message, socket=nil, logger: nil
+            self.logger = logger
             @connection = connection
             @channel = channel
             @host_to_connect       = message[:'host to connect']
@@ -29,16 +31,16 @@ module HrrRbSsh
           def close
             begin
               if @sender_thread_finished && @receiver_thread_finished
-                @logger.info { "closing direct-tcpip" }
+                log_info { "closing direct-tcpip" }
                 @socket.close
-                @logger.info { "closing channel IOs" }
+                log_info { "closing channel IOs" }
                 @channel.io.each{ |io| io.close rescue nil }
-                @logger.info { "channel IOs closed" }
+                log_info { "channel IOs closed" }
                 @channel.close from=:channel_type_instance
-                @logger.info { "direct-tcpip closed" }
+                log_info { "direct-tcpip closed" }
               end
             rescue => e
-              @logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
             end
           end
 
@@ -49,24 +51,24 @@ module HrrRbSsh
                   begin
                     @channel.io[1].write s.readpartial(10240)
                   rescue EOFError
-                    @logger.info { "socket is EOF" }
+                    log_info { "socket is EOF" }
                     @channel.io[1].close rescue nil
                     break
                   rescue IOError
-                    @logger.info { "socket is closed" }
+                    log_info { "socket is closed" }
                     @channel.io[1].close rescue nil
                     break
                   rescue => e
-                    @logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+                    log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
                     @channel.io[1].close rescue nil
                     break
                   end
                 end
-                @logger.info { "finishing sender thread" }
+                log_info { "finishing sender thread" }
                 @sender_thread_finished = true
                 close
               ensure
-                @logger.info { "sender thread finished" }
+                log_info { "sender thread finished" }
               end
             }
           end
@@ -78,23 +80,23 @@ module HrrRbSsh
                   begin
                     s.write @channel.io[0].readpartial(10240)
                   rescue EOFError
-                    @logger.info { "io is EOF" }
+                    log_info { "io is EOF" }
                     s.close_write
                     break
                   rescue IOError
-                    @logger.info { "socket is closed" }
+                    log_info { "socket is closed" }
                     break
                   rescue => e
-                    @logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+                    log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
                     s.close_write
                     break
                   end
                 end
-                @logger.info { "finishing receiver thread" }
+                log_info { "finishing receiver thread" }
                 @receiver_thread_finished = true
                 close
               ensure
-                @logger.info { "receiver thread finished" }
+                log_info { "receiver thread finished" }
               end
             }
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/forwarded_tcpip.rb

@@ -1,17 +1,19 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
     class Channel
       class ChannelType
         class ForwardedTcpip < ChannelType
+          include Loggable
+
           NAME = 'forwarded-tcpip'
 
-          def initialize connection, channel, message, socket
-            @logger = Logger.new self.class.name
+          def initialize connection, channel, message, socket, logger: nil
+            self.logger = logger
             @connection = connection
             @channel = channel
             @socket = socket
@@ -25,16 +27,16 @@ module HrrRbSsh
           def close
             begin
               if @sender_thread_finished && @receiver_thread_finished
-                @logger.info { "closing forwarded-tcpip" }
+                log_info { "closing forwarded-tcpip" }
                 @socket.close
-                @logger.info { "closing channel IOs" }
+                log_info { "closing channel IOs" }
                 @channel.io.each{ |io| io.close rescue nil }
-                @logger.info { "channel IOs closed" }
+                log_info { "channel IOs closed" }
                 @channel.close from=:channel_type_instance
-                @logger.info { "forwarded-tcpip closed" }
+                log_info { "forwarded-tcpip closed" }
               end
             rescue => e
-              @logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
             end
           end
 
@@ -45,24 +47,24 @@ module HrrRbSsh
                   begin
                     @channel.io[1].write s.readpartial(10240)
                   rescue EOFError
-                    @logger.info { "socket is EOF" }
+                    log_info { "socket is EOF" }
                     @channel.io[1].close rescue nil
                     break
                   rescue IOError
-                    @logger.info { "socket is closed" }
+                    log_info { "socket is closed" }
                     @channel.io[1].close rescue nil
                     break
                   rescue => e
-                    @logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+                    log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
                     @channel.io[1].close rescue nil
                     break
                   end
                 end
-                @logger.info { "finishing sender thread" }
+                log_info { "finishing sender thread" }
                 @sender_thread_finished = true
                 close
               ensure
-                @logger.info { "sender thread finished" }
+                log_info { "sender thread finished" }
               end
             }
           end
@@ -74,23 +76,23 @@ module HrrRbSsh
                   begin
                     s.write @channel.io[0].readpartial(10240)
                   rescue EOFError
-                    @logger.info { "io is EOF" }
+                    log_info { "io is EOF" }
                     s.close_write
                     break
                   rescue IOError
-                    @logger.info { "socket is closed" }
+                    log_info { "socket is closed" }
                     break
                   rescue => e
-                    @logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+                    log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
                     s.close_write
                     break
                   end
                 end
-                @logger.info { "finishing receiver thread" }
+                log_info { "finishing receiver thread" }
                 @receiver_thread_finished = true
                 close
               ensure
-                @logger.info { "receiver thread finished" }
+                log_info { "receiver thread finished" }
               end
             }
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/proc_chain/chain_context.rb

@@ -1,8 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
-
 module HrrRbSsh
   class Connection
     class Channel
@@ -11,7 +9,6 @@ module HrrRbSsh
           class ProcChain
             class ChainContext
               def initialize proc_chain
-                @logger = Logger.new self.class.name
                 @proc_chain = proc_chain
               end
               def call_next *args

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/proc_chain.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/channel/channel_type/session/proc_chain/chain_context'
 
 module HrrRbSsh
@@ -11,7 +10,6 @@ module HrrRbSsh
         class Session
           class ProcChain
             def initialize
-              @logger = Logger.new self.class.name
               @q = Queue.new
             end
             def connect next_proc

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/env/context.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
@@ -11,8 +11,9 @@ module HrrRbSsh
           class RequestType
             class Env
               class Context
+                include Loggable
+
                 attr_reader \
-                  :logger,
                   :username,
                   :io,
                   :variables,
@@ -20,8 +21,8 @@ module HrrRbSsh
                   :variable_name,
                   :variable_value
 
-                def initialize proc_chain, username, io, variables, message, session
-                  @logger = Logger.new self.class.name
+                def initialize proc_chain, username, io, variables, message, session, logger: nil
+                  self.logger = logger
 
                   @proc_chain = proc_chain
                   @username   = username

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/env.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/request_handler'
 
 module HrrRbSsh
@@ -13,10 +12,8 @@ module HrrRbSsh
             class Env < RequestType
               NAME = 'env'
 
-              def self.run proc_chain, username, io, variables, message, options, session
-                logger = Logger.new self.class.name
-
-                context = Context.new proc_chain, username, io, variables, message, session
+              def self.run proc_chain, username, io, variables, message, options, session, logger: nil
+                context = Context.new proc_chain, username, io, variables, message, session, logger: logger
                 handler = options.fetch('connection_channel_request_env', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/exec/context.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
@@ -11,16 +11,17 @@ module HrrRbSsh
           class RequestType
             class Exec
               class Context
+                include Loggable
+
                 attr_reader \
-                  :logger,
                   :username,
                   :io,
                   :variables,
                   :vars,
                   :command
 
-                def initialize proc_chain, username, io, variables, message, session
-                  @logger = Logger.new self.class.name
+                def initialize proc_chain, username, io, variables, message, session, logger: nil
+                  self.logger = logger
 
                   @proc_chain = proc_chain
                   @username   = username

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/exec.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/request_handler'
 
 module HrrRbSsh
@@ -13,10 +12,8 @@ module HrrRbSsh
             class Exec < RequestType
               NAME = 'exec'
 
-              def self.run proc_chain, username, io, variables, message, options, session
-                logger = Logger.new self.class.name
-
-                context = Context.new proc_chain, username, io, variables, message, session
+              def self.run proc_chain, username, io, variables, message, options, session, logger: nil
+                context = Context.new proc_chain, username, io, variables, message, session, logger: logger
                 handler = options.fetch('connection_channel_request_exec', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/pty_req/context.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
@@ -11,8 +11,9 @@ module HrrRbSsh
           class RequestType
             class PtyReq
               class Context
+                include Loggable
+
                 attr_reader \
-                  :logger,
                   :username,
                   :io,
                   :variables,
@@ -24,8 +25,8 @@ module HrrRbSsh
                   :terminal_height_pixels,
                   :encoded_terminal_modes
 
-                def initialize proc_chain, username, io, variables, message, session
-                  @logger = Logger.new self.class.name
+                def initialize proc_chain, username, io, variables, message, session, logger: nil
+                  self.logger = logger
 
                   @proc_chain = proc_chain
                   @username   = username

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/pty_req.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/request_handler'
 
 module HrrRbSsh
@@ -13,10 +12,8 @@ module HrrRbSsh
             class PtyReq < RequestType
               NAME = 'pty-req'
 
-              def self.run proc_chain, username, io, variables, message, options, session
-                logger = Logger.new self.class.name
-
-                context = Context.new proc_chain, username, io, variables, message, session
+              def self.run proc_chain, username, io, variables, message, options, session, logger: nil
+                context = Context.new proc_chain, username, io, variables, message, session, logger: logger
                 handler = options.fetch('connection_channel_request_pty_req', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/shell/context.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
@@ -11,15 +11,16 @@ module HrrRbSsh
           class RequestType
             class Shell
               class Context
+                include Loggable
+
                 attr_reader \
-                  :logger,
                   :username,
                   :io,
                   :variables,
                   :vars
 
-                def initialize proc_chain, username, io, variables, message, session
-                  @logger = Logger.new self.class.name
+                def initialize proc_chain, username, io, variables, message, session, logger: nil
+                  self.logger = logger
 
                   @proc_chain = proc_chain
                   @username   = username

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/shell.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/request_handler'
 
 module HrrRbSsh
@@ -13,10 +12,8 @@ module HrrRbSsh
             class Shell < RequestType
               NAME = 'shell'
 
-              def self.run proc_chain, username, io, variables, message, options, session
-                logger = Logger.new self.class.name
-
-                context = Context.new proc_chain, username, io, variables, message, session
+              def self.run proc_chain, username, io, variables, message, options, session, logger: nil
+                context = Context.new proc_chain, username, io, variables, message, session, logger: logger
                 handler = options.fetch('connection_channel_request_shell', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/subsystem/context.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
@@ -11,16 +11,17 @@ module HrrRbSsh
           class RequestType
             class Subsystem
               class Context
+                include Loggable
+
                 attr_reader \
-                  :logger,
                   :username,
                   :io,
                   :variables,
                   :vars,
                   :subsystem_name
 
-                def initialize proc_chain, username, io, variables, message, session
-                  @logger = Logger.new self.class.name
+                def initialize proc_chain, username, io, variables, message, session, logger: nil
+                  self.logger = logger
 
                   @proc_chain = proc_chain
                   @username   = username

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/subsystem.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/request_handler'
 
 module HrrRbSsh
@@ -13,10 +12,8 @@ module HrrRbSsh
             class Subsystem < RequestType
               NAME = 'subsystem'
 
-              def self.run proc_chain, username, io, variables, message, options, session
-                logger = Logger.new self.class.name
-
-                context = Context.new proc_chain, username, io, variables, message, session
+              def self.run proc_chain, username, io, variables, message, options, session, logger: nil
+                context = Context.new proc_chain, username, io, variables, message, session, logger: logger
                 handler = options.fetch('connection_channel_request_subsystem', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/window_change/context.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/loggable'
 
 module HrrRbSsh
   class Connection
@@ -11,8 +11,9 @@ module HrrRbSsh
           class RequestType
             class WindowChange
               class Context
+                include Loggable
+
                 attr_reader \
-                  :logger,
                   :username,
                   :io,
                   :variables,
@@ -22,8 +23,8 @@ module HrrRbSsh
                   :terminal_width_pixels,
                   :terminal_height_pixels
 
-                def initialize proc_chain, username, io, variables, message, session
-                  @logger = Logger.new self.class.name
+                def initialize proc_chain, username, io, variables, message, session, logger: nil
+                  self.logger = logger
 
                   @proc_chain = proc_chain
                   @username   = username

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/window_change.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/logger'
 require 'hrr_rb_ssh/connection/request_handler'
 
 module HrrRbSsh
@@ -13,10 +12,8 @@ module HrrRbSsh
             class WindowChange < RequestType
               NAME = 'window-change'
 
-              def self.run proc_chain, username, io, variables, message, options, session
-                logger = Logger.new self.class.name
-
-                context = Context.new proc_chain, username, io, variables, message, session
+              def self.run proc_chain, username, io, variables, message, options, session, logger: nil
+                context = Context.new proc_chain, username, io, variables, message, session, logger: logger
                 handler = options.fetch('connection_channel_request_window_change', RequestHandler.new {})
                 handler.run context