bfs-ftp 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 996793546b6def5f901a9d609a1a87fb4c229ce11808519119b0b3e485d459eb
+  data.tar.gz: 973ca56c2d859de7ca93fb6774055667b66f929cbcc857849e24b1f6f0cb0723
+SHA512:
+  metadata.gz: cd8dd65cf5f0b0230a0f30e2f51fc4f2d438768df108a7d9d0c07f0a129fe6fb2aded68c2ef8310cd37d8767ec36c9270f97618932044e4bd237174262d82135
+  data.tar.gz: 36ab986b28ca63d6c39f3d0bb32805509a0b66f332e153c168b5e8c0f682d0475f00e97c2a56b7cf3dd517323bdc232c045d7e31d7105b9cf84d452a68dead9a

data/bfs-ftp.gemspec

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

data/lib/bfs/bucket/ftp.rb

@@ -0,0 +1,136 @@
+require 'bfs'
+require 'net/ftp/list'
+require 'cgi'
+
+module BFS
+  module Bucket
+    # FTP buckets are operating on ftp servers
+    class FTP < Abstract
+
+      # Initializes a new bucket
+      # @param [String] host the host name
+      # @param [Hash] opts options
+      # @option opts [Integer] :port custom port. Default: 21.
+      # @option opts [Boolean] :ssl will attempt to use SSL.
+      # @option opts [String] :username user name for login.
+      # @option opts [String] :password password for login.
+      # @option opts [String] :passive connect in passive mode. Default: true.
+      # @option opts [String] :prefix optional prefix.
+      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::FTP.new(host, opts)
+        @client.binary = true
+
+        if prefix # rubocop:disable Style/GuardClause
+          prefix = norm_path(prefix)
+          mkdir_p(prefix)
+          @client.chdir(prefix)
+        end
+      end
+
+      # Lists the contents of a bucket using a glob pattern
+      def ls(pattern='**/*', _opts={})
+        dir = pattern[%r{^[^\*\?\{\}\[\]]+/}]
+        dir&.chomp!('/')
+
+        Enumerator.new do |y|
+          glob(dir) do |path|
+            y << path if File.fnmatch?(pattern, path, File::FNM_PATHNAME)
+          end
+        end
+      end
+
+      # Info returns the object info
+      def info(path, _opts={})
+        path = norm_path(path)
+        BFS::FileInfo.new(path, @client.size(path), @client.mtime(path))
+      rescue Net::FTPPermError
+        raise BFS::FileNotFound, path
+      end
+
+      # Creates a new file and opens it for writing
+      def create(path, opts={}, &block)
+        path = norm_path(path)
+        enc  = opts.delete(:encoding) || @encoding
+        temp = BFS::TempWriter.new(path, encoding: enc) do |t|
+          mkdir_p File.dirname(path)
+          @client.put(t, path)
+        end
+        return temp unless block
+
+        begin
+          yield temp
+        ensure
+          temp.close
+        end
+      end
+
+      # Opens an existing file for reading
+      def open(path, opts={}, &block)
+        path = norm_path(path)
+        enc  = opts.delete(:encoding) || @encoding
+        temp = Tempfile.new(File.basename(path), encoding: enc)
+        temp.close
+
+        @client.get(path, temp.path)
+        File.open(temp.path, encoding: enc, &block)
+      rescue Net::FTPPermError
+        raise BFS::FileNotFound, path
+      end
+
+      # Deletes a file.
+      def rm(path, _opts={})
+        path = norm_path(path)
+        @client.delete(path)
+      rescue Net::FTPPermError # rubocop:disable Lint/HandleExceptions
+      end
+
+      # Closes the underlying connection
+      def close
+        @client.close
+      end
+
+      private
+
+      def glob(dir, &block)
+        @client.ls(dir || '.') do |e|
+          entry = Net::FTP::List.parse(e)
+          if entry.dir?
+            subdir = [dir, entry.basename].compact.join('/')
+            glob subdir, &block
+          elsif entry.file?
+            yield [dir, entry.basename].compact.join('/')
+          end
+        end
+      end
+
+      def mkdir_p(path)
+        parts = path.split('/').reject(&:empty?)
+        (0...parts.size).each do |i|
+          begin
+            @client.mkdir parts[0..i].join('/')
+          rescue Net::FTPPermError # rubocop:disable Lint/HandleExceptions
+          end
+        end
+      end
+    end
+  end
+end
+
+BFS.register('ftp', 'sftp') do |url|
+  params = CGI.parse(url.query.to_s)
+
+  BFS::Bucket::FTP.new url.host,
+    username: url.user ? CGI.unescape(url.user) : nil,
+    password: url.password ? CGI.unescape(url.password) : nil,
+    port: url.port,
+    ssl: params.key?('ssl') || url.scheme == 'sftp',
+    prefix: params.key?('prefix') ? params['prefix'].first : nil
+end

data/lib/bfs/ftp.rb

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

data/spec/bfs/bucket/ftp_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+sandbox  = { host: '127.0.0.1', port: 7021, username: 'ftpuser', password: 'ftppass' }.freeze
+run_spec = \
+  begin
+    ftp = Net::FTP.new sandbox[:host], sandbox
+    ftp.list
+    ftp.close
+  rescue Errno::ECONNREFUSED, Net::FTPError => e
+    warn "WARNING: unable to run #{File.basename __FILE__}: #{e.message}"
+    false
+  end
+
+RSpec.describe BFS::Bucket::FTP, if: run_spec do
+  subject { described_class.new sandbox[:host], sandbox.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('ftp://ftpuser:ftppass@127.0.0.1:7021')
+    expect(bucket).to be_instance_of(described_class)
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: bfs-ftp
+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-ftp-list
+  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-ftp.gemspec
+- lib/bfs/bucket/ftp.rb
+- lib/bfs/ftp.rb
+- spec/bfs/bucket/ftp_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: FTP adapter for bfs
+test_files:
+- spec/bfs/bucket/ftp_spec.rb