rest-ftp-daemon 0.221.2 → 0.222.0

data/lib/rest-ftp-daemon/api/root.rb

@@ -12,11 +12,12 @@ module RestFtpDaemon
       do_not_route_head!
       do_not_route_options!
 
-      # FIXME
-      # add_swagger_documentation
-      # default_error_formatter :json
       format :json
 
+      mount RestFtpDaemon::API::Jobs => "/jobs"
+      mount RestFtpDaemon::API::Dashbaord => "/"
+
+
 
 ####### INITIALIZATION
 
@@ -38,25 +39,44 @@ module RestFtpDaemon
           Root.logger
         end
 
-        # def log_context
-        #   {}
-        # end
+      end
 
-        def api_error exception
-          {
-          :error => exception.message,
-          #:message => exception.backtrace.first,
-          }
-        end
 
-        def render name, values={}
-          template = File.read("#{APP_LIBS}/views/#{name.to_s}.haml")
-          haml_engine = Haml::Engine.new(template)
-          haml_engine.render(binding, values)
-        end
+####### GET /routes
 
+      desc "show application routes"
+      get "/routes" do
+        log_info "GET /routes"
+        status 200
+        return RestFtpDaemon::API::Root.routes
       end
 
+
+####### GET /status
+
+      # Server global status
+      get "/status" do
+        log_info "GET /status"
+        mem = GetProcessMem.new
+
+        status 200
+        return  {
+          hostname: `hostname`.chomp,
+          version: APP_VER,
+          started: APP_STARTED,
+          uptime: (Time.now - APP_STARTED).round(1),
+          counters: $queue.counters,
+          memory_bytes: mem.bytes.to_i,
+          memory_mb: mem.mb.round(0),
+          status: $queue.counts_by_status,
+          workers: $pool.worker_variables,
+          jobs_count: $queue.jobs_count,
+          jobs_queued: $queue.queued_ids,
+          config: Helpers.get_censored_config
+          }
+      end
+
+
     end
   end
 end

data/lib/rest-ftp-daemon/constants.rb

@@ -1,7 +1,7 @@
 # Terrific constants
 APP_NAME = "rest-ftp-daemon"
 APP_NICK = "rftpd"
-APP_VER = "0.221.2"
+APP_VER = "0.222.0"
 
 
 # Jobs and workers
@@ -21,8 +21,8 @@ LOG_COL_WID             = 8
 LOG_COL_JID             = JOB_IDENT_LEN+3+2
 LOG_COL_ID              = 6
 LOG_TRIM_LINE           = 80
-LOG_DUMPS               = File.dirname(__FILE__) + '/../../log/'
-LOG_ROTATION            = 'daily'
+LOG_DUMPS               = File.dirname(__FILE__) + "/../../log/"
+LOG_ROTATION            = "daily"
 LOG_FORMAT_TIME         = "%Y-%m-%d %H:%M:%S"
 LOG_FORMAT_PREFIX       = "%s %s\t%-#{LOG_PIPE_LEN.to_i}s\t"
 LOG_FORMAT_MESSAGE      = "%#{-LOG_COL_WID.to_i}s\t%#{-LOG_COL_JID.to_i}s\t%#{-LOG_COL_ID.to_i}s"
@@ -43,11 +43,11 @@ JOB_STYLES = {
   JOB_STATUS_RENAMING   => :info,
   }
 WORKER_STYLES = {
-  :waiting              => :success,
-  :working              => :info,
-  :crashed              => :danger,
-  :done                 => :success,
-  :dead                 => :danger
+  waiting:              :success,
+  working:              :info,
+  crashed:              :danger,
+  done:                 :success,
+  dead:                 :danger
   }
 PAGINATE_MAX            = 30
 

data/lib/rest-ftp-daemon/helpers.rb

@@ -16,12 +16,13 @@ module RestFtpDaemon
       converted = number.to_f / ( 1024 ** index )
 
       truncated = converted.round(decimals)
+
       "#{truncated} #{units[index]}#{unit}"
     end
 
     def self.text_or_empty text
       return "-" if text.nil? || text.empty?
-      # return "Ø" if text.nil? || text.empty?
+
       text
     end
 
@@ -37,10 +38,6 @@ module RestFtpDaemon
       path.gsub(/(\[[^\[]+\])/, '<span class="token">\1</span>')
     end
 
-    # def self.hide_password url
-    #   path.gsub(/(\[[^\[]+\])/, '<span class="token">\1</span>')
-    # end
-
     def self.extract_filename path
       # match everything that's after a slash at the end of the string
       m = path.match /\/?([^\/]+)$/
@@ -60,10 +57,10 @@ module RestFtpDaemon
     end
 
     def self.local_port_used? port
-      ip = '0.0.0.0'
+      ip = "127.0.0.1"
       timeout = 1
       begin
-        Timeout::timeout(timeout) do
+        Timeout.timeout(timeout) do
           begin
             TCPSocket.new(ip, port).close
             true
@@ -82,13 +79,13 @@ module RestFtpDaemon
       return if method.nil?
       klass = case method
       when :file
-        'label-primary'
+        "label-primary"
       when :ftp
-        'label-warning'
+        "label-warning"
       when :ftps, :ftpes
-        'label-success'
+        "label-success"
       else
-        'label-default'
+        "label-default"
       end
       "<div class=\"transfer-method label #{klass}\">#{method.upcase}</div>"
     end
@@ -96,7 +93,8 @@ module RestFtpDaemon
     # Dates and times: date with time generator
     def self.datetime_full datetime
       return "-"  if datetime.nil?
-      return datetime.to_datetime.strftime("%d.%m.%Y %H:%M:%S")
+
+      datetime.to_datetime.strftime("%d.%m.%Y %H:%M:%S")
     end
 
     def self.datetime_short datetime
@@ -104,7 +102,8 @@ module RestFtpDaemon
       return "-" if datetime.nil?
       return "?" unless datetime.respond_to? :to_date
       return datetime.to_datetime.strftime("%H:%M:%S") if datetime.to_date == Time.now.to_date
-      return datetime.to_datetime.strftime("%d/%m %H:%M:%S")
+
+      datetime.to_datetime.strftime("%d/%m %H:%M:%S")
     end
 
     def self.hide_credentials_from_url url

data/lib/rest-ftp-daemon/job.rb

@@ -48,7 +48,7 @@ module RestFtpDaemon
 
       # Import query params
       FIELDS.each do |name|
-        instance_variable_set "@#{name.to_s}", params[name]
+        instance_variable_set "@#{name}", params[name]
       end
 
       # Set super-default flags
@@ -106,7 +106,7 @@ module RestFtpDaemon
       # rescue RestFtpDaemon::RestFtpDaemonException => exception
       #   return oops :started, exception, :prepare_failed, true
 
-      # rescue Exception => exception
+      # rescue StandardError => exception
       #   return oops :started, exception, :prepare_unhandled, true
 
       else
@@ -182,7 +182,7 @@ module RestFtpDaemon
       # rescue RestFtpDaemon::RestFtpDaemonException => exception
       #   return oops :ended, exception, :transfer_failed, true
 
-      # rescue Exception => exception
+      # rescue StandardError => exception
       #   return oops :ended, exception, :transfer_unhandled, true
 
       else
@@ -216,11 +216,11 @@ module RestFtpDaemon
     end
 
     def oops_after_crash exception
-      return oops :ended, exception, :crashed
+      oops :ended, exception, :crashed
     end
 
     def oops_you_stop_now exception
-      return oops :ended, exception, :timeout
+      oops :ended, exception, :timeout
     end
 
   protected
@@ -243,7 +243,7 @@ module RestFtpDaemon
     end
 
     def expand_url path
-      URI::parse replace_tokens(path)
+      URI.parse replace_tokens(path)
     end
 
     def contains_brackets(item)
@@ -256,7 +256,7 @@ module RestFtpDaemon
       vectors = Settings.endpoints.clone
 
       # Stack RANDOM into tokens
-      vectors['RANDOM'] = SecureRandom.hex(JOB_RANDOM_LEN)
+      vectors["RANDOM"] = SecureRandom.hex(JOB_RANDOM_LEN)
 
       # Replace endpoints defined in config
       newpath = path.clone
@@ -269,7 +269,7 @@ module RestFtpDaemon
       raise RestFtpDaemon::JobUnresolvedTokens if contains_brackets newpath
 
       # All OK, return this URL stripping multiple slashes
-      return newpath.gsub(/([^:])\/\//, '\1/')
+      newpath.gsub(/([^:])\/\//, '\1/')
     end
 
     def prepare
@@ -293,11 +293,11 @@ module RestFtpDaemon
       @target_url = expand_url @target
       set :target_url, @target_url.to_s
 
-      if @target_url.kind_of? URI::FTP
+      if @target_url.is_a? URI::FTP
         @target_method = :ftp
-      elsif @target_url.kind_of? URI::FTPES
+      elsif @target_url.is_a? URI::FTPES
         @target_method = :ftps
-      elsif @target_url.kind_of? URI::FTPS
+      elsif @target_url.is_a? URI::FTPS
         @target_method = :ftps
       end
       set :target_method, @target_method
@@ -309,7 +309,7 @@ module RestFtpDaemon
 
     def transfer
       # Update job status
-      newstatus = :checking_source
+      newstatus :checking_source
       @started_at = Time.now
 
       # Method assertions and init
@@ -390,7 +390,7 @@ module RestFtpDaemon
 
     def flag_default name, default
       # build the flag instance var name
-      variable = "@#{name.to_s}"
+      variable = "@#{name}"
 
       # If it's true or false, that's ok
       return if [true, false].include? instance_variable_get(variable)
@@ -413,7 +413,7 @@ module RestFtpDaemon
         @ftp = Net::FTP.new
       when :ftps
         @ftp = DoubleBagFTPS.new
-        @ftp.ssl_context = DoubleBagFTPS.create_ssl_context(:verify_mode => OpenSSL::SSL::VERIFY_NONE)
+        @ftp.ssl_context = DoubleBagFTPS.create_ssl_context(verify_mode: OpenSSL::SSL::VERIFY_NONE)
         @ftp.ftps_mode = DoubleBagFTPS::EXPLICIT
       else
         log_info "Job.ftp_init unknown scheme [#{@target_url.scheme}]"
@@ -513,7 +513,7 @@ module RestFtpDaemon
         # Try to chdir in this directory
         @ftp.chdir(path)
 
-      rescue Net::FTPPermError => exception
+      rescue Net::FTPPermError
         # If not possible because the directory is missing
         parent =  Helpers.extract_parent(path)
         log_info "#{pref} chdir failed - parent [#{parent}]"
@@ -553,7 +553,8 @@ module RestFtpDaemon
 
       # Result can be nil or a list of files
       return false if results.nil?
-      return results.count >0
+
+      results.count >0
     end
 
     def ftp_transfer source_filename, target_name = nil
@@ -668,7 +669,7 @@ module RestFtpDaemon
       payload[:event] = event
       RestFtpDaemon::Notification.new @notify, payload
 
-    rescue Exception => ex
+    rescue StandardError => ex
       log_error "Job.client_notify EXCEPTION: #{ex.inspect}"
      end
 
@@ -684,7 +685,7 @@ module RestFtpDaemon
       # Log this error
       error = exception.class if error.nil?
 
-      message = "Job.oops event[#{event.to_s}] error[#{error.to_s}] ex[#{exception.class}] #{exception.message}"
+      message = "Job.oops event[#{event}] error[#{error}] ex[#{exception.class}] #{exception.message}"
       if include_backtrace
         log_error message, exception.backtrace
       else
@@ -715,14 +716,14 @@ module RestFtpDaemon
 
       # Prepare notification if signal given
       return unless event
-      client_notify event, error: error, status: notif_status, message: "#{exception.class.to_s} | #{exception.message}"
+      client_notify event, error: error, status: notif_status, message: "#{exception.class} | #{exception.message}"
     end
 
     if Settings.newrelic_enabled?
-      add_transaction_tracer :prepare, :category => :task
-      add_transaction_tracer :transfer, :category => :task
-      add_transaction_tracer :client_notify, :category => :task
-      add_transaction_tracer :initialize, :category => :task
+      add_transaction_tracer :prepare,        category: :task
+      add_transaction_tracer :transfer,       category: :task
+      add_transaction_tracer :client_notify,  category: :task
+      add_transaction_tracer :initialize,     category: :task
     end
 
   end

data/lib/rest-ftp-daemon/job_queue.rb

@@ -6,7 +6,6 @@ module RestFtpDaemon
     attr_reader :queue
     attr_reader :jobs
 
-
     if Settings.newrelic_enabled?
       include ::NewRelic::Agent::Instrumentation::ControllerInstrumentation
     end
@@ -18,7 +17,7 @@ module RestFtpDaemon
       @waiting = []
       @queue.taint          # enable tainted communication
       @waiting.taint
-      self.taint
+      taint
       @mutex = Mutex.new
 
       # Logger
@@ -186,7 +185,7 @@ module RestFtpDaemon
 
           # Ok, we have to clean it up ..
           log_info "expire [#{status.to_s}] [#{maxage}] > [#{job.id}] [#{job.updated_at}]"
-          log_info "       + unqueued" if @queue.delete(job)
+          log_info "       & unqueued" if @queue.delete(job)
 
           true
         end
@@ -208,12 +207,12 @@ module RestFtpDaemon
     end
 
     if Settings.newrelic_enabled?
-      add_transaction_tracer :push, :category => :task
-      add_transaction_tracer :pop, :category => :task
-      add_transaction_tracer :sort_queue!, :category => :task
-      add_transaction_tracer :expire, :category => :task
-      add_transaction_tracer :counts_by_status, :category => :task
-      add_transaction_tracer :filter_jobs, :category => :task
+      add_transaction_tracer :push,             category: :task
+      add_transaction_tracer :pop,              category: :task
+      add_transaction_tracer :sort_queue!,      category: :task
+      add_transaction_tracer :expire,           category: :task
+      add_transaction_tracer :counts_by_status, category: :task
+      add_transaction_tracer :filter_jobs,      category: :task
     end
 
   end

data/lib/rest-ftp-daemon/logger.rb

@@ -7,20 +7,8 @@ class Logger
 
     # Build prefixes depending on this context
     prefix1 = build_prefix(context)
-    prefix2 = build_prefix() + '   | '
+    prefix2 = build_prefix() + "   | "
 
-    # # Build output lines
-    # output = []
-    # output << prefix1 + message.strip
-
-    # # Add optional lines
-    # context[:lines].each do |line|
-    #   # line.strip!
-    #   # next if line.empty?
-    #   output << prefix2 + line[0..LOG_TRIM_LINE]
-    # end if context[:lines].is_a? Enumerable
-
-    # Use "context[:lines]" according to its type
     lines = context[:lines]
 
     if lines.is_a? Hash
@@ -47,7 +35,7 @@ class Logger
       context[:wid].to_s,
       context[:jid].to_s,
       context[:id].to_s,
-      context[:level].to_i+1,
+      context[:level].to_i+1
     ]
   end
 

data/lib/rest-ftp-daemon/logger_pool.rb

@@ -25,7 +25,7 @@ module RestFtpDaemon
         prefix = LOG_FORMAT_PREFIX % [
           datetime.strftime(LOG_FORMAT_TIME),
           severity,
-          progname,
+          progname
         ]
 
         # If we have a bunch of lines, prefix them and send them together

data/lib/rest-ftp-daemon/notification.rb

@@ -31,7 +31,7 @@ module RestFtpDaemon
       # Build body and extract job ID if provided
       body = {
         id:       params[:id].to_s,
-        signal:   "#{NOTIFY_PREFIX}.#{params[:event].to_s}",
+        signal:   "#{NOTIFY_PREFIX}.#{params[:event]}",
         error:    params[:error],
         host:     Settings.host.to_s,
         }
@@ -42,13 +42,13 @@ module RestFtpDaemon
 
 
       # Send message in a thread
-      Thread.new do |thread|
+      Thread.new do
         # Prepare query
         uri = URI(url)
         headers = {
-          'Content-Type'  => 'application/json',
-          'Accept'        => 'application/json',
-          'User-Agent'    => "#{APP_NAME} - #{APP_VER}"
+          "Content-Type"  => "application/json",
+          "Accept"        => "application/json",
+          "User-Agent"    => "#{APP_NAME} - #{APP_VER}"
            }
         data = body.to_json
         log_info "sending #{data}"