jsch_sftp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e51f25e22a07fb4bd8a98439c062fca66e7069cb
+  data.tar.gz: 96c0a5bd7e2198d6b1ee09cb25b192df596531b7
+SHA512:
+  metadata.gz: 441822f3ddce6129d59022e70ad6a6a194bf9f3a8c1fd34a2b8f9a864b83687540725da435bf2927ffe0b393d908f95ccceafa1024234a4208ea35103603ffe9
+  data.tar.gz: 0cef60b9dccf5cacfab5c502f8eadd5b9722e90740a19bf13be4d5cd307e5c554855593dc9671861d0ab01064264b4719b2dc44dd515be48b76df4baf06d15ad

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    jsch_sftp (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jsch_sftp!
+  rake
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 AquisTech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# jsch_sftp
+
+A simple JRuby wrapper around the Java [JSch](http://www.jcraft.com/jsch/) library for SFTP implementation.
+Current JSch version is `0.1.55`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jsch_sftp'
+
+then execute:
+
+    $ bundle
+
+## Usage
+
+```
+require 'jsch_sftp'
+require 'jsch_sftp/sftp'
+
+JschSFTP::SFTP.start('host', 'user', identity: '/path/to/keyfile') do |sftp|
+  # To list files/folders
+  sftp.entries('/').each do |entry|
+    puts entry.name
+  end
+
+  # To upload
+  sftp.upload!('/path/to/local', '/path/to/remote')
+
+  # To download
+  sftp.download!('/path/to/remote', '/path/to/local')
+end
+```
+
+## Special Thanks
+This library is a port of [jsch-sftp](https://github.com/modcloth-labs/jsch-sftp) but uses latest version of JSch.
+Thanks madcloth-labs.
+I have ported it with plans to upgrade and maintain it and also release it as a gem for ease of use.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = "--tty --color"
+end
+
+task :default => :spec
+
+load 'jsch_sftp.gemspec'
+

data/jsch-LICENSE.txt

@@ -0,0 +1,30 @@
+JSch 0.0.* was released under the GNU LGPL license.  Later, we have switched
+over to a BSD-style license.
+
+------------------------------------------------------------------------------
+Copyright (c) 2002-2015 Atsuhiko Yamanaka, JCraft,Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+  1. Redistributions of source code must retain the above copyright notice,
+     this list of conditions and the following disclaimer.
+
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in
+     the documentation and/or other materials provided with the distribution.
+
+  3. The names of the authors may not be used to endorse or promote products
+     derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JCRAFT,
+INC. OR ANY CONTRIBUTORS TO THIS SOFTWARE BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/jsch_sftp.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsch_sftp/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jsch_sftp"
+  gem.version       = JschSFTP::VERSION
+  gem.authors       = ['AquisTech']
+  gem.email         = ['aquis.tech@gmail.com']
+  gem.description   = %q{Jsch wrapper for SFTP in JRuby}
+  gem.summary       = %q{Wraps Jsch library for easy implementation of SFTP in JRuby}
+  gem.homepage      = 'https://github.com/AquisTech/jsch_sftp'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/jsch_sftp.rb

@@ -0,0 +1,2 @@
+require 'jsch_sftp/version'
+require 'jsch_sftp/init'

data/lib/jsch_sftp/init.rb

@@ -0,0 +1,3 @@
+require 'java'
+$CLASSPATH << File.expand_path('../', __FILE__)
+require 'jsch-0.1.55.jar'

data/lib/jsch_sftp/sftp.rb

@@ -0,0 +1,31 @@
+require_relative 'sftp/session'
+
+module JschSFTP
+  module SFTP
+
+    def self.start(host, user, options = {})
+      begin
+        session = connect(user, host, options)
+
+        yield session
+      rescue Exception => e
+        raise e
+      ensure
+        session.disconnect unless session.nil?
+      end
+    end
+
+    private
+
+    def self.connect(user, host, options)
+      jsch = com.jcraft.jsch.JSch.new
+      configure(jsch, options)
+
+      Session.connect(jsch, user, host, options)
+    end
+
+    def self.configure(jsch, options)
+      jsch.add_identity(options[:identity]) if options.key?(:identity)
+    end
+  end
+end

data/lib/jsch_sftp/sftp/channel.rb

@@ -0,0 +1,57 @@
+require_relative 'entry'
+
+module JschSFTP
+  module SFTP
+    class Channel
+
+      def initialize(channel)
+        @channel = channel
+      end
+
+      def connected?
+        channel.is_connected
+      end
+
+      def download!(remote_filepath, local_filepath)
+        channel.get(remote_filepath, local_filepath)
+      end
+
+      def upload!(local_filepath, remote_filepath)
+        channel.put(local_filepath, remote_filepath)
+      end
+
+      def mkdir(remote_path)
+        channel.mkdir(remote_path)
+      end
+
+      def entries(remote_path)
+        to_entries(channel.ls(remote_path))
+      end
+
+      def disconnect
+        if connected?
+          channel.disconnect rescue nil
+        end
+      end
+
+      def self.connect(session)
+        channel = session.open_channel("sftp")
+        channel.connect
+
+        self.new(channel)
+      end
+
+      private
+
+      attr_reader :channel
+
+      def to_entries(entries)
+        entries.map { |e| to_entry(e) }
+      end
+
+      def to_entry(entry)
+        Entry.new(entry.filename)
+      end
+    end
+  end
+end

data/lib/jsch_sftp/sftp/entry.rb

@@ -0,0 +1,12 @@
+module JschSFTP
+  module SFTP
+    class Entry
+
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+  end
+end

data/lib/jsch_sftp/sftp/session.rb

@@ -0,0 +1,60 @@
+require_relative 'channel'
+
+module JschSFTP
+  module SFTP
+    class Session
+      attr_reader :channel
+
+      def initialize(session, channel)
+        @session, @channel = session, channel
+      end
+
+      def connected?
+        session.is_connected
+      end
+
+      def download!(remote_filepath, local_filepath)
+        channel.download!(remote_filepath, local_filepath)
+      end
+
+      def entries(remote_path)
+        channel.entries(remote_path)
+      end
+
+      def upload!(local_filepath, remote_filepath)
+        channel.upload!(local_filepath, remote_filepath)
+      end
+
+      def mkdir(remote_path)
+        channel.mkdir(remote_path)
+      end
+
+      def disconnect
+        channel.disconnect unless channel.nil?
+
+        if connected?
+          session.disconnect rescue nil
+        end
+      end
+
+      def self.connect(jsch, user, host, options)
+        session = jsch.get_session(user, host)
+        configure(session, options)
+        session.connect
+
+        channel = Channel.connect(session)
+
+        self.new(session, channel)
+      end
+
+      private
+
+      attr_reader :session
+
+      def self.configure(session, options)
+        session.set_password(options[:password]) if options.key?(:password)
+        session.set_config("StrictHostKeyChecking", "no")
+      end
+    end
+  end
+end

data/lib/jsch_sftp/version.rb

@@ -0,0 +1,3 @@
+module JschSFTP
+  VERSION = "0.1.0"
+end

data/spec/lib/jsch_sftp/end_to_end_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../../../lib/jsch_sftp/init'
+require_relative '../../../lib/jsch_sftp/sftp'
+require 'fileutils'
+require 'tmpdir'
+
+describe JschSFTP::SFTP do
+  let(:host) { 'localhost' }
+  let(:user) { ENV['USER'] }
+
+  before(:all) do
+    @sourcedir = File.join(File.expand_path(File.dirname(__FILE__)), '../../')
+    @destdir = Dir.mktmpdir('sftp_work')
+
+    home = Java::JavaLang::System.get_property('user.home')
+    @identity = File.join(home, '.ssh/id_rsa')
+  end
+
+  context "downloading a file" do
+    it "should download the given remote file to the given local path" do
+      remote_file = File.join(@sourcedir, 'test.tgz')
+      local_file = File.join(@destdir, 'test.tgz.down')
+
+      described_class.start(host, user, identity: @identity) do |sftp|
+        sftp.download!(remote_file, local_file)
+      end
+
+      File.exists?(local_file).should be_true
+    end
+  end
+
+  context "uploading a file" do
+    it "should upload the given local file to the given remote path" do
+      local_file = File.join(@sourcedir, 'test.tgz')
+      remote_file = File.join(@destdir, 'test.tgz.up')
+
+      described_class.start(host, user, identity: @identity) do |sftp|
+        sftp.upload!(local_file, remote_file)
+      end
+
+      File.exists?(remote_file).should be_true
+    end
+  end
+
+  context "listing the contents of a remote directory" do
+    it "should return a list of the entries in the remote directory" do
+      FileUtils.touch(File.join(@destdir, 'empty1.txt'))
+      FileUtils.touch(File.join(@destdir, 'empty2.txt'))
+      names = []
+
+      described_class.start(host, user, identity: @identity) do |sftp|
+        sftp.entries(@destdir).each { |f| names << f.name }
+      end
+
+      names.should be_include('empty1.txt')
+      names.should be_include('empty2.txt')
+    end
+  end
+
+  context "making a remote directory" do
+    it "should create the specified directory on the remote server" do
+      remote_dir = File.join(@destdir, 'test_dir')
+
+      described_class.start(host, user, identity: @identity) do |sftp|
+        sftp.mkdir(remote_dir)
+      end
+
+      File.exists?(remote_dir).should be_true
+      File.directory?(remote_dir).should be_true
+    end
+  end
+end

data/spec/lib/jsch_sftp/sftp_spec.rb

@@ -0,0 +1,44 @@
+require_relative '../../../lib/jsch_sftp/init'
+require_relative '../../../lib/jsch_sftp/sftp'
+
+describe JschSFTP::SFTP do
+
+  context "opening a remote connection" do
+    let(:sftp) { double('sftp', disconnect: nil) }
+
+    before(:each) do
+      described_class.stub(:connect).and_return(sftp)
+    end
+
+    context "when the commands complete successfully" do
+      it "should automatically close the connection" do
+        sftp.should_receive(:disconnect)
+
+          described_class.start('host', 'user') do |sftp|
+            # noop
+          end
+      end
+    end
+
+    context "when an error occurs while executing one of the commands" do
+      it "should automatically close the connection" do
+        sftp.should_receive(:disconnect)
+
+        begin
+          described_class.start('host', 'user') do |sftp|
+            raise StandardError
+          end
+        rescue
+        end
+      end
+
+      it "should re-raise the error" do
+        expect {
+          described_class.start('host', 'user') do |sftp|
+            raise StandardError
+          end
+        }.to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'jsch_sftp'
+
+Rspec.configure do |config|
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: jsch_sftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AquisTech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Jsch wrapper for SFTP in JRuby
+email:
+- aquis.tech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jsch-LICENSE.txt
+- jsch_sftp.gemspec
+- lib/jsch_sftp.rb
+- lib/jsch_sftp/init.rb
+- lib/jsch_sftp/jsch-0.1.55.jar
+- lib/jsch_sftp/sftp.rb
+- lib/jsch_sftp/sftp/channel.rb
+- lib/jsch_sftp/sftp/entry.rb
+- lib/jsch_sftp/sftp/session.rb
+- lib/jsch_sftp/version.rb
+- spec/lib/jsch_sftp/end_to_end_spec.rb
+- spec/lib/jsch_sftp/sftp_spec.rb
+- spec/spec_helper.rb
+- spec/test.tgz
+homepage: https://github.com/AquisTech/jsch_sftp
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Wraps Jsch library for easy implementation of SFTP in JRuby
+test_files:
+- spec/lib/jsch_sftp/end_to_end_spec.rb
+- spec/lib/jsch_sftp/sftp_spec.rb
+- spec/spec_helper.rb
+- spec/test.tgz