libssh 0.1.0 → 0.2.0

data/lib/libssh.rb

@@ -1,7 +1,3 @@
 require 'libssh/version'
 require 'libssh/libssh_ruby'
 require 'libssh/key'
-
-module LibSSh
-  # Your code goes here...
-end

data/lib/libssh/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module LibSSH
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/sshkit/backends/libssh.rb

@@ -17,6 +17,43 @@ module SSHKit
       end
 
       BUFSIZ = 16384
+      private_constant :BUFSIZ
+
+      # @override
+      def upload!(local, remote, _options = {})
+        with_session do |session|
+          scp = LibSSH::Scp.new(session, :write, File.dirname(remote))
+          wrap_local_reader(local) do |io, mode|
+            scp.init do
+              scp.push_file(File.basename(remote), io.size, mode)
+              info "Uploading #{remote}"
+              while (buf = io.read(BUFSIZ))
+                scp.write(buf)
+              end
+            end
+          end
+        end
+      end
+
+      # @override
+      def download!(remote, local, _options = {})
+        with_session do |session|
+          scp = LibSSH::Scp.new(session, :read, remote)
+          scp.init do
+            loop do
+              case scp.pull_request
+              when LibSSH::Scp::REQUEST_NEWFILE
+                info "Downloading #{remote}"
+                download_file(scp, local)
+              when LibSSH::Scp::REQUEST_NEWDIR
+                scp.deny_request('Only NEWFILE is acceptable')
+              when LibSSH::Scp::REQUEST_EOF
+                break
+              end
+            end
+          end
+        end
+      end
 
       @pool = SSHKit::Backend::ConnectionPool.new
 
@@ -64,13 +101,52 @@ module SSHKit
         end
       end
 
+      def wrap_local_reader(local)
+        if local.respond_to?(:read)
+          # local is IO-like object
+          yield(local, 0644)
+        else
+          File.open(local, 'rb') do |f|
+            yield(f, File.stat(local).mode & 0xfff)
+          end
+        end
+      end
+
+      def wrap_local_writer(local, mode)
+        if local.respond_to?(:write)
+          # local is IO-like object
+          yield(local)
+        else
+          File.open(local, 'wb', mode) do |f|
+            yield(f)
+          end
+        end
+      end
+
+      def download_file(scp, local)
+        size = scp.request_size
+        mode = scp.request_permissions
+        scp.accept_request
+        wrap_local_writer(local, mode) do |io|
+          n = 0
+          while n < size
+            buf = scp.read(size - n)
+            io.write(buf)
+            n += buf.size
+          end
+        end
+      end
+
       def with_session
-        entry = self.class.pool.checkout(host.hostname) do
+        host.ssh_options = Libssh.config.ssh_options.merge(host.ssh_options || {})
+        entry = self.class.pool.checkout(String(host.hostname), host.username, host.netssh_options) do |hostname, username, ssh_options|
           LibSSH::Session.new.tap do |session|
-            session.host = host.hostname
-            session.parse_config
-            session.add_identity('%d/id_ed25519')
-
+            session.host = hostname
+            username = ssh_options.fetch(:user, username)
+            if username
+              session.user = username
+            end
+            configure_session(session, ssh_options)
             session.connect
             if session.server_known != LibSSH::SERVER_KNOWN_OK
               raise 'unknown host'
@@ -87,6 +163,33 @@ module SSHKit
           self.class.pool.checkin(entry)
         end
       end
+
+      def configure_session(session, ssh_options)
+        if ssh_options[:port]
+          session.port = ssh_options[:port]
+        end
+
+        session.add_identity('%d/id_ed25519')
+        keys = Array(ssh_options[:keys])
+        unless keys.empty?
+          keys.each do |key|
+            session.add_identity(key)
+          end
+        end
+
+        ssh_options.fetch(:config, true).tap do |config|
+          case config
+          when true
+            # Load from default ssh_config
+            session.parse_config
+          when false, nil
+            # Don't load from ssh_config
+          else
+            # Load from specified path
+            session.parse_config(config)
+          end
+        end
+      end
     end
   end
 end

data/libssh.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rake-compiler'
-  spec.add_development_dependency 'sshkit'
   spec.add_development_dependency 'rubocop', '>= 0.36.0'
+  spec.add_development_dependency 'sshkit'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libssh
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-23 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.36.0
 - !ruby/object:Gem::Dependency
   name: sshkit
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.36.0
+        version: '0'
 description: Ruby binding for libssh.
 email:
 - eagletmt@gmail.com
@@ -101,6 +115,8 @@ files:
 - bin/console
 - bin/setup
 - example/exec.rb
+- example/scp_download.rb
+- example/scp_upload.rb
 - example/sshkit.rb
 - example/write.rb
 - ext/libssh_ruby/channel.c
@@ -109,6 +125,7 @@ files:
 - ext/libssh_ruby/key.c
 - ext/libssh_ruby/libssh_ruby.c
 - ext/libssh_ruby/libssh_ruby.h
+- ext/libssh_ruby/scp.c
 - ext/libssh_ruby/session.c
 - lib/libssh.rb
 - lib/libssh/key.rb
@@ -140,3 +157,4 @@ signing_key:
 specification_version: 4
 summary: Ruby binding for libssh.
 test_files: []
+has_rdoc: