ftp_paradise 1.4.5

data/lib/ftp_paradise/www/public/css/style.css

@@ -0,0 +1,3 @@
+.red {
+  color: red;
+}

data/lib/ftp_paradise/www/sinatra_web_interface.rb

@@ -0,0 +1,242 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === FtpWebApp
+#
+# This file requires these projects:
+#
+#   sinatra
+#   html_tags
+#   colours
+#   ftp_paradise
+#
+# =========================================================================== #
+require 'sinatra'
+require 'html_tags'
+require 'colours/autoinclude'
+require 'ftp_paradise'
+require 'cliner'
+
+# =========================================================================== #
+# We must remove method :body first before continuing.
+# =========================================================================== #
+HtmlTags.class_eval { remove_method(:body) }
+
+class FtpWebApp < Sinatra::Base
+
+  include HtmlTags
+
+  set :port, USE_THIS_PORT
+  set :logging, true
+
+  USE_THIS_PORT = 81
+  WHERE_TO = :SHEVY
+
+  # ========================================================================= #
+  # Initialize the Ftp-Connection here.
+  # ========================================================================= #
+  FTP = FtpParadise::Connection.new(:dont_run)
+
+  # ========================================================================= #
+  # The various constants for the URL actions.
+  # ========================================================================= #
+  ROOT       = '/'
+  ABOUT      = '/about/?'
+  CONNECT    = '/connect/?'
+  CONNECT_TO = '/connect_to/?'
+  STATUS     = '/status/?'
+  LISTING    = '/listing/?'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      run_already = true
+    )
+    super
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === link_to_everything                          (everything tag, all tag)
+  # ========================================================================= #
+  def link_to_everything
+    div(
+      :id => 'intralink',
+      :css_style => 'margin: 0.55em;
+      margin-top:1.05em;
+      margin-left:0.45em;
+      margin-right:0.45em;
+      padding-top: 2px;
+      padding:5px;
+      border:1px dotted black;'
+    ) {
+      h2('Available actions for the www-ftp part:','','',
+      'margin-top:1px; margin-bottom:1px;padding:0.2em')+
+      link_to(:connect,'margin-left:1em')+
+      link_to(:status)+
+      link_to(:root)+
+      link_to(:listing)
+    }
+  end
+
+  # ========================================================================= #
+  # === link_to
+  # ========================================================================= #
+  def link_to(i, optional_css = '')
+    case i.to_s
+    when 'root'
+      i = '/'
+    end
+    a(i.to_s, :make_newline,'','padding-left:1.2em;'+optional_css)
+  end
+
+  # ========================================================================= #
+  # === do_connect
+  # ========================================================================= #
+  def do_connect(
+      where_to = WHERE_TO
+    )
+    FTP.connect :to => where_to
+  end
+
+  # ========================================================================= #
+  # localhost:81/halt
+  # ========================================================================= #
+  get '/halt' do 
+    halt 403, 'Halting everything.'
+  end
+
+  # ========================================================================= #
+  # === /about
+  #
+  # localhost:81/about
+  # About tag
+  # ========================================================================= #
+  get ABOUT do
+    _  = h2 'This is the Web Interface for the FtpParadise project.'
+    _ << 'If you wish to connect to a remote site, try:'+br
+    _ << h4('  connect SERVER_URL_HERE','','',
+         'color:slateblue; margin-left:1em')
+    return _
+  end
+
+  # ========================================================================= #
+  # /listing                                                      (listing tag)
+  # ========================================================================= #
+  get LISTING do
+    do_connect
+    _ = h2('Remote File listing (of <b>'+WHERE_TO.to_s+'</b>):','','',
+           'text-decoration: underline')
+    FTP.array_remote_files.
+      reject {|entry| entry[0,1] == '.'}.
+      each_with_index {|entry, index|
+      _ << (index+1).to_s+' <b>'+link(
+        'http://'+FTP.connected_to?+'/'+entry.to_s
+      )+'</b>'+br+"\n"
+    }
+    _+link_to_everything
+  end
+
+  # ========================================================================= #
+  # === status tag
+  #
+  # localhost:81/status
+  # ========================================================================= #
+  get STATUS do
+    do_connect
+    show_status
+  end
+
+  # ========================================================================= #
+  # localhost:81/status
+  # ========================================================================= #
+  get CONNECT do
+    h2('Please give us an argument to use.','red')+
+    h3('If you are unsure what kind of argument, simply append the login '+
+       'host you wish to connect to, such as /SHEVY.')+br+
+       'Example: /connect_to/SHEVY'+
+       a('connect/SHEVY', :make_newline)
+  end
+
+  # ========================================================================= #
+  # === show_status
+  # ========================================================================= #
+  def show_status
+    _ = h2 'The status is as follows:'+br
+    _ << 'We are connected to: '+b(FTP.connected_to?,
+          '','','text-decoration: underline')+br+br
+    _ << FTP.status?+br
+    _ << link_to_everything
+  end
+
+  # ========================================================================= #
+  # localhost:81/connect
+  # ========================================================================= #
+  [
+    CONNECT+'/:connect',
+    CONNECT_TO+'/:connect'
+  ].each {|entry|
+    get(entry) do
+      FTP.connect :to => params[:connect]
+      _ = 'Now connecting to ...'+params[:connect].to_s+
+          show_status+br+link_to(:root)
+      return _
+    end
+  }
+
+  # ========================================================================= #
+  # The root at / is shown here.
+  # localhost:81/
+  # ========================================================================= #
+  get ROOT do
+    h1('Welcome to the web-interface of the FtpParadise project. ',
+       '','','margin-top:0.5em')+
+    h2('We will now show which actions are possible:','','',
+      'margin-bottom:1px; margin-left:1em')+
+      link_to_everything
+  end
+
+  # ========================================================================= #
+  # === report_port
+  # ========================================================================= #
+  def report_port
+    cliner {
+      e 'We will use the port '+sfancy(port?)+' ( http://localhost:'+port?+'/ ).'
+    }
+  end
+
+  # ========================================================================= #
+  # === port?
+  # ========================================================================= #
+  def port?
+    USE_THIS_PORT.to_s
+  end
+
+  # ========================================================================= #
+  # === not_found
+  #
+  # In case the action was not found, continue here.
+  #
+  # localhost:81/not_existing
+  # ========================================================================= #
+  not_found do
+    status 404
+    h1('The action '+request.path_info+' was not found.')+
+    link_to_everything
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    report_port
+    self.class.run!
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+   FtpWebApp.new
+end # rb sinatra_web_interface.rb

data/lib/ftp_paradise/www/views/index.slim

@@ -0,0 +1,3 @@
+h2 My Tasks
+ul.tasks
+  li Get Milk

data/lib/ftp_paradise/www/views/layout.slim

@@ -0,0 +1,11 @@
+doctype html
+html
+  head
+    meta charset="utf-8"
+    title Just Do It
+    link rel="stylesheet" media="screen, projection" href="/styles.css"
+    /[if lt IE 9]
+      script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"
+  body
+    h1 Just Do It
+    == yield

data/lib/ftp_paradise/www/web_interface.cgi

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# http://localhost/DATA/PROGRAMMING_LANGUAGES/RUBY/src/ftp_paradise/lib/ftp_paradise/www/web_interface.cgi
+# =========================================================================== #
+require 'web_object/autoinclude'
+require 'ftp_paradise'
+
+english {
+title 'Ftp Paradise Web Interface'
+
+doc {
+  h2 sg(:ausrufungszeichen2,'marr8px')+'Welcome to Web-based FTP','ud'
+  p {
+    e 'You will be able to connect to a remote FTP
+    site with this cgi script.'
+  }
+  FTP_LIBRARY = FtpParadise::Connection.new(:dont_run)
+  div('pad1em wid50','','border: 1px inset crimson;') {
+    form('self','post','form_name') {
+      ee 'Connect to:'
+      input_field      
+      ee '<select size="1" name="foobar">'
+      ee '<option value="aa">Choose a Host:</option>'
+      FTP_LIBRARY.array_available_hosts.each {|entry|
+        ee '<option value="aa">'+entry+'</option>'  
+      }
+      cselect
+      br
+      submit
+    }
+  }
+}}

data/lib/ftp_paradise/yaml/automatically_connect_on_startup_of_the_interactive_ftp_shell.yml

@@ -0,0 +1 @@
+true

data/lib/ftp_paradise/yaml/debug.yml

@@ -0,0 +1 @@
+--- false

data/lib/ftp_paradise/yaml/open_in_default_editor.yml

@@ -0,0 +1 @@
+--- true

data/lib/ftp_paradise/yaml/show_full_names.yml

@@ -0,0 +1 @@
+--- false

data/lib/ftp_paradise/yaml/use_colours.yml

@@ -0,0 +1 @@
+--- true

data/test/testing_ftp_paradise.rb

@@ -0,0 +1,94 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'verbose_truth'
+require 'colours/colours_e_autoinclude.rb'
+require 'cliner'
+require 'ftp_paradise'
+
+@counter = 0
+
+# =========================================================================== #
+# === fancy_colour
+#
+# Through a Konsole-colour.
+# =========================================================================== #
+def fancy_colour(i)
+  ::Colours.springgreen(i)
+end; alias main_colour fancy_colour # === main_colour
+
+# =========================================================================== #
+# === counter
+#
+# We return a colourized-counter here.
+# =========================================================================== #
+def counter
+  @counter += 1
+  return ::Colours.peachpuff('('+@counter.to_s+') ')
+end
+
+e 'Now testing the project called '+sfancy('ftp_paradise')+'.'
+e 'Will we use colours?'
+e VerboseTruth[FtpParadise.use_colours?]
+e
+e 'Next, we will instantiate a new FtpParadise::Connection object.'
+connection = FtpParadise::Connection.new { :default_dataset }
+# library.set_data :shevy # <-- This is not necessary.
+pp connection
+cliner
+# =========================================================================== #
+# === Feedback the configuration object
+# =========================================================================== #
+e 'The configuration object is:'
+pp FtpParadise.config?
+pp FtpParadise::CONFIGURATION
+e '^^^ should be the same'
+cliner
+e 'Next, we will test some colours:'
+FtpParadise.testing_colours # Making some colour-tests next.
+cliner
+e 'Next, we will show the user name, port and password:'
+connection.show_host_user_name_port_and_password
+cliner
+e counter+'Now testing the '+fancy_colour('class FtpParadise::Connection')
+connection = FtpParadise::Connection.new(:default)
+e 'Will we debug? '+VerboseTruth[connection.debug?]
+e 'The user name is: '+::Colours.orchid(connection.user_name?)
+e 'Next showing the FtpParadise::Connection object:'
+pp connection # test_ftp
+connection.set_passive
+connection.set_mode
+connection.cd 'ZEUGNISSE'
+e 'Next testing the method '+main_colour('.nlst()')
+connection.nlst
+e 'Debugging next:'
+connection.debug
+e 'We are connected to?'
+e '  '+::Colours.deepskyblue(connection.connected_to?)
+connection.report_remote_directory
+# connection.upload 'LPC_CODE_SHEET'
+e 'Is CSS/ a directory? '+connection.is_directory?('CSS').to_s
+e 'The last response was: `'+connection.last_response?.chomp+'`'
+e 'open_timeout? '+connection.open_timeout?.to_s # ftplib
+e 'Next testing '+main_colour('FtpParadise.connect')+' functionality'
+FtpParadise.connect to: :shevy
+# =========================================================================== #
+# Testing whether we will transfer in binary mode:
+# =========================================================================== #
+cliner
+e 'Will we transfer in binary mode? '+VerboseTruth[connection.binary?].to_s
+cliner
+e 'Next, we will test '+simp('FtpParadise.mlsd()')+' but only the first entry there:'
+e FtpParadise.mlsd.first
+e FtpParadise.mlsd.first.class
+# =========================================================================== #
+# Ok, done testing FtpParadise::Connection.
+# =========================================================================== #
+
+# =========================================================================== #
+# Now we can test interactive FTP. This must come last because it will
+# start up the interactive variant.
+# =========================================================================== #
+interactive = FtpParadise.interactive(:no_main_loop)
+interactive.run

data/test/testing_minimal_pure_net_ftp_example_to_connect.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This small .rb file will just show how to quickly connect to a default
+# host that I use. I have the login information stored in a yaml file.
+# =========================================================================== #
+require 'yaml'
+require 'colours/colours_e_autoinclude.rb'
+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']
+url       = dataset.fetch 'url'
+_port     = dataset.fetch 'port'
+user_name = dataset.fetch 'user_name'
+password  = dataset.fetch 'password'
+
+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)
+ftp = Net::FTP.new(url)
+ftp.login(user_name, password) # First the user's name, then the password
+pp ftp
+pp ftp.list
+ftp.close

data/test/testing_the_ftp_connection_component.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'colours/colours_e_autoinclude.rb'
+require 'cliner/autoinclude'
+require 'verbose_truth'
+require 'ftp_paradise'
+
+e 'Now testing the component '+sfancy('ftp_paradise')+'.'
+
+_ = FtpParadise::Connection.new(:dont_run_yet) { :use_default_dataset }
+
+e
+e 'The following Hash should have some data:'
+e
+pp FtpParadise.dataset?
+e
+e '(This should have already connected to the remote URL.)'
+e
+e 'Next, showing whether we are connected to the remote host: '+
+  slateblue(VerboseTruth[_.are_we_connected?])
+e
+e 'We will issue the method .nlst? next:'
+e
+pp _.nlst?
+e
+e
+e 'Next, show a listing via .list() on the ftp-object:'
+e
+pp _.list?
+
+e
+e 'We will cd on the remote host next, into htdocs:'
+e
+e _.pwd
+_.rcd 'htdocs'
+e _.pwd
+e
+e 'HMM'
+e
+e 'And get a file-listing (in two different ways):'
+e
+pp _.list?
+e
+e "Listing all #{Colours.lightgreen('remote files')} next:"
+e
+pp _.return_all_remote_files
+e
+e 'Uploading a file; then showing the remote files, before this file is removed again:'
+e
+_.upload_this_file   '/Depot/j/test.txt'
+pp _.return_all_remote_files
+_.remove_remote_file '/Depot/j/test.txt'
+pp _.return_all_remote_files
+pp _.pwd
+_.do_list_content
+cliner
+e 'Next showing all remote directories:'
+e
+pp _.return_remote_directories
+e
+_.rcd '..'
+e 'Showing the remote directory listing:'
+e
+_.show_remote_directory_listing
+e
+pp _.file_listing_as_entries?
+cliner
+_.show_file_listing