rack-archive-zip-extract 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d1d1fdef39fc5a5b020441ab5e3016d4ceb278e
+  data.tar.gz: 9c122a1f1cd9c251625211a264e49ec4779fddc7
+SHA512:
+  metadata.gz: 281a9e3aabf364311f5600e8857e579fcd2ddcccbdbb622b9bf2ccb16564bf12ec01c057660e11e5d3bb83bbd126eeda9d1892ee0218db272ddf9598dde5b5e0
+  data.tar.gz: 57c7a6d86e25a58b13b23d3d6e16c1241f2094a23de109357443a7014d140934ba2e3d967bebd2abaa06e7313f443976900acd1ea9b32c5a0ff899a08513f75b

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

@@ -0,0 +1,98 @@
+require 'pathname'
+require 'rack/utils'
+require 'rack/file'
+require 'rack/mime'
+require 'zipruby'
+
+# {Rack::Archive::Zip::Extract Rack::Archive::Zip::Extract} is a Rack application which serves files in zip archives.
+# @example
+#   run Rack::Archive::Zip::Extract.new('path/to/docroot')
+# @example
+#   run Rack::Archive::Zip::Extract.new('path/to/docroot', extensions: %w[.epub .zip .jar .odt .docx])
+# @note
+#   {Rack::Archive::Zip::Extract Rack::Archive::Zip::Extract} does not serve a zip file itself. Use Rack::File or so to do so.
+module Rack::Archive
+  module Zip
+    class Extract
+      SEPS = Rack::File::SEPS
+      ALLOWED_VERBS = Rack::File::ALLOWED_VERBS
+
+      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])
+        @root = root.kind_of?(Pathname) ? root : Pathname(root)
+        @root = @root.expand_path
+        @extensions = extensions
+        raise ArgumentError, "Not a directory: #{@root}" unless @root.directory?
+      end
+
+      def call(env)
+        return [405, {'Allow' => ALLOWED_VERBS.join(', ')}, []] unless ALLOWED_VERBS.include? env['REQUEST_METHOD']
+
+        path_info = Rack::Utils.unescape(env['PATH_INFO'])
+        zip_file = nil
+        body = nil
+        @extensions.each do |ext|
+          zip_file, inner_path = find_zip_file_and_inner_path(path_info, ext)
+          body = extract_content(zip_file, inner_path)
+          break if body
+        end
+        return [404, {}, []] if body.nil?
+
+        [
+          200,
+          {
+            'Content-Type' => Rack::Mime.mime_type(::File.extname(path_info)),
+            'Content-Length' => body.bytesize.to_s,
+            'Last-Modified' => zip_file.mtime.httpdate
+          },
+          [body]
+        ]
+      end
+
+      # @param path_info [String]
+      # @param extension [String]
+      # @return [Array] a pair of Pathname(zip file) and String(file path in zip archive)
+      def find_zip_file_and_inner_path(path_info, extension)
+        path_parts = path_info_to_clean_parts(path_info)
+        current = @root
+        zip_file = nil
+        while part = path_parts.shift
+          zip_file = current + "#{part}#{extension}"
+          return zip_file, ::File.join(path_parts) if zip_file.file?
+          current += part
+        end
+      end
+
+      # @param zip_file_path [Pathname] path to zip file
+      # @param inner_path [String] path to file in zip archive
+      # @return [String] content
+      # @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)
+        return if zip_file_path.nil? or inner_path.empty?
+        ::Zip::Archive.open zip_file_path.to_path do |archive|
+          return if archive.locate_name(inner_path) < 0
+          archive.fopen inner_path do |file|
+            return file.read
+          end
+        end
+      end
+
+      # @param path_info [String]
+      # @return [Array<String>] parts of clean path
+      def path_info_to_clean_parts(path_info)
+        parts = path_info.split SEPS
+        clean = []
+        parts.each do |part|
+          next if part.empty? || part == '.'
+          part == '..' ? clean.pop : clean << part
+        end
+        clean
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: rack-archive-zip-extract
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- KITAITI Makoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: zipruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: test-unit-notify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Rack::Archive::Zip::Extract serves files in zip archives.
+email: KitaitiMakoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack/archive/zip/extract.rb
+homepage: https://github.com/KitaitiMakoto/rack-archive-zip-extract
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Zip file server
+test_files: []