SftpTree

This is a Ruby library that allows you to get a tree from a remote location over sftp. When the resulting hash is serialized into JSON it uses the JSTree syntax.

Installation

Add this line to your application's Gemfile:

gem 'sftp_tree'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sftp_tree

Usage

require 'sftp_tree'

tree = SftpTree::get_core_tree('test.example.com', 'demo', 'password', '/')

Result:

{:core=>{:data=>{:text=>"/", :children=>[{:text=>"/pub/", :children=>[{:text=>"/pub/example/", :children=>["ConsoleClient.png", "ConsoleClientSmall.png", "FtpDownloader.png", "imap-console-client.png", "KeyGenerator.png", "KeyGeneratorSmall.png", "mail-editor.png", "mail-send-winforms.png", "mime-explorer.png", "pocketftp.png", "pocketftpSmall.png", "pop3-browser.png", "pop3-console-client.png", "readme.txt", "ResumableTransfer.png", "winceclient.png", "winceclientSmall.png", "WinFormClient.png", "WinFormClientSmall.png"]}]}, "readme.txt"]}}}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/little9/sftp_tree.

License

The gem is available as open source under the terms of the MIT License.