rack-archive-zip-extract 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72114a73a80de1f5a42ba4439d0de4d8bd490be9
-  data.tar.gz: 1b0f2ca04e99752201464ac5f7e5e113df7c441d
+  metadata.gz: 8f335e345e79786674c599d49801cfab192613ec
+  data.tar.gz: 05268821dfdf5582e97e7580accbcf2cbe9a187b
 SHA512:
-  metadata.gz: 7256c9a7a0cc5fde2f603e04ad495a46ad20af2858afa32707e7afd1576a7faf9dd1ec4c6050869d87827535e0484ee2bbeb4cd5ab79fe77c9d60f1dbb28b503
-  data.tar.gz: c49eebd140a6258aad2987ed476af758dbd634515fb7f823c2bee7999eb0faab722625f1554b1bffd84ec48e8fd0f2d61cc81df6ec700c1de1dd9fee6e5bc62a
+  metadata.gz: 0d32ed10d8c653fbc13463163c94198af348cfdfcd43b9e916cf92762def4eafe2419a47e40e1a2a618ffcfdd41d9f078be5a98202d649e3b3ce3a56511e7f96
+  data.tar.gz: 61a4b7dc23f899ce983976f0d334b8bca21459813a6aab5e43e3b69c7cf41789aefa9bda5f139640b7c455aa48174c7e343b05eb54d0ee016195dc7f99c75ae0

data/CHANGELOG.markdown

@@ -0,0 +1,25 @@
+CHANGELOG
+=========
+
+0.0.4
+-----
+
+* Change method name `extract_content` -> `extract_file`
+* [BUG FIX]Close body when content not modified
+* Make buffer size for reading file in zip archive configuable
+
+0.0.3
+-----
+
+* Chunk content body and use buffer rather than read body at a time
+
+0.0.2
+-----
+
+* Use mtime of file in archive for Last-Modified header
+* Don't read file body from zip archive when file is older than If-Modified-Since header
+
+0.0.1
+-----
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013, 2014 KITAITIMAKOTO <KitaitiMakoto@gmail.com>
+
+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.markdown

@@ -0,0 +1,61 @@
+Rack::Archive::Zip::Extract
+===========================
+
+Rack::Archive::Zip::Extract is a Rack application which serves files in ZIP archives.
+
+Installation
+------------
+
+    $ gem install rack-archive-zip-extract
+
+Or add this line to your application's Gemfile:
+
+    $ gem 'rack-archive-zip-extract', :require => 'rack/archive/zip/extract'
+
+And then execute:
+
+    $ bundle install
+
+Usage
+-----
+
+Write below in your config.ru:
+
+    require 'rack/archive/zip/extract'
+    
+    run Rack::Archive::Zip::Extract.new('path/to/docroot')
+
+`'path/to/docroot'` above should have some ZIP files like this:
+
+    $ tree path/to/docroot
+    some.zip
+    another.zip
+    andmore.zip
+
+Then, run server:
+
+    $ rackup
+
+Now you can see files in zip archives. For example, visit http://localhost:9292/some/inner-file.txt and then you can see the text in "inner-file.txt" file in "some.zip" archive file.
+
+*Note that Rack::Archive::Zip::Extract doesn't serve ZIP file itself.*
+
+### File extensions
+
+By default, files with extension ".zip" is recognized as ZIP files.
+You can tell the app extensions by option argument:
+
+    run Rack::Archive::Zip::Extract.new('path/to/docroot', extensions: ['.epub', '.zip'])
+
+### Buffer size
+
+Buffer size for reading file in zip archive is set to {Rack::Archive::Zip::Extract::ExtractedFile::BUFFER_SIZE 8192} bytes by default.
+
+You can change it by passing `buffer_size` named argument when initailizig the app:
+
+    run Rack::Archive::Zip::Extract.new('path/to/docroot', buffer_size: 1024 * 1024)
+
+License
+-------
+
+This program is distribuetd under the term of the MIT License. See MIT-LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/clean'
+require 'rake/testtask'
+require 'rubygems/tasks'
+
+task :default => :test
+
+Rake::TestTask.new do |test|
+  test.options = '--no-show-detail-immediately --verbose'
+end
+
+namespace :test do
+  desc 'Build test fixtures'
+  task :build do
+    sh 'cd test/fixtures/sample-zip && zip -r ../../sample.zip .'
+    sh 'cd test/fixtures/sample-ext && zip -r ../../sample.ext .'
+  end
+end
+
+task :test => [:clean, 'test:build']
+
+Gem::Tasks.new
+Gem::Tasks::Sign::Checksum.new

data/lib/rack/archive/zip/extract.rb

@@ -19,8 +19,7 @@ module Rack::Archive
       SEPS = Rack::File::SEPS
       DOT = '.'.freeze
       DOUBLE_DOT = '..'.freeze
-      COMMA = ','.freeze
-      ALLOWED_VERBS = Rack::File::ALLOWED_VERBS
+      ALLOWED_METHODS = Rack::File::ALLOWED_VERBS.join(', ').freeze
       ALLOW = 'Allow'.freeze
       CONTENT_TYPE = 'Content-Type'.freeze
       CONTENT_LENGTH = 'Content-Length'.freeze
@@ -29,33 +28,31 @@ module Rack::Archive
       REQUEST_METHOD = 'REQUEST_METHOD'.freeze
       PATH_INFO = 'PATH_INFO'.freeze
 
-      attr_reader :root
-
       # @param root [Pathname, #to_path, String] path to document root
       # @param extensions [Array<String>] extensions which is recognized as a zip file
       # @raise [ArgumentError] if +root+ is not a directory
-      def initialize(root, extensions: %w[.zip])
+      def initialize(root, extensions: %w[.zip], buffer_size: ExtractedFile::BUFFER_SIZE)
         @root = root.kind_of?(Pathname) ? root : Pathname(root)
         @root = @root.expand_path
-        @extensions = extensions
+        @extensions = extensions.each {|extention| extention.freeze}.lazy
+        @buffer_size = buffer_size
         raise ArgumentError, "Not a directory: #{@root}" unless @root.directory?
       end
 
       def call(env)
-        return [status_code(:method_not_allowd), {ALLOW => ALLOWED_VERBS.join(COMMA)}, []] unless ALLOWED_VERBS.include? env[REQUEST_METHOD]
+        return [status_code(:method_not_allowd), {ALLOW => ALLOWED_METHODS}, []] unless Rack::File::ALLOWED_VERBS.include? env[REQUEST_METHOD]
 
         path_info = unescape(env[PATH_INFO])
-        file = nil
-        @extensions.each do |ext|
+        file = @extensions.map {|ext|
           zip_file, inner_path = find_zip_file_and_inner_path(path_info, ext)
-          file = extract_content(zip_file, inner_path)
-          break if file
-        end
+          extract_file(zip_file, inner_path)
+        }.select {|file| file}.first
         return [status_code(:not_found), {}, []] if file.nil?
 
         if_modified_since = env[IF_MODIFIED_SINCE]
         if_modified_since = Time.parse(if_modified_since) if if_modified_since
         if if_modified_since and file.mtime <= if_modified_since
+          file.close
           [status_code(:not_modified), {}, []]
         else
           [
@@ -89,14 +86,14 @@ module Rack::Archive
       # @return [Zip::File]
       # @return [nil] if +zip_file_path+ is nil or +inner_path+ is empty
       # @return [nil] if +inner_path+ doesn't exist in zip archive
-      def extract_content(zip_file_path, inner_path)
+      def extract_file(zip_file_path, inner_path)
         return if zip_file_path.nil? or inner_path.empty?
         archive = ::Zip::Archive.open(zip_file_path.to_path)
         if archive.locate_name(inner_path) < 0
           archive.close
           nil
         else
-          ExtractedFile.new(archive, archive.fopen(inner_path))
+          ExtractedFile.new(archive, inner_path, @buffer_size)
         end
       end
 
@@ -114,14 +111,20 @@ module Rack::Archive
       end
 
       class ExtractedFile
+        BUFFER_SIZE = 8192
+
         # @param archive [Zip::Archive]
-        # @param file [Zip::File]
-        def initialize(archive, file)
-          @archive, @file = archive, file
+        # @param path [String]
+        # @raise ArgumentError when +archive+ already closed
+        def initialize(archive, path, buffer_size=BUFFER_SIZE)
+          raise ArgumentError, 'archive already closed' unless archive.open?
+          @archive = archive
+          @file = @archive.fopen(path)
+          @buffer_size = buffer_size
         end
 
         def each
-          @file.read do |chunk|
+          while chunk = @file.read(@buffer_size)
             yield chunk
           end
         end

data/test/fixtures/sample-ext/sample.txt

@@ -0,0 +1 @@
+This is a plain text file in sample.ext.

data/test/fixtures/sample-zip/sample.html

@@ -0,0 +1,3 @@
+<!DOCTYPE html>
+<title>HTML</title>
+<p>This is a HTML file.</p>

data/test/fixtures/sample-zip/sample.txt

@@ -0,0 +1 @@
+This is a plain text file.

data/test/fixtures/sample-zip/sample.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0">
+<root><content>This is an XML file.</content></root>

data/test/fixtures/sample-zip/subdir/sample.txt

@@ -0,0 +1 @@
+This is a plain text file in subdirectory.

data/test/test_rack-archive-zip-extract.rb

@@ -0,0 +1,126 @@
+require 'test/unit'
+require 'test/unit/notify'
+require 'rack/lint'
+require 'rack/mock'
+require 'rack/archive/zip/extract'
+
+class TestRackArchiveZipExtract < Test::Unit::TestCase
+  def setup
+    @zip = Rack::Archive::Zip::Extract.new(__dir__)
+  end
+
+  def request(path, app=@zip, opts={})
+    Rack::MockRequest.new(app).get(path, opts)
+  end
+
+  def test_request_to_file_in_zip_returns_content
+    response = request('/sample/sample.txt')
+
+    assert_equal "This is a plain text file.\n", response.body
+  end
+
+  def test_request_to_file_in_zip_returns_last_modified
+    response = request('/sample/sample.txt')
+    expected = File.mtime(File.join(__dir__, 'fixtures', 'sample-zip', 'sample.txt'))
+    actual = Time.parse(response['Last-Modified'])
+
+    assert_in_delta expected, actual, 2
+  end
+
+  def test_request_to_old_file_returns_not_modified
+    mtime = File.mtime(File.join(__dir__, 'fixtures', 'sample-zip', 'sample.txt'))
+    if_modified_since = mtime + 12
+    response = request('/sample/sample.txt', @zip, {'HTTP_IF_MODIFIED_SINCE' => if_modified_since.httpdate})
+
+    assert_equal 304, response.status
+  end
+
+  def test_request_to_old_file_returns_no_content
+    mtime = File.mtime(File.join(__dir__, 'fixtures', 'sample-zip', 'sample.txt'))
+    if_modified_since = mtime + 12
+    response = request('/sample/sample.txt', @zip, {'HTTP_IF_MODIFIED_SINCE' => if_modified_since.httpdate})
+
+    assert_empty response.body
+  end
+
+  class TestStatusCode < self
+    data(
+      'file in zip'              => [200, '/sample/sample.txt'],
+      'zip file itself'          => [404, '/sample.zip'],
+      'non-existent file in zip' => [404, '/sample/non-existent'],
+      'file in subdirectory'     => [200, '/sample/subdir/sample.txt']
+    )
+
+    def test_status_code(data)
+      status_code, path_info = data
+
+      assert_equal status_code, request(path_info).status
+    end
+  end
+
+  class TestContentType < self
+    data(
+      'text/plain'        => %w[.txt  text/plain],
+      'text/html'         => %w[.html text/html],
+      'application/xml'   => %w[.xml  application/xml],
+      'unknown extension' => %w[.unknownextension application/octet-stream],
+      'no extension'      =>   ['', 'application/octet-stream'],
+    )
+    def test_content_type(data)
+      extension, content_type = data
+      response = request("/sample/sample#{extension}")
+
+      assert_equal content_type, response['Content-Type']
+    end
+  end
+
+  def test_extension_of_file_can_be_changed
+    ext = Rack::Archive::Zip::Extract.new(__dir__, extensions: %w[.ext])
+    response = request('/sample/sample.txt', ext)
+
+    assert_equal 200, response.status
+    assert_equal "This is a plain text file in sample.ext.\n", response.body
+  end
+
+  class TestMultipleExtensions < self
+    def setup
+      super
+      @multi = Rack::Archive::Zip::Extract.new(__dir__, extensions: %w[.ext .zip])
+    end
+
+    def test_multiple_extensions_for_zip_file_can_be_specified
+      response = request('/sample/sample.txt', @multi)
+
+      assert_equal 200, response.status
+      assert_equal "This is a plain text file in sample.ext.\n", response.body
+    end
+
+    def test_fallback_to_next_extension_when_file_not_exit_in_zip_archive
+      response = request('/sample/sample.html', @multi)
+
+      assert_equal 200, response.status
+    end
+  end
+
+  class TestExtractedFile < self
+    def setup
+      @zip_path = 'test/sample.zip'
+      @inner_path = 'sample.txt'
+      @file = Rack::Archive::Zip::Extract::ExtractedFile.new(Zip::Archive.open(@zip_path), @inner_path)
+    end
+
+    # If body of Rack application responds to method `to_path`,
+    # it is used to specify file path on file system when
+    # Rack::Senfile or so is stacked on Rack builder.
+    def test_not_respond_to_to_path
+      assert_false @file.respond_to? :to_path
+    end
+
+    def test_cannot_initialize_with_closed_archive
+      archive = Zip::Archive.open(@zip_path)
+      archive.close
+      assert_raise ArgumentError do Rack::Archive::Zip::Extract::ExtractedFile.new archive, @inner_path
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-archive-zip-extract
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - KITAITI Makoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-06 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -98,9 +98,22 @@ description: Rack::Archive::Zip::Extract serves files in zip archives.
 email: KitaitiMakoto@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.markdown
+- MIT-LICENSE
+- CHANGELOG.markdown
 files:
+- CHANGELOG.markdown
+- MIT-LICENSE
+- README.markdown
+- Rakefile
 - lib/rack/archive/zip/extract.rb
+- test/fixtures/sample-ext/sample.txt
+- test/fixtures/sample-zip/sample.html
+- test/fixtures/sample-zip/sample.txt
+- test/fixtures/sample-zip/sample.xml
+- test/fixtures/sample-zip/subdir/sample.txt
+- test/test_rack-archive-zip-extract.rb
 homepage: https://github.com/KitaitiMakoto/rack-archive-zip-extract
 licenses:
 - MIT
@@ -125,4 +138,10 @@ rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Zip file server
-test_files: []
+test_files:
+- test/test_rack-archive-zip-extract.rb
+- test/fixtures/sample-ext/sample.txt
+- test/fixtures/sample-zip/sample.html
+- test/fixtures/sample-zip/sample.txt
+- test/fixtures/sample-zip/sample.xml
+- test/fixtures/sample-zip/subdir/sample.txt