rest-ftp-daemon 0.242.2 → 0.242.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fed5f04a6d1a2f75378437123d1ee8d7d650c3d3
-  data.tar.gz: c0232b87d7c6497059ec52e539f63955ec6d78b4
+  metadata.gz: 1ecbe20206a3af518da510a31113cf02b3e198cf
+  data.tar.gz: bcae2929dc73d34920c7730a04c4c51836e58f17
 SHA512:
-  metadata.gz: e8ab309003321a4e37d43ac8a02146d7640c92a745298565c5e8e751c8017c3eeb0f9c9db05a29b5d6cab8c2969535b56baee68a43498fa8f58970da7f6c2ca3
-  data.tar.gz: 4ea60d8be7aa292c831303fa75fedb855b039a2a0cf7cf2e47addf7df0828508cac781c286496dea53636e4201c680126f0af562667e697fcb48356ec66bd4fc
+  metadata.gz: da5f0d7ecde70351eea2a3857b3b0726953b3a1134b5023076b86ecadd5067859fa611bcec67613e0544f13bc9da8f561d722ecb6813aa855c01e0fcf084b6eb
+  data.tar.gz: ebc98fb0f9d944678cafa24253817f6e6d9669891356fd63037d5ba4bfb8682c18c49a213278ab624a9403ac7cafda746aea87fe391f59ae417a98f530febeef

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-ftp-daemon (0.242.2)
+    rest-ftp-daemon (0.242.3)
       double-bag-ftps
       facter
       get_process_mem

data/README.md

@@ -136,7 +136,7 @@ Those tokens will be expanded when the job is run:
 
 ```
 curl -H "Content-Type: application/json" -X POST -D /dev/stdout -d \
-'{"source":"~/file.dmg","priority":"3", target":"ftp://anonymous@localhost/incoming/dest4.dmg","notify":"http://requestb.in/1321axg1"}' "http://localhost:3000/jobs"
+'{"source":"~/file.dmg","priority":"3","target":"ftp://anonymous@localhost/incoming/dest4.dmg","notify":"http://requestb.in/1321axg1"}' "http://localhost:3000/jobs"
 ```
 
 

data/config.ru

@@ -29,8 +29,8 @@ unless Settings.namespace == "production"
 end
 
 # Set up encodings
-Encoding.default_internal = "utf-8"
-Encoding.default_external = "utf-8"
+# Encoding.default_internal = "utf-8"
+# Encoding.default_external = "utf-8"
 
 # Launch the main daemon
 run RestFtpDaemon::API::Root

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

@@ -26,7 +26,7 @@ module RestFtpDaemon
         expose :exectime
 
         # Params
-        expose :params, unless: :hide_params
+        expose :infos, unless: :hide_infos
 
       end
 

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

@@ -14,6 +14,7 @@ module RestFtpDaemon
       do_not_route_options!
 
       format :json
+      content_type :json, 'application/json; charset=utf-8'
 
       mount RestFtpDaemon::API::Jobs => "/jobs"
       mount RestFtpDaemon::API::Dashbaord => "/"
@@ -87,6 +88,37 @@ module RestFtpDaemon
       end
 
 
+      desc "List all Jobs params encodings"
+      get "/encodings" do
+        # Get jobs to display
+        encodings = {}
+        jobs = $queue.jobs
+
+        jobs.each do |job|
+          # here = out[job.id] = {}
+          me = encodings[job.id] = {}
+
+          me[:error] = job.error.encoding.to_s unless job.error.nil?
+          me[:status] = job.status.encoding.to_s unless job.status.nil?
+
+          Job::FIELDS.each do |name|
+            value = job.send(name)
+            me[name] = value.encoding.to_s if value.is_a? String
+          end
+
+          job.infos.each do |name, value|
+            me["infos_#{name}"] = value.encoding.to_s if value.is_a? String
+          end
+
+          # # Computed fields
+          # expose :age
+          # expose :exectime
+        end
+
+        encodings
+      end
+
+
       ### RELOAD CONFIG
 
       desc "Reload daemon config"

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.2"
+APP_VER = "0.242.3"
 
 # Provide default config file information
 APP_LIB = File.expand_path File.dirname(__FILE__)

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

@@ -25,7 +25,7 @@ module RestFtpDaemon
     attr_reader :started_at
     attr_reader :finished_at
 
-    attr_reader :params
+    attr_reader :infos
 
     FIELDS.each do |name|
       attr_reader name
@@ -37,7 +37,7 @@ module RestFtpDaemon
 
       # Init context
       @id = job_id.to_s
-      @params = {}
+      @infos = {}
       @updated_at = nil
       @started_at = nil
       @finished_at = nil
@@ -81,7 +81,7 @@ module RestFtpDaemon
 
       # Prepare job
       begin
-        newstatus :prepare
+        set_status :prepare
         prepare
 
       rescue RestFtpDaemon::JobMissingAttribute => exception
@@ -104,14 +104,14 @@ module RestFtpDaemon
 
       else
         # Prepare done !
-        newstatus JOB_STATUS_PREPARED
+        set_status JOB_STATUS_PREPARED
         log_info "Job.process notify [started]"
         client_notify :started
       end
 
       # Process job
       begin
-        newstatus :starting
+        set_status :starting
         transfer
 
       rescue SocketError => exception
@@ -182,7 +182,7 @@ module RestFtpDaemon
 
       else
         # All done !
-        newstatus JOB_STATUS_FINISHED
+        set_status JOB_STATUS_FINISHED
         log_info "Job.process notify [ended]"
         client_notify :ended
       end
@@ -190,8 +190,8 @@ module RestFtpDaemon
 
     def get attribute
       @mutex.synchronize do
-        @params || {}
-        @params[attribute]
+        @infos || {}
+        @infos[attribute]
       end
     end
 
@@ -210,7 +210,7 @@ module RestFtpDaemon
 
     def set_queued
       # Update job status
-      newstatus JOB_STATUS_QUEUED
+      set_status JOB_STATUS_QUEUED
     end
 
     def oops_after_crash exception
@@ -228,14 +228,6 @@ module RestFtpDaemon
 
   protected
 
-    def set attribute, value
-      @mutex.synchronize do
-        @params || {}
-        @updated_at = Time.now
-        @params[attribute] = value
-      end
-    end
-
     def expand_path path
       File.expand_path replace_tokens(path)
     end
@@ -272,7 +264,7 @@ module RestFtpDaemon
 
     def prepare
       # Update job status
-      newstatus :prepare
+      set_status :prepare
       @runs += 1
 
       # Init
@@ -283,34 +275,34 @@ module RestFtpDaemon
       # Prepare source
       raise RestFtpDaemon::JobMissingAttribute unless @source
       @source_path = expand_path @source
-      set :source_path, @source_path
-      set :source_method, :file
+      set_info :source_path, @source_path
+      set_info :source_method, :file
 
       # Prepare target
       raise RestFtpDaemon::JobMissingAttribute unless @target
       target_uri = expand_url @target
-      set :target_uri, target_uri.to_s
+      set_info :target_uri, target_uri.to_s
       @target_path = Path.new target_uri.path, true
 
       #puts "@target_path: #{@target_path.inspect}"
 
       # Prepare remote
-      newstatus :remote_init
+      set_status :remote_init
       #FIXME: use a "case" statement on @target_url.class
 
       if target_uri.is_a? URI::FTP
         log_info "Job.prepare target_method FTP"
-        set :target_method, :ftp
+        set_info :target_method, :ftp
         @remote = RemoteFTP.new target_uri, log_context
 
       elsif (target_uri.is_a? URI::FTPES) || (target_uri.is_a? URI::FTPS)
         log_info "Job.prepare target_method FTPES"
-        set :target_method, :ftpes
+        set_info :target_method, :ftpes
         @remote = RemoteFTP.new target_uri, log_context, ftpes: true
 
       elsif target_uri.is_a? URI::SFTP
         log_info "Job.prepare target_method SFTP"
-        set :target_method, :sftp
+        set_info :target_method, :sftp
         @remote = RemoteSFTP.new target_uri, log_context
 
       else
@@ -328,13 +320,13 @@ module RestFtpDaemon
       raise RestFtpDaemon::JobAssertionFailed, "transfer/1" unless @source_path
       raise RestFtpDaemon::JobAssertionFailed, "transfer/2" unless @target_path
       @transfer_sent = 0
-      set :source_processed, 0
+      set_info :source_processed, 0
 
       # Guess source files from disk
-      newstatus :checking_source
+      set_status :checking_source
       sources = find_local @source_path
-      set :source_count, sources.count
-      set :source_files, sources.collect(&:full)
+      set_info :source_count, sources.count
+      set_info :source_files, sources.collect(&:full)
       log_info "Job.transfer sources #{sources.collect(&:name)}"
       raise RestFtpDaemon::JobSourceNotFound if sources.empty?
 
@@ -342,16 +334,16 @@ module RestFtpDaemon
       raise RestFtpDaemon::JobTargetDirectoryError if @target_path.name && sources.count>1
 
       # Connect to remote server and login
-      newstatus :remote_connect
+      set_status :remote_connect
       @remote.connect
 
       # Prepare target path or build it if asked
-      newstatus :remote_chdir
+      set_status :remote_chdir
       @remote.chdir_or_create @target_path.dir, @mkdir
 
       # Compute total files size
       @transfer_total = sources.collect(&:size).sum
-      set :transfer_total, @transfer_total
+      set_info :transfer_total, @transfer_total
 
       # Reset counters
       @last_data = 0
@@ -372,7 +364,7 @@ module RestFtpDaemon
         remote_push source, full_target
 
         # Update counters
-        set :source_processed, source_processed += 1
+        set_info :source_processed, source_processed += 1
       end
 
       # FTP transfer finished
@@ -397,13 +389,37 @@ module RestFtpDaemon
       end
     end
 
-    def worker_is_still_active
-       Thread.current.thread_variable_set :updted_at, Time.now
+    def touch_job
+      now = Time.now
+      @updated_at = now
+      Thread.current.thread_variable_set :updated_at, now
+    end
+
+    def set_info attribute, value
+      @mutex.synchronize do
+        @infos || {}
+        @infos[attribute] = utf8_if_string value
+        touch_job
+      end
+    end
+
+    def set_error value
+      @mutex.synchronize do
+        @error = utf8_if_string value
+        touch_job
+      end
+    end
+
+    def set_status value
+      @mutex.synchronize do
+        @status = utf8_if_string value
+        touch_job
+      end
     end
 
-    def newstatus name
-      @status = name
-      worker_is_still_active
+    def utf8_if_string value
+      return value unless (value.is_a? String) || (value.is_a? Symbol)
+      return value.to_s.encode("UTF-8")
     end
 
     def flag_default name, default
@@ -426,7 +442,7 @@ module RestFtpDaemon
       @remote = nil
 
       # Update job status
-      newstatus :disconnecting
+      set_status :disconnecting
       @finished_at = Time.now
 
       # Update counters
@@ -442,7 +458,7 @@ module RestFtpDaemon
 
       # Use source filename if target path provided none (typically with multiple sources)
       log_info "Job.remote_push [#{source.name}]: [#{source.full}] > [#{target.full}]"
-      set :source_current, source.name
+      set_info :source_current, source.name
 
       # Compute temp target name
       tempname = nil
@@ -463,24 +479,24 @@ module RestFtpDaemon
       transfer_started_at = Time.now
       @progress_at = 0
       @notified_at = transfer_started_at
-      newstatus JOB_STATUS_UPLOADING
+      set_status JOB_STATUS_UPLOADING
 
       # Start the transfer, update job status after each block transfer
-      newstatus :uploading
+      set_status :uploading
       @remote.push source, target, tempname do |transferred, name|
         # Update transfer statistics
         progress transferred, name
 
         # Touch my worker status
-        worker_is_still_active
+        touch_job
       end
 
       # Compute final bitrate
       global_transfer_bitrate = get_bitrate @transfer_total, (Time.now - transfer_started_at)
-      set :transfer_bitrate, global_transfer_bitrate.round(0)
+      set_info :transfer_bitrate, global_transfer_bitrate.round(0)
 
       # Done
-      set :source_current, nil
+      set_info :source_current, nil
     end
 
     def progress transferred, name = ""
@@ -489,17 +505,17 @@ module RestFtpDaemon
 
       # Update counters
       @transfer_sent += transferred
-      set :transfer_sent, @transfer_sent
+      set_info :transfer_sent, @transfer_sent
 
       # Update job info
       percent0 = (100.0 * @transfer_sent / @transfer_total).round(0)
-      set :progress, percent0
+      set_info :progress, percent0
 
       # Update job status after each NOTIFY_UPADE_STATUS
       progressed_ago = (now.to_f - @progress_at.to_f)
       if (!JOB_UPDATE_INTERVAL.to_f.zero?) && (progressed_ago > JOB_UPDATE_INTERVAL.to_f)
         @current_bitrate = running_bitrate @transfer_sent
-        set :transfer_bitrate, @current_bitrate.round(0)
+        set_info :transfer_bitrate, @current_bitrate.round(0)
 
         # Log progress
         stack = []
@@ -568,7 +584,9 @@ module RestFtpDaemon
 
     def oops event, exception, error = nil, include_backtrace = false
       # Log this error
+      # error = exception.class.to_s.encoding.to_s if error.nil?
       error = exception.class if error.nil?
+      # error = "DEF #{exception.class}" if error.nil?
 
       message = "Job.oops event[#{event}] error[#{error}] ex[#{exception.class}] #{exception.message}"
       if include_backtrace
@@ -581,15 +599,15 @@ module RestFtpDaemon
       @remote.close unless @remote.nil? || !@remote.connected?
 
       # Update job's internal status
-      newstatus JOB_STATUS_FAILED
-      @error = error
-      set :error_exception, exception.class.to_s
-      set :error_message, exception.message
+      set_status JOB_STATUS_FAILED
+      set_error error
+      set_info :error_exception, exception.class.to_s
+      set_info :error_message, exception.message
 
       # Build status stack
       notif_status = nil
       if include_backtrace
-        set :error_backtrace, exception.backtrace
+        set_info :error_backtrace, exception.backtrace
         notif_status = {
           backtrace: exception.backtrace,
           }

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

@@ -45,7 +45,7 @@ module RestFtpDaemon
         log_error "not retrying: max_age reached (#{max_age} s)"
 
       elsif max_runs && (job.runs >= max_runs)
-        log_error "not retrying: max_runs reached (#{max_runs} tentatives)"
+        log_error "not retrying: max_runs reached (#{max_runs} tries)"
 
       else
         # Delay cannot be negative, and will be 1s minimum

data/rest-ftp-daemon.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.version       = APP_VER
 
-  spec.required_ruby_version = ">= 2.1.7"
+  spec.required_ruby_version = ">= 2.2"
 
   # spec.add_development_dependency "rack-mini-profiler"
   # spec.add_development_dependency "stackprof"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rest-ftp-daemon
 version: !ruby/object:Gem::Version
-  version: 0.242.2
+  version: 0.242.3
 platform: ruby
 authors:
 - Bruno MEDICI
@@ -338,7 +338,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.7
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -346,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: RESTful FTP client daemon