ferver 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e42a62e59a7371617918ea1c1a52702b6765ade1
-  data.tar.gz: 7144fe5b0a7167319a4f1837980f55796fabb554
+  metadata.gz: 53cab51e0ed1cb913ac92f9a19e927f9287115c4
+  data.tar.gz: 2be0b531e9d3b69bca13fbda397f84851fcbc414
 SHA512:
-  metadata.gz: 1d3ee2dfde1b61732967fc3cd2011702dec256256ae73dd3110c956588fdbb39f954b44c3dc0f5798c04597309d8f306d3f72caa8fabc49a731ba864ab17cc04
-  data.tar.gz: 7c658dfd826f29d134eb31fe0eb56a3973e5860c72446826cf3a7674e91063681a518a5adc1db1fb44b9940c19d27984773f5fd5258706cff0083118faecca79
+  metadata.gz: 0768729a9b85bb19183db20980214eeb22499d62a0fe23739dee08d9b635ff0eda80b937d09ee8e8801dadcefc041e1c07fbd7d3ff4087603af1e8f4d504aa43
+  data.tar.gz: 23c93f96598a6397cdc0e073acb16f58bd3da509be09a806638895d256c3d81b742e219822de5aa2897156906996b3ea768ed52af8fe6708c01c83528f69c50f

data/.ruby-version

@@ -1 +1 @@
-2.1.1
+2.2.0

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
+sudo: false
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
+  - 2.2.0
   - ruby-head
 
 addons:
    code_climate:
-     repo_token: aaa2bcd71ac641474a13caabe294beeb26abcc7c4dd82f3395a7b9193bb20d02 
+     repo_token: aaa2bcd71ac641474a13caabe294beeb26abcc7c4dd82f3395a7b9193bb20d02
+

data/CHANGELOG.md

@@ -1,7 +1,23 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## 1.2.1 - 2014-11-14 - XX
+## 1.3.0 - 2015-10-24 - TBC
+
+### Added
+* Don't serve hidden files by default
+* New `--all` option to serve hidden files
+* Sort files listed alphabetically
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Don't serve empty files
+
+## 1.2.1 - 2014-11-15 - de54826
 
 ### Added
 

data/README.md

@@ -17,6 +17,7 @@ Here's the spec for **ferver**:
 * available over http
 * provide a list of files as html and json
 * ignore directories
+* ignore dotfiles - turn off with setting
 * serve files as individual files
 * minimal config
 * able to specify the directory to serve files from
@@ -41,15 +42,25 @@ $ ferver
 
 ##### Use a specific directory
 
-For exmple, to serve files from **/Users/rob/Projects/ferver/** directory pass the path in as below;
+For exmple, to serve files from **/Users/rob/Projects/ferver/** directory pass the path in as below using the `--directory` option.
 
 ```bash
 $ ferver -d /Users/rob/Projects/ferver/
 ````
 
+##### Serve all files
+
+By default, dotfiles will be hidden. Use the `--all` option to serve all files.
+
+```bash
+$ ferver -a
+````
+
+> Note that zero size files will always be hidden.
+
 ##### Command line help
 
-For a list of arguments just use the `-h` switch.
+For a list of arguments just use the `--help` switch.
 
 ```bash
 $ ferver -h
@@ -67,7 +78,7 @@ List available files in your browser.
 
 #### JSON
 
-Requesting content-type `json`, for exampled passing the header `Accept: application/json` will return the list of files as json.
+Requesting content-type `json`, for example 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
@@ -83,15 +94,8 @@ 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 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 s
+After cloning the repo, you can run the web application without having to publish and then install the gem package by calling the executable as per normal.
 
-# or
-
-$ rake s /path/to/dir
-```
 
 ### License
 

data/Rakefile

@@ -1,27 +1,8 @@
-require 'bundler/gem_tasks'
-require 'rspec/core'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
 
-task :default => :spec
-task :s => :server
+task default: :spec
 
 desc "Run all specs in spec directory (excluding plugin specs)"
 RSpec::Core::RakeTask.new(:spec)
-
-desc 'Run ferver locally from source'
-task :server do
-  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.configure do |config|
-    config.directory_path = ferver_path
-  end
-  Ferver::App.set :raise_errors, false
-
-  # run!
-  Ferver::App.run!
-end

data/bin/ferver

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require 'optparse'
-require 'sinatra'
+$:.unshift File.join( File.dirname(__FILE__), "/../lib")
 require 'ferver'
 
 options = {}
@@ -9,6 +9,10 @@ OptionParser.new do |opts|
   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|
+    options[:hidden] = a
+  end
+
   opts.on('-d', '--directory [DIRECTORY]', 'Specify the path to the directory to serve files from [optional]') do |directory|
     options[:directory] = directory
   end
@@ -20,6 +24,7 @@ OptionParser.new do |opts|
 end.parse!
 
 Ferver.configure do |config|
+  config.serve_hidden = options[:hidden]
   config.directory_path = options[:directory]
 end
 Ferver::App.set :environment, :production

data/lib/ferver.rb

@@ -4,6 +4,7 @@ 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'
 
 module Ferver
@@ -11,18 +12,18 @@ module Ferver
   DEFAULT_FILE_SERVER_DIR_PATH = './'
 
   class << self
-      attr_accessor :configuration
-  end
+    attr_accessor :configuration
 
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-  def self.reset
-    @configuration = Configuration.new
-  end
+    def reset
+      @configuration = Configuration.new
+    end
 
-  def self.configure
-    yield(configuration)
+    def configure
+      yield(configuration)
+    end
   end
 end

data/lib/ferver/configuration.rb

@@ -1,11 +1,18 @@
 module Ferver
   class Configuration
-    attr_accessor :directory_path
+    attr_accessor :directory_path, :serve_hidden
 
     # Return the absolute path to the directory Ferver is serving files from.
     #
     def directory_path
       @directory_path || Ferver::DEFAULT_FILE_SERVER_DIR_PATH
     end
+
+    # Default to not serving hidden files
+    #
+    def serve_hidden
+      @serve_hidden || false
+    end
+    alias_method :serve_hidden?, :serve_hidden
   end
 end

data/lib/ferver/controller.rb

@@ -10,6 +10,12 @@ module Ferver
       @ferver_list = FileList.new(current_ferver_path)
     end
 
+    before '/files/:id' do
+      halt(400, 'Bad request') unless valid_file_request?
+
+      find_file!
+    end
+
     error Ferver::DirectoryNotFoundError do
       halt 500, "Ferver: Directory '#{current_ferver_path}' not found."
     end
@@ -24,26 +30,19 @@ module Ferver
       if request.preferred_type.to_s == 'application/json'
         content_type :json
 
-        ferver_list.all.to_json
+        ferver_list.map(&:name).to_json
       else
-        erb :index, locals: { file_list: ferver_list.all,
-                              ferver_path: File.expand_path(current_ferver_path),
+        erb :index, locals: { file_list: ferver_list,
+                              ferver_path: current_full_path,
                               file_count: ferver_list.size }
       end
     end
 
     # download file
     get '/files/:id' do
-      halt(400, 'Bad request') unless valid_file_request?
-
-      if ferver_list.file_id_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))
-      else
-        status 404
-      end
+      send_file(
+        @file.path_to_file, disposition: 'attachment', filename: @file.name
+      )
     end
 
     private
@@ -58,8 +57,18 @@ module Ferver
       file_id_request.valid?
     end
 
+    def find_file!
+      @file = ferver_list.file_by_id(file_id_request.value)
+    rescue IndexError
+      halt 404, 'File requested not found.'
+    end
+
     def current_ferver_path
       Ferver.configuration.directory_path
     end
+
+    def current_full_path
+      File.expand_path(current_ferver_path)
+    end
   end
 end

data/lib/ferver/directory_not_found_error.rb

@@ -1,4 +1,3 @@
-
 module Ferver
-  class DirectoryNotFoundError < StandardError; end
+  DirectoryNotFoundError = Class.new(StandardError)
 end

data/lib/ferver/file_id_request.rb

@@ -10,14 +10,7 @@ module Ferver
     end
 
     def value=(value)
-      id = parse_value(value)
-
-      if id.nil?
-        @is_valid = false
-      else
-        @value = id
-        @is_valid = true
-      end
+      @value = parse_value(value)
     end
 
     def valid?
@@ -28,9 +21,11 @@ module Ferver
 
     def parse_value(value)
       begin
-        Integer(value)
+        int_val = Integer(value)
+        @is_valid = true
+        int_val
       rescue
-        nil
+        @is_valid = false
       end
     end
   end

data/lib/ferver/file_list.rb

@@ -4,44 +4,33 @@ require 'forwardable'
 #
 module Ferver
   class FileList
-    extend Forwardable
     include Enumerable
 
-    def_delegators :@files, :size, :each
-
     # Create a new instance with a path
     #
     def initialize(path)
       fail ArgumentError, 'No path is specified' if path.empty?
       fail DirectoryNotFoundError unless Dir.exist?(path)
 
-      @files = []
       @configured_file_path = File.expand_path(path)
-      find_files
+      @files = find_files.sort_by! { |f| f.name.downcase }
     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)
+    def each(&block)
+      files.each(&block)
     end
 
-    # Is the file id a valid id for Ferver to serve
-    #
-    def file_id_valid?(file_id)
-      file_id < files.size
+    def size
+      files.size
     end
 
     # Filename by its index
+    # An id out of range with raise IndexError
     #
     def file_by_id(id)
       files.fetch(id)
     end
 
-    def all
-      files
-    end
-
     private
 
     attr_reader :configured_file_path, :files
@@ -49,13 +38,14 @@ module Ferver
     # Iterate through files in specified dir for files
     #
     def find_files
-      @files = []
-
-      Dir.foreach(configured_file_path) do |file|
-        next if file == '.' || file == '..'
-
-        file_path = FileList.path_for_file(configured_file_path, file)
-        @files << file if File.file?(file_path)
+      [].tap do |results|
+        Dir.foreach(configured_file_path) do |file_name|
+          next if file_name == '.' || file_name == '..'
+          next if file_name =~ /^\./ && !Ferver.configuration.serve_hidden?
+
+          found_file = FoundFile.new(configured_file_path, file_name)
+          results << found_file if found_file.valid?
+        end
       end
     end
   end

data/lib/ferver/found_file.rb

@@ -0,0 +1,16 @@
+module Ferver
+  class FoundFile
+    attr_reader :file_name, :path_to_file
+
+    alias_method :name, :file_name
+
+    def initialize(directory, file_name)
+      @file_name = file_name
+      @path_to_file = File.join(directory, file_name)
+    end
+
+    def valid?
+      File.file?(path_to_file) && !File.zero?(path_to_file)
+    end
+  end
+end

data/lib/ferver/version.rb

@@ -1,3 +1,3 @@
 module Ferver
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/lib/ferver/views/index.erb

@@ -7,9 +7,9 @@
   <body>
     <h3>Files served:</h3>
     <ul>
-      <% file_list.each_with_index do |file_name, index| %>
+      <% file_list.each_with_index do |file, index| %>
 
-        <li><a href="/files/<%= index %>"><%= file_name %></a></li>
+        <li><a href="/files/<%= index %>"><%= file.name %></a></li>
 
       <% end %>
 
@@ -25,4 +25,4 @@
 </html>
 
 <html>
-<body>
+<body>

data/spec/configuration_spec.rb

@@ -1,10 +1,9 @@
 require 'spec_helper'
 
 describe Ferver::Configuration do
-  subject { Ferver::Configuration.new }
+  subject { described_class.new }
 
   describe 'configured directory path' do
-
     context 'with no path set' do
       it 'should return default path' do
         expect(subject.directory_path).to eq(Ferver::DEFAULT_FILE_SERVER_DIR_PATH)
@@ -21,4 +20,20 @@ describe Ferver::Configuration do
       end
     end
   end
+
+  describe "serving all files" do
+    context "with no configuration set" do
+      it "is false by default" do
+        expect(subject.serve_hidden?).to be false
+      end
+    end
+
+    context "when configured to serve hidden" do
+      it "is true" do
+        subject.serve_hidden = true
+
+        expect(subject.serve_hidden?).to be true
+      end
+    end
+  end
 end

data/spec/ferver_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'ferver' do
-  let(:file_list) { double('file-list') }
+  let(:file_list) { double('Ferver::FileList') }
 
   context 'given a request to the server root' do
     before do
@@ -22,7 +22,7 @@ describe 'ferver' do
 
   describe 'choosing directory to serve files from' do
     before do
-      allow(file_list).to receive(:all).and_return(EMPTY_FILE_LIST)
+      allow(file_list).to receive(:each_with_index)
       allow(file_list).to receive(:size).and_return(0)
     end
 
@@ -63,7 +63,7 @@ describe 'ferver' do
 
   context 'given an empty list of files' do
     before do
-      allow(file_list).to receive(:all).and_return(EMPTY_FILE_LIST)
+      allow(file_list).to receive(:each_with_index)
       allow(file_list).to receive(:size).and_return(0)
       allow(Ferver::FileList).to receive(:new).and_return(file_list)
     end
@@ -83,6 +83,8 @@ describe 'ferver' do
 
     context 'when json content-type is requested' do
       before do
+        allow(file_list).to receive(:map).and_return([])
+
         get '/files', {}, 'HTTP_ACCEPT' => 'application/json'
       end
 
@@ -99,8 +101,10 @@ describe 'ferver' do
   end
 
   context 'given a list of files' do
+    let(:file_1) { double('file', name: 'file1') }
+    let(:file_2) { double('file', name: 'file2') }
     before do
-      allow(file_list).to receive(:all).and_return(%w(file1 file2))
+      allow(file_list).to receive(:each_with_index).and_yield(file_1, 1).and_yield(file_2, 2)
       allow(file_list).to receive(:size).and_return(2)
       allow(Ferver::FileList).to receive(:new).and_return(file_list)
     end
@@ -129,6 +133,8 @@ describe 'ferver' do
 
       context 'when json content-type is requested' do
         before do
+          allow(file_list).to receive(:map).and_return([file_1.name, file_2.name])
+
           get '/files', {}, 'HTTP_ACCEPT' => 'application/json'
         end
 
@@ -140,7 +146,7 @@ describe 'ferver' do
         it 'should contain no file list in response content' do
           list = JSON.parse last_response.body
           expect(list.count).to eq(2)
-          expect(list).to match_array(%w(file1 file2))
+          expect(list).to match_array([file_1.name, file_2.name])
         end
       end
     end
@@ -149,7 +155,7 @@ describe 'ferver' do
 
       context 'when requesting a file out of range' do
         before do
-          allow(file_list).to receive(:file_id_valid?).with(3).and_return(false)
+          allow(file_list).to receive(:file_by_id).with(3).and_raise(IndexError)
           get '/files/3'
         end
 

data/spec/file_list_spec.rb

@@ -1,6 +1,9 @@
 require 'spec_helper'
 
 describe Ferver::FileList do
+  let(:file_1) { double('file', name: 'file1') }
+  let(:file_2) { double('file', name: 'file2') }
+
   before { allow(Dir).to receive(:exist?).and_return(true) }
   subject { Ferver::FileList.new('/foo') }
 
@@ -47,14 +50,15 @@ describe Ferver::FileList do
     end
 
     it 'should return empty array of files' do
-      expect(subject.all).to eq(EMPTY_FILE_LIST)
+      expect(subject.to_a).to eq(EMPTY_FILE_LIST)
     end
   end
 
   context 'when path directory contains current working dir and parent' do
     before(:each) do
-      allow(Dir).to receive(:foreach).and_yield('.').and_yield('.').and_yield('file1')
+      allow(Dir).to receive(:foreach).and_yield('.').and_yield('.').and_yield(file_1.name)
       allow(File).to receive(:file?).and_return(true)
+      allow(File).to receive(:zero?).and_return(false)
     end
 
     it 'should not count current working dir and parent' do
@@ -62,14 +66,15 @@ describe Ferver::FileList do
     end
 
     it 'should not include current working dir and parent' do
-      expect(subject.all).to eq(['file1'])
+      expect(subject.to_a.first.name).to eq(file_1.name)
     end
   end
 
   context 'when path directory contains file and directory' do
     before(:each) do
-      allow(Dir).to receive(:foreach).and_yield('file1').and_yield('a_directory')
+      allow(Dir).to receive(:foreach).and_yield(file_1.name).and_yield('a_directory')
       allow(File).to receive(:file?).twice.and_return(true, false)
+      allow(File).to receive(:zero?).twice.and_return(false, true)
     end
 
     it 'should not count the directory' do
@@ -77,30 +82,30 @@ describe Ferver::FileList do
     end
 
     it 'should not include the directory' do
-      expect(subject.all).to eq(['file1'])
+      expect(subject.to_a.first.name).to eq(file_1.name)
     end
   end
 
   context 'when path directory contains valid files' do
-    let(:files) { %w(file1 file2) }
     before do
-      allow(Dir).to receive(:foreach).and_yield(files[0]).and_yield(files[1])
+      allow(Dir).to receive(:foreach).and_yield(file_1.name).and_yield(file_2.name)
       allow(File).to receive(:file?).twice.and_return(true)
+      allow(File).to receive(:zero?).twice.and_return(false)
     end
 
     it 'should count all files' do
       expect(subject.size).to eq(2)
     end
 
-    it 'should list all files' do
-      expect(subject.all).to eq(files)
-    end
+    describe "ordering" do
+      let(:file_2) { double('file', name: 'alpha') }
+      let(:file_1) { double('file', name: 'zeta') }
+      let(:ordered_files) { [file_2.name, file_1.name] }
 
-    describe 'iterating over files list' do
       it 'should yield files in order' do
         i = 0
         subject.each do | file |
-          expect(file).to eq(files[i])
+          expect(file.name).to eq(ordered_files[i])
           i += 1
         end
       end
@@ -109,35 +114,22 @@ describe Ferver::FileList do
 
   describe 'requesting files' do
     before(:each) do
-      allow(Dir).to receive(:foreach).and_yield('file1').and_yield('file2')
+      allow(Dir).to receive(:foreach).and_yield(file_1.name).and_yield(file_2.name)
       allow(File).to receive(:file?).and_return(true)
+      allow(File).to receive(:zero?).and_return(false)
     end
 
     context 'when requesting valid file_id' do
-      # TODO: possible to redesign this
-
-      it '#file_id_valid? should return true for first file' do
-        expect(subject.file_id_valid?(0)).to be_truthy
-      end
-
-      it '#file_id_valid? should return true for second file' do
-        expect(subject.file_id_valid?(1)).to be_truthy
-      end
-
       it '#file_by_id should return the correct file for the first file' do
-        expect(subject.file_by_id(0)).to eq('file1')
+        expect(subject.file_by_id(0).name).to eq(file_1.name)
       end
 
       it '#file_by_id should return the correct file for the second file' do
-        expect(subject.file_by_id(1)).to eq('file2')
+        expect(subject.file_by_id(1).name).to eq(file_2.name)
       end
     end
 
     context 'when requesting invalid file_id' do
-      it 'should return false for invalid file_id' do
-        expect(subject.file_id_valid?(2)).to be_falsey
-      end
-
       it 'should raise_error if file_by_id is called' do
         expect { subject.file_by_id(2) }.to raise_error(IndexError)
       end

data/spec/spec_helper.rb

@@ -29,6 +29,7 @@ Spork.prefork do
 
   RSpec.configure do |config|
     config.include Rack::Test::Methods
+    config.include RSpecHtmlMatchers
   end
 
   def app

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferver
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Rob Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-15 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,6 +163,7 @@ files:
 - lib/ferver/directory_not_found_error.rb
 - lib/ferver/file_id_request.rb
 - lib/ferver/file_list.rb
+- lib/ferver/found_file.rb
 - lib/ferver/version.rb
 - lib/ferver/views/index.erb
 - spec/configuration_spec.rb
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A simple web app to serve files over HTTP.