bfs-scp 0.4.4 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caf82a4458c6bd32289190f40d664108d365f70c0ec2ca78d92faf030a647ac6
-  data.tar.gz: 8e47309534a09fdcfd2f67b5f021b32be0ef955a64376e274568118ef63fb2cb
+  metadata.gz: 2d2a1d8aa79faab191a46b8719628bc1b92fa2528be1e9b95d1e0c88e34e5131
+  data.tar.gz: 3b8ed648fc045c535b360c9541028655a18748c4421cdec5f6ac23b3ca04681a
 SHA512:
-  metadata.gz: 4a2600a804bdd5d768e26f622b4c98bba543c1d780649f4bf32ae7ecdc180058c46d9db3ccb837b4647bf1400b5d2da440070f5ed11ea1d75c2998177c69f7ee
-  data.tar.gz: f3f078f7e9bacf1a29bc0c17d95288aa23134d3d44dff1a5591bf3f360d445e78adede1306c9c28c4d12182586330393776d4fbcdbaf7cca682063140c2ad8c4
+  metadata.gz: 375ed1a9efc068961df091335dd6950e934d3f9363d7c79b6e8428c4d04febe368569189caf8b941ca74b3b1c964229cc7df6ed1399e6cdb783e16a2e71c1814
+  data.tar.gz: faaccfff6e02b43e0e41374596dd89f169c827916ca1902d3504de4cdbafb6fcc53594055170a68a7b76715783d82217e55200bdb233c379392446d4853888aa

data/bfs-scp.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- spec/*`.split("\n")
   s.require_paths = ['lib']
-  s.required_ruby_version = '>= 2.4.0'
+  s.required_ruby_version = '>= 2.5.0'
 
   s.add_dependency 'bfs', s.version
   s.add_dependency 'net-scp'

data/lib/bfs/bucket/scp.rb

@@ -10,7 +10,7 @@ module BFS
       class CommandError < RuntimeError
         attr_reader :status
 
-        def initialize(cmd, status, extra=nil)
+        def initialize(cmd, status, extra = nil)
           @status = status
           super ["Command '#{cmd}' exited with status #{status}", extra].join(': ')
         end
@@ -28,30 +28,25 @@ module BFS
       # @option opts [Integer] :keepalive_interval interval if keepalive enabled. Default: 300.
       # @option opts [Array<String>] :keys an array of file names of private keys to use for publickey and hostbased authentication.
       # @option opts [Boolean|Symbol] :verify_host_key specifying how strict host-key verification should be, either false, true, :very, or :secure.
-      def initialize(host, opts={})
-        opts = opts.dup
-        opts.keys.each do |key|
-          val = opts.delete(key)
-          opts[key.to_sym] = val unless val.nil?
-        end
-        super(opts)
+      def initialize(host, prefix: nil, **opts)
+        super(**opts)
 
-        @prefix = opts.delete(:prefix)
-        @client = Net::SCP.start(host, nil, opts)
+        @prefix = prefix
+        @client = Net::SCP.start(host, nil, **opts)
 
         if @prefix # rubocop:disable Style/GuardClause
           @prefix = norm_path(@prefix) + '/'
-          mkdir_p(@prefix)
+          mkdir_p abs_path(@prefix)
         end
       end
 
       # Lists the contents of a bucket using a glob pattern
-      def ls(pattern='**/*', _opts={})
-        prefix = @prefix || '.'
+      def ls(pattern = '**/*', **_opts)
+        prefix = @prefix ? abs_path(@prefix) : '/'
         Enumerator.new do |y|
           sh! 'find', prefix, '-type', 'f' do |out|
             out.each_line do |line|
-              path = trim_prefix(line.strip)
+              path = trim_prefix(norm_path(line.strip))
               y << path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
             end
           end
@@ -59,24 +54,28 @@ module BFS
       end
 
       # Info returns the object info
-      def info(path, _opts={})
+      def info(path, **_opts)
         full = full_path(path)
         path = norm_path(path)
-        out  = sh! 'stat', '-c', '%s;%Z', full
+        out  = sh! 'stat', '-c', '%s;%Z;%a', full
 
-        size, epoch = out.strip.split(';', 2).map(&:to_i)
-        BFS::FileInfo.new(path, size, Time.at(epoch))
+        size, epoch, mode = out.strip.split(';', 3)
+        BFS::FileInfo.new(path: path, size: size.to_i, mtime: Time.at(epoch.to_i), mode: BFS.norm_mode(mode))
       rescue CommandError => e
         e.status == 1 ? raise(BFS::FileNotFound, path) : raise
       end
 
       # Creates a new file and opens it for writing
-      def create(path, opts={}, &block)
+      # @option opts [String|Encoding] :encoding Custom file encoding.
+      # @option opts [Integer] :perm Custom file permission, default: 0600.
+      def create(path, encoding: nil, perm: nil, **opts, &block)
         full = full_path(path)
-        enc  = opts.delete(:encoding) || @encoding
-        temp = BFS::TempWriter.new(path, encoding: enc) do |temp_path|
+
+        opts[:preserve] = true if perm && !opts.key?(:preserve)
+        enc = encoding || @encoding
+        temp = BFS::TempWriter.new(path, encoding: enc, perm: perm) do |temp_path|
           mkdir_p File.dirname(full)
-          @client.upload!(temp_path, full)
+          @client.upload!(temp_path, full, **opts)
         end
         return temp unless block
 
@@ -88,10 +87,10 @@ module BFS
       end
 
       # Opens an existing file for reading
-      def open(path, opts={}, &block)
+      def open(path, encoding: nil, tempdir: nil, **_opts, &block)
         full = full_path(path)
-        enc  = opts.delete(:encoding) || @encoding
-        temp = Tempfile.new(File.basename(path), encoding: enc)
+        enc  = encoding || @encoding
+        temp = Tempfile.new(File.basename(path), tempdir, encoding: enc)
         temp.close
 
         @client.download!(full, temp.path)
@@ -101,7 +100,7 @@ module BFS
       end
 
       # Deletes a file.
-      def rm(path, _opts={})
+      def rm(path, **_opts)
         path = full_path(path)
         sh! 'rm', '-f', path
       end
@@ -110,7 +109,7 @@ module BFS
       #
       # @param [String] src The source path.
       # @param [String] dst The destination path.
-      def cp(src, dst, _opts={})
+      def cp(src, dst, **_opts)
         full_src = full_path(src)
         full_dst = full_path(dst)
 
@@ -124,7 +123,7 @@ module BFS
       #
       # @param [String] src The source path.
       # @param [String] dst The destination path.
-      def mv(src, dst, _opts={})
+      def mv(src, dst, **_opts)
         full_src = full_path(src)
         full_dst = full_path(dst)
 
@@ -141,6 +140,15 @@ module BFS
 
       private
 
+      def abs_path(path)
+        path = "/#{path}" unless path.start_with?('~/', './')
+        path
+      end
+
+      def full_path(*)
+        abs_path(super)
+      end
+
       def mkdir_p(path)
         sh! 'mkdir', '-p', path
       end
@@ -186,5 +194,5 @@ BFS.register('scp', 'ssh') do |url|
   opts[:password] ||= CGI.unescape(url.password) if url.password
   opts[:port] ||= url.port if url.port
 
-  BFS::Bucket::SCP.new url.host, opts
+  BFS::Bucket::SCP.new(url.host, **opts)
 end

data/spec/bfs/bucket/scp_spec.rb

@@ -13,15 +13,43 @@ run_spec = \
   end
 
 RSpec.describe BFS::Bucket::SCP, if: run_spec do
-  subject { described_class.new sandbox[:host], sandbox[:opts].merge(prefix: SecureRandom.uuid) }
-  after   { subject.close }
+  context 'absolute' do
+    subject { described_class.new sandbox[:host], **sandbox[:opts].merge(prefix: SecureRandom.uuid) }
+    after   { subject.close }
 
-  it_behaves_like 'a bucket',
-    content_type: false,
-    metadata: false
+    it_behaves_like 'a bucket', content_type: false, metadata: false
+  end
+
+  context 'relative' do
+    subject { described_class.new sandbox[:host], **sandbox[:opts].merge(prefix: "~/#{SecureRandom.uuid}") }
+    after   { subject.close }
+
+    it_behaves_like 'a bucket', content_type: false, metadata: false
+  end
 
   it 'should resolve from URL' do
     bucket = BFS.resolve('scp://root:root@127.0.0.1:7022')
     expect(bucket).to be_instance_of(described_class)
   end
+
+  it 'should handle absolute and relative paths' do
+    abs = BFS::Blob.new("scp://root:root@127.0.0.1:7022/#{SecureRandom.uuid}/file.txt")
+    abs.create {|w| w.write 'absolute' }
+
+    rel = BFS::Blob.new("scp://root:root@127.0.0.1:7022/~/#{SecureRandom.uuid}/file.txt")
+    rel.create {|w| w.write 'relative' }
+
+    expect(abs.read).to eq('absolute')
+    expect(rel.read).to eq('relative')
+
+    abs.close
+    rel.close
+  end
+
+  it 'should support custom perms' do
+    blob = BFS::Blob.new("scp://root:root@127.0.0.1:7022/#{SecureRandom.uuid}/file.txt")
+    blob.create(perm: 0o666) {|w| w.write 'foo' }
+    expect(blob.info.mode).to eq(0o666)
+    blob.close
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bfs-scp
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.6.2
 platform: ruby
 authors:
 - Dimitrij Denissenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-27 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bfs
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: net-scp
   requirement: !ruby/object:Gem::Requirement
@@ -60,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: SCP/SSH adapter for bfs