rack-tail_file 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-tail_file.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Beth
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Rack::TailFile
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-tail_file'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-tail_file
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/rack/tail_file/version.rb

@@ -0,0 +1,7 @@
+module Rack
+
+  class TailFile
+    VERSION = "0.0.1"
+  end
+
+end

data/lib/rack/tail_file.rb

@@ -0,0 +1,178 @@
+require "rack/tail_file/version"
+
+require 'elif'
+require 'time'
+require 'rack/utils'
+require 'rack/mime'
+
+module Rack
+  # Rack::File serves files below the +root+ directory given, according to the
+  # path info of the Rack request.
+  # e.g. when Rack::File.new("/etc") is used, you can access 'passwd' file
+  # as http://localhost:9292/passwd
+  #
+  # Handlers can detect if bodies are a Rack::File, and use mechanisms
+  # like sendfile on the +path+.
+
+  class TailFile
+
+    SEPS = Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact)
+    ALLOWED_VERBS = %w[GET HEAD]
+
+    attr_accessor :root
+    attr_accessor :path
+    attr_accessor :cache_control
+
+    alias :to_path :path
+
+    def initialize(root, headers={}, default_mime = 'text/plain')
+      @root = root
+      @headers = headers
+      @default_mime = default_mime
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    F = ::File
+
+    def _call(env)
+      return fail(405, "Method Not Allowed") unless method_allowed?(env)
+      return fail(403, "Forbidden") unless path_is_within_root?(env)
+
+      @path = file_path(env)
+
+      if available?
+        serving(env)
+      else
+        fail(404, "File not found: #{path_info_for(env)}")
+      end
+    end
+
+    def method_allowed? env
+      ALLOWED_VERBS.include? env["REQUEST_METHOD"]
+    end
+
+    def available?
+      begin
+        F.file?(@path) && F.readable?(@path)
+      rescue SystemCallError
+        false
+      end
+    end
+
+    def path_info_for env
+      Utils.unescape(env["PATH_INFO"])
+    end
+
+    def path_is_within_root? env
+      root = root env
+      target = target_file env
+      !target.relative_path_from(root).to_s.split(SEPS).any?{|p| p == ".."}
+    end
+
+    def target_file env
+      path_info = Pathname.new("").join(*path_info_for(env).split(SEPS))
+      root = root env
+      root.join(path_info)
+    end
+
+    def root env
+      Pathname.new(@root)
+    end
+
+    def file_path(env)
+      target_file env
+    end
+
+    def serving(env)
+      last_modified = F.mtime(@path).httpdate
+      return [304, {}, []] if env['HTTP_IF_MODIFIED_SINCE'] == last_modified
+
+      headers = { "Last-Modified" => last_modified }
+      mime = Mime.mime_type(F.extname(@path), @default_mime)
+      headers["Content-Type"] = mime if mime
+
+      # Set custom headers
+      @headers.each { |field, content| headers[field] = content } if @headers
+
+      response = [ 200, headers, env["REQUEST_METHOD"] == "HEAD" ? [] : self ]
+      response[1]["Content-Length"] = requested_size(env, response).to_s
+      response
+    end
+
+    def requested_lines_size(env)
+      (env.fetch("QUERY_STRING")[/\d+/] || 50).to_i
+    end
+
+    def tail_size_for line_count
+      elif = Elif.new(@path)
+      tail_size = 0
+      line_count.times do
+        begin
+          tail_size += Rack::Utils.bytesize(elif.readline)
+        rescue EOFError
+          return tail_size
+        end
+      end
+      tail_size - 1 # Don't include the first \n
+    end
+
+
+    def requested_size(env, response)
+      # NOTE:
+      #   We check via File::size? whether this file provides size info
+      #   via stat (e.g. /proc files often don't), otherwise we have to
+      #   figure it out by reading the whole file into memory.
+      size = F.size?(@path) || Utils.bytesize(F.read(@path))
+
+      #TODO handle invalid lines
+      tail_size = tail_size_for requested_lines_size(env)
+
+      if tail_size == size
+        response[0] = 200
+        @range = 0..size-1
+      else
+        start_byte = size - tail_size - 1
+        @range = start_byte..size-1
+        response[0] = 206
+        response[1]["Content-Range"] = "bytes #{@range.begin}-#{@range.end}/#{size}"
+        size = @range.end - @range.begin + 1
+      end
+
+      size
+    end
+
+    def each
+      F.open(@path, "rb") do |file|
+        file.seek(@range.begin)
+        remaining_len = @range.end-@range.begin+1
+        while remaining_len > 0
+          part = file.read([8192, remaining_len].min)
+          break unless part
+          remaining_len -= part.length
+
+          yield part
+        end
+      end
+    end
+
+    private
+
+    def fail(status, body)
+      body += "\n"
+      [
+        status,
+        {
+          "Content-Type" => "text/plain",
+          "Content-Length" => body.size.to_s,
+          "X-Cascade" => "pass"
+        },
+        [body]
+      ]
+    end
+
+  end
+end
+

data/rack-tail_file.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/tail_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-tail_file"
+  spec.version       = Rack::TailFile::VERSION
+  spec.authors       = ["Beth"]
+  spec.email         = ["beth@bethesque.com"]
+  spec.description   = %q{Like Rack::File, but it serves the last lines of a file}
+  spec.summary       = %q{A rack app that serves the last lines of a file}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "elif"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "pry"
+end

data/spec/fixtures/test.txt

@@ -0,0 +1,5 @@
+1
+2
+3
+4
+5

data/spec/lib/rack/tail_file_spec.rb

@@ -0,0 +1,146 @@
+require 'rack/tail_file'
+require 'rack/test'
+describe Rack::TailFile do
+
+  include Rack::Test::Methods
+
+  def app
+    Rack::TailFile.new root
+  end
+
+  let(:root) { './spec/fixtures' }
+  let(:file_path) { root + file_name }
+  let(:file_name) { "/test.txt" }
+  let(:file_contents) { File.read(file_path )}
+
+  describe "GET" do
+
+    context "when the number of lines required is not specified" do
+
+      subject { get file_name }
+
+      it "returns the entire file" do
+        subject
+        expect(last_response.body).to eq(file_contents)
+      end
+
+      it "sets a status of 200" do
+        subject
+        expect(last_response.status).to eq 200
+      end
+    end
+
+    context "when a number of lines is specified" do
+      let(:file_contents) { File.readlines(file_path).last(2).join }
+
+      subject { get file_name, "lines" => "2" }
+
+      it "returns the last lines" do
+        subject
+        expect(last_response.body).to eq(file_contents)
+      end
+
+      it "sets a status of 206" do
+        subject
+        expect(last_response.status).to eq 206
+      end
+    end
+
+    context "when a number of lines is specified that is more than the number of lines in the file" do
+
+      subject { get file_name, "lines" => "50" }
+      let(:file_contents) { File.read(file_path )}
+
+      it "returns the entire file" do
+        subject
+        expect(last_response.body).to eq(file_contents)
+      end
+
+      it "sets a status of 200" do
+        subject
+        expect(last_response.status).to eq 200
+      end
+    end
+
+    context "when the file does not exist" do
+      subject { get "something.txt" }
+
+      it "sets a status of 404" do
+        subject
+        expect(last_response.status).to eq 404
+      end
+    end
+
+    context "when the file requested is outside the root" do
+      subject { get "../lib/rack/tail_file_spec.rb" }
+
+      it "returns a 403 Forbidden" do
+        subject
+        expect(last_response.status).to eq 403
+      end
+
+      it "does not return the file" do
+        subject
+        expect(last_response.body).to_not eq(file_contents)
+      end
+    end
+
+    context "when the file requested has a path with .. that resolves to a file within the root" do
+
+      subject { get "../fixtures/blah/..#{file_name}" }
+
+      it "returns a 200 Success" do
+        subject
+        expect(last_response.status).to eq 200
+      end
+    end
+  end
+
+  describe "HEAD" do
+
+    subject { head file_name }
+
+    context "when the number of lines required is not specified" do
+      let(:file_contents) { File.read(file_path )}
+
+      it "returns an empty body" do
+        subject
+        expect(last_response.body.size).to eq 0
+      end
+
+      it "sets a status of 200" do
+        subject
+        expect(last_response.status).to eq 200
+      end
+    end
+
+    context "when a number of lines is specified" do
+      let(:file_contents) { File.readlines(file_path).last(2).join }
+
+      subject { head file_name, "lines" => "2" }
+
+      it "returns an empty body" do
+        subject
+        expect(last_response.body.size).to eq 0
+      end
+
+      xit "sets a status of 206" do
+        subject
+        expect(last_response.status).to eq 206
+      end
+    end
+
+  end
+
+  %w{PUT POST DELETE PATCH}.each do | http_method |
+
+    describe http_method do
+      it "returns a 405 Method Not Allowed response" do
+        self.send(http_method.downcase.to_sym, "something")
+        expect(last_response.status).to eq 405
+      end
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: rack-tail_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Beth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elif
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Like Rack::File, but it serves the last lines of a file
+email:
+- beth@bethesque.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack/tail_file.rb
+- lib/rack/tail_file/version.rb
+- rack-tail_file.gemspec
+- spec/fixtures/test.txt
+- spec/lib/rack/tail_file_spec.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2187452435069552088
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2187452435069552088
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A rack app that serves the last lines of a file
+test_files:
+- spec/fixtures/test.txt
+- spec/lib/rack/tail_file_spec.rb