bfs-scp 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31c7f82a6aae8c2bd13d174bb267ba3a27d2635e03813fa99f2aa531be59f9be
+  data.tar.gz: 3b89574dc5e9b02693de9a6bae66fefea69605b5d75e83a17de062dd532a35a6
+SHA512:
+  metadata.gz: 84c82c16c24daa41792c9a2509092f06a79bd080ae4b83dad44ab97b41730cc03b1af9921f25d6c5dcf9f137ec2260b47d814afbd52699a259eb6b0f07280498
+  data.tar.gz: 58d1ef53e369746d33b4c783c1bcaa67a72963e6b289f7f2b080362525197503eea5c4599e2b5d469b76fb3fe8b614585743806d48a8e9b62459591912a28b29

data/bfs-scp.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'bfs-scp'
+  s.version     = File.read(File.expand_path('../.version', __dir__)).strip
+  s.platform    = Gem::Platform::RUBY
+
+  s.licenses    = ['Apache-2.0']
+  s.summary     = 'SCP/SSH adapter for bfs'
+  s.description = 'https://github.com/bsm/bfs.rb'
+
+  s.authors     = ['Dimitrij Denissenko']
+  s.email       = 'dimitrij@blacksquaremedia.com'
+  s.homepage    = 'https://github.com/bsm/bfs.rb'
+
+  s.executables   = []
+  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.add_dependency 'bfs', s.version
+  s.add_dependency 'net-scp'
+end

data/lib/bfs/bucket/scp.rb

@@ -0,0 +1,190 @@
+require 'bfs'
+require 'net/scp'
+require 'cgi'
+require 'shellwords'
+
+module BFS
+  module Bucket
+    # SCP buckets are operating on SCP/SSH connections.
+    class SCP < Abstract
+      class CommandError < RuntimeError
+        attr_reader :status
+
+        def initialize(cmd, status, extra=nil)
+          @status = status
+          super ["Command '#{cmd}' exited with status #{status}", extra].join(': ')
+        end
+      end
+
+      # Initializes a new bucket
+      # @param [String] host the host name
+      # @param [Hash] opts options
+      # @option opts [Integer] :port custom port. Default: 22.
+      # @option opts [String] :user user name for login.
+      # @option opts [String] :password password for login.
+      # @option opts [String] :prefix optional prefix.
+      # @option opts [Boolean] :compression use compression.
+      # @option opts [Boolean] :keepalive use keepalive.
+      # @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)
+
+        @prefix = opts.delete(:prefix)
+        @client = Net::SCP.start(host, nil, opts)
+
+        if @prefix # rubocop:disable Style/GuardClause
+          @prefix = norm_path(@prefix) + '/'
+          mkdir_p(@prefix)
+        end
+      end
+
+      # Lists the contents of a bucket using a glob pattern
+      def ls(pattern='**/*', _opts={})
+        prefix = @prefix || '.'
+        Enumerator.new do |y|
+          sh! 'find', prefix, '-type', 'f' do |out|
+            out.each_line do |line|
+              path = trim_prefix(line.strip)
+              y << path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+            end
+          end
+        end
+      end
+
+      # Info returns the object info
+      def info(path, _opts={})
+        full = full_path(path)
+        path = norm_path(path)
+        out  = sh! 'stat', '-c', '%s;%Z', full
+
+        size, epoch = out.strip.split(';', 2).map(&:to_i)
+        BFS::FileInfo.new(path, size, Time.at(epoch))
+      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)
+        full = full_path(path)
+        enc  = opts.delete(:encoding) || @encoding
+        temp = BFS::TempWriter.new(path, encoding: enc) do |temp_path|
+          mkdir_p File.dirname(full)
+          @client.upload!(temp_path, full)
+        end
+        return temp unless block
+
+        begin
+          yield temp
+        ensure
+          temp.close
+        end
+      end
+
+      # Opens an existing file for reading
+      def open(path, opts={}, &block)
+        full = full_path(path)
+        enc  = opts.delete(:encoding) || @encoding
+        temp = Tempfile.new(File.basename(path), encoding: enc)
+        temp.close
+
+        @client.download!(full, temp.path)
+        File.open(temp.path, encoding: enc, &block)
+      rescue Net::SCP::Error
+        raise BFS::FileNotFound, path
+      end
+
+      # Deletes a file.
+      def rm(path, _opts={})
+        path = full_path(path)
+        sh! 'rm', '-f', path
+      end
+
+      # Copies src to dst
+      #
+      # @param [String] src The source path.
+      # @param [String] dst The destination path.
+      def cp(src, dst, _opts={})
+        full_src = full_path(src)
+        full_dst = full_path(dst)
+
+        mkdir_p File.dirname(full_dst)
+        sh! 'cp', '-a', '-f', full_src, full_dst
+      rescue CommandError => e
+        e.status == 1 ? raise(BFS::FileNotFound, src) : raise
+      end
+
+      # Moves src to dst
+      #
+      # @param [String] src The source path.
+      # @param [String] dst The destination path.
+      def mv(src, dst, _opts={})
+        full_src = full_path(src)
+        full_dst = full_path(dst)
+
+        mkdir_p File.dirname(full_dst)
+        sh! 'mv', '-f', full_src, full_dst
+      rescue CommandError => e
+        e.status == 1 ? raise(BFS::FileNotFound, src) : raise
+      end
+
+      # Closes the underlying connection
+      def close
+        @client.session.close unless @client.session.closed?
+      end
+
+      private
+
+      def mkdir_p(path)
+        sh! 'mkdir', '-p', path
+      end
+
+      def sh!(*cmd) # rubocop:disable Metrics/MethodLength
+        stdout = ''
+        stderr = nil
+        status = 0
+        cmdstr = cmd.map {|x| Shellwords.escape(x) }.join(' ')
+
+        @client.session.open_channel do |ch|
+          ch.exec(cmdstr) do |_, _success|
+            ch.on_data do |_, data|
+              if block_given?
+                yield data
+              else
+                stdout += data
+              end
+            end
+            ch.on_extended_data do |_, _, data|
+              stderr = data
+            end
+            ch.on_request('exit-status') do |_, buf|
+              status = buf.read_long
+            end
+          end
+        end
+        @client.session.loop
+        raise CommandError.new(cmdstr, status, stderr) unless status.zero?
+
+        stdout
+      end
+    end
+  end
+end
+
+BFS.register('scp', 'ssh') do |url|
+  opts = {}
+  CGI.parse(url.query.to_s).each do |key, values|
+    opts[key.to_sym] = values.first
+  end
+  opts[:user] ||= CGI.unescape(url.user) if url.user
+  opts[:password] ||= CGI.unescape(url.password) if url.password
+  opts[:port] ||= url.port if url.port
+
+  BFS::Bucket::SCP.new url.host, opts
+end

data/lib/bfs/scp.rb

@@ -0,0 +1 @@
+require 'bfs/bucket/scp'

data/spec/bfs/bucket/scp_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+sandbox  = { host: '127.0.0.1', opts: { port: 7022, user: 'root', password: 'root' } }.freeze
+run_spec = \
+  begin
+    Net::SCP.start sandbox[:host], nil, sandbox[:opts].merge(timeout: 1) do |scp|
+      scp.session.exec!('hostname')
+    end
+    true
+  rescue Net::SSH::Exception => e
+    warn "WARNING: unable to run #{File.basename __FILE__}: #{e.message}"
+    false
+  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 }
+
+  it_behaves_like 'a bucket',
+    content_type: false,
+    metadata: false
+
+  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
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: bfs-scp
+version: !ruby/object:Gem::Version
+  version: 0.4.1
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bfs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: https://github.com/bsm/bfs.rb
+email: dimitrij@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- bfs-scp.gemspec
+- lib/bfs/bucket/scp.rb
+- lib/bfs/scp.rb
+- spec/bfs/bucket/scp_spec.rb
+homepage: https://github.com/bsm/bfs.rb
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: SCP/SSH adapter for bfs
+test_files:
+- spec/bfs/bucket/scp_spec.rb