ftp_paradise 1.4.5 → 1.5.3

data/lib/ftp_paradise/connection/transfer_mode.rb

@@ -1,163 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/transfer_mode.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection
-
-  # ========================================================================= #
-  # === set_passive_mode
-  #
-  # Use this when modifying the passive setting.
-  # ========================================================================= #
-  def set_passive_mode
-    set_transfer_mode :ascii
-    ftp_object?.passive = true if ftp_object?
-  end; alias set_passive set_passive_mode # === set_passive
-
-  # ========================================================================= #
-  # === set_default_transfer_mode
-  # ========================================================================= #
-  def set_default_transfer_mode(
-      be_verbose = :be_quiet
-    )
-    set_transfer_mode(DEFAULT_TRANSFER_MODE, be_verbose)
-  end
-
-  # ========================================================================= #
-  # === set_transfer_mode
-  #
-  # This method will set to either one of two different possibles modes:
-  #
-  #   (1) :ascii
-  #   (2) :binary
-  #   (3) :passive
-  #
-  # Note that :passive "mode" is ascii, with an additional invocation to
-  # change the transfer mode to .passive.
-  #
-  # It will also change passive mode. The argument :default will default
-  # to the more commonly used ASCII mode.
-  #
-  # When would you want to use ASCII mode?
-  #
-  # Use ascii mode for:
-  #
-  #   txt, rtf, html, php
-  #
-  # Use binary mode for:
-  #
-  #   images, videos and similar.
-  #
-  # ========================================================================= #
-  def set_transfer_mode(
-      i          = DEFAULT_TRANSFER_MODE, # Will usually default to :ascii
-      be_verbose = be_verbose?
-    )
-    case be_verbose
-    when :be_verbose
-      be_verbose = true
-    when :be_quiet
-      be_verbose = false
-    end
-    i = :ascii if i == :default
-    case i
-    # ======================================================================= #
-    # === :ascii
-    # ======================================================================= #
-    when :ascii
-      notify_the_user_about(i, __method__) if be_verbose
-      @internal_hash[:transfer_mode] = :ascii
-      ftp_object?.binary = false if ftp_object?
-    # ======================================================================= #
-    # === :binary
-    # ======================================================================= #
-    when :binary
-      notify_the_user_about(i, __method__) if be_verbose
-      @internal_hash[:transfer_mode] = :binary
-    # ======================================================================= #
-    # === :passive
-    # ======================================================================= #
-    when :passive,
-         :pass
-      notify_the_user_about(i, __method__) if be_verbose
-      @internal_hash[:transfer_mode] = :ascii
-      ftp_object?.passive = true if ftp_object?
-    else
-      opnn; e swarn('Not found the following mode: ')+
-              sfancy(i.to_s)
-    end
-  end; alias mode_to_use= set_transfer_mode # === mode_to_use=
-       alias set_mode     set_transfer_mode # === set_mode
-
-  # ========================================================================= #
-  # === report_transfer_mode_in_use
-  # ========================================================================= #
-  def report_transfer_mode_in_use
-    e "Transfer mode: #{sfancy(transfer_mode?.to_s)}"
-  end
-
-  # ========================================================================= #
-  # === set_active
-  # ========================================================================= #
-  def set_active
-    ftp_object?.passive = false
-  end
-  
-  # ========================================================================= #
-  # === passive_transfer?
-  # ========================================================================= #
-  def passive_transfer?
-    ftp_object?.passive
-  end; alias passive? passive_transfer? # === passive?
-
-  # ========================================================================= #
-  # === transfer_mode?
-  #
-  # This method will return the currently used transfer_mode. This mode
-  # can be either :binary, or :ascii. By default it will be :binary.
-  #
-  # The transfer mode can be :binary or :text. :ascii is an alias to
-  # :text.
-  # ========================================================================= #
-  def transfer_mode?
-    @internal_hash[:transfer_mode]
-  end; alias transfer_mode transfer_mode? # === transfer_mode
-       alias mode?         transfer_mode? # === mode?
-       alias type          transfer_mode? # === type
-       alias type?         transfer_mode? # === type?
-
-  # ========================================================================= #
-  # === set_ascii
-  #
-  # Easier wrapper method.
-  # ========================================================================= #
-  def set_ascii
-    set_transfer_mode :ascii
-  end; alias set_ascii_mode set_ascii # === set_ascii_mode
-
-  # ========================================================================= #
-  # === binary?
-  #
-  # When this is true, then then all FTP-transfers will be performed in
-  # binary mode.
-  #
-  # Deaults to true.
-  # ========================================================================= #
-  def binary?
-    ftp_object?.binary
-  end; alias binary binary? # === binary
-
-  # ========================================================================= #
-  # === set_binary_mode
-  # ========================================================================= #
-  def set_binary_mode
-    set_transfer_mode :binary
-    ftp_object?.binary = true
-  end; alias set_binary         set_binary_mode # === set_binary
-       alias set_to_binary_mode set_binary_mode # === set_to_binary_mode
-
-end; end

data/lib/ftp_paradise/connection/upload.rb

@@ -1,253 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/upload.rb'
-# =========================================================================== #
-module FtpParadise
-        
-class Connection
-
-  require 'ftp_paradise/connection/remote_pwd.rb'
-  require 'ftp_paradise/connection/is_connected.rb'
-
-  # ========================================================================= #
-  # === upload_binary_file
-  #
-  # Use this method to upload a binary file to a remote host.
-  #
-  # The first argument `i` is the file that we wish to upload.
-  #
-  # The method will make use of the method .putbinaryfile().
-  #
-  # Documentation for that file can be found here:
-  #
-  #   https://ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html#method-i-putbinaryfile
-  #
-  # ========================================================================= #
-  def upload_binary_file(
-      i,
-      be_verbose = be_verbose?
-    )
-    be_verbose = false if be_verbose == :be_silent
-    if i.is_a? Array
-      i.each {|entry| upload_binary_file(entry, be_verbose) }
-    else
-      i = i.strip.delete(N) # Added Feb 2014.
-      if be_verbose
-        notify_the_user_about(i, __method__)
-      end
-      begin
-        # =================================================================== #
-        # Next we will delegate towards the @ftp_object:
-        # =================================================================== #
-        ftp_object?.putbinaryfile(i) # We will use the method .putbinaryfile()
-        @internal_hash[:uploaded_these_files] << i
-        if be_verbose
-          remote_path = rds(remote_path?+'/'+File.basename(i))
-          e 'Done uploading! The remote path is: '
-          e "  #{simp(remote_path)}"
-          report_finished_uploading_of_this_file(i)
-        end
-      rescue Exception => error
-        e 'An error happened as we tried to use the method '+simp('upload_binary()')+'.'
-        e 'The method we used was: '+simp('ftp?.putbinaryfile(i)')
-        e 'We will feedback this error now (of class '+sfancy(error.class.to_s)+'):'
-        pp error
-      end
-    end
-  end; alias upload_binary           upload_binary_file # === upload_binary
-       alias upload_this_binary_file upload_binary_file # === upload_this_binary_file()
-
-  # ========================================================================= #
-  # === upload_file
-  #
-  # This method will distinguish between a binary file or a text file,
-  # based on the transfer mode in use. The default is to work on a
-  # text file.
-  # ========================================================================= #
-  def upload_file(
-      i,
-      be_verbose = be_verbose?
-    )
-    if File.exist? i
-      case transfer_mode?
-      # ===================================================================== #
-      # === :ascii
-      # ===================================================================== #
-      when :ascii,
-           :text,
-           :default
-        upload_this_text_file(i, be_verbose)
-      # ===================================================================== #
-      # === :binary
-      # ===================================================================== #
-      when :binary
-        upload_this_binary_file(i, be_verbose)
-      end
-      update_raw_listing(:be_quiet)
-    else
-      opnn; e "No file called `#{sfile(i)}` appears to exist locally." 
-    end
-  end; alias upload_this_file upload_file # === upload_this_file
-
-  # ========================================================================= #
-  # === upload                                                   (upload tag)
-  #
-  # This method can upload binary files, text files and whole directories.
-  # Based on that check, the method body will behave differently, and
-  # delegate to other methods such as upload_directory() or upload_file().
-  #
-  # A single file (as String) can be uploaded, or an Array of files. The
-  # upload activity will transfer the file or the files onto the remote host.
-  #
-  # The second argument specifies whether the method will be verbose and
-  # report back to the user, or whether the method will be quiet,
-  # defaulting to the return value of the method `be_verbose?`.
-  # ========================================================================= #
-  def upload(
-      i,
-      be_verbose = be_verbose?
-    )
-    be_verbose = false if be_verbose == :be_silent
-    if i.is_a? Array
-      i.each {|entry| upload(entry, be_verbose) }
-    else
-      if i == '*' # Here we want to upload all files.
-        i = get_all_local_files
-        upload(i, be_verbose) 
-      else
-        # =================================================================== #
-        # === Handle upload of directories first
-        # =================================================================== #
-        if File.directory? i
-          upload_directory(i, be_verbose)
-        # =================================================================== #
-        # === Handle uploading of files next
-        # =================================================================== #
-        else
-          upload_file(i, be_verbose)
-        end
-      end
-    end
-  end
-
-  # ========================================================================= #
-  # === uploaded_these_files?
-  # ========================================================================= #
-  def uploaded_these_files?
-    @internal_hash[:uploaded_these_files]
-  end
-
-  # ========================================================================= #
-  # === report_finished_uploading_of_this_file
-  #
-  # Report that we have finished uploading a file.
-  #
-  # We should also denote the leading http part.
-  # ========================================================================= #
-  def report_finished_uploading_of_this_file(i)
-    if is_connected?
-      remote_path = "http://#{rds(remote_path?+File.basename(i))}"
-      opnn; e "Done uploading `#{sfile(i)}` to `"\
-              "#{sdir(remote_path)}`!"
-    end
-  end
-
-  # ========================================================================= #
-  # === puttextfile
-  #
-  # This method will transfer a localfile to the remote server in
-  # ASCII (text) mode. The result will be stored in "remotefile".
-  #
-  # If a callback or an associated block is supplied, calls it, passing
-  # in the transmitted data one line at a time.
-  # ========================================================================= #
-  def puttextfile(
-      local_file, remotefile = File.basename(local_file)
-    )
-    begin
-      ftp_object?.puttextfile(local_file)
-      @internal_hash[:uploaded_these_files] << local_file
-    rescue Net::FTPPermError => error
-      opnn; e swarn('Can not upload `')+sfile(local_file)+swarn('`.')
-      opnn; e swarn('Reason provided to this method was:')
-      opnn; e "  → #{sfancy(error.to_s)}"
-    rescue Exception => error
-      opnn; e "An error happened in the method #{__method__}"
-      pp error
-    end
-  end
-
-  # ========================================================================= #
-  # === upload_this_text_file
-  #
-  # This method can be used to upload one or several text files.
-  #
-  # The first argument should be an Array or a String, denoting the
-  # name/path of the local text file that you wish to upload.
-  # ========================================================================= #
-  def upload_this_text_file(
-      i,
-      be_verbose = be_verbose?
-    )
-    be_verbose = false if be_verbose == :be_silent
-    if i.is_a? Array
-      i.each {|entry| upload_this_text_file(entry, be_verbose) }
-    else
-      i = i.strip.delete(N) # Added in February 2014.
-      case i
-      when :default
-        ENV['MISC'].to_s+'/SITEMAP.cgi' # <- Makes only sense for text-files anyway.
-      end
-      case be_verbose
-      when :be_quiet
-        be_verbose = false
-      end
-      if be_verbose
-        notify_the_user_about(i, __method__)
-      end
-      puttextfile(i) # <- Delegate towards the method puttextfile().
-      report_finished_uploading_of_this_file(i) if be_verbose
-    end
-  end
-
-  # ========================================================================= #
-  # === upload_this_directory
-  #
-  # This method can be used to upload a local directory to a remote host.
-  #
-  # If the first input argument is an Array, then the method will call
-  # itself recursively. This allows us to transfer several directories
-  # in one go.
-  #
-  # If the input is a (local and existing) directory, then this method
-  # will also have to create a remote directory, then chdir into it,
-  # and then upload the content of that local directory to the remote
-  # host.
-  # ========================================================================= #
-  def upload_this_directory(
-      i,
-      be_verbose = be_verbose?
-    )
-    if i.is_a? Array
-      i.each {|entry| upload_this_directory(i, be_verbose) }
-    else
-      if File.directory? i
-        unless this_remote_directory_exists?(i)
-          remote_create_directory(i, be_verbose)
-        end
-        change_local_directory(i)
-        change_remote_directory(i)
-        report_remote_directory
-        content = return_directory_content(i) # Last but not least, copy all files to that dir.
-        content.each {|this_file| upload(this_file) }
-      else
-        opnn; e "The given input `#{sfancy(i)}` is not a directory."
-        opnn; e 'This method can only upload directories.'
-      end
-    end
-  end; alias upload_directory         upload_this_directory # === upload_directory
-       alias upload_these_directories upload_this_directory # === upload_these_directories
-
-end; end

data/lib/ftp_paradise/connection/use_default_dataset.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/use_default_dataset.rb'
-# =========================================================================== #
-module FtpParadise
-
-class Connection # === FtpParadise::Connection
-
-  require 'ftp_paradise/toplevel_methods/determine_user_dataset_from_this_hash.rb'
-
-  require 'ftp_paradise/connection/do_login.rb'
-
-  # ========================================================================= #
-  # === use_default_dataset
-  #
-  # This method will just take the default dataset for my FTP connections, 
-  # hence the "File.exist?" check.
-  #
-  # Additionally we will initialize the default net-ftp object.
-  # ========================================================================= #
-  def use_default_dataset(
-      i = 'shevy' # ← This is the default.
-    )
-    if File.exist? FILE_ROEBE_FTP
-      dataset = YAML.load_file(FILE_ROEBE_FTP)
-      # ===================================================================== #
-      # Default to what the user provided to the method.
-      # ===================================================================== #
-      use_this_dataset = dataset[i]
-      # ===================================================================== #
-      # Set remote-url, username and password through the following method:
-      # ===================================================================== #
-      FtpParadise.determine_user_dataset_from_this_hash(use_this_dataset)
-      do_login
-    end
-  end
-
-end; end

data/lib/ftp_paradise/connection/username.rb

@@ -1,42 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/connection/username.rb'
-# =========================================================================== #
-module FtpParadise
-         
-class Connection
-
-  require 'ftp_paradise/toplevel_methods/login_name.rb'
-
-  # ========================================================================= #
-  # === set_username
-  #
-  # Set the username that you wish to use here. If the input is nil, a
-  # default name will be used instead.
-  # ========================================================================= #
-  def set_username(
-      i = DEFAULT_USER_NAME
-    )
-    i = i.first if i.is_a? Array
-    i = DEFAULT_USER_NAME if i.nil?
-    # ======================================================================= #
-    # The username will be stored on the toplevel-module.
-    # ======================================================================= #
-    FtpParadise.set_username(i)
-  end; alias set_user_name  set_username # === set_user_name
-       alias login_name=    set_username # === login_name?
-       alias set_name       set_username # === set_name
-       alias set_user       set_username # === set_user
-       alias set_login_name set_username # === set_login_name
-       alias user_name=     set_username # === user_name?
-
-  # ========================================================================= #
-  # === username?
-  # ========================================================================= #
-  def username?
-    FtpParadise.username?.to_s
-  end; alias user_name? username? # === user_name?
-
-end; end

data/lib/ftp_paradise/constants/misc.rb

@@ -1,57 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen-string-literal: true
-# =========================================================================== #
-# require 'ftp_paradise/constants/misc.rb'
-# =========================================================================== #
-module FtpParadise
-
-  require 'ftp_paradise/project/project.rb'
-
-  # ========================================================================= #
-  # === SHALL_WE_DEBUG
-  # ========================================================================= #
-  SHALL_WE_DEBUG = false
-
-  # ========================================================================= #
-  # === ARRAY_HELP_OPTIONS
-  #
-  # This Array is only required in the interactive variant though.
-  # ========================================================================= #
-  ARRAY_HELP_OPTIONS = %w(
-    HELP --help help hel he h hlep
-  ) # ,'?'
-
-  # ========================================================================= #
-  # === ARRAY_BINARY_FILES
-  #
-  # Just note down the extension names.
-  # ========================================================================= #
-  ARRAY_BINARY_FILES = %w(
-    pdf
-    docx
-    odt
-    doc
-  )
-
-  # ========================================================================= #
-  # === ARRAY_VALID_OPTIONS_FOR_EXITING_THE_SHELL
-  # ========================================================================= #
-  ARRAY_VALID_OPTIONS_FOR_EXITING_THE_SHELL = %w(
-    q
-    quit
-    exit
-    break
-  )
-
-  # ========================================================================= #
-  # === FtpParadise::FILE_AUTOMATICALLY_CONNECT_ON_STARTUP_OF_THE_INTERACTIVE_FTP_SHELL
-  # ========================================================================= #
-  FILE_AUTOMATICALLY_CONNECT_ON_STARTUP_OF_THE_INTERACTIVE_FTP_SHELL =
-    "#{PROJECT_YAML_DIRECTORY}automatically_connect_on_startup_of_the_interactive_ftp_shell.yml"
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  puts FtpParadise::FILE_AUTOMATICALLY_CONNECT_ON_STARTUP_OF_THE_INTERACTIVE_FTP_SHELL
-end

data/lib/ftp_paradise/constants/namespace.rb

@@ -1,14 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/constants/namespace.rb'
-# =========================================================================== #
-module FtpParadise
-
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-end

data/lib/ftp_paradise/constants/newline.rb

@@ -1,14 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen-string-literal: true
-# =========================================================================== #
-# require 'ftp_paradise/constants/newline.rb'
-# =========================================================================== #
-module FtpParadise
-
-  # ========================================================================= #
-  # === N
-  # ========================================================================= #
-  N = "\n"
-
-end

data/lib/ftp_paradise/constants/roebe.rb

@@ -1,31 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'ftp_paradise/constants/roebe.rb'
-# FILE_ROEBE_FTP
-# HOME_DIRECTOY_OF_USER_X
-# =========================================================================== #
-module FtpParadise
-
-  # =========================================================================== #
-  # === HOME_DIRECTORY_OF_USER_X
-  #
-  # This is also only useful on my home setup.
-  # =========================================================================== #
-  HOME_DIRECTORY_OF_USER_X = '/home/x/'
-
-  # =========================================================================== #
-  # === FILE_ROEBE_FTP
-  #
-  # In theory you could change this if you use a similar .yml file.
-  #
-  # This will, on my home directory, expand to:
-  #
-  #   /home/x/DATA/PC/OS/LINUX/FTP/YAML/roebe_ftp.yml
-  #
-  # =========================================================================== #
-  FILE_ROEBE_FTP =
-    "#{HOME_DIRECTORY_OF_USER_X}DATA/PC/OS/LINUX/FTP/YAML/roebe_ftp.yml"
-
-end