range_header_parser 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 217f64dd018bb6c66a7d38805273d4acac2c7dca
+  data.tar.gz: c19c42981bc33331d5c5ff52161df8c01b0e515b
+SHA512:
+  metadata.gz: 6fcd582622c18bd2072344c24ddf523796bf0d5ebf27c6e6b61c508625ced22a2f2f30782cc64e140947bac7ff53d18e03285feb56fd643bc44980e08f958a33
+  data.tar.gz: 1e41f056d1bac4305889cbbd53959c0ee4fa455a0bd2a1958e81b5431752b243264af01e19ffc69568a09e5057360f917c0c19c1fad80af5cd1e0ea5810b8921

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3
+cache: bundler
+sudo: false

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem 'range_utils'
+
+group :development do
+  gem "rspec", "~> 3"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 WeTransfer
+
+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 @@
+# range_header_parser
+
+![Travis-CI status](https://api.travis-ci.org/wetransfer/range_header_parser.svg?branch=master)
+
+Parse `Range:` HTTP headers, and returns an Array of Ruby ranges. The ranges are guaranteed to be:
+
+* positive
+* inclusive
+* of at least 1 byte
+
+Use it like so:
+
+    if env['HTTP_RANGE']
+      ranges = RangeHeaderParser.parse(env['HTTP_RANGE], size_of_resource)
+    end
+
+Adjacent ranges will be combined. Note that returning multiple ranges requires a multipart/byteranges
+response, and you might need some special machinery to be able to generate it.
+
+## Contributing to range_header_parser
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 WeTransfer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require_relative 'lib/range_header_parser/version'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  gem.version = RangeHeaderParser::VERSION
+  gem.name = "range_header_parser"
+  gem.homepage = "http://github.com/wetransfer/range_header_parser"
+  gem.license = "MIT"
+  gem.description = %Q{Parses Range HTTP headers for specific fetches}
+  gem.summary = %Q{with range splicing and proper offsets}
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "range_header_parser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/authorization_header_parser.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: range_header_parser 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "range_header_parser"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2015-06-29"
+  s.description = "Parses parametrized  HTTP Authorization headers"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/range_header_parser.rb",
+    "spec/range_header_parser_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/julik/range_header_parser"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "such as OAuth and Digest"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 3"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 3"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/lib/range_header_parser.rb

@@ -0,0 +1,66 @@
+require 'range_utils'
+
+module RangeHeaderParser
+  RANGE_RE = /^(\d+)-(\d+)$/.freeze
+  RANGE_FROM = /^(\d+)-$/.freeze
+  RANGE_LAST_N =/^-(\d+)$/.freeze
+  BYTES_RE = /^bytes=(.*)/.freeze
+  
+  InvalidHeader = Class.new(RuntimeError)
+  InvalidRange = Class.new(InvalidHeader)
+
+  # Parses a given string from Range: header,
+  # and returns an Array of Range objects.
+  #
+  # Overlapping and adjacent ranges will be spliced.
+  def parse(header_str, resource_size)
+    ranges = ranges_from_header_str(header_str, resource_size)
+    RangeUtils.splice(ranges)
+  end
+  
+  extend self
+  
+  private
+  
+  # Ported from WEBrick::HTTPUtils.parse_range_header, but with extra juice and
+  # honoring the actual size of the resource.
+  # https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.1
+  # If the last-byte-pos value is absent, or if the value is greater than or equal
+  # to the current length of the entity-body, last-byte-pos is taken to be equal
+  # to one less than the current length of the entity- body in bytes.
+  def ranges_from_header_str(ranges_specifier, size)
+    raise InvalidHeader, ranges_specifier unless BYTES_RE =~ ranges_specifier
+    byte_range_set = split_header_value($1)
+    byte_range_set.map do |range_spec|
+      case range_spec
+      when RANGE_RE # From byte M to byte N
+        starts_at = $1.to_i
+        ends_at = $2.to_i
+        ends_at = (size - 1) if ends_at >= size
+        raise InvalidRange, "Invalid range spec  #{range_spec} (starts too far in the resource)" if starts_at >= size
+        raise InvalidRange, "Invalid range spec #{range_spec} (start and end are flipped)" if ends_at < starts_at
+        starts_at..ends_at
+      when RANGE_FROM # From byte N to the end
+        starts_at = $1.to_i
+        raise InvalidRange, "Invalid range spec (starts too far in the resource) #{range_spec}" if starts_at >= size
+        starts_at..(size - 1)
+      when RANGE_LAST_N # The last N bytes
+        last_n = $1.to_i
+        raise InvalidRange, "Invalid range spec #{range_spec} (resource too small)" if last_n > size
+        
+        starts_at = size - last_n
+        ends_at = size - 1
+        raise InvalidRange, "Invalid range spec #{range_spec} (flipped negative)" if starts_at >= size
+        starts_at..ends_at
+      else
+        raise InvalidRange, "Invalid range spec #{range_spec} (unparseable)"
+      end
+    end
+  end
+  
+  # Ported from webrick
+  def split_header_value(str)
+    str.scan(%r'\G((?:"(?:\.|[^"])+?"|[^",]+)+)
+                  (?:,\s*|\Z)'xn).flatten
+  end
+end

data/lib/range_header_parser/version.rb

@@ -0,0 +1,3 @@
+module RangeHeaderParser
+  VERSION = '1.0.0'
+end

data/range_header_parser.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: range_header_parser 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "range_header_parser"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2016-05-18"
+  s.description = "Parses Range HTTP headers for specific fetches"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "authorization_header_parser.gemspec",
+    "lib/range_header_parser.rb",
+    "lib/range_header_parser/version.rb",
+    "range_header_parser.gemspec",
+    "spec/range_header_parser_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/wetransfer/range_header_parser"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "with range splicing and proper offsets"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<range_utils>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<range_utils>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 3"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<range_utils>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/spec/range_header_parser_spec.rb

@@ -0,0 +1,119 @@
+require_relative 'spec_helper'
+
+describe RangeHeaderParser do
+  it 'parses the various versions correctly and splices overlapping/adjacent byte ranges' do
+    size = 10000
+    expect(described_class.parse('bytes=0-499', 10000)).to eq([0..499])
+    expect(described_class.parse('bytes=500-999', 10000)).to eq([500..999])
+      
+    expect(described_class.parse('bytes=-500', 10000)).to eq([9500..9999])
+    expect(described_class.parse('bytes=9500-', 10000)).to eq([9500..9999])
+    
+    expect(described_class.parse('bytes=500-520,601-999', 10000)).to eq([500..520, 601..999])
+    
+    expect(described_class.parse('bytes=500-600,601-999', 10000)).to eq([500..999])
+    expect(described_class.parse('bytes=601-999,500-600', 10000)).to eq([500..999])
+    expect(described_class.parse('bytes=500-700,601-999', 10000)).to eq([500..999])
+    
+    expect(described_class.parse('bytes=500-600,1000-1024,601-999', 10000)).to eq([500..1024])
+  end
+  
+  it 'bails when encountering nonsensical ranges' do
+    expect {
+      described_class.parse('bytes=-1--13', 1)
+    }.to raise_error(described_class::InvalidRange, 'Invalid range spec -1--13 (unparseable)')
+    
+    expect {
+      described_class.parse('bytes=1-13', 1)
+    }.to raise_error(described_class::InvalidRange, 'Invalid range spec  1-13 (starts too far in the resource)')
+    
+    expect {
+      described_class.parse('bytes=-999999', 1)
+    }.to raise_error(described_class::InvalidRange, 'Invalid range spec -999999 (resource too small)')
+    
+    expect {
+      described_class.parse('bytes=12345-12', 999999)
+    }.to raise_error(described_class::InvalidRange, 'Invalid range spec 12345-12 (start and end are flipped)')
+  end
+  
+  it 'handles examples from the RFC 2616' do
+    # https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.1
+    # Examples of byte-ranges-specifier values (assuming an entity-body of length 10000):
+    size = 10000
+    
+    # The first 500 bytes (byte offsets 0-499, inclusive):
+    parsed_ranges = described_class.parse('bytes=0-499', size)
+    expect(parsed_ranges).to be_one
+    range = parsed_ranges.first
+    expect(range.to_a.length).to eq(500)
+    expect(range).to eq(0..499)
+    
+    # The second 500 bytes (byte offsets 500-999, inclusive):
+    parsed_ranges = described_class.parse('bytes=500-999', size)
+    expect(parsed_ranges).to be_one
+    range = parsed_ranges.first
+    expect(range.to_a.length).to eq(500)
+    expect(range).to eq(500..999)
+    
+    # The final 500 bytes (byte offsets 9500-9999, inclusive):
+    range = described_class.parse('bytes=-500', size).first
+    expect(range.to_a.length).to eq(500)
+    expect(range).to eq(9500..9999)
+    range = described_class.parse('bytes=9500-', size).first
+    expect(range.to_a.length).to eq(500)
+    expect(range).to eq(9500..9999)
+    
+    # The first and last bytes only (bytes 0 and 9999):
+    a, b = described_class.parse('bytes=0-0,-1', size)
+    expect(a).to eq(0..0)
+    expect(b).to eq(9999..9999)
+    
+    # Several legal but not canonical specifications of the second 500
+    # bytes (byte offsets 500-999, inclusive):
+    %w( bytes=500-600,601-999 bytes=500-700,601-999).each do |bytespec|
+      ranges = described_class.parse(bytespec, size)
+      expect(ranges).to be_one
+      range = ranges.first
+      expect(range).to eq(500..999)
+    end
+  end
+  
+  it 'clamps ranges' do
+    size = 100
+    expect(described_class.parse('bytes=0-499', size)).to eq([0..99])
+  end
+  
+  it 'bails on invalid headers' do
+    %w(
+      tingies=100-200
+      100-200
+      not-a-header-value-at-all
+    ).each do | garbage |
+      expect {
+        described_class.parse(garbage, 10000)
+      }.to raise_error(described_class::InvalidHeader, /#{Regexp.escape(garbage)}/)
+    end
+  end
+  
+  it 'bails on negative ranges' do
+    %w(
+      bytes=3-0
+    ).each do | garbage |
+      expect {
+        described_class.parse(garbage, 10000)
+      }.to raise_error(described_class::InvalidRange)
+    end
+  end
+  
+  it 'bails on invalid ranges' do
+    %w(
+      bytes=-
+      bytes=more
+      bytes=more-and-more
+    ).each do | garbage |
+      expect {
+        described_class.parse(garbage, 10000)
+      }.to raise_error(described_class::InvalidRange)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'range_header_parser'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: range_header_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: range_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Parses Range HTTP headers for specific fetches
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- authorization_header_parser.gemspec
+- lib/range_header_parser.rb
+- lib/range_header_parser/version.rb
+- range_header_parser.gemspec
+- spec/range_header_parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/wetransfer/range_header_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: with range splicing and proper offsets
+test_files: []