ngzip 1.0.6 → 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e20636d23b8e7ba30af726b7a530f96f31eb636a
+  data.tar.gz: ed999e168b1c77b6942cb2cb6f118a5a936fe434
+SHA512:
+  metadata.gz: 70d66540ec58ff16e08321b26b998e303c765f3aaa057f58e9956cd5922c1e39869ce1c2d75b5a5db01952a91089661470fca66bc069fe0d540b15e60c9743fc
+  data.tar.gz: 769e82edd41c5029b2eef0be5dbc89fcdaaae0f5b2570902cbe3bc71b601d3145dde48b86bfebfe4839d785d4aece3a8b62fd74d7ae079cc1d5ba1d7bed882d6

data/CHANGELOG.md

@@ -1,8 +1,11 @@
+### 1.0.7 (2017-10-20)
+
+* Fixed an issue with '?' encoding
+
 ### 1.0.6 (2013-12-12)
 
 * Fixed a regression from 1.0.5 where directories were included due to the changed pattern
 
-
 ### 1.0.5 (2013-12-12)
 
 * Fixed issue #2 (files without extensions being ignored)
@@ -26,4 +29,3 @@
 ### 1.0.0 (2013-07-14)
 
 * Initial public release
-

data/LICENSE.txt

@@ -1,4 +1,5 @@
 Copyright (c) 2013 ncode gmbh
+Copyright (c) 2017 CargoServer AG
 
 MIT License
 

data/README.md

@@ -22,7 +22,7 @@ Or install it yourself as:
 In a controller
 
 ```ruby
-b = Nginx::Builder.new()
+b = Ngzip::Builder.new()
 response.headers['X-Archive-Files'] = 'zip'
 render :text => b.build(["/data/test/Report.pdf", "/data/test/LargeArchive.tar"])
 ```
@@ -67,6 +67,6 @@ fetch the actual file data and would support any location type (even proxied).
 ## License
 
 Copyright (c) 2013, ncode gmbh. All Rights Reserved.
+Copyright (c) 2017, CargoServer AG. All Rights Reserved.
 
 This project is licenced under the [MIT License](LICENSE.txt).
-

data/lib/ngzip/builder.rb

@@ -2,18 +2,16 @@ require 'zlib'
 require 'uri'
 
 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
@@ -21,7 +19,7 @@ module Ngzip
     def build(files, options = {})
       settings = {:crc => true}
       settings.merge! options
-            
+
       list = file_list(files)
       prefix = options[:base_dir] || detect_common_prefix(list)
       prefix += '/' unless prefix.end_with?('/')
@@ -36,26 +34,25 @@ module Ngzip
     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
-    
-    
-    # Public: Encode the string 
+
+    # Public: Encode the string
     #
     # Returns the encoded string using URL escape formatting
     def self.encode(string)
-      URI.encode(string).sub('+', "%2B")
+      URI.encode(string).gsub('+', '%2B').gsub('?', '%3F')
     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
@@ -69,9 +66,9 @@ module Ngzip
       end
       prefix
     end
-    
+
     # Internal: Compute the file list by expanding directories
-    # 
+    #
     def file_list(files)
       Array(files).map do |e|
         if File.directory?(e)
@@ -81,33 +78,30 @@ module Ngzip
         end
       end.flatten
     end
-    
-    
-    # Internal: Compute the CRC-32 checksum for a file unless the settings 
+
+    # 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) 
+          crc32 = Zlib.crc32(buffer, crc32)
         end
       end
       crc32.to_s(16)
     end
-    
   end
-  
-end
+end

data/lib/ngzip/version.rb

@@ -1,3 +1,3 @@
 module Ngzip
-  VERSION = "1.0.6"
+  VERSION = '1.0.7'.freeze
 end

data/ngzip.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "ngzip"
   spec.version       = Ngzip::VERSION
   spec.authors       = ["dup2"]
-  spec.email         = ["zarkov@ncode.ch"]
+  spec.email         = ["zarkov@cargoserver.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}

data/test/data/c/questions?/test.txt

@@ -0,0 +1 @@
+Tyrell Corp.

data/test/lib/ngzip/builder_test.rb

@@ -1,16 +1,17 @@
 require_relative "../../test_helper"
 require 'uri'
+require 'pathname'
 
 describe Ngzip do
 
   it 'must support the static method :build' do
     Ngzip.respond_to?(:build).must_equal true
-  end  
+  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__)}
@@ -21,46 +22,47 @@ describe Ngzip::Builder do
   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__)}
-  
+  let(:questions) { File.expand_path('../../../data/c/questions?', __FILE__) }
+
   it 'must be defined' do
     Ngzip::Builder.wont_be_nil
-  end 
-  
+  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          
+      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 escape the path name' do
       expected = "8f92322f 446 #{URI.escape(whitespaced)} A filename with whitespace.txt"
       builder.build(whitespaced, options).must_equal expected
     end
-    
+
     it 'must return a correct list for all files in a directory' do
       expected = "8f92322f 446 #{URI.escape(whitespaced)} A filename with whitespace.txt"
       expected << "\n8f92322f 446 #{my_file} d/my_file.txt"
@@ -69,7 +71,7 @@ describe Ngzip::Builder do
       expected << "\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 #{URI.escape(whitespaced)} a/A filename with whitespace.txt"
       expected << "\n8f92322f 446 #{my_file} a/d/my_file.txt"
@@ -77,9 +79,9 @@ describe Ngzip::Builder do
       expected << "\n8f92322f 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      
+      builder.build([a,sit], options).must_equal expected
     end
-    
+
     it 'must preserve directory names' do
       expected = [
         "8f92322f 446 #{lorem} a/lorem.txt",
@@ -88,41 +90,45 @@ describe Ngzip::Builder do
         ].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
-    
+
     it 'must remove common directories by default' do
       pathes = builder.build([lorem, ipsum]).split("\n").map{|line| line.split.last}
       expected = ["lorem.txt", "ipsum.txt"]
       pathes.must_equal expected
     end
-    
+
     it 'must keep common directories if :base_dir is provided' do
       options = {:base_dir => Pathname.new(lorem).parent.parent.to_s}
       pathes = builder.build([lorem, ipsum], options).split("\n").map{|line| line.split.last}
       expected = ["a/lorem.txt", "a/ipsum.txt"]
       pathes.must_equal expected
     end
-    
+
     it 'must cope with a trailing / in the :base_dir' do
       options = {:base_dir => Pathname.new(lorem).parent.parent.to_s + '/'}
       pathes = builder.build([lorem, ipsum], options).split("\n").map{|line| line.split.last}
       expected = ["a/lorem.txt", "a/ipsum.txt"]
-      pathes.must_equal expected      
+      pathes.must_equal expected
     end
-    
+
     it 'must correctly encode filenames with a "+"' do
       options = {}
-      name = File.join(Pathname.new(plused).parent.to_s, 'A%20filename%20with%20space%20and%20%2B%20in%20it.txt') 
+      name = File.join(Pathname.new(plused).parent.to_s, 'A%20filename%20with%20space%20and%20%2B%20in%20it.txt')
       expected = "8f92322f 446 #{name} A filename with space and + in it.txt"
       builder.build([plused], options).must_equal expected
     end
-    
-    
+
+    it 'must correctly encode the "?" character' do
+      name = File.join(Pathname.new(questions).parent.to_s, 'questions%3F/test.txt')
+      expected = "f03102f5 13 #{name} test.txt"
+
+      builder.build([File.join(questions, 'test.txt')]).must_equal expected
+    end
   end
-  
 end

metadata

@@ -1,58 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: ngzip
 version: !ruby/object:Gem::Version
-  version: 1.0.6
-  prerelease: 
+  version: 1.0.7
 platform: ruby
 authors:
 - dup2
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2017-10-20 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."
+description: |-
+  Provides a nginx mod_zip compatible file manifest for streaming support.
+                            See http://wiki.nginx.org/NginxNgxZip for the nginx module.
 email:
-- zarkov@ncode.ch
+- zarkov@cargoserver.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -70,6 +65,7 @@ files:
 - test/data/b/Cargo.png
 - test/data/b/dolor.txt
 - test/data/c/A filename with space and + in it.txt
+- test/data/c/questions?/test.txt
 - test/data/sit.txt
 - test/lib/ngzip/builder_test.rb
 - test/lib/ngzip/version_test.rb
@@ -77,33 +73,26 @@ files:
 homepage: https://github.com/cargoserver/ngzip
 licenses:
 - MIT
+metadata: {}
 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: 4602707169932349817
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 4602707169932349817
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.6.13
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Provides a nginx mod_zip compatible file manifest for streaming support
 test_files:
 - test/data/a/A filename with whitespace.txt
@@ -114,6 +103,7 @@ test_files:
 - test/data/b/Cargo.png
 - test/data/b/dolor.txt
 - test/data/c/A filename with space and + in it.txt
+- test/data/c/questions?/test.txt
 - test/data/sit.txt
 - test/lib/ngzip/builder_test.rb
 - test/lib/ngzip/version_test.rb

data/.rvmrc

@@ -1,48 +0,0 @@
-#!/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