ftp_paradise 1.4.5 → 1.5.4

data/lib/ftp_paradise/toplevel_methods/connect.rb

@@ -34,6 +34,9 @@ module FtpParadise
       &block
     )
     case remote_host
+    # ======================================================================= #
+    # === :dont_run_yet
+    # ======================================================================= #
     when :dont_run_yet
       remote_host = :default
       run_already = false

data/lib/ftp_paradise/toplevel_methods/dataset.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/dataset.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/toplevel_methods/login_name.rb'
+  require 'ftp_paradise/toplevel_methods/password.rb'
+  require 'ftp_paradise/toplevel_methods/port.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
+
+  # ========================================================================= #
+  # === 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?,
+      port:       FtpParadise.port?
+    }
+  end; self.instance_eval { alias dataset?   data? } # === FtpParadise.dataset?
+       self.instance_eval { alias main_hash? data? } # === FtpParadise.main_hash?
+       self.instance_eval { alias info?      data? } # === FtpParadise.info?
+
+  # ========================================================================= #
+  # === FtpParadise.determine_user_dataset_from_this_hash
+  #
+  # This method can set relevant entries from an input Hash.
+  #
+  # The IDs should be 'url', 'user_name', 'password' and 'port'.
+  #
+  # Usage example:
+  #
+  #   FtpParadise.determine_user_dataset_from_this_hash(YAML.load_file(FtpParadise.my_yaml_file), :default)
+  #
+  # ========================================================================= #
+  def self.determine_user_dataset_from_this_hash(
+      i, optional_use_this_entry = nil
+    )
+    case optional_use_this_entry
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      optional_use_this_entry = 'bplaced'
+    end
+    if i.is_a? Hash
+      if optional_use_this_entry and i.has_key?(optional_use_this_entry)
+        i = i[optional_use_this_entry]
+      end
+      # ===================================================================== #
+      # === url
+      # ===================================================================== #
+      if i.has_key? 'url'
+        _ = i.fetch('url')
+        FtpParadise.set_remote_url(_)
+      end
+      # ===================================================================== #
+      # === user_name
+      # ===================================================================== #
+      if i.has_key? 'user_name'
+        _ = i.fetch('user_name')
+        FtpParadise.set_user_name(_)
+      end
+      # ===================================================================== #
+      # === password
+      # ===================================================================== #
+      if i.has_key? 'password'
+        _ = i.fetch('password')
+        FtpParadise.set_password(_)
+      end
+      # ===================================================================== #
+      # === port
+      # ===================================================================== #
+      if i.has_key? 'port'
+        _ = i.fetch('port')
+        FtpParadise.set_port(_)
+      end
+      return main_hash? # We can return it here as well.
+    end
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'yaml'
+  dataset = YAML.load_file('/home/x/data/personal/yaml/ftp/roebe_ftp.yml')
+  FtpParadise.determine_user_dataset_from_this_hash(dataset, :default)
+  pp FtpParadise.dataset?
+end

data/lib/ftp_paradise/toplevel_methods/file_related_actions.rb

@@ -13,14 +13,15 @@ module FtpParadise
   #
   # Use this method whenever you want to get all (local) files.
   #
-  # By default, this method will return all files from the current directory.
+  # By default, this method will return all files from the current
+  # directory.
   # ========================================================================= #
   def self.get_files(
       from = '*'
     )
     entries = Dir[from]
     entries.select! {|entry| File.file?(entry) }
-    entries
+    return entries
   end
 
   # ========================================================================= #
@@ -37,7 +38,7 @@ module FtpParadise
   #
   # Consistently use this method if you wish to delete a (local) file.
   # ========================================================================= #
-  def self.delete(i) # ← Added this method as of April 2014.
+  def self.delete(i) # ← This method was added in April 2014.
     i = i.to_s # We don't want nil-errors here.
     if File.exist? i
       File.delete(i)

data/lib/ftp_paradise/toplevel_methods/ftp_object.rb

@@ -6,7 +6,9 @@
 # =========================================================================== #
 module FtpParadise
 
-  require 'net/ftp'
+  require 'yaml'
+  require 'ftp_paradise/constants/constants.rb'
+  require 'ftp_paradise/requires/require_net_ftp.rb'
   require 'ftp_paradise/toplevel_methods/e.rb'
   require 'ftp_paradise/toplevel_methods/login_name.rb'
   require 'ftp_paradise/toplevel_methods/password.rb'
@@ -22,8 +24,6 @@ module FtpParadise
   # ========================================================================= #
   @ftp_object = nil
 
-  require 'yaml'
-  require 'ftp_paradise/constants/roebe.rb'
   # ========================================================================= #
   # === FtpParadise.initialize_ftp_object
   #
@@ -36,10 +36,11 @@ module FtpParadise
     # === :default
     # ======================================================================= #
     when :default
-      use_this_url = YAML.load_file(FILE_ROEBE_FTP)['podserver']['url']
+      use_this_url = YAML.load_file(FILE_ROEBE_FTP)['bplaced']['url']
     end
     @ftp_object = Net::FTP.new(use_this_url)
-  end
+    return @ftp_object
+  end; self.instance_eval { alias initialize_the_ftp_dataset initialize_ftp_object } # === FtpParadise.initialize_the_ftp_dataset
 
   # ========================================================================= #
   # === FtpParadise.do_login                                      (login tag)

data/lib/ftp_paradise/toplevel_methods/login_name.rb

@@ -7,7 +7,7 @@
 module FtpParadise
 
   require 'yaml'
-  require 'ftp_paradise/constants/roebe.rb'
+  require 'ftp_paradise/constants/constants.rb'
 
   # ========================================================================= #
   # === @login_name
@@ -25,7 +25,8 @@ module FtpParadise
   # === FtpParadise.set_login_name
   # ========================================================================= #
   def self.set_login_name(
-      i = :try_to_infer_automatically
+      i                    = :try_to_infer_automatically,
+      use_this_entry_point = 'bplaced'
     )
     case i
     # ======================================================================= #
@@ -34,7 +35,7 @@ module FtpParadise
     when :try_to_infer_automatically,
          :infer
       if File.exist? FILE_ROEBE_FTP
-        i = YAML.load_file(FILE_ROEBE_FTP)['podserver']['user_name']
+        i = YAML.load_file(FILE_ROEBE_FTP)[use_this_entry_point]['user_name']
       end
     end
     @login_name = i
@@ -44,6 +45,7 @@ module FtpParadise
 end
 
 if __FILE__ == $PROGRAM_NAME
+  alias e puts
   FtpParadise.set_login_name
-  puts FtpParadise.login_name?
+  e FtpParadise.login_name?
 end

data/lib/ftp_paradise/toplevel_methods/misc.rb

@@ -13,4 +13,23 @@ module FtpParadise
     return ("#{Dir.pwd}/").squeeze('/')
   end
 
+  # ========================================================================= #
+  # === 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/opn.rb

@@ -10,7 +10,7 @@ module FtpParadise
     require 'opn'
   rescue LoadError; end
 
-  require 'ftp_paradise/constants/namespace.rb'
+  require 'ftp_paradise/constants/constants.rb'
 
   # ========================================================================= #
   # === FtpParadise.opn

data/lib/ftp_paradise/toplevel_methods/password.rb

@@ -7,7 +7,7 @@
 module FtpParadise
 
   require 'yaml'
-  require 'ftp_paradise/constants/roebe.rb'
+  require 'ftp_paradise/constants/constants.rb'
 
   # ========================================================================= #
   # === @password
@@ -32,11 +32,13 @@ module FtpParadise
       i = :try_to_infer_automatically
     )
     case i
+    # ======================================================================= #
     # === :try_to_infer_automatically
+    # ======================================================================= #
     when :try_to_infer_automatically,
          :infer
       if File.exist? FILE_ROEBE_FTP
-        i = YAML.load_file(FILE_ROEBE_FTP)['bytehost']['password']
+        i = YAML.load_file(FILE_ROEBE_FTP)['bplaced']['password']
       end
     end
     @password = i

data/lib/ftp_paradise/toplevel_methods/port.rb

@@ -18,9 +18,12 @@ module FtpParadise
       i = :try_to_infer_automatically
     )
     case i
+    # ======================================================================= #
+    # === :try_to_infer_automatically
+    # ======================================================================= #
     when :try_to_infer_automatically
       if File.exist? FILE_ROEBE_FTP
-        i = YAML.load_file(FILE_ROEBE_FTP)['podcast']['port']
+        i = YAML.load_file(FILE_ROEBE_FTP)['bplaced']['port']
       end
     end
     @port = i

data/lib/ftp_paradise/toplevel_methods/remote_url.rb

@@ -6,6 +6,10 @@
 # =========================================================================== #
 module FtpParadise
 
+  require 'yaml'
+  require 'ftp_paradise/toplevel_methods/is_on_roebe.rb'
+  require 'ftp_paradise/constants/constants.rb'
+
   # ========================================================================= #
   # === @remote_url
   #
@@ -22,9 +26,6 @@ module FtpParadise
     @remote_url
   end
 
-  require 'yaml'
-  require 'ftp_paradise/toplevel_methods/is_on_roebe.rb'
-  require 'ftp_paradise/constants/roebe.rb'
   # ========================================================================= #
   # === FtpParadise.set_remote_url
   #
@@ -34,10 +35,15 @@ module FtpParadise
       i = :try_to_infer
     )
     case i
-    when nil, :infer, :try_to_infer
+    # ======================================================================= #
+    # === :try_to_infer
+    # ======================================================================= #
+    when :try_to_infer,
+         :infer,
+         nil
       if is_on_roebe?
         if File.exist? FILE_ROEBE_FTP
-          i = YAML.load_file(FILE_ROEBE_FTP)['bytehost']['url']
+          i = YAML.load_file(FILE_ROEBE_FTP)['bplaced']['url']
         end
       end
     end

data/lib/ftp_paradise/toplevel_methods/upload_and_download.rb

@@ -53,6 +53,7 @@ module FtpParadise
     end
     if yielded
       if yielded.is_a? Hash
+        # === :cd_into_this_directory
         if yielded.has_key? :cd_into_this_directory
           use_this_as_ftp_object.remote_cd(yielded[:cd_into_this_directory])
         end

data/lib/ftp_paradise/version/version.rb

@@ -9,7 +9,12 @@ module FtpParadise
   # ========================================================================= #
   # === VERSION
   # ========================================================================= #
-  VERSION = '1.4.5'
+  VERSION = '1.5.4'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '01.06.2023'
 
 end
 

data/lib/ftp_paradise/www/web_interface.cgi

@@ -4,7 +4,7 @@
 # =========================================================================== #
 # http://localhost/DATA/PROGRAMMING_LANGUAGES/RUBY/src/ftp_paradise/lib/ftp_paradise/www/web_interface.cgi
 # =========================================================================== #
-require 'web_object/autoinclude'
+require 'cyberweb/autoinclude'
 require 'ftp_paradise'
 
 english {

data/test/testing_minimal_pure_net_ftp_example_to_connect.rb

@@ -11,18 +11,28 @@ require 'net/ftp'
 
 e Colours.rev+'Now testing a minimal FTP example.'
 
-_ = '/home/x/DATA/PC/OS/LINUX/FTP/YAML/roebe_ftp.yml'
-dataset = YAML.load_file(_)['bytehost']
+_ = '/home/x/data/personal/yaml/ftp/roebe_ftp.yml'
+dataset = YAML.load_file(_)['bplaced'] # ['bytehost']
 url       = dataset.fetch 'url'
 _port     = dataset.fetch 'port'
 user_name = dataset.fetch 'user_name'
 password  = dataset.fetch 'password'
-
+e
 e 'We will use this url:       '+sfancy(url)
 e 'We will use this user name: '+sfancy(user_name)
 e 'We will use this password:  '+sfancy(password)
+e
 ftp = Net::FTP.new(url)
 ftp.login(user_name, password) # First the user's name, then the password
 pp ftp
+e
+pp ftp.list
+e
+ftp.chdir('www')
 pp ftp.list
+# =========================================================================== #
+# Next we can test downloading something via FTP:
+# =========================================================================== #
+# ftp.getbinaryfile('basic_chemistry.pdf')
+# ftp.getbinaryfile("PRÜFFUNGSFRAGEN.md")
 ftp.close