photocopier 0.0.4 → 0.0.5

data/.gitignore

@@ -1,2 +1 @@
-spec
 pkg

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@photocopier

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    photocopier (0.0.1)
+    photocopier (0.0.4)
       activesupport
       escape
       i18n
@@ -12,18 +12,16 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.8)
+    activesupport (3.2.9)
       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)
+    multi_json (1.4.0)
     net-scp (1.0.4)
       net-ssh (>= 1.99.1)
-    net-ssh (2.6.0)
-      jruby-pageant (>= 1.1.1)
+    net-ssh (2.6.2)
     net-ssh-gateway (1.1.0)
       net-ssh (>= 1.99.1)
     rspec (2.11.0)

data/README.md

@@ -47,6 +47,9 @@ 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 output and exit code
+ssh.exec!('pwd') # => [ "/home/128423/users/.home\n", 0 ]
 ```
 The very same commands are valid for the `Photocopier::FTP` adapter.
 

data/lib/photocopier/adapter.rb

@@ -1,14 +1,13 @@
 require 'escape'
 require 'tempfile'
 require 'logger'
+require 'active_support/all'
 
 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)
@@ -21,10 +20,13 @@ module Photocopier
       end
     end
 
-    def delete(remote_path); end
+    def put_file(file_path, remote_path); end
+    def put_directory(local_path, remote_path, exclude = []); end
 
+    def get(remote_path, file_path = nil); end
     def get_directory(remote_path, local_path, exclude = []); end
-    def put_directory(local_path, remote_path, exclude = []); end
+
+    def delete(remote_path); end
 
     protected
 

data/lib/photocopier/ftp.rb

@@ -5,7 +5,7 @@ require 'fileutils'
 module Photocopier
   class FTP < Adapter
 
-    def initialize(options)
+    def initialize(options = {})
       @options = options
     end
 
@@ -76,16 +76,5 @@ module Photocopier
       end
       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
-
   end
-
 end

data/lib/photocopier/ssh.rb

@@ -8,7 +8,7 @@ require 'photocopier/adapter'
 module Photocopier
   class SSH < Adapter
 
-    def initialize(options)
+    def initialize(options = {})
       @options = options
     end
 
@@ -25,7 +25,7 @@ module Photocopier
     end
 
     def delete(remote_path)
-      session.exec!("rm -rf #{remote_path}")
+      exec!("rm -rf #{remote_path}")
     end
 
     def get_directory(remote_path, local_path, exclude = [])
@@ -50,9 +50,21 @@ module Photocopier
                    end
     end
 
+    def exec!(cmd)
+      result = ""
+      exit_code = nil
+      session.exec!(cmd) do |ch, type, data|
+        result << data
+        ch.on_request("exit-status") do |ch, data|
+          exit_code = data.read_long
+        end
+      end
+      [ result, exit_code ]
+    end
+
     private
 
-    def rsync(source, destination, exclude)
+    def rsync(source, destination, exclude = [])
       command = [
         "rsync", "--progress", "-e", rsh_arguments, "--archive", "--compress",
         "--omit-dir-times", "--delete"
@@ -100,6 +112,5 @@ module Photocopier
     def gateway_options
       options[:gateway] || {}
     end
-
   end
 end

data/lib/photocopier/version.rb

@@ -1,3 +1,3 @@
 module Photocopier
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/adapter_spec.rb

@@ -0,0 +1,6 @@
+require 'photocopier/adapter'
+require 'shared_examples_for_adapter'
+
+describe Photocopier::Adapter do
+  it_behaves_like "a Photocopier adapter"
+end

data/spec/ftp_spec.rb

@@ -0,0 +1,162 @@
+require 'photocopier/ftp'
+require 'shared_examples_for_adapter'
+
+describe Photocopier::FTP do
+  it_behaves_like "a Photocopier adapter"
+
+  let(:ftp) { Photocopier::FTP.new(options) }
+  let(:options) do { :host => "host", :user => "user", :password => "password" } end
+
+  context "#session" do
+    it "retrieves an FTP session" do
+      Net::FTP.should_receive(:open).with("host", "user", "password")
+      ftp.session
+    end
+
+    context "passive mode" do
+      let(:options) do { :host => "host", :passive => true } end
+
+      it "should enable passive mode" do
+        Net::FTP.stub(:open).and_return(stub.as_null_object)
+        ftp.session.should be_passive
+      end
+    end
+  end
+
+  context "#remote_ftp_url" do
+    let(:options) do { :host => "host" } end
+
+    it "should build an ftp url" do
+      ftp.send(:remote_ftp_url).should == "ftp://host"
+    end
+
+    context "given an username" do
+      let(:options) do { :host => "host", :user => "user" } end
+
+      it "should add it to the url" do
+        ftp.send(:remote_ftp_url).should == "ftp://user@host"
+      end
+
+      context "given a password" do
+        let(:options) do { :host => "host", :user => "user", :password => "password" } end
+
+        it "should add it to the url" do
+          ftp.send(:remote_ftp_url).should == "ftp://user:password@host"
+        end
+      end
+    end
+  end
+
+  context "#lftp_mirror_arguments" do
+    let(:lftp_arguments) do
+      %w(
+        mirror
+        --delete
+        --use-cache
+        --verbose
+        --allow-chown
+        --allow-suid
+        --no-umask
+        --parallel=2
+      )
+    end
+
+    it "should build arguments for lftp" do
+      ftp.send(:lftp_mirror_arguments, false, []).should == lftp_arguments.join(" ")
+    end
+
+    it "should build args for reverse mirroring" do
+      lftp_arguments << "--reverse"
+      ftp.send(:lftp_mirror_arguments, true, []).should == lftp_arguments.join(" ")
+    end
+
+    it "should exclude files" do
+      lftp_arguments << "--exclude-glob .git"
+      ftp.send(:lftp_mirror_arguments, false, [".git"]).should == lftp_arguments.join(" ")
+    end
+  end
+
+  context "#lftp" do
+
+    let(:remote) { "remote" }
+    let(:local) { "local" }
+
+    before(:each) do
+      ftp.stub(:remote_ftp_url).and_return("remote_ftp_url")
+      ftp.stub(:lftp_mirror_arguments).and_return("lftp_mirror_arguments")
+    end
+
+    let(:lftp_command) do
+      [
+        "lftp",
+        "-c",
+        [
+          "set ftp:list-options -a",
+          "open remote_ftp_url",
+          "mkdir -p #{remote}",
+          "cd #{remote}",
+          "lcd #{local}",
+          "lftp_mirror_arguments"
+        ].join("; ")
+      ]
+    end
+
+    it "should build a lftp command" do
+      ftp.should_receive(:run).with(*lftp_command)
+      ftp.send(:lftp, local, remote, false, [])
+    end
+  end
+
+  context "adapter interface" do
+
+    let(:remote_path) { stub }
+    let(:local_path)  { stub }
+    let(:file_path)   { stub }
+    let(:session)     { stub }
+
+    before(:each) do
+      ftp.stub(:session).and_return(session)
+    end
+
+    context "#get" do
+      it "should get a remote path" do
+        session.should_receive(:get).with(remote_path, file_path)
+        ftp.get(remote_path, file_path)
+      end
+    end
+
+    context "#put_file" do
+      it "should send a file to remote" do
+        session.should_receive(:put).with(file_path, remote_path)
+        ftp.put_file(file_path, remote_path)
+      end
+    end
+
+    context "#delete" do
+      it "should delete a remote path" do
+        session.should_receive(:delete).with(remote_path)
+        ftp.delete(remote_path)
+      end
+    end
+
+    context "directories management" do
+      let(:remote_path) { "remote_path" }
+      let(:exclude_list) { [] }
+
+      context "#get_directory" do
+        it "should get a remote directory" do
+          FileUtils.should_receive(:mkdir_p).with(local_path)
+          ftp.should_receive(:lftp).with(local_path, remote_path, false, exclude_list)
+          ftp.get_directory(remote_path, local_path, exclude_list)
+        end
+      end
+
+      context "#put_directory" do
+        it "should send a directory to remote" do
+          ftp.should_receive(:lftp).with(local_path, remote_path, true, exclude_list)
+          ftp.put_directory(local_path, remote_path, exclude_list)
+        end
+      end
+    end
+  end
+end

data/spec/shared_examples_for_adapter.rb

@@ -0,0 +1,71 @@
+require 'photocopier/adapter'
+
+shared_examples_for "a Photocopier adapter" do
+  let(:adapter) { described_class.new }
+
+  context "adapter interface" do
+    it "should expose all adapter methods" do
+      [
+        :put,
+        :put_file,
+        :put_directory,
+        :get,
+        :get_directory,
+        :delete
+      ].each do |sym|
+        adapter.should respond_to(sym)
+      end
+    end
+  end
+
+  context "#put" do
+    let(:file_path) { Tempfile.new("tmp").path }
+    let(:remote_path) { stub }
+
+    context "given a real file path" do
+      it "should put a file" do
+        adapter.should_receive(:put_file).with(file_path, remote_path)
+        adapter.put(file_path, remote_path)
+      end
+    end
+
+    context "given a string" do
+      let(:string) { "foobar" }
+      let(:file) { stub(:path => "path") }
+
+      it "should write it to file, put it and remove the file" do
+        Tempfile.stub(:new).and_return(file)
+
+        file.should_receive(:write).with(string)
+        file.should_receive(:close)
+        adapter.should_receive(:put_file).with("path", remote_path)
+        file.should_receive(:unlink)
+
+        adapter.put(string, remote_path)
+      end
+    end
+
+    context "#run" do
+      let(:arg) { stub }
+      let(:command) { stub }
+      before(:each) {
+        Escape.stub(:shell_command).with([arg]).and_return(command)
+      }
+
+      it "should delegate to Kernel system" do
+        adapter.should_receive(:system).with(command)
+        adapter.send(:run, arg)
+      end
+
+      context "given a logger" do
+        let(:logger) { stub }
+
+        it "should send the command to the logger" do
+          adapter.logger = logger
+          logger.should_receive(:info).with(command)
+          adapter.send(:run, arg)
+        end
+      end
+    end
+  end
+end

data/spec/ssh_spec.rb

@@ -0,0 +1,178 @@
+require 'photocopier/ssh'
+require 'shared_examples_for_adapter'
+
+describe Photocopier::SSH do
+  it_behaves_like "a Photocopier adapter"
+
+  let(:ssh) { Photocopier::SSH.new(options) }
+  let(:options) do { :host => "host", :user => "user" } end
+  let(:gateway_config) do { :host => "gate_host", :user => "gate_user" } end
+  let(:options_with_gateway) do
+    {
+      :host => "host",
+      :user => "user",
+      :gateway => gateway_config
+    }
+  end
+
+  context "#session" do
+    it "retrieves an SSH session" do
+      Net::SSH.should_receive(:start).with("host", "user", {})
+      ssh.session
+    end
+
+    context "given a gateway " do
+      let(:options) { options_with_gateway }
+      let(:gateway) { stub }
+
+      it "goes through it to retrieve a session" do
+        Net::SSH::Gateway.stub(:new).with("gate_host", "gate_user", {}).and_return(gateway)
+        gateway.should_receive(:ssh).with("host", "user", {})
+        ssh.session
+      end
+    end
+  end
+
+  context "#ssh_command" do
+    let(:options) do { :host => "host" } end
+
+    it "should build an ssh command" do
+      ssh.send(:ssh_command, options).should == "ssh host"
+    end
+
+    context "given a port" do
+      let(:options) do { :host => "host", :port => "port" } end
+      it "should be added to the command" do
+        ssh.send(:ssh_command, options).should == "ssh -p port host"
+      end
+    end
+
+    context "given a user" do
+      let(:options) do { :host => "host", :user => "user" } end
+      it "should be added to the command" do
+        ssh.send(:ssh_command, options).should == "ssh user@host"
+      end
+    end
+
+    context "given a password" do
+      let(:options) do { :host => "host", :password => "password" } end
+
+      context "sshpass is enabled" do
+        it "should be added to the command" do
+          ssh.send(:ssh_command, options, true).should == "sshpass -p password ssh host"
+        end
+      end
+
+      context "sshpass is disabled" do
+        it "should not change the command" do
+          ssh.send(:ssh_command, options, false).should == "ssh host"
+        end
+      end
+    end
+  end
+
+  context "#rsh_arguments" do
+    it "should build arguments for rsync" do
+      ssh.should_receive(:ssh_command).with(options, anything)
+      ssh.send(:rsh_arguments)
+    end
+
+    context "given a gateway" do
+      let(:options) { options_with_gateway }
+      it "should include gateway options" do
+        ssh.should_receive(:ssh_command).with(gateway_config, anything)
+        ssh.should_receive(:ssh_command).with(options, anything)
+        ssh.send(:rsh_arguments)
+      end
+    end
+  end
+
+  context "#rsync" do
+    before(:each) do
+      ssh.stub(:rsh_arguments).and_return("rsh_arguments")
+    end
+
+    let(:rsync_command) {
+      %w(
+        rsync
+        --progress
+        -e
+        rsh_arguments
+        --archive
+        --compress
+        --omit-dir-times
+        --delete
+      )
+    }
+
+    it "should build an rsync command" do
+      rsync_command << "source/" << "destination"
+      ssh.should_receive(:run).with(*rsync_command)
+      ssh.send(:rsync, "source", "destination")
+    end
+
+    context "given an exclude list" do
+      it "should skip excluded paths" do
+        rsync_command << "--exclude" << ".git"
+        rsync_command << "source/" << "destination"
+        ssh.should_receive(:run).with(*rsync_command)
+        ssh.send(:rsync, "source", "destination", [".git"])
+      end
+    end
+  end
+
+  context "adapter interface" do
+
+    let(:remote_path) { stub }
+    let(:local_path)  { stub }
+    let(:file_path)   { stub }
+    let(:scp)         { stub }
+    let(:session)     { stub(:scp => scp) }
+
+    before(:each) do
+      ssh.stub(:session).and_return(session)
+    end
+
+    context "#get" do
+      it "should get a remote path" do
+        scp.should_receive(:download!).with(remote_path, file_path)
+        ssh.get(remote_path, file_path)
+      end
+    end
+
+    context "#put_file" do
+      it "should send a file to remote" do
+        scp.should_receive(:upload!).with(file_path, remote_path)
+        ssh.put_file(file_path, remote_path)
+      end
+    end
+
+    context "#delete" do
+      it "should delete a remote path" do
+        ssh.should_receive(:exec!).with("rm -rf foo")
+        ssh.delete("foo")
+      end
+    end
+
+    context "directories management" do
+      let(:remote_path) { "remote_path" }
+      let(:exclude_list) { [] }
+
+      context "#get_directory" do
+        it "should get a remote directory" do
+          FileUtils.should_receive(:mkdir_p).with(local_path)
+          ssh.should_receive(:rsync).with(":remote_path", local_path, exclude_list)
+          ssh.get_directory(remote_path, local_path, exclude_list)
+        end
+      end
+
+      context "#put_directory" do
+        it "should send a directory to remote" do
+          ssh.should_receive(:rsync).with(local_path, ":remote_path", exclude_list)
+          ssh.put_directory(local_path, remote_path, exclude_list)
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: photocopier
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,6 +132,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -143,6 +144,10 @@ files:
 - lib/photocopier/ssh.rb
 - lib/photocopier/version.rb
 - photocopier.gemspec
+- spec/adapter_spec.rb
+- spec/ftp_spec.rb
+- spec/shared_examples_for_adapter.rb
+- spec/ssh_spec.rb
 homepage: https://github.com/stefanoverna/photocopier
 licenses: []
 post_install_message: 
@@ -168,4 +173,9 @@ signing_key:
 specification_version: 3
 summary: Photocopier provides FTP/SSH adapters to abstract away file and directory
   copying.
-test_files: []
+test_files:
+- spec/adapter_spec.rb
+- spec/ftp_spec.rb
+- spec/shared_examples_for_adapter.rb
+- spec/ssh_spec.rb
+has_rdoc: