RubyGems - ferver - Versions diffs - 1.1.0 → 1.2.0 - Mend

ferver 1.1.0 → 1.2.0

Files changed (21) hide show

checksums.yaml +4 -4
data/.ruby-version +1 -1
data/.travis.yml +6 -1
data/README.md +18 -10
data/Rakefile +19 -17
data/bin/ferver +19 -4
data/ferver.gemspec +19 -19
data/lib/ferver.rb +24 -2
data/lib/ferver/app.rb +38 -97
data/lib/ferver/configuration.rb +11 -0
data/lib/ferver/directory_not_found_error.rb +4 -0
data/lib/ferver/file_id_request.rb +28 -19
data/lib/ferver/file_list.rb +48 -46
data/lib/ferver/version.rb +1 -1
data/lib/ferver/views/index.erb +28 -0
data/spec/configuration_spec.rb +24 -0
data/spec/ferver_spec.rb +132 -180
data/spec/file_id_request_spec.rb +46 -67
data/spec/file_list_spec.rb +107 -128
data/spec/spec_helper.rb +10 -10
metadata +49 -44

@@ -1,59 +1,61 @@
+require 'forwardable'
 # A representation of Ferver's file list
 #
 module Ferver
-    class FileList
-      # List of files
-      attr_reader :files
-      # 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)
+  class FileList
+    extend Forwardable
+    def_delegators :@files, :size, :each
+    include Enumerable
+    # 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
+    end
-        @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
-      # 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
-      # 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
-      # Filename by its index
-      #
-      def file_by_id(id)
-        @files.fetch(id)
-      end
+    def all
+      files
+    end
-      # Number of files in list
-      #
-      def file_count
-        @files.size
-      end
+    private
-      private
+    attr_reader :configured_file_path, :files
-        # Iterate through files in specified dir for files
-        #
-        def find_files
-          @files = []
+    # Iterate through files in specified dir for files
+    #
+    def find_files
+      @files = []
-          Dir.foreach(@file_path) do |file|
-            next if file == '.' or file == '..'
+      Dir.foreach(configured_file_path) do |file|
+        next if file == '.' || file == '..'
-            file_path = FileList.path_for_file(@file_path, file)
-            @files << file if File.file?(file_path)
-          end
-        end
+        file_path = FileList.path_for_file(configured_file_path, file)
+        @files << file if File.file?(file_path)
+      end
     end
-end
+  end
+end

data/lib/ferver/version.rb CHANGED

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

data/lib/ferver/views/index.erb ADDED

@@ -0,0 +1,28 @@
+<!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/spec/configuration_spec.rb ADDED

@@ -0,0 +1,24 @@
+require 'spec_helper'
+describe Ferver::Configuration do
+  subject { Ferver::Configuration.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)
+      end
+    end
+    context 'when directory is set' do
+      let(:path) { '/foo/bar' }
+      it 'should return default path' do
+        subject.directory_path = path
+        expect(subject.directory_path).to eq(path)
+      end
+    end
+  end
+end

data/spec/ferver_spec.rb CHANGED

@@ -1,231 +1,183 @@
-require "spec_helper"
+require 'spec_helper'
-describe "ferver" do
-    include Webrat::Matchers # allow cool html matching
-    context "given a request to the server root" do
-        before(:each) do
-            get "/"
-        end
-        it "should return redirect" do
-            expect(last_response).to be_redirect
-        end
-        it "should redirect to file list" do
-            follow_redirect!
-            expect(last_response).to be_ok
-            expect(last_request.url).to match(/files/)
-        end
+describe 'ferver' do
+  let(:file_list) { double('file-list') }
+  context 'given a request to the server root' do
+    before do
+      get '/'
     end
-    describe "choosing directory to serve files from" do
-        before {
-            @file_list = mock()
-            @file_list.stubs(:files).returns(EMPTY_FILE_LIST)
-            @file_list.stubs(:file_count).returns(0)
-        }
-        context "when no directory is specified" do
-            it "will use default directory" do
-                Ferver::FileList.expects(:new).with("./").returns(@file_list)
-                get "/files"
-            end
+    it 'should return redirect' do
+      expect(last_response).to be_redirect
+    end
-        end
+    it 'should redirect to file list' do
+      follow_redirect!
-        context "when the directory passed via configuration" do
+      expect(last_response).to be_ok
+      expect(last_request.url).to match(/files/)
+    end
+  end
-            before { Ferver::App.set :ferver_path, "/foo" }
+  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(:size).and_return(0)
+    end
-            it "will use directory specified" do
-                Ferver::FileList.expects(:new).with("/foo").returns(@file_list)
+    context 'when no directory is specified' do
+      it 'will use default directory' do
+        expect(Ferver::FileList).to receive(:new).with('./').and_return(file_list)
-                get "/files"
-            end
+        get '/files'
+      end
+    end
+    context 'when the directory passed via configuration' do
+      before do
+        Ferver.configure do |conf|
+          conf.directory_path = '/foo'
         end
+      end
-        context "when directory does not exist" do
+      it 'will use directory specified' do
+        expect(Ferver::FileList).to receive(:new).with('/foo').and_return(file_list)
-            before(:each) { Ferver::App.set :ferver_path, "/foo" }
+        get '/files'
+      end
+    end
-            it "will attempt to create FileList with path" do
-                Ferver::FileList.expects(:new).with("/foo").raises(Ferver::DirectoryNotFoundError)
+    context 'when directory does not exist' do
+      before do
+        allow(Ferver::FileList).to receive(:new).and_raise(Ferver::DirectoryNotFoundError)
+      end
-                get "/files"
-            end
+      it 'will return server error status' do
+        get '/files'
-            it "will return server error status" do
-                Ferver::FileList.stubs(:new).with("/foo").raises(Ferver::DirectoryNotFoundError)
+        expect(last_response.status).to eql 500
+      end
+    end
+  end
-                get "/files"
+  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(:size).and_return(0)
+      allow(Ferver::FileList).to receive(:new).and_return(file_list)
+    end
-                last_response.status.should eql 500
-            end
+    context 'when no content-type is requested' do
+      before { get '/files' }
-        end
+      it 'should return valid response' do
+        expect(last_response).to be_ok
+      end
+      it 'should contain no file list in response content' do
+        expect(last_response.body).not_to have_tag('li')
+        expect(last_response.body).to have_tag('p', text: /0 files/)
+      end
     end
-    context "given an empty list of files" do
+    context 'when json content-type is requested' do
+      before do
+        get '/files', {}, 'HTTP_ACCEPT' => 'application/json'
+      end
-        before {
-            file_list = mock()
-            file_list.stubs(:files).returns(EMPTY_FILE_LIST)
-            file_list.stubs(:file_count).returns(0)
-            Ferver::FileList.stubs(:new).returns(file_list)
-        }
+      it 'should return valid response' do
+        expect(last_response).to be_ok
+        expect(last_response.content_type).to include('application/json')
+      end
-        context "when no content-type is requested" do
+      it 'should contain no file list in response content' do
+        list = JSON.parse last_response.body
+        expect(list).to eq(EMPTY_FILE_LIST)
+      end
+    end
+  end
-            before { get "/files" }
+  context 'given a list of files' do
+    before do
+      allow(file_list).to receive(:all).and_return(%w(file1 file2))
+      allow(file_list).to receive(:size).and_return(2)
+      allow(Ferver::FileList).to receive(:new).and_return(file_list)
+    end
-            it "should return valid response" do
-                expect(last_response).to be_ok
-                #todo test html
-            end
+    describe 'file list request' do
-            it "should contain no file list in response content" do
-                expect(last_response.body).to have_selector("li", :count => 0)
-                expect(last_response.body).to contain(/0 files/)
-            end
+      context 'when no content-type is requested' do
+        before { get '/files' }
+        it 'should return valid response' do
+          expect(last_response).to be_ok
         end
-        context "when json content-type is requested" do
-            before {
-                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")
-            end
-            it "should contain no file list in response content" do
-                list = JSON.parse last_response.body
-                expect(list).to eq(EMPTY_FILE_LIST)
-            end
+        it 'should contain no file list in response content' do
+          expect(last_response.body).to have_tag('li', count: 2)
+          expect(last_response.body).to have_tag('p', text: /2 files/)
         end
-    end
-    context "given a list of files" do
-        before {
-            file_list = mock()
-            file_list.stubs(:files).returns(["file1", "file2"])
-            file_list.stubs(:file_count).returns(2)
-            Ferver::FileList.stubs(:new).returns(file_list)
-        }
-        context "when no content-type is requested" do
-            before { get "/files" }
-            it "should return valid response" do
-                expect(last_response).to be_ok
-                #todo test html
-            end
-            it "should contain no file list in response content" do
-                expect(last_response.body).to have_selector("li", :count => 2)
-                expect(last_response.body).to contain(/2 files/)
-            end
-            it "should list filenames" do
-                expect(last_response.body).to have_selector("li") do |node|
-                    expect(node.first).to have_selector("a", :content => "file1")
-                    expect(node.last).to have_selector("a", :content => "file2")
-                end
-            end
+        it 'should list filenames' do
+          expect(last_response.body).to have_tag('li') do
+            with_tag('a', text: 'file1')
+            with_tag('a', text: 'file2')
+          end
         end
+      end
-        context "when json content-type is requested" do
-            before {
-                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")
-            end
-            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(["file1", "file2"])
-            end
+      context 'when json content-type is requested' do
+        before do
+          get '/files', {}, 'HTTP_ACCEPT' => 'application/json'
+        end
+        it 'should return valid response' do
+          expect(last_response).to be_ok
+          expect(last_response.content_type).to include('application/json')
         end
+        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))
+        end
+      end
     end
+    describe 'downloading a file' do
-    describe "downloading a file" do
-        before {
-            @file_list = mock()
-            @file_list.stubs(:files).returns(["file1", "file2"])
-            @file_list.stubs(:file_count).returns(2)
-            Ferver::FileList.stubs(:new).returns(@file_list)
-        }
-        context "when requesting a file out of range" do
-            before {
-                @file_list.expects(:file_id_is_valid?).with(3).returns(false)
-                get "/files/3"
-            }
-            it "should return not_found" do
-                expect(last_response).to be_not_found
-            end
+      context 'when requesting a file out of range' do
+        before do
+          allow(file_list).to receive(:file_id_is_valid?).with(3).and_return(false)
+          get '/files/3'
         end
-        context "when requesting invalid file id" do
-            before {
-                @file_list.expects(:file_id_is_valid?).never
-                get "/files/foo"
-            }
-            it "should return not_found" do
-                expect(last_response).to be_bad_request
-            end
+        it 'should return not_found' do
+          expect(last_response).to be_not_found
         end
+      end
-        context "when requesting a valid file id" do
+      context 'when requesting invalid file id' do
+        before { get '/files/foo' }
-            before { get "/files/0" }
+        it 'should return not_found' do
+          expect(last_response).to be_bad_request
+        end
+      end
-            xit "should return ok response" do
-                expect(last_response).to be_ok
-            end
+      context 'when requesting a valid file id' do
+        before { get '/files/0' }
-            xit "should return octet-stream content-type" do
-                expect(last_response.headers['Content-Type']).to eq("application/octet-stream")
-            end
+        xit 'should return ok response' do
+          expect(last_response).to be_ok
+        end
+        xit 'should return octet-stream content-type' do
+          expect(last_response.headers['Content-Type']).to eq('application/octet-stream')
         end
+      end
     end
-end
+  end
+end