rest-ftp-daemon 0.242.1 → 0.242.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a814100e37f53bb5ca5286c7484f1cabaf2fed7a
-  data.tar.gz: 7cf660d4c30ecc0f48bf277c9c2a11280d92d111
+  metadata.gz: fed5f04a6d1a2f75378437123d1ee8d7d650c3d3
+  data.tar.gz: c0232b87d7c6497059ec52e539f63955ec6d78b4
 SHA512:
-  metadata.gz: 3755d63260e6530f8a2f34148127c9e1384943be2fb00cc6115d8d0df02d1eb324b511d73c0e77a17f29731c3f8b8d6318e0f53c1cf8f80c5521b2f12cb087de
-  data.tar.gz: 20e8159b35e3a60f25fda7e2175700f77b887a83a88a9f8e5184bab55a36683bc1cb9f8328e22a22e66cc254b54b1caed3276ddb57f4ae27ffc5741534a04f0f
+  metadata.gz: e8ab309003321a4e37d43ac8a02146d7640c92a745298565c5e8e751c8017c3eeb0f9c9db05a29b5d6cab8c2969535b56baee68a43498fa8f58970da7f6c2ca3
+  data.tar.gz: 4ea60d8be7aa292c831303fa75fedb855b039a2a0cf7cf2e47addf7df0828508cac781c286496dea53636e4201c680126f0af562667e697fcb48356ec66bd4fc

data/.rubocop.yml

@@ -27,6 +27,7 @@ AllCops:
   Exclude:
     - 'vendor/**/*'
     - 'DOC/**/*'
+    - '**/actors/*'
   # By default, the rails cops are not run. Override in project or home
   # directory .rubocop.yml files, or by giving the -R/--rails option.
   RunRailsCops: false
@@ -380,6 +381,7 @@ Style/FileName:
   # File names listed in AllCops:Include are excluded by default. Add extra
   # excludes here.
   Exclude: []
+  Enabled: false
 
 Style/FirstParameterIndentation:
   EnforcedStyle: special_for_inner_method_call_in_parentheses
@@ -413,7 +415,7 @@ Style/FormatString:
 
 # Built-in global variables are allowed by default.
 Style/GlobalVars:
-  AllowedVariables: []
+  AllowedVariables: ["$queue", "$pool"]
 
 # `MinBodyLength` defines the number of lines of the a body of an if / unless
 # needs to have to trigger this cop
@@ -490,7 +492,7 @@ Style/NonNilCheck:
   IncludeSemanticChanges: false
 
 Style/MethodDefParentheses:
-  EnforcedStyle: require_parentheses
+  EnforcedStyle: require_no_parentheses
   SupportedStyles:
     - require_parentheses
     - require_no_parentheses
@@ -660,7 +662,7 @@ Style/TrailingComma:
   # last item of a list, but only for lists where each item is on its own line.
   # If EnforcedStyleForMultiline is consistent_comma, the cop requires a comma
   # after the last item of a list, for all lists.
-  EnforcedStyleForMultiline: no_comma
+  EnforcedStyleForMultiline: comma
   SupportedStyles:
     - comma
     - consistent_comma
@@ -715,7 +717,7 @@ Style/VariableName:
     - camelCase
 
 Style/WhileUntilModifier:
-  MaxLineLength: 80
+  MaxLineLength: 120
 
 Style/WordArray:
   MinSize: 0
@@ -742,10 +744,10 @@ Metrics/ModuleLength:
 
 # Avoid complex methods.
 Metrics/CyclomaticComplexity:
-  Max: 6
+  Max: 10
 
 Metrics/LineLength:
-  Max: 80
+  Max: 120
   # To make it possible to copy or click on URIs in the code, we allow lines
   # contaning a URI to be longer than Max.
   AllowURI: true
@@ -755,14 +757,14 @@ Metrics/LineLength:
 
 Metrics/MethodLength:
   CountComments: false  # count full line comments?
-  Max: 10
+  Max: 20
 
 Metrics/ParameterLists:
   Max: 5
   CountKeywordArgs: true
 
 Metrics/PerceivedComplexity:
-  Max: 7
+  Max: 10
 
 ##################### Lint ##################################
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-ftp-daemon (0.242.1)
+    rest-ftp-daemon (0.242.2)
       double-bag-ftps
       facter
       get_process_mem
@@ -152,3 +152,6 @@ DEPENDENCIES
   rest-ftp-daemon!
   rspec (~> 3.1)
   rubocop (~> 0.32.0)
+
+BUNDLED WITH
+   1.10.6

data/Rakefile

@@ -2,15 +2,15 @@
 require "bundler/gem_tasks"
 require "rubygems"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
 # Run specs by default
-desc 'Run all tests'
+desc "Run all tests"
 
-require 'rubocop/rake_task'
+require "rubocop/rake_task"
 RuboCop::RakeTask.new(:rubocop) do |task|
   task.fail_on_error = false
 end
 
-task :default => [:spec, :rubocop]
+task default: [:spec, :rubocop]

data/bin/rest-ftp-daemon

@@ -23,17 +23,17 @@ puts
 # Detect options from ARGV
 options = {}
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename $0} [options] start|stop"
-  opts.on("-c", "--config CONFIGFILE")                                 { |config| APP_CONF = config }
-  opts.on("-e", "--environment ENV")                                   { |env| APP_ENV = env }
-  opts.on("",   "--dev")                                               { APP_ENV = "development" }
-  opts.on("-p", "--port PORT", "use PORT")                             { |port| options["port"] = port.to_i }
-  opts.on("-w", "--workers COUNT", "Use COUNT worker threads")         { |count| options["workers"] = count.to_i }
-  opts.on("-d", "--daemonize", "Run daemonized in the background")     { |bool| options["daemonize"] = true }
-  opts.on("-f", "--foreground", "Run in the foreground")               { |bool| options["daemonize"] = false }
-  opts.on("-P", "--pid FILE", "File to store PID")                     { |file| options["pidfile"] = file }
-  opts.on("-u", "--user NAME", "User to run daemon as (use with -g)")  { |user| options["user"] = user }
-  opts.on("-g", "--group NAME", "Group to run daemon as (use with -u)"){ |group| options["group"] = group }
+  opts.banner = "Usage: #{File.basename $PROGRAM_NAME} [options] start|stop"
+  opts.on("-c", "--config CONFIGFILE")                                  { |config| APP_CONF = config }
+  opts.on("-e", "--environment ENV")                                    { |env| APP_ENV = env }
+  opts.on("",   "--dev")                                                { APP_ENV = "development" }
+  opts.on("-p", "--port PORT", "use PORT")                              { |port| options["port"] = port.to_i }
+  opts.on("-w", "--workers COUNT", "Use COUNT worker threads")          { |count| options["workers"] = count.to_i }
+  opts.on("-d", "--daemonize", "Run daemonized in the background")      { options["daemonize"] = true }
+  opts.on("-f", "--foreground", "Run in the foreground")                { options["daemonize"] = false }
+  opts.on("-P", "--pid FILE", "File to store PID")                      { |file| options["pidfile"] = file }
+  opts.on("-u", "--user NAME", "User to run daemon as (use with -g)")   { |user| options["user"] = user }
+  opts.on("-g", "--group NAME", "Group to run daemon as (use with -u)") { |group| options["group"] = group }
 
   opts.separator ""
   opts.on_tail("-h", "--help", "Show this message")                    do
@@ -41,10 +41,9 @@ parser = OptionParser.new do |opts|
     puts TAIL_MESSAGE unless File.exist?(DEFAULT_CONFIG_PATH)
     exit
   end
-  opts.on_tail("-v", "--version", "Show version (#{APP_VER})")         { puts APP_VER; exit }
+  opts.on_tail("-v", "--version", "Show version (#{APP_VER})")         { puts(APP_VER) && exit }
 end
 
-
 # Parse options and check compliance
 begin
   parser.order!(ARGV)
@@ -119,9 +118,9 @@ puts "Daemonize    \t #{Settings.daemonize ? "YES" : "no (PID: #{Process.pid})"}
 puts "Host         \t #{Settings.host}"
 puts "Namespace    \t #{Settings.namespace}"
 puts "Network port \t #{Settings.port}"
-puts "User:group   \t #{Settings.user}:#{Settings.group}" if (Settings.user || Settings.group)
+puts "User:group   \t #{Settings.user}:#{Settings.group}" if Settings.user || Settings.group
 puts "Newrelic     \t #{Settings.newrelic_enabled? ? Settings.at(:newrelic, :licence) : "no"}"
-puts "Started at   \t #{APP_STARTED.to_s}"
+puts "Started at   \t #{APP_STARTED}"
 # puts Settings.dump
 puts
 puts "--- Thin ARGV"
@@ -132,7 +131,7 @@ puts
 # Start Thin with this rackup configuration, changing to app_root first
 begin
   Dir.chdir app_root
-  r = Thin::Runner.new(argv.flatten).run!
+  Thin::Runner.new(argv.flatten).run!
 rescue RuntimeError => e
   puts "FAILED: RuntimeError: #{e.message}"
 rescue Thin::PidFileExist
@@ -144,8 +143,8 @@ rescue Errno::ENOENT => e
 rescue SystemExit
   # Leave some time for the daemon to launch
   pidfile = Settings.pidfile
-    print "Waiting for pidfile"
-  while !File.file?(pidfile) do
+  print "Waiting for pidfile"
+  until File.file?(pidfile) do
     print "."
     sleep 0.25
   end
@@ -157,9 +156,9 @@ rescue SystemExit
     Process.kill(0, pid)
     puts "Process ##{pid} is running"
   rescue Errno::EPERM                            # changed uid
-    puts "No permission to query process ##{pid}!";
+    puts "No permission to query process ##{pid}!"
   rescue Errno::ESRCH
-    puts "Process ##{pid} is NOT running.";      # or zombied
+    puts "Process ##{pid} is NOT running."       # or zombied
   rescue
     puts "Unable to determine status for ##{pid}: #{$!}"
   end

data/config.ru

@@ -20,7 +20,7 @@ end
 GC::Profiler.enable if Settings.newrelic_enabled?
 
 # Serve static assets
-use Rack::Static, :urls => ["/css", "/js", "/images"], :root => "#{APP_LIBS}/static/"
+use Rack::Static, urls: ["/css", "/js", "/images"], root: "#{APP_LIBS}/static/"
 
 # Rack reloader and mini-profiler
 unless Settings.namespace == "production"
@@ -28,6 +28,9 @@ unless Settings.namespace == "production"
   # use Rack::MiniProfiler
 end
 
+# Set up encodings
+Encoding.default_internal = "utf-8"
+Encoding.default_external = "utf-8"
+
 # Launch the main daemon
 run RestFtpDaemon::API::Root
-#run Rack::Cascade.new [RestFtpDaemon::API::Root]

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

@@ -5,14 +5,17 @@ require "facter"
 
 module RestFtpDaemon
   module API
+
+    # Offers an HTML dashboard through the Grape API (hum...)
     class Dashbaord < Grape::API
 
-####### HELPERS
+      ### HELPERS
 
       helpers do
         def logger
           Root.logger
         end
+
         def render name, values={}
           template = File.read("#{APP_LIBS}/views/#{name}.haml")
           haml_engine = Haml::Engine.new(template)
@@ -21,13 +24,14 @@ module RestFtpDaemon
       end
 
 
-####### Common request logging
-    before do
-      log_info "HTTP #{request.request_method} #{request.fullpath}", params
-    end
+      ### Common request logging
+
+      before do
+        log_info "HTTP #{request.request_method} #{request.fullpath}", params
+      end
 
 
-####### DASHBOARD
+      ### DASHBOARD
 
       get "/" do
         # Initialize Facter

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

@@ -4,7 +4,7 @@ module RestFtpDaemon
   module API
     class Jobs < Grape::API
 
-####### HELPERS
+      ### HELPERS
 
       helpers do
         def logger
@@ -13,13 +13,13 @@ module RestFtpDaemon
       end
 
 
-####### Common request logging
-    before do
-      log_info "HTTP #{request.request_method} #{request.fullpath}", params
-    end
+      ### Common request logging
+      before do
+        log_info "HTTP #{request.request_method} #{request.fullpath}", params
+      end
 
 
-####### READ ONE JOB
+      ### READ ONE JOB
 
       desc "Read job with ID"
       params do
@@ -34,11 +34,11 @@ module RestFtpDaemon
 
         rescue RestFtpDaemon::JobNotFound => exception
           log_error "JobNotFound: #{exception.message}"
-          error!({error: :api_job_not_found, message: exception.message}, 404)
+          error!({ error: :api_job_not_found, message: exception.message }, 404)
 
         rescue StandardError => exception
           log_error "Exception: #{exception.message}"
-          error!({error: :api_exception, message: exception.message}, 500)
+          error!({ error: :api_exception, message: exception.message }, 500)
 
         else
           status 200
@@ -48,7 +48,7 @@ module RestFtpDaemon
       end
 
 
-####### READ ALL JOBS
+      ### READ ALL JOBS
 
       desc "List all Jobs"
       get "/" do
@@ -58,7 +58,7 @@ module RestFtpDaemon
 
         rescue StandardError => exception
           log_error "Exception: #{exception.message}"
-          error!({error: :api_exception, message: exception.message}, 500)
+          error!({ error: :api_exception, message: exception.message }, 500)
 
         else
           status 200
@@ -68,7 +68,7 @@ module RestFtpDaemon
       end
 
 
-####### CREATE A JOB
+      ### CREATE A JOB
 
       desc "Create a new job"
       params do

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

@@ -5,11 +5,9 @@ module RestFtpDaemon
   module API
     class Root < Grape::API
 
-
-####### CLASS CONFIG
+      ### CLASS CONFIG
 
       helpers RestFtpDaemon::LoggerHelper
-
       logger RestFtpDaemon::LoggerPool.instance.get :api
 
       do_not_route_head!
@@ -21,7 +19,7 @@ module RestFtpDaemon
       mount RestFtpDaemon::API::Dashbaord => "/"
 
 
-####### INITIALIZATION
+      ### INITIALIZATION
 
       def initialize
         # Call daddy
@@ -33,7 +31,7 @@ module RestFtpDaemon
       end
 
 
-####### HELPERS
+      ### HELPERS
 
       helpers do
         def logger
@@ -42,13 +40,14 @@ module RestFtpDaemon
       end
 
 
-####### Common request logging
-    before do
-      log_info "HTTP #{request.request_method} #{request.fullpath}", params
-    end
+      ### Common request logging
+
+      before do
+        log_info "HTTP #{request.request_method} #{request.fullpath}", params
+      end
 
 
-####### SHOW ROUTES
+      ### SHOW ROUTES
 
       desc "Show application routes"
       get "/routes" do
@@ -57,7 +56,7 @@ module RestFtpDaemon
       end
 
 
-####### SHOW STATUS
+      ### SHOW STATUS
 
       desc "Show daemon status"
       get "/status" do
@@ -74,12 +73,12 @@ module RestFtpDaemon
           status: $queue.counts_by_status,
           workers: $pool.worker_variables,
           jobs_count: $queue.jobs_count,
-          jobs_queued: $queue.queued_ids
+          jobs_queued: $queue.queued_ids,
           }
       end
 
 
-####### SHOW CONFIG
+      ### SHOW CONFIG
 
       desc "Show daemon config"
       get "/config" do
@@ -88,7 +87,7 @@ module RestFtpDaemon
       end
 
 
-####### RELOAD CONFIG
+      ### RELOAD CONFIG
 
       desc "Reload daemon config"
       post "/config/reload" do

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

@@ -1,7 +1,7 @@
 # Terrific constants
 APP_NAME = "rest-ftp-daemon"
 APP_NICK = "rftpd"
-APP_VER = "0.242.1"
+APP_VER = "0.242.2"
 
 # Provide default config file information
 APP_LIB = File.expand_path File.dirname(__FILE__)
@@ -10,7 +10,6 @@ APP_ROOT = File.expand_path(File.dirname(__FILE__) + "/../../")
 DEFAULT_CONFIG_PATH = File.expand_path "/etc/#{APP_NAME}.yml"
 SAMPLE_CONFIG_FILE = File.expand_path(File.join File.dirname(__FILE__), "/../../rest-ftp-daemon.yml.sample")
 
-#SAMPLE_CONFIG_FILE = File.expand_path("#{app_root}/#{APP_NAME}.yml.sample")
 TAIL_MESSAGE = <<EOD
 
 A default configuration is available here: #{SAMPLE_CONFIG_FILE}.
@@ -56,7 +55,7 @@ WORKER_STATUS_CLEANING  = :cleaning
 # Logging and startup
 LOG_PIPE_LEN            = 10
 LOG_COL_WID             = 8
-LOG_COL_JID             = JOB_IDENT_LEN+3+2
+LOG_COL_JID             = JOB_IDENT_LEN + 3 + 2
 LOG_COL_ID              = 6
 LOG_TRIM_LINE           = 80
 LOG_DUMPS               = File.dirname(__FILE__) + "/../../log/"
@@ -67,7 +66,7 @@ LOG_FORMAT_MESSAGE      = "%#{-LOG_COL_WID.to_i}s\t%#{-LOG_COL_JID.to_i}s\t%#{-L
 LOG_NEWLINE             = "\n"
 LOG_INDENT              = "\t"
 BIND_PORT_TIMEOUT       = 3
-BIND_PORT_LOCALHOST     = '127.0.0.1'
+BIND_PORT_LOCALHOST     = "127.0.0.1"
 
 
 # Notifications
@@ -89,7 +88,7 @@ DASHBOARD_WORKER_STYLES = {
   working:              :info,
   crashed:              :danger,
   done:                 :success,
-  dead:                 :danger
+  dead:                 :danger,
   }
 
 

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

@@ -110,7 +110,7 @@ module RestFtpDaemon
 
     def self.hide_credentials_from_url path
       return unless path.is_a? String
-      path.sub(/([a-z]+:\/\/[^\/]+):[^\/]+\@/, '\1@' )
+      path.sub(/([a-z]+:\/\/[^\/]+):[^\/]+\@/, '\1@')
     end
 
     def self.formatted_duration duration
@@ -120,11 +120,11 @@ module RestFtpDaemon
     minutes = (duration / 60) % 60
     seconds = duration % 60
 
-    out << "#{hours}h" if hours>0
-    out << "#{minutes}mn" if (minutes>0) || (hours>0)
+    out << "#{hours}h" if hours > 0
+    out << "#{minutes}mn" if (minutes > 0) || (hours > 0)
     out << "#{seconds}s"
 
-    out.join(' ')
+    out.join(" ")
     end
 
     def self.dashboard_job_link job

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

@@ -1,6 +1,8 @@
 require "securerandom"
 
 module RestFtpDaemon
+
+  # Reprensents work to be done along with parameters to process it
   class Job
     include LoggerHelper
     attr_reader :logger
@@ -29,7 +31,7 @@ module RestFtpDaemon
       attr_reader name
     end
 
-    def initialize job_id, params={}
+    def initialize job_id, params = {}
       # Call super
       # super()
 
@@ -68,7 +70,7 @@ module RestFtpDaemon
       @updated_at = Time.now
 
       # Send first notification
-      log_info "Job.initialize notify[queued] notify_after_sec[#{@notify_after_sec}] JOB_UPDATE_INTERVAL[#{JOB_UPDATE_INTERVAL}]"
+      log_info "Job.initialize notify[queued] notify_after_sec[#{@notify_after_sec}] interval[#{JOB_UPDATE_INTERVAL}]"
       client_notify :queued
     end
 
@@ -197,12 +199,12 @@ module RestFtpDaemon
       @weight = [
         - @runs.to_i,
         + @priority.to_i,
-        - @queued_at.to_i
+        - @queued_at.to_i,
         ]
     end
 
     def exectime
-      return nil if (@started_at.nil? || @finished_at.nil?)
+      return nil if @started_at.nil? || @finished_at.nil?
       (@finished_at - @started_at).round(2)
     end
 
@@ -242,7 +244,7 @@ module RestFtpDaemon
       URI.parse replace_tokens(path)
     end
 
-    def contains_brackets(item)
+    def contains_brackets item
       /\[.*\]/.match(item)
     end
 
@@ -320,7 +322,6 @@ module RestFtpDaemon
 
     def transfer
       # Update job status
-      #log_info "Job.transfer starting"
       @started_at = Time.now
 
       # Method assertions and init
@@ -335,7 +336,6 @@ module RestFtpDaemon
       set :source_count, sources.count
       set :source_files, sources.collect(&:full)
       log_info "Job.transfer sources #{sources.collect(&:name)}"
-      #log_info "Job.transfer target #{target.full}"
       raise RestFtpDaemon::JobSourceNotFound if sources.empty?
 
       # Guess target file name, and fail if present while we matched multiple sources
@@ -343,11 +343,9 @@ module RestFtpDaemon
 
       # Connect to remote server and login
       newstatus :remote_connect
-      #log_info "Job.remote_connect" # [#{host}] [#{login}]"
       @remote.connect
 
       # Prepare target path or build it if asked
-      #log_info "Job.remote_chdir"
       newstatus :remote_chdir
       @remote.chdir_or_create @target_path.dir, @mkdir
 
@@ -371,7 +369,6 @@ module RestFtpDaemon
         end
 
         # Do the transfer, for each file
-        #log_info "Job.remote_push"
         remote_push source, full_target
 
         # Update counters
@@ -387,8 +384,8 @@ module RestFtpDaemon
 
     def log_context
       {
-      wid: @wid,
-      jid: @id
+        wid: @wid,
+        jid: @id,
       }
     end
 
@@ -484,7 +481,6 @@ module RestFtpDaemon
 
       # Done
       set :source_current, nil
-      #log_info "Job.remote_push finished"
     end
 
     def progress transferred, name = ""
@@ -511,7 +507,7 @@ module RestFtpDaemon
         stack << (Helpers.format_bytes @transfer_sent, "B")
         stack << (Helpers.format_bytes @transfer_total, "B")
         stack << (Helpers.format_bytes @current_bitrate.round(0), "bps")
-        stack2 = stack.map{ |txt| ("%#{LOG_PIPE_LEN.to_i}s" % txt)}.join("\t")
+        stack2 = stack.map { |txt| ("%#{LOG_PIPE_LEN.to_i}s" % txt) }.join("\t")
         log_info "#{LOG_INDENT}progress #{stack2} \t#{name}"
 
         # Remember when we last did it
@@ -526,7 +522,7 @@ module RestFtpDaemon
           progress: percent0,
           transfer_sent: @transfer_sent,
           transfer_total: @transfer_total,
-          transfer_bitrate: @current_bitrate
+          transfer_bitrate: @current_bitrate,
           }
         client_notify :progress, status: notif_status
 

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

@@ -1,4 +1,6 @@
 module RestFtpDaemon
+
+  # Queue that stores all the Jobs waiting to be processed or fully processed
   class JobQueue
     include LoggerHelper
     attr_reader :logger
@@ -134,7 +136,7 @@ module RestFtpDaemon
     alias enq     push
     alias requeue push
 
-    def pop non_block=false
+    def pop non_block = false
       @mutex.synchronize do
         loop do
           if @queue.empty?

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

@@ -9,7 +9,7 @@ class Logger
 
     # Build prefixes depending on this context
     prefix1 = build_prefix(context)
-    prefix2 = build_prefix() + "   | "
+    prefix2 = build_prefix + "   | "
 
     lines = context[:lines]
 
@@ -36,25 +36,25 @@ 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
 
   protected
 
-    def build_from_array prefix, lines
-      lines.map do |value|
-        #text = value.to_s.strip[0..LOG_TRIM_LINE]
-        text = value.to_s[0..LOG_TRIM_LINE]
-        "#{prefix}#{text}"
-      end
+  def build_from_array prefix, lines
+    lines.map do |value|
+      #text = value.to_s.strip[0..LOG_TRIM_LINE]
+      text = value.to_s[0..LOG_TRIM_LINE]
+      "#{prefix}#{text}"
     end
+  end
 
-    def build_from_hash prefix, lines
-      lines.map do |name, value|
-        text = value.to_s.strip[0..LOG_TRIM_LINE]
-        "#{prefix}#{name}: #{text}"
-      end
+  def build_from_hash prefix, lines
+    lines.map do |name, value|
+      text = value.to_s.strip[0..LOG_TRIM_LINE]
+      "#{prefix}#{name}: #{text}"
     end
+  end
 
 end

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

@@ -28,7 +28,7 @@ module RestFtpDaemon
       logger.info_with_id message, context.merge({
         from: self.class.to_s,
         lines: lines,
-        level: level
+        level: level,
         })
     end
 

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

@@ -1,6 +1,8 @@
 require "logger"
 
 module RestFtpDaemon
+
+  # Logger interface class to access logger though symbolic names
   class LoggerPool
     include Singleton
 
@@ -27,7 +29,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

@@ -1,4 +1,6 @@
 module RestFtpDaemon
+
+  # Handles a notification POST using a dedicated thread
   class Notification
     include LoggerHelper
     attr_reader :logger

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

@@ -0,0 +1,10 @@
+module Haml
+  class Buffer
+    alias_method :haml_push_text, :push_text
+
+    def push_text text, tab_change, dont_tab_up
+      haml_push_text text.force_encoding("utf-8"), tab_change, dont_tab_up
+    end
+
+  end
+end

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

@@ -13,8 +13,11 @@ module RestFtpDaemon
     end
 
     def full
-      return @name if @dir.nil? || @dir.empty?
-      return File.join @dir, @name
+      if @dir.nil? || @dir.empty?
+        return @name
+      else
+        return File.join @dir, @name
+      end
     end
 
     def size

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

@@ -1,4 +1,6 @@
 module RestFtpDaemon
+
+  # Handles transfers for Job class
   class Remote
     include LoggerHelper
     attr_reader :logger
@@ -41,11 +43,7 @@ module RestFtpDaemon
       # Output header to STDOUT
       puts
       puts "-------------------- SESSION STARTING -------------------------"
-      #puts "job id\t #{@id}"
-      #puts "source\t #{@source}"
-      #puts "target\t #{@target}"
       puts "class\t #{myname}"
-      #puts "class\t #{myname}"
       puts "host\t #{@url.host}"
       puts "user\t #{@url.user}"
       puts "port\t #{@url.port}"

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

@@ -2,6 +2,7 @@ require "net/ftp"
 require "double_bag_ftps"
 
 module RestFtpDaemon
+  # Handles FTP and FTPeS transfers for Remote class
   class RemoteFTP < Remote
     attr_reader :ftp
 
@@ -77,12 +78,9 @@ module RestFtpDaemon
       rescue Net::FTPPermError => _e
         # If not allowed to create path, that's over, we're stuck
         return false unless mkdir
-
-        #log_info "#{LOG_INDENT}upward [#{parent}]"
         chdir_or_create parent, mkdir
 
         # Now I was able to chdir into my parent, create the current directory
-        #log_info "#{LOG_INDENT}mkdir [#{directory}]"
         mkdir "/#{directory}"
 
         # Finally retry the chdir
@@ -105,7 +103,7 @@ module RestFtpDaemon
 
       @ftp.putbinaryfile source.full, target.name, @chunk_size do |data|
         # Update the worker activity marker
-        #FIXME worker_is_still_active
+        # FIXME: worker_is_still_active
 
         # Update job status after this block transfer
         yield data.bytesize, destination.name
@@ -130,11 +128,11 @@ module RestFtpDaemon
       @ftp = Net::FTP.new
     end
 
-   def prepare_ftpes
+    def prepare_ftpes
       @ftp = DoubleBagFTPS.new
       @ftp.ssl_context = DoubleBagFTPS.create_ssl_context(verify_mode: OpenSSL::SSL::VERIFY_NONE)
       @ftp.ftps_mode = DoubleBagFTPS::EXPLICIT
-   end
+    end
 
 
   end

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

@@ -1,6 +1,7 @@
 require "net/sftp"
 
 module RestFtpDaemon
+  # Handles sFTP transfers for Remote class
   class RemoteSFTP < Remote
     attr_reader :sftp
 
@@ -81,11 +82,9 @@ module RestFtpDaemon
         return false unless mkdir
 
         # Recurse upward
-        #log_info "#{LOG_INDENT}upward [#{parent}]"
         chdir_or_create parent, mkdir
 
         # Now I was able to chdir into my parent, create the current directory
-        #log_info "#{LOG_INDENT}mkdir [#{directory}]"
         mkdir directory
 
         # Finally retry the chdir
@@ -114,7 +113,7 @@ module RestFtpDaemon
 
       # Do the transfer
       log_info "RemoteSFTP.push [#{destination.full}]"
-      @sftp.upload! source.full, destination.full do |event, uploader, *args|
+      @sftp.upload! source.full, destination.full do |event, _uploader, *args|
         case event
         when :open then
           # args[0] : file metadata
@@ -125,7 +124,7 @@ module RestFtpDaemon
           # puts "writing #{args[2].length} bytes to #{args[0].remote} starting at #{args[1]}"
 
           # Update the worker activity marker
-          #FIXME worker_is_still_active
+          # FIXME: worker_is_still_active
 
           # Update job status after this block transfer
           yield args[2].length, destination.name

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

@@ -25,8 +25,8 @@ module RestFtpDaemon
 
     def log_context
       {
-      wid: @wid,
-      jid: Thread.current.thread_variable_get(:jid),
+        wid: @wid,
+        jid: Thread.current.thread_variable_get(:jid),
       }
     end
 

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

@@ -1,4 +1,6 @@
 module RestFtpDaemon
+
+  # Worker used to clean up the queue deleting expired jobs
   class ConchitaWorker < Worker
 
     def initialize wid = :conchita

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

@@ -1,4 +1,6 @@
 module RestFtpDaemon
+
+  # Worker used to process Jobs
   class JobWorker < Worker
 
     def initialize wid

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

@@ -1,4 +1,6 @@
 module RestFtpDaemon
+
+  # Handles a pool of Worker objects
   class WorkerPool
     include LoggerHelper
     attr_reader :logger
@@ -96,10 +98,10 @@ module RestFtpDaemon
       end
     end
 
-  if Settings.newrelic_enabled?
-    add_transaction_tracer :create_conchita_thread,     category: :task
-    add_transaction_tracer :create_worker_thread,       category: :task
-  end
+    if Settings.newrelic_enabled?
+      add_transaction_tracer :create_conchita_thread,     category: :task
+      add_transaction_tracer :create_worker_thread,       category: :task
+    end
 
   end
 end

data/lib/rest-ftp-daemon.rb

@@ -1,6 +1,8 @@
+
 # Global libs
 require "rubygems"
 require "json"
+require "haml"
 require "uri"
 require "timeout"
 require "syslog"
@@ -17,7 +19,6 @@ require "newrelic_rpm"
 #   require 'flamegraph'
 # end
 
-
 # Project's libs
 require_relative "rest-ftp-daemon/constants"
 require_relative "rest-ftp-daemon/settings"
@@ -45,3 +46,6 @@ require_relative "rest-ftp-daemon/api/job_presenter"
 require_relative "rest-ftp-daemon/api/jobs"
 require_relative "rest-ftp-daemon/api/dashboard"
 require_relative "rest-ftp-daemon/api/root"
+
+# Haml monkey-patching
+require_relative "rest-ftp-daemon/patch_haml"

data/rest-ftp-daemon.gemspec

@@ -1,7 +1,6 @@
 # coding: utf-8
 
 # Libs
-#require "settingslogic"
 app_root = File.dirname(__FILE__)
 require File.expand_path("#{app_root}/lib/rest-ftp-daemon/constants")
 
@@ -17,32 +16,31 @@ Gem::Specification.new do |spec|
   spec.licenses = ["MIT"]
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f == 'dashboard.png'
+    f == "dashboard.png"
   end
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.version       = APP_VER
 
-  #spec.required_ruby_version = '>= 1.9.3'
-  spec.required_ruby_version = ">= 2.1"
+  spec.required_ruby_version = ">= 2.1.7"
 
+  # spec.add_development_dependency "rack-mini-profiler"
+  # spec.add_development_dependency "stackprof"
+  # spec.add_development_dependency "flamegraph"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 3.1"
   spec.add_development_dependency "http", "~> 0.8"
   spec.add_development_dependency "rubocop", "~> 0.32.0"
   spec.add_development_dependency "pry"
-  # spec.add_development_dependency "rack-mini-profiler"
-  # spec.add_development_dependency "stackprof"
-  # spec.add_development_dependency "flamegraph"
 
+  # spec.add_runtime_dependency "net-ssh", "~> 2.10.1.rc1"
   spec.add_runtime_dependency "thin", "~> 1.6"
   spec.add_runtime_dependency "grape"
   spec.add_runtime_dependency "grape-entity"
   spec.add_runtime_dependency "settingslogic"
   spec.add_runtime_dependency "haml"
   spec.add_runtime_dependency "json"
-  #spec.add_runtime_dependency "net-ssh", "~> 2.10.1.rc1"
   spec.add_runtime_dependency "net-sftp"
   spec.add_runtime_dependency "double-bag-ftps"
   spec.add_runtime_dependency "facter"

data/spec/rest-ftp-daemon/features/dashboard_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe 'Dashboard', feature: true do
+describe "Dashboard", feature: true do
 
   describe "GET /" do
     context 'without a password' do
@@ -9,8 +9,8 @@ describe 'Dashboard', feature: true do
       end
     end
 
-    context 'with a password' do
-      it 'can be accessed' do
+    context "with a password" do
+      it "can be accessed" do
         expect(
             get("/").status
         ).to eq 200

data/spec/rest-ftp-daemon/features/jobs_spec.rb

@@ -23,24 +23,24 @@ describe "Jobs", feature: true do
       let(:params) do
         {
           source: "/tmp/foo",
-          target: "/tmp/bar"
+          target: "/tmp/bar",
         }
       end
 
       it "issues a 201 response" do
         expect(
-          post("/jobs", json: params).status
+          post("/jobs", json: params).status,
         ).to eq 201
       end
 
       it "exposes the new job id" do
         response = JSON.parse post("/jobs", json: params)
-        expect(response['id']).not_to be_nil
+        expect(response["id"]).not_to be_nil
       end
 
       it "assigns a status" do
         response = JSON.parse post("/jobs", json: params)
-        expect(response['status']).to match(/^(queued|failed)$/)
+        expect(response["status"]).to match(/^(queued|failed)$/)
       end
 
       it "creates a new job" do
@@ -53,14 +53,14 @@ describe "Jobs", feature: true do
 
   describe "GET /jobs/:id" do
     let(:creation_response) do
-      JSON.parse post("/jobs", json: {source: "/tmp/foo", target: "/tmp/bar"}).body
+      JSON.parse post("/jobs", json: { source: "/tmp/foo", target: "/tmp/bar" }).body
     end
 
-    let(:job_id) { creation_response.fetch('id') }
+    let(:job_id) { creation_response.fetch("id") }
 
     it "is properly exposed" do
       expect(
-        get("/jobs/#{job_id}").status
+        get("/jobs/#{job_id}").status,
       ).to eq 200
     end
   end # GET /jobs/:id

data/spec/rest-ftp-daemon/features/routes_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe 'Routes', feature: true do
+describe "Routes", feature: true do
 
   let!(:response) { get "/routes" }
 

data/spec/rest-ftp-daemon/features/status_spec.rb

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe 'Status', feature: true do
+describe "Status", feature: true do
 
   let!(:response) { get "/status" }
 

data/spec/spec_helper.rb

@@ -38,7 +38,7 @@ RSpec.configure do |config|
     # Use the documentation formatter for detailed output,
     # unless a formatter has already been configured
     # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
+    config.default_formatter = "doc"
   end
 
   # Print the 10 slowest examples and example groups at the
@@ -51,8 +51,8 @@ RSpec.configure do |config|
 
   include RequestHelpers
 
-  def call_server(command, config = Pathname(__dir__).join("support/config.yml"), port = RequestHelpers::PORT)
-    system(Pathname(__dir__).join("../bin/rest-ftp-daemon -e test -c #{config} #{command} -p #{port}").to_s, chdir: __dir__) or fail "Could not #{command} server"
+  def call_server command, config = Pathname(__dir__).join("support/config.yml"), port = RequestHelpers::PORT
+    system(Pathname(__dir__).join("../bin/rest-ftp-daemon -e test -c #{config} #{command} -p #{port}").to_s, chdir: __dir__) || fail("Could not #{command} server")
   end
 
   config.before :suite do

data/spec/support/request_helpers.rb

@@ -5,18 +5,18 @@ require "uri"
 module RequestHelpers
   PORT = 5678
 
-  def get(path, options = {})
+  def get path, options = {}
     accept = options.delete(:accept) { :json }
     url = URI("http://localhost:#{PORT}").merge(path)
-    HTTP.accept(accept).basic_auth(user: 'admin', pass: 'admin').
-      get(url, options)
+    HTTP.accept(accept).basic_auth(user: "admin", pass: "admin")
+      .get(url, options)
   end
 
-  def post(path, options = {})
+  def post path, options = {}
     accept = options.delete(:accept) { :json }
     url = URI("http://localhost:#{PORT}").merge(path)
-    HTTP.accept(accept).basic_auth(user: 'admin', pass: 'admin').
-      post(url, options)
+    HTTP.accept(accept).basic_auth(user: "admin", pass: "admin")
+      .post(url, options)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-ftp-daemon
 version: !ruby/object:Gem::Version
-  version: 0.242.1
+  version: 0.242.2
 platform: ruby
 authors:
 - Bruno MEDICI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -296,6 +296,7 @@ files:
 - lib/rest-ftp-daemon/logger_pool.rb
 - lib/rest-ftp-daemon/notification.rb
 - lib/rest-ftp-daemon/paginate.rb
+- lib/rest-ftp-daemon/patch_haml.rb
 - lib/rest-ftp-daemon/path.rb
 - lib/rest-ftp-daemon/remote.rb
 - lib/rest-ftp-daemon/remote_ftp.rb
@@ -337,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: 2.1.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -345,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: RESTful FTP client daemon