ngzip 1.0.0

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/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p392@ngzip"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.18.14 (version)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/CHANGELOG

@@ -0,0 +1,3 @@
+### 1.0.0 (2013-07-14)
+
+* Initial public release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ncode gmbh
+
+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,34 @@
+# Ngzip
+
+This gem allows easy integration of nginx mod_zip into your ruby/rails application by providing
+the formatted output list and a HTTP header to use the on-thy-fly creation of ZIP archives.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ngzip'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ngzip
+
+## Usage
+
+In a controller
+
+    b = Nginx::Builder.new()
+    response.headers['X-Archive-Files'] = 'zip'
+    render :text => b.build("/data/test/Report.pdf", "/data/test/LargeArchive.tar")
+
+
+## License
+
+Copyright (c) 2013, ncode gmbh. All Rights Reserved.
+
+This project is licenced under the [MIT License](LICENSE.txt).
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.test_files = FileList['test/lib/ngzip/*_test.rb']
+  t.verbose = true
+end
+ 
+task :default => :test

data/lib/ngzip.rb

@@ -0,0 +1,8 @@
+require "ngzip/version"
+require "ngzip/builder"
+
+module Ngzip
+  def self.build
+    
+  end
+end

data/lib/ngzip/builder.rb

@@ -0,0 +1,106 @@
+require 'zlib'
+
+module Ngzip
+  
+  class Builder
+    
+    BUFFER_SIZE = 8 * 1024
+
+    # Public: Build the files manifest for mod_zip, see http://wiki.nginx.org/NginxNgxZip for the specs.
+    # 
+    # files - An Array of absolute file path elements
+    # options - The options, see below
+    # 
+    # Returns a line for each file separated by \n
+    #  
+    # The following options are available:
+    #  :crc         => Enable or disable CRC-32 checksums
+    #  :crc_cache   => Allows for provided cached CRC-32 checksums in a hash where the key is the file path
+    def build(files, options = {})
+      settings = {:crc => true}
+      settings.merge! options
+            
+      list = file_list(files)
+      prefix = detect_common_prefix(list)
+      list.map do |f|
+        sprintf("%s %d %s %s",
+                compute_crc32(f, settings),
+                File.size(f).to_i,
+                f,
+                f.gsub(prefix, '')
+        )
+      end.join("\n")      
+      
+    end
+
+    # Public: Get the special header to signal the mod_zip
+    # 
+    # Returns the header as a string "key: value"
+    def header()
+      "X-Archive-Files: zip"
+    end
+    
+    private
+    
+    # Internal: Compute a common prefix from a list of path elements
+    # 
+    # list - The list of file path elements
+    # 
+    # Returns a common prefix
+    def detect_common_prefix(list)
+      if list.size == 1
+        return File.dirname(list.first) + '/'
+      end
+      prefix = ''
+      min, max = list.sort.values_at(0, -1)
+      min.split(//).each_with_index do |c, i|
+        break if c != max[i, 1]
+        prefix << c
+      end
+      prefix
+    end
+    
+    # Internal: Compute the file list by expanding directories
+    # 
+    def file_list(files)
+      Array(files).map do |e|
+        if File.directory?(e)
+          Dir.glob("#{e}/**/*.*")
+        else
+          e
+        end
+      end.flatten
+      
+    end
+    
+    
+    # Internal: Compute the CRC-32 checksum for a file unless the settings 
+    # disable the computation (:crc => false) and this method returns "-"
+    # 
+    # file - The full path to the file
+    # settings - The settings hash
+    # 
+    # Returns a hex string
+    def compute_crc32(file, settings)
+      return '-' unless settings[:crc]
+      
+      # honor the cache
+      if settings[:crc_cache] && settings[:crc_cache][file]
+        return settings[:crc_cache][file]
+      end
+      
+      # read using a buffer, we might operate on large files!
+      crc32 = 0
+      File.open(file,'rb') do |f|
+        while buffer = f.read(BUFFER_SIZE) do
+          crc32 = Zlib.crc32(buffer, crc32) 
+        end
+      end
+      crc32.to_s(16)
+    end
+    
+    
+    
+  end
+  
+end

data/lib/ngzip/version.rb

@@ -0,0 +1,3 @@
+module Ngzip
+  VERSION = "1.0.0"
+end

data/ngzip.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ngzip/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ngzip"
+  spec.version       = Ngzip::VERSION
+  spec.authors       = ["dup2"]
+  spec.email         = ["zarkov@ncode.ch"]
+  spec.description   = %q{Provides a nginx mod_zip compatible file manifest for streaming support.
+                          See http://wiki.nginx.org/NginxNgxZip for the nginx module.}
+  spec.summary       = %q{Provides a nginx mod_zip compatible file manifest for streaming support}
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/test/data/a/ipsum.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/data/a/lorem.txt

@@ -0,0 +1 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/data/b/dolor.txt

@@ -0,0 +1,3 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/data/sit.txt

@@ -0,0 +1,5 @@
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/lib/ngzip/builder_test.rb

@@ -0,0 +1,89 @@
+require_relative "../../test_helper"
+
+describe Ngzip do
+
+  it 'must support the static method :build' do
+    Ngzip.respond_to?(:build).must_equal true
+  end  
+
+end
+
+describe Ngzip::Builder do
+  
+  let(:builder) {Ngzip::Builder.new()}
+  let(:lorem) {File.expand_path('../../../data/a/lorem.txt', __FILE__)}
+  let(:ipsum) {File.expand_path('../../../data/a/ipsum.txt', __FILE__)}
+  let(:cargo) {File.expand_path('../../../data/b/Cargo.png', __FILE__)}
+  let(:sit) {File.expand_path('../../../data/sit.txt', __FILE__)}
+  let(:a) {File.expand_path('../../../data/a', __FILE__)}
+  
+  it 'must be defined' do
+    Ngzip::Builder.wont_be_nil
+  end 
+  
+  it 'must be a class we can call :new on' do
+    Ngzip::Builder.new().wont_be_nil
+  end
+  
+  it 'must respond to :build' do
+    builder.respond_to?(:build).must_equal true
+  end
+  
+  describe "with CRC-32 checksums disabled" do
+    let(:options) { {:crc => false}}
+    
+    it 'must return a correct list for one file' do
+      expected = "- 446 #{lorem} lorem.txt"
+      builder.build(lorem, options).must_equal expected      
+    end          
+  end
+  
+  describe "with CRC-32 checksums enabled" do
+    let(:options) { {:crc => true}}
+    
+    it 'must return a correct list for one file with a checksum' do
+      expected = "8f92322f 446 #{lorem} lorem.txt"
+      builder.build(lorem, options).must_equal expected
+    end
+    
+    it 'must return a correct list for one binary file with a checksum' do
+      expected = "b2f4655b 11550 #{cargo} Cargo.png"
+      builder.build(cargo, options).must_equal expected
+    end
+    
+    it 'must return a correct list for all files in a directory' do
+      expected = "8f92322f 446 #{ipsum} ipsum.txt\n8f92322f 446 #{lorem} lorem.txt"
+      builder.build(a,options).must_equal expected
+    end
+    
+    it 'must allow to mix files and directories' do
+      expected = "8f92322f 446 #{ipsum} a/ipsum.txt"
+      expected << "\n8f92322f 446 #{lorem} a/lorem.txt"
+      expected << "\nf7c0867d 1342 #{sit} sit.txt"
+      builder.build([a,sit], options).must_equal expected      
+    end
+    
+    it 'must preserve directory names' do
+      expected = [
+        "8f92322f 446 #{lorem} a/lorem.txt",
+        "8f92322f 446 #{ipsum} a/ipsum.txt",
+        "b2f4655b 11550 #{cargo} b/Cargo.png"
+        ].join("\n")
+      builder.build([lorem,ipsum,cargo], options).must_equal expected
+    end
+    
+    it 'must honor the CRC cache' do
+      invalid_but_cached = "781aaabcc124"
+      expected = "#{invalid_but_cached} 446 #{lorem} lorem.txt"
+      builder.build(lorem, options.merge(:crc_cache => {lorem => invalid_but_cached})).must_equal expected
+    end
+    
+      
+  end
+  
+  
+  
+  
+  
+end
+

data/test/lib/ngzip/version_test.rb

@@ -0,0 +1,9 @@
+require_relative "../../test_helper"
+
+describe Ngzip do
+
+  it "must define a version" do
+    Ngzip::VERSION.wont_be_nil
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/ngzip.rb', __FILE__)
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ngzip
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- dup2
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: ! "Provides a nginx mod_zip compatible file manifest for streaming support.\n
+  \                         See http://wiki.nginx.org/NginxNgxZip for the nginx module."
+email:
+- zarkov@ncode.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ngzip.rb
+- lib/ngzip/builder.rb
+- lib/ngzip/version.rb
+- ngzip.gemspec
+- test/data/a/ipsum.txt
+- test/data/a/lorem.txt
+- test/data/b/Cargo.png
+- test/data/b/dolor.txt
+- test/data/sit.txt
+- test/lib/ngzip/builder_test.rb
+- test/lib/ngzip/version_test.rb
+- test/test_helper.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: -3265339193018102278
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3265339193018102278
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Provides a nginx mod_zip compatible file manifest for streaming support
+test_files:
+- test/data/a/ipsum.txt
+- test/data/a/lorem.txt
+- test/data/b/Cargo.png
+- test/data/b/dolor.txt
+- test/data/sit.txt
+- test/lib/ngzip/builder_test.rb
+- test/lib/ngzip/version_test.rb
+- test/test_helper.rb