parallel_sftp 0.3.0

data/lib/parallel_sftp.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require "parallel_sftp/version"
+require "parallel_sftp/errors"
+require "parallel_sftp/configuration"
+require "parallel_sftp/lftp_command"
+require "parallel_sftp/progress_parser"
+require "parallel_sftp/segment_progress_parser"
+require "parallel_sftp/time_estimator"
+require "parallel_sftp/download"
+require "parallel_sftp/client"
+
+module ParallelSftp
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configure ParallelSftp globally
+    #
+    # @example
+    #   ParallelSftp.configure do |config|
+    #     config.default_segments = 8
+    #     config.timeout = 60
+    #     config.max_retries = 15
+    #   end
+    def configure
+      yield(configuration)
+    end
+
+    # Reset configuration to defaults
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+
+    # Check if lftp is available on the system
+    #
+    # @return [Boolean] true if lftp is installed and accessible
+    def lftp_available?
+      system("which lftp > /dev/null 2>&1")
+    end
+
+    # Get the installed lftp version
+    #
+    # @return [String, nil] Version string or nil if not installed
+    def lftp_version
+      return nil unless lftp_available?
+      `lftp --version`.lines.first&.strip
+    end
+
+    # Raise an error if lftp is not available
+    #
+    # @raise [LftpNotFoundError] if lftp is not installed
+    def ensure_lftp_available!
+      raise LftpNotFoundError unless lftp_available?
+    end
+
+    # Simple one-liner for downloading a file
+    #
+    # @param options [Hash] Connection and download options
+    # @option options [String] :host SFTP host
+    # @option options [String] :user Username
+    # @option options [String] :password Password
+    # @option options [Integer] :port SFTP port (default: 22)
+    # @option options [String] :remote_path Path to file on server
+    # @option options [String] :local_path Local destination path
+    # @option options [Integer] :segments Parallel connections (default: 4)
+    # @option options [Boolean] :resume Continue interrupted downloads (default: true)
+    # @option options [Integer] :timeout Connection timeout in seconds
+    # @option options [Integer] :max_retries Maximum retry attempts
+    # @option options [Proc] :on_progress Progress callback
+    # @option options [Proc] :on_segment_progress Per-segment progress callback
+    #
+    # @return [String] Local path to downloaded file
+    # @raise [DownloadError] if download fails
+    #
+    # @example Basic progress
+    #   ParallelSftp.download(
+    #     host: 'ftp.example.com',
+    #     user: 'username',
+    #     password: 'secret',
+    #     remote_path: '/path/to/large_file.zip',
+    #     local_path: '/tmp/large_file.zip',
+    #     segments: 8,
+    #     on_progress: ->(info) { puts "#{info[:percent]}%" }
+    #   )
+    #
+    # @example With per-segment progress
+    #   ParallelSftp.download(
+    #     host: 'ftp.example.com',
+    #     user: 'username',
+    #     password: 'secret',
+    #     remote_path: '/path/to/large_file.zip',
+    #     local_path: '/tmp/large_file.zip',
+    #     segments: 8,
+    #     on_segment_progress: lambda do |info|
+    #       puts "Overall: #{info[:overall_percent]}% (#{info[:eta]} remaining)"
+    #       puts "Speed: #{info[:speed] / 1_000_000.0} MB/s" if info[:speed]
+    #       info[:segments].each do |seg|
+    #         puts "  Segment #{seg[:index]}: #{seg[:percent]}%"
+    #       end
+    #     end
+    #   )
+    def download(options = {})
+      client = Client.new(
+        host: options.fetch(:host),
+        user: options.fetch(:user),
+        password: options.fetch(:password),
+        port: options.fetch(:port, configuration.default_port)
+      )
+
+      client.download(
+        options.fetch(:remote_path),
+        options.fetch(:local_path),
+        segments: options[:segments],
+        resume: options.fetch(:resume, true),
+        timeout: options[:timeout],
+        max_retries: options[:max_retries],
+        reconnect_interval: options[:reconnect_interval],
+        sftp_connect_program: options[:sftp_connect_program],
+        on_progress: options[:on_progress],
+        on_segment_progress: options[:on_segment_progress]
+      )
+    end
+  end
+end

data/parallel_sftp.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "parallel_sftp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "parallel_sftp"
+  spec.version       = ParallelSftp::VERSION
+  spec.authors       = ["Nestor G Pestelos Jr"]
+  spec.email         = ["ngpestelos@gmail.com"]
+
+  spec.summary       = "Fast parallel SFTP downloads using lftp's segmented transfer"
+  spec.description   = "A Ruby gem that wraps lftp for parallel/segmented SFTP downloads of large files. " \
+                       "Supports resume, progress callbacks, and configurable retry settings."
+  spec.homepage      = "https://github.com/ngpestelos/parallel_sftp"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/shell.nix

@@ -0,0 +1,29 @@
+{ pkgs ? import <nixpkgs> {} }:
+
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    ruby_3_3
+    bundler
+    lftp
+    curl
+  ];
+
+  shellHook = ''
+    export GEM_HOME="$PWD/.gems"
+    export PATH="$GEM_HOME/bin:$PATH"
+    mkdir -p "$GEM_HOME"
+    # Check if Claude Code is installed natively
+    if [ ! -f "$HOME/.local/bin/claude" ]; then
+      echo "Installing Claude Code (native)..."
+      curl -fsSL https://claude.ai/install.sh | bash
+    fi
+
+    # Add Claude to PATH if not already there
+    export PATH="$HOME/.local/bin:$PATH"
+
+    # Indicate we're in a nix-shell with Claude Code
+    export PS1="\[\033[1;32m\][nix-shell:claude]\[\033[0m\] $PS1"
+
+    echo "Claude Code environment activated. Run 'claude' to use the CLI."
+  '';
+}

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: parallel_sftp
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Nestor G Pestelos Jr
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ruby gem that wraps lftp for parallel/segmented SFTP downloads of large
+  files. Supports resume, progress callbacks, and configurable retry settings.
+email:
+- ngpestelos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CLAUDE.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/parallel_sftp.rb
+- lib/parallel_sftp/client.rb
+- lib/parallel_sftp/configuration.rb
+- lib/parallel_sftp/download.rb
+- lib/parallel_sftp/errors.rb
+- lib/parallel_sftp/lftp_command.rb
+- lib/parallel_sftp/progress_parser.rb
+- lib/parallel_sftp/segment_progress_parser.rb
+- lib/parallel_sftp/time_estimator.rb
+- lib/parallel_sftp/version.rb
+- parallel_sftp.gemspec
+- shell.nix
+homepage: https://github.com/ngpestelos/parallel_sftp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ngpestelos/parallel_sftp
+  source_code_uri: https://github.com/ngpestelos/parallel_sftp
+  changelog_uri: https://github.com/ngpestelos/parallel_sftp/blob/master/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Fast parallel SFTP downloads using lftp's segmented transfer
+test_files: []