bfs-sftp 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c4dfdb49d9d05b759223cabb87be952c6dfae65f966eabe4cf0662ad26dea2d
+  data.tar.gz: 950c37378a426f30b038b67cf4e9c48d252801714f2f161e7fa23556a96a8585
+SHA512:
+  metadata.gz: a481be112d9b2873a303675fb33e33dbb993678f889f0ca501fd5cab6cbc7f39c5cc41b1c4818187e5672e652beac6cc07276b19621175eb548f251be45577ac
+  data.tar.gz: 511f81ecb71ff42f0f6a987af1871bc56960e50b187c9e352fe824d3e624534d2a2c91c76d600d24675a114c190c5785955e3fdf91d986afa39beafd128a6985

data/bfs-sftp.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |s|
+  s.name        = 'bfs-sftp'
+  s.version     = File.read(File.expand_path('../.version', __dir__)).strip
+  s.platform    = Gem::Platform::RUBY
+
+  s.licenses    = ['Apache-2.0']
+  s.summary     = 'SFTP 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.6.0'
+
+  s.add_dependency 'bfs', s.version
+  s.add_dependency 'net-sftp'
+end

data/lib/bfs/bucket/sftp.rb

@@ -0,0 +1,143 @@
+require 'bfs'
+require 'net/sftp'
+
+module BFS
+  module Bucket
+    # SFTP buckets are operating on SFTP connections.
+    class SFTP < Abstract
+      StatusCodes = Net::SFTP::Constants::StatusCodes
+
+      # 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, prefix: nil, **opts)
+        super(**opts)
+
+        @prefix  = prefix
+        @session = Net::SSH.start(host, nil, **opts.slice(*Net::SSH::VALID_OPTIONS), non_interactive: true)
+
+        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)
+        Enumerator.new do |acc|
+          walk(pattern) {|path, _| acc << path }
+        end
+      end
+
+      # Iterates over the contents of a bucket using a glob pattern
+      def glob(pattern = '**/*', **_opts)
+        Enumerator.new do |acc|
+          walk(pattern) do |path, attrs|
+            acc << file_info(path, attrs)
+          end
+        end
+      end
+
+      # Info returns the object info
+      def info(path, **_opts)
+        full = full_path(path)
+        path = norm_path(path)
+        attrs = @session.sftp.stat!(full)
+        raise BFS::FileNotFound, path unless attrs.file?
+
+        file_info path, attrs
+      rescue Net::SFTP::StatusException => e
+        raise BFS::FileNotFound, path if e.code == StatusCodes::FX_NO_SUCH_FILE
+
+        raise
+      end
+
+      # Creates a new file and opens it for writing
+      # @option opts [String|Encoding] :encoding Custom file encoding.
+      # @option opts [Integer] :perm Custom file permission, default: 0600.
+      def create(path, encoding: self.encoding, perm: self.perm, **opts, &block)
+        full = full_path(path)
+
+        opts[:preserve] = true if perm && !opts.key?(:preserve)
+        BFS::Writer.new(path, encoding: encoding, perm: perm) do |temp_path|
+          mkdir_p File.dirname(full)
+          @session.sftp.upload!(temp_path, full, **opts)
+        end.perform(&block)
+      end
+
+      # Opens an existing file for reading
+      def open(path, encoding: self.encoding, tempdir: nil, **_opts, &block)
+        full = full_path(path)
+        temp = Tempfile.new(File.basename(path), tempdir, encoding: encoding)
+        temp.close
+
+        @session.sftp.download!(full, temp.path)
+        File.open(temp.path, encoding: encoding, &block)
+      rescue Net::SFTP::StatusException => e
+        raise BFS::FileNotFound, path if e.code == StatusCodes::FX_NO_SUCH_FILE
+
+        raise
+      end
+
+      # Deletes a file.
+      def rm(path, **_opts)
+        full = full_path(path)
+        @session.sftp.remove!(full)
+      rescue Net::SFTP::StatusException => e
+        raise unless e.code == StatusCodes::FX_NO_SUCH_FILE
+      end
+
+      # Closes the underlying connection
+      def close
+        @session.close unless @session.closed?
+      end
+
+      private
+
+      def file_info(path, attrs)
+        BFS::FileInfo.new(path: path, size: attrs.size.to_i, mtime: Time.at(attrs.mtime.to_i), mode: BFS.norm_mode(attrs.permissions))
+      end
+
+      def walk(pattern)
+        @session.sftp.dir.glob(@prefix || '/', pattern) do |ent|
+          next unless ent.file?
+
+          path = norm_path(ent.name)
+          yield(path, ent.attributes)
+        end
+      end
+
+      def mkdir_p(path)
+        parts = path.split('/').reject(&:empty?)
+        cmds  = (0...parts.size).map do |i|
+          @session.sftp.mkdir parts[0..i].join('/')
+        end
+        cmds.each do |req|
+          req.wait
+          next if req.response.code <= StatusCodes::FX_FAILURE
+
+          raise Net::SFTP::StatusException, req.response
+        end
+      end
+    end
+  end
+end
+
+BFS.register('sftp') do |url, opts, block|
+  prefix = BFS.norm_path(opts[:prefix] || url.path)
+  opts[:prefix] = prefix unless prefix.empty?
+  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::SFTP.open(url.host, **opts, &block)
+end

data/lib/bfs/sftp.rb

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

data/spec/bfs/bucket/sftp_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+RSpec.describe BFS::Bucket::SFTP, sftp: true do
+  subject do
+    described_class.new '127.0.0.1', port: 7023, user: 'sftp', password: 'DockerPassSFTP', prefix: SecureRandom.uuid
+  end
+
+  it_behaves_like 'a bucket', content_type: false, metadata: false
+
+  it 'resolves from URL' do
+    bucket = BFS.resolve('sftp://sftp:DockerPassSFTP@127.0.0.1:7023')
+    expect(bucket).to be_instance_of(described_class)
+    bucket.close
+
+    bucket = BFS.resolve('sftp://sftp:DockerPassSFTP@127.0.0.1:7023/a/b/')
+    expect(bucket).to be_instance_of(described_class)
+    bucket.close
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: bfs-sftp
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bfs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: net-sftp
+  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-sftp.gemspec
+- lib/bfs/bucket/sftp.rb
+- lib/bfs/sftp.rb
+- spec/bfs/bucket/sftp_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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: SFTP adapter for bfs
+test_files:
+- spec/bfs/bucket/sftp_spec.rb