rstreamor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2917bc3f4ceb7e49d8bf2ce9a8a8a784800261e
+  data.tar.gz: bdaab2583015a8f27ccf380153131fd63292e19c
+SHA512:
+  metadata.gz: 68af7208404956aa3790a5b348b2b1c64cb3110e8b1c4c0b56f3777b08166a1fb135a091669d87215b1e48b55fb8229c24fce12552a997d4decb7c7836bf9d61
+  data.tar.gz: 125a769788b7ce6018e6088aca988dc83df98d3a3045c4aca94f08aed404b9751ef7f7d3651af02f0fa9eae89f3c61873cf4a9750f462c7f7d95d3eeaba1e4ac

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,45 @@
+# Rstreamor
+Development in progress...
+
+# Get Rstreamor
+###### Directly from GitHub
+```ruby
+gem 'regressor', git: 'https://github.com/ndea/rstreamor.git', branch: 'master'
+```
+###### Rubygems
+# Install
+```ruby
+bundle install
+```
+# Usage
+Given you have a controller with a streaming action (here it's the show  action) simply use following code:
+```ruby
+class VideosController < ApplicationController
+    include Rstreamor
+    def show
+        stream @resource.file
+    end
+end
+```
+Please note that the file method of @resource is a mounted uploader of carrierwave.
+
+Rstreamor takes care of the rest. 
+If you dont use Carrierwave as a file make sure your file has the following methods:
+- #data
+- #content_type
+
+# What is a range request?
+Byte serving is the process of sending only a portion of an HTTP/1.1 message from a server to a client. Byte serving begins when an HTTP server advertises its willingness to serve partial requests using the Accept-Ranges response header. A client then requests a specific part of a file from the server using the Range request header. If the range is valid, the server sends it to the client with a 206 Partial Content status code and a Content-Range header listing the range sent. Clients which request byte-serving might do so in cases in which a large file has been only partially delivered and a limited portion of the file is needed in a particular range. Byte Serving is therefore a method of bandwidth optimization. [Wikipedia](https://en.wikipedia.org/wiki/Byte_serving)
+
+### HTML5 video / audio streaming
+Consider you have a large video or audio file on your server which needs to be served partially to your client. You don't want to send the whole file in one response (unless you want to download the file). Instead the client needs only partial content which he can view and request other partial content if needed. Rstreamor provides this byte serving mechanism defined in HTTP/1.1.
+
+###### Example
+###### Limitations
+# Contributing
+
+1. Fork it ( https://github.com/ndea/regressor/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,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rstreamor"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rstreamor.rb

@@ -0,0 +1,8 @@
+require 'rstreamor/version'
+require 'rstreamor/file'
+require 'rstreamor/request'
+require 'rstreamor/response'
+require 'rstreamor/stream'
+module Rstreamor
+  include Rstreamor::Stream
+end

data/lib/rstreamor/file.rb

@@ -0,0 +1,22 @@
+module Rstreamor
+  class File
+    attr_accessor :file
+
+    def initialize(file)
+      self.file = file
+    end
+
+    def data
+      self.file.data
+    end
+
+    def content_type
+      self.file.content_type
+    end
+
+    def size
+      data.size
+    end
+
+  end
+end

data/lib/rstreamor/request.rb

@@ -0,0 +1,39 @@
+module Rstreamor
+  class Request
+    attr_accessor :request, :file
+
+    def initialize(request, file)
+      self.request = request
+      self.file = file
+    end
+
+    def ranges
+      self.request.headers['HTTP_RANGE'].gsub('bytes=', '').split('-')
+    end
+
+    def upper_bound
+      ranges[1] ? ranges[1].to_i : self.file.data.size
+    end
+
+    def lower_bound
+      ranges[0] ? ranges[0].to_i : 0
+    end
+
+    def range_header?
+      self.request.headers['HTTP_RANGE'].present?
+    end
+
+    def file_content_type
+      self.file.content_type
+    end
+
+    def slice_file
+      self.file.data.byteslice(lower_bound, upper_bound)
+    end
+
+    def file_size
+      self.file.size
+    end
+
+  end
+end

data/lib/rstreamor/response.rb

@@ -0,0 +1,34 @@
+module Rstreamor
+  class Response
+    attr_accessor :request
+
+    def initialize(request)
+      self.request = request
+    end
+
+    def response_code
+      self.request.range_header? ? 206 : 200
+    end
+
+    def content_length
+      if self.request.range_header?
+        (self.request.upper_bound - self.request.lower_bound).to_s
+      else
+        self.request.file.data.size
+      end
+    end
+
+    def content_range
+      "bytes #{self.request.lower_bound}-#{self.request.upper_bound - 1}/#{self.request.file.data.size}"
+    end
+
+    def accept_ranges
+      'bytes'
+    end
+
+    def cache_control
+      'no-cache'
+    end
+
+  end
+end

data/lib/rstreamor/stream.rb

@@ -0,0 +1,27 @@
+module Rstreamor
+  module Stream
+    def stream(file)
+      request_builder = Rstreamor::Request.new(request, file)
+      response_builder = Rstreamor::Response.new(request_builder)
+      set_response_header(request_builder, response_builder)
+      stream_file(request_builder, response_builder)
+    end
+
+    private
+
+    def stream_file(request_builder, response_builder)
+      content = request_builder.slice_file
+      send_data content, type: request_builder.file_content_type, disposition: 'inline', status: response_builder.response_code
+    end
+
+    def set_response_header(request_builder, response_builder)
+      response.headers['Content-Type'] = request_builder.file_content_type
+      response.headers['Content-Length'] = response_builder.content_length
+      if request_builder.range_header?
+        response.headers['Accept-Ranges'] = 'bytes'
+        response.headers['Cache-Control'] = 'no-cache'
+        response.headers['Content-Range'] = response_builder.content_range
+      end
+    end
+  end
+end

data/lib/rstreamor/version.rb

@@ -0,0 +1,3 @@
+module Rstreamor
+  VERSION = "0.2.0"
+end

data/rstreamor.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rstreamor/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'rstreamor'
+  spec.version = Rstreamor::VERSION
+  spec.authors = ['Erwin Schens']
+  spec.email = ['erwinschens@uni-koblenz.de']
+
+  spec.summary = %q{Stream files using HTTP range requests.}
+  spec.description = %q{
+                        Rstreamor gives you the power to stream your files using the HTTP range requests defined in the HTTP/1.1.
+                        Range requests are an optional feature of HTTP,
+                        designed so that recipients not implementing this feature
+                        (or not supporting it for the target resource) can respond as if
+                        it is a normal GET request without impacting interoperability.
+                         Partial responses are indicated by a distinct status code to not be mistaken for full responses by caches that might not implement the feature.
+                      }
+  spec.homepage = 'https://github.com/ndea/rstreamor'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3.0'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rstreamor
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Erwin Schens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: "\n                        Rstreamor gives you the power to stream your
+  files using the HTTP range requests defined in the HTTP/1.1.\n                        Range
+  requests are an optional feature of HTTP,\n                        designed so that
+  recipients not implementing this feature\n                        (or not supporting
+  it for the target resource) can respond as if\n                        it is a normal
+  GET request without impacting interoperability.\n                         Partial
+  responses are indicated by a distinct status code to not be mistaken for full responses
+  by caches that might not implement the feature.\n                      "
+email:
+- erwinschens@uni-koblenz.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rstreamor.rb
+- lib/rstreamor/file.rb
+- lib/rstreamor/request.rb
+- lib/rstreamor/response.rb
+- lib/rstreamor/stream.rb
+- lib/rstreamor/version.rb
+- rstreamor.gemspec
+homepage: https://github.com/ndea/rstreamor
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Stream files using HTTP range requests.
+test_files: []