interval_response 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de097b24eeeebadc3a25e7c9a5e1731b3e53d356b2b51dab43c95b0fd7e1499b
-  data.tar.gz: bd529e7dd25f1d0968db781bc194722501da7940c6fb687a14cb98d84033d813
+  metadata.gz: 627cc1b428d5adbde188c9718a9fabeacf4d852126500439ec672f1caea8b88f
+  data.tar.gz: e42cae558b987ef86bc9bb351a3e5196bf68af9bfa2f0918a6f16d8fbbb52036
 SHA512:
-  metadata.gz: d9fe05b599f91e6ad913667abdbc7ab9c84b8fe8ebbabee86b057871253b7e947bac1ee6f7c1ad8eb1e62c7fab89b5a5d3f3193972f7bfe88b3ced2ed4bd2753
-  data.tar.gz: 279349c6ae98f20b861434d6d6e150379fe142ea3219f3b7c963542c61a7cf04370f2606a3f63fbb526e0f0f7e79138d73af00f36a25ff2754bf936bd6dbb2a1
+  metadata.gz: 991b923a00ccb2b510e45044cf578c19e38a6ce65669188c91c16b736dfee0aba1352126d5552e114acc6a30d8ecc322d478c1af3091e3b7761d395cd521d5ec
+  data.tar.gz: e229ea7a13015012c7ecf8125b0f401e8b24b236de19a5a65b9c67afac6121966c269d31062a1a84a713e5caa25485e30eaf9e7c73a6bf3e452c2dd25ea4f67c

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.1.5
+
+* Change the API of `IntervalResponse.new` to accept the Rack `env` hash directly, without having the caller extract the header values manually.
+* Allow intervals to set ETags which contribute to the final ETag
+* Make #etag available on return value from IntervalResponse.new so that the ETag check can be performed without having to keep the interval sequence object at hand
+* Switch the license to MIT-Hippocratic
+
+# 0.1.4
+
+Initial public release

data/LICENSE.txt

@@ -1,21 +1,33 @@
-The MIT License (MIT)
-
-Copyright (c) 2019 Julik Tarkhanov
-
-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.
+interval_response - Copyright (2020) - (WeTransfer)(“Licensor”)
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+* Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+* Compliance with Human Rights Principles and Human Rights Laws.
+
+    1. Human Rights Principles.
+
+        (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+        (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+        Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+    2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws.  “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above).  Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+    3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+* Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+* Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -1,7 +1,9 @@
 # IntervalResponse
 
 is a little piece of machinery which allows your Rack/Rails application to correctly
-serve HTTP `Range:` responses. Features:
+serve HTTP `Range:` responses. It allows you to "stitch" together multiple spans of
+data (such as long strings, files or remote resources) and then serve them out in response
+to requests with `Range:` headers. Features:
 
 * Strong ETags depending on response composition
 * Correct response codes/headers/offsets
@@ -19,7 +21,7 @@ Wrap them in an `IntervalResponse` and return it to Rack:
 verses_app = ->(env) {
   all_verses = ImportantVerse.all.map(&:verse_text)
   interval_sequence = IntervalResponse::Sequence.new(*all_verses)
-  response = IntervalResponse.new(interval_sequence, env['HTTP_RANGE'], env['HTTP_IF_RANGE'])
+  response = IntervalResponse.new(interval_sequence, env)
   response.to_rack_response_triplet
 }
 ```
@@ -32,7 +34,7 @@ Or imagine you want to serve out a few very large log files, concatenated togeth
   # do not have to stay open during the entire response output
   lazy_files = log_paths.map { |path| IntervalResponse::LazyFile.new(path) }
   interval_sequence = IntervalResponse::Sequence.new(*lazy_files)
-  response = IntervalResponse.new(interval_sequence, env['HTTP_RANGE'], env['HTTP_IF_RANGE'])
+  response = IntervalResponse.new(interval_sequence, env)
   response.to_rack_response_triplet(headers: {'X-Server' => 'teapot'})
 ```
 
@@ -72,7 +74,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/julik/interval_response.
+Bug reports and pull requests are welcome on GitHub at https://github.com/WeTransfer/interval_response.
 
 ## License
 

data/interval_response.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Assemble HTTP responses from spliced sequences of payloads}
   spec.description   = %q{Assemble HTTP responses from spliced sequences of payloads}
   spec.homepage      = "https://github.com/WeTransfer/interval_response"
-  spec.license       = "MIT"
+  spec.licenses = ['MIT (Hippocratic)']
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.

data/lib/interval_response.rb

@@ -5,8 +5,8 @@ module IntervalResponse
   class Error < StandardError; end
 
   require_relative "interval_response/version"
-  require_relative "interval_response/to_rack_response_triplet"
   require_relative "interval_response/sequence"
+  require_relative "interval_response/abstract"
   require_relative "interval_response/empty"
   require_relative "interval_response/single"
   require_relative "interval_response/invalid"
@@ -16,50 +16,68 @@ module IntervalResponse
 
   ENTIRE_RESOURCE_RANGE = 'bytes=0-'
 
-  def self.new(interval_map, http_range_header_value_or_nil, http_if_range_header_or_nil)
+  # Creates a new IntervalResponse object. The object returned does not
+  # have a specific class, but is one of the following objects, which
+  # all support the same interface:
+  #
+  # * IntervalResponse::Empty for an empty response
+  # * IntervalResponse::Single for a single HTTP range
+  # * IntervalResponse::Full for the entire resource
+  # * IntervalResponse::Multi for multipart ranges response with multiple HTTP ranges
+  # * IntervalResponse::Invalid for responses that are 416 (Unsatisfiable range)
+  #
+  # @param interval_sequence[IntervalResponse::Sequence] the sequence of segments
+  # @param rack_env_headers[Hash] the Rack env, or a Hash containing 'HTTP_RANGE' and 'HTTP_IF_RANGE' headers
+  # @return [Empty, Single, Full, Multi, Invalid]
+  def self.new(interval_sequence, rack_env_headers)
+    http_range_header_value = rack_env_headers['HTTP_RANGE']
+    http_if_range_header_value = rack_env_headers['HTTP_IF_RANGE']
+
     # If the 'If-Range' header is provided but does not match, discard the Range header. It means
     # that the client is requesting a certain representation of the resource and wants a range
     # _within_ that representation, but the representation has since changed and the offsets
     # no longer make sense. In that case we are supposed to answer with a 200 and the full
     # monty.
-    if http_if_range_header_or_nil && http_if_range_header_or_nil != interval_map.etag
+    if http_if_range_header_value && http_if_range_header_value != interval_sequence.etag
       Measurometer.increment_counter('interval_response.if_range_mismatch', 1)
-      return new(interval_map, ENTIRE_RESOURCE_RANGE, nil)
+      return new(interval_sequence, 'HTTP_RANGE' => ENTIRE_RESOURCE_RANGE)
     end
 
-    if http_if_range_header_or_nil
+    if http_if_range_header_value
       Measurometer.increment_counter('interval_response.if_range_match', 1)
-    elsif http_range_header_value_or_nil
+    elsif http_range_header_value
       Measurometer.increment_counter('interval_response.if_range_not_provided', 1)
     end
 
-    prepare_response(interval_map, http_range_header_value_or_nil, http_if_range_header_or_nil).tap do |res|
+    prepare_response(interval_sequence, http_range_header_value).tap do |res|
       response_type_name_for_metric = res.class.to_s.split('::').last.downcase # Some::Module::Empty => empty
       Measurometer.increment_counter('interval_response.resp_%s' % response_type_name_for_metric, 1)
     end
   end
 
-  def self.prepare_response(interval_map, http_range_header_value_or_nil, _http_if_range_header_or_nil)
+  def self.prepare_response(interval_sequence, http_range_header_value)
     # Case 1 - response of 0 bytes (empty resource).
     # We don't even have to parse the Range header for this since
     # the response will be the same, always.
-    return Empty.new(interval_map) if interval_map.empty?
+    return Empty.new(interval_sequence) if interval_sequence.empty?
 
     # Parse the HTTP Range: header
-    range_request_header = http_range_header_value_or_nil || ENTIRE_RESOURCE_RANGE
-    http_ranges = Rack::Utils.get_byte_ranges(range_request_header, interval_map.size)
+    range_request_header = http_range_header_value || ENTIRE_RESOURCE_RANGE
+    http_ranges = Rack::Utils.get_byte_ranges(range_request_header, interval_sequence.size)
 
     # Case 2 - Client did send us a Range header, but Rack discarded
     # it because it is invalid and cannot be satisfied
-    return Invalid.new(interval_map) if http_range_header_value_or_nil && (http_ranges.nil? || http_ranges.empty?)
+    return Invalid.new(interval_sequence) if http_range_header_value && (http_ranges.nil? || http_ranges.empty?)
 
     # Case 3 - entire resource
-    return Full.new(interval_map) if http_ranges.length == 1 && http_ranges.first == (0..(interval_map.size - 1))
+    return Full.new(interval_sequence) if http_ranges.length == 1 && http_ranges.first == (0..(interval_sequence.size - 1))
 
     # Case 4 - one content range
-    return Single.new(interval_map, http_ranges) if http_ranges.length == 1
+    return Single.new(interval_sequence, http_ranges[0]) if http_ranges.length == 1
 
     # Case 5 - MIME multipart with multiple content ranges
-    Multi.new(interval_map, http_ranges)
+    Multi.new(interval_sequence, http_ranges)
   end
+
+  private_class_method :prepare_response
 end

data/lib/interval_response/abstract.rb

@@ -0,0 +1,115 @@
+# Base class for all response types, primarily for ease of documentation
+class IntervalResponse::Abstract
+  # The Rack body wrapper is intended to return as the third element
+  # of the Rack response triplet. It supports the #each method
+  # and will call to the IntervalResponse object given to it
+  # at instantiation, filling up a pre-allocated String object
+  # with the bytes to be served out.
+  class RackBodyWrapper
+    # Default size of the chunk (String buffer) which is going to be
+    # yielded to the caller of the `each` method.
+    # Set toroughly one TCP kernel buffer
+    CHUNK_SIZE = 65 * 1024
+
+    def initialize(with_interval_response, chunk_size:)
+      @chunk_size = chunk_size
+      @interval_response = with_interval_response
+    end
+
+    def each
+      buf = String.new(capacity: @chunk_size)
+      @interval_response.each do |segment, range_in_segment|
+        case segment
+        when IntervalResponse::LazyFile
+          segment.with do |file_handle|
+            with_each_chunk(range_in_segment) do |offset, read_n|
+              file_handle.seek(offset, IO::SEEK_SET)
+              yield file_handle.read(read_n, buf)
+            end
+          end
+        when String
+          with_each_chunk(range_in_segment) do |offset, read_n|
+            yield segment.slice(offset, read_n)
+          end
+        when IO, Tempfile
+          with_each_chunk(range_in_segment) do |offset, read_n|
+            segment.seek(offset, IO::SEEK_SET)
+            yield segment.read(read_n, buf)
+          end
+        else
+          raise TypeError, "RackBodyWrapper only supports IOs or Strings"
+        end
+      end
+    ensure
+      buf.clear
+    end
+
+    private
+
+    def with_each_chunk(range_in_segment)
+      range_size = range_in_segment.end - range_in_segment.begin + 1
+      start_at_offset = range_in_segment.begin
+      n_whole_segments, remainder = range_size.divmod(@chunk_size)
+
+      n_whole_segments.times do |n|
+        unit_offset = start_at_offset + (n * @chunk_size)
+        yield unit_offset, @chunk_size
+      end
+
+      if remainder > 0
+        unit_offset = start_at_offset + (n_whole_segments * @chunk_size)
+        yield unit_offset, remainder
+      end
+    end
+  end
+
+  def to_rack_response_triplet(headers: nil, chunk_size: RackBodyWrapper::CHUNK_SIZE)
+    [status_code, headers.to_h.merge(self.headers), RackBodyWrapper.new(self, chunk_size: chunk_size)]
+  end
+
+  # @param interval_sequence[IntervalResponse::Sequence] the sequence the response is built for
+  def initialize(interval_sequence)
+    @interval_sequence = interval_sequence
+  end
+
+  # Returns the ETag of the interval sequence
+  def etag
+    @interval_sequence.etag
+  end
+
+  # Yields every segment and the range within that segment to be returned to the client. For multipart
+  # responses the envelopes of the parts will be returned as segments as well
+  #
+  # @yield [Object, Range]
+  def each
+    # No-op
+  end
+
+  # Returns the HTTP status code of the response
+  #
+  # @return [Integer]
+  def status_code
+    200
+  end
+
+  # Returns the exact number of bytes that the response is. If the response
+  # is a range it will be the length of the range. If the response is a multipart
+  # byte range response it will be the content length of the ranges plus the content
+  # length of all the envelopes.
+  #
+  # @return [Integer]
+  def content_length
+    0
+  end
+
+  # Returns headers for the HTTP response
+  # @return [Hash]
+  def headers
+    {
+      'Accept-Ranges' => 'bytes',
+      'Content-Length' => '0',
+      'Content-Type' => 'binary/octet-stream',
+      'ETag' => etag,
+    }
+  end
+end

data/lib/interval_response/empty.rb

@@ -1,15 +1,5 @@
 # Serves out a response that is of size 0
-class IntervalResponse::Empty
-  include IntervalResponse::ToRackResponseTriplet
-
-  def initialize(interval_map)
-    @interval_map = interval_map
-  end
-
-  def each
-    # No-op
-  end
-
+class IntervalResponse::Empty < IntervalResponse::Abstract
   def status_code
     200
   end
@@ -23,7 +13,7 @@ class IntervalResponse::Empty
       'Accept-Ranges' => 'bytes',
       'Content-Length' => '0',
       'Content-Type' => 'binary/octet-stream',
-      'ETag' => @interval_map.etag,
+      'ETag' => etag,
     }
   end
 end

data/lib/interval_response/full.rb

@@ -1,15 +1,9 @@
 # Serves out a response that contains the entire resource
-class IntervalResponse::Full
-  include IntervalResponse::ToRackResponseTriplet
-
-  def initialize(interval_map, *)
-    @interval_map = interval_map
-  end
-
+class IntervalResponse::Full < IntervalResponse::Abstract
   def each
     # serve the part of the interval map
-    full_range = 0..(@interval_map.size - 1)
-    @interval_map.each_in_range(full_range) do |segment, range_in_segment|
+    full_range = 0..(@interval_sequence.size - 1)
+    @interval_sequence.each_in_range(full_range) do |segment, range_in_segment|
       yield(segment, range_in_segment)
     end
   end
@@ -19,15 +13,15 @@ class IntervalResponse::Full
   end
 
   def content_length
-    @interval_map.size
+    @interval_sequence.size
   end
 
   def headers
     {
       'Accept-Ranges' => 'bytes',
-      'Content-Length' => @interval_map.size.to_s,
+      'Content-Length' => @interval_sequence.size.to_s,
       'Content-Type' => 'binary/octet-stream',
-      'ETag' => @interval_map.etag,
+      'ETag' => etag,
     }
   end
 end

data/lib/interval_response/invalid.rb

@@ -1,13 +1,7 @@
-# Serves out a response that is of size 0
-class IntervalResponse::Invalid
-  include IntervalResponse::ToRackResponseTriplet
-
+# Serves out a response for 416 responses (invalid range request)
+class IntervalResponse::Invalid < IntervalResponse::Abstract
   ERROR_JSON = '{"message": "Ranges cannot be satisfied"}'
 
-  def initialize(segment_map)
-    @interval_map = segment_map
-  end
-
   def each
     full_segment_range = (0..(ERROR_JSON.bytesize - 1))
     yield(ERROR_JSON, full_segment_range)
@@ -26,8 +20,8 @@ class IntervalResponse::Invalid
       'Accept-Ranges' => 'bytes',
       'Content-Length' => ERROR_JSON.bytesize.to_s,
       'Content-Type' => 'application/json',
-      'Content-Range' => "bytes */#{@interval_map.size}",
-      'ETag' => @interval_map.etag,
+      'Content-Range' => "bytes */#{@interval_sequence.size}",
+      'ETag' => etag,
     }
   end
 end

data/lib/interval_response/multi.rb

@@ -1,18 +1,15 @@
-require 'securerandom'
-
-class IntervalResponse::Multi
-  include IntervalResponse::ToRackResponseTriplet
-
+class IntervalResponse::Multi < IntervalResponse::Abstract
   ALPHABET = ('0'..'9').to_a + ('a'..'z').to_a + ('A'..'Z').to_a
 
-  def initialize(interval_map, http_ranges)
-    @interval_map = interval_map
+  # @param http_ranges[Array<Range>]
+  def initialize(interval_sequence, http_ranges)
+    @interval_sequence = interval_sequence
     @http_ranges = http_ranges
     # RFC1521 says that a boundary "must be no longer than 70 characters,
     # not counting the two leading hyphens".
-    # Modulo-based random is biased but it doesn't matter much for us (we do not need to
+    # Standard Ruby randomness is biased but it doesn't matter much for us (we do not need to
     # be extremely secure here)
-    @boundary = SecureRandom.bytes(24).unpack("C*").map { |b| ALPHABET[b % ALPHABET.length] }.join
+    @boundary = ALPHABET.sample(24).join
   end
 
   def each
@@ -21,7 +18,7 @@ class IntervalResponse::Multi
       part_header = part_header(range_i, http_range)
       entire_header_range = 0..(part_header.bytesize - 1)
       yield(part_header, entire_header_range)
-      @interval_map.each_in_range(http_range) do |segment, range_in_segment|
+      @interval_sequence.each_in_range(http_range) do |segment, range_in_segment|
         yield(segment, range_in_segment)
       end
     end
@@ -46,7 +43,7 @@ class IntervalResponse::Multi
       'Accept-Ranges' => 'bytes',
       'Content-Length' => content_length.to_s,
       'Content-Type' => "multipart/byte-ranges; boundary=#{@boundary}",
-      'ETag' => @interval_map.etag,
+      'ETag' => etag,
     }
   end
 
@@ -65,7 +62,7 @@ class IntervalResponse::Multi
       part_index > 0 ? "\r\n" : "", # Parts follwing the first have to be delimited "at the top"
       "--%s\r\n" % @boundary,
       "Content-Type: binary/octet-stream\r\n",
-      "Content-Range: bytes %d-%d/%d\r\n" % [http_r.begin, http_r.end, @interval_map.size],
+      "Content-Range: bytes %d-%d/%d\r\n" % [http_r.begin, http_r.end, @interval_sequence.size],
       "\r\n",
     ].join
   end

data/lib/interval_response/sequence.rb

@@ -1,35 +1,65 @@
 require 'digest'
 
-# An interval sequence represents a linear sequence of non-overlapping,
+# Represents a linear sequence of non-overlapping,
 # joined intervals. For example, an HTTP response which consists of
 # multiple edge included segments, or a timeline with clips joined together.
 # Every interval contains a *segment* - an arbitrary object which responds to
 # `#size` at time of adding to the IntervalSequence.
 class IntervalResponse::Sequence
-  MULTIPART_GENRATOR_FINGERPRINT = 'boo'
-  Interval = Struct.new(:segment, :size, :offset, :position)
+  Interval = Struct.new(:segment, :size, :offset, :position, :etag)
+  private_constant :Interval
 
+  # @return [Integer] the sum of sizes of all the segments of the sequence
   attr_reader :size
 
+  # Creates a new Sequence with given segments.
+  #
+  # @param segments[Array<#size,#bytesize>] Segments which respond to #size or #bytesize
   def initialize(*segments)
     @intervals = []
     @size = 0
     segments.each { |s| self << s }
   end
 
+  # Adds a segment to the sequence. The segment gets added at the end of the sequence.
+  #
+  # @param segment[#size,#bytesize] Segment which responds to #size or #bytesize
+  # @return self
   def <<(segment)
     segment_size_or_bytesize = segment.respond_to?(:bytesize) ? segment.bytesize : segment.size
-    return self if segment_size_or_bytesize == 0
-
     add_segment(segment, size: segment_size_or_bytesize)
-    self
   end
 
-  def add_segment(segment, size:)
-    @intervals << Interval.new(segment, size, @size, @intervals.length)
-    @size += size
+  # Adds a segment to the sequence with specifying the size and optionally the ETag value
+  # of the segment. ETag defaults to the size of the segment. Segment can be any object
+  # as the size gets passed as a keyword argument
+  #
+  # @param segment[Object] Any object can be used as the segment
+  # @param size[Integer] The size of the segment
+  # @param etag[Object] An object that defines the ETag for the segment. Can be any object that can
+  #   be Marshal.dump - ed.
+  # @return self
+  def add_segment(segment, size:, etag: size)
+    if size > 0
+      etag_quoted = '"%s"' % etag
+      @intervals << Interval.new(segment, size, @size, @intervals.length, etag_quoted)
+      @size += size
+    end
+    self
   end
 
+  # Yields every segment which is touched by the given Range in resource in sequence,
+  # together with a Range object which defines the necessary part of the segment.
+  # For example, calling `each_in_range(0..2)` with 2 segments of size 1 and 2
+  # will successively yield [segment1, 0..0] then [segment2, 0..1]
+  #
+  # Interval sequences can be nested - you can place a Sequence inside another Sequence
+  # as a segment. In that case when you call `each_in_range` on the outer Sequence and you
+  # need to retrieve data from the inner Sequence which is one of the segments, the call will
+  # yield the segments from the inner Sequence, "drilling down" as deep as is appropriate.
+  #
+  # @param from_range_in_resource[Range] an inclusive Range that specifies the range within the segment map
+  # @yield segment[Object], range_in_segment[Range]
   def each_in_range(from_range_in_resource)
     # Skip empty ranges
     requested_range_size = (from_range_in_resource.end - from_range_in_resource.begin) + 1
@@ -57,6 +87,7 @@ class IntervalResponse::Sequence
     end
   end
 
+  # Tells whether the size of the entire sequence is 0
   def empty?
     @size == 0
   end
@@ -87,10 +118,17 @@ class IntervalResponse::Sequence
   # enclosed in double-quotes.
   #
   # See for more https://blogs.msdn.microsoft.com/ieinternals/2011/06/03/download-resumption-in-internet-explorer/
+  #
+  # The ETag value gets derived from the ETags of the segments, which will be Marshal.dump'ed together
+  # and then added to the hash digest to produce the final ETag value.
+  #
+  # @return [String] a string delimited with double-quotes
   def etag
     d = Digest::SHA1.new
     d << IntervalResponse::VERSION
-    d << Marshal.dump(@intervals.map(&:size))
+    @intervals.each do |interval|
+      d << interval.etag
+    end
     '"%s"' % d.hexdigest
   end
 

data/lib/interval_response/single.rb

@@ -1,16 +1,15 @@
 # Serves out a response that consists of one HTTP Range,
 # which is always not the entire resource
-class IntervalResponse::Single
-  include IntervalResponse::ToRackResponseTriplet
-
-  def initialize(interval_map, http_ranges)
-    @interval_map = interval_map
-    @http_range = http_ranges.first
+class IntervalResponse::Single < IntervalResponse::Abstract
+  # @param http_range[Range]
+  def initialize(interval_sequence, http_range)
+    @interval_sequence = interval_sequence
+    @http_range = http_range
   end
 
   # Serve the part of the interval map
   def each
-    @interval_map.each_in_range(@http_range) do |segment, range_in_segment|
+    @interval_sequence.each_in_range(@http_range) do |segment, range_in_segment|
       yield(segment, range_in_segment)
     end
   end
@@ -24,13 +23,13 @@ class IntervalResponse::Single
   end
 
   def headers
-    c_range = ('bytes %d-%d/%d' % [@http_range.begin, @http_range.end, @interval_map.size])
+    c_range = ('bytes %d-%d/%d' % [@http_range.begin, @http_range.end, @interval_sequence.size])
     {
       'Accept-Ranges' => 'bytes',
       'Content-Length' => (@http_range.end - @http_range.begin + 1).to_s,
       'Content-Type' => 'binary/octet-stream',
       'Content-Range' => c_range,
-      'ETag' => @interval_map.etag,
+      'ETag' => etag,
     }
   end
 end

data/lib/interval_response/version.rb

@@ -1,3 +1,3 @@
 module IntervalResponse
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/spec/interval_response/sequence_spec.rb

@@ -66,6 +66,23 @@ RSpec.describe IntervalResponse::Sequence do
       expect(etag_for_sequence_of_same_sizes).not_to eq(etag_for_sequence)
     end
 
+    it 'takes explicit etags into account if they are set on the intervals' do
+      seq = described_class.new
+      seq.add_segment(:a, size: 6)
+      etag_of_size_6 = seq.etag
+
+      seq = described_class.new
+      seq.add_segment(:a, size: 6)
+      another_etag_of_size_6 = seq.etag
+
+      seq = described_class.new
+      seq.add_segment(:a, size: 6, etag: "Some random etag")
+      etag_set_explicitly = seq.etag
+
+      expect(etag_of_size_6).to eq(another_etag_of_size_6)
+      expect(etag_of_size_6).not_to eq(etag_set_explicitly)
+    end
+
     it 'can handle a range that stretches outside of the available range' do
       a = double('a', size: 3)
       b = double('b', size: 4)

data/spec/interval_response_spec.rb

@@ -6,7 +6,7 @@ RSpec.describe IntervalResponse do
   context 'with an empty resource' do
     let(:seq) { IntervalResponse::Sequence.new }
     it 'always returns the empty response' do
-      response = IntervalResponse.new(seq, _http_range_header = nil, _if_range_header = nil)
+      response = IntervalResponse.new(seq, {})
       expect(response.status_code).to eq(200)
       expect(response.content_length).to eq(0)
       expect(response.headers).to eq(
@@ -15,11 +15,12 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
       expect { |b|
         response.each(&b)
       }.not_to yield_control
 
-      response = IntervalResponse.new(seq, 'bytes=0-', _if_range = nil)
+      response = IntervalResponse.new(seq, 'HTTP_RANGE' => 'bytes=0-')
       expect(response.status_code).to eq(200)
       expect(response.content_length).to eq(0)
       expect(response.headers).to eq(
@@ -28,6 +29,7 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
       expect { |b|
         response.each(&b)
       }.not_to yield_control
@@ -44,7 +46,7 @@ RSpec.describe IntervalResponse do
     end
 
     it 'returns the full response if the client did not ask for a Range' do
-      response = IntervalResponse.new(seq, _http_range_header = nil, _if_range = nil)
+      response = IntervalResponse.new(seq, {})
       expect(response.status_code).to eq(200)
       expect(response.content_length).to eq(3 + 4 + 1)
       expect(response.headers).to eq(
@@ -53,13 +55,14 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
       expect { |b|
         response.each(&b)
       }.to yield_successive_args([segment_a, 0..2], [segment_b, 0..3], [segment_c, 0..0])
     end
 
     it 'returns 416 if the requested range is invalid' do
-      response = IntervalResponse.new(seq, "bytes=6-5", _if_range = nil)
+      response = IntervalResponse.new(seq, 'HTTP_RANGE' => "bytes=6-5")
       expect(response.status_code).to eq(416)
       expect(response.headers).to eq(
         "Accept-Ranges" => "bytes",
@@ -68,10 +71,11 @@ RSpec.describe IntervalResponse do
         'Content-Range' => "bytes */#{seq.size}",
         'ETag' => seq.etag
       )
+      expect(response.etag).to eq(seq.etag)
     end
 
     it 'returns a single HTTP range if the client asked for it and it can be satisfied' do
-      response = IntervalResponse.new(seq, "bytes=2-4", _if_range = nil)
+      response = IntervalResponse.new(seq, "HTTP_RANGE" => "bytes=2-4")
       expect(response.status_code).to eq(206)
       expect(response.content_length).to eq(3)
       expect(response.headers).to eq(
@@ -81,13 +85,14 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
       expect { |b|
         response.each(&b)
       }.to yield_successive_args([segment_a, 2..2], [segment_b, 0..1])
     end
 
     it 'returns a single HTTP range if the client asked for it and it can be satisfied, ETag matches' do
-      response = IntervalResponse.new(seq, "bytes=2-4", _if_range = seq.etag)
+      response = IntervalResponse.new(seq, "HTTP_RANGE" => "bytes=2-4", "HTTP_IF_RANGE" => seq.etag)
       expect(response.status_code).to eq(206)
       expect(response.content_length).to eq(3)
       expect(response.headers).to eq(
@@ -97,13 +102,14 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
       expect { |b|
         response.each(&b)
       }.to yield_successive_args([segment_a, 2..2], [segment_b, 0..1])
     end
 
     it 'responss with the entier resource if the Range is satisfiable but the If-Range specifies a different ETag than the sequence' do
-      response = IntervalResponse.new(seq, _http_range_header = "bytes=12901-", _http_if_range = '"different"')
+      response = IntervalResponse.new(seq, "HTTP_RANGE" => "bytes=12901-", "HTTP_IF_RANGE" => '"different"')
       expect(response.status_code).to eq(200)
       expect(response.content_length).to eq(8)
       expect(response.headers).to eq(
@@ -112,10 +118,11 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
     end
 
-    it 'responds with the range that can be satisfied if asked for 2 of which one is unsatisfiable' do
-      response = IntervalResponse.new(seq, _http_range_header = "bytes=0-5,12901-", _http_if_range = nil)
+    it 'responds with the range that can be satisfied if asked for 2, of which one is unsatisfiable' do
+      response = IntervalResponse.new(seq, "HTTP_RANGE" => "bytes=0-5,12901-")
       expect(response.status_code).to eq(206)
       expect(response.content_length).to eq(6)
       expect(response.headers).to eq(
@@ -125,6 +132,7 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "binary/octet-stream",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
 
       expect { |b|
         response.each(&b)
@@ -132,7 +140,7 @@ RSpec.describe IntervalResponse do
     end
 
     it 'responds with MIME multipart of ranges if the client asked for it and it can be satisfied' do
-      response = IntervalResponse.new(seq, _http_range_header = "bytes=0-0,2-2", _http_if_range = nil)
+      response = IntervalResponse.new(seq, "HTTP_RANGE" => "bytes=0-0,2-2")
       response.instance_variable_set('@boundary', 'tcROXEYMdRNXRRYstW296yM1')
 
       expect(response.status_code).to eq(206)
@@ -143,6 +151,7 @@ RSpec.describe IntervalResponse do
         "Content-Type" => "multipart/byte-ranges; boundary=tcROXEYMdRNXRRYstW296yM1",
         'ETag' => seq.etag,
       )
+      expect(response.etag).to eq(seq.etag)
 
       output = StringIO.new
       response.each do |segment, range|

data/spec/rack_stack_spec.rb

@@ -7,7 +7,7 @@ RSpec.describe 'IntervalResponse used in a Rack application' do
   let(:app) do
     ->(env) {
       interval_sequence = IntervalResponse::Sequence.new(*segments)
-      response = IntervalResponse.new(interval_sequence, env['HTTP_RANGE'], env['HTTP_IF_RANGE'])
+      response = IntervalResponse.new(interval_sequence, env)
       response.to_rack_response_triplet
     }
   end
@@ -49,4 +49,19 @@ RSpec.describe 'IntervalResponse used in a Rack application' do
     expect(last_response.status).to eq(206)
     expect(last_response.content_length).to eq(56897)
   end
+
+  it 'serves from LazyFile objects' do
+    tiny = "tiny string"
+    file_a = tempfile_with_random_bytes(4 * 1024 * 1024)
+    file_b = tempfile_with_random_bytes(7 * 1024 * 1024)
+
+    @segments = [tiny, IntervalResponse::LazyFile.new(file_a.path), IntervalResponse::LazyFile.new(file_b.path)]
+    get '/big', nil, 'HTTP_RANGE' => 'bytes=1-5'
+    expect(last_response.status).to eq(206)
+    expect(last_response.content_length).to eq(5)
+
+    get '/big', nil, 'HTTP_RANGE' => 'bytes=2-56898'
+    expect(last_response.status).to eq(206)
+    expect(last_response.content_length).to eq(56897)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: interval_response
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-07 00:00:00.000000000 Z
+date: 2020-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -133,6 +133,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -141,6 +142,7 @@ files:
 - bin/setup
 - interval_response.gemspec
 - lib/interval_response.rb
+- lib/interval_response/abstract.rb
 - lib/interval_response/empty.rb
 - lib/interval_response/full.rb
 - lib/interval_response/invalid.rb
@@ -148,7 +150,6 @@ files:
 - lib/interval_response/multi.rb
 - lib/interval_response/sequence.rb
 - lib/interval_response/single.rb
-- lib/interval_response/to_rack_response_triplet.rb
 - lib/interval_response/version.rb
 - spec/interval_response/sequence_spec.rb
 - spec/interval_response_spec.rb
@@ -156,7 +157,7 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/WeTransfer/interval_response
 licenses:
-- MIT
+- MIT (Hippocratic)
 metadata:
   homepage_uri: https://github.com/WeTransfer/interval_response
   source_code_uri: https://github.com/WeTransfer/interval_response

data/lib/interval_response/to_rack_response_triplet.rb

@@ -1,58 +0,0 @@
-module IntervalResponse::ToRackResponseTriplet
-  CHUNK_SIZE = 65 * 1024 # Roughly one TCP kernel buffer
-
-  class RackBodyWrapper
-    def initialize(with_interval_response, chunk_size:)
-      @chunk_size = chunk_size
-      @interval_response = with_interval_response
-    end
-
-    def each
-      buf = String.new(capacity: @chunk_size)
-      @interval_response.each do |segment, range_in_segment|
-        case segment
-        when IntervalResponse::LazyFile
-          segment.with do |_file_handle|
-            with_each_chunk(range_in_segment) do |offset, read_n|
-              segment.seek(offset, IO::SEEK_SET)
-              yield segment.read_nonblock(read_n, buf)
-            end
-          end
-        when String
-          with_each_chunk(range_in_segment) do |offset, read_n|
-            yield segment.slice(offset, read_n)
-          end
-        when IO, Tempfile
-          with_each_chunk(range_in_segment) do |offset, read_n|
-            segment.seek(offset, IO::SEEK_SET)
-            yield segment.read_nonblock(read_n, buf)
-          end
-        else
-          raise TypeError, "RackBodyWrapper only supports IOs or Strings"
-        end
-      end
-    ensure
-      buf.clear
-    end
-
-    def with_each_chunk(range_in_segment)
-      range_size = range_in_segment.end - range_in_segment.begin + 1
-      start_at_offset = range_in_segment.begin
-      n_whole_segments, remainder = range_size.divmod(@chunk_size)
-
-      n_whole_segments.times do |n|
-        unit_offset = start_at_offset + (n * @chunk_size)
-        yield unit_offset, @chunk_size
-      end
-
-      if remainder > 0
-        unit_offset = start_at_offset + (n_whole_segments * @chunk_size)
-        yield unit_offset, remainder
-      end
-    end
-  end
-
-  def to_rack_response_triplet(headers: nil, chunk_size: CHUNK_SIZE)
-    [status_code, headers.to_h.merge(self.headers), RackBodyWrapper.new(self, chunk_size: chunk_size)]
-  end
-end