http_zip 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5c21ac606a405c8527ce48a94f760ecd195104a4ac84a25c84bbb095a748c21
-  data.tar.gz: 3b9c5d83fcbbbf09b858411fe10f56fc582738914bfbd5b54626571705eff72c
+  metadata.gz: e045495a2ce12199f65be5bf20671418ad350c81ae91fa59c574229ed20eaa22
+  data.tar.gz: fed79c7c440c3323204e105ba449c92bb26d8a1a8b47b258ef1215865a30d7c2
 SHA512:
-  metadata.gz: 6770e900fbf8a657716f0426e394646ba1bcd796cce64317c9d34996bd792847d1cd147ac0c7a49a64641787519a15c4d2abcc8933f01379e75f9607359049c2
-  data.tar.gz: 1d85ea79fd3e03302e242c4fce86a4fdf45ead85e663f3a5b4b91cf5cb735081a5d50aecd2e7931de6ef7b1064dcc6d174c2b25222689cee24ba7d26cbe8c2e9
+  metadata.gz: 39861993eeb2e36bbbb0e96cf620afcc94935dc11160a676ec9c65657cfca840ab98d0c57ab51fd8272ca10ac1d46c37be6f6d866598410bd13012cba3c0e262
+  data.tar.gz: 348b335d82a78a8b37c075981370996723b977ce3ce68c18db72a1e68f64c6ec100ac922ff7303bbafd885fc6360e7d676a980407e65048d51415bcedd26f6d2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# 2.0.0
+* Drop dependency on HTTParty
+* Remove `RangeRequest.server_supports_content_range?` and `RangeRequest.check_server_supports_content_range!`
+* Instead of pre-checking for Range request support, we just attempt the request and abort it early if the server doesn't support Range requests. This should make it more reliable for servers that e.g. don't announce support with the Accept-Ranges header or don't support HEAD requests.
+* Better separation of server error responses: When the server responds with an error, HttpZip now raises `HttpZip::RequestError`. Only when the response is successful, but not `206 Partial Content`, do we raise `HttpZip::ContentRangeError`.
+
+# 1.0.0
+* Initial release

data/README.md

@@ -42,11 +42,7 @@ content = entry.read
 entry.write_to_file('/path/extracted.txt')
 ```
 
-If the server that the zip file is hosted on doesn't support Range requests, HttpZip will throw `HttpZip::ContentRangeError`. If you want you can check this beforehand by calling:
-
-```ruby
-HttpZip::RangeRequest.server_supports_content_range?(url)
-```
+If the server that the zip file is hosted on doesn't support Range requests, HttpZip will throw `HttpZip::ContentRangeError`.
 
 ## Contributing
 

data/http_zip.gemspec

@@ -26,11 +26,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'httparty', '~> 0.20'
-
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
   spec.add_development_dependency 'simplecov', '~> 0.21'
   spec.add_development_dependency 'webmock', '~> 3.14'
 end

data/lib/http_zip/compression/deflate.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module HttpZip
+  module Compression
+    class Deflate
+      def initialize
+        @inflater = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+      end
+
+      def decompress(input)
+        @inflater.inflate(input)
+      end
+
+      def finish
+        @inflater.finish
+        @inflater.close
+      end
+    end
+  end
+end

data/lib/http_zip/compression/stored.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module HttpZip
+  module Compression
+    class Stored
+      def decompress(input)
+        input
+      end
+
+      def finish; end
+    end
+  end
+end

data/lib/http_zip/entry.rb

@@ -4,7 +4,7 @@ module HttpZip
   # Describes one entry in an HTTP zip archive
   # @attr_reader [String] name filename of the entry
   class Entry
-    attr_reader :name
+    attr_reader :name, :compressed_size
 
     def initialize(url, name, header_offset, central_directory_file_compressed_size)
       @range_request = HttpZip::RangeRequest.new(url)
@@ -20,10 +20,9 @@ module HttpZip
       from = @header_offset + header_size
       to = @header_offset + header_size + @compressed_size
 
-      decompress, _finish = decompress_funcs
-
+      decompressor = compression_method
       compressed_contents = @range_request.get(from, to)
-      decompress.call(compressed_contents)
+      decompressor.decompress(compressed_contents)
     end
 
     # Get the decompressed content of the file entry
@@ -32,14 +31,13 @@ module HttpZip
       from = @header_offset + header_size
       to = @header_offset + header_size + @compressed_size
 
-      decompress, finish = decompress_funcs
-
+      decompressor = compression_method
       ::File.open(filename, 'wb') do |out_file|
         @range_request.get(from, to) do |chunk|
-          decompressed = decompress.call(chunk)
+          decompressed = decompressor.decompress(chunk)
           out_file.write(decompressed)
         end
-        finish.call
+        decompressor.finish
       end
     end
 
@@ -57,33 +55,19 @@ module HttpZip
       30 + file_name_length + extra_field_length
     end
 
-    def decompress_funcs
+    def compression_method
       # which compression method is used?
-      compression_method = header[8...10].unpack1('v')
+      algorithm = header[8...10].unpack1('v')
 
-      case compression_method
+      case algorithm
       when 0
-        # STORED content, doesn't require decompression
-        decompress = lambda { |input|
-          input
-        }
-        finish = -> {}
+        HttpZip::Compression::Stored.new
       when 8
-        inflater = Zlib::Inflate.new(-Zlib::MAX_WBITS)
-        # DEFLATED content, inflate it
-        decompress = lambda { |input|
-          inflater.inflate(input)
-        }
-        finish = lambda do
-          inflater.finish
-          inflater.close
-        end
+        HttpZip::Compression::Deflate.new
       else
         raise HttpZip::ZipError,
-              "Unsupported compression method #{compression_method}. HttpZip only supports compression methods 0 (STORED) and 8 (DEFLATE)."
+              "Unsupported compression method #{algorithm}. HttpZip only supports compression methods 0 (STORED) and 8 (DEFLATE)."
       end
-
-      [decompress, finish]
     end
   end
 end

data/lib/http_zip/errors.rb

@@ -2,6 +2,7 @@
 
 module HttpZip
   class Error < StandardError; end
-  class ContentRangeError < Error; end
+  class RequestError < Error; end
+  class ContentRangeError < RequestError; end
   class ZipError < Error; end
 end

data/lib/http_zip/file.rb

@@ -23,7 +23,6 @@ module HttpZip
       @url = url
       @entries = nil
       @range_request = RangeRequest.new(url)
-      @range_request.check_server_supports_content_range!
     end
 
     # Get all entries in the zip archive as an array of HttpZip::Entry.

data/lib/http_zip/range_request.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'httparty'
+require 'net/http'
 
 module HttpZip
   # Class to make Range requests to a HTTP server
@@ -9,7 +9,9 @@ module HttpZip
     #
     # @param [String] url remote file URL
     def initialize(url)
-      @url = url
+      @uri = URI(url)
+      @connection = Net::HTTP.new(@uri.host, @uri.port)
+      @connection.use_ssl = true if @uri.scheme == 'https'
     end
 
     # Request a partial object via HTTP. If a block is given, yields the response body in chunks.
@@ -18,20 +20,10 @@ module HttpZip
     # @param [Integer] to end byte of the range to request. Exclusive.
     # @yield [chunk] yields a chunk of data to the block
     # @raise [ContentRangeError] if the server responds with anything other than 206 Partial Content
-    def get(from, to)
-      options = { headers: { 'Range' => "bytes=#{from}-#{to - 1}" } }
-      options[:stream_body] = true if block_given?
-
-      response = HTTParty.get(@url, options) do |chunk|
-        yield chunk if block_given?
-      end
-
-      if response.code != 206
-        # oops, we downloaded the whole file
-        raise ContentRangeError, 'Server does not support the Range header'
-      end
-
-      response.body
+    def get(from, to, &block)
+      request = Net::HTTP::Get.new(@uri)
+      request['Range'] = "bytes=#{from}-#{to - 1}"
+      make_request(request, &block)
     end
 
     # Request the last `num_bytes` bytes of the remote file via HTTP.
@@ -39,32 +31,31 @@ module HttpZip
     # @param [Integer] num_bytes number of bytes to request
     # @raise [ContentRangeError] if the server responds with anything other than 206 Partial Content
     def last(num_bytes)
-      response = HTTParty.get(@url, headers: { 'Range' => "bytes=-#{num_bytes}" })
-      if response.code != 206
-        # oops, we downloaded the whole file
-        raise ContentRangeError, 'Server does not support the Range header'
-      end
-
-      response.body
+      request = Net::HTTP::Get.new(@uri)
+      request['Range'] = "bytes=-#{num_bytes}"
+      make_request(request)
     end
 
-    # Tests if the server supports the Range header by checking the "Accept-Ranges" header,
-    # otherwise raises an exception.
-    #
-    # @raise [ContentRangeError] if the server does not support the Range header
-    def check_server_supports_content_range!
-      return if self.class.server_supports_content_range?(@url)
+    private
 
-      raise ContentRangeError, 'Server does not support the Range header'
+    def make_request(request, &block)
+      @connection.start do |http|
+        response = http.request(request) do |res|
+          handle_response_code!(res)
+          res.read_body(&block)
+        end
+
+        response.body unless block_given?
+      end
     end
 
-    # Tests if the server supports the Range header by checking the "Accept-Ranges" header.
-    #
-    # @param [String] url remote file URL
-    # @return [Boolean] true if the server supports the Range header
-    def self.server_supports_content_range?(url)
-      response = HTTParty.head(url)
-      response.headers['Accept-Ranges'] && response.headers['Accept-Ranges'].downcase != 'none'
+    def handle_response_code!(response)
+      unless response.is_a?(Net::HTTPSuccess)
+        raise RequestError, "Server responded with #{response.code} #{response.message}"
+      end
+      return if response.is_a?(Net::HTTPPartialContent)
+
+      raise ContentRangeError, 'Server does not support the Range header'
     end
   end
 end

data/lib/http_zip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HttpZip
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/http_zip.rb

@@ -7,3 +7,5 @@ require 'http_zip/entry'
 require 'http_zip/file'
 require 'http_zip/parser/central_directory_file_header'
 require 'http_zip/parser/central_directory'
+require 'http_zip/compression/stored'
+require 'http_zip/compression/deflate'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http_zip
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marvin Killing
@@ -9,22 +9,8 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-04-13 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: httparty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.20'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -59,14 +45,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -104,6 +96,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -112,6 +105,8 @@ files:
 - bin/setup
 - http_zip.gemspec
 - lib/http_zip.rb
+- lib/http_zip/compression/deflate.rb
+- lib/http_zip/compression/stored.rb
 - lib/http_zip/entry.rb
 - lib/http_zip/errors.rb
 - lib/http_zip/file.rb