ftp_paradise 1.3.8

data/lib/ftp_paradise/requires/common_basic_requires.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/requires/common_basic_requires.rb'
+# =========================================================================== #
+require 'net/ftp' # Load up the ruby net-ftp library.
+require 'socket'
+require 'monitor'
+# =========================================================================== #
+# Next, ftp_paradise-specific .rb files:
+# =========================================================================== #
+require 'ftp_paradise/project/project.rb'

data/lib/ftp_paradise/requires/common_external_requires.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/requires/common_external_requires.rb'
+# =========================================================================== #
+begin
+  require 'cliner/module'
+rescue LoadError; end

data/lib/ftp_paradise/requires/require_the_constants.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/requires/require_the_constants.rb'
+# =========================================================================== #
+require 'ftp_paradise/constants/constants.rb'

data/lib/ftp_paradise/requires/require_the_ftp_paradise_project.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# This variant will require the ftp_paradise project without the actual
+# GUI bindings.
+# =========================================================================== #
+# require 'ftp_paradise/requires/require_the_ftp_paradise_project.rb'
+# =========================================================================== #
+require 'ftp_paradise/project/project.rb'
+require 'ftp_paradise/requires/require_the_constants.rb'
+require 'ftp_paradise/requires/common_external_requires.rb'
+require 'ftp_paradise/requires/common_basic_requires.rb'
+require 'ftp_paradise/requires/require_the_toplevel_methods.rb'
+require 'ftp_paradise/entry/entry.rb'
+require 'ftp_paradise/configuration/configuration.rb'
+require 'ftp_paradise/connection/initialize.rb'
+require 'ftp_paradise/interactive_ftp/interactive_ftp.rb'

data/lib/ftp_paradise/requires/require_the_ftp_paradise_project_with_the_GUI_bindings.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# This variant will require the ftp_paradise project with the GUI bindings.
+# =========================================================================== #
+# require 'ftp_paradise/requires/require_the_ftp_paradise_project_with_the_GUI_bindings.rb'
+# =========================================================================== #
+require 'ftp_paradise/requires/require_the_ftp_paradise_project.rb'
+require 'ftp_paradise/gui/gtk/ftp_binding.rb'

data/lib/ftp_paradise/requires/require_the_toplevel_methods.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/requires/require_the_toplevel_methods.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/project/project.rb'
+  # ========================================================================= #
+  # === FtpParadise.require_the_toplevel_methods
+  # ========================================================================= #
+  def self.require_the_toplevel_methods
+    Dir["#{PROJECT_BASE_DIRECTORY}toplevel_methods/*.rb"].each {|this_file|
+      require this_file
+    }
+  end
+
+  # ========================================================================= #
+  # And require these files at once:
+  # ========================================================================= #
+  require_the_toplevel_methods
+
+end

data/lib/ftp_paradise/toplevel_methods/can_connect_to_remote_site.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/can_connect_to_remote_site.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/connection/connection.rb'
+
+  # ========================================================================= #
+  # === 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?
+    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

@@ -0,0 +1,28 @@
+#!/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/connect.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/connect.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/connection/connection.rb'
+
+  # ========================================================================= #
+  # === FtpParadise.connect
+  #
+  # To use this convenient connection-method, do this:
+  #
+  #   _ = FtpParadise.connect to: :shevy
+  # ========================================================================= #
+  def self.connect(
+      where_to = {}
+    )
+    if where_to.is_a? Hash
+      FtpParadise::Connection.new(where_to) # This ought to be a Hash anyway.
+    end
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.new
+  #
+  # Module-method to create a new Connection object.
+  # ========================================================================= #
+  def self.new(
+      remote_host = :default,
+      run_already = FtpParadise::Connection::RUN_ALREADY,
+      &block
+    )
+    case remote_host
+    when :dont_run_yet
+      remote_host = :default
+      run_already = false
+    end
+    if remote_host.is_a? Symbol
+      run_already = remote_host
+    end
+    FtpParadise::Connection.new(
+      remote_host, run_already, &block
+    )
+  end; self.instance_eval { alias open new } # === FtpParadosie.open
+
+end

data/lib/ftp_paradise/toplevel_methods/create_file.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module FtpParadise
+
+  require 'fileutils'
+
+  # ========================================================================= #
+  # === FtpParadise.create_file
+  #
+  # Create a local file, via .touch().
+  # ========================================================================= #
+  def self.create_file(i)
+    FileUtils.touch(i)
+  end; self.instance_eval { alias touch create_file } # === FtpParadise.touch
+
+end

data/lib/ftp_paradise/toplevel_methods/data.rb

@@ -0,0 +1,31 @@
+#!/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/delete.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module FtpParadise
+
+  require 'fileutils'
+
+  # ========================================================================= #
+  # === FtpParadise.delete                                         (del tag)
+  #
+  # Consistently use this method if you wish to delete a (local) file.
+  # ========================================================================= #
+  def self.delete(i) # ← Added this method as of Apr 2014.
+    i = i.to_s # We don't want nil-errors here.
+    if File.exist? i
+      File.delete(i)
+    else
+      e "No file at #{sfile(i)} appears to exist."
+    end
+  end; self.instance_eval { alias remove delete } # === FtpParadise.remove
+
+end

data/lib/ftp_paradise/toplevel_methods/determine_user_dataset_from_this_hash.rb

@@ -0,0 +1,37 @@
+#!/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

data/lib/ftp_paradise/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/e.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === FtpParadise.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/ftp_paradise/toplevel_methods/ftp_object.rb

@@ -0,0 +1,270 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/ftp_object.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'net/ftp'
+  require 'ftp_paradise/toplevel_methods/e.rb'
+  require 'ftp_paradise/toplevel_methods/login_name.rb'
+  require 'ftp_paradise/toplevel_methods/password.rb'
+  require 'ftp_paradise/toplevel_methods/remote_url.rb'
+
+  # ========================================================================= #
+  # === @ftp_object
+  #
+  # This is the main Net FTP object that we will use to connect to
+  # some remote host. It will be stored on the module-level so that
+  # we can also use module-level methods such as
+  # FtpParadise.ftp_object? for easy access ways.
+  # ========================================================================= #
+  @ftp_object = nil
+
+  require 'yaml'
+  require 'ftp_paradise/constants/roebe.rb'
+  # ========================================================================= #
+  # === FtpParadise.initialize_ftp_object
+  #
+  # Use this method if you wish to initialize a new FTP object. This will
+  # be, by default, a blank-state initializer.
+  # ========================================================================= #
+  def self.initialize_ftp_object(use_this_url = nil)
+    case use_this_url
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      use_this_url = YAML.load_file(FILE_ROEBE_FTP)['bytehost']['url']
+    end
+    @ftp_object = Net::FTP.new(use_this_url)
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.do_login                                      (login tag)
+  #
+  # This method combines setting the remote URL, before doing the login
+  # action.
+  # ========================================================================= #
+  def self.do_login(
+      use_this_as_the_remote_url = nil,
+      user                       = :default,
+      passwd                     = :default_or_nil,
+      acct                       = nil
+    )
+    if use_this_as_the_remote_url and FtpParadise.ftp_object?.nil?
+      FtpParadise.set_remote_url(use_this_as_the_remote_url)
+    end
+    case use_this_as_the_remote_url
+    # ======================================================================= #
+    # === :bytehost
+    # ======================================================================= #
+    when :bytehost
+      FtpParadise.set_remote_url(:infer)
+      use_this_as_the_remote_url = remote_url?
+    end
+    # ======================================================================= #
+    # Sanitize the default user (user name aka login name).
+    # ======================================================================= #
+    case user
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default
+      if is_on_roebe?
+        set_login_name(:infer)
+        user = login_name?
+      else
+        user = 'anonymous'
+      end
+    end
+    # ======================================================================= #
+    # Sanitize the given password next.
+    # ======================================================================= #
+    case passwd
+    # ======================================================================= #
+    # === :default_or_nil
+    # ======================================================================= #
+    when :default_or_nil
+      if is_on_roebe?
+        set_password(:infer)
+        passwd = password?
+      else
+        passwd = nil
+      end
+    end
+    # ======================================================================= #
+    # puts "Debug: user name is: #{user} password is: #{passwd} account is: #{acct}"
+    # ======================================================================= #
+    @ftp_object.login(
+      user, passwd, acct
+    ) # Delegate to the main object here.
+    return @ftp_object # And mandatory return here.
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.use_this_as_ftp_object
+  #
+  # Assignment to a new FTP object can come through this method.
+  # ========================================================================= #
+  def self.use_this_as_ftp_object(i)
+    @ftp_object = i
+  end; self.instance_eval { alias assign_ftp_object= use_this_as_ftp_object } # === FtpParadise.assign_ftp_object=
+       self.instance_eval { alias ftp_object=        use_this_as_ftp_object } # === FtpParadise.ftp_object=
+
+  # ========================================================================= #
+  # === FtpParadise.list
+  # ========================================================================= #
+  def self.list(i = 'n*')
+    @ftp_object.list(i)
+  end; self.instance_eval { alias ll list } # === FtpParadise.ll
+
+  # ========================================================================= #
+  # === FtpParadise.close
+  # ========================================================================= #
+  def self.close
+    @ftp_object.close
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.mlsd
+  #
+  # This method will return an Array of the entries of the directory
+  # specified by pathname.
+  #
+  # Each entry has the facts (e.g., size, last modification time, etc.)
+  # and the pathname. If a block is given, it iterates through the listing.
+  #
+  # If pathname is omitted, the current directory is assumed.
+  # ========================================================================= #
+  def self.mlsd(
+      pathname = nil
+    )
+    @ftp_object.mlsd(pathname)
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.delete
+  #
+  # Use this to delete a remote file.
+  # ========================================================================= #
+  def self.delete(i)
+    FtpParadise.ftp_object.delete(i)
+  end; self.instance_eval { alias remove_this_file delete } # === FtpParadise.remove_this_file
+
+  # ========================================================================= #
+  # === FtpParadise.getbinaryfile
+  # ========================================================================= #
+  def self.getbinaryfile(
+      a = 'nif.rb-0.91.gz',
+      b = 'nif.gz',
+      c = 1024
+    )
+    @ftp_object.getbinaryfile(a,b,c)
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.remote_host?
+  # ========================================================================= #
+  def self.remote_host?
+    if @ftp_object
+      @ftp_object.remote_host?
+    else
+      nil
+    end
+  end; self.instance_eval { alias host? remote_host? } # === FtpParadise.host?
+
+  # ========================================================================= #
+  # === FtpParadise.chdir                                            (cd tag)
+  #
+  # Change directory through this method here.
+  #
+  # Usage Example:
+  #
+  #   FtpParadise.chdir('pub/lang/ruby/contrib')
+  #   FtpParadise.cd('pub/lang/ruby/contrib')
+  #
+  # ========================================================================= #
+  def self.chdir(i)
+    @ftp_object.chdir(i)
+  end; self.instance_eval { alias cd        chdir } # === FtpParadise.cd
+       self.instance_eval { alias remote_cd chdir } # === FtpParadise.remote_cd
+
+  # ========================================================================= #
+  # === FtpParadise.ftp_object
+  #
+  # Reader method to return the @ftp_object.
+  #
+  # This method should ideally come last in this .rb file.
+  # ========================================================================= #
+  def self.ftp_object
+    @ftp_object
+  end; self.instance_eval { alias ftp_object? ftp_object } # === FtpParadise.ftp_object?
+       self.instance_eval { alias object      ftp_object } # === FtpParadise.object
+
+  # ========================================================================= #
+  # === FtpParadise.show_list
+  #
+  # By default this method will exclude the '.' and '..' entries.
+  # ========================================================================= #
+  def self.show_list
+    result = @ftp_object.list
+    result.each {|line|
+      e line unless line.end_with? '.'
+    }
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.remote_mkdir
+  #
+  # This method will create a remote directory. Make sure to have
+  # a valid (active) FTP connection before you invoke this method.
+  # ========================================================================= #
+  def self.remote_mkdir(
+      create_this_remote_directory,
+      connection           = @ftp_object,
+      connect_to_this_host = :shevy
+    )
+    if create_this_remote_directory.is_a? Array
+      create_this_remote_directory.each {|name_of_the_remote_directory|
+        remote_mkdir(
+          name_of_the_remote_directory,
+          connection,
+          connect_to_this_host
+        )
+      }
+    else
+      create_this_remote_directory = create_this_remote_directory.to_s
+
+      if connection.nil?
+        require 'ftp_paradise/connection/connection.rb'
+        connection = FtpParadise::Connection.new(connect_to_this_host) { :do_not_run_yet }
+        connection.be_silent
+        connection.do_login
+      end
+
+      begin
+        connection.mkdir(create_this_remote_directory)
+      rescue Net::FTPPermError => error
+        pp error
+        e "No directory called #{create_this_remote_directory}/ could be created"
+        e 'as such a (remote) directory already exists.'
+      end
+
+    end
+  end; self.instance_eval { alias create_directory        remote_mkdir } # === FtpParadise.create_directory
+       self.instance_eval { alias remote_create_directory remote_mkdir } # === FtpParadise.remote_create_directory
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise.initialize_ftp_object(:default)
+  result = FtpParadise.do_login :bytehost
+  pp result.list
+  pp result
+  FtpParadise.cd 'htdocs'
+  FtpParadise.show_list
+  FtpParadise.remote_mkdir('test')
+  FtpParadise.show_list
+end # ftpobject