ftp_paradise 1.4.5 → 1.5.3

data/lib/ftp_paradise/interactive_ftp/run.rb

@@ -1,22 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/run.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp # === FtpParadise::InteractiveFtp
-
-  # ========================================================================= #
-  # === run
-  # ========================================================================= #
-  def run
-    set_passive :be_verbose
-    pass_commandline_arguments_into_the_menu # <- Must come before startup_actions().
-    startup_actions
-    do_login # Next, login.
-    enter_main_loop
-  end
-
-end; end

data/lib/ftp_paradise/interactive_ftp/show.rb

@@ -1,184 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/show.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp
-
-  # ========================================================================= #
-  # === show_remote_directories
-  # ========================================================================= #
-  def show_remote_directories
-    e "The remote directories at #{sdir(return_remote_pwd)} are:"
-    e
-    ftp?.return_remote_directories.each_with_index {|dir, index|
-      index += 1
-      e index.to_s.rjust(3)+') '+sdir(dir)
-    }
-    e
-  end
-
-  # ========================================================================= #
-  # === show_remote_files
-  #
-  # Use this method to show all remote files on a FTP site.
-  # ========================================================================= #
-  def show_remote_files(
-      mode = nil
-    ) # Show the content of the remote host.
-    ftp?.show_remote_files
-  end
-
-  # ========================================================================= #
-  # === show_hosts
-  # ========================================================================= #
-  def show_hosts
-    e "The available hosts are:#{N}#{N}"
-    ftp?.array_available_hosts.each {|host|
-      e simp("  #{host}")
-    }; e
-  end
-
-  # ========================================================================= #
-  # === show_remote_listing
-  #
-  # This will display the remote file listing.
-  # ========================================================================= #
-  def show_remote_listing
-    ftp?.show_remote_listing
-  end
-
-  # ========================================================================= #
-  # === show_status
-  # ========================================================================= #
-  def show_status
-    cliner {
-      # e
-      # show_help # <- Disabled as of May 2017.
-      e
-      report_where_we_are_connected_to
-      report_remote_directory # Added Dec 2011.
-      report_local_dir
-      # debug_it
-      e
-    }
-  end
-
-  # ========================================================================= #
-  # === show_title
-  #
-  # Use this method to give us the title
-  # ========================================================================= #
-  def show_title
-    e return_title
-  end
-
-  # ========================================================================= #
-  # === show_history
-  #
-  # This method can be used to display the input-history of the user.
-  # ========================================================================= #
-  def show_history # History tag.
-    e "The history for #{sfancy(return_title)} is:"
-    @history.each_with_index { |key, index|
-      e '%3s' % (index+1).to_s+' '+key
-    }
-  end
-
-  # ========================================================================= #
-  # === show_which_files_we_did_download_so_far
-  # ========================================================================= #
-  def show_which_files_we_did_download_so_far
-    if @array_downloaded_files.empty?
-      e 'We did not yet download any file.'
-    else
-      e 'We downloaded these files so far:'
-      pp @array_downloaded_files
-    end
-  end
-
-  # ========================================================================= #
-  # === show_ftp_docu
-  #
-  # This method will show where to find ruby's ftp docu.
-  # ========================================================================= #
-  def show_ftp_docu
-    e
-    e '  https://www.ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html'
-    e
-  end
-
-  # ========================================================================= #
-  # === show_ftp_yaml_file
-  # ========================================================================= #
-  def show_ftp_yaml_file
-    e 'The yaml file in question can be found at:'
-    e
-    e "  #{sfile(FILE_ROEBE_FTP)}"
-    e
-  end
-
-  # ========================================================================= #
-  # === show_modtime_of
-  # ========================================================================= #
-  def show_modtime_of(i)
-    e "The modification time of #{sfile(i)} is:"
-    e
-    e '  '+sfancy(ftp?.modification_time_of?(i))
-    e
-  end
-
-  # ========================================================================= #
-  # === display_configuration_options                       (show config tag)
-  #
-  # This method will show the configuration settings.
-  #
-  # You can invoke this in an interactive FTP session by doing this:
-  #
-  #   config?
-  #
-  # ========================================================================= #
-  def display_configuration_options # Config tag.
-    cliner {
-      if @file.to_s.empty?
-        e '@file is: unassigned as of yet'
-      else
-        e '@file is: '+sfancy(@file.to_s)
-      end
-      e '@local_directory is: '+sfancy(@local_directory.to_s)
-      e '@splitted is: '+sfancy(@splitted.to_s)
-      e 'Will we use the Readline module? '+
-        sfancy(verbose_truth(use_readline?))
-      e 'Will we show full names (with full path)? '+
-         sfancy(verbose_truth(show_full_names?))
-      e 'What is the base directory? '+
-         sfancy(@config.base_directory.to_s)
-    }
-  end
-
-  # ========================================================================= #
-  # === show_available_connections
-  # ========================================================================= #
-  def show_available_connections(
-      i = ARRAY_AVAILABLE_HOSTS
-    )
-    i.each_with_index {|entry, index|
-      e "#{index} #{entry}"
-    } if Object.const_defined? :RoebeFtpConstants
-  end
-
-  # ========================================================================= #
-  # === show_www_component
-  # ========================================================================= #
-  def show_www_component
-    e 'Make sure to visit:'
-    path = '$RSRC/ftp_paradise/lib/ftp_paradise/www/sinatra_web_interface.rb'
-    e "  #{sfancy(path)}"
-    _ = get_env_of("ruby #{path}")
-    esystem _
-  end
-
-end; end

data/lib/ftp_paradise/interactive_ftp/upload.rb

@@ -1,90 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/upload.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp # === FtpParadise::Interactive
-
-  # ========================================================================= #
-  # === upload                                                 (upload tag)
-  #
-  # Use this method to upload something locally to the remote site.
-  #
-  # You can also upload several files in one go - to do this, try
-  # one of these ways:
-  #
-  #   upload 7,8 # This would upload file position 7 and 8.
-  #   upload 1..293
-  #
-  # ========================================================================= #
-  def upload(
-      i = Dir['*']
-    )
-    # ======================================================================= #
-    # We will always work with an Array past the following point.
-    # ======================================================================= #
-    i = [i].flatten.compact # Safeguard against nil.
-    if i.empty?
-      i << @file if @file
-    end
-    i.map! {|entry|
-      if entry.include?('-') and !entry.include?('.') # Assume a range was given like 1-20.
-        splitted = entry.split('-')
-        entry = (splitted[0] .. splitted[1]).to_a
-      elsif entry.include?('..') # Assume a range such as: upload 1..25
-        entry =~ /(\d+)\.\.(\d+)/
-        start_position = $1.to_s.dup.to_i 
-        end_position   = $2.to_s.dup.to_i
-        entry = return_local_files[start_position, end_position]
-      elsif entry.include?(',')
-        splitted = i.split(',')
-        entry = (splitted[0] .. splitted[1]).to_a
-      elsif (entry == 'ALL') or (entry == '*')
-        entry = Dir['*']
-      elsif entry.include?('*.') or entry.include?('*')
-        entry = Dir[entry]
-      end
-      entry
-    }
-    i.flatten!
-    i.compact!
-    if on_roebe? and !is_connected?
-      connect_to :shevy
-    end
-    i.each {|this_file|
-      if this_file =~ /^\d+$/ # upload only a specific number.
-        sorted = Dir['*'].sort
-        if i.is_a? Array
-          i = i.first
-        end
-        this_file = sorted[i.to_i - 1]
-      end
-      _ = this_file # default to upload to 'all'
-      if File.exist?(_)
-        # =================================================================== #
-        # Next, some files will always be in binary mode. These are
-        # defined in the Array ARRAY_BINARY_FILES.
-        # =================================================================== #
-        if ARRAY_BINARY_FILES.include?(File.extname(_).delete('.')) and
-          (@mode != :binary)
-          use_binary_mode
-        end
-        case @mode
-        when :ascii
-          set_file(_)
-          ftp?.upload(_) # And now, call the functionality in the FTP lib.
-        else
-          ftp?.upload_binary(_)
-        end
-      else
-        opne swarn('But the file `')+
-             sfile(i)+
-             swarn('` does not exist.')
-      end
-    }
-  end
-
-end; end

data/lib/ftp_paradise/interactive_ftp/user_input.rb

@@ -1,53 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/interactive_ftp/user_input.rb'
-# =========================================================================== #
-module FtpParadise
-
-class InteractiveFtp # === FtpParadise::InteractiveFtp
-
-  # ========================================================================= #
-  # === obtain_user_input
-  #  
-  # This method will obtain user input, and assign it to the variable
-  # @user_input.
-  # ========================================================================= #
-  def obtain_user_input
-    if @use_readline
-      user_input = Readline.readline('', true)
-      Readline::HISTORY.pop if user_input.strip.empty?
-    else
-      user_input = $stdin.gets.chomp
-    end
-    # ======================================================================= #
-    # Get rid of potential '#' comments in the input.
-    # ======================================================================= #
-    if user_input.include? '#'
-      user_input = user_input[0 .. user_input.index('#')-1]
-    end
-    user_input.strip! # Get rid of ' ' empty characters.
-    _ = user_input
-    unless _.empty? # append to history.
-      try_to_append_this_to_the_history(_)
-    end
-    # ======================================================================= #
-    # If the user did input a ';' character then we will assume that he
-    # wants to send multiple commands. We will however NOT assume so
-    # if the string also includes a 'http://' - in that case, we assume
-    # a HTTP URL instead.
-    # ======================================================================= #
-    if user_input.include? ';' and !user_input.include?('http://')
-      user_input = user_input.split(';')
-    else
-      user_input = [user_input] # In this case simply turn it into an Array. 
-    end
-    # ======================================================================= #
-    # The @user_input variable should always be an Array.
-    # ======================================================================= #
-    @user_input = user_input
-  end; alias get_user_input   obtain_user_input # === get_user_input
-       alias fetch_user_input obtain_user_input # === fetch_user_input
-
-end; end

data/lib/ftp_paradise/toplevel_methods/can_connect_to_remote_site.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/toplevel_methods/can_connect_to_remote_site.rb'
-# =========================================================================== #
-module FtpParadise
-
-  # ========================================================================= #
-  # === FtpParadise.can_connect_to_remote_site?
-  #
-  # This method can be used to query whether we can connect to a remote
-  # website via the FtpParadise project.
-  #
-  # The method will return a boolean: either true or false.
-  # ========================================================================= #
-  def self.can_connect_to_remote_site?
-    require 'ftp_paradise/connection/connection.rb'
-    ftp = FtpParadise::Connection.new(:dont_run_yet) { :use_default_dataset }
-    ftp.be_quiet
-    return ftp.is_connected?
-  end
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  p FtpParadise.can_connect_to_remote_site?
-end

data/lib/ftp_paradise/toplevel_methods/clear_user_dataset.rb

@@ -1,28 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/toplevel_methods/clear_user_dataset.rb'
-# =========================================================================== #
-module FtpParadise
-
-  require 'ftp_paradise/toplevel_methods/login_name.rb'
-  require 'ftp_paradise/toplevel_methods/password.rb'
-  require 'ftp_paradise/toplevel_methods/remote_url.rb'
-
-  # ========================================================================= #
-  # === FtpParadise.clear_user_dataset
-  #
-  # This method will reset the user-dataset to nil again, that is,
-  # user name, password and remote url.
-  #
-  # This method had to be added so that we can easily clean-up on
-  # a disconnect-action.
-  # ========================================================================= #
-  def self.clear_user_dataset
-    FtpParadise.set_remote_url(nil)
-    FtpParadise.set_user_name(nil)
-    FtpParadise.set_password(nil)
-  end
-
-end

data/lib/ftp_paradise/toplevel_methods/data.rb

@@ -1,31 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/toplevel_methods/data.rb'
-# =========================================================================== #
-module FtpParadise
-
-  require 'ftp_paradise/toplevel_methods/login_name.rb'
-  require 'ftp_paradise/toplevel_methods/password.rb'
-  require 'ftp_paradise/toplevel_methods/remote_url.rb'
-
-  # ========================================================================= #
-  # === FtpParadise.data?
-  #
-  # This method will return the name of the user; the password; and the
-  # remote URL. It is mostly just a convenience method.
-  # ========================================================================= #
-  def self.data?
-    {
-      user_name:  FtpParadise.username?,
-      password:   FtpParadise.password?,
-      remote_url: FtpParadise.remote_url?
-    }
-  end; self.instance_eval { alias dataset? data? } # === FtpParadise.dataset?
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  pp FtpParadise.data?
-end

data/lib/ftp_paradise/toplevel_methods/determine_user_dataset_from_this_hash.rb

@@ -1,37 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/toplevel_methods/determine_user_dataset_from_this_hash.rb'
-# =========================================================================== #
-module FtpParadise
-
-  require 'ftp_paradise/toplevel_methods/login_name.rb'
-  require 'ftp_paradise/toplevel_methods/remote_url.rb'
-  require 'ftp_paradise/toplevel_methods/password.rb'
-
-  # ========================================================================= #
-  # === FtpParadise.determine_user_dataset_from_this_hash
-  #
-  # This method can set relevant entries from an input Hash.
-  #
-  # The IDs should be 'url', 'user_name' and 'password'.
-  # ========================================================================= #
-  def self.determine_user_dataset_from_this_hash(i)
-    if i.is_a? Hash
-      if i.has_key? 'url'
-        _ = i.fetch('url')
-        FtpParadise.set_remote_url(_)
-      end
-      if i.has_key? 'user_name'
-        _ = i.fetch('user_name')
-        FtpParadise.set_user_name(_)
-      end
-      if i.has_key? 'password'
-        _ = i.fetch('password')
-        FtpParadise.set_password(_)
-      end
-    end
-  end
-
-end