rstreamor 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2917bc3f4ceb7e49d8bf2ce9a8a8a784800261e
-  data.tar.gz: bdaab2583015a8f27ccf380153131fd63292e19c
+  metadata.gz: a114369ba9a80a9fee20d8aca564c850c072fab9
+  data.tar.gz: d210db8229bd6674e5986ed0af1725a7a56978d2
 SHA512:
-  metadata.gz: 68af7208404956aa3790a5b348b2b1c64cb3110e8b1c4c0b56f3777b08166a1fb135a091669d87215b1e48b55fb8229c24fce12552a997d4decb7c7836bf9d61
-  data.tar.gz: 125a769788b7ce6018e6088aca988dc83df98d3a3045c4aca94f08aed404b9751ef7f7d3651af02f0fa9eae89f3c61873cf4a9750f462c7f7d95d3eeaba1e4ac
+  metadata.gz: ec343f4bebd927818fbc4818b7077ab99aaf05479d481c5f33e5fba0394d9f5c1bd55835144b4809caa5251bab63a3016ae425c4c1995099bb5df8964d053105
+  data.tar.gz: 8f5e8a1814c84547e62f2c2bb2fd85207055365b7eb23991d218b16faa2dc883a928d90e71c015c2bbd4b4434ff25983446e3b394b75cdb2e997bb8cecfa3b4f

data/README.md

@@ -1,30 +1,36 @@
 # Rstreamor
-Development in progress...
+Stream your data using HTTP/1.1 range requests and partial responses.
 
 # Get Rstreamor
 ###### Directly from GitHub
 ```ruby
-gem 'regressor', git: 'https://github.com/ndea/rstreamor.git', branch: 'master'
+gem 'rstreamor', git: 'https://github.com/ndea/rstreamor.git', branch: 'master'
 ```
 ###### Rubygems
+```ruby
+gem 'rstreamor', '~> 0.2.1'
+```
 # Install
 ```ruby
 bundle install
 ```
 # Usage
-Given you have a controller with a streaming action (here it's the show  action) simply use following code:
+In combination with Carrierwave
+```ruby
+class Profile < ActiveRecord::Base
+    mount_uploader :image_file, ProfileImageUploader
+end
+```
 ```ruby
 class VideosController < ApplicationController
     include Rstreamor
     def show
-        stream @resource.file
+        stream @resource.image_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:
+If you dont use Carrierwave as a file make sure your file method has the following methods defined:
 - #data
 - #content_type
 
@@ -35,7 +41,42 @@ Byte serving is the process of sending only a portion of an HTTP/1.1 message fro
 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
+Example of the request - response flow
+Consider simple HTML5 video streaming.
+```html
+<video width="320" height="240" controls>
+  		<source src="http://..." type="video/mp4">
+		Your browser does not support the video tag.
+</video>
+```
+The first request fired by the client contains the following header
+```bash
+Range:bytes=0-
+```
+and requests the whole file from the server starting from 0 till end. The server then responds with the following headers
+```bash
+Accept-Ranges:bytes
+Cache-Control:no-cache
+Content-Disposition:inline
+Content-Length:6642801
+Content-Range:bytes 0-6642800/6642801
+Content-Transfer-Encoding:binary
+Content-Type:application/mp4
+```
+Now let's skip through our video and seek for a certain scene - the client now sends the following request header
+```bash 
+Range:bytes=3303604-
+```
+And the server responds with the following response headers
+```bash 
+Accept-Ranges:bytes
+Cache-Control:no-cache
+Content-Disposition:inline
+Content-Length:3339197
+Content-Range:bytes 3303604-6642800/6642801
+Content-Transfer-Encoding:binary
+Content-Type:application/mp4
+```
 # Contributing
 
 1. Fork it ( https://github.com/ndea/regressor/fork )

data/lib/rstreamor/file.rb

@@ -7,7 +7,11 @@ module Rstreamor
     end
 
     def data
-      self.file.data
+      if self.file.respond_to? :data
+        self.file.data
+      else
+        self.file.read
+      end
     end
 
     def content_type

data/lib/rstreamor/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rstreamor
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Erwin Schens