ftp_liar 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46a94e03d4451cb163649ebbca4ea29b357c1b4b
-  data.tar.gz: 0682537419402274ba2b73e1a7aa5af171afe1cf
+  metadata.gz: f4d0a590a5f11f6c92e906d855eb9f9701edd853
+  data.tar.gz: bad3d60b8d98ed04c2d027cc5772b2258e39ecc0
 SHA512:
-  metadata.gz: eb7fc9663f7137a6764d6af8fc366807341489ecf75f6cfc932263b1b9a03a9002979179a8082b4770b8ba48743820020b3a93d312a5b05b71a93cd5938903ba
-  data.tar.gz: d65874cef4501bd231d7ae3768f58c5eb857b71b3f99798b1fe0d69318e907cd201e1367001d182628a0c345bacb6470102a0596bae8cdedb051f9f90746b158
+  metadata.gz: 898fe0c3632611ec39ec626697e203c83c29f21eb9b9796a4611f0e12c9397879ec9853a38cbf7a098c88171378c1a564901bae45c437886c7820b233bd9f682
+  data.tar.gz: d18a986d07309963155b876f4b7bbff8e12a146a8ecfccb0b012ca6f36641fc4b114c9dd0029aba052c26e927bf695cf4e2178b2cb15c8d422e67459f4cb5672

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 2.3.0@ftp_liar

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ftp_liar.gemspec
 gemspec
+
+gem 'faker'

data/README.md

@@ -24,7 +24,7 @@ Use FTPLiar class with proxy pattern, override interesting class.
 ```ruby
 class MyFTP
   def initialize(*args)
-    @ftp_liar = FTPLiar::FTPLiar.new
+    @ftp_liar = FTPLiar::FTPLiar.new(*args)
   end
 
   def method_missing(name, *args)
@@ -32,12 +32,23 @@ class MyFTP
   end
 end
 ```
-## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+If some method raise NotImplementedError override create your own method like in the example
+```ruby
+class MyFTP
+  def initialize(*args)
+    @ftp_liar = FTPLiar::FTPLiar.new(*args)
+  end
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  def mdtm(filename)
+    # Do here what do you want.
+  end
 
+  def method_missing(name, *args)
+    @ftp_liar.send(name, *args)
+  end
+end
+```
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Draqun/ftp_liar.

data/TODO

@@ -0,0 +1 @@
+Some method can use blocks as parameters. Find this methods and implement it.

data/ftp_liar.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "byebug"
 end

data/lib/ftp_liar.rb

@@ -1,57 +1,404 @@
 require "ftp_liar/version"
+require_relative 'ftp_liar_net'
 require 'fileutils'
 require 'tmpdir'
+require 'faker'
 
 module FTPLiar
   class FTPLiar
     # FTP Liar
     # Simple class for test aplication using Net::FTP
     attr_writer :open_timeout, :read_timeout, :debug_mode, :passive
+    attr_accessor :binary
 
-    def initialize(*args)
-      FileUtils.cd(Dir.tmpdir)
+    def initialize(host = nil, user = nil, passwd = nil, acct = nil)
+      @ftp_directory = File.join(Dir.tmpdir, '.ftp_liar')
+      FileUtils.mkdir_p(@ftp_directory)
+      @binary = true
+      @passive = false
+      ObjectSpace.define_finalizer(self, self.method(:finalize))
+      if !(user.nil? && passwd.nil?) && (user.nil? || passwd.nil?)
+        raise Net::FTPPermError.new("530 User cannot log in.")
+      else
+        @is_connect = true
+      end
+      chdir("/")
     end
 
-    def login(*args)
+    def finalize(object_id)
+      # Finalizer to delete ftp_liar directory
+      FileUtils.rm_rf(@ftp_directory)
     end
 
-    def getbinaryfile(remotefile, localfile = nil, blocksize = nil)
-      # A simple method that manages to copy a remote file to local
-      FileUtils.cp(remotefile, localfile ? localfile : File.basename(remotefile))
+    # :nocov:
+    def abort()
+      # Aborts the previous command (ABOR command).
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
     end
 
-    def putbinaryfile(localfile, remotefile = nil, blocksize = nil)
-      # A simple method that manages to copy a local file on the FTP.
-      FileUtils.cp(localfile, remotefile ? remotefile : File.basename(localfile))
+    def acct(account)
+      # Sends the ACCT command.
+      #
+      # This is a less common FTP command, to send account information if the destination host requires it.
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
     end
+    # :nocov:
 
     def chdir(path)
-      # Method to change directory
+      # Changes the (remote) directory.
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      if path[0] == "/"
+        path = if path.length == 1
+          @ftp_directory
+        else
+          File.join(@ftp_directory, path[1..-1])
+        end
+      end
+
+      unless absolute_path_indicates_to_ftp_directory?(path) && Dir.exist?(path)
+        raise Net::FTPPermError.new("500")
+      end
+
       FileUtils.cd(path)
+      nil
+    end
+
+    def close()
+      # Closes the connection. Further operations are impossible until you open a new connection with connect.
+      chdir("/")
+      @is_connect = false
+      ""
+    end
+
+    def closed?()
+      # Returns true if the connection is closed.
+      !@is_connect
+    end
+
+    def connect(host, port = 21)
+      # Method imitate connect method in Net::FTP
+      @is_connect = true
+      nil
+    end
+
+    def delete(filename)
+      # Method remove file on FTP
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      filename = if filename[0] == "/"
+        File.join(@ftp_directory, filename[1..-1])
+      else
+        File.join(@ftp_directory, pwd[1..-1], filename)
+      end
+      unless absolute_path_indicates_to_ftp_directory?(filename) && File.exist?(filename)
+        raise Net::FTPPermError.new("550")
+      end
+      File.delete(filename)
+      nil
     end
 
+    # :nocov:
+    def dir(*args)
+      # Alias for list
+      list(*args)
+    end
+    # :nocov:
+
+    def get(remotefile, localfile = File.basename(remotefile), blocksize = nil)
+      # A simple method that manages to copy a remote file to local
+      raise Net::FTPPermError("530 Please login with USER and PASS.") unless @is_connect
+      if remotefile[0] == "/"
+        if remotefile.length > 1
+          remotefile = File.join(@ftp_directory, pwd[1..-1], remotefile[1..-1])
+        elsif remotefile == "/"
+          raise Errno::EISDIR
+        end
+      end
+
+      unless absolute_path_indicates_to_ftp_directory?(remotefile) && File.exist?(remotefile)
+        raise Net::FTPPermError.new("550")
+      end
+
+      localdir = localfile.split("/")[0...-1].join("/")
+      if File.directory?(localfile)
+        raise Errno::EISDIR
+      end
+      unless Dir.exist?(localdir)
+        raise Errno::ENOENT
+      end
+      copy_file(remotefile, localfile)
+      nil
+    end
+
+    # :nocov:
+    def getbinaryfile(*args)
+      # A simple method that manages to copy a remote file to local
+      get(*args)
+    end
+
+    def getdir()
+      pwd
+    end
+
+    def gettextfile(*args)
+      get(*args)
+    end
+
+    def help(arg = nil)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def list(*args)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+    # :nocov:
+
+    def login(user = "anonymous", passwd = nil, acct = nil)
+      # Method imitate login to ftp. When login is "anonymous" it "connect" without password
+      if user != "anonymous" && (user.nil? || passwd.nil?)
+        raise Net::FTPPermError.new("530 User cannot log in.")
+      end
+      @is_connect = true
+    end
+
+    # :nocov:
+    def ls(*args)
+      # Alias for list
+      list(*args)
+    end
+
+    def mdtm(filename)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+    # :nocov:
+
+    def mkdir(dirname)
+      # Creates a remote directory.
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      new_dirname = create_path(dirname)
+
+      if !absolute_path_indicates_to_ftp_directory?(new_dirname) || File.exist?(new_dirname)
+        raise Net::FTPPermError.new("550")
+      end
+
+      Dir.mkdir(new_dirname)
+      dirname
+    end
+
+    # :nocov:
+    def mtime(filename, local = false)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+    # :nocov:
+
     def nlst(path = '.')
       # A simple method to list data in directory, return list with filename if file
-      if File.file?(path)
+      # Method does not work as method in Net::FTP. I started topic about it on https://bugs.ruby-lang.org/issues/11407 because I think original method has bugs
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      new_path = create_path(path)
+
+      unless absolute_path_indicates_to_ftp_directory?(new_path)
+        raise Net::FTPPermError.new("550")
+      end
+
+      if File.file?(new_path)
         [path]
       else
-        Dir.entries(path).sort[2..-1]
+        Dir.entries(new_path).sort[2..-1]
+      end
+    end
+
+    # :nocov:
+    def noop()
+      # Does nothing
+      nil
+    end
+    # :nocov:
+
+    def put(localfile, remotefile = File.basename(localfile), blocksize = nil)
+      # A simple method that manages to copy a local file on the FTP.
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      if File.directory?(localfile)
+        raise Errno::EISDIR
       end
+      unless File.exist?(localfile)
+        raise Errno::ENOENT
+      end
+
+      if remotefile[0] == "/" && remotefile.length > 1
+        remotefile = File.join(@ftp_directory, remotefile[1..-1])
+      end
+
+      unless absolute_path_indicates_to_ftp_directory?(remotefile)
+        raise Net::FTPPermError.new("550")
+      end
+
+      if  File.exist?(remotefile)
+        raise Net::FTPPermError.new("550")
+      end
+
+      copy_file(localfile, remotefile)
+      nil
     end
 
+    # :nocov:
+    def putbinaryfile(*args)
+      # A simple method that manages to copy a local file on the FTP.
+      put(*args)
+    end
+
+    def puttextfile(*args)
+      put(*args)
+    end
+    # :nocov:
+
     def pwd
       # Method return actual directory
-      Dir.pwd
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      ftp_directory_length = @ftp_directory.length
+      if Dir.pwd == @ftp_directory
+        "/"
+      else
+        Dir.pwd[ftp_directory_length..-1]
+      end
     end
 
-    def delete(filename)
-      # Method remove file on FTP
-      File.delete(filename)
+    def quit
+      raise Errno::EPIPE unless @is_connect
+      chdir("/")
+      @is_connect = false
+      nil
     end
 
+    def rename(fromname, toname)
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      [fromname, toname].each do |path|
+        eval(%Q{
+          if path == "/"
+            raise Net::FTPPermError.new("550")
+          end
+        })
+      end
+      fromname = create_path(fromname)
+      toname = create_path(toname)
+
+      [fromname, toname].each do |path|
+        eval(%Q{
+          unless absolute_path_indicates_to_ftp_directory?(path)
+            raise Net::FTPPermError.new("550")
+          end
+
+          if File.directory?(path) && !Dir.entries(path).sort[2..-1].empty?
+            raise Net::FTPPermError.new("550")
+          end
+        })
+      end
+
+      FileUtils.mv(fromname, toname)
+      nil
+    end
+
+    # :nocov:
+    def retrbinary(cmd, blocksize, rest_offset = nil)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def retrlines(cmd)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+    # :nocov:
+
     def rmdir(dirname)
       # Method remove directory on FTP
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      dirname = if dirname[0] == "/"
+        File.join(@ftp_directory, dirname[1..-1])
+      else
+        File.join(@ftp_directory, pwd[1..-1], dirname)
+      end
+
+      if File.file?(dirname) || !File.exist?(dirname)
+        raise Net::FTPPermError.new("550")
+      end
       Dir.delete(dirname)
+      nil
+    end
+
+    # :nocov:
+    def sendcmd(cmd)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def set_socket(sock, get_greeting=true)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def site(arg)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+    # :nocov:
+
+    def size(filename)
+      raise Net::FTPPermError.new("530 Please login with USER and PASS.") unless @is_connect
+      filename = create_path(filename)
+      unless absolute_path_indicates_to_ftp_directory?(filename)
+        raise Net::FTPPermError.new("550")
+      end
+
+      if File.directory?(filename)
+        raise Net::FTPPermError.new("550")
+      end
+
+      File.size(filename)
+    end
+
+    # :nocov:
+    def status()
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def storbinary(cmd, file, blocksize, rest_offset = nil)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def sotrlines(cmd, file)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def system()
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+
+    def voidcmd(cmd)
+      raise NotImplementedError("Method not implemented. Override it if you want use this method.")
+    end
+    # :nocov:
+
+    private
+    attr_accessor :ftp_directory
+    attr_accessor :is_connection
+
+    def copy_file(from, to)
+      FileUtils.copy_file(from, to)
+    end
+
+    def absolute_path_indicates_to_ftp_directory?(path)
+      File.absolute_path(path).start_with?(@ftp_directory)
+    end
+
+    def create_path(path)
+      if path[0] == "/"
+        File.join(@ftp_directory, path[1..-1])
+      elsif pwd == "/"
+        File.join(@ftp_directory, path)
+      else
+        File.join(@ftp_directory, pwd[1..-1], path)
+      end
+    end
+
+    class << self
+      def open(host, *args)
+        FTPLiar.new(host, *args)
+      end
     end
   end
 end

data/lib/ftp_liar/version.rb

@@ -1,3 +1,3 @@
 module FTPLiar
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/ftp_liar_net.rb

@@ -0,0 +1,3 @@
+module Net
+  FTPPermError = Class.new(Exception)
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ftp_liar
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Damian Giebas
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple class for test application using Net::FTP object. It is not complete
   FTP local server.
 email:
@@ -62,16 +90,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rvmrc"
 - ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- TODO
 - bin/console
 - bin/setup
 - ftp_liar.gemspec
 - lib/ftp_liar.rb
 - lib/ftp_liar/version.rb
+- lib/ftp_liar_net.rb
 homepage: https://github.com/Draqun/ftp_liar
 licenses:
 - MIT
@@ -92,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.0
 signing_key: 
 specification_version: 4
 summary: Simple class for test application using Net::FTP object