ftp_paradise 1.4.5 → 1.5.3

data/lib/ftp_paradise/connection/download.rb

@@ -1,86 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/download.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === download_binary_file
-  #
-  # Use this method to download a binary file, by calling the method
-  # getbinaryfile(). You can download as many files as you want to
-  # through this method, but we expect this method to be a binary
-  # file.
-  #
-  # Specific usage example:
-  #
-  #   ftp?.download_binary_file('photos_2009-03-29.zip', 'ftp_photos/photos.zip')
-  #
-  # ========================================================================= #
-  def download_binary_file(
-      i,
-      be_verbose = be_verbose?
-    )
-    if i.is_a? Array
-      i.each {|entry| download_binary_file(entry) }
-    else
-      ftp?.getbinaryfile(i) # Delegate towards .getbinaryfile()
-      if be_verbose
-        e "Downloaded file #{sfile(i)}."
-      end
-    end
-  end; alias getbinaryfile download_binary_file # === getbinaryfile
-
-  # ========================================================================= #
-  # === download_remote_file                                   (download tag)
-  #
-  # Use this method to download a remote file. If you are sure to have
-  # a binary file, the method download_binary_file() could be used
-  # instead.
-  #
-  # gettextfile(remotefile, localfile = File.basename(remotefile)) {|line| ...}
-  # ========================================================================= #
-  def download_remote_file(
-      i, be_verbose = be_verbose?
-    )
-    if i.is_a? Array # Handle arrays first.
-      i.each {|entry| download_remote_file(entry, be_verbose) }
-    else
-      if i =~ /^\d+$/ # if is a number
-        update_file_listing
-        i = return_remote_files[i.to_i - 1].first
-      end
-      if i == '*' # Here we want to download all files, as we passed in '*'.
-        i = []
-        update_file_listing
-        return_remote_files.each { |a,b| i << FtpParadise.rds(a) }
-      end
-      if be_verbose
-        notify_the_user_about(i, __method__)
-      end
-      set_file(i) # This assigns to @internal_hash[:file].
-      begin # We can use @file because we called set_file() before.
-        ftp_object?.gettextfile(file?)
-        basename = File.basename(file?)
-        e "Finished downloading `#{sandybrown(file?)}`"
-        e 'into `'+sdir(rds(Dir.pwd+'/'+basename))+'`.'
-        return file?
-      rescue Net::FTPPermError => error
-        pp error
-        e 'An exception occurred in the method '+sfancy('download()')+'.'
-        e 'The error was a '+sfancy('Permission Error')+', the input '\
-          'to the method was: `'+simp(i)+'`.'
-        e 'Is the file that you are trying to download really '\
-          'existing on the remote server?'
-        return false
-      end
-    end
-  end; alias download                  download_remote_file # === download
-       alias download_this_remote_file download_remote_file # === download_this_remote_file
-       alias download_this_file        download_remote_file # === download_this_file
-
-end; end

data/lib/ftp_paradise/connection/file_handling.rb

@@ -1,174 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/file_handling.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === create_remote_file                                        (touch tag)
-  #
-  # This "touches" a remote file.
-  # ========================================================================= #
-  def create_remote_file(
-      i,
-      be_verbose = be_verbose?
-    )
-    if i.is_a? Array
-      i.each {|entry| create_remote_file(entry, be_verbose) }
-    else
-      FileUtils.touch(i)
-      if be_verbose
-        notify_the_user_about(i, __method__)
-      end
-      upload_this_text_file(i, :be_quiet)
-      File.delete(i) if File.zero? i # And get rid of that file too.
-    end
-  end; alias touch create_remote_file # === touch
-
-  # ========================================================================= #
-  # === fancy_remote_listing
-  #
-  # This method will obtain the (remote) directory listing and then
-  # display it.
-  # ========================================================================= #
-  def fancy_remote_listing(
-      be_verbose = be_verbose?
-    )
-    update_file_listing
-    case be_verbose
-    when :be_silent,
-         :be_quiet
-      be_verbose = false
-    when :also_show_filesize
-      be_verbose = true
-    end
-    if be_verbose
-      e ('=' * 55)+' '+
-        FtpParadise.yellow('REMOTE FILES')+' '+('=' * 12)
-      if remote_directory_is_empty?
-        e "Remote `#{sdir(remote_path?)}` is empty."
-        e 'No files or directories can be found therein.'
-      else
-        e 'Remote content of `'+sdir(remote_path?)+'` is:'+N+N
-        e 'Index  Filename                           '\
-          '                                    Filesize'
-        show_remote_file_listing
-      end
-      cliner
-    end
-    return remote_directory_content
-  end
-
-  # ========================================================================= #
-  # === rename
-  #
-  # This method will attempt to rename a file on the remote server.
-  #
-  # Note that this is equivalent to moving a file, which is why the alias
-  # move_file can also be used. Any move-file actioni s simply a rename()
-  # action.
-  #
-  # The first argument passed to this method should be the name of an 
-  # existing (remote) file. The second second argument should be the
-  # new name of that file, or its full (remote) path.
-  #
-  # Also note that it seems as if the FTP protocol requires the full
-  # target location, otherwise errors such as the following might
-  # happen:
-  #
-  #   ftp.rb in `getresp': 451 Rename/move failure: Is a directory (Net::FTPTempError)
-  #
-  # The command used by .rename() command should be equivalent to this code:
-  #
-  #   SITE mv oldpath newpath
-  #
-  # Documentation for the functionality can be found here:
-  #
-  #   http://ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html#method-i-rename
-  #        
-  # ========================================================================= #
-  def rename(
-      from,
-      to,
-      be_verbose = be_verbose?
-    )
-    to = to.first if to.is_a? Array
-    if from.is_a? Array # Support batch-transfer.
-      from.each {|entry| rename(entry, to) }
-    else
-      from = rds(from)
-      to   = rds(to)
-      begin
-        ftp_object?.rename(from, to)
-        if be_verbose
-          opnn; e "Renamed the remote entry `#{sfancy(from)}"\
-                  "` to `#{sfancy(to)}`."
-        end
-      rescue Net::FTPTempError => error
-        e "An error (#{simp('Net::FTPTempError')}) occurred "\
-          "in the method #{simp('rename()')}:"
-        pp error
-      end
-    end
-  end; alias rename_file        rename # === rename_file
-       alias move_file          rename # === move_file
-       alias rename_remote_file rename # === rename_remote_file
-
-  # ========================================================================= #
-  # === update_remote_file_listing
-  # ========================================================================= #
-  def update_remote_file_listing(
-      be_verbose = be_verbose?
-    )
-    case be_verbose
-    when :be_quiet
-      be_verbose = false
-    end
-    if is_connected?
-      begin
-        # =================================================================== #
-        # Make use of a method that will skip a few entries, such as
-        # "." or "..".
-        # =================================================================== #
-        @internal_hash[:raw_entries] = return_slightly_sanitized_entries_ignoring_a_few
-      rescue Exception => error
-        opnn; e swarn('An error happened in the method '\
-                'update_remote_file_listing(), at '\
-                'line: '+__LINE__.to_s+'.')
-        pp error.class
-        pp error
-      end
-    else
-      if be_verbose
-        opnn; e 'Can not update the remote file listing '\
-                'because we are not connected.'
-      end
-    end
-  end; alias update_file_listing update_remote_file_listing # === update_file_listing
-       alias update_raw_listing  update_remote_file_listing # === update_raw_listing
-       alias get_listing         update_remote_file_listing # === get_listing
-       alias get_remote_listing  update_remote_file_listing # === get_remote_listing
-       alias update              update_remote_file_listing # === update
-
-  # ========================================================================= #
-  # === does_this_remote_file_exist?
-  # ========================================================================= #
-  def does_this_remote_file_exist?(i)
-    i = File.basename(i).strip
-    array = return_all_remote_files
-    if array.is_a?(Array) and
-       array.first.is_a?(String)
-      array.map! {|entry|
-        entry = FtpParadise::Entry.new(entry)
-      }
-      array.select! {|entry| entry.is_a_file? }
-      array.map! {|entry| entry.filename? }
-    end
-    return array.include?(i)
-  end
-
-end; end

data/lib/ftp_paradise/connection/ftp_object.rb

@@ -1,21 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/ftp_object.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === ftp_object?
-  # ========================================================================= #
-  def ftp_object?
-    @ftp_object
-  end; alias net_ftp?   ftp_object? # === net_ftp?
-       alias ftp?       ftp_object? # === ftp?
-       alias ftp        ftp_object? # === ftp?
-       alias ftp_object ftp_object? # === ftp_object
-
-end; end

data/lib/ftp_paradise/connection/initialize.rb

@@ -1,88 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/initialize.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  require 'ftp_paradise/base/prototype.rb'
-  include ::FtpParadise::Base
-
-  require 'ftp_paradise/connection/constants.rb' # ← For the constant RUN_ALREADY
-  require 'ftp_paradise/connection/ftp_object.rb'
-  require 'ftp_paradise/connection/reset.rb'
-  require 'ftp_paradise/connection/run.rb'
-  require 'ftp_paradise/connection/set_input.rb'
-  require 'ftp_paradise/connection/remote_url.rb'
-  require 'ftp_paradise/connection/use_default_dataset.rb'
-
-  # ========================================================================= #
-  # === initialize
-  #
-  # The first argument to this method should be the remote host's URL.
-  # ========================================================================= #
-  def initialize(
-      i           = ARGV,
-      run_already = RUN_ALREADY
-    )
-    reset
-    # ======================================================================= #
-    # - If we pass in a Hash as the first argument, then we will use
-    #   set_data(), otherwise we will set individually it all individually.
-    # ======================================================================= #
-    if i.is_a? Hash
-      set_data(i)
-    else
-      set_input(i)
-    end
-    case i
-    when :dont_run_yet,
-         :do_not_run_yet
-      run_already = false
-    end
-    case run_already
-    when :dont_run_yet
-      run_already = false
-    end
-    if run_already.is_a? Hash
-      _ = run_already
-      if _.has_key? :connect_to_this_host
-        set_this_host(
-          _.delete(:connect_to_this_host)
-        )
-      end
-      run_already = RUN_ALREADY # Restore to the default in this case.
-    end
-    if block_given?
-      yielded = yield
-      case yielded
-      # ===================================================================== #
-      # === :do_not_run_yet
-      # ===================================================================== #
-      when :do_not_run_yet
-        run_already = false
-      # ===================================================================== #
-      # The "default" dataset defaults to my personal FTP login dataset.
-      # ===================================================================== #
-      when :use_default_dataset,
-           :default_dataset,
-           :default
-        use_default_dataset
-      end
-    end
-    run if run_already
-  end
-
-  # ========================================================================= #
-  # === initialize_a_new_net_ftp_object_with_this_remote_url
-  #
-  # This method is the only one allowed to create a new Net::FTP instance.
-  # ========================================================================= #
-  def initialize_a_new_net_ftp_object_with_this_remote_url(i)
-    @ftp_object = Net::FTP.new(i) # ftp = Net::FTP.new(YAML.load_file(ENV['FTP_YAML_FILE'])['freehosting']['url'])
-  end; alias initialize_a_new_net_ftp_object initialize_a_new_net_ftp_object_with_this_remote_url # === initialize_a_new_net_ftp_object
-
-end; end

data/lib/ftp_paradise/connection/initialize_a_new_net_ftp_object_with_this_url.rb

@@ -1,20 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/initialize_a_new_net_ftp_object_with_this_url.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  require 'net/ftp'
-
-  # ========================================================================= #
-  # === initialize_a_new_net_ftp_object_with_this_url
-  # ========================================================================= #
-  def initialize_a_new_net_ftp_object_with_this_url(this_url)
-    @ftp_object = Net::FTP.new(this_url)
-  end
-
-end; end

data/lib/ftp_paradise/connection/is_connected.rb

@@ -1,46 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/is_connected.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  require 'ftp_paradise/connection/ftp_object.rb'
-
-  # ========================================================================= #
-  # === closed?
-  #
-  # Returns true if the connection to our remote host is closed.
-  # ========================================================================= #
-  def closed?
-    begin
-      ftp_object?.closed? if ftp_object?
-    rescue Net::FTPConnectionError
-      true
-    end
-  end
-
-  # ========================================================================= #
-  # === open?
-  #
-  # This method can also be used to determine whether we are still
-  # connected to the remote site.
-  #
-  # This method will return true if the connection is open.
-  #
-  # If you want to determine whether you are still connected to the
-  # remote host, you can alias use the alias are_we_connected? - it
-  # may read nicer.
-  # ========================================================================= #
-  def open?
-    !closed?
-  end; alias are_we_connected? open? # === are_we_connected?
-       alias is_connected?     open? # === is_connected?
-       alias is_connected      open? # === is_connected
-       alias connected?        open? # === connected?
-       alias did_we_connect?   open? # === did_we_connect?
-
-end; end