ftp_paradise 1.4.5

data/lib/ftp_paradise/toplevel_methods/is_on_roebe.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/is_on_roebe.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === FtpParadise.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts FtpParadise.is_on_roebe?
+end

data/lib/ftp_paradise/toplevel_methods/login_name.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/login_name.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'yaml'
+  require 'ftp_paradise/constants/roebe.rb'
+
+  # ========================================================================= #
+  # === @login_name
+  # ========================================================================= #
+  @login_name = nil
+
+  # ========================================================================= #
+  # === FtpParadise.login_name?
+  # ========================================================================= #
+  def self.login_name?
+    @login_name
+  end; self.instance_eval { alias username? login_name? } # === FtpParadise.username?
+
+  # ========================================================================= #
+  # === FtpParadise.set_login_name
+  # ========================================================================= #
+  def self.set_login_name(
+      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)['podserver']['user_name']
+      end
+    end
+    @login_name = i
+  end; self.instance_eval { alias set_user_name set_login_name } # === FtpParadise.set_user_name
+       self.instance_eval { alias set_username  set_login_name } # === FtpParadise.set_username
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise.set_login_name
+  puts FtpParadise.login_name?
+end

data/lib/ftp_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/misc.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === FtpParadise.return_pwd
+  # ========================================================================= #
+  def self.return_pwd
+    return ("#{Dir.pwd}/").squeeze('/')
+  end
+
+end

data/lib/ftp_paradise/toplevel_methods/opn.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/opn.rb'
+# =========================================================================== #
+module FtpParadise
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  require 'ftp_paradise/constants/namespace.rb'
+
+  # ========================================================================= #
+  # === FtpParadise.opn
+  # ========================================================================= #
+  def self.opn(
+      i = { namespace: NAMESPACE }
+    )
+    Opn.opn(i) if Object.const_defined? :Opn
+  end; self.instance_eval { alias opnn opn } # === FtpParadise.opnn
+
+end

data/lib/ftp_paradise/toplevel_methods/password.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/password.rb'
+# =========================================================================== #
+module FtpParadise
+
+  require 'yaml'
+  require 'ftp_paradise/constants/roebe.rb'
+
+  # ========================================================================= #
+  # === @password
+  #
+  # This variable will keep track of the password to the remote FTP
+  # host. This allows you to use FtpParadise without instantiating
+  # the main class of this project.
+  # ========================================================================= #
+  @password = nil
+
+  # ========================================================================= #
+  # === FtpParadise.password?
+  # ========================================================================= #
+  def self.password?
+    @password
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.set_password
+  # ========================================================================= #
+  def self.set_password(
+      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']
+      end
+    end
+    @password = i
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise.set_password
+  puts FtpParadise.password?
+end

data/lib/ftp_paradise/toplevel_methods/port.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/port.rb' 
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === @port
+  # ========================================================================= #
+  @port = 21
+
+  # ========================================================================= #
+  # === FtpParadise.set_port
+  # ========================================================================= #
+  def self.set_port(
+      i = :try_to_infer_automatically
+    )
+    case i
+    when :try_to_infer_automatically
+      if File.exist? FILE_ROEBE_FTP
+        i = YAML.load_file(FILE_ROEBE_FTP)['podcast']['port']
+      end
+    end
+    @port = i
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.port?
+  # ========================================================================= #
+  def self.port?
+    @port
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise.set_port
+  puts FtpParadise.port?
+end

data/lib/ftp_paradise/toplevel_methods/rds.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/rds.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === FtpParadise.rds
+  #
+  # Use this method to remove double '//' entry.
+  # ========================================================================= #
+  def self.rds(i)
+    i.squeeze '/'
+  end
+
+end

data/lib/ftp_paradise/toplevel_methods/remote_url.rb

@@ -0,0 +1,57 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/remote_url.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === @remote_url
+  #
+  # This variable will keep track of the remote url.
+  # ========================================================================= #
+  @remote_url = nil
+
+  # ========================================================================= #
+  # === FtpParadise.remote_url?
+  #
+  # Return the @remote_url variable.
+  # ========================================================================= #
+  def self.remote_url?
+    @remote_url
+  end
+
+  require 'yaml'
+  require 'ftp_paradise/toplevel_methods/is_on_roebe.rb'
+  require 'ftp_paradise/constants/roebe.rb'
+  # ========================================================================= #
+  # === FtpParadise.set_remote_url
+  #
+  # Setter-method for @remote_url. Will be nil initially.
+  # ========================================================================= #
+  def self.set_remote_url(
+      i = :try_to_infer
+    )
+    case i
+    when nil, :infer, :try_to_infer
+      if is_on_roebe?
+        if File.exist? FILE_ROEBE_FTP
+          i = YAML.load_file(FILE_ROEBE_FTP)['bytehost']['url']
+        end
+      end
+    end
+    @remote_url = i
+  end; self.instance_eval { alias set_remote_host set_remote_url } # === FtpParadise.set_remote_host 
+
+  # ========================================================================= #
+  # Initialize it to the default value.
+  # ========================================================================= #
+  set_remote_url
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  FtpParadise.set_remote_url
+  puts FtpParadise.remote_url?
+end # ftp_remote_url

data/lib/ftp_paradise/toplevel_methods/time.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/time.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === FtpParadise.return_date
+  #
+  # This method will return a String such as "03.12.2014".
+  # ========================================================================= #
+  def self.return_date
+    Time.now.strftime('%d.%m.%Y')
+  end
+
+  # ========================================================================= #
+  # === return_date
+  # ========================================================================= #
+  def return_date
+    FtpParadise.return_date
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.return_time
+  #
+  # This method will return a String such as "15:55:30".
+  # ========================================================================= #
+  def self.return_time
+    Time.now.strftime('%H:%M:%S')
+  end
+
+  # ========================================================================= #
+  # === return_time
+  # ========================================================================= #
+  def return_time
+    FtpParadise.return_time
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts FtpParadise.return_time
+end

data/lib/ftp_paradise/toplevel_methods/upload_and_download.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'ftp_paradise/toplevel_methods/upload_and_download.rb'
+# FtpParadise.download
+# =========================================================================== #
+module FtpParadise
+
+  require 'ftp_paradise/toplevel_methods/e.rb'
+  require 'ftp_paradise/toplevel_methods/opn.rb'
+
+  # ========================================================================= #
+  # === FtpParadise.upload_this_binary_file
+  #
+  # This method shall allow you to upload a binary file to a remote host.
+  #
+  # For now, this has my FTP information hardcoded.
+  #
+  # Usage examples:
+  #
+  #   FtpParadise.upload_this_binary_file("/home/x/src/htop/htop-2.0.2.tar.xz")
+  #   FtpParadise.upload_this_binary_file("/home/x/src/htop/htop-2.0.2.tar.xz") {{ cd_into_this_directory: 'htdocs/' }}
+  #   FtpParadise.upload_this_binary_file("/home/x/src/htop/htop-2.0.2.tar.xz") {{ cd_into_this_directory: 'www/' }}
+  #   upload_this_binary_file /home/x/src/htop/htop-2.0.2.tar.xz
+  #   upload_this_binary_file /home/x/src/htop/htop-2.0.2.tar.xz
+  #
+  # ========================================================================= #
+  def self.upload_this_binary_file(
+      file,
+      be_verbose             = :be_silent,
+      use_this_as_ftp_object = nil
+    )
+    yielded = nil
+    yielded = yield if block_given?
+    case yielded
+    when :be_quiet
+      be_verbose = false
+    end
+    case be_verbose
+    when :be_silent
+      be_verbose = false
+    end
+    unless use_this_as_ftp_object
+      require 'ftp_paradise/connection/connection.rb'
+      use_this_as_ftp_object = ::FtpParadise::Connection.new(:dont_run_yet) { :default_dataset }
+      if be_verbose
+        use_this_as_ftp_object.be_verbose
+      else
+        use_this_as_ftp_object.be_quiet
+      end
+      use_this_as_ftp_object.set_binary_mode
+    end
+    if yielded
+      if yielded.is_a? Hash
+        if yielded.has_key? :cd_into_this_directory
+          use_this_as_ftp_object.remote_cd(yielded[:cd_into_this_directory])
+        end
+      end
+    end
+    use_this_as_ftp_object.upload(file, be_verbose) # Here, do the FTP upload finally. 
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.download
+  # ========================================================================= #
+  def self.download(
+      this_remote_file,
+      use_this_ftp_object
+    )
+    use_this_ftp_object.gettextfile(
+      this_remote_file
+    )
+  end
+
+  # ========================================================================= #
+  # === FtpParadise.upload
+  #
+  # This toplevel-method can be used to upload something to a remote
+  # target.
+  #
+  # The second argument called `to` will tell us where to upload to.
+  # ========================================================================= #
+  def self.upload(
+      local_target,
+      remote_target       = :short_variant,
+      use_this_ftp_object = :shevy,
+      &block
+    )
+    case remote_target
+    when :short_variant
+      remote_target = File.basename(local_target)
+    end
+    if use_this_ftp_object.is_a? Symbol
+      require 'ftp_paradise/connection/connection.rb'
+      use_this_ftp_object = FtpParadise::Connection.new(:dont_run_yet)
+      opn; e "We will now connect to #{sfancy(use_this_ftp_object.to_s)}."
+      use_this_ftp_object.connect_to
+      use_this_ftp_object.upload(local_target)
+    end
+    use_this_ftp_object.put(
+      local_target,
+      remotefile = File.basename(localfile),
+      &block
+    )
+  end
+
+end

data/lib/ftp_paradise/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen-string-literal: true
+# =========================================================================== #
+# require 'ftp_paradise/version/version.rb'
+# =========================================================================== #
+module FtpParadise
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.4.5'
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  p FtpParadise::VERSION
+  p FtpParadise::VERSION.frozen?
+end