ftp_paradise 1.3.8

data/doc/TODO_FOR_FTP_PARADISE_PROJECT.md

@@ -0,0 +1,79 @@
+(1)
+
+- rcd AUSARBEITUNG
+
+  Changing remote directory to `AUSARBEITUNG` now.
+  Trying to change directory into `AUSARBEITUNG/`.
+
+  ^^^ nope, we should check FIRST before we do 
+  that. "This directory does not exist."
+
+(2)
+
+- Build a GUI Wrapper (in ruby-gnome for now) over the FTP stuff.
+  Once it is finished, we can remove this entry here, or perhaps
+  extend to it every once in a while.
+
+(3)
+
+- Also check that tab completion works for remote files and
+  remote dirs.
+
+(4)
+
+- Add readline support so we can use tab completion. Would be
+  cool to use readline-support TAB COMPLETION, especially when
+  handling directories.
+
+  Tab completion must work for:
+
+    file screenshot.png
+    upload scr<PRESS_TAB_HERE>
+
+(6)
+
+- Build a WWW wrapper, in sinatra.
+
+(7)
+
+- shugo added directory? and stuff. we may be able to simplify
+  our already existing methods for that, then upload.
+  
+  -> Please note that the new methods are available only with FTP servers
+     which support the MLST/MLSD commands specified in RFC 3659.
+
+
+pwd
+The local directory is: 
+  /home/x/STUDIUM/BOKU_WIEN/958118_Obst_und_Weinbau/
+remotemkdir 958118
+Creating remote directory `958118/` now.
+rcd 958118
+false
+#<NoMethodError: undefined method `+' for nil:NilClass>
+rcd 958118
+true
+Changing remote directory to `958118` now.
+Trying to change directory into `958118/`.
+Remote directory is:
+  shevegen.square7.ch/AUSARBEITUNGEN/958118/
+  
+  ^^^^ warum gibt uns das einen Fehler aus????
+
+
+
+FtpParadise.remote_host?
+
+^^^ and show it
+
+FtpParadise.user?
+
+
+
+FtpParadise.password?
+
+
+
+
+^^^ ensure that this exists in particular the top one
+and add a commandline bin/ variant to show this too

data/ftp_paradise.gemspec

@@ -0,0 +1,114 @@
+# =========================================================================== #
+# Gemspec for Project FtpParadise.
+# =========================================================================== #
+require 'ftp_paradise/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'ftp_paradise'
+  s.version = FtpParadise::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This project aims to provide some convenience bindings and addon-classes
+for the Ruby-FTP base module.
+
+Please be aware that since as of the year 2020, this project is in a
+low-effort maintenance mode only. Bug fixes are welcome as are usability
+improvements and improvements made to the documentation - but do not
+expect this project to be very actively maintained anymore. Its peak
+days were from 2010 to 2014 or so; since then I have found fewer use
+cases for the project, but I will maintain it nonetheless. 
+
+For more information about this project, please have a look at the
+online documentation at https://www.rubydoc.info/gems/ftp_paradise/ or
+within the doc/ subdirectory of this gem.
+
+EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  # =============================================================== #
+  # Show this when a user installs this project.
+  # =============================================================== #
+  s.post_install_message = <<-EOF
+
+  The interactive file, which can be started by typing "iftp",
+  requires a library called configuration.
+
+  This is NOT the one available at rubygems.org - but instead can
+  be downloaded here:
+
+      wget http://shevegen.bplaced.net/configuration-1.0.21.gem
+
+  Please install only the above configuration-gem variant, not the
+  other gem called "configuration". (You can extract the gem and
+  look at it before you install it of course. Its sole purpose
+  is to read in a bunch of .yml yaml files to provide a proper
+  base configuration for a project.)
+
+  If you wish to start the interactive FTP, the file can be
+  found at:
+
+      bin/iftp
+
+  And should on most Linux systems end up on:
+
+      /usr/bin/iftp
+
+  if the --prefix is at /usr (obviously, if you install into
+  your home directory, then it will be at another location;
+  rubygems should take care of this).
+
+  So just typing "iftp" should suffice to start the interactive FTP
+  component, but keep in mind that you need to download the
+  configuration gem listed above first.
+
+  You can disable the colour-section of the interactive FTP
+  by issuing:
+
+      iftp --disable-colours
+
+  You can also batch-upload some scripts through the command
+  called:
+
+      ftp_upload
+
+  ftp_upload --help should give you some information on how
+  to use it.
+
+  Consider installing the "roebe" gem for making "Configuration"
+  available.
+
+  Thank you and have fun!
+
+  EOF
+
+  s.authors     = ['Robert A. Heiler']
+  s.email       = 'shevegen@gmail.com'
+  s.license     = 'GPL-2.0'
+  s.files       = Dir['**/*']
+  s.files      << ['README.md']
+  s.files       = s.files.flatten
+  s.executables = Dir['bin/*'].map { |entry| File.basename(entry) }
+  s.require_paths = ["lib"]
+
+  s.homepage    = 'http://rubygems.org/gems/ftp_paradise'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # =============================================================== #
+  # Dependencies for this project:
+  # =============================================================== #
+  s.add_dependency 'cliner'
+  s.add_dependency 'colours'
+  s.add_dependency 'convert_global_env'
+  s.add_dependency 'rcfiles'
+  s.add_dependency 'opn'
+  s.add_dependency 'verbose_truth'
+
+}

data/lib/ftp_paradise.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+require 'ftp_paradise/requires/require_the_ftp_paradise_project.rb'

data/lib/ftp_paradise/base/cliner.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/cliner.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/requires/common_external_requires.rb'
+  # =========================================================================== #
+  # === cliner
+  # =========================================================================== #
+  def cliner
+    Cliner.cliner
+    if block_given?
+      yield
+      Cliner.cliner
+    end
+  end
+
+end

data/lib/ftp_paradise/base/colours.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/colours.rb'
+# =========================================================================== #
+module FtpParadise
+
+class Base
+
+  require 'ftp_paradise/colours/colours.rb'
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(i = '')
+    return ::FtpParadise.swarn(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    return ::FtpParadise.sfile(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    return ::FtpParadise.simp(i) if use_colours?
+    i
+  end; alias simportant simp # === simportant
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    return ::FtpParadise.sfancy(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    return ::FtpParadise.sdir(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === orange
+  # ========================================================================= #
+  def orange(i = '')
+    return ::Colours.orange(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === sandybrown
+  # ========================================================================= #
+  def sandybrown(i = '')
+    return ::Colours.sandybrown(i) if use_colours?
+    i
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i = '')
+    FtpParadise.royalblue(i)
+  end
+
+  # ========================================================================= #
+  # === slateblue
+  # ========================================================================= #
+  def slateblue(i = '')
+    FtpParadise.slateblue(i)
+  end
+
+end; end

data/lib/ftp_paradise/base/prototype.rb

@@ -0,0 +1,169 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/base/prototype.rb'
+# FtpParadise::Base
+# =========================================================================== #
+require 'ftp_paradise/constants/constants.rb'
+# =========================================================================== #
+# The various project's toplevel_methods files:
+# =========================================================================== #
+require 'ftp_paradise/toplevel_methods/create_file.rb'
+require 'ftp_paradise/toplevel_methods/e.rb'
+require 'ftp_paradise/toplevel_methods/get_files.rb'
+require 'ftp_paradise/toplevel_methods/opn.rb'
+require 'ftp_paradise/toplevel_methods/password.rb'
+require 'ftp_paradise/toplevel_methods/rds.rb'
+require 'ftp_paradise/toplevel_methods/time.rb'
+# =========================================================================== #
+# The next .rb file will pull in "cliner":
+# =========================================================================== #
+require 'ftp_paradise/requires/common_external_requires.rb'
+
+module FtpParadise
+
+class Base
+
+  # =========================================================================== #
+  # Colour support comes next:
+  # =========================================================================== #
+  require 'ftp_paradise/base/colours.rb'
+  require 'ftp_paradise/base/cliner.rb'
+  require 'ftp_paradise/base/reset.rb'
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @internal_hash[:be_verbose]
+  end
+
+  # ========================================================================= #
+  # === be_quiet
+  # ========================================================================= #
+  def be_quiet
+    @internal_hash[:be_verbose] = false
+  end; alias be_silent be_quiet # === be_silent
+
+  # ========================================================================= #
+  # === set_be_verbose
+  #
+  # Set the verbosity mode.
+  # ========================================================================= #
+  def set_be_verbose(i = true)
+    @internal_hash[:be_verbose] = i
+  end; alias be_verbose= set_be_verbose # === be_verbose=
+       alias be_verbose  set_be_verbose # === be_verbose
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(i = NAMESPACE)
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    FtpParadise.opnn(i)
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i = '')
+    FtpParadise.rds(i)
+  end
+
+  # ========================================================================= #
+  # === touch
+  # ========================================================================= #
+  def touch(i = '')
+    FtpParadise.touch(i)
+  end
+
+  # ========================================================================= #
+  # === get_files
+  # ========================================================================= #
+  def get_files(i = '')
+    FtpParadise.get_files(i)
+  end
+
+  # ========================================================================= #
+  # === cd
+  # ========================================================================= #
+  def cd(i)
+    Dir.chdir(i) if File.directory? i
+  end; alias change_local_directory cd # === change_local_directory
+
+  # ========================================================================= #
+  # === return_all_local_entries
+  #
+  # This will return an array.
+  # ========================================================================= #
+  def return_all_local_entries(
+      from_where = Dir.pwd
+    )
+    Dir["#{from_where}/**/**"]
+  end; alias return_directory_content return_all_local_entries # === return_directory_content
+
+  # ========================================================================= #
+  # === e
+  # ========================================================================= #
+  def e(i = '')
+    FtpParadise.e(i)
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    @internal_hash[:use_colours]
+  end
+
+  # ========================================================================= #
+  # === parens                                                   (parens tag)
+  # ========================================================================= #
+  def parens(i)
+    padding_to_use = ' ' *  5
+    return sfancy("#{padding_to_use}(#{i}) ")
+  end
+
+  # ========================================================================= #
+  # === pound_token
+  #
+  # Simply return a colourized pound token next, but only if we use colours.
+  # ========================================================================= #
+  def pound_token
+    _ = '# '
+    if use_colours?
+      return "#{Colours::CYAN}#{_}#{Colours::WHITE}"
+    end
+    _
+  end
+
+  # ========================================================================= #
+  # === on_roebe?
+  # ========================================================================= #
+  def on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end; alias are_we_on_roebe? on_roebe? # === are_we_on_roebe?
+
+  # ========================================================================= #
+  # === return_time
+  # ========================================================================= #
+  def return_time
+    FtpParadise.return_time
+  end
+
+  # ========================================================================= #
+  # === do_use_colours
+  # ========================================================================= #
+  def do_use_colours
+    @internal_hash[:use_colours] = true
+  end
+
+end; end