ferver 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53cab51e0ed1cb913ac92f9a19e927f9287115c4
-  data.tar.gz: 2be0b531e9d3b69bca13fbda397f84851fcbc414
+  metadata.gz: afd7d5747292d7103cf9d23366c7c3873f3f6191
+  data.tar.gz: c3c46b4c00c3d4de4cfdda39e2872ea2dea74edd
 SHA512:
-  metadata.gz: 0768729a9b85bb19183db20980214eeb22499d62a0fe23739dee08d9b635ff0eda80b937d09ee8e8801dadcefc041e1c07fbd7d3ff4087603af1e8f4d504aa43
-  data.tar.gz: 23c93f96598a6397cdc0e073acb16f58bd3da509be09a806638895d256c3d81b742e219822de5aa2897156906996b3ea768ed52af8fe6708c01c83528f69c50f
+  metadata.gz: 02dd8ddfa1e9816e330dabdad1da70301a743589c8154a709122174ec5ec941c0acb9ec9bc34021b19a359253a1e496661894e2663de149e74171476fc70cb37
+  data.tar.gz: 601fa4f7a2e4c2b74cae5114d1c98662136e1dc4e2406cbe135648d693832991c690ce980661b77dfaedc1ffa9fe9690ef4c8611ead0748af55163737bb24d9e

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

data/.rspec

@@ -1,2 +1,3 @@
 --colour
---format progress
+--format progress
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+LineLength:
+  Enabled: false
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Documentation:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - "spec/spec_helper.rb"

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.4.0

data/.travis.yml

@@ -1,12 +1,17 @@
 language: ruby
 sudo: false
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.0
   - 2.2.0
+  - 2.3.0
+  - 2.4.0
   - ruby-head
 
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+
 addons:
    code_climate:
      repo_token: aaa2bcd71ac641474a13caabe294beeb26abcc7c4dd82f3395a7b9193bb20d02

data/Gemfile

@@ -1,4 +1,5 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in ferver.gemspec
 gemspec

data/README.md

@@ -4,7 +4,7 @@
 
 [![Build Status](https://travis-ci.org/rob-murray/ferver.svg?branch=master)](https://travis-ci.org/rob-murray/ferver)
 [![Code Climate](https://codeclimate.com/github/rob-murray/ferver.png)](https://codeclimate.com/github/rob-murray/ferver)
-[![Coverage Status](https://coveralls.io/repos/rob-murray/ferver/badge.png)](https://coveralls.io/r/rob-murray/ferver)
+[![Coverage Status](https://coveralls.io/repos/rob-murray/ferver/badge.svg?branch=master&service=github)](https://coveralls.io/github/rob-murray/ferver?branch=master)
 [![Dependency Status](https://gemnasium.com/rob-murray/ferver.svg)](https://gemnasium.com/rob-murray/ferver)
 [![Gem Version](https://badge.fury.io/rb/ferver.svg)](http://badge.fury.io/rb/ferver)
 
@@ -58,6 +58,14 @@ $ ferver -a
 
 > Note that zero size files will always be hidden.
 
+##### Configure webserver
+
+If required, you can configure the bind address or port number used by the webserver. By default this is `0.0.0.0` and port `4567` which means the server is accessible from outside your machine (if firewall permits). For example if you used the configuration below then it would only be accessible from local machine and on port `9999`.
+
+```bash
+$ ferver -p 9999 -b 127.0.0.1
+````
+
 ##### Command line help
 
 For a list of arguments just use the `--help` switch.
@@ -70,6 +78,8 @@ $ ferver -h
 
 The **ferver** gem uses [Sinatra](http://www.sinatrarb.com/) and runs on default port configuration so just point your browser to `http://localhost:4567` to list the files.
 
+> If you are unable to connect then please check any firewall settings or the configured bind address or port number!
+
 #### HTML
 
 List available files in your browser.

data/Rakefile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
 require "rspec/core"
 require "rspec/core/rake_task"

data/bin/ferver

@@ -1,22 +1,31 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require 'optparse'
-$:.unshift File.join( File.dirname(__FILE__), "/../lib")
-require 'ferver'
+require "optparse"
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "/../lib")
+require "ferver"
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = 'Ferver: A simple web app to serve files over HTTP. Version: ' + Ferver::VERSION
-  opts.separator ''
+  opts.banner = "Ferver: A simple web app to serve files over HTTP. Version: " + Ferver::VERSION
+  opts.separator ""
 
-  opts.on('-a', '--all', 'Serve hidden files') do |a|
+  opts.on("-a", "--all", "Serve hidden files. False by default [optional]") do |a|
     options[:hidden] = a
   end
 
-  opts.on('-d', '--directory [DIRECTORY]', 'Specify the path to the directory to serve files from [optional]') do |directory|
+  opts.on("-d", "--directory [DIRECTORY]", "Specify the path to the directory to serve files from [optional]") do |directory|
     options[:directory] = directory
   end
 
+  opts.on("-b", "--bind [IP or hostname]", "Set the hostname or IP address of the interface to listen on when running. Defaults to '0.0.0.0' [optional]") do |bind_address|
+    options[:bind_address] = bind_address
+  end
+
+  opts.on("-p", "--port [PORT]", "Set the port used by Ferver server. Defaults to 4567 [optional]") do |port|
+    options[:port] = port
+  end
+
   opts.on("-h", "--help", "Displays help") do
     puts opts
     exit
@@ -24,10 +33,12 @@ OptionParser.new do |opts|
 end.parse!
 
 Ferver.configure do |config|
-  config.serve_hidden = options[:hidden]
-  config.directory_path = options[:directory]
+  config.serve_hidden = options[:hidden] if options[:hidden]
+  config.directory_path = options[:directory] if options[:directory]
 end
 Ferver::App.set :environment, :production
+Ferver::App.set :bind, options[:bind_address] if options[:bind_address]
+Ferver::App.set :port, options[:port] if options[:port]
 
 # run!
 Ferver::App.run!

data/ferver.gemspec

@@ -1,33 +1,35 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ferver/version'
+require "ferver/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'ferver'
+  spec.name          = "ferver"
   spec.version       = Ferver::VERSION
-  spec.authors       = ['Rob Murray']
-  spec.email         = ['robmurray17@gmail.com']
-  spec.summary       = %q(A simple web app to serve files over HTTP.)
-  spec.description   = %q(Ferver is a super, simple ruby gem to serve files over http; useful as a basic file server to quickly share files on your local network.)
-  spec.homepage      = 'https://github.com/rob-murray/ferver'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.authors       = ["Rob Murray"]
+  spec.email         = ["robmurray17@gmail.com"]
+  spec.summary       = "A simple web app to serve files over HTTP."
+  spec.description   = "Ferver is a super, simple ruby gem to serve files over http; useful as a basic file server to quickly share files on your local network."
+  spec.homepage      = "https://github.com/rob-murray/ferver"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.0.0"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake', '~> 0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rack-test', '~> 0.6'
-  spec.add_development_dependency 'spork', '~> 0.9'
-  spec.add_development_dependency 'rspec-html-matchers', '~> 0.6'
-  spec.add_development_dependency 'coveralls', '~> 0.7'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "rspec-html-matchers", "~> 0.6"
+  spec.add_development_dependency "coveralls", "~> 0.7"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "byebug"
 
-  spec.add_dependency 'sinatra', '~> 1.4'
+  spec.add_dependency "sinatra", "~> 1.4"
 end

data/lib/ferver.rb

@@ -1,16 +1,14 @@
-require_relative 'ferver/app'
-require_relative 'ferver/controller'
-require_relative 'ferver/configuration'
-require_relative 'ferver/directory_not_found_error'
-require_relative 'ferver/file_id_request'
-require_relative 'ferver/file_list'
-require_relative 'ferver/found_file'
-require_relative 'ferver/version'
+# frozen_string_literal: true
+require_relative "ferver/configuration"
+require_relative "ferver/errors"
+require_relative "ferver/app"
+require_relative "ferver/controller"
+require_relative "ferver/ferver_directory"
+require_relative "ferver/file_list"
+require_relative "ferver/found_file"
+require_relative "ferver/version"
 
 module Ferver
-  # By default, serve files from current location when the gem is called.
-  DEFAULT_FILE_SERVER_DIR_PATH = './'
-
   class << self
     attr_accessor :configuration
 

data/lib/ferver/app.rb

@@ -1,13 +1,14 @@
-require 'sinatra'
-require 'sinatra/base'
-require_relative './controller'
+# frozen_string_literal: true
+require "sinatra"
+require "sinatra/base"
+require_relative "./controller"
 
 module Ferver
   class App < Sinatra::Application
     set :app_file, __FILE__
 
     configure do
-      set :views, './views'
+      set :views, "./views"
     end
 
     use Controller

data/lib/ferver/configuration.rb

@@ -1,18 +1,27 @@
+# frozen_string_literal: true
 module Ferver
   class Configuration
-    attr_accessor :directory_path, :serve_hidden
+    # By default, serve files from current location when the gem is called.
+    DEFAULT_FILE_SERVER_DIR_PATH = "./".freeze
 
     # Return the absolute path to the directory Ferver is serving files from.
-    #
-    def directory_path
-      @directory_path || Ferver::DEFAULT_FILE_SERVER_DIR_PATH
+    attr_accessor :directory_path
+
+    # Default to not serving hidden files.
+    attr_accessor :serve_hidden
+
+    # For testing
+    attr_writer :directory
+
+    alias serve_hidden? serve_hidden
+
+    def initialize(directory_path = DEFAULT_FILE_SERVER_DIR_PATH, serve_hidden = false)
+      @directory_path = directory_path
+      @serve_hidden   = serve_hidden
     end
 
-    # Default to not serving hidden files
-    #
-    def serve_hidden
-      @serve_hidden || false
+    def directory
+      @directory ||= FerverDirectory.new(self)
     end
-    alias_method :serve_hidden?, :serve_hidden
   end
 end

data/lib/ferver/controller.rb

@@ -1,19 +1,20 @@
-require 'sinatra'
-require 'sinatra/base'
-require 'json'
-require_relative './directory_not_found_error'
-require_relative './configuration'
+# frozen_string_literal: true
+require "sinatra"
+require "sinatra/base"
+require "json"
 
 module Ferver
   class Controller < Sinatra::Base
     before do
-      @ferver_list = FileList.new(current_ferver_path)
+      @ferver_list = FileList.new(Ferver.configuration.directory.found_files)
     end
 
-    before '/files/:id' do
-      halt(400, 'Bad request') unless valid_file_request?
-
-      find_file!
+    before "/files/:id" do
+      begin
+        @file = find_file! Integer(params[:id])
+      rescue ArgumentError
+        halt 400, "Bad request"
+      end
     end
 
     error Ferver::DirectoryNotFoundError do
@@ -21,13 +22,13 @@ module Ferver
     end
 
     # redirect to file list
-    get '/' do
-      redirect to('/files')
+    get "/" do
+      redirect to("/files")
     end
 
     # list files
-    get '/files' do
-      if request.preferred_type.to_s == 'application/json'
+    get "/files" do
+      if json_request?
         content_type :json
 
         ferver_list.map(&:name).to_json
@@ -39,36 +40,30 @@ module Ferver
     end
 
     # download file
-    get '/files/:id' do
-      send_file(
-        @file.path_to_file, disposition: 'attachment', filename: @file.name
-      )
+    get "/files/:id" do
+      send_file @file.path_to_file, disposition: String.new("attachment"), filename: @file.name
     end
 
     private
 
     attr_reader :ferver_list
 
-    def file_id_request
-      @file_id_request ||= FileIdRequest.new(params[:id])
-    end
-
-    def valid_file_request?
-      file_id_request.valid?
+    def find_file!(file_id)
+      ferver_list.file_by_id(file_id)
+    rescue Ferver::FileNotFoundError => error
+      halt 404, error.message
     end
 
-    def find_file!
-      @file = ferver_list.file_by_id(file_id_request.value)
-    rescue IndexError
-      halt 404, 'File requested not found.'
+    def json_request?
+      request.preferred_type.to_s == "application/json"
     end
 
     def current_ferver_path
-      Ferver.configuration.directory_path
+      Ferver.configuration.directory.path
     end
 
     def current_full_path
-      File.expand_path(current_ferver_path)
+      Ferver.configuration.directory.full_path
     end
   end
 end

data/lib/ferver/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Ferver
+  DirectoryNotFoundError = Class.new(StandardError)
+  FileNotFoundError      = Class.new(StandardError)
+end

data/lib/ferver/ferver_directory.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Ferver
+  # A wrapper around the directory specified by config
+  class FerverDirectory
+    def initialize(configuration)
+      path = configuration.directory_path
+      raise ArgumentError, "No path is specified" if path.empty?
+      raise DirectoryNotFoundError unless Dir.exist?(path)
+
+      @configuration = configuration
+    end
+
+    def path
+      configuration.directory_path
+    end
+
+    def full_path
+      @_full_path ||= File.expand_path(path)
+    end
+
+    def found_files
+      find_files
+    end
+
+    private
+
+    attr_reader :configuration
+
+    # Iterate through files in specified dir for valid files
+    #
+    def find_files
+      [].tap do |results|
+        Dir.foreach(full_path) do |file_name|
+          next if file_name == "." || file_name == ".."
+          next if file_name =~ /^\./ && !configuration.serve_hidden?
+
+          found_file = FoundFile.new(full_path, file_name)
+          results << found_file if found_file.valid?
+        end
+      end
+    end
+  end
+end