hydra_hls 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9236d95b23d74bf963df893cb8b90281fd403f9c
-  data.tar.gz: f1a176a698a89323d4ac0bb258cf858b6c698c32
+  metadata.gz: e89e7ba3df570de007f02cec74f4062228d71ac9
+  data.tar.gz: 9fe646b3d44d966870fe0f6eef44ecf8aa300087
 SHA512:
-  metadata.gz: d648c21a5ab319268f2a364e504d530e0947da7ccfd59ae04a30bafe88da669af5e84b93fe9f2409eda36ba375d58d837dcc025c563715ce6a760fbb17d5bdaa
-  data.tar.gz: acf0dfb58e9ff1b0ab22d820f6e9606d38f4c8ef93ab76985bc0ea7c0be1a9cc036686a7b0a58f4bc999f70b629128bbbd1e955fb89602f62929861ec7cbbc10
+  metadata.gz: 310c0568b99d3bb6da7ce59444dfb09368c8581e4903ab5441e8a61af9b597ccf585b02b76cd14dd40d42d12abbe93885269b9785da3a3edc760af9285131770
+  data.tar.gz: 31c46697adddffb92b19f13bca01122765064fecd299e8bfa3ce14cd062199868dd6e0ff9f56828bd0023b0a12f55f4a98a93a47d6fab4787e01a7cd2b94177f

data/README.md

@@ -5,15 +5,15 @@ This gem allows a hydra application to create hls derivative media files automat
 
 ## Motivation
 
-Hydra is a promising framework for digital asset management. One Hydra based application - [https://github.com/avalonmediasystem](Avalon Media System) - has relatively robust support for multimedia streaming. However, Avalon is not nearly as flexible or feature rich as [](Sufia) (another Hydra "head") as an asset management system. Avalon also relies on a clunky party transcoding service (Matterhorn) and external streaming server (Red5 or Wowza), creating an unweildly application stack. We wanted the streaming power and flexiblity promised by Avalon, in a mature and flexible asset management system like Sufia. This gem aims to integrate all of the benefits of adaptive bitrate streaming into Sufia's existing simple, efficient system for creating multimedia derivative files. 
+Hydra is a promising digital asset management solution with a growign feature set, and we wanted to use as a streaming media service for audiovisual collections. One Hydra based application - [Avalon Media System](https://github.com/avalonmediasystem) - is designed specifically to support multimedia streaming. However, Avalon is not nearly as flexible or well developed as [Sufia](https://github.com/projecthydra/sufia) (another Hydra "head") as an asset management system, and its developer community is relatively small. Avalon also relies on a clunky party transcoding service (Matterhorn) and external streaming server (Red5 or Wowza), creating an unweildly and bug-pronesoftware stack. We wanted the streaming power and flexiblity promised by Avalon, in a more flexible and feature-rich asset management system like Sufia. This gem aims to integrate all of the benefits of adaptive bitrate streaming into Sufia's existing simple, efficient system for creating multimedia derivative files. 
 
-## Security
+## Security & tokens
 
-Streaming media presents a challenge in balancing speed with security. Media streaming requires many requests to a server, each for a small peice of the media file being played. Each of these requests must be individually authenticated to prevent access by unauthorized users. Our Rails app requires full control over which users are authorized to view which files. If we load our whole Rails app for each media request we put a big load on our server and ruin our streaming media performance. On the other hand, if we don't authenticate requests for media segments (avalon doesn't) we risk people linking directly to those segments and bypassing our authorization system entirely.
+This software is not a DRM solution. We do not claim or intend to offer protection against authorized clients storing streamed media and then using it in undesired ways. We only seek to limit streaming from our servers to authorized clients.
 
-Instead, my Rails engine uses signed tokens which grant direct access to a specific file's media segments for a specified period of time. When an authorized client requests a media segment, the token is authenticated by a lightweight external script which does not need to load the entire Rails app. If a malicious client tries to link to this segment file, the link will break quickly when the token expires.
+Streaming media presents a challenge in balancing speed with security. Media streaming requires many requests to a server, each for a small segment of the media file being played. Each of these requests must be individually authenticated to prevent access by unauthorized users. We want to give our Rails app full control over which users are authorized to view which files - but if we load our whole Rails app for each media request, we put a big load on the server and ruin our streaming media performance. On the other hand, if we don't authenticate requests for media segments (Avalon doesn't) we risk people creating their own playlist files linking directly to those segments and bypassing our authorization system entirely.
 
-This software is not a DRM solution. We do not claim or intend to offer protection against authorized clients storing streamed media locally and then using it in undesired ways. We only seek to limit streaming from our servers to unauthorized clients.
+Instead, my Rails engine uses signed tokens (using a SHA-256 hash and secret key) which grant direct access to a specific file's media segments for a specified period of time. When an authorized client requests a media segment, the token is authenticated by a lightweight external script which does not need to load the entire Rails app. If a malicious client tries to link to this segment file, the link will break quickly when the token expires.
 
 ## Requirements
 

data/app/models/concerns/hydra_hls/file_set_behavior.rb

@@ -100,7 +100,7 @@ module HydraHls
     end
 
     def hls_config
-      @hls_config ||= YAML.load_file(Rails.root.join('config','transcoding.yml'))
+      @hls_config ||= YAML.load_file(Rails.root.join('config','hls.yml'))
     end
 
     def segment_playlist_path format

data/lib/generators/hydra_hls/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs hydra_hls into your rails application.
+      * adds the routes to playlist files
+      * adds hls derivative file creation
+      * installs new viewer for adaptive streaming display
+
+Example:
+    rails generate hydra_hls:install

data/lib/generators/hydra_hls/{install_generator.rb → install/install_generator.rb}

@@ -1,6 +1,6 @@
 require 'rails/generators'
-class Qa::InstallGenerator < Rails::Generators::Base
-  source_root File.expand_path('./templates', __FILE__)
+class HydraHls::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
 
   def inject_routes
     insert_into_file "config/routes.rb", :after => ".draw do" do
@@ -16,7 +16,7 @@ class Qa::InstallGenerator < Rails::Generators::Base
   end
 
   def copy_transcoding_config
-    copy_file "config/transcoding.yml.example", "config/transcoding.yml"
+    copy_file "config/hls.yml.example", "config/hls.yml"
   end
 
   def copy_file_sets_controller

data/lib/hydra_hls/derivatives/processors/audio.rb

@@ -22,7 +22,7 @@ module HydraHls::Derivatives::Processors
     private
 
     def get_hls_options(format)
-      config = YAML.load_file(Rails.root.join('config','transcoding.yml'))["audio"]
+      config = YAML.load_file(Rails.root.join('config','hls.yml'))["audio"]
       config["default"].merge(config[format])
     end
 

data/lib/hydra_hls/derivatives/processors/video.rb

@@ -22,7 +22,7 @@ module HydraHls::Derivatives::Processors
     private
 
     def get_hls_options(format)
-      config = YAML.load_file(Rails.root.join('config','transcoding.yml'))["video"]
+      config = YAML.load_file(Rails.root.join('config','hls.yml'))["video"]
       config["default"].merge(config[format])
     end
     

data/lib/hydra_hls/version.rb

@@ -1,3 +1,3 @@
 module HydraHls
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra_hls
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ned Henry, UCSC Library Digital Initiatives
@@ -45,12 +45,12 @@ files:
 - app/views/curation_concerns/file_sets/embed.html.erb
 - app/views/curation_concerns/file_sets/media_display/_audio_hls.html.erb
 - app/views/curation_concerns/file_sets/media_display/_video_hls.html.erb
+- config/hls.yml
 - config/routes.rb
-- config/transcoding.yml
-- lib/generators/hydra_hls/install_generator.rb
-- lib/generators/hydra_hls/templates/config/transcoding.yml
-- lib/generators/hydra_hls/templates/config/transcoding.yml.example
-- lib/generators/hydra_hls/templates/controllers/file_sets_controller.rb
+- lib/generators/hydra_hls/install/USAGE
+- lib/generators/hydra_hls/install/install_generator.rb
+- lib/generators/hydra_hls/install/templates/config/hls.yml.example
+- lib/generators/hydra_hls/install/templates/controllers/file_sets_controller.rb
 - lib/hydra_hls.rb
 - lib/hydra_hls/derivatives.rb
 - lib/hydra_hls/derivatives/audio_derivatives.rb

data/lib/generators/hydra_hls/templates/config/transcoding.yml

@@ -1,50 +0,0 @@
----
-token_secret: <%= ENV["hls_token_secret"] %>
-video:
-     hls_high:
-          bitrate: 6500000 
-          maxrate: 6800000 
-          vf: "scale=1280:-2"
-          resolution: "1280x720"
-     hls_med:
-          bitrate: 3500000
-          maxrate: 3600000 
-          vf: "scale=960:-2"
-          resolution: "960x540"
-     hls_low:
-          r: 15 
-          profile_v: baseline 
-          level: 3.0 
-          bitrate: 400000 
-          maxrate: 420000 
-          g: 45 
-          segment_list_type: m3u8 
-          vf: "scale=480:-2"
-          codec_code: "mp4a.40.2,avc1.42001e"
-          resolution: "480x360"
-     default:
-          r: 29.97 
-          pix_fmt: yuv420p 
-          vcodec: libx264
-          acodec: aac
-          profile_v: main 
-          level: 3.1 
-          codec_code: "mp4a.40.2,avc1.4d001f"
-          segment_time: 9
-          g: 90
-          vf: "scale=960:-2" 
-audio:
-     hls_hd:
-          bitrate: 128000
-          maxrate: 140000
-     hls:
-          bitrate: 64000
-          maxrate: 70000
-     default:
-          acodec: aac
-          flags: "-f segment -global_header" 
-          segment_time: 9
-          segment_format: mpeg_ts 
-          segment_list_type: m3u8 
-          codec_code: "mp4a.40.2"
-          resolution: 300x50