zip_tricks 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 327b846ccfc7d19442d21e145a2f767da91f0547381afe52be27db6709dee4a4
-  data.tar.gz: 4d80718a715063f1cebad32471ab83e77d38a805f3ceed82793b922d0d3a877f
+  metadata.gz: 983b83d36f88a25db8276a74e45d506f801ac3ecdd64197fd6fbc98bdb39cb03
+  data.tar.gz: c74a8a3936f4afb1f71ad7775025b73ccd04d2db309df8942a20ff64e82cea81
 SHA512:
-  metadata.gz: 982bc310eb658d67262c28efb043f1ddd3957db197ef1bcbe9108f3572431211069843221d36cf9b28231617d899249ad06be5b9c756189e8f0d383b168a340f
-  data.tar.gz: 40fdde09881e02b5a816dae826554e14d76fb26a1bcf09cfcd053450668b34e2d3c63dc5bbf84417b6bdc44f021a35d38fdabd08d9ace5aabe1ff6c335b65e49
+  metadata.gz: 2b6eed391cd16c4077003535b0d7fb52e6930f351b230d31ba68aab2f05905df3987565aad76741083e888a91d054eaff3beab507117088b812b6c95f9ecf4f3
+  data.tar.gz: 9c4ad53ef462d28f8cdffcc439200788cb260e9d1b35ee231aed3b7979630d0c31881db95198a944c375c836678063e0db187fbfb3c2672819ad5e06d1023dc9

data/.travis.yml

@@ -1,10 +1,6 @@
 rvm:
-- 2.1
-- 2.2.10
-- 2.3.7
-- 2.4.4
-- 2.5.4
-- 2.6.2
+- 2.1.0
+- 2.6.5
 - jruby-9.0
 sudo: false
 cache: bundler

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 5.1.0
+
+* Slightly rework `RemoteIO` and `RemoteUncap` and make sure they work correctly by spinning up a test webserver
+  to verify their operation. The changes to the documented API are fairly small so this is still marked as a minor
+  release.
+
 ## 5.0.0
 
 * Disable automatic filename deduplication by default, because it does not play nice with file/directory

data/lib/zip_tricks/remote_io.rb

@@ -8,14 +8,16 @@
 # actual fetches over HTTP and an object that expects a handful of IO methods to be
 # available.
 class ZipTricks::RemoteIO
-  # @param fetcher[#request_object_size, #request_range] an object that perform fetches
-  def initialize(fetcher = :NOT_SET)
+  # @param url[String, URI] the HTTP/HTTPS URL of the object to be retrieved
+  def initialize(url)
     @pos = 0
-    @fetcher = fetcher
-    @remote_size = false
+    @uri = URI(url)
+    @remote_size = nil
   end
 
   # Emulates IO#seek
+  # @param offset[Integer] absolute offset in the remote resource to seek to
+  # @param mode[Integer] The seek mode (only SEEK_SET is supported)
   def seek(offset, mode = IO::SEEK_SET)
     raise "Unsupported read mode #{mode}" unless mode == IO::SEEK_SET
     @remote_size ||= request_object_size
@@ -25,7 +27,7 @@ class ZipTricks::RemoteIO
 
   # Emulates IO#size.
   #
-  # @return [Fixnum] the size of the remote resource
+  # @return [Integer] the size of the remote resource
   def size
     @remote_size ||= request_object_size
   end
@@ -39,21 +41,20 @@ class ZipTricks::RemoteIO
   # @param n_bytes[Fixnum, nil] how many bytes to read, or `nil` to read all the way to the end
   # @return [String] the read bytes
   def read(n_bytes = nil)
-    @remote_size ||= request_object_size
-
     # If the resource is empty there is nothing to read
-    return if @remote_size.zero?
+    return if size.zero?
 
-    maximum_avaialable = @remote_size - @pos
+    maximum_avaialable = size - @pos
     n_bytes ||= maximum_avaialable # nil == read to the end of file
     return '' if n_bytes.zero?
     raise ArgumentError, "No negative reads(#{n_bytes})" if n_bytes < 0
 
     n_bytes = clamp(0, n_bytes, maximum_avaialable)
 
-    read_n_bytes_from_remote(@pos, n_bytes).tap do |data|
+    http_range = (@pos..(@pos + n_bytes - 1))
+    request_range(http_range).tap do |data|
       raise "Remote read returned #{data.bytesize} bytes instead of #{n_bytes} as requested" if data.bytesize != n_bytes
-      @pos = clamp(0, @pos + data.bytesize, @remote_size)
+      @pos = clamp(0, @pos + data.bytesize, size)
     end
   end
 
@@ -66,23 +67,41 @@ class ZipTricks::RemoteIO
 
   protected
 
+  # Only used internally when reading the remote ZIP.
+  #
+  # @param range[Range] the HTTP range of data to fetch from remote
+  # @return [String] the response body of the ranged request
   def request_range(range)
-    @fetcher.request_range(range)
+    http = Net::HTTP.start(@uri.hostname, @uri.port)
+    request = Net::HTTP::Get.new(@uri)
+    request.range = range
+    response = http.request(request)
+    case response.code
+    when "206", "200"
+      response.body
+    else
+      raise "Remote at #{@uri} replied with code #{response.code}"
+    end
   end
 
+  # For working with S3 it is a better idea to perform a GET request for one byte, since doing a HEAD
+  # request needs a different permission - and standard GET presigned URLs are not allowed to perform it
+  #
+  # @return [Integer] the size of the remote resource, parsed either from Content-Length or Content-Range header
   def request_object_size
-    @fetcher.request_object_size
-  end
-
-  # Reads N bytes at offset from remote
-  def read_n_bytes_from_remote(start_at, n_bytes)
-    range = (start_at..(start_at + n_bytes - 1))
-    request_range(range)
-  end
-
-  # Reads the Content-Length and caches it
-  def remote_size
-    @remote_size ||= request_object_size
+    http = Net::HTTP.start(@uri.hostname, @uri.port)
+    request = Net::HTTP::Get.new(@uri)
+    request.range = 0..0
+    response = http.request(request)
+    case response.code
+    when "206"
+      content_range_header_value = response['Content-Range']
+      content_range_header_value.split('/').last.to_i
+    when "200"
+      response['Content-Length'].to_i
+    else
+      raise "Remote at #{@uri} replied with code #{response.code}"
+    end
   end
 
   private

data/lib/zip_tricks/remote_uncap.rb

@@ -7,42 +7,16 @@
 #
 # Please read the security warning in `FileReader` _VERY CAREFULLY_
 # before you use this module.
-class ZipTricks::RemoteUncap
+module ZipTricks::RemoteUncap
   # @param uri[String] the HTTP(S) URL to read the ZIP footer from
   # @param reader_class[Class] which class to use for reading
   # @param options_for_zip_reader[Hash] any additional options to give to
   # {ZipTricks::FileReader} when reading
   # @return [Array<ZipTricks::FileReader::ZipEntry>] metadata about the
   # files within the remote archive
-  def self.files_within_zip_at(uri,
-                               reader_class: ZipTricks::FileReader,
-                               **options_for_zip_reader)
-    fetcher = new(uri)
-    fake_io = ZipTricks::RemoteIO.new(fetcher)
+  def self.files_within_zip_at(uri, reader_class: ZipTricks::FileReader, **options_for_zip_reader)
+    fake_io = ZipTricks::RemoteIO.new(uri)
     reader = reader_class.new
     reader.read_zip_structure(io: fake_io, **options_for_zip_reader)
   end
-
-  def initialize(uri)
-    @uri = URI(uri)
-  end
-
-  # Only used internally when reading the remote ZIP.
-  #
-  # @param range[Range] the HTTP range of data to fetch from remote
-  # @return [String] the response body of the ranged request
-  def request_range(range)
-    request = Net::HTTP::Get.new(@uri)
-    request.range = range
-    http = Net::HTTP.start(@uri.hostname, @uri.port)
-    http.request(request).body
-  end
-
-  # Only used internally when reading the remote ZIP.
-  #
-  # @return [Fixnum] the byte size of the ranged request
-  def request_object_size
-    http = Net::HTTP.start(@uri.hostname, @uri.port)
-    http.request_head(@uri)['Content-Length'].to_i
-  end
 end

data/lib/zip_tricks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipTricks
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/zip_tricks.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.require_paths  = ['lib']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rubyzip', '>= 1.2.2'
+  spec.add_development_dependency 'rubyzip', '~> 1', '>= 1.2.2'
   spec.add_development_dependency 'terminal-table'
   spec.add_development_dependency 'range_utils'
 
@@ -44,4 +44,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'allocation_stats', '~> 0.1.5'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'wetransfer_style', '0.6.0'
+  spec.add_development_dependency 'puma'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip_tricks
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-01 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,6 +31,9 @@ dependencies:
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
@@ -38,6 +41,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
@@ -195,6 +201,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Stream out ZIP files from Ruby
 email:
 - me@julik.nl