JOCHLSDownloader 0.0.4 → 0.0.5

data/lib/JOCHLSDownloader.rb

@@ -1,9 +1,7 @@
 #file: JOCHLSDownloader.rb
-
 # CJOCHLSDownloader -- Downloads all HLS data from a URL
 # Copyright (c) 2014 Jordi Cenzano (www.jordicenzano.name)
 
-
 #Checked with ruby 1.9.3 perhaps it works with lower versions
 if RUBY_VERSION < "1.9.3"
   fail "JOCHLSDownloader requires ruby >= 1.9.3."
@@ -52,6 +50,10 @@ class CJOCHLSDownloader
 
 private
 
+  #Download a m3u8 file and call to parse function
+  # @param domain [String] Source domain to download m3u8 file
+  # @param url [String] Source url path to download m3u8 file
+  # @param basedir [String] local filesystem path to save the downloaded files
   def downloadHLS (domain, url, basedir)
     Log Logger::DEBUG, "downloadHLS domain: #{domain}, URL: #{url}, basedir: #{basedir}"
 
@@ -82,6 +84,11 @@ private
     end
   end
 
+  #Parse a m3u8 file
+  # @param file [String] path to donwloaded m3u8 to parse
+  # @param domain [String] Source domain of downloaded m3u8 file
+  # @param url [String] Source url path to downloaded m3u8 file
+  # @param basedir [String] local filesystem path to save the downloaded files
   def parsem3u8 (file, domain, url, basedir)
 
     File.open( file ).each do |line|
@@ -110,6 +117,9 @@ private
     end
   end
 
+  #Send a log to file or to stderr
+  # @param type type of log
+  # @param message [String] log message
   def Log (type, message)
 
     #To test

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: JOCHLSDownloader
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors: