youtube-dl.rb 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c86f76bf2febd54113c84142274c4c496855ebf
-  data.tar.gz: 0da55077bb17767338d0bde1ae75ed1fc1d9e78d
+  metadata.gz: 9617af8816b4a2d132a238753878f96266d28c83
+  data.tar.gz: 90ebb1224cf47322e548d66ff45d13a32b48b2ec
 SHA512:
-  metadata.gz: ef750607464a9a53882193569508b45b5f59d9b8c60fa30166bcded52a7a4ef1ae46223849aded5de47cbef64960a4958c78591d15528a46971465ca5d545d7a
-  data.tar.gz: b18889569bf6401ee10bffc6edab536d0f066cd3379cd487b65f2038b743ec1a7509f333e01c492d0dd81791df8c070d53e7b4de9dc9eb1a967d292b8ef0cc2d
+  metadata.gz: 005ac4174bbf67fd4392f339dd853615fc984d3da896e83ec4024dcce56e0895c834a2eb9181426e6ec3a61a305e4e3fc17d9ace8781487df46e98c48f42e204
+  data.tar.gz: 24c69abc365276c73497f483d8c7c9eb6ca782dd42181bb99bee7b8a5964ee52105b0ba53507a4881c5b3a8ceb4c4579982ae4b8862e6b4da3c54debe0c688a2

data/lib/youtube-dl.rb

@@ -1,3 +1,5 @@
+require 'cocaine'
+
 require 'youtube-dl/version'
 require 'youtube-dl/support'
 require 'youtube-dl/options'
@@ -5,6 +7,7 @@ require 'youtube-dl/output'
 require 'youtube-dl/runner'
 require 'youtube-dl/video'
 
+# Global YoutubeDL module. Contains some convenience methods and all of the business classes.
 module YoutubeDL
   extend self
   extend Support

data/lib/youtube-dl/options.rb

@@ -1,5 +1,9 @@
 module YoutubeDL
+
+  # Option and configuration getting, setting, and storage, and all that
   class Options
+
+    # [Hash] key value storage object
     attr_accessor :store
 
     # Options initializer
@@ -65,6 +69,11 @@ module YoutubeDL
     end
 
     # Option getting and setting using ghost methods
+    #
+    # @param method [Symbol] method name
+    # @param args [Array] list of arguments passed
+    # @param block [Proc] implicit block given
+    # @return [Object] the value of method in the options store
     def method_missing(method, *args, &block)
       if method.to_s.include? '='
         method = method.to_s.tr('=', '').to_sym

data/lib/youtube-dl/output.rb

@@ -1,6 +1,19 @@
 module YoutubeDL
+
   # A class of voodoo methods for parsing youtube-dl output
-  class Output < Struct.new(:output)
+  class Output
+
+    # [String] Whatever youtube-dl spat out.
+    attr_accessor :output
+
+    # Initialize output parser
+    #
+    # @param output [String] Whatever youtube-dl spat out.
+    # @return [YoutubeDL::Output] self
+    def initialize(output)
+      @output = output
+    end
+
     # Takes the output of '--list-formats'
     #
     # @return [Array] Array of supported formats

data/lib/youtube-dl/runner.rb

@@ -1,6 +1,6 @@
-require 'cocaine'
-
 module YoutubeDL
+
+  # Utility class for running and managing youtube-dl
   class Runner
     include YoutubeDL::Support
 
@@ -42,7 +42,7 @@ module YoutubeDL
 
     # Sets Cocaine's runner engine
     #
-    # @param [CommandLineRunner] backend runner class
+    # @param cocaine_runner [CommandLineRunner] backend runner class
     # @return [Object] whatever Cocaine::CommandLine.runner= returns.
     def backend_runner=(cocaine_runner)
       Cocaine::CommandLine.runner = cocaine_runner

data/lib/youtube-dl/support.rb

@@ -1,20 +1,21 @@
 module YoutubeDL
+
+  # Some support methods and glue logic.
   module Support
-    # Some support methods and glue logic.
 
     # Returns a usable youtube-dl executable (system or vendor)
     #
     # @param exe [String] Executable to search for
     # @return [String] executable path
     def usable_executable_path_for(exe)
-      system_path = `which #{exe} 2> /dev/null` # This will currently only work on Unix systems. TODO: Add Windows support
-      if $?.exitstatus == 0 # $? is an object with information on that last command run with backticks.
-        system_path.strip
-      else
+      system_path = which(exe)
+      if system_path.nil?
         # TODO: Search vendor bin for executable before just saying it's there.
         vendor_path = File.absolute_path("#{__FILE__}/../../../vendor/bin/#{exe}")
         File.chmod(775, vendor_path) unless File.executable?(vendor_path) # Make sure vendor binary is executable
         vendor_path
+      else
+        system_path.strip
       end
     end
 
@@ -37,5 +38,23 @@ module YoutubeDL
     def quoted(url)
       "\"#{url}\""
     end
+
+    # Cross-platform way of finding an executable in the $PATH.
+    # Stolen from http://stackoverflow.com/a/5471032
+    #
+    #   which('ruby') #=> /usr/bin/ruby
+    #
+    # @param cmd [String] cmd to search for
+    # @return [String] full path for the cmd
+    def which(cmd)
+      exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
+      ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts.each { |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        }
+      end
+      return nil
+    end
   end
 end

data/lib/youtube-dl/version.rb

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

data/lib/youtube-dl/video.rb

@@ -1,9 +1,13 @@
 module YoutubeDL
-  # Video model
+
+  # Video model for using and downloading a single video.
   class Video < Runner
     class << self
       # Instantiate a new Video model and download the video
       #
+      #   YoutubeDL.download 'https://www.youtube.com/watch?v=KLRDLIIl8bA' # => #<YoutubeDL::Video:0x00000000000000>
+      #   YoutubeDL.get 'https://www.youtube.com/watch?v=ia1diPnNBgU', extract_audio: true, audio_quality: 0
+      #
       # @param url [String] URL to use and download
       # @param options [Hash] Options to pass in
       # @return [YoutubeDL::Video] new Video model

data/test/fixtures.yml

@@ -0,0 +1,54 @@
+---
+:output:
+  :download: |
+    [youtube] gvdf5n-zI14: Downloading webpage
+    [youtube] gvdf5n-zI14: Downloading video info webpage
+    [youtube] gvdf5n-zI14: Extracting video information
+    [youtube] gvdf5n-zI14: Downloading DASH manifest
+    [youtube] gvdf5n-zI14: Downloading DASH manifest
+    [download] Destination: nope.avi-gvdf5n-zI14.mp4
+    [download] 100% of 1.31MiB in 00:00
+  :download_ffmpeg: |
+    [youtube] gvdf5n-zI14: Downloading webpage
+    [youtube] gvdf5n-zI14: Downloading video info webpage
+    [youtube] gvdf5n-zI14: Extracting video information
+    [youtube] gvdf5n-zI14: Downloading DASH manifest
+    [youtube] gvdf5n-zI14: Downloading DASH manifest
+    [download] Destination: nope.avi-gvdf5n-zI14.f136.mp4
+    [download] 100% of 762.83KiB in 00:04
+    [download] Destination: nope.avi-gvdf5n-zI14.f141.m4a
+    [download] 100% of 282.57KiB in 00:00
+    [ffmpeg] Merging formats into "nope.avi-gvdf5n-zI14.mp4"
+    Deleting original file nope.avi-gvdf5n-zI14.f136.mp4 (pass -k to keep)
+    Deleting original file nope.avi-gvdf5n-zI14.f141.m4a (pass -k to keep)
+  :download_exists: |
+    [youtube] gvdf5n-zI14: Downloading webpage
+    [youtube] gvdf5n-zI14: Downloading video info webpage
+    [youtube] gvdf5n-zI14: Extracting video information
+    [youtube] gvdf5n-zI14: Downloading DASH manifest
+    [youtube] gvdf5n-zI14: Downloading DASH manifest
+    [download] nope.avi-gvdf5n-zI14.mp4 has already been downloaded
+    [download] 100% of 1.31MiB
+  :list_formats: "[youtube] gvdf5n-zI14: Downloading webpage\n[youtube] gvdf5n-zI14:
+    Downloading video info webpage\n[youtube] gvdf5n-zI14: Extracting video information\n[youtube]
+    gvdf5n-zI14: Downloading DASH manifest\n[youtube] gvdf5n-zI14: Downloading DASH
+    manifest\n[info] Available formats for gvdf5n-zI14:\nformat code  extension  resolution
+    note\n171          webm       audio only DASH audio  120k , vorbis@128k (44100Hz),
+    132.26KiB\n140          m4a        audio only DASH audio  129k , m4a_dash container,
+    aac  @128k (44100Hz), 142.59KiB\n141          m4a        audio only DASH audio
+    \ 255k , m4a_dash container, aac  @256k (44100Hz), 282.57KiB\n242          webm
+    \      426x240    DASH video  109k , vp9, 1fps, video only, 118.40KiB\n160          mp4
+    \       256x144    DASH video  110k , avc1.4d400c, 12fps, video only, 121.30KiB\n243
+    \         webm       640x360    DASH video  189k , vp9, 1fps, video only, 200.48KiB\n134
+    \         mp4        640x360    DASH video  237k , avc1.4d401e, 24fps, video only,
+    239.13KiB\n133          mp4        426x240    DASH video  248k , avc1.4d4015,
+    24fps, video only, 270.34KiB\n244          webm       854x480    DASH video  311k
+    , vp9, 1fps, video only, 333.92KiB\n135          mp4        854x480    DASH video
+    \ 430k , avc1.4d401e, 24fps, video only, 421.60KiB\n247          webm       1280x720
+    \  DASH video  572k , vp9, 1fps, video only, 596.27KiB\n136          mp4        1280x720
+    \  DASH video  788k , avc1.4d401f, 24fps, video only, 762.83KiB\n13           3gp
+    \       unknown    small \n17           3gp        176x144    small ,  mp4a.40.2,
+    mp4v.20.3\n36           3gp        320x240    small ,  mp4a.40.2, mp4v.20.3\n5
+    \           flv        400x240    small \n43           webm       640x360    medium
+    ,  vorbis, vp8.0\n18           mp4        640x360    medium ,  mp4a.40.2, avc1.42001E\n22
+    \          mp4        1280x720   hd720 ,  mp4a.40.2, avc1.64001F (best)\n"

data/test/test_helper.rb

@@ -14,6 +14,7 @@ require 'minitest/spec'
 require 'purdytest' # minitest-colorize is broken in minitest version 5
 require 'pry'
 require 'fileutils'
+require 'yaml'
 
 require 'youtube-dl'
 
@@ -28,3 +29,11 @@ def remove_downloaded_files
     File.delete(nope)
   end
 end
+
+def fixture(*keys)
+  @fixtures ||= YAML.load(File.read(File.join(File.dirname(__FILE__), 'fixtures.yml')))
+
+  last_path = @fixtures
+  keys.each { |key| last_path = last_path[key] }
+  last_path
+end

data/test/youtube-dl/output_test.rb

@@ -1,38 +1,5 @@
 require_relative '../test_helper'
 
-module OutputFactory
-  extend self
-  extend YoutubeDL::Support
-
-  def download
-    remove_downloaded_files # Make sure there isn't a file there
-    @download ||= cocaine_line(quoted(TEST_URL)).run
-  end
-
-  def download_exists
-    @download_exists ||= lambda do
-      cocaine_line(quoted(TEST_URL)).run # two times to make sure it's there.
-      cocaine_line(quoted(TEST_URL)).run
-    end.call
-  end
-
-  def list_formats
-    @list_formats ||= cocaine_line("--list-formats #{quoted(TEST_URL)}").run
-  end
-end
-
-# For debugging
-# puts
-# puts " --------------- OutputFactory.download --------------- "
-# puts OutputFactory.download
-# puts
-# puts " --------------- OutputFactory.download_exists --------------- "
-# puts OutputFactory.download_exists
-# puts
-# puts " --------------- OutputFactory.list_formats --------------- "
-# puts OutputFactory.list_formats
-# puts
-
 describe YoutubeDL::Output do
   describe '#initialize' do
     it 'should set the output variable' do
@@ -44,7 +11,7 @@ describe YoutubeDL::Output do
 
   describe '#supported_formats' do
     before do
-      @parser = YoutubeDL::Output.new(OutputFactory.list_formats)
+      @parser = YoutubeDL::Output.new(fixture(:output, :list_formats))
     end
 
     it 'should find a match given the correct output' do
@@ -56,37 +23,41 @@ describe YoutubeDL::Output do
     end
 
     it 'should return nil if no match or wrong log format' do
-      bad_parser = YoutubeDL::Output.new(OutputFactory.download)
+      bad_parser = YoutubeDL::Output.new(fixture(:output, :download))
       assert_nil bad_parser.supported_formats
     end
   end
 
   describe '#filename' do
     before do
-      @parser_download = YoutubeDL::Output.new(OutputFactory.download)
-      @parser_download_exists = YoutubeDL::Output.new(OutputFactory.download_exists)
+      @parser_download = YoutubeDL::Output.new(fixture(:output, :download))
+      @parser_download_ffmpeg = YoutubeDL::Output.new(fixture(:output, :download_ffmpeg))
+      @parser_download_exists = YoutubeDL::Output.new(fixture(:output, :download_exists))
     end
 
     it 'should find a match given the correct output' do
       refute_nil @parser_download.filename
+      refute_nil @parser_download_ffmpeg.filename
       refute_nil @parser_download_exists.filename
     end
 
     it 'should find the correct match' do
       assert_equal 'nope.avi-gvdf5n-zI14.mp4', @parser_download.filename
+      assert_equal 'nope.avi-gvdf5n-zI14.mp4', @parser_download_ffmpeg.filename
       assert_equal 'nope.avi-gvdf5n-zI14.mp4', @parser_download_exists.filename
     end
 
     it 'should return nil if no match or wrong log format' do
-      bad_parser = YoutubeDL::Output.new(OutputFactory.list_formats)
+      bad_parser = YoutubeDL::Output.new(fixture(:output, :list_formats))
       assert_nil bad_parser.filename
     end
   end
 
   describe '#already_downloaded?' do
     before do
-      @parser_download = YoutubeDL::Output.new(OutputFactory.download)
-      @parser_download_exists = YoutubeDL::Output.new(OutputFactory.download_exists)
+      @parser_download = YoutubeDL::Output.new(fixture(:output, :download))
+      @parser_download_ffmpeg = YoutubeDL::Output.new(fixture(:output, :download_ffmpeg))
+      @parser_download_exists = YoutubeDL::Output.new(fixture(:output, :download_exists))
     end
 
     it 'should return a truthy value if true' do
@@ -95,6 +66,7 @@ describe YoutubeDL::Output do
 
     it 'should return a falsy value if false' do
       refute @parser_download.already_downloaded?
+      refute @parser_download_ffmpeg.already_downloaded?
     end
   end
 end

data/test/youtube-dl/support_test.rb

@@ -55,4 +55,10 @@ describe YoutubeDL::Support do
       assert_equal "\"#{TEST_URL}\"", @klass.quoted(TEST_URL)
     end
   end
+
+  describe '#which' do
+    it 'should find a proper executable' do
+      assert File.exists?(@klass.which('ls'))
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youtube-dl.rb
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - sapslaj
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -144,6 +144,7 @@ files:
 - lib/youtube-dl/support.rb
 - lib/youtube-dl/version.rb
 - lib/youtube-dl/video.rb
+- test/fixtures.yml
 - test/test_helper.rb
 - test/youtube-dl/options_test.rb
 - test/youtube-dl/output_test.rb
@@ -179,6 +180,7 @@ signing_key:
 specification_version: 4
 summary: youtube-dl wrapper for Ruby
 test_files:
+- test/fixtures.yml
 - test/test_helper.rb
 - test/youtube-dl/options_test.rb
 - test/youtube-dl/output_test.rb