ftpmock 0.0.0 → 0.1.0

data/lib/ftpmock/core/configuration.rb

@@ -0,0 +1,33 @@
+module Ftpmock
+  module_function
+
+  def configure
+    yield configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_writer :path
+    attr_accessor :verbose
+
+    def initialize(path: nil, verbose: true)
+      @path = path
+      @verbose = verbose
+    end
+
+    def path
+      @path ||= "#{test_dir}/ftp_records"
+    end
+
+    def test_dir
+      rspec? ? 'spec' : 'test'
+    end
+
+    def rspec?
+      defined?(RSpec)
+    end
+  end
+end

data/lib/ftpmock/helpers/get_helper.rb

@@ -0,0 +1,46 @@
+module Ftpmock
+  module GetHelper
+    module_function
+
+    # reads from cache to localfile
+    #
+    # true/false
+    def read(cache_path, chdir, remotefile, localfile)
+      # chdir =
+      remotefile = PathHelper.join(PathHelper.simplify(chdir), remotefile).to_s
+      # localfile = PathHelper.join(chdir, localfile).to_s
+
+      cached_path = path_for(cache_path, remotefile)
+
+      File.exist?(cached_path) && FileUtils.cp(cached_path, localfile)
+
+      fetched?(localfile)
+    end
+
+    # writes to cache from localfile
+    def write(cache_path, chdir, remotefile, localfile)
+      return false unless File.exist?(localfile)
+
+      # chdir =
+      remotefile = PathHelper.join(PathHelper.simplify(chdir), remotefile).to_s
+      # localfile = PathHelper.join(chdir, localfile).to_s
+
+      cached_path = path_for(cache_path, remotefile)
+      FileUtils.cp(localfile, cached_path)
+
+      File.exist?(cached_path)
+    end
+
+    def fetched?(localfile)
+      File.exist?(localfile)
+    end
+
+    def path_for(cache_path, remotefile)
+      path = cache_path.join('get')
+      remotefile = PathHelper.simplify(remotefile)
+      ret = path.join(remotefile)
+      FileUtils.mkdir_p(ret.dirname.to_s)
+      ret
+    end
+  end
+end

data/lib/ftpmock/helpers/list_helper.rb

@@ -0,0 +1,53 @@
+require 'psych'
+
+module Ftpmock
+  module ListHelper
+    module_function
+
+    def read(cache_path, chdir, key)
+      key = PathHelper.join(chdir, key).to_s if chdir
+      dataset = read_dataset(cache_path)
+      dataset[key]
+    end
+
+    def write(cache_path, chdir, key, list)
+      key = PathHelper.join(chdir, key).to_s if chdir
+      dataset = read_dataset(cache_path)
+      dataset[key] = list
+      write_dataset(cache_path, dataset)
+      true
+    end
+
+    def read_dataset(cache_path)
+      path = path_for(cache_path)
+      string = path.read
+      load(string)
+    end
+
+    def write_dataset(cache_path, dataset)
+      path = path_for(cache_path)
+      content = dump(dataset)
+      path.write(content)
+    end
+
+    def path_for(cache_path)
+      cache_path = PathHelper.clean(cache_path)
+      cache_path.exist? || FileUtils.mkdir_p(cache_path)
+      path = PathHelper.clean("#{cache_path}/list.yml")
+      path.exist? || path.write(dump(new_list))
+      path
+    end
+
+    def new_list
+      {}
+    end
+
+    def load(string)
+      Psych.load(string)
+    end
+
+    def dump(data)
+      Psych.dump(data)
+    end
+  end
+end

data/lib/ftpmock/helpers/path_helper.rb

@@ -0,0 +1,24 @@
+module Ftpmock
+  module PathHelper
+    module_function
+
+    def clean(path)
+      path = path.to_s
+      path = path[1..-1] if path[0] == '/'
+      path = Pathname(path).cleanpath
+      return Pathname('') if path.to_s == '.'
+
+      path
+    end
+
+    def join(path_a, path_b)
+      clean Pathname(path_a.to_s).join(path_b.to_s)
+    end
+
+    def simplify(path)
+      path.to_s
+          .tr('/', '-')
+          .tr('..', '__')
+    end
+  end
+end

data/lib/ftpmock/helpers/put_helper.rb

@@ -0,0 +1,39 @@
+module Ftpmock
+  module PutHelper
+    module_function
+
+    def cached?(cache_path, remotefile)
+      path = path_for(cache_path, remotefile)
+      path.exist?
+    end
+
+    def exist?(localfile)
+      File.exist?(localfile)
+    end
+
+    def write(cache_path, localfile, remotefile)
+      path = path_for(cache_path, remotefile)
+      FileUtils.cp(localfile, path)
+    end
+
+    # Array
+    def compare(cache_path, localfile, remotefile)
+      return [] unless cached?(cache_path, remotefile)
+
+      path = path_for(cache_path, remotefile)
+      diff = StringUtils.diff(localfile, path)
+      diff.split("\n")
+    end
+
+    # def expire(cache_path, remotefile)
+    #   path = path_for(cache_path, remotefile)
+    #   path.exist? && path.delete
+    # end
+
+    def path_for(cache_path, remotefile)
+      path = cache_path.join('put')
+      FileUtils.mkdir_p(path)
+      path.join(remotefile.tr('/', '-'))
+    end
+  end
+end

data/lib/ftpmock/proxies/method_missing_mixin.rb

@@ -0,0 +1,9 @@
+module Ftpmock
+  module MethodMissingMixin
+    def method_missing(name, *_args)
+      msg = "  Missing method `#{self.class.name}##{name}`. Ignoring"
+      configuration.verbose && VerboseUtils.warn(msg)
+      nil
+    end
+  end
+end

data/lib/ftpmock/proxies/net_ftp_proxy.rb

@@ -0,0 +1,287 @@
+# https://apidock.com/ruby/Net/FTP
+require 'net/ftp'
+
+module Ftpmock
+  class NetFtpProxy
+    # Stubbers
+
+    Real = begin
+             Net::FTP
+           rescue NameError
+             nil
+           end
+
+    # inspired by https://github.com/bblimke/webmock/blob/master/lib/webmock/http_lib_caches/net_http.rb
+    def self.on!
+      unless Real
+        yield
+        return
+      end
+
+      Net.send(:remove_const, :FTP)
+      Net.const_set(:FTP, self)
+      if block_given?
+        yield
+        off!
+      end
+    end
+
+    def self.off!
+      return unless Real
+
+      Net.send(:remove_const, :FTP)
+      Net.const_set(:FTP, Real)
+    end
+
+    PORT = 21
+
+    # Instance Methods
+
+    # inspired by https://apidock.com/ruby/v2_6_3/Net/FTP/open/class
+    def self.open(host, *args)
+      if block_given?
+        proxy = new(host, *args)
+        begin
+          yield proxy
+        ensure
+          proxy.close
+        end
+      else
+        new(host, *args)
+      end
+    end
+
+    # inspired by https://apidock.com/ruby/v2_6_3/Net/FTP/new/class
+    def initialize(host = nil, *args)
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @host = host
+      @configuration = @options[:configuration] || Ftpmock.configuration
+
+      if args.size == 2
+        @options[:username] ||= args[0]
+        @options[:password] ||= args[1]
+      end
+
+      if host
+        connect(host, @options[:port] || PORT)
+        login(@options[:username], @options[:password]) if @options[:username]
+      end
+    end
+
+    def real
+      @real ||= Real.new
+    end
+
+    attr_writer :cache, :real
+    attr_reader :configuration,
+                :host,
+                :port,
+                :username,
+                :password
+
+    # connection methods
+
+    def connect(host, port = PORT)
+      @real_connected = false
+      @host = host
+      @port = port
+
+      StringUtils.all_present?(host, port) || _raise_not_connected
+
+      @cache_connected = true
+      true
+    end
+
+    def login(username, password)
+      @cache = nil
+      @real_logged = false
+      @username = username
+      @password = password
+
+      _init_cache
+
+      @cache_logged = true
+      true
+    end
+
+    def _real_connect_and_login
+      @cache_connected || _raise_not_connected
+      @cache_logged || _raise_not_connected
+
+      @real_connected || real.connect(*_real_connect_args)
+      @real_connected = true
+
+      @real_logged || real.login(*_real_login_args)
+      @real_logged = true
+
+      if @chdir
+        @real.chdir(@chdir)
+        @chdir = nil
+      end
+    end
+
+    def _real_connect_args
+      [host, port]
+    end
+
+    def _real_login_args
+      [username, password].select { |string| StringUtils.present?(string) }
+    end
+
+    def _init_cache
+      credentials = [host, port, username, password]
+      @cache = Cache.new(configuration, credentials)
+    end
+
+    def cache
+      @cache || _raise_not_connected
+    end
+
+    def _raise_not_connected
+      raise(Net::FTPConnectionError, 'not connected')
+    end
+
+    # directory methods
+
+    # https://docs.ruby-lang.org/en/2.0.0/Net/FTP.html#method-i-chdir
+    def chdir(dirname = nil)
+      cache.chdir(dirname)
+    end
+
+    def pwd
+      chdir
+    end
+
+    def getdir
+      chdir
+    end
+
+    # list methods
+
+    def list(*args)
+      cache.list(*args) do
+        _real_connect_and_login
+        real.list(*args)
+      end
+    end
+
+    # get methods
+
+    def get(remotefile, localfile = File.basename(remotefile))
+      cache.get(remotefile, localfile) do
+        _real_connect_and_login
+        real.get(remotefile, localfile)
+      end
+
+      true
+    end
+
+    def gettextfile(remotefile, localfile = File.basename(remotefile))
+      cache.get(remotefile, localfile) do
+        _real_connect_and_login
+        real.gettextfile(remotefile, localfile)
+      end
+
+      true
+    end
+
+    def getbinaryfile(remotefile, localfile = File.basename(remotefile))
+      cache.get(remotefile, localfile) do
+        _real_connect_and_login
+        real.getbinaryfile(remotefile, localfile)
+      end
+
+      true
+    end
+
+    # put methods
+
+    # TODO: block
+    # https://docs.ruby-lang.org/en/2.0.0/Net/FTP.html#method-i-put
+    def put(localfile, remotefile = File.basename(localfile))
+      cache.put(localfile, remotefile) do
+        _real_connect_and_login
+        real.put(localfile, remotefile)
+      end
+
+      true
+    end
+
+    # TODO: block
+    def puttextfile(localfile, remotefile = File.basename(localfile))
+      cache.put(localfile, remotefile) do
+        _real_connect_and_login
+        real.puttextfile(localfile, remotefile)
+      end
+
+      true
+    end
+
+    # TODO: block
+    def putbinaryfile(localfile, remotefile = File.basename(localfile))
+      cache.put(localfile, remotefile) do
+        _real_connect_and_login
+        real.putbinaryfile(localfile, remotefile)
+      end
+
+      true
+    end
+
+    # TODO: Methods Not Implemented
+
+    # abort
+    # acct
+    # binary
+    # binary=
+    # close
+    # closed?
+    # debug_mode
+    # debug_mode=
+    # delete
+    # help
+    # last_response
+    # last_response_code
+    # mdtm
+    # mkdir
+    # mlsd
+    # mlst
+    # mon_enter
+    # mon_exit
+    # mon_locked?
+    # mon_owned?
+    # mon_synchronize
+    # mon_try_enter
+    # mtime
+    # new_cond
+    # nlst
+    # noop
+    # open_timeout
+    # open_timeout=
+    # passive
+    # passive=
+    # quit
+    # read_timeout
+    # read_timeout=
+    # rename
+    # resume
+    # resume=
+    # retrbinary
+    # retrlines
+    # return_code
+    # return_code=
+    # rmdir
+    # sendcmd
+    # set_socket
+    # site
+    # size
+    # ssl_handshake_timeout
+    # ssl_handshake_timeout=
+    # status
+    # storbinary
+    # storlines
+    # system
+    # voidcmd
+    # welcome
+    include MethodMissingMixin
+  end
+end