http_range 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f193e3a32d1e236790886073848643050da5d0b
+  data.tar.gz: 99b3dc5188a26fb91d4bf6565cb253bf735757eb
+SHA512:
+  metadata.gz: 06330411edb69fa887cb44cec4d9168951d0db998ad90e0db0887adb987f76d6bd45895870aa4219f4ea329b283a8e27061a4838d26af68cea7f3802ef1f5fc5
+  data.tar.gz: 3ad46bb2d5c68534374b87efdb6735ed57cc7de81ef1225adc6e2ae868e6f4e973bac19116f328f0e795b0ed8a8d985573b9aa12fbc7997fcd69bb4bd99504b1

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in http_range.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brad Fults, The Last Guide Company
+
+MIT License
+
+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,44 @@
+# HTTPRange
+
+A library to parse an HTTP `Range` header with semantics similar to
+[Heroku's Range headers][1].
+
+ [1]: https://devcenter.heroku.com/articles/platform-api-reference#ranges
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'http_range'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_range
+
+## Usage
+
+```ruby
+http_range = HTTPRange.parse('Range: id 29f99177-36e9-466c-baef-f855e1ab731e..29f99177-36e9-466c-baef-f855e1ab731e[; max=100')
+
+http_range.attribute       # => "id"
+http_range.first           # => "29f99177-36e9-466c-baef-f855e1ab731e"
+http_range.last            # => "29f99177-36e9-466c-baef-f855e1ab731e"
+http_range.max             # => "100"
+http_range.order           # => nil
+http_range.first_inclusive # => true
+http_range.last_inclusive  # => false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/http_range/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/http_range.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'http_range/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'http_range'
+  spec.version       = HTTPRange::VERSION
+  spec.authors       = ["Brad Fults"]
+  spec.email         = ["bfults@gmail.com"]
+  spec.summary       = %q{Assists in parsing HTTP Range headers.}
+  spec.description   = %q{}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.1'
+end

data/lib/http_range/parser.rb

@@ -0,0 +1,95 @@
+class HTTPRange
+  class Parser
+    # Accepts the HTTP Range header string to parse.
+    #
+    def initialize(header_string)
+      @header_string = header_string.dup
+    end
+
+    # Runs the parser on its given `header_string` and returns a hash of the
+    # extracted parts.
+    #
+    # @return [Hash]
+    #
+    def extract_parts_hash
+      parts_hash = {}
+
+      @header_string.sub!(/\ARange:\s*/, '')
+
+      range_spec_string, params_strings = split_header_string(@header_string)
+
+      parts_hash.merge! extract_range_spec_hash(range_spec_string)
+      parts_hash.merge! extract_params_hash(params_strings)
+
+      return parts_hash
+    end
+
+  private
+
+    def blank?(value)
+      value.nil? || value == '' || value == false
+    end
+
+    # Takes raw params strings and returns a hash of key/value pairs.
+    #
+    # @param params_strings [Array<String>]
+    #
+    # @return [Hash<String,String>]
+    #
+    def extract_params_hash(params_strings)
+      hash = Hash[params_strings.map { |p| p.split('=').map { |v| v.strip } }]
+      hash.detect do |k, v|
+        raise MalformedRangeHeaderError, "Params key malformed."      if blank?(k)
+        raise MalformedRangeHeaderError, "Params value missing: #{k}" if blank?(v)
+        raise MalformedRangeHeaderError, "Invalid order value: #{v}"  if k == 'order' && !%w[asc desc].include?(v)
+      end
+      hash
+    end
+
+    RANGE_SPEC_REGEX = /\A
+      (?<attribute>[a-zA-Z][\w\.-]*)
+      \s+
+      (?<first_exclusive>\])?
+      (?<first>[^\.]*?)
+      \.\.
+      (?<last>[^\.]*?)
+      (?<last_exclusive>\[)?
+    \z/x
+
+    # Takes a raw range spec string (<attr> <first>..<last>) and returns a hash
+    # of key/value pairs for the extracted parts.
+    #
+    # @param range_spec_string [String]
+    #
+    # @return [Hash<String,String>]
+    #
+    def extract_range_spec_hash(range_spec_string)
+      hash   = {}
+      values = range_spec_string.match(RANGE_SPEC_REGEX)
+      if values
+        hash.merge!({
+          'attribute'       => values['attribute'],
+          'first'           => values['first'],
+          'last'            => values['last'],
+          'first_inclusive' => values['first_exclusive'].nil?,
+          'last_inclusive'  => values['last_exclusive'].nil?,
+        })
+      else
+        raise MalformedRangeHeaderError, "Invalid range spec."
+      end
+      hash
+    end
+
+    # Takes the value portion of a Range header string and splits it into the
+    # range spec and any params delimited by ;. Also strips whitespace.
+    #
+    # @param header_string [String]
+    #
+    # @return [Array<String,Array<String>>]
+    #
+    def split_header_string(header_string)
+      range_spec, *params = header_string.split(';')
+      [range_spec.strip, params.map { |s| s.strip }]
+    end
+  end
+end

data/lib/http_range/version.rb

@@ -0,0 +1,3 @@
+class HTTPRange
+  VERSION = "1.0.0"
+end

data/lib/http_range.rb

@@ -0,0 +1,24 @@
+require 'http_range/version'
+
+class HTTPRange
+
+  class MalformedRangeHeaderError < StandardError; end
+
+  attr_reader :attribute
+  attr_reader :first
+  attr_reader :last
+  attr_reader :first_inclusive
+  attr_reader :last_inclusive
+  attr_reader :order
+  attr_reader :max
+
+  def initialize(fields)
+    fields.each { |field, value| instance_variable_set(:"@#{field}", value) }
+  end
+
+  def self.parse(header_string)
+    new(Parser.new(header_string).extract_parts_hash)
+  end
+end
+
+require 'http_range/parser'

data/spec/http_range_spec.rb

@@ -0,0 +1,66 @@
+require 'http_range'
+require 'spec_helper'
+
+RSpec.describe HTTPRange do
+  describe '.parse' do
+    subject { described_class.parse(header) }
+
+    context "for a correctly formatted Range header" do
+      let(:header) { "Range: id 29f99177-36e9-466c-baef-f855e1ab731e..6c714be1-d901-4c40-adb3-22c9a8cda950[; max=100" }
+
+      it "returns an instance of the class" do
+        expect(subject).to be_an(HTTPRange)
+      end
+
+      it { expect(subject.attribute).to eq('id') }
+      it { expect(subject.first).to eq('29f99177-36e9-466c-baef-f855e1ab731e') }
+      it { expect(subject.last).to eq('6c714be1-d901-4c40-adb3-22c9a8cda950') }
+      it { expect(subject.first_inclusive).to eq(true) }
+      it { expect(subject.last_inclusive).to eq(false) }
+      it { expect(subject.max).to eq('100') }
+      it { expect(subject.order).to be_nil }
+    end
+
+    context "for a Range header with a wacky but valid attribute name" do
+      let(:header) { "Range: purple.cycle-cleaner_knob ]1e3f..2e5a; order=desc" }
+
+      it { expect(subject.attribute).to eq('purple.cycle-cleaner_knob') }
+      it { expect(subject.first).to eq('1e3f') }
+      it { expect(subject.last).to eq('2e5a') }
+      it { expect(subject.first_inclusive).to eq(false) }
+      it { expect(subject.last_inclusive).to eq(true) }
+      it { expect(subject.max).to be_nil }
+      it { expect(subject.order).to eq('desc') }
+    end
+
+    context "for a Range header with an invalid order param" do
+      let(:header) { "Range: purple.cycle-cleaner_knob ]1e3f..2e5a; order=true" }
+
+      it { expect { subject }.to raise_error(HTTPRange::MalformedRangeHeaderError) }
+    end
+
+    context "for a Range header with an invalid range spec syntax" do
+      let(:header) { "Range: id 1e3f...2e5a" }
+
+      it { expect { subject }.to raise_error(HTTPRange::MalformedRangeHeaderError) }
+    end
+
+    context "for a Range header with an invalid range attribute name" do
+      let(:header) { "Range: !!!amazing!!! 1e3f...2e5a" }
+
+      it { expect { subject }.to raise_error(HTTPRange::MalformedRangeHeaderError) }
+    end
+
+    context "for a Range header without an attribute name" do
+      let(:header) { "Range: 1..2" }
+
+      it { expect { subject }.to raise_error(HTTPRange::MalformedRangeHeaderError) }
+    end
+
+    context "for a Range header without a range" do
+      let(:header) { "Range: hi" }
+
+      it { expect { subject }.to raise_error(HTTPRange::MalformedRangeHeaderError) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec/core'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: http_range
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brad Fults
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: ''
+email:
+- bfults@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- http_range.gemspec
+- lib/http_range.rb
+- lib/http_range/parser.rb
+- lib/http_range/version.rb
+- spec/http_range_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Assists in parsing HTTP Range headers.
+test_files:
+- spec/http_range_spec.rb
+- spec/spec_helper.rb