ftp_paradise 1.4.5 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b6d3a006fd092742114c88fab423c7710496d9053d7ebd8ad53dad0568d5a5e
-  data.tar.gz: 890921f06bf315fe27f64805a671c49cdd2cf13ecf760920ca0ff097b59d665c
+  metadata.gz: c26a08971e887fa0ecdb6ea40624c14fcdcee8e62fbdaf4dc3303fa4efe8e116
+  data.tar.gz: d103baf29e4453269e7cec1ce1da7e94c8f4d579fb7a594dcb87809892bc2733
 SHA512:
-  metadata.gz: 59976fc1a9ed5960b938ad184fbfb9adbc658a59848fbfd3572edc9aa47e7d15b75e52165ef9c38ebf4fe6f293fb61b7250974dd5b1beedb61d42aadca7f8da7
-  data.tar.gz: a286bde9aca62ec9b1f82e75a18f9a0f9882c32a708552b00236916aa804b45753d600ec453dfd93fb98005777d98e2829dc613b8103647560ca2d55a2d5718a
+  metadata.gz: 02edbe9791818a5870735afdf78285ba89eefe3dd706d00c64fb2f0404fac731ece897d497bafc593bf437a380cf05c79fa4327f0abbd8c938eb7796561f748e
+  data.tar.gz: 46610d361fb597a295dfcef48d583cb045c9ab3be1135d2d33d23aa2a5b6182f45bb79ec1bcea1954808b4a89b13c5f595b1e26a5a1421452d8603a610de6203

data/README.md

@@ -1,5 +1,5 @@
-[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
-[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](https://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
 [![Gem Version](https://badge.fury.io/rb/ftp_paradise.svg)](https://badge.fury.io/rb/ftp_paradise)
 
 ## FtpParadise - Introduction
@@ -32,7 +32,7 @@ FTP. (Evidently you have to first connect to the remote
 website via your FTP login credentials, so make sure to do
 that first before inputting commands.)
 
-## Requiring the FtpParadise library:
+## Requiring the FtpParadise library
 
 Simply do the following in order to require this project:
 
@@ -53,17 +53,6 @@ This is mostly for convenience. Use in your code whatever you
 prefer. Most may prefer foo=, I like to read a leading set_
 though, visually.
 
-## The interactive component of the FTP Paradise:
-
-The **interactive** component will properly tell the user whether
-he/she is connected to a remote host or whether the user is not
-connected, since as of the version **1.0.35**.
-
-If you need to determine manually whether you are connected, do
-input this command in the interactive shell:
-
-    connected?
-
 ## Autoconnecting (Added as of December 2017)
 
 This presently works only on my home system, by checking whether
@@ -291,29 +280,164 @@ toplevel method:
 This will return nil if no connection has been made as of
 yet.
 
+## FtpParadise::Entry
+
+This small class will represent a remote entry, that is,
+the entries that you get via .list() from a FTP-object.
+
+It contains useful methods such as .is_a_directory?
+or .is_a_file?.
+
 ## The graphical user interface (ruby-gtk3)
 
-There exists a small ruby-gtk3 client for the ftp_paradise
-gem. Unfortunately it is not complete and has a few bugs;
-if anyone wants to fix that ... :)
+There exists a small ruby-gtk3 client for the ftp_paradise gem.
+
+In <b>July 2022</b> the project was rewritten from scratch,
+with the ruby-gtk3 client as the new primary focus for this
+gem.
+
+In order to use this client, you first have to install
+the gtk3 gem, and then do:
+
+    gem install gtk_paradise
 
 For selecting a local file, you currently have to 
 double-click. At some later point I will extend this
 to one-click only.
 
+A screenshot follows next, showcasing this GUI:
+
+## The difference between .putbinaryfile() and .puttextfile()
+
+.putbinaryfile() is used for a file transfer to the remote
+server in binary mode.
+
+.puttextfile() is used to transfer a local file
+to the remote server in ASCII (aka text) mode.
+
+So what is the difference?
+
+Well, first we have to determine whether there is a 
+difference. Yes, there is - meaning you may end
+up receiving corrupt files during FTP transfer
+if the upload was handled incorrectly, aka
+the wrong mode was used.
+
+Ok, so we now know that we have to use the correct
+mode if possible.
+
+An example for a binary file is an image file
+such as <b>foobar.jpg</b>. Note that TYPE I
+means I for Image, which is the same thing 
+as binary, as far as the FTP protocol is concerned.
+
+The TYPE A command, on the other hand, where A stands
+for ASCII, is to be used if the transfer mode
+should be in ASCII.
+
+So which files should be transferred in binary
+mode?
+
+The following "table" gives a few examples here:
+
+    Image files:   .jpg, .bmp, .png
+    Sound files:   .mp3, .avi, .wma
+    Video files:   .flv, .mkv, .mov, .mp4 
+    Archive files: .zip, .rar, .tar
+    Other files:   .exe, .doc, .xls, .pdf
+
+Note that typically <b>binary</b> mode is the default.
+
+So when to use the ASCII transfer mode?
+
+Well - it is is recommended to use it only if you
+want to transfer text files, such as a .md file or
+a .txt file.
+
+Text files that use UTF-8 character encoding should
+not be transferred via ASCII mode. Examples for
+these are Japanese or Chinese text files.
+
+But why is it necessary to use the ASCII transfer mode?
+
+This is due to the way end-of-lines (EOLs) are handled.
+In FTP, EOLs in ASCII files (such as text files) are
+denoted by carriage return+line feed (CRLF) pairs
+(see RFC959). 
+
+## The FtpParadise::Shell - the interactive component of the FTP Paradise
+
+The **interactive** component of the FtpParadise project will properly
+tell the user whether he/she is connected to a remote host or whether
+the user is not connected, since as of the version **1.0.35**.
+
+You can start the interactive shell via:
+
+    bin/ftp_paradise_shell
+    ftp_paradise_shell # <- This works if you have that file added to your $PATH
+
+If you need to determine manually whether you are connected,
+do input this command in the <b>interactive shell</b>:
+
+    connected?
+    
+
+## Licence
+
+The licence for this gem is the MIT licence.
+
+Basically the most important part of the MIT licence is that, aside
+from you being able to use the project as you see fit, is the no
+warranty disclaimer to avoid any potential misuse from the use
+of the software at hand.
+
+You can read up on this licence here:
+
+https://opensource.org/licenses/MIT
+
+The usual copyright assignment is:
+
+Copyright 2022 Robert Heiler
+
+
+
+## Contact information and mandatory 2FA coming up in 2022
+
+If your creative mind has ideas and specific suggestions to make this gem
+more useful in general, feel free to drop me an email at any time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail for various reasons. In order to limit this
+explanation here, allow me to just briefly state that I do not feel as if I
+want to promote any Google service anymore, for various reasons.
+
+Do keep in mind that responding to emails may take some time, depending on
+the amount of work I may have at that moment.
+
+In 2022 rubygems.org decided to make 2FA mandatory for every gem owner:
+see https://blog.rubygems.org/2022/06/13/making-packages-more-secure.html
 
-## Contact information
+As I can not use 2FA, for reasons I will skip explaining here (see
+various github issue discussions in the past), this effectively means that
+Betty Li and others who run the show at rubygems.org will perma-ban me
+from using rubygems as a developer.
 
-If your creative mind has ideas and specific suggestions to make this
-gem more useful in general, feel free to drop me an email at any
-time, via:
+As I disagree with that decision completely, this will mean that all my
+gems will be removed from rubygems.org prior to that sunset date, e. g.
+before they permanently lock me out from the code that I used
+to maintain. It is pointless to want to discuss this with them anymore -
+they have made up their minds and decided that you can only use
+the code if 2FA is in place, even though the code itself works just
+fine. If you don't use 2FA you are effectively locked out from your
+own code; I consider this a malicious attack. See also how they limited
+discussions to people with mandatory 2FA on the ruby-bugtracker, thus
+banning everyone permanently without 2FA:  
 
-    shevegen@gmail.com
+https://bugs.ruby-lang.org/issues/18800
 
-(Do keep in mind that responding to emails may take some time, depending
-on the amount of work I may have at that moment, due to reallife. I will,
-however had, read feedback. Patches and code changes are welcome too
-of course, as long as they are in the spirit of the project at
-hand, e. g. fitting to the general theme.)
+Guess it may indeed be time to finally abandon ruby - not because
+ruby is a bad language, but there are people now in charge who
+really should not be part of ruby in the first place.
 
-Thank you.

data/bin/{iftp → ftp_paradise_shell}

@@ -4,4 +4,4 @@
 # =========================================================================== #
 require 'ftp_paradise'
 
-FtpParadise.interactive(ARGV)
+FtpParadise.shell(ARGV)

data/doc/README.gen

@@ -30,7 +30,7 @@ FTP. (Evidently you have to first connect to the remote
 website via your FTP login credentials, so make sure to do
 that first before inputting commands.)
 
-## Requiring the FtpParadise library:
+## Requiring the FtpParadise library
 
 Simply do the following in order to require this project:
 
@@ -51,17 +51,6 @@ This is mostly for convenience. Use in your code whatever you
 prefer. Most may prefer foo=, I like to read a leading set_
 though, visually.
 
-## The interactive component of the FTP Paradise:
-
-The **interactive** component will properly tell the user whether
-he/she is connected to a remote host or whether the user is not
-connected, since as of the version **1.0.35**.
-
-If you need to determine manually whether you are connected, do
-input this command in the interactive shell:
-
-    connected?
-
 ## Autoconnecting (Added as of December 2017)
 
 This presently works only on my home system, by checking whether
@@ -289,14 +278,107 @@ toplevel method:
 This will return nil if no connection has been made as of
 yet.
 
+## FtpParadise::Entry
+
+This small class will represent a remote entry, that is,
+the entries that you get via .list() from a FTP-object.
+
+It contains useful methods such as .is_a_directory?
+or .is_a_file?.
+
 ## The graphical user interface (ruby-gtk3)
 
-There exists a small ruby-gtk3 client for the ftp_paradise
-gem. Unfortunately it is not complete and has a few bugs;
-if anyone wants to fix that ... :)
+There exists a small ruby-gtk3 client for the ftp_paradise gem.
+
+In <b>July 2022</b> the project was rewritten from scratch,
+with the ruby-gtk3 client as the new primary focus for this
+gem.
+
+In order to use this client, you first have to install
+the gtk3 gem, and then do:
+
+    gem install gtk_paradise
 
 For selecting a local file, you currently have to 
 double-click. At some later point I will extend this
 to one-click only.
 
+A screenshot follows next, showcasing this GUI:
+
+## The difference between .putbinaryfile() and .puttextfile()
+
+.putbinaryfile() is used for a file transfer to the remote
+server in binary mode.
+
+.puttextfile() is used to transfer a local file
+to the remote server in ASCII (aka text) mode.
+
+So what is the difference?
+
+Well, first we have to determine whether there is a 
+difference. Yes, there is - meaning you may end
+up receiving corrupt files during FTP transfer
+if the upload was handled incorrectly, aka
+the wrong mode was used.
+
+Ok, so we now know that we have to use the correct
+mode if possible.
+
+An example for a binary file is an image file
+such as <b>foobar.jpg</b>. Note that TYPE I
+means I for Image, which is the same thing 
+as binary, as far as the FTP protocol is concerned.
+
+The TYPE A command, on the other hand, where A stands
+for ASCII, is to be used if the transfer mode
+should be in ASCII.
+
+So which files should be transferred in binary
+mode?
+
+The following "table" gives a few examples here:
+
+    Image files:   .jpg, .bmp, .png
+    Sound files:   .mp3, .avi, .wma
+    Video files:   .flv, .mkv, .mov, .mp4 
+    Archive files: .zip, .rar, .tar
+    Other files:   .exe, .doc, .xls, .pdf
+
+Note that typically <b>binary</b> mode is the default.
+
+So when to use the ASCII transfer mode?
+
+Well - it is is recommended to use it only if you
+want to transfer text files, such as a .md file or
+a .txt file.
+
+Text files that use UTF-8 character encoding should
+not be transferred via ASCII mode. Examples for
+these are Japanese or Chinese text files.
+
+But why is it necessary to use the ASCII transfer mode?
+
+This is due to the way end-of-lines (EOLs) are handled.
+In FTP, EOLs in ASCII files (such as text files) are
+denoted by carriage return+line feed (CRLF) pairs
+(see RFC959). 
+
+## The FtpParadise::Shell - the interactive component of the FTP Paradise
+
+The **interactive** component of the FtpParadise project will properly
+tell the user whether he/she is connected to a remote host or whether
+the user is not connected, since as of the version **1.0.35**.
+
+You can start the interactive shell via:
+
+    bin/ftp_paradise_shell
+    ftp_paradise_shell # <- This works if you have that file added to your $PATH
+
+If you need to determine manually whether you are connected,
+do input this command in the <b>interactive shell</b>:
+
+    connected?
+    
+LICENCE_IS_MIT
+
 ADD_CONTACT_DETAILS

data/ftp_paradise.gemspec

@@ -2,6 +2,7 @@
 # Gemspec for Project FtpParadise.
 # =========================================================================== #
 require 'ftp_paradise/version/version.rb'
+require 'roebe'
 
 Gem::Specification.new { |s|
 
@@ -42,67 +43,57 @@ EOF
   # =============================================================== #
   s.post_install_message = <<-EOF
 
-  The interactive file, which can be started by typing "iftp",
-  requires a library called configuration.
+The interactive file, which can be started by typing "iftp",
+requires a library called configuration. This is part of the
+gem called "Roebe", so you may have to install this gem
+first:
 
-  This is NOT the one available at rubygems.org - but instead can
-  be downloaded here:
+    gem install roebe
 
-      wget http://shevegen.bplaced.net/configuration-1.0.21.gem
+If you wish to start the interactive FTP, the file can be
+found at:
 
-  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.)
+    bin/iftp
 
-  If you wish to start the interactive FTP, the file can be
-  found at:
+And should on most Linux systems end up on:
 
-      bin/iftp
+    /usr/bin/iftp
 
-  And should on most Linux systems end up on:
+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).
 
-      /usr/bin/iftp
+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.
 
-  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).
+You can disable the colour-section of the interactive FTP
+by issuing:
 
-  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.
+    iftp --disable-colours
 
-  You can disable the colour-section of the interactive FTP
-  by issuing:
+You can also batch-upload some scripts through the command
+called:
 
-      iftp --disable-colours
+    ftp_upload
 
-  You can also batch-upload some scripts through the command
-  called:
+ftp_upload --help should give you some information on how
+to use it.
 
-      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!
+Thank you and have fun.
 
   EOF
 
   s.authors     = ['Robert A. Heiler']
-  s.email       = 'shevegen@gmail.com'
-  s.license     = 'GPL-2.0'
+  s.email       = Roebe.email?
+  s.license     = 'MIT'
   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.homepage    = 'https://rubygems.org/gems/ftp_paradise'
 
   s.required_ruby_version     = '>= '+RUBY_VERSION
   s.required_rubygems_version = '>= '+Gem::VERSION
@@ -117,6 +108,6 @@ EOF
   s.add_dependency 'rcfiles'
   s.add_dependency 'opn'
   s.add_dependency 'verbose_truth'
-  s.add_dependency 'gtk_paradise'
+  # s.add_dependency 'gtk_paradise'
 
 }