ferver 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88fa261cbca7d3076a07ff0531243891902f7b13
-  data.tar.gz: 2ba5cbe2dd11de73bcc3076e878529fed5c1e685
+  metadata.gz: 8d2f0cc442e5c638817dbd7465cac6033cbafa38
+  data.tar.gz: 3344fc4b12b37de5ec6e08da1694c093172a6bbe
 SHA512:
-  metadata.gz: 66bb027b877ae36dbdcc68a53f75558480dafd2af82382ab53b47a6bdd856189b1b93ae48d95608defcf94beb289270b2094c54d3f78b1b975a78df91570d3c0
-  data.tar.gz: a1c85bf0783ffd26e95b69a5b40b038f34aa705f2b1432f86acc15b5688479c34f671121e26e4948ba6e64da686b7ff760bacb4d77099acc9dd353b8dc6eb516
+  metadata.gz: 98f244dec47ab5c2dd7cd9d1ac687115763a63872622d03dd602d002125d38169210af42d66ad1eb3b8bd53d0edb72e068cf2cd7a7363debd62be2f57ce7f1b1
+  data.tar.gz: a111d09816eefba4e1da78e7e5af7d7172d6526d5cb14988dca5b4d6d8d4f27c54a4005963b937ec4d10bead859cc9c536e2f20015342fc55f10b3fa7cf0c11a

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.1.1

data/.travis.yml

@@ -2,4 +2,9 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.0
+  - ruby-head
+
+addons:
+   code_climate:
+     repo_token: aaa2bcd71ac641474a13caabe294beeb26abcc7c4dd82f3395a7b9193bb20d02 

data/README.md

@@ -2,11 +2,11 @@
 
 #### Ferver: A simple web app to serve files over HTTP packaged as a Ruby gem.
 
-[![Build Status](https://travis-ci.org/rob-murray/ferver.png?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) 
-[![Dependency Status](https://gemnasium.com/rob-murray/ferver.png)](https://gemnasium.com/rob-murray/ferver) 
-[![Gem Version](https://badge.fury.io/rb/ferver.png)](http://badge.fury.io/rb/ferver)
+[![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)
+[![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)
 
 ### Description
 
@@ -31,7 +31,7 @@ $ gem install ferver
 
 ### Usage
 
-You can run **ferver** from any directory, just pass in the directory you want to serve files from or if leave blank to use the current directory.
+You can run **ferver** from any directory, just pass in the directory you want to serve files from as a command line argument or leave blank to use the current directory.
 
 ##### Use the current directory
 
@@ -44,7 +44,15 @@ $ ferver
 For exmple, to serve files from **/Users/rob/Projects/ferver/** directory pass the path in as below;
 
 ```bash
-$ ferver /Users/rob/Projects/ferver/
+$ ferver -d /Users/rob/Projects/ferver/
+````
+
+##### Command line help
+
+For a list of arguments just use the `-h` switch.
+
+```bash
+$ ferver -h
 ````
 
 ### Accessing files
@@ -75,14 +83,14 @@ For example to download file appearing third in the list displayed earlier, requ
 
 Please use the GitHub pull-request mechanism to submit contributions.
 
-After cloning the repo, you can test the application without having to install the gem package by running the `server` Rake task;
+After cloning the repo, you can run the web application without having to install the gem package by running a Rake task named `server`, or it's alias `s`.
 
 ```bash
-$ rake server
+$ rake s
 
 # or
 
-$ rake server /path/to/dir
+$ rake s /path/to/dir
 ```
 
 ### License

data/Rakefile

@@ -1,25 +1,27 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rspec/core'
 require 'rspec/core/rake_task'
- 
+
 task :default => :spec
- 
+task :s => :server
+
 desc "Run all specs in spec directory (excluding plugin specs)"
 RSpec::Core::RakeTask.new(:spec)
 
-desc "Run ferver locally from source"
-task :server do |t, args|
-
-    require 'rubygems'
-    require 'bundler'
-    Bundler.setup
-    require 'ferver'
-
-    # use the last argument (first is the rake task) as the file path to serve from
-    ferver_path = (ARGV.length == 2 && ARGV.last) || nil
-    Ferver::App.set :ferver_path, ferver_path
+desc 'Run ferver locally from source'
+task :server do
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+  require 'ferver'
 
-    # run!
-    Ferver::App.run!
+  # use the last argument (first is the rake task) as the file path to serve from
+  ferver_path = (ARGV.length == 2 && ARGV.last) || nil
+  Ferver.configure do |config|
+    config.directory_path = ferver_path
+  end
+  Ferver::App.set :raise_errors, false
 
-end
+  # run!
+  Ferver::App.run!
+end

data/bin/ferver

@@ -1,13 +1,28 @@
 #!/usr/bin/env ruby
 
+require 'optparse'
 require 'sinatra'
 require 'ferver'
 
+options = {}
+OptionParser.new do |opts|
+  opts.banner = 'Ferver: A simple web app to serve files over HTTP. Version: ' + Ferver::VERSION
+  opts.separator ''
 
-# use the first argument as the file path to serve from
-ferver_path = (ARGV.length == 1 && ARGV[0]) || nil
-Ferver::App.set :ferver_path, ferver_path
+  opts.on('-d', '--directory [DIRECTORY]', 'Specify the path to the directory to serve files from [optional]') do |directory|
+    options[:directory] = directory
+  end
+
+  opts.on("-h", "--help", "Displays help") do
+    puts opts
+    exit
+  end
+end.parse!
+
+Ferver.configure do |config|
+  config.directory_path = options[:directory]
+end
 Ferver::App.set :environment, :production
 
 # run!
-Ferver::App.run!
+Ferver::App.run!

data/ferver.gemspec

@@ -4,29 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 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.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.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", "~> 2.14.1"
-  spec.add_development_dependency "rack-test", "~> 0.6.2"
-  spec.add_development_dependency "mocha", "~> 1.0.0"
-  spec.add_development_dependency "spork", "~> 0.9.2"
-  spec.add_development_dependency "webrat", "~> 0.7.3"
-  spec.add_development_dependency "coveralls", "~> 0.7.0"
 
-  spec.add_dependency "sinatra", "~> 1.4.4"
+  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_dependency 'sinatra', '~> 1.4'
 end

data/lib/ferver.rb

@@ -1,7 +1,29 @@
-require "ferver/version"
+require_relative 'ferver/app'
+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/version'
 
 module Ferver
   autoload :App, 'ferver/app'
 
-  class DirectoryNotFoundError < StandardError; end
+  # By default, serve files from current location when the gem is called.
+  DEFAULT_FILE_SERVER_DIR_PATH = './'
+
+  class << self
+      attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/ferver/app.rb

@@ -1,126 +1,67 @@
-require "sinatra"
-require "json"
-require "sinatra/base"
-require "ferver/file_list"
-require "ferver/file_id_request"
+require 'sinatra'
+require 'sinatra/base'
+require 'json'
+require_relative './directory_not_found_error'
+require_relative './configuration'
 
 module Ferver
   class App < Sinatra::Base
-
-    # Config
-    set :inline_templates, true
     set :app_file, __FILE__
 
-    # By default, serve files from current location when the gem 
-    #   binary is called.
-    DEFAULT_FILE_SERVER_DIR_PATH = "./"
+    before do
+      @ferver_list = FileList.new(current_ferver_path)
+    end
 
-    # redirect to file list
-    # /
-    get "/" do
-      redirect to("/files")
+    error Ferver::DirectoryNotFoundError do
+      halt 500, "Ferver: Directory '#{current_ferver_path}' not found."
     end
 
-    # list files; repond as html or json
-    # /files
-    get "/files" do
-      file_list = @ferver_list.files
+    # redirect to file list
+    get '/' do
+      redirect to('/files')
+    end
 
-      if request.preferred_type.to_s == "application/json"
+    # list files
+    get '/files' do
+      if request.preferred_type.to_s == 'application/json'
         content_type :json
 
-        file_list.to_json
+        ferver_list.all.to_json
       else
-        @file_count = @ferver_list.file_count
-        @ferver_path = File.expand_path(get_current_ferver_path)
-        @file_list = file_list
-
-        erb :file_list_view
+        erb :index, locals: { file_list: ferver_list.all,
+                              ferver_path: File.expand_path(current_ferver_path),
+                              file_count: ferver_list.size }
       end
-      
     end
 
     # download file
-    # /files/:id
-    get "/files/:id" do
-      id_request = Ferver::FileIdRequest.new(params[:id])
+    get '/files/:id' do
+      halt(400, 'Bad request') unless valid_file_request?
 
-      halt(400, "Bad request") unless id_request.valid?
-      
-      if @ferver_list.file_id_is_valid?(id_request.value)
-        file_name = @ferver_list.file_by_id(id_request.value)
-        file = FileList.path_for_file(get_current_ferver_path, file_name)
+      if ferver_list.file_id_is_valid?(file_id_request.value)
+        file_name = ferver_list.file_by_id(file_id_request.value)
+        file = FileList.path_for_file(current_ferver_path, file_name)
 
-        send_file(file, :disposition => 'attachment', :filename => File.basename(file))
+        send_file(file, disposition: 'attachment', filename: File.basename(file))
       else
         status 404
       end
     end
 
-
-    # Find all files in `Ferver` directory. 
-    # !Called before each request
-    #
-    before do
-      begin
-        @ferver_list = FileList.new(get_current_ferver_path)
-      rescue DirectoryNotFoundError
-        halt(500, "Ferver: Directory '#{get_current_ferver_path}' not found.")
-      end
-      
-    end
-
     private
 
-      # Return the absolute path to the directory Ferver is serving files from.
-      # This can be specified in Sinatra configuration; 
-      #   i.e. `Ferver::App.set :ferver_path, ferver_path` or the default if nil
-      #
-      def get_current_ferver_path
-        @current_ferver_path ||= begin
-          path = nil
+    attr_reader :ferver_list
 
-          if settings.respond_to?(:ferver_path) and settings.ferver_path
-            path = settings.ferver_path
-          else
-            path = DEFAULT_FILE_SERVER_DIR_PATH
-          end
-        end
-      end
+    def file_id_request
+      @file_id_request ||= FileIdRequest.new(params[:id])
+    end
 
+    def valid_file_request?
+      file_id_request.valid?
+    end
+
+    def current_ferver_path
+      Ferver.configuration.directory_path
+    end
   end
 end
-
-
-
-__END__
- 
-@@file_list_view
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="utf-8">
-    <title>File List &middot; Ferver</title>
-  </head>
-  <body>
-    <h3>Files served:</h3>
-    <ul>
-      <% @file_list.each_with_index do |file_name, index| %>
-
-        <li><a href="/files/<%= index %>"><%= file_name %></a></li>
-
-      <% end %>
-
-    </ul>
-
-    <p><%= @file_count %> files served from: <%= @ferver_path %></p>
-
-    <hr>
-
-    <p>Served by <a href="https://github.com/rob-murray/ferver" title="Ferver: A simple Ruby app serving files over HTTP">Ferver</a> gem v<%= Ferver::VERSION %></p>
-
-  </body>
-</html>
-
-<html>
-<body>

data/lib/ferver/configuration.rb

@@ -0,0 +1,11 @@
+module Ferver
+  class Configuration
+    attr_accessor :directory_path
+
+    # Return the absolute path to the directory Ferver is serving files from.
+    #
+    def directory_path
+      @directory_path || Ferver::DEFAULT_FILE_SERVER_DIR_PATH
+    end
+  end
+end

data/lib/ferver/directory_not_found_error.rb

@@ -0,0 +1,4 @@
+
+module Ferver
+  class DirectoryNotFoundError < StandardError; end
+end

data/lib/ferver/file_id_request.rb

@@ -1,28 +1,37 @@
 
 module Ferver
-    class FileIdRequest
+  class FileIdRequest
+    attr_reader :value
 
-        attr_reader :value
+    def initialize(value = nil)
+      @is_valid = false
 
-        def initialize(value = nil)
-            @is_valid = false
+      self.value = value
+    end
+
+    def value=(value)
+      id = parse_value(value)
 
-            self.value = value
-        end
+      if id.nil?
+        @is_valid = false
+      else
+        @value = id
+        @is_valid = true
+      end
+    end
 
-        def value=(value)
-            id = Integer(value) rescue nil
+    def valid?
+      @is_valid
+    end
 
-            if id.nil?
-                @is_valid = false
-            else
-                @value = id
-                @is_valid = true
-            end
-        end
+    private
 
-        def valid?
-            @is_valid
-        end
+    def parse_value(value)
+      begin
+        Integer(value)
+      rescue
+        nil
+      end
     end
-end
+  end
+end