viddl-rb 0.72 → 0.73

data/README.md

@@ -1,4 +1,4 @@
-__viddl-rb:__  
+__viddl-rb:__ 
 Initially created by Marc Seeger (@rb2k)  
 Repo: http://github.com/rb2k/viddl-rb  
 [![Build Status](https://secure.travis-ci.org/rb2k/viddl-rb.png)](http://travis-ci.org/rb2k/viddl-rb) [![Dependency Status](https://gemnasium.com/rb2k/viddl-rb.png)](https://gemnasium.com/rb2k/viddl-rb)
@@ -7,21 +7,31 @@ __Installation:__
 
 gem install viddl-rb
 
-__Usage:__  
+__Usage:__
 
 Download a video:  
     viddl-rb http://www.youtube.com/watch?v=QH2-TGUlwu4
 
+Viddl-rb supports the following command line options:
+```
+-e, --extract-audio              Save video audio to file
+-u, --url-only                   Prints url without downloading
+-t, --title-only                 Prints title without downloading
+-f, --filter REGEX               Filters a video playlist according to the regex (Youtube only right now)
+-s, --save-dir DIRECTORY         Specifies the directory where videos should be saved
+-h, --help                       Displays the help screen
+```
+
 Download a video and extract the audio:  
     viddl-rb http://www.youtube.com/watch?v=QH2-TGUlwu4 --extract-audio 
 
 In both cases we'll name the output file according to the video title.
 
 Setting the video save directory:  
-    viddl-rb http://vimeo.com/38372260 --save-dir=C:/myvideos
+    viddl-rb http://vimeo.com/38372260 --save-dir C:/myvideos
 
 The --save-dir option works with both absolute and relative paths (relative based on the directory viddl-rb is run from).
-If you want to save to a folder with spaces in it, you have to quote the path like this: --save-dir="C:/my videos"
+If you want to save to a folder with spaces in it, you have to quote the path like this: --save-dir "C:/my videos"
 
 __Youtube plugin specifics:__  
 
@@ -32,10 +42,10 @@ Download all videos from a user:
     viddl-rb http://www.youtube.com/user/tedtalksdirector
 
 Filter videos to download from a user/playlist:  
-    viddl-rb http://www.youtube.com/user/tedtalksdirector --filter=internet/i
+    viddl-rb http://www.youtube.com/user/tedtalksdirector --filter /internet/i
 
 The --filter argument accepts a regular expression and will only download videos where the title matches the regex.
-The /i option does a case-insensitive search.
+It uses the same syntax as Ruby regular expression literals do.
 
 __Library Usage:__
 

data/bin/helper/downloader.rb

@@ -13,7 +13,7 @@ class Downloader
         raise DownloadFailedError, "Download for #{name} failed."
       else
         puts "Download for #{name} successful."
-        AudioHelper.extract(name) if params[:extract_audio]
+        ViddlRb::AudioHelper.extract(name, params[:save_dir]) if params[:extract_audio]
       end
     end
   end

data/bin/helper/parameter-parser.rb

@@ -1,67 +1,84 @@
 
 # ParameterParser parses the program parameters.
 # If the parameters are not valid in some way an exception is raised.
+# The exceptions raised by this class are handeled in the bin program.
+
 class ParameterParser
 
   DEFAULT_SAVE_DIR = "."
 
   #returns a hash with the parameters in it:
-  # :url            => the video url
-  # :extract_audio  => should attempt to extract audio? (true/false)
-  # :url_only       => do not download, only print the urls to stdout
-  # :title_only     => do not download, only print the titles to stdout
-  # :youtube_filer  => a regular expression used ot fileter youtube playlists
-  # :save_dir       => the directory where the videos are saved
-  def self.parse_app_parameters
-    check_valid_parameters!
+  # :url              => the video url
+  # :extract_audio    => should attempt to extract audio? (true/false)
+  # :url_only         => do not download, only print the urls to stdout
+  # :title_only       => do not download, only print the titles to stdout
+  # :playlist_filter  => a regular expression used to filter playlists
+  # :save_dir         => the directory where the videos are saved
+  def self.parse_app_parameters(args)
 
-    params = {}
-    params[:url] = ARGV.first
-    params[:extract_audio] = ARGV.include?("--extract-audio")
-    params[:url_only] = ARGV.include?("--url-only")
-    params[:title_only] = ARGV.include?("--title-only")
-    params[:playlist_filter] = get_youtube_filter
-    params[:save_dir] = get_save_dir  
-    params
-  end
+    # Default option values are set here
+    options = {
+      :extract_audio    => false,
+      :url_only         => false,
+      :title_only       => false,
+      :playlist_filter  => nil,
+      :save_dir         => DEFAULT_SAVE_DIR
+    }
 
-  #check if parameters are valid.
-  #the exceptions raised by this method are caught by the viddl-rb bin utility.
-  def self.check_valid_parameters!
-    if ARGV.empty?
-      raise "Usage: viddl-rb URL [--extract-audio]"
-    elsif !ARGV.first.match(/^http/)
-      raise "ERROR: Please include 'http' with your URL e.g. http://www.youtube.com/watch?v=QH2-TGUlwu4"
-    elsif ARGV.include?("--extract-audio") && !DownloadHelper.os_has?("ffmpeg")
-      raise "ERROR: To extract audio you need to have ffmpeg on your system"
-    end
-  end
+    optparse = OptionParser.new do |opts|
+      opts.banner = "Usage: viddl-rb URL [options]"
+
+      opts.on("-e", "--extract-audio", "Save video audio to file") do
+        if ViddlRb::UtilityHelper.os_has?("ffmpeg")
+          options[:extract_audio] = true
+        else
+          raise OptionParser::ParseError.new("to extract audio you need to have ffmpeg on your PATH")
+        end
+      end
+
+      opts.on("-u", "--url-only", "Prints url without downloading") do
+        options[:url_only] = true
+      end
 
-  #gets the regular expression used to filter youtube playlists.
-  def self.get_youtube_filter
-    filter = ARGV.find { |arg| arg =~ /--filter=./ }  # --filter= and at least one more character
-    return nil unless filter
+      opts.on("-t", "--title-only", "Prints title without downloading") do
+        options[:title_only] = true
+      end
 
-    ignore_case = filter.include?("/i")
-    regex = filter[/--filter=(.*?)(?:\/|$)/, 1]   # everything up to the first / (could be an empty string)
-    raise "ERROR: '#{regex}' is not a valid regular expression" unless is_valid_regex?(regex)
-    Regexp.new(regex, ignore_case)
+      opts.on("-f", "--filter REGEX", Regexp, "Filters a video playlist according to the regex") do |regex|
+        options[:filter] = regex
+      end
+
+      opts.on("-s", "--save-dir DIRECTORY", "Specifies the directory where videos should be saved") do |dir|
+        if File.directory?(dir)
+          options[:save_dir] = dir
+        else
+          raise OptionParser::InvalidArgument.new("'#{dir}' is not a valid directory")
+        end
+      end
+
+      opts.on_tail('-h', '--help', 'Display this screen') do
+        print_help_and_exit(opts)
+      end
+    end
+
+    optparse.parse!(args)                           # removes all options from args
+    print_help_and_exit(optparse) if args.empty?    # exit if no video url
+    url = validate_url(args.first)                  # the url is the only element left
+    options[:url] = url                     
+    options
   end
 
-  #checks if the string is a valid regex (for example "*****" is not)
-  def self.is_valid_regex?(regex)
-    Regexp.compile(regex)
-  rescue RegexpError
-    false
+  def self.print_help_and_exit(opts)
+    puts opts
+    exit(0)
   end
-  
-  #gets the directory used for saving videos in.
-  def self.get_save_dir
-    save_dir = ARGV.find { |arg| arg =~ /--save-dir=./ }
-    return DEFAULT_SAVE_DIR unless save_dir
 
-    dir = save_dir[/--save-dir=(.+)/, 1]
-    raise "ERROR: '#{dir}' is not a valid directory or does not exist" unless File.directory?(dir)
-    dir
+  def self.validate_url(url)
+    if url =~ /^http/
+      url
+    else
+      raise OptionParser::InvalidArgument.new(
+        "please include 'http' with your URL e.g. http://www.youtube.com/watch?v=QH2-TGUlwu4")
+    end
   end
 end

data/bin/viddl-rb

@@ -8,6 +8,7 @@ require "mechanize"
 require "cgi"
 require "open-uri"
 require "open3"
+require "optparse"
 
 require "driver.rb"
 require "downloader.rb"
@@ -20,7 +21,7 @@ require "utility-helper.rb"
 begin
   # params is a hash with keys for each of the parameters passed in.
   # see helper/parameter-parser.rb for what those keys are.
-  params = ParameterParser.parse_app_parameters
+  params = ParameterParser.parse_app_parameters(ARGV)
 
   puts "Loading Plugins"
   ViddlRb::UtilityHelper.load_plugins
@@ -32,8 +33,13 @@ begin
   app = Driver.new(params)   
   app.start                  # starts the download process
 
+rescue OptionParser::ParseError => e
+  puts "Error: #{e.message}"
+  exit(1)
+
 rescue StandardError => e
-  puts "#{e.message}"
+  puts "Error: #{e.message}"
+  puts "\nBacktrace:"
+  puts e.backtrace
   exit(1)
 end
-

data/helper/audio-helper.rb

@@ -3,7 +3,7 @@ module ViddlRb
   # This class is responsible for extracting audio from video files using ffmpeg.
   class AudioHelper
 
-    def self.extract(file_path)
+    def self.extract(file_path, save_dir)
       no_ext_filename = file_path.split('.')[0..-1][0]
       #capture stderr because ffmpeg expects an output param and will error out
       puts "Gathering information about the downloaded file."
@@ -32,7 +32,7 @@ module ViddlRb
           puts "Unknown audio format: #{audio_format}, using name as extension: '.#{audio_format}'."
           output_extension = audio_format
         end
-        output_filename = "#{no_ext_filename}.#{output_extension}"
+        output_filename = File.join(save_dir, "#{no_ext_filename}.#{output_extension}")
         if File.exist?(output_filename)
           puts "Audio file seems to exist already, removing it before extraction."
           File.delete(output_filename)
@@ -46,4 +46,3 @@ module ViddlRb
   end
 
 end
-

data/helper/download-helper.rb

@@ -29,12 +29,11 @@ module ViddlRb
       file_path = File.expand_path(File.join(save_dir, file_name))
       #Some providers seem to flake out every now end then
       amount_of_retries.times do |i|
-        if os_has?("wget")
+        if UtilityHelper.os_has?("wget")
           puts "using wget"
           `wget \"#{file_uri}\" -O #{file_path.inspect}`
-        elsif os_has?("curl")
+        elsif UtilityHelper.os_has?("curl")
           puts "using curl"
-          #require "pry"; binding.pry; exit
           #-L means: follow redirects, We set an agent because Vimeo seems to want one
           `curl -A 'Wget/1.8.1' --retry 10 --retry-delay 5 --retry-max-time 4  -L \"#{file_uri}\" -o #{file_path.inspect}`
         else
@@ -54,33 +53,5 @@ module ViddlRb
       $? == 0
     end
 
-    #checks to see whether the os has a certain utility like wget or curl
-    #`` returns the standard output of the process
-    #system returns the exit code of the process
-    def self.os_has?(utility)
-      windows = ENV['OS'] =~ /windows/i
-
-      unless windows # if os is not Windows
-        `which #{utility}`.include?(utility)
-      else
-        if has_where?
-          system("where /q #{utility}")   #/q is the quiet mode flag
-        else
-          begin   #as a fallback we just run the utility itself
-            system(utility)
-          rescue Errno::ENOENT
-            false
-          end
-        end
-      end
-    end
-
-    #checks if Windows has the where utility (Server 2003 and later)
-    #system only return nil if the command is not found
-    def self.has_where?
-      !system("where /q where").nil?
-    end
   end
-
 end
-

data/helper/utility-helper.rb

@@ -10,7 +10,27 @@ module ViddlRb
         ViddlRb.class_eval(File.read(plugin))
       end
     end
-  end
 
-end
+    #checks to see whether the os has a certain utility like wget or curl
+    #`` returns the standard output of the process
+    #system returns the exit code of the process
+    def self.os_has?(utility)
+      windows = ENV['OS'] =~ /windows/i
 
+      unless windows
+        `which #{utility}`.include?(utility)
+      else
+        if !system("where /q where").nil?   #if Windows has the where utility
+          system("where /q #{utility}")     #/q is the quiet mode flag
+        else
+          begin                             #as a fallback we just run the utility itself
+            system(utility)
+          rescue Errno::ENOENT
+            false
+          end
+        end
+      end
+    end
+    
+  end
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: viddl-rb
 version: !ruby/object:Gem::Version 
-  hash: 155
+  hash: 153
   prerelease: 
   segments: 
   - 0
-  - 72
-  version: "0.72"
+  - 73
+  version: "0.73"
 platform: ruby
 authors: 
 - Marc Seeger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-03 00:00:00 +02:00
+date: 2012-10-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,7 +112,6 @@ files:
 - plugins/veoh.rb
 - plugins/vimeo.rb
 - plugins/youtube.rb
-- CHANGELOG.txt
 - Gemfile
 - Gemfile.lock
 - Rakefile

data/CHANGELOG.txt

@@ -1,14 +0,0 @@
-=== 0.6
-* Soundcloud support
-* Removed megavideo plugin
-
-=== 0.4.x
-* New Features
-  * Use wget or curl (if present)
-
-* Bugfixes
-  * Fixed Vimeo Plugin
-
-=== 0.3
-* New Features
-  * added megavideo plugin