photocopier 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in photocopier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    photocopier (0.0.1)
+      activesupport
+      escape
+      i18n
+      net-scp
+      net-ssh
+      net-ssh-gateway
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    escape (0.0.4)
+    i18n (0.6.1)
+    jruby-pageant (1.1.1)
+    multi_json (1.3.6)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-ssh (2.6.0)
+      jruby-pageant (>= 1.1.1)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  photocopier!
+  rspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Stefano Verna
+
+MIT License
+
+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,108 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'photocopier'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install photocopier
+
+## Usage
+
+```ruby
+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')
+
+# mirros the remote directory 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')
+```
+The very same commands are valid for the `Photocopier::FTP` adapter.
+
+## FTP
+
+`Photocopier::FTP.new` accepts the following parameters (you need to pass them
+all).
+
+```ruby
+{
+  host: '',
+  user: '',
+  password: ''
+}
+```
+For performance reasons, the `.get_directory` and `.put_directory` commands make
+use of `lftp`.
+
+## SSH Gotchas
+
+`Photocopier::SSH.new` accepts the following parameters (you DON'T need
+to pass them all).
+
+```ruby
+{
+  host: '',
+  user: '',
+  password: '',
+  port: '',
+  gateway: {
+    host: '',
+    user: '',
+    password: '',
+    port: ''
+  }
+}
+```
+
+**TL;DR:** Avoid specifying passwords on Photocopier::SSH, and use more secure
+and reliable ways to authenticate (`ssh-copy-id` anyone?).
+
+The passwords specified will be used during `.get` and `.put` commands (which use
+the pure-ruby `net-ssh` gem). For performance reasons, the `.get_directory` and
+`.put_directory` commands make use of `rsync`. There's no easy way to pass SSH
+passwords to `rsync`: the only way is to install a tool called [`sshpass`](http://sourceforge.net/projects/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`](https://github.com/mxcl/homebrew):
+
+```
+sudo brew install https://raw.github.com/gist/1513663/3e98bf9e03feb7e31eeddcd08f89ca86163a376d/sshpass.rb
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/photocopier/adapter.rb

@@ -0,0 +1,36 @@
+require 'escape'
+require 'tempfile'
+require 'logger'
+
+module Photocopier
+
+  class Adapter
+    attr_accessor :logger
+
+    def get(remote_path, file_path = nil); end
+
+    def put(file_path_or_string, remote_path)
+      if File.exists? file_path_or_string
+        put_file(file_path_or_string, remote_path)
+      else
+        file = Tempfile.new('put')
+        file.write file_path_or_string
+        file.close
+        put_file(file.path, remote_path)
+        file.unlink
+      end
+    end
+
+    def delete(remote_path); end
+
+    def get_directory(remote_path, local_path); end
+    def put_directory(local_path, remote_path); end
+
+    protected
+
+    def run(*args)
+      system Escape.shell_command(args)
+    end
+  end
+
+end

data/lib/photocopier/ftp.rb

@@ -0,0 +1,89 @@
+require 'net/ftp'
+require 'photocopier/adapter'
+require 'fileutils'
+
+module Photocopier
+  class FTP < Adapter
+
+    def initialize(options)
+      @options = options
+    end
+
+    def options
+      @options.clone
+    end
+
+    def get(remote_path, file_path = nil)
+      session.get remote_path, file_path
+    end
+
+    def put_file(file_path, remote_path)
+      session.put file_path, remote_path
+    end
+
+    def delete(remote_path)
+      session.delete(remote_path)
+    end
+
+    def get_directory(remote_path, local_path)
+      FileUtils.mkdir_p(local_path)
+      lftp(local_path, remote_path, false)
+    end
+
+    def put_directory(local_path, remote_path)
+      lftp(local_path, remote_path, true)
+    end
+
+    private
+
+    def lftp(local, remote, reverse)
+      run "lftp",
+          "-c",
+          [
+            "set ftp:list-options -a",
+            "open #{remote_ftp_url}",
+            "mkdir -p #{remote}",
+            "cd #{remote}",
+            "lcd #{local}",
+            lftp_mirror_arguments(reverse)
+          ].join("; ")
+    end
+
+    def remote_ftp_url
+      url = "ftp://"
+      if options[:user].present?
+        url << options[:user]
+        url << ":#{options[:password]}" if options[:password].present?
+        url << "@"
+      end
+      url << options[:host]
+      url
+    end
+
+    def lftp_mirror_arguments(reverse)
+      mirror = "mirror --delete --use-cache --verbose --allow-chown --allow-suid --no-umask --parallel=2"
+      mirror << " --reverse" if reverse
+      mirror
+    end
+
+    def lftp_mirrir_arguments(local, remote, reverse)
+
+      arguments = []
+      if gateway_options.any?
+        arguments << ssh_command(gateway_options)
+      end
+      arguments << ssh_command(options)
+      arguments.join(" ")
+    end
+
+    def session
+      opts = options
+      host = opts.delete(:host)
+      user = opts.delete(:user)
+      password = opts.delete(:password)
+      @session ||= Net::FTP.open(host, user, password)
+    end
+
+  end
+
+end

data/lib/photocopier/ssh.rb

@@ -0,0 +1,93 @@
+require 'net/ssh'
+require 'net/ssh/gateway'
+require 'net/scp'
+require 'fileutils'
+
+require 'photocopier/adapter'
+
+module Photocopier
+  class SSH < Adapter
+
+    def initialize(options)
+      @options = options
+    end
+
+    def options
+      @options.clone
+    end
+
+    def get(remote_path, file_path = nil)
+      session.scp.download! remote_path, file_path
+    end
+
+    def put_file(file_path, remote_path)
+      session.scp.upload! file_path, remote_path
+    end
+
+    def delete(remote_path)
+      session.exec!("rm -rf #{remote_path}")
+    end
+
+    def get_directory(remote_path, local_path)
+      FileUtils.mkdir_p(local_path)
+      rsync ":#{remote_path}", local_path
+    end
+
+    def put_directory(local_path, remote_path)
+      rsync local_path, ":#{remote_path}"
+    end
+
+    private
+
+    def rsync(source, destination)
+      run "rsync", "--progress", "-e", rsh_arguments, "--archive", "--compress",
+          "--omit-dir-times", "--delete", "#{source}/", destination
+    end
+
+    def rsh_arguments
+      arguments = []
+      if gateway_options.any?
+        arguments << ssh_command(gateway_options, options[:sshpass])
+      end
+      arguments << ssh_command(options, gateway_options[:sshpass])
+      arguments.join(" ")
+    end
+
+    def ssh_command(opts, use_sshpass=true)
+      command = "ssh "
+      command << "-p #{opts[:port]} " if opts[:port].present?
+      command << "#{opts[:user]}@" if opts[:user].present?
+      command << opts[:host]
+      if opts[:password] && use_sshpass
+        command = "sshpass -p #{opts[:password]} #{command}"
+      end
+      command
+    end
+
+    def session
+      opts = options
+      host = opts.delete(:host)
+      user = opts.delete(:user)
+      opts.delete(:gateway)
+      opts.delete(:sshpass)
+      @session ||= if gateway_options.any?
+                     gateway.ssh(host, user, opts)
+                   else
+                     Net::SSH.start(host, user, opts)
+                   end
+    end
+
+    def gateway
+      opts = gateway_options
+      host = opts.delete(:host)
+      user = opts.delete(:user)
+      opts.delete(:sshpass)
+      @gateway ||= Net::SSH::Gateway.new(host, user, opts)
+    end
+
+    def gateway_options
+      options[:gateway] || {}
+    end
+
+  end
+end

data/lib/photocopier/version.rb

@@ -0,0 +1,3 @@
+module Photocopier
+  VERSION = "0.0.1"
+end

data/lib/photocopier.rb

@@ -0,0 +1,4 @@
+require "active_support/core_ext"
+
+require "photocopier/ssh"
+require "photocopier/ftp"

data/photocopier.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/photocopier/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Stefano Verna"]
+  gem.email         = ["stefano.verna@welaika.com"]
+  gem.description   = %q{Photocopier provides FTP/SSH adapters to abstract away file and directory copying.}
+  gem.summary       = %q{Photocopier provides FTP/SSH adapters to abstract away file and directory copying.}
+  gem.homepage      = "https://github.com/stefanoverna/photocopier"
+
+  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.name          = "photocopier"
+  gem.require_paths = ["lib"]
+  gem.version       = Photocopier::VERSION
+
+  gem.add_dependency "activesupport"
+  gem.add_dependency "i18n"
+  gem.add_dependency "net-ssh"
+  gem.add_dependency "net-scp"
+  gem.add_dependency "net-ssh-gateway"
+  gem.add_dependency "escape"
+
+  gem.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: photocopier
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stefano Verna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh-gateway
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Photocopier provides FTP/SSH adapters to abstract away file and directory
+  copying.
+email:
+- stefano.verna@welaika.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/photocopier.rb
+- lib/photocopier/adapter.rb
+- lib/photocopier/ftp.rb
+- lib/photocopier/ssh.rb
+- lib/photocopier/version.rb
+- photocopier.gemspec
+homepage: https://github.com/stefanoverna/photocopier
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Photocopier provides FTP/SSH adapters to abstract away file and directory
+  copying.
+test_files: []