rest-ftp-daemon 0.221.2 → 0.222.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-ftp-daemon (0.221.2)
+    rest-ftp-daemon (0.222.0)
       double-bag-ftps
       facter
       get_process_mem
@@ -25,6 +25,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    addressable (2.3.8)
     axiom-types (0.1.1)
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
@@ -35,6 +36,9 @@ GEM
     daemons (1.2.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.2.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
     double-bag-ftps (0.1.2)
     equalizer (0.0.11)
     eventmachine (1.0.7)
@@ -58,10 +62,19 @@ GEM
     haml (4.0.6)
       tilt
     hashie (3.4.1)
+    http (0.8.12)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 1.0.1)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    http-form_data (1.0.1)
+    http_parser.rb (0.6.0)
     i18n (0.7.0)
     ice_nine (0.11.1)
-    json (1.8.2)
-    minitest (5.6.1)
+    json (1.8.3)
+    minitest (5.7.0)
     multi_json (1.11.0)
     multi_xml (0.5.5)
     newrelic_rpm (3.12.0.288)
@@ -71,6 +84,19 @@ GEM
     rack-mount (0.8.3)
       rack (>= 1.0.0)
     rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
     settingslogic (2.0.9)
     sys-cpu (0.7.1)
       ffi (>= 1.0.0)
@@ -85,6 +111,9 @@ GEM
     timeout-extensions (0.0.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
     virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
@@ -96,5 +125,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.6)
+  http (~> 0.8)
   rake
   rest-ftp-daemon!
+  rspec (~> 3.1)

data/README.md

@@ -1,13 +1,18 @@
 rest-ftp-daemon
 ====================================================================================
 
+[![Gem Version](https://badge.fury.io/rb/rest-ftp-daemon.svg)](http://badge.fury.io/rb/rest-ftp-daemon)
+[![Code Climate](https://codeclimate.com/github/bmedici/rest-ftp-daemon/badges/gpa.svg)](https://codeclimate.com/github/bmedici/rest-ftp-daemon)
+[![Test Coverage](https://codeclimate.com/github/bmedici/rest-ftp-daemon/badges/coverage.svg)](https://codeclimate.com/github/bmedici/rest-ftp-daemon/coverage)
 
-This is a pretty simple FTP client daemon, controlled through a RESTful API.
+
+A pretty simple FTP-client daemon, driven through a RESTful API.
 
 API documentation is [maintained on Apiary](http://docs.restftpdaemon.apiary.io/)
 
 
 
+
 Features
 ------------------------------------------------------------------------------------
 

data/Rakefile

@@ -1,3 +1,10 @@
 # encoding: utf-8
 require "bundler/gem_tasks"
-require 'rubygems'
+require "rubygems"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+# Run specs by default
+desc 'Run all tests'
+task :default => :spec

data/bin/rest-ftp-daemon

@@ -1,12 +1,12 @@
 #!/usr/bin/env ruby
 
 # Try to load external libs
-app_root = File.dirname(__FILE__) + '/../'
+app_root = File.dirname(__FILE__) + "/../"
 begin
   require "thin"
-  require 'optparse'
-  require 'socket'
-  # require 'timeout'
+  require "optparse"
+  require "socket"
+  # require "timeout"
   require "settingslogic"
 rescue LoadError
   raise "EXITING: some of basic libs were not found: thin, optparse, socket, settingslogic"
@@ -15,7 +15,7 @@ end
 
 # Load helpers and constants
 [:constants, :helpers].each do |lib|
-  require File.expand_path("#{app_root}/lib/rest-ftp-daemon/#{lib.to_s}")
+  require File.expand_path("#{app_root}/lib/rest-ftp-daemon/#{lib}")
 end
 puts
 
@@ -36,7 +36,7 @@ parser = OptionParser.new do |opts|
   opts.on("-g", "--group NAME", "Group to run daemon as (use with -u)"){ |group| options["group"] = group }
 
   opts.on_tail("-h", "--help", "Show this message")                    { puts opts; exit }
-  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
 
 
@@ -69,7 +69,7 @@ begin
 
 rescue Psych::SyntaxError => e
   abort "EXITING: config file syntax error: #{e.message}"
-rescue Exception => e
+rescue StandardError => e
   abort "EXITING: unknow error loading settings  #{e.inspect}"
 end
 
@@ -109,7 +109,7 @@ argv << command unless command.nil?
 puts "--- #{APP_NAME} #{APP_VER}"
 puts "Config file  \t #{APP_CONF}"
 puts "PID file     \t #{Settings.pidfile}"
-puts "Daemonize    \t #{Settings.daemonize ? 'YES' : "no (PID: #{Process.pid})"}"
+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}"
@@ -118,7 +118,7 @@ puts "Newrelic     \t #{Settings.newrelic_enabled? ? Settings.at(:debug, :newrel
 # puts Settings.dump
 puts
 puts "--- Thin ARGV"
-puts argv.flatten.join(' ')
+puts argv.flatten.join(" ")
 puts
 
 

data/config.ru

@@ -1,7 +1,7 @@
 # Load gem files
-load_path_libs = File.expand_path(File.join(File.dirname(__FILE__), 'lib'))
+load_path_libs = File.expand_path(File.join(File.dirname(__FILE__), "lib"))
 $LOAD_PATH.unshift(load_path_libs) unless $LOAD_PATH.include?(load_path_libs)
-require 'rest-ftp-daemon'
+require "rest-ftp-daemon"
 
 # Create global queue
 $queue = RestFtpDaemon::JobQueue.new
@@ -17,7 +17,7 @@ end
 # Rack authent
 unless Settings.adminpwd.nil?
   use Rack::Auth::Basic, "Restricted Area" do |username, password|
-    [username, password] == ['admin', Settings.adminpwd]
+    [username, password] == ["admin", Settings.adminpwd]
   end
 end
 

data/lib/rest-ftp-daemon.rb

@@ -1,49 +1,49 @@
 # Global libs
-require 'rubygems'
+require "rubygems"
 require "settingslogic"
-require 'json'
-require 'grape'
-require 'grape-entity'
-require 'haml'
-require 'facter'
-require 'uri'
-require 'securerandom'
-require 'timeout'
-require 'sys/cpu'
-require 'syslog'
-require 'net/ftp'
-require 'net/http'
-require 'double_bag_ftps'
-require 'thread'
-require 'securerandom'
-require 'singleton'
-require 'logger'
+require "json"
+require "grape"
+require "grape-entity"
+require "haml"
+require "facter"
+require "uri"
+require "securerandom"
+require "timeout"
+require "sys/cpu"
+require "syslog"
+require "net/ftp"
+require "net/http"
+require "double_bag_ftps"
+require "thread"
+require "securerandom"
+require "singleton"
+require "logger"
 
-require 'newrelic_rpm'
-require 'get_process_mem'
+require "newrelic_rpm"
+require "get_process_mem"
 
 
 # Project's libs
-require 'rest-ftp-daemon/constants'
-require 'rest-ftp-daemon/settings'
-require 'rest-ftp-daemon/exceptions'
-require 'rest-ftp-daemon/helpers'
-require 'rest-ftp-daemon/logger_helper'
-require 'rest-ftp-daemon/logger_pool'
-require 'rest-ftp-daemon/logger'
-require 'rest-ftp-daemon/paginate'
-require 'rest-ftp-daemon/uri'
-require 'rest-ftp-daemon/job_queue'
-# require 'rest-ftp-daemon/worker'
-require 'rest-ftp-daemon/worker'
-require 'rest-ftp-daemon/worker_conchita'
-require 'rest-ftp-daemon/worker_job'
-require 'rest-ftp-daemon/worker_pool'
-require 'rest-ftp-daemon/job'
-require 'rest-ftp-daemon/notification'
-require 'rest-ftp-daemon/api/root'
-require 'rest-ftp-daemon/api/jobs'
-require 'rest-ftp-daemon/api/dashboard'
-require 'rest-ftp-daemon/api/status'
-require 'rest-ftp-daemon/api/debug'
-require 'rest-ftp-daemon/api/job_presenter'
+require "rest-ftp-daemon/constants"
+require "rest-ftp-daemon/settings"
+require "rest-ftp-daemon/exceptions"
+require "rest-ftp-daemon/helpers"
+require "rest-ftp-daemon/logger_helper"
+require "rest-ftp-daemon/logger_pool"
+require "rest-ftp-daemon/logger"
+require "rest-ftp-daemon/paginate"
+require "rest-ftp-daemon/uri"
+require "rest-ftp-daemon/job_queue"
+require "rest-ftp-daemon/worker"
+require "rest-ftp-daemon/worker_conchita"
+require "rest-ftp-daemon/worker_job"
+require "rest-ftp-daemon/worker_pool"
+require "rest-ftp-daemon/job"
+require "rest-ftp-daemon/notification"
+
+require "rest-ftp-daemon/api/job_presenter"
+require "rest-ftp-daemon/api/jobs"
+require "rest-ftp-daemon/api/dashboard"
+
+require "rest-ftp-daemon/api/root"
+

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

@@ -1,18 +1,28 @@
 module RestFtpDaemon
   module API
-    class Root < Grape::API
-
+    class Dashbaord < Grape::API
 
 ####### 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)
+          haml_engine.render(binding, values)
+        end
+
       end
 
 
 ####### DASHBOARD - GET /
 
       # Server global status
-      get '/' do
+      get "/" do
         log_info "GET /"
 
         # Initialize Facter
@@ -40,7 +50,7 @@ module RestFtpDaemon
         output = render :dashboard
 
         # Send response
-        env['api.format'] = :html
+        env["api.format"] = :html
         format "html"
         status 200
         content_type "text/html"

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

@@ -10,7 +10,7 @@ module RestFtpDaemon
         Job::FIELDS.each { |name| expose name }
 
         # Technical fields
-        expose :wid, unless: lambda { |object, options| object.wid.nil? }
+        expose :wid, unless: lambda { |object, _options| object.wid.nil? }
 
         expose :error
         expose :status

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

@@ -1,14 +1,24 @@
 module RestFtpDaemon
   module API
-    class Root < Grape::API
+    class Jobs < Grape::API
+
+####### HELPERS
+
+      helpers do
+
+        def logger
+          Root.logger
+        end
+
+      end
 
 
 ####### GET /jobs/:id
 
       params do
-        requires :id, type: String, desc: 'ID of the Job to read', regexp: /[^\/]+/
+        requires :id, type: String, desc: "ID of the Job to read", regexp: /[^\/]+/
       end
-      get '/jobs/*id' do
+      get "/*id" do
         log_info "GET /jobs/#{params[:id]}"
 
         begin
@@ -19,21 +29,17 @@ module RestFtpDaemon
 
         rescue RestFtpDaemon::JobNotFound => exception
           log_error "JobNotFound: #{exception.message}"
-          status 404
-          api_error exception
-        rescue RestFtpDaemonException => exception
-          log_error "RestFtpDaemonException: #{exception.message}"
-          status 500
-          api_error exception
-        rescue Exception => exception
+          error!({error: :api_job_not_found, message: exception.message}, 404)
+
+        rescue StandardError => exception
           log_error "Exception: #{exception.message}"
-          status 501
-          api_error exception
+          error!({error: :api_exception, message: exception.message}, 500)
+
         else
           status 200
-          present job, :with => RestFtpDaemon::API::Entities::JobPresenter, type: "complete"
-        end
+          present job, with: RestFtpDaemon::API::Entities::JobPresenter, type: "complete"
 
+        end
       end
 
 
@@ -41,33 +47,25 @@ module RestFtpDaemon
 
       desc "List all Jobs"
 
-      get '/jobs/' do
+      get "/" do
         log_info "GET /jobs"
 
         begin
-          # Detect QS filters
-          only = params["only"].to_s
-
           # Get jobs to display
-          # jobs = $queue.sorted_by_status(only)
           jobs = $queue.jobs
 
-        rescue RestFtpDaemonException => exception
-          log_error "RestFtpDaemonException: #{exception.message}"
-          status 501
-          api_error exception
-        rescue Exception => exception
+        rescue StandardError => exception
           log_error "Exception: #{exception.message}"
-          status 501
-          api_error exception
+          error!({error: :api_exception, message: exception.message}, 500)
+
         else
           status 200
-          present jobs, :with => RestFtpDaemon::API::Entities::JobPresenter
+          present jobs, with: RestFtpDaemon::API::Entities::JobPresenter
+
         end
       end
 
 
-
 ####### POST /jobs/
 
       desc "Create a new job"
@@ -78,16 +76,21 @@ module RestFtpDaemon
         optional :label, type: String, desc: "Descriptive label for this job"
         optional :notify, type: String, desc: "URL to get POST'ed notifications back"
         optional :priority, type: Integer, desc: "Priority level of the job (lower is stronger)"
-
-        optional :overwrite, type: Boolean, desc: "overwrites files at target server",
+        optional :overwrite,
+          type: Boolean,
+          desc: "Overwrites files at target server",
           default: Settings.transfer[:overwrite]
-        optional :mkdir, type: Boolean, desc: "create missing directories on target server",
+        optional :mkdir,
+          type: Boolean,
+          desc: "Create missing directories on target server",
           default: Settings.transfer[:mkdir]
-        optional :tempfile, type: Boolean, desc: "upload to a temp file before renaming it to the target filename",
+        optional :tempfile,
+          type: Boolean,
+          desc: "Upload to a temp file before renaming it to the target filename",
           default: Settings.transfer[:tempfile]
       end
 
-      post '/jobs/' do
+      post "/" do
         log_info "POST /jobs", params
 
         begin
@@ -104,19 +107,16 @@ module RestFtpDaemon
 
         rescue JSON::ParserError => exception
           log_error "JSON::ParserError: #{exception.message}"
-          status 406
-          api_error exception
+          error!({error: :api_parse_error, message: exception.message}, 422)
+
         rescue RestFtpDaemonException => exception
           log_error "RestFtpDaemonException: #{exception.message}"
-          status 412
-          api_error exception
-        rescue Exception => exception
-          log_error "Exception: #{exception.message}"
-          status 501
-          api_error exception
+          error!({error: :api_exception, message: exception.message}, 500)
+
         else
           status 201
-          present job, :with => RestFtpDaemon::API::Entities::JobPresenter, hide_params: true
+          present job, with: RestFtpDaemon::API::Entities::JobPresenter, hide_params: true
+
         end
       end