Photocopier

Photocopier provides handy FTP/SSH adapters to abstract away file and directory copying. To move directories to/from the remote server, it wraps efficient tools like lftp and rsync.

Prerequisites

If you need to use FTP protocol you need to install LFTP on your machine.

Installation

Add this line to your application's Gemfile:

gem 'photocopier'

And then execute:

$ bundle

Or install it yourself as:

$ gem install photocopier

Usage

require 'photocopier'

ssh = Photocopier::SSH.new(
  host: 'my_host',
  user: 'my_user'
)

# downloads a file and returns the content
puts ssh.get('remote_file.txt')

# downloads a file and saves the content
ssh.get('remote_file.txt', './local_file.txt')

# uploads a file with the specified content
ssh.put('foobar!', 'remote_file.txt')

# uploads a file
ssh.put('./local_file.txt', 'remote_file.txt')

# deletes a file
ssh.delete('remote_file.txt')

# mirros the remote directory content into the local machine (needs rsync on the local machine)
ssh.get_directory('remote_dir', './local_dir')

# and viceversa
ssh.put_directory('./local_dir', 'remote_dir')

# execs a command and waits for the result, returns stdout, stderr and exit code
ssh.exec!('pwd') # => [ "/home/128423/users/.home\n", "", 0 ]

The very same commands are valid for the Photocopier::FTP adapter.

FTP

Photocopier::FTP.new accepts the following parameters

{
  host: '', #mandatory
  user: '', #mandatory
  password: '', #mandatory
  scheme: 'ftp' #default, other options are sftp and ftps
}

For performance reasons, the .get_directory and .put_directory commands make use of lftp, so you need to have it installed on your machine.

SSH

Photocopier::SSH.new accepts the following parameters (you DON'T need to pass them all).

{
  host: '',
  user: '',
  password: '',
  port: '',
  rsync_options: '',
  gateway: {
    host: '',
    user: '',
    password: '',
    port: ''
  }
}

For performance reasons, the .get_directory and .put_directory commands make use of rsync, so you need to have it installed on your machine.

Password gotchas

TL;DR: Avoid specifying the password argument on Photocopier::SSH, and use more secure and reliable ways to authenticate (ssh-copy-id anyone?).

There's no easy way to pass SSH passwords to rsync: the only way is to install a tool called sshpass on your machine (and on the gateway machine, if you also need to specify the password of the final machine).

On Linux, you can install it with your standard package manager. On Mac, you can have it via brew:

brew install https://raw.github.com/eugeneoden/homebrew/eca9de1/Library/Formula/sshpass.rb

Please note that on Ubuntu 11.10 sshpass is at version 1.04, which has a bug that prevents it from working. Install version 1.03 or 1.05.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Author

made with ❤️ and ☕️ by weLaika

License

(The MIT License)

Copyright © 2012-2019 weLaika