rest-ftp-daemon 0.221.2 → 0.222.0

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

@@ -47,12 +47,13 @@ module RestFtpDaemon
   private
 
     def link p
-      klass = (p == @page)? ' btn-info' : ''
-      return "<a class='page btn btn-default%s' href='?only=%s&page=%d'>%p</a>" % [
+      klass = (p == @page)? " btn-info" : ""
+
+      "<a class='page btn btn-default%s' href='?only=%s&page=%d'>%p</a>" % [
         klass,
         @only,
         p,
-        p,
+        p
       ]
     end
 

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

@@ -7,21 +7,22 @@ class Settings < Settingslogic
 
   # Compute my PID filename
   def pidfile
-    self["pidfile"] || "/tmp/#{APP_NAME}.port#{self['port'].to_s}.pid"
+    port = self["port"]
+    self["pidfile"] || "/tmp/#{APP_NAME}.port#{port}.pid"
   end
 
   # Direct access to any depth
   def at *path
-    path.reduce(Settings) {|m,key| m && m[key.to_s] }
+    path.reduce(Settings) { |m, key| m && m[key.to_s] }
   end
 
   # Dump whole settings set to readable YAML
   def dump
-    self.to_hash.to_yaml( :Indent => 4, :UseHeader => true, :UseVersion => false )
+    to_hash.to_yaml(indent: 4, useheader: true, useversion: false )
   end
 
   def init_defaults
-    Settings['host'] ||= `hostname`.chomp.split('.').first
+    Settings["host"] ||= `hostname`.chomp.split(".").first
   end
 
   def newrelic_enabled?
@@ -30,21 +31,20 @@ class Settings < Settingslogic
 
   def init_newrelic
     # Skip if not enabled
-    return ENV['NEWRELIC_AGENT_ENABLED'] = 'false' unless Settings.newrelic_enabled?
+    return ENV["NEWRELIC_AGENT_ENABLED"] = "false" unless Settings.newrelic_enabled?
 
     # Enable module
-    ENV['NEWRELIC_AGENT_ENABLED'] = 'true'
-    ENV['NEW_RELIC_MONITOR_MODE'] = 'true'
-    #Settings['newrelic']['enabled'] = true
+    ENV["NEWRELIC_AGENT_ENABLED"] = "true"
+    ENV["NEW_RELIC_MONITOR_MODE"] = "true"
 
     # License
-    ENV['NEW_RELIC_LICENSE_KEY'] = Settings.at(:debug, :newrelic)
+    ENV["NEW_RELIC_LICENSE_KEY"] = Settings.at(:debug, :newrelic)
 
     # Appname
-    ENV['NEW_RELIC_APP_NAME'] = "#{APP_NICK}-#{Settings.host}-#{APP_ENV}"
+    ENV["NEW_RELIC_APP_NAME"] = "#{APP_NICK}-#{Settings.host}-#{APP_ENV}"
 
     # Logfile
-    ENV['NEW_RELIC_LOG'] = Settings.at(:logs, :newrelic)
+    ENV["NEW_RELIC_LOG"] = Settings.at(:logs, :newrelic)
   end
 
 end

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

@@ -2,11 +2,11 @@ module URI
   class FTPS < Generic
     DEFAULT_PORT = 21
   end
-  @@schemes['FTPS'] = FTPS
+  @@schemes["FTPS"] = FTPS
 end
 module URI
   class FTPES < Generic
     DEFAULT_PORT = 990
   end
-  @@schemes['FTPES'] = FTPES
+  @@schemes["FTPES"] = FTPES
 end

data/lib/rest-ftp-daemon/views/dashboard_table.haml

@@ -3,7 +3,7 @@
   - source_count = job.get(:source_count) || 0
   - source_processed = job.get(:source_processed) || 0
   - source_current = job.get(:source_current)
-  - presented = present job, :with => RestFtpDaemon::API::Entities::JobPresenter, hide_params: true
+  - presented = present job, with: RestFtpDaemon::API::Entities::JobPresenter, hide_params: true
   - bitrate = job.get :transfer_bitrate
 
   - trclass = JOB_STYLES[job.status]

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

@@ -33,7 +33,7 @@ module RestFtpDaemon
       loop do
         begin
           work
-        rescue Exception => e
+        rescue StandardError => e
           log_error "WORKER EXCEPTION: #{e.inspect}"
           sleep 1
         end

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

@@ -32,7 +32,7 @@ module RestFtpDaemon
       worker_status :collecting
       GC.start if @conchita["garbage_collector"]
 
-    rescue Exception => e
+    rescue StandardError => e
       log_error "EXCEPTION: #{e.inspect}"
       sleep 1
     else
@@ -42,12 +42,12 @@ module RestFtpDaemon
     end
 
     def maxage status
-      @conchita["clean_#{status.to_s}"] || 0
+      @conchita["clean_#{status}"] || 0
     end
 
 
     if Settings.newrelic_enabled?
-      add_transaction_tracer :work, :category => :task
+      add_transaction_tracer :work,       category: :task
     end
 
   end

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

@@ -28,7 +28,7 @@ module RestFtpDaemon
       job.wid = Thread.current.thread_variable_get :wid
 
       # Processs this job protected by a timeout
-      Timeout::timeout(@timeout, RestFtpDaemon::JobTimeout) do
+      Timeout.timeout(@timeout, RestFtpDaemon::JobTimeout) do
         job.process
       end
 
@@ -50,7 +50,7 @@ module RestFtpDaemon
       job.oops_you_stop_now ex unless job.nil?
       sleep 1
 
-    rescue Exception => ex
+    rescue StandardError => ex
       log_error "JOB UNHDNALED EXCEPTION: #{ex.message}", lines: ex.backtrace
       worker_status :crashed
       job.oops_after_crash ex unless job.nil?
@@ -65,7 +65,7 @@ module RestFtpDaemon
 
 
     if Settings.newrelic_enabled?
-      add_transaction_tracer :work, :category => :task
+      add_transaction_tracer :work,       category: :task
     end
 
   end

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

@@ -12,9 +12,6 @@ module RestFtpDaemon
     def initialize
       # Logger
       @logger = RestFtpDaemon::LoggerPool.instance.get :workers
-      # log_info "WorkerPool: log_info"
-      # log_error "WorkerPool: log_error"
-      # log_error "WorkerPool: log_error + lines", ['line1', 'line2']
 
       # Prepare status hash and vars
       @statuses = {}
@@ -30,7 +27,7 @@ module RestFtpDaemon
     end
 
     def worker_variables
-      @workers.collect do |wid, worker|
+      @workers.collect do |_wid, worker|
         vars = {}
         worker.thread_variables.each do |var|
           vars[var] = worker.thread_variable_get var
@@ -73,7 +70,7 @@ module RestFtpDaemon
       # Start conchita thread
       @conchita = create_conchita_thread
 
-    rescue Exception => ex
+    rescue StandardError => ex
       log_error "UNHDNALED EXCEPTION: #{ex.message}", ex.backtrace
 
     end
@@ -83,7 +80,7 @@ module RestFtpDaemon
         begin
           worker = JobWorker.new wid
           log_info "JobWorker [#{wid}]: #{worker}"
-        rescue Exception => ex
+        rescue StandardError => ex
           log_error "EXCEPTION: #{ex.message}"
         end
       end
@@ -94,7 +91,7 @@ module RestFtpDaemon
         begin
           worker = ConchitaWorker.new :conchita
           log_info "ConchitaWorker: #{worker}"
-        rescue Exception => ex
+        rescue StandardError => ex
           log_error "EXCEPTION: #{ex.message}"
         end
       end
@@ -103,8 +100,8 @@ module RestFtpDaemon
   protected
 
     if Settings.newrelic_enabled?
-      add_transaction_tracer :create_conchita_thread, :category => :task
-      add_transaction_tracer :create_worker_thread, :category => :task
+      add_transaction_tracer :create_conchita_thread,     category: :task
+      add_transaction_tracer :create_worker_thread,       category: :task
     end
 
   end

data/rest-ftp-daemon.gemspec

@@ -22,10 +22,12 @@ Gem::Specification.new do |spec|
   spec.version       = APP_VER
 
   #spec.required_ruby_version = '>= 1.9.3'
-  spec.required_ruby_version = '>= 2.1'
+  spec.required_ruby_version = ">= 2.1"
 
   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_runtime_dependency "thin", "~> 1.6"
   spec.add_runtime_dependency "grape"

data/rest-ftp-daemon.yml.sample

@@ -2,21 +2,20 @@ defaults: &defaults
   daemonize: true
   port: 3000
   workers: 2
-  #adminpwd: "admin"
   user: rftpd
   group: rftpd
-  host: <%= `hostname`.chomp.split('.').first %>
+  host: "myhost"
 
   transfer:
-    update_every_kb: 1024
-    notify_after_sec: 5
-    mkdir: true
-    tempfile: true
-    overwrite: false
-    timeout: 1800
+    update_every_kb: 1024     # block size to transfer between counter updates
+    notify_after_sec: 5       # wait at least X seconds between HTTP notifications
+    mkdir: true               # build directory tree if missing
+    tempfile: true            # transfer to temporary file, rename after sucessful transfer
+    overwrite: false          # overwrite any target file with the same name
+    timeout: 1800             # jobs running for longer than X seconds will be killed
 
   conchita:
-    timer: 60
+    # timer: 60
     # garbage_collector: true
     # clean_failed: 3600
     # clean_finished: 3600
@@ -24,7 +23,7 @@ defaults: &defaults
 
   debug:
     ftp: false
-    # license: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+    # newrelic: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
 
   logs:
     thin:    "/var/log/rftpd-environment-thin.log"
@@ -35,8 +34,10 @@ defaults: &defaults
     notify:  "/var/log/rftpd-environment-work.log"
     newrelic:"/var/log/rftpd-environment-newrelic.log"
 
-preprod:
+
+development:
   <<: *defaults
+  port: 3400
 
 production:
   <<: *defaults

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

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe 'Dashboard', feature: true do
+
+  describe "GET /" do
+    context 'without a password' do
+      it 'is forbidden' do
+        expect(HTTP.accept(:json).get("http://localhost:5678").status).to eq 401
+      end
+    end
+
+    context 'with a password' do
+      it 'can be accessed' do
+        expect(
+          HTTP.accept(:json).
+            basic_auth(user: 'admin', pass: 'admin').
+            get("http://localhost:5678").status
+        ).to eq 200
+      end
+    end
+  end # GET /
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+require "pathname"
+require "http"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # 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'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  def call_server(command, config = Pathname(__dir__).join("support/config.yml"))
+    system(Pathname(__dir__).join("../bin/rest-ftp-daemon -e test -c #{config} #{command}").to_s, chdir: __dir__) or fail "Could not #{command} server"
+  end
+
+  config.before :suite do
+    call_server(:start)
+    sleep 2
+  end
+
+  config.after :suite do
+    call_server(:stop)
+  end
+end

data/spec/support/config.yml

@@ -0,0 +1,26 @@
+test:
+  daemonize: true
+  port: 5678
+  workers: 2
+  adminpwd: "admin"
+  host: 127.0.0.1
+
+  transfer:
+    update_every_kb: 1024
+    notify_after_sec: 5
+    mkdir: true
+    tempfile: true
+    overwrite: false
+    timeout: 1800
+
+  debug:
+    ftp: false
+
+  logs:
+    thin:     "./tmp/log/rftpd-environment-thin.log"
+    queue:    "./tmp/log/rftpd-environment-core.log"
+    api:      "./tmp/log/rftpd-environment-core.log"
+    workers:  "./tmp/log/rftpd-environment-work.log"
+    jobs:     "./tmp/log/rftpd-environment-work.log"
+    notify:   "./tmp/log/rftpd-environment-work.log"
+    newrelic: "/var/log/rftpd-environment-newrelic.log"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-ftp-daemon
 version: !ruby/object:Gem::Version
-  version: 0.221.2
+  version: 0.222.0
 platform: ruby
 authors:
 - Bruno MEDICI
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-28 00:00:00.000000000 Z
+date: 2015-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -215,6 +243,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - Gemfile
 - Gemfile.lock
@@ -225,11 +255,9 @@ files:
 - config.ru
 - lib/rest-ftp-daemon.rb
 - lib/rest-ftp-daemon/api/dashboard.rb
-- lib/rest-ftp-daemon/api/debug.rb
 - lib/rest-ftp-daemon/api/job_presenter.rb
 - lib/rest-ftp-daemon/api/jobs.rb
 - lib/rest-ftp-daemon/api/root.rb
-- lib/rest-ftp-daemon/api/status.rb
 - lib/rest-ftp-daemon/constants.rb
 - lib/rest-ftp-daemon/exceptions.rb
 - lib/rest-ftp-daemon/helpers.rb
@@ -258,6 +286,9 @@ files:
 - lib/rest-ftp-daemon/worker_pool.rb
 - rest-ftp-daemon.gemspec
 - rest-ftp-daemon.yml.sample
+- spec/rest-ftp-daemon/features/dashboard_spec.rb
+- spec/spec_helper.rb
+- spec/support/config.yml
 homepage: http://github.com/bmedici/rest-ftp-daemon
 licenses:
 - MIT