hrr_rb_sftp 0.1.0 → 0.2.0

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/014_ssh_fxp_mkdir.rb

@@ -1,21 +1,37 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_MKDIR
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_MKDIR packet type, format, and responder.
+        #
+        class SSH_FXP_MKDIR < Packet
+
+          #
+          # Represents SSH_FXP_MKDIR packet type.
+          #
           TYPE = 14
 
+          #
+          # Represents SSH_FXP_MKDIR packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"path"      ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
           ]
 
+          #
+          # Responds to SSH_FXP_MKDIR request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_MKDIR request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
-              Dir.mkdir request[:"path"]
+              log_debug { "Dir.mkdir(#{request[:"path"].inspect})" }
+              Dir.mkdir(request[:"path"])
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -23,7 +39,8 @@ module HrrRbSftp
                 :"error message" => "Success",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -31,7 +48,8 @@ module HrrRbSftp
                 :"error message" => "Permission denied",
                 :"language tag"  => "",
               }
-            rescue Errno::EEXIST
+            rescue Errno::EEXIST => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/015_ssh_fxp_rmdir.rb

@@ -1,21 +1,37 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_RMDIR
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_RMDIR packet type, format, and responder.
+        #
+        class SSH_FXP_RMDIR < Packet
+
+          #
+          # Represents SSH_FXP_RMDIR packet type.
+          #
           TYPE = 15
 
+          #
+          # Represents SSH_FXP_RMDIR packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"path"      ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
           ]
 
+          #
+          # Responds to SSH_FXP_RMDIR request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_RMDIR request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
-              Dir.rmdir request[:"path"]
+              log_debug { "Dir.rmdir(#{request[:"path"].inspect})" }
+              Dir.rmdir(request[:"path"])
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -23,7 +39,8 @@ module HrrRbSftp
                 :"error message" => "Success",
                 :"language tag"  => "",
               }
-            rescue Errno::ENOENT
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -31,7 +48,8 @@ module HrrRbSftp
                 :"error message" => "No such file or directory",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -39,7 +57,8 @@ module HrrRbSftp
                 :"error message" => "Permission denied",
                 :"language tag"  => "",
               }
-            rescue Errno::ENOTDIR
+            rescue Errno::ENOTDIR => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -47,7 +66,8 @@ module HrrRbSftp
                 :"error message" => "Not a directory",
                 :"language tag"  => "",
               }
-            rescue Errno::ENOTEMPTY
+            rescue Errno::ENOTEMPTY => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],

data/lib/hrr_rb_sftp/protocol/version1/packets/016_ssh_fxp_realpath.rb

@@ -0,0 +1,47 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_REALPATH packet type, format, and responder.
+        #
+        class SSH_FXP_REALPATH < Packet
+
+          #
+          # Represents SSH_FXP_REALPATH packet type.
+          #
+          TYPE = 16
+
+          #
+          # Represents SSH_FXP_REALPATH packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
+          ]
+
+          #
+          # Responds to SSH_FXP_REALPATH request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_REALPATH request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_NAME.
+          #
+          def respond_to request
+            log_debug { "absolute_path = File.absolute_path(#{request[:"path"].inspect})" }
+            absolute_path = File.absolute_path(request[:"path"])
+            {
+              :"type"        => SSH_FXP_NAME::TYPE,
+              :"request-id"  => request[:"request-id"],
+              :"count"       => 1,
+              :"filename[0]" => absolute_path,
+              :"longname[0]" => absolute_path,
+              :"attrs[0]"    => {},
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/017_ssh_fxp_stat.rb

@@ -1,20 +1,36 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_STAT
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_STAT packet type, format, and responder.
+        #
+        class SSH_FXP_STAT < Packet
+
+          #
+          # Represents SSH_FXP_STAT packet type.
+          #
           TYPE = 17
 
+          #
+          # Represents SSH_FXP_STAT packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"path"      ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
           ]
 
+          #
+          # Responds to SSH_FXP_STAT request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_STAT request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_ATTRS. In other cases, its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
+              log_debug { "File.stat(#{request[:"path"].inspect})" }
               stat = File.stat(request[:"path"])
               attrs = Hash.new
               attrs[:"size"]        = stat.size       if stat.size
@@ -28,7 +44,8 @@ module HrrRbSftp
                 :"request-id" => request[:"request-id"],
                 :"attrs"      => attrs,
               }
-            rescue Errno::ENOENT
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -36,7 +53,8 @@ module HrrRbSftp
                 :"error message" => "No such file or directory",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],

data/lib/hrr_rb_sftp/protocol/version1/packets/101_ssh_fxp_status.rb

@@ -0,0 +1,73 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_STATUS packet type, format, and responder.
+        #
+        class SSH_FXP_STATUS < Packet
+
+          #
+          # Represents SSH_FXP_STATUS packet type.
+          #
+          TYPE = 101
+
+          #
+          # Represents SSH_FXP_STATUS packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::Uint32, :"code"      ],
+          ]
+
+          #
+          # Represents SSH_FX_OK value.
+          #
+          SSH_FX_OK                = 0
+
+          #
+          # Represents SSH_FX_EOF value.
+          #
+          SSH_FX_EOF               = 1
+
+          #
+          # Represents SSH_FX_NO_SUCH_FILE value.
+          #
+          SSH_FX_NO_SUCH_FILE      = 2
+
+          #
+          # Represents SSH_FX_PERMISSION_DENIED value.
+          #
+          SSH_FX_PERMISSION_DENIED = 3
+
+          #
+          # Represents SSH_FX_FAILURE value.
+          #
+          SSH_FX_FAILURE           = 4
+
+          #
+          # Represents SSH_FX_BAD_MESSAGE value.
+          #
+          SSH_FX_BAD_MESSAGE       = 5
+
+          #
+          # Represents SSH_FX_NO_CONNECTION value.
+          #
+          SSH_FX_NO_CONNECTION     = 6
+
+          #
+          # Represents SSH_FX_CONNECTION_LOST value.
+          #
+          SSH_FX_CONNECTION_LOST   = 7
+
+          #
+          # Represents SSH_FX_OP_UNSUPPORTED value.
+          #
+          SSH_FX_OP_UNSUPPORTED    = 8
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/packets/102_ssh_fxp_handle.rb

@@ -0,0 +1,28 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_HANDLE packet type, format, and responder.
+        #
+        class SSH_FXP_HANDLE < Packet
+
+          #
+          # Represents SSH_FXP_HANDLE packet type.
+          #
+          TYPE = 102
+
+          #
+          # Represents SSH_FXP_HANDLE packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/packets/103_ssh_fxp_data.rb

@@ -0,0 +1,28 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_DATA packet type, format, and responder.
+        #
+        class SSH_FXP_DATA < Packet
+
+          #
+          # Represents SSH_FXP_DATA packet type.
+          #
+          TYPE = 103
+
+          #
+          # Represents SSH_FXP_DATA packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"data"      ],
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/packets/104_ssh_fxp_name.rb

@@ -0,0 +1,48 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_NAME packet type, format, and responder.
+        #
+        class SSH_FXP_NAME < Packet
+
+          #
+          # Represents SSH_FXP_NAME packet type.
+          #
+          TYPE = 104
+
+          #
+          # Represents SSH_FXP_NAME packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::Uint32, :"count"     ],
+          ]
+
+          #
+          # Represents SSH_FXP_NAME packet additional format for :"count" => N.
+          #
+          PER_COUNT_FORMAT = Hash.new{ |hash, key|
+            Array.new(key){ |i|
+              [
+                [DataTypes::String, :"filename[#{i}]"],
+                [DataTypes::String, :"longname[#{i}]"],
+                [DataTypes::Attrs,  :"attrs[#{i}]"   ],
+              ]
+            }.inject(:+)
+          }
+
+          #
+          # Represents SSH_FXP_NAME packet conditional format.
+          #
+          CONDITIONAL_FORMAT = {
+            :"count" => PER_COUNT_FORMAT,
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/packets/105_ssh_fxp_attrs.rb

@@ -0,0 +1,28 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_ATTRS packet type, format, and responder.
+        #
+        class SSH_FXP_ATTRS < Packet
+
+          #
+          # Represents SSH_FXP_ATTRS packet type.
+          #
+          TYPE = 105
+
+          #
+          # Represents SSH_FXP_ATTRS packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::Attrs,  :"attrs"     ],
+          ]
+        end
+      end
+    end
+  end
+end