net-scp 1.0.2 → 1.0.3

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 1.0.3 / 17 Aug 2010
+
+* replace :sanitize_file_name with a call to String#shellescape [Sung Pae]
+* Added gemspec file and removed echoe dependency [Miron Cuperman, Delano Mandelbaum]
+* Removed Hanna dependency in Rakefile [Delano Mandelbaum]
+
+
 === 1.0.2 / 4 Feb 2009
 
 * Escape spaces in file names on remote server [Jamis Buck]

data/README.rdoc

@@ -1,6 +1,6 @@
 = Net::SCP
 
-* http://net-ssh.rubyforge.org/scp
+* http://github.com/net-ssh/net-scp
 
 == DESCRIPTION:
 

data/Rakefile

@@ -1,30 +1,82 @@
-$LOAD_PATH.unshift "../net-ssh/lib"
-require './lib/net/scp/version'
+require 'rubygems'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'fileutils'
+include FileUtils
 
 begin
-  require 'echoe'
+  require 'hanna/rdoctask'
 rescue LoadError
-  abort "You'll need to have `echoe' installed to use Net::SCP's Rakefile"
+  require 'rake/rdoctask'
 end
 
-version = Net::SCP::Version::STRING.dup
-if ENV['SNAPSHOT'].to_i == 1
-  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+task :default => :package
+ 
+# CONFIG =============================================================
+
+# Change the following according to your needs
+README = "README.rdoc"
+CHANGES = "CHANGELOG.rdoc"
+
+# Files and directories to be deleted when you run "rake clean"
+CLEAN.include [ 'pkg', '*.gem', '.config', 'doc']
+
+name = 'net-scp'
+
+load "#{name}.gemspec"
+version = @spec.version
+
+# That's it! The following defaults should allow you to get started
+# on other things. 
+
+
+# TESTS/SPECS =========================================================
+
+
+
+# INSTALL =============================================================
+
+Rake::GemPackageTask.new(@spec) do |p|
+  p.need_tar = true if RUBY_PLATFORM !~ /mswin/
+end
+
+task :release => [ :rdoc, :package ]
+task :install => [ :rdoc, :package ] do
+	sh %{sudo gem install pkg/#{name}-#{version}.gem}
+end
+task :uninstall => [ :clean ] do
+	sh %{sudo gem uninstall #{name}}
+end
+
+
+# RUBYFORGE RELEASE / PUBLISH TASKS ==================================
+
+if @spec.rubyforge_project
+  desc 'Publish website to rubyforge'
+  task 'publish:rdoc' => 'doc/index.html' do
+    sh "scp -rp doc/* rubyforge.org:/var/www/gforge-projects/#{name}/ssh/v2/api/"
+  end
+
+  desc 'Public release to rubyforge'
+  task 'publish:gem' => [:package] do |t|
+    sh <<-end
+      rubyforge add_release -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.gem &&
+      rubyforge add_file -o Any -a #{CHANGES} -f -n #{README} #{name} #{name} #{@spec.version} pkg/#{name}-#{@spec.version}.tgz 
+    end
+  end
 end
 
-Echoe.new('net-scp', version) do |p|
-  p.project          = "net-ssh"
-  p.changelog        = "CHANGELOG.rdoc"
 
-  p.author           = "Jamis Buck"
-  p.email            = "jamis@jamisbuck.org"
-  p.summary          = "A pure Ruby implementation of the SCP client protocol"
-  p.url              = "http://net-ssh.rubyforge.org/scp"
 
-  p.dependencies     = ["net-ssh >=1.99.1"]
+# RUBY DOCS TASK ==================================
 
-  p.need_zip         = true
-  p.include_rakefile = true
+Rake::RDocTask.new do |t|
+	t.rdoc_dir = 'doc'
+	t.title    = @spec.summary
+	t.options << '--line-numbers' << '-A cattr_accessor=object'
+	t.options << '--charset' << 'utf-8'
+	t.rdoc_files.include(README)
+	t.rdoc_files.include(CHANGES)
+	t.rdoc_files.include('lib/**/*.rb')
+end
 
-  p.rdoc_pattern     = /^(lib|README.rdoc|CHANGELOG.rdoc)/
-end

data/lib/net/scp.rb

@@ -1,4 +1,5 @@
 require 'stringio'
+require 'shellwords'
 
 require 'net/ssh'
 require 'net/scp/errors'
@@ -337,7 +338,7 @@ module Net
       # (See Net::SCP::Upload and Net::SCP::Download).
       def start_command(mode, local, remote, options={}, &callback)
         session.open_channel do |channel|
-          command = "#{scp_command(mode, options)} #{sanitize_file_name(remote)}"
+          command = "#{scp_command(mode, options)} #{remote.shellescape}"
           channel.exec(command) do |ch, success|
             if success
               channel[:local   ] = local
@@ -398,10 +399,6 @@ module Net
       def progress_callback(channel, name, sent, total)
         channel[:callback].call(channel, name, sent, total) if channel[:callback]
       end
-
-      def sanitize_file_name(file_name)
-        file_name.gsub(/[ ]/) { |m| "\\#{m}" }
-      end
   end
 end
 

data/lib/net/scp/version.rb

@@ -6,7 +6,7 @@ module Net; class SCP
   class Version < Net::SSH::Version
     MAJOR = 1
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
 
     # The current version, as a Version instance
     CURRENT = new(MAJOR, MINOR, TINY)

data/net-scp.gemspec

@@ -1,12 +1,12 @@
 # -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |s|
+@spec = Gem::Specification.new do |s|
   s.name = %q{net-scp}
-  s.version = "1.0.2"
+  s.version = "1.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Jamis Buck"]
-  s.date = %q{2009-11-23}
+  s.authors = ["Jamis Buck", "Delano Mandelbaum"]
+  s.date = %q{2010-08-17}
   s.description = %q{A pure Ruby implementation of the SCP client protocol}
   s.email = %q{jamis@jamisbuck.org}
   s.extra_rdoc_files = ["CHANGELOG.rdoc", "lib/net/scp/download.rb", "lib/net/scp/errors.rb", "lib/net/scp/upload.rb", "lib/net/scp/version.rb", "lib/net/scp.rb", "lib/uri/open-scp.rb", "lib/uri/scp.rb", "README.rdoc"]

data/test/common.rb

@@ -54,6 +54,21 @@ class Net::SCP::TestCase < Test::Unit::TestCase
       directory.stub!
     end
 
+    # The POSIX spec unfortunately allows all characters in file names except
+    # ASCII 0x00(NUL) and 0x2F(/)
+    #
+    # Ideally, we should be testing filenames with newlines, but Mocha doesn't
+    # like this at all, so we leave them out. However, the Shellwords module
+    # handles newlines just fine, so we can be reasonably confident that they
+    # will work in practice
+    def awful_file_name
+      (((0x00..0x7f).to_a - [0x00, 0x0a, 0x2f]).map { |n| n.chr }).join + '.txt'
+    end
+
+    def escaped_file_name
+      "\\\001\\\002\\\003\\\004\\\005\\\006\\\a\\\b\\\t\\\v\\\f\\\r\\\016\\\017\\\020\\\021\\\022\\\023\\\024\\\025\\\026\\\027\\\030\\\031\\\032\\\e\\\034\\\035\\\036\\\037\\ \\!\\\"\\#\\$\\%\\&\\'\\(\\)\\*\\+,-.0123456789:\\;\\<\\=\\>\\?@ABCDEFGHIJKLMNOPQRSTUVWXYZ\\[\\\\\\]\\^_\\`abcdefghijklmnopqrstuvwxyz\\{\\|\\}\\~\\\177.txt"
+    end
+
     class FileEntry
       attr_reader :path, :contents, :mode, :mtime, :atime, :io
 

data/test/test_download.rb

@@ -11,7 +11,7 @@ class TestDownload < Net::SCP::TestCase
     assert_scripted { scp.download!("/path/to/remote.txt", "/path/to/local.txt") }
     assert_equal "a" * 1234, file.io.string
   end
-
+  
   def test_download_file_with_spaces_in_name_should_escape_remote_file_name
     file = prepare_file("/path/to/local file.txt", "")
 
@@ -25,6 +25,20 @@ class TestDownload < Net::SCP::TestCase
 
     assert_scripted { scp.download!("/path/to/remote file.txt", "/path/to/local file.txt") }
   end
+  
+  def test_download_file_with_metacharacters_in_name_should_escape_remote_file_name
+    file = prepare_file("/path/to/local/#{awful_file_name}", "")
+
+    expect_scp_session "-f /path/to/remote/#{escaped_file_name}" do |channel|
+      channel.sends_ok
+      channel.gets_data "C0666 0 #{awful_file_name}\n"
+      channel.sends_ok
+      channel.gets_ok
+      channel.sends_ok
+    end
+
+    assert_scripted { scp.download!("/path/to/remote/#{awful_file_name}", "/path/to/local/#{awful_file_name}") }
+  end
 
   def test_download_with_preserve_should_send_times
     file = prepare_file("/path/to/local.txt", "a" * 1234, 0644, Time.at(1234567890, 123456), Time.at(12121212, 232323))

data/test/test_upload.rb

@@ -15,7 +15,7 @@ class TestUpload < Net::SCP::TestCase
 
     assert_scripted { scp.upload!("/path/to/local.txt", "/path/to/remote.txt") }
   end
-
+  
   def test_upload_file_with_spaces_in_name_should_escape_remote_file_name
     prepare_file("/path/to/local file.txt", "")
 
@@ -29,6 +29,20 @@ class TestUpload < Net::SCP::TestCase
 
     assert_scripted { scp.upload!("/path/to/local file.txt", "/path/to/remote file.txt") }
   end
+  
+  def test_upload_file_with_metacharacters_in_name_should_escape_remote_file_name
+    prepare_file("/path/to/local/#{awful_file_name}", "")
+
+    expect_scp_session "-t /path/to/remote/#{escaped_file_name}" do |channel|
+      channel.gets_ok
+      channel.sends_data "C0666 0 #{awful_file_name}\n"
+      channel.gets_ok
+      channel.sends_ok
+      channel.gets_ok
+    end
+
+    assert_scripted { scp.upload!("/path/to/local/#{awful_file_name}", "/path/to/remote/#{awful_file_name}") }
+  end
 
   def test_upload_file_with_preserve_should_send_times
     prepare_file("/path/to/local.txt", "a" * 1234, 0666, Time.at(1234567890, 123456), Time.at(1234543210, 345678))

metadata

@@ -1,27 +1,40 @@
 --- !ruby/object:Gem::Specification 
 name: net-scp
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  hash: 17
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - Jamis Buck
+- Delano Mandelbaum
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-11-23 00:00:00 -05:00
+date: 2010-08-17 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 409
+        segments: 
+        - 1
+        - 99
+        - 1
         version: 1.99.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: A pure Ruby implementation of the SCP client protocol
 email: jamis@jamisbuck.org
 executables: []
@@ -72,21 +85,28 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
       version: "1.2"
-  version: 
 requirements: []
 
 rubyforge_project: net-ssh
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A pure Ruby implementation of the SCP client protocol