sshkit 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b21b9fc05481526fd6470265cb3afb51fcc0691a
-  data.tar.gz: 4a093de329e546b6410c01c03ab8fe8379c8c53f
+  metadata.gz: 45f49f25df22edea1abf8c5db3edda63255ddbb2
+  data.tar.gz: 71642fd8de408f19d9e40fad80ce7315ca553235
 SHA512:
-  metadata.gz: 7f7ba415cd0b373c356ab99e1ca0624bcca5265c328e2b060def73684541eaf041b539162779a7463691428162e5758bcc025bbe8c6966f3deca4cb95aaa9f8e
-  data.tar.gz: f2907bc157c0cacfa2309725aa637deff3bf43079b5dbe255c7d00049997f46cdb574823d8ee8bd848c6e12b24a0c5bb02d8ed66e8196bb87d5fff2b14c41380
+  metadata.gz: 2483400c0e519f6ea60432371a04d77c523a965db7cf117c611056aa052f87125ccb605ec1ae241bec4f24ec1e75f03ef2927dce8d0a64757147a4fe0ce8e4f0
+  data.tar.gz: 360df78c26c2e413e54d02f0152279f968f25ad3373e3f0fd36086d6bc867f1aa473937e84e7be0602047307042c45426d35833e8c0c5be803da243d95ced76b

data/CHANGELOG.md

@@ -7,6 +7,20 @@ appear at the top.
 
   * Your contribution here!
 
+## [1.15.0][] (2017-11-03)
+
+### New features
+
+  * [#408](https://github.com/capistrano/sshkit/pull/408): upload! and download! now respect `within` - [@sj26](https://github.com/sj26)
+
+### Potentially breaking changes
+
+  * `upload!` and `download!` now support remote paths which are
+    relative to the `within` working directory. They were previously documented
+    as only supporting absolute paths, but relative paths still worked relative
+    to the remote working directory. If you rely on the previous behaviour you
+    may need to adjust your code.
+
 ## [1.14.0][] (2017-06-30)
 
 ### Breaking changes
@@ -707,7 +721,8 @@ version `0.0.5`.
 
 First release.
 
-[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.14.0...HEAD
+[Unreleased]: https://github.com/capistrano/sshkit/compare/v1.15.0...HEAD
+[1.15.0]: https://github.com/capistrano/sshkit/compare/v1.14.0...v1.15.0
 [1.14.0]: https://github.com/capistrano/sshkit/compare/v1.13.1...v1.14.0
 [1.13.1]: https://github.com/capistrano/sshkit/compare/v1.13.0...v1.13.1
 [1.13.0]: https://github.com/capistrano/sshkit/compare/v1.12.0...v1.13.0

data/EXAMPLES.md

@@ -90,6 +90,7 @@ end
 ```
 
 ## Download a file from disk
+
 ```ruby
 on roles(:all) do
   puts 'Downloading DB Backup File'
@@ -106,8 +107,18 @@ on hosts do |host|
 end
 ```
 
-**Note:** The `upload!()` method doesn't honor the values of `within()`, `as()`
-etc, this will be improved as the library matures, but we're not there yet.
+Upload and download will respect the `within()` directories:
+
+```ruby
+on hosts do |host|
+  within 'my/app/directory' do
+    upload! 'database.yml', 'config/database.yml'
+  end
+end
+```
+
+**Note:** The `upload!()` method doesn't honor the values of `as()` etc, this
+will be improved as the library matures, but we're not there yet.
 
 ## Upload a file from a stream
 

data/Gemfile

@@ -13,3 +13,8 @@ end
 if Gem::Requirement.new('>= 2.1.0').satisfied_by?(Gem::Version.new(RUBY_VERSION))
   gem 'chandler', '>= 0.1.1'
 end
+
+# public_suffix 3+ requires ruby 2.1+
+if Gem::Requirement.new('< 2.1').satisfied_by?(Gem::Version.new(RUBY_VERSION))
+  gem 'public_suffix', '< 3'
+end

data/lib/sshkit/backends/local.rb

@@ -11,6 +11,7 @@ module SSHKit
       end
 
       def upload!(local, remote, options = {})
+        remote = File.join(pwd_path, remote) unless remote.start_with?("/")
         if local.is_a?(String)
           if options[:recursive]
             FileUtils.cp_r(local, remote)
@@ -25,6 +26,7 @@ module SSHKit
       end
 
       def download!(remote, local=nil, _options = {})
+        remote = File.join(pwd_path, remote) unless remote.start_with?("/")
         if local.nil?
           FileUtils.cp(remote, File.basename(remote))
         else

data/lib/sshkit/backends/netssh.rb

@@ -63,6 +63,7 @@ module SSHKit
 
       def upload!(local, remote, options = {})
         summarizer = transfer_summarizer('Uploading', options)
+        remote = File.join(pwd_path, remote) unless remote.start_with?("/")
         with_ssh do |ssh|
           ssh.scp.upload!(local, remote, options, &summarizer)
         end
@@ -70,6 +71,7 @@ module SSHKit
 
       def download!(remote, local=nil, options = {})
         summarizer = transfer_summarizer('Downloading', options)
+        remote = File.join(pwd_path, remote) unless remote.start_with?("/")
         with_ssh do |ssh|
           ssh.scp.download!(remote, local, options, &summarizer)
         end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "1.14.0".freeze
+  VERSION = "1.15.0".freeze
 end

data/test/functional/backends/test_local.rb

@@ -20,6 +20,23 @@ module SSHKit
         end
       end
 
+      def test_upload_within
+        file_contents = "Some Content"
+        actual_file_contents = nil
+        Dir.mktmpdir do |dir|
+          Local.new do
+            within dir do
+              execute(:mkdir, "-p", "foo")
+              within "foo" do
+                upload!(StringIO.new(file_contents), "bar")
+              end
+            end
+            actual_file_contents = capture(:cat, File.join(dir, "foo", "bar"))
+          end.run
+          assert_equal file_contents, actual_file_contents
+        end
+      end
+
       def test_upload_recursive
         Dir.mktmpdir do |dir|
           Dir.mkdir("#{dir}/local")

data/test/functional/backends/test_netssh.rb

@@ -103,6 +103,23 @@ module SSHKit
         assert_equal "Some Content\nWith a newline and trailing spaces    \n ", actual_file_contents
       end
 
+      def test_upload_within
+        file_name = SecureRandom.uuid
+        file_contents = "Some Content"
+        dir_name = SecureRandom.uuid
+        actual_file_contents = ""
+        Netssh.new(a_host) do |_host|
+          within("/tmp") do
+            execute :mkdir, "-p", dir_name
+            within(dir_name) do
+              upload!(StringIO.new(file_contents), file_name)
+            end
+          end
+          actual_file_contents = capture(:cat, "/tmp/#{dir_name}/#{file_name}", strip: false)
+        end.run
+        assert_equal file_contents, actual_file_contents
+      end
+
       def test_upload_string_io
         file_contents = ""
         Netssh.new(a_host) do |_host|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Lee Hambley
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-30 00:00:00.000000000 Z
+date: 2017-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -293,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: SSHKit makes it easy to write structured, testable SSH commands in Ruby