ftp_paradise 1.4.5

data/lib/ftp_paradise/colours/use_colours.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/colours/use_colours.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/configuration/configuration.rb'
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === @configuration
+  #
+  # Let's initialize the configuration here, if we have not yet
+  # done so.
+  # ========================================================================= #
+  if @configuration.nil? and FtpParadise.respond_to?(:initialize_configuration)
+    FtpParadise.initialize_configuration
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.use_colours?
+  #
+  # This can be delegated towards the configuration object.
+  # ========================================================================= #
+  def self.use_colours?
+    if FtpParadise.respond_to?(:config?) and
+       FtpParadise.config?.respond_to?(:use_colours)
+      FtpParadise.config?.use_colours
+    else
+      true
+    end
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.disable_colours
+  #
+  # Use this method to disable colours.
+  # ========================================================================= #
+  def self.disable_colours
+    FtpParadise.config?.use_colours = false
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  #
+  # Whether we will use colours or whether we will not.
+  # ========================================================================= #
+  def use_colours?
+    FtpParadise.use_colours?
+  end
+
+  # ========================================================================= #
+  # === If we use colours in this project
+  # ========================================================================= #
+  if use_colours?
+    # ======================================================================= #
+    # And we can also set the default-colours to use.
+    # ======================================================================= #
+    if Object.const_defined?(:Colours) and
+       Colours.respond_to?(:assign_new_colour_codes)
+      Colours.update_the_colour_codes_with({
+        default_colour: :green,
+        sfile:          :brown,
+        sdir:           :chocolate,
+        swarn:          :red,
+        simportant:     :bold_yellow,
+      })
+    end
+  end
+
+end

data/lib/ftp_paradise/configuration/configuration.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# require 'ftp_paradise/configuration/configuration.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/project/project.rb'
+
+  begin # Try to make use of Roebe::Configuration next.
+    require 'roebe/configuration/configuration.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === @configuration
+  # ========================================================================= #
+  @configuration = nil
+
+  # ========================================================================= #
+  # === FtpParadise.initialize
+  #
+  # This method will assign to the general configuration object stored
+  # in the variable @configuration.
+  # ========================================================================= #
+  def self.initialize
+    if Object.const_defined? :Roebe
+      # ===================================================================== #
+      # Load up all .yml files from the path to the yaml directory:
+      # ===================================================================== #
+      @configuration = ::Roebe::Configuration::Configuration.new(FtpParadise.yaml_directory?)
+    end
+  end; self.instance_eval { alias initialize_configuration initialize } # === FtpParadise.initialize_configuration
+
+  # ========================================================================= #
+  # === Initialize the Configuration object here
+  # ========================================================================= #
+  FtpParadise.initialize_configuration if @configuration
+
+  # ========================================================================= #
+  # === FtpParadise.config?
+  #
+  # Query method towards the Configuration object.
+  # ========================================================================= #
+  def self.config?
+    @configuration
+  end; self.class { alias configuration? config? } # === FtpParadise.configuration?
+
+end

data/lib/ftp_paradise/connection/README.md

@@ -0,0 +1 @@
+This directory contains code for an "FTP connection".

data/lib/ftp_paradise/connection/connection.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This is the "connection class". It will have methods that can be use
+# when we are connected to a remote site (via the FTP protocol).
+#
+# Rather than keeping FTP-related state within this class, such as remote
+# URL and such, we will instead use FtpParadise module methods.
+# =========================================================================== #
+# Possible errors and failures when we are trying to connect:
+#
+#   Net::FTPPermError: 530 Please login with USER and PASS.
+#
+#   Net::FTPConnectionError is raised if we are no longer connected to
+#   the remote FTP site.
+#
+#   Errno::ETIMEDOUT is raised when a timeout event occurred.
+# =========================================================================== #
+# The official documentation for Ruby-FTP can be found here:
+#
+#   https://ruby-doc.org/stdlib/libdoc/net/ftp/rdoc/Net/FTP.html
+#
+# =========================================================================== #
+require 'ftp_paradise/connection/initialize.rb'
+require 'ftp_paradise/connection/data.rb'
+require 'ftp_paradise/connection/debug.rb'
+require 'ftp_paradise/connection/misc.rb'
+require 'ftp_paradise/connection/notify.rb'
+require 'ftp_paradise/connection/remote_pwd.rb'
+require 'ftp_paradise/connection/remove.rb'
+require 'ftp_paradise/connection/show.rb'
+require 'ftp_paradise/connection/upload.rb'
+require 'ftp_paradise/version/version.rb'
+require 'ftp_paradise/configuration/configuration.rb'

data/lib/ftp_paradise/connection/constants.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/constants.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === BE_VERBOSE
+  # ========================================================================= #
+  BE_VERBOSE = true
+
+  # ========================================================================= #
+  # === DEFAULT_TRANSFER_MODE
+  # ========================================================================= #
+  DEFAULT_TRANSFER_MODE = :ascii # Which transfer mode to use by default.
+
+  # ========================================================================= #
+  # === DEFAULT_PORT
+  # ========================================================================= #
+  DEFAULT_PORT = 21
+
+  # ========================================================================= #
+  # === RUN_ALREADY
+  # ========================================================================= #
+  RUN_ALREADY = true
+
+  # ========================================================================= #
+  # === DEFAULT_USER_NAME
+  #
+  # In the past this was set to a String (the user name); but since as
+  # of October 2018, it will default to nil, so that we really initialize
+  # the whole project to a nil-state (as the default). This thus allows
+  # us to determine whether this has been changed, aka initialized.
+  # ========================================================================= # 
+  DEFAULT_USER_NAME = nil
+
+end; end

data/lib/ftp_paradise/connection/data.rb

@@ -0,0 +1,164 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/data.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection
+
+  require 'ftp_paradise/constants/roebe.rb'
+
+  # ========================================================================= #
+  # === set_data                                   (all in one, set_data tag)
+  #
+  # This method sets:
+  #
+  #   - host
+  #   - user name
+  #   - port and
+  #   - password
+  #
+  # This method is thus a nifty little convenience method. You can pass
+  # a hash to it too, which is the recommended way to use this method.
+  #
+  # You can also use an Array (with 4 elements), in which case we will
+  # process it one after the other. The reason for this procedure is
+  # because we can also use yaml files that way, that also use the
+  # exact order of elements.
+  #
+  # If you add a new entry to the case menu below, also add this to 
+  # ARRAY_AVAILABLE_HOSTS, please. That Array can be found in the
+  # file 'constants/roebe_ftp_constants.rb'.
+  # ========================================================================= #
+  def set_data(
+      i = 'default'
+    ) # set the default here.
+    if debug?
+      opnn; e 'We will debug next, as the @debug variable was set to true.'
+      pp i
+    end
+    # ======================================================================= #
+    # === Handle Hash as input first
+    # ======================================================================= #
+    if i.is_a? Hash # Hash is treated differently.
+
+      # ===================================================================== #
+      # === :host
+      # ===================================================================== #
+      if   i.has_key? :host
+        set_host i.fetch(:host)
+      elsif i.has_key? :remote_host
+        set_host i.fetch(:remote_host)
+      elsif i.has_key? :to # :to is an alias to :host.
+        set_host i.fetch(:to)
+      end      
+
+      # ===================================================================== #
+      # === :user_name
+      # ===================================================================== #
+      if    i.has_key? :user_name
+        set_user_name i.fetch(:user_name)
+      elsif i.has_key? :login_name
+        set_user_name i.fetch(:login_name)
+      end
+
+      # ===================================================================== #
+      # === :password
+      # ===================================================================== #
+      if i.has_key? :password
+        set_password i.fetch(:password)
+      elsif i.has_key? :login_password
+        set_password i.fetch(:login_password)
+      end
+
+      # ===================================================================== #
+      # === :port
+      # ===================================================================== #
+      if i.has_key? :port
+        set_port i.fetch(:port)
+      end
+    # ======================================================================= #
+    # === Handle Array as input next
+    # ======================================================================= #
+    elsif i.is_a? Array # Example-Array: ["ftp.byethost33.com", "b33_14144659", "1aaaaaa", 21]
+      set_host      i.first
+      set_user_name i[1]
+      set_password  i[2]
+      set_port      i[3]
+    # ======================================================================= #
+    # === Else, use simple toggle commands, such as 1,2,3,4,5 and so forth.
+    # ======================================================================= #
+    else # In the following case menu you can toggle your FTP.
+      case i.to_s # Work on strings only. Assumes shortcuts.
+      # ===================================================================== #
+      # === shevy
+      #
+      # This defaults to my home system.
+      # ===================================================================== #
+      when '6',
+           /shevy/i,
+           'square',
+           'square7',
+           'bplaced',
+           'podserver',
+           'default',
+           'top' # Current default.
+        _ = FILE_ROEBE_FTP
+        if File.exist? _
+          data = YAML.load_file(_)['podserver'] # 'bplaced'
+          set_host      data['url']
+          set_user_name data['user_name']
+          this_password = data['password']
+          this_password.chop! if this_password.end_with? '_'
+          set_password  this_password
+          set_port      data['port']
+        end
+      # ===================================================================== #
+      # === a1
+      # ===================================================================== #
+      when '1',
+           'a1',
+           'a1_ftp' # A1 FTP host. No longer in use but still kept.
+        set_host      A1.first
+        set_user_name A1[1]
+        set_password  A1[2]
+        set_port      A1[3]
+      # ===================================================================== #
+      # === zymix
+      # ===================================================================== #
+      when '2',
+           'zymix',
+           'standard'
+        set_host      ZYMIX.first
+        set_user_name ZYMIX[1]
+        set_password  ZYMIX[2]
+        set_port      ZYMIX[3]
+      # ===================================================================== #
+      # === uniwien
+      # ===================================================================== #
+      when '3',
+           'univie',
+           'uniwien' # Uni Wien FTP Account.
+        set_host      UNIVIE.first
+        set_user_name UNIVIE[1]
+        set_password  UNIVIE[2]
+        set_port      UNIVIE[3]
+      # ===================================================================== #
+      # === byte
+      # ===================================================================== #
+      when '4',
+           'byte',
+           'bytehost'
+        set_host      BYTEHOST.first
+        set_user_name BYTEHOST[1]
+        set_password  BYTEHOST[2]
+        set_port      BYTEHOST[3]
+      else
+        set_data(:default) # Go back to default again if not found.
+      end
+    end
+  end
+
+end; end

data/lib/ftp_paradise/connection/debug.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/connection/debug.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Connection
+
+  # ========================================================================= #
+  # === set_debug
+  # ========================================================================= #
+  def set_debug(i = SHALL_WE_DEBUG)
+    @internal_hash[:debug] = i
+  end
+
+  # ========================================================================= #
+  # === enable_debug_mode
+  #
+  # When the debug mode is set to true, then all traffic to and from
+  # the server is written to $stdout. By default, this will NOT
+  # be the case.
+  # ========================================================================= #
+  def enable_debug_mode
+    ftp_object?.debug_mode = true
+  end
+
+  # ========================================================================= #
+  # === enable_debug
+  #
+  # Set the @debug variable to true, and also invoke enable_debug_mode().
+  # ========================================================================= #
+  def enable_debug
+    enable_debug_mode
+    set_debug(true)
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    @internal_hash[:debug]
+  end
+
+  # ========================================================================= #
+  # === disable_debug
+  # ========================================================================= #
+  def disable_debug
+    ftp_object?.debug_mode = false
+    @internal_hash[:debug] = false
+  end
+
+  # ========================================================================= #
+  # === debug                                                     (debug tag)
+  #
+  # This method can be used for some debugging output.
+  # ========================================================================= #
+  def debug(
+      shall_we_debug = debug?
+    )
+    cliner {
+      pp ftp?
+      show_host_user_name_port_and_password
+      update_file_listing
+      if shall_we_debug
+        opnn; e 'File Listing:'
+        show_file_listing
+      end
+      if remote_file_listing?.empty?
+        opnn; e 'No file could be found. The remote directory '\
+                'is most likely empty.'
+      end
+    } if shall_we_debug
+  end; alias feedback debug # === feedback
+       alias report   debug # === report
+
+end; end