viddl-rb 0.73 → 0.74

data/README.md

@@ -10,7 +10,7 @@ gem install viddl-rb
 __Usage:__
 
 Download a video:  
-    viddl-rb http://www.youtube.com/watch?v=QH2-TGUlwu4
+    ```viddl-rb http://www.youtube.com/watch?v=QH2-TGUlwu4```
 
 Viddl-rb supports the following command line options:
 ```
@@ -19,16 +19,17 @@ Viddl-rb supports the following command line options:
 -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
+-d, --downloader TOOL            Specifies the tool to download with. Supports 'wget', 'curl' and 'net-http'
 -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 
+    ```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"
@@ -36,13 +37,13 @@ If you want to save to a folder with spaces in it, you have to quote the path li
 __Youtube plugin specifics:__  
 
 Download all videos on a playlist:  
-    viddl-rb http://www.youtube.com/playlist?list=PL7E8DA0A515924126
+    ```viddl-rb http://www.youtube.com/playlist?list=PL7E8DA0A515924126```
 
 Download all videos from a user:  
-    viddl-rb http://www.youtube.com/user/tedtalksdirector
+    ```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.
 It uses the same syntax as Ruby regular expression literals do.

data/bin/helper/downloader.rb

@@ -8,7 +8,7 @@ class Downloader
       url = url_name[:url]
       name = url_name[:name]
 
-      result = save_file(url, name, params[:save_dir])
+      result = ViddlRb::DownloadHelper.save_file(url, name, :save_dir => params[:save_dir], :tool => params[:tool])
       unless result
         raise DownloadFailedError, "Download for #{name} failed."
       else
@@ -17,9 +17,4 @@ class Downloader
       end
     end
   end
-
-  # TODO save_dir is not used yet
-  def save_file(url, name, save_dir)
-    ViddlRb::DownloadHelper.save_file(url, name, save_dir)
-  end
 end

data/bin/helper/parameter-parser.rb

@@ -22,7 +22,8 @@ class ParameterParser
       :url_only         => false,
       :title_only       => false,
       :playlist_filter  => nil,
-      :save_dir         => DEFAULT_SAVE_DIR
+      :save_dir         => DEFAULT_SAVE_DIR,
+      :tool             => nil
     }
 
     optparse = OptionParser.new do |opts|
@@ -56,6 +57,14 @@ class ParameterParser
         end
       end
 
+      opts.on("-d", "--downloader TOOL", "Specifies the tool to download with. Supports 'wget', 'curl' and 'net-http'") do |tool|
+        if tool =~ /(^wget$)|(^curl$)|(^net-http$)/
+          options[:tool] = tool
+        else
+          raise OptionParser::InvalidArgument.new("'#{tool}' is not a valid tool.")
+        end
+      end
+
       opts.on_tail('-h', '--help', 'Display this screen') do
         print_help_and_exit(opts)
       end
@@ -63,7 +72,8 @@ class ParameterParser
 
     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
+    url = args.first                                # the url is the only element left
+    validate_url!(url)                              # raise exception if invalid url
     options[:url] = url                     
     options
   end
@@ -73,10 +83,8 @@ class ParameterParser
     exit(0)
   end
 
-  def self.validate_url(url)
-    if url =~ /^http/
-      url
-    else
+  def self.validate_url!(url)
+    unless url =~ /^http/
       raise OptionParser::InvalidArgument.new(
         "please include 'http' with your URL e.g. http://www.youtube.com/watch?v=QH2-TGUlwu4")
     end

data/bin/viddl-rb

@@ -25,7 +25,7 @@ begin
 
   puts "Loading Plugins"
   ViddlRb::UtilityHelper.load_plugins
-  "Plugins loaded: #{ViddlRb::PluginBase.registered_plugins.inspect}"
+  puts "Plugins loaded: #{ViddlRb::PluginBase.registered_plugins.inspect}"
 
   puts "Will try to extract audio: #{params[:extract_audio] == true}."
   puts "Analyzing URL: #{params[:url]}"
@@ -33,7 +33,7 @@ begin
   app = Driver.new(params)   
   app.start                  # starts the download process
 
-rescue OptionParser::ParseError => e
+rescue OptionParser::ParseError, ViddlRb::RequirementError => e
   puts "Error: #{e.message}"
   exit(1)
 

data/helper/download-helper.rb

@@ -1,57 +1,94 @@
 module ViddlRb
 
+  class RequirementError < StandardError; end
+
   class DownloadHelper
-    #usually not called directly
-    def self.fetch_file(uri)
-      begin
-        require "progressbar" #http://github.com/nex3/ruby-progressbar
-      rescue LoadError
-        puts "ERROR: You don't seem to have curl or wget on your system. In this case you'll need to install the 'progressbar' gem."
-        exit
-      end
-      progress_bar = nil 
-      open(uri, :proxy => nil,
-        :content_length_proc => lambda { |length|
-          if length && 0 < length
-            progress_bar = ProgressBar.new(uri.to_s, length)
-            progress_bar.file_transfer_mode   #to show download speed and file size
-          end 
-        },
-        :progress_proc => lambda { |progress|
-          progress_bar.set(progress) if progress_bar
-        }) {|file| return file.read}        
-    end
+
+    #viddl will use the first of these tools it finds on the system to download the video.
+    #if the system does not have any of these tools, net/http is used instead.
+    TOOLS_PRIORITY_LIST = [:wget, :curl] 
     
     #simple helper that will save a file from the web and save it with a progress bar
-    def self.save_file(file_uri, file_name, save_dir = ".", amount_of_retries = 6)
+    def self.save_file(file_url, file_name, opts = {})
       trap("SIGINT") { puts "goodbye"; exit }
 
-      file_path = File.expand_path(File.join(save_dir, file_name))
+      #default options
+      options = {:save_dir => ".", 
+                 :amount_of_retries => 6, 
+                 :tool => get_tool}
+
+      opts[:tool] = options[:tool] if opts[:tool].nil?
+      options.merge!(opts)
+
+      file_path = File.expand_path(File.join(options[:save_dir], file_name))
+      success = false
+
       #Some providers seem to flake out every now end then
-      amount_of_retries.times do |i|
-        if UtilityHelper.os_has?("wget")
-          puts "using wget"
-          `wget \"#{file_uri}\" -O #{file_path.inspect}`
-        elsif UtilityHelper.os_has?("curl")
-          puts "using curl"
+      options[:amount_of_retries].times do |i|
+        case options[:tool].to_sym
+        when :wget
+          puts "Using wget"
+          success = system "wget \"#{file_url}\" -O #{file_path.inspect}"
+        when :curl
+          puts "Using curl"
           #-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}`
+          success = system "curl -A 'Wget/1.8.1' --retry 10 --retry-delay 5 --retry-max-time 4  -L \"#{file_url}\" -o #{file_path.inspect}"
         else
-         puts "using net/http"
-          open(file_path, 'wb') { |file|          
-            file.write(fetch_file(file_uri)); puts
-          }
+          require_progressbar
+          puts "Using net/http"
+          success = download_and_save_file(file_url, file_path)
         end  
         #we were successful, we're outta here
-        if $? == 0
+        if success
           break
         else
           puts "Download seems to have failed (retrying, attempt #{i+1}/#{amount_of_retries})"
           sleep 2
         end
       end    
-      $? == 0
+      success
+    end
+
+    def self.get_tool
+      tool = TOOLS_PRIORITY_LIST.find { |tool| ViddlRb::UtilityHelper.os_has?(tool) }
+      tool || :net_http
     end
 
+    def self.require_progressbar
+      begin
+        require "progressbar"
+      rescue LoadError
+        raise RequirementError,
+          "you don't seem to have curl or wget on your system. In this case you'll need to install the 'progressbar' gem."
+      end
+    end
+
+    # downloads and saves a file using the net/http streaming api
+    # return true if the download was successful, else returns false
+    def self.download_and_save_file(download_url, full_path)
+      final_url = UtilityHelper.get_final_location(download_url)    # follow all redirects
+      uri = URI(final_url)
+      file = File.new(full_path, "wb")
+      file_size = 0
+
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        http.request_get(uri.request_uri) do |res|
+          file_size = res.read_header["content-length"].to_i 
+          bar = ProgressBar.new(File.basename(full_path), file_size)
+          bar.file_transfer_mode
+          res.read_body do |segment|
+            bar.inc(segment.size)
+            file.write(segment)
+          end
+        end
+      end
+      file.close
+      print "\n"
+      download_successful?(full_path, file_size)   #because Net::HTTP.start does not throw Net exceptions
+    end
+
+    def self.download_successful?(full_file_path, file_size)
+      File.exist?(full_file_path) && File.size(full_file_path) == file_size
+    end
   end
 end

data/helper/utility-helper.rb

@@ -18,7 +18,7 @@ module ViddlRb
       windows = ENV['OS'] =~ /windows/i
 
       unless windows
-        `which #{utility}`.include?(utility)
+        `which #{utility}`.include?(utility.to_s)
       else
         if !system("where /q where").nil?   #if Windows has the where utility
           system("where /q #{utility}")     #/q is the quiet mode flag
@@ -31,6 +31,15 @@ module ViddlRb
         end
       end
     end
-    
+
+    #recursively get the final location (after following all redirects) for an url.
+    def self.get_final_location(url)
+      Net::HTTP.get_response(URI(url)) do |res|
+        location = res["location"]
+        return url if location.nil?
+        return get_final_location(location)
+      end
+    end
+
   end
 end

data/lib/viddl-rb.rb

@@ -95,19 +95,9 @@ module ViddlRb
   def self.follow_all_redirects(urls_filenames)
     urls_filenames.map do |uf|
       url = uf[:url]
-      final_location = get_final_location(url)
+      final_location = UtilityHelper.get_final_location(url)
       {:url => final_location, :name => uf[:name]}
     end
   end
   private_class_method :follow_all_redirects
-
-  #recursively get the final location (after following all redirects) for an url.
-  def self.get_final_location(url)
-    Net::HTTP.get_response(URI(url)) do |res|
-      location = res["location"]
-      return url if location.nil?
-      return get_final_location(location)
-    end
-  end
-  private_class_method :get_final_location
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: viddl-rb
 version: !ruby/object:Gem::Version 
-  hash: 153
+  hash: 159
   prerelease: 
   segments: 
   - 0
-  - 73
-  version: "0.73"
+  - 74
+  version: "0.74"
 platform: ruby
 authors: 
 - Marc Seeger
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-05 00:00:00 +02:00
+date: 2012-10-07 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,7 +87,21 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
-description: An extendable commandline video downloader for flash video sites. Includes plugins for vimeo, youtube and megavideo
+- !ruby/object:Gem::Dependency 
+  name: progressbar
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: An extendable commandline video downloader for flash video sites. Includes plugins for vimeo, youtube, dailymotion and more
 email: mail@marc-seeger.de
 executables: 
 - viddl-rb