ferver 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 137fd53d644093579a6fd6c6dae744d54e6bf9b0
-  data.tar.gz: 588b0d87f456072b9d577f766c4cd623de59487b
+  metadata.gz: 88fa261cbca7d3076a07ff0531243891902f7b13
+  data.tar.gz: 2ba5cbe2dd11de73bcc3076e878529fed5c1e685
 SHA512:
-  metadata.gz: 7833e07900143a2ee6bb1ebbf007fe744a5ab814082dc93b2a9b0ed9840c7f184b7a36891d5b73d6a882107a43e1bcf917d0d5cf0f2c3be7e8ce154705bc03fd
-  data.tar.gz: 3b79d0e6fed0e1913fc084d4d0ae6c29c5539e52a73ef3de62a01802533b0227c2849ceef016c64a805e0dbd48105ab5e519922b530981f6e79ddc4144819d94
+  metadata.gz: 66bb027b877ae36dbdcc68a53f75558480dafd2af82382ab53b47a6bdd856189b1b93ae48d95608defcf94beb289270b2094c54d3f78b1b975a78df91570d3c0
+  data.tar.gz: a1c85bf0783ffd26e95b69a5b40b038f34aa705f2b1432f86acc15b5688479c34f671121e26e4948ba6e64da686b7ff760bacb4d77099acc9dd353b8dc6eb516

data/README.md

@@ -1,12 +1,16 @@
 ## Ferver = File-Server
 
-#### Ferver: A simple web app to server files over HTTP packaged as a Ruby gem.
+#### 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)
+[![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)
 
 ### Description
 
-This is super, simple ruby gem to serve files over **http**, useful as a basic file server to quickly share files on your local network or something. Just install the gem and go!
+This is super, simple ruby gem to serve files over **http**, useful as a basic file server to quickly share files on your local network or something over the web. Just install the gem and go!
 
 Here's the spec for **ferver**:
 
@@ -19,9 +23,7 @@ Here's the spec for **ferver**:
 
 ### Getting started
 
-Using **ferver** could not be simpler; 
-
-Install the **ferver** gem
+Using **ferver** could not be simpler - just install the **ferver** gem.
 
 ```bash
 $ gem install ferver
@@ -42,7 +44,6 @@ $ ferver
 For exmple, to serve files from **/Users/rob/Projects/ferver/** directory pass the path in as below;
 
 ```bash
-# Serve files from a specific directory
 $ ferver /Users/rob/Projects/ferver/
 ````
 
@@ -52,11 +53,13 @@ The **ferver** gem uses [Sinatra](http://www.sinatrarb.com/) and runs on default
 
 #### HTML
 
-`http://localhost:4567/files` - List available files
+List available files in your browser.
+
+`http://localhost:4567/files`
 
 #### JSON
 
-Passing the header `Accept: application/json` will return the list of files as json.
+Requesting content-type `json`, for exampled passing the header `Accept: application/json` will return the list of files as json.
 
 ```bash
 curl -i -H "Accept: application/json" http://localhost:4567/files
@@ -72,6 +75,16 @@ 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;
+
+```bash
+$ rake server
+
+# or
+
+$ rake server /path/to/dir
+```
+
 ### License
 
 This project is available for use under the MIT software license.

data/Rakefile

@@ -5,4 +5,21 @@ require 'rspec/core/rake_task'
 task :default => :spec
  
 desc "Run all specs in spec directory (excluding plugin specs)"
-RSpec::Core::RakeTask.new(:spec)
+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
+
+    # run!
+    Ferver::App.run!
+
+end

data/bin/ferver

@@ -3,9 +3,11 @@
 require 'sinatra'
 require 'ferver'
 
+
 # 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
+Ferver::App.set :environment, :production
 
 # run!
 Ferver::App.run!

data/lib/ferver.rb

@@ -2,4 +2,6 @@ require "ferver/version"
 
 module Ferver
   autoload :App, 'ferver/app'
+
+  class DirectoryNotFoundError < StandardError; end
 end

data/lib/ferver/app.rb

@@ -2,6 +2,7 @@ require "sinatra"
 require "json"
 require "sinatra/base"
 require "ferver/file_list"
+require "ferver/file_id_request"
 
 module Ferver
   class App < Sinatra::Base
@@ -12,61 +13,48 @@ module Ferver
 
     # By default, serve files from current location when the gem 
     #   binary is called.
-    DEFAULT_FILE_SERVER_DIR_PATH = './'
+    DEFAULT_FILE_SERVER_DIR_PATH = "./"
 
     # redirect to file list
     # /
-    get '/' do
-
-      redirect to('/files')
-
+    get "/" do
+      redirect to("/files")
     end
 
-
     # list files; repond as html or json
     # /files
-    get '/files' do
-
+    get "/files" do
       file_list = @ferver_list.files
 
       if request.preferred_type.to_s == "application/json"
-
         content_type :json
-        file_list.to_json
 
+        file_list.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
-
       end
       
     end
 
-
     # download file
     # /files/:id
-    get '/files/:id' do
+    get "/files/:id" do
+      id_request = Ferver::FileIdRequest.new(params[:id])
 
-      id = Integer(params[:id]) rescue halt(400, "Bad request")
+      halt(400, "Bad request") unless id_request.valid?
       
-      if @ferver_list.file_id_is_valid?(id)
-
-        file_name = @ferver_list.file_by_id(id)
-
+      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)
 
         send_file(file, :disposition => 'attachment', :filename => File.basename(file))
-
       else
-
         status 404
-
       end
-      
     end
 
 
@@ -74,9 +62,12 @@ module Ferver
     # !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
       
-      @ferver_list = FileList.new(get_current_ferver_path)
-
     end
 
     private
@@ -86,7 +77,6 @@ module Ferver
       #   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
 
@@ -95,8 +85,7 @@ module Ferver
           else
             path = DEFAULT_FILE_SERVER_DIR_PATH
           end
-        end        
-
+        end
       end
 
   end

data/lib/ferver/file_id_request.rb

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

data/lib/ferver/file_list.rb

@@ -9,45 +9,35 @@ module Ferver
       # create a new instance with a path
       #
       def initialize(path)
-
         raise ArgumentError, "No path is specified" if path.empty?
+        raise DirectoryNotFoundError unless Dir.exists?(path)
 
         @file_path = File.expand_path(path)
-
         find_files
-        
       end
 
       # Return an absolute path to a `file_name` in the `directory`
       #
       def self.path_for_file(directory, file_name)
-
         File.join(directory, file_name)
-
       end
 
       # Is the file id a valid id for Ferver to serve
       #
       def file_id_is_valid?(file_id)
-
         file_id < @files.size
-
       end
 
       # Filename by its index
       #
       def file_by_id(id)
-
         @files.fetch(id)
-
       end
 
       # Number of files in list 
       #
       def file_count
-
         @files.size
-
       end
 
       private
@@ -55,20 +45,15 @@ module Ferver
         # Iterate through files in specified dir for files
         #
         def find_files
-
           @files = []
 
           Dir.foreach(@file_path) do |file|
-
             next if file == '.' or file == '..'
 
             file_path = FileList.path_for_file(@file_path, file)
-
             @files << file if File.file?(file_path)
-
           end
-
         end
-
+        
     end
 end

data/lib/ferver/version.rb

@@ -1,3 +1,3 @@
 module Ferver
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/ferver_spec.rb

@@ -1,13 +1,13 @@
-require 'spec_helper'
+require "spec_helper"
 
-describe 'ferver' do
+describe "ferver" do
     include Webrat::Matchers # allow cool html matching
 
 
     context "given a request to the server root" do
 
         before(:each) do
-            get '/'
+            get "/"
         end
 
         it "should return redirect" do
@@ -35,28 +35,48 @@ describe 'ferver' do
 
             it "will use default directory" do
 
-                Ferver::FileList.expects(:new).with('./').returns(@file_list)
+                Ferver::FileList.expects(:new).with("./").returns(@file_list)
 
-                get '/files'
+                get "/files"
             end
 
         end
 
         context "when the directory passed via configuration" do
 
-            before { Ferver::App.set :ferver_path, '/foo' }
+            before { Ferver::App.set :ferver_path, "/foo" }
 
             it "will use directory specified" do
-                Ferver::FileList.expects(:new).with('/foo').returns(@file_list)
+                Ferver::FileList.expects(:new).with("/foo").returns(@file_list)
 
-                get '/files'
+                get "/files"
+            end
+
+        end
+
+        context "when directory does not exist" do
+
+            before(:each) { Ferver::App.set :ferver_path, "/foo" }
+
+            it "will attempt to create FileList with path" do
+                Ferver::FileList.expects(:new).with("/foo").raises(Ferver::DirectoryNotFoundError)
+
+                get "/files"
+            end
+
+            it "will return server error status" do
+                Ferver::FileList.stubs(:new).with("/foo").raises(Ferver::DirectoryNotFoundError)
+
+                get "/files"
+
+                last_response.status.should eql 500
             end
 
         end
 
     end
 
-    context 'given an empty list of files' do
+    context "given an empty list of files" do
 
         before {
             file_list = mock()
@@ -67,7 +87,7 @@ describe 'ferver' do
 
         context "when no content-type is requested" do
 
-            before { get '/files' }
+            before { get "/files" }
 
             it "should return valid response" do
                 expect(last_response).to be_ok
@@ -84,12 +104,12 @@ describe 'ferver' do
         context "when json content-type is requested" do
 
             before {
-                get '/files', {}, {"HTTP_ACCEPT" => "application/json" }
+                get "/files", {}, {"HTTP_ACCEPT" => "application/json" }
             }
 
             it "should return valid response" do
                 expect(last_response).to be_ok
-                expect(last_response.content_type).to include('application/json')
+                expect(last_response.content_type).to include("application/json")
             end
 
             it "should contain no file list in response content" do
@@ -101,7 +121,7 @@ describe 'ferver' do
 
     end
 
-    context 'given a list of files' do
+    context "given a list of files" do
 
         before {
             file_list = mock()
@@ -112,7 +132,7 @@ describe 'ferver' do
 
         context "when no content-type is requested" do
 
-            before { get '/files' }
+            before { get "/files" }
 
             it "should return valid response" do
                 expect(last_response).to be_ok
@@ -138,12 +158,12 @@ describe 'ferver' do
         context "when json content-type is requested" do
 
             before {
-                get '/files', {}, {"HTTP_ACCEPT" => "application/json" }
+                get "/files", {}, {"HTTP_ACCEPT" => "application/json" }
             }
 
             it "should return valid response" do
                 expect(last_response).to be_ok
-                expect(last_response.content_type).to include('application/json')
+                expect(last_response.content_type).to include("application/json")
             end
 
             it "should contain no file list in response content" do
@@ -170,7 +190,7 @@ describe 'ferver' do
 
             before {
                 @file_list.expects(:file_id_is_valid?).with(3).returns(false)
-                get '/files/3'
+                get "/files/3"
             }
 
             it "should return not_found" do
@@ -183,7 +203,7 @@ describe 'ferver' do
 
             before {
                 @file_list.expects(:file_id_is_valid?).never
-                get '/files/foo'
+                get "/files/foo"
             }
 
             it "should return not_found" do
@@ -194,7 +214,7 @@ describe 'ferver' do
 
         context "when requesting a valid file id" do
 
-            before { get '/files/0' }
+            before { get "/files/0" }
 
             xit "should return ok response" do
                 expect(last_response).to be_ok

data/spec/file_id_request_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Ferver::FileIdRequest do
+
+    describe "creating new instance" do
+
+        context "when valid Integer is passed" do
+
+            let(:id_request) { Ferver::FileIdRequest.new(1) }
+
+            it "should create instance" do
+                expect(id_request).not_to be_nil
+            end
+
+            it "should return expected value" do
+                expect(id_request.value).to eq(1)
+            end
+
+        end
+
+        context "when nil argument is passed" do
+
+            it "should be invalid" do
+                id_request = Ferver::FileIdRequest.new(nil)
+                expect(id_request.valid?).to be_false
+            end
+
+        end
+
+    end
+
+    describe "#value= method" do
+
+        let(:id_request) { Ferver::FileIdRequest.new }
+
+        context "when valid Integer is passed" do
+
+            before { id_request.value = 1 }
+
+            it "should be valid" do
+                expect(id_request.valid?).to be_true
+            end
+
+            it "should return expected value" do
+                expect(id_request.value).to eq(1)
+            end
+
+        end
+
+        context "when valid String as Integer is passed" do
+
+            before { id_request.value = "1" }
+
+            it "should be valid" do
+                expect(id_request.valid?).to be_true
+            end
+
+            it "should return expected value" do
+                expect(id_request.value).to eq(1)
+            end
+
+        end
+
+        context "when a string is passed" do
+
+            before { id_request.value = "foo" }
+
+            it "should be invalid" do
+                expect(id_request.valid?).to be_false
+            end
+
+        end
+
+        context "when an empty string is passed" do
+
+            it "should be invalid" do
+                id_request.value = ""
+                expect(id_request.valid?).to be_false
+            end
+
+        end
+
+    end
+
+
+end

data/spec/file_list_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe Ferver::FileList do
 
+    before { Dir.stubs(:exists?).returns(true) }
+
     describe "creating instance" do
 
         context "when empty path argument is passed" do
@@ -12,9 +14,9 @@ describe Ferver::FileList do
 
         end
 
-        context "when path argument is passed" do
+        context "when valid path argument is passed" do
 
-            let(:path) { '/foo' }
+            let(:path) { "/foo" }
 
             it "should find files in path argument" do
                 Dir.expects(:foreach).with(path).returns(EMPTY_FILE_LIST)
@@ -23,11 +25,29 @@ describe Ferver::FileList do
             
         end
 
+        context "when path argument passed does not exist" do
+
+            let(:path) { "/foo" }
+
+            it "should test if directory exists" do
+                Dir.expects(:exists?).with(path).returns(true)
+                Dir.stubs(:foreach).returns(EMPTY_FILE_LIST)
+
+                Ferver::FileList.new(path)
+            end
+
+            it "should raise exception" do
+                Dir.stubs(:exists?).returns(false)
+                expect { Ferver::FileList.new(path) }.to raise_error(Ferver::DirectoryNotFoundError)
+            end
+
+        end
+
     end
 
     context "when path directory is empty" do
 
-        let(:file_list) { Ferver::FileList.new('/foo') }
+        let(:file_list) { Ferver::FileList.new("/foo") }
 
         before { Dir.stubs(:foreach).returns(EMPTY_FILE_LIST) }
 
@@ -43,7 +63,7 @@ describe Ferver::FileList do
 
     context "when path directory contains current working dir and parent" do
 
-        let(:file_list) { Ferver::FileList.new('/foo') }
+        let(:file_list) { Ferver::FileList.new("/foo") }
 
         before(:each) do
             Dir.stubs(:foreach).multiple_yields(".", "..", "file1")
@@ -62,7 +82,7 @@ describe Ferver::FileList do
 
     context "when path directory contains file and directory" do
 
-        let(:file_list) { Ferver::FileList.new('/foo') }
+        let(:file_list) { Ferver::FileList.new("/foo") }
 
         before(:each) do
             Dir.stubs(:foreach).multiple_yields("file1", "a_directory")
@@ -81,7 +101,7 @@ describe Ferver::FileList do
 
     context "when path directory contains valid files" do
 
-        let(:file_list) { Ferver::FileList.new('/foo') }
+        let(:file_list) { Ferver::FileList.new("/foo") }
 
         before {
             Dir.stubs(:foreach).multiple_yields("file1", "file2")
@@ -100,7 +120,7 @@ describe Ferver::FileList do
 
     describe "requesting files" do
 
-        let(:file_list) { Ferver::FileList.new('/foo') }
+        let(:file_list) { Ferver::FileList.new("/foo") }
 
         before {
             Dir.stubs(:foreach).multiple_yields("file1", "file2")

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ Coveralls.wear! # this uses SimpleCov under its bonnet
 
 Spork.prefork do
   require File.join(File.dirname(__FILE__), '..', '/lib/', 'ferver', 'file_list')
+  require File.join(File.dirname(__FILE__), '..', '/lib/', 'ferver', 'file_id_request')
   require 'ferver'
 
   require 'rubygems'
@@ -18,7 +19,7 @@ Spork.prefork do
   require 'webrat'
   
   # test environment stuff
-  set :environment, :testf
+  set :environment, :test
   set :run, false
   set :raise_errors, true
   set :logging, false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferver
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -157,10 +157,11 @@ files:
 - ferver.gemspec
 - lib/ferver.rb
 - lib/ferver/app.rb
+- lib/ferver/file_id_request.rb
 - lib/ferver/file_list.rb
 - lib/ferver/version.rb
-- run.rb
 - spec/ferver_spec.rb
+- spec/file_id_request_spec.rb
 - spec/file_list_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rob-murray/ferver
@@ -189,5 +190,6 @@ specification_version: 4
 summary: A simple web app to serve files over HTTP.
 test_files:
 - spec/ferver_spec.rb
+- spec/file_id_request_spec.rb
 - spec/file_list_spec.rb
 - spec/spec_helper.rb

data/run.rb

@@ -1,21 +0,0 @@
-require 'rubygems'
-require 'bundler'
-Bundler.setup
-require 'ferver'
-
-def main
-
-    # 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
-
-    # run!
-    Ferver::App.run!
-
-end
-
-
-if __FILE__ == $0
-    main()
-end
-