youtube-dl.rb 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f871ed15e269c05860f9784244e7b8a8b50f233
-  data.tar.gz: de5a4e5606cba55abaedb53936d42a1099ccdef9
+  metadata.gz: dc95699d01465f5cb0881852a1e8d37e1a9c0794
+  data.tar.gz: ab8b547a79cfa7a04ac8e3c56ab46da1f7df31dd
 SHA512:
-  metadata.gz: 7fadfe8fca0a98fd27690767f657e0b7e9174c725b3a8b29846dbfd4c7cc167165dad6115cd352f76ef8b88709a48cce9e806f2e344bd4215eb79c2c66fc2c2b
-  data.tar.gz: 049911e6cbea32b12ff588d19f881814ad42f5ee4ce726c9984e0c2d93b51fcadb05a9fd0189b88b00ba78c548c188006fde20a888129893f5ea0846e7590b4e
+  metadata.gz: f4620ff0634fd5cfad55178b623ccc267e57576f4ab5f79fb8f1f967cd926c3f9e3062f5b26fd994de52c1536813c94ec5be2c0f33fecbc1d8f70d9f3fa403e9
+  data.tar.gz: 5f3f979b7fa7ea34cdf7f170d5a2e2466502ad753704baa11a065016e0ddac735bbab08fbfdacd2d7c0403c95651f02c7d6bde175841d5d473a78d1aa7ae07f6

data/lib/youtube-dl.rb

@@ -1,9 +1,11 @@
 require 'youtube-dl/version'
+require 'youtube-dl/support'
 require 'youtube-dl/options'
 require 'youtube-dl/runner'
 
 module YoutubeDL
   extend self
+  extend Support
 
   # Downloads given array of URLs with any options passed
   #
@@ -20,4 +22,12 @@ module YoutubeDL
   end
 
   alias_method :get, :download
+
+  def extractors
+    Cocaine::CommandLine.new(usable_executable_path_for('youtube-dl'), '--list-extractors').run.split("\n")
+  end
+
+  def binary_version
+    Cocaine::CommandLine.new(usable_executable_path_for('youtube-dl'), '--version').run.chomp
+  end
 end

data/lib/youtube-dl/options.rb

@@ -54,14 +54,19 @@ module YoutubeDL
       end
     end
 
-    # Symbolizes keys in the option store
-    def symbolize_keys!
-      @store.keys.each do |key_name|
-        unless key_name.is_a? Symbol
-          @store[key_name.to_sym] = @store[key_name]
-          @store.delete(key_name)
-        end
-      end
+    # Symbolizes and sanitizes keys in the option store
+    def sanitize_keys!
+      # Symbolize
+      manipulate_keys! { |key_name| key_name.is_a?(Symbol) ? key_name : key_name.to_sym }
+
+      # Underscoreize
+      manipulate_keys! { |key_name| key_name.to_s.tr('-', '_').to_sym }
+    end
+
+    def sanitize_keys
+      safe_copy = self.dup
+      safe_copy.sanitize_keys!
+      safe_copy
     end
 
     private
@@ -72,5 +77,15 @@ module YoutubeDL
     def paramize(key)
       key.to_s.tr("_", '-')
     end
+
+    def manipulate_keys!(&block)
+      @store.keys.each do |old_name|
+        new_name = block.call(old_name)
+        unless new_name == old_name
+          @store[new_name] = @store[old_name]
+          @store.delete(old_name)
+        end
+      end
+    end
   end
 end

data/lib/youtube-dl/runner.rb

@@ -2,6 +2,8 @@ require 'cocaine'
 
 module YoutubeDL
   class Runner
+    include YoutubeDL::Support
+
     attr_accessor :url
     attr_accessor :options
     attr_accessor :executable_path
@@ -13,7 +15,7 @@ module YoutubeDL
     def initialize(url, options=YoutubeDL::Options.new)
       @url = url
       @options = YoutubeDL::Options.new(options.to_hash)
-      @executable_path = usable_executable_path
+      @executable_path = usable_executable_path_for('youtube-dl')
     end
 
     # Returns Cocaine's runner engine
@@ -42,6 +44,11 @@ module YoutubeDL
     def run
       cocaine_line(options_to_commands).run(@options.store)
     end
+    alias_method :download, :run
+
+    def formats
+      parse_format_output(cocaine_line("--list-formats #{quoted(url)}").run)
+    end
 
     private
 
@@ -50,17 +57,21 @@ module YoutubeDL
     # @return [String] commands ready to do cocaine
     def options_to_commands
       commands = []
-      options.each_paramized_key do |key, paramized_key|
+      options.sanitize_keys.each_paramized_key do |key, paramized_key|
         if options[key].to_s == 'true'
           commands.push "--#{paramized_key}"
         else
           commands.push "--#{paramized_key} :#{key}"
         end
       end
-      commands.push url
+      commands.push quoted(url)
       commands.join(' ')
     end
 
+    def quoted(url)
+      "\"#{url}\""
+    end
+
     # Helper for doing lines of cocaine (initializing, auto executable stuff, etc)
     #
     # @param command [String] command switches to run
@@ -69,18 +80,20 @@ module YoutubeDL
       Cocaine::CommandLine.new(@executable_path, command)
     end
 
-    # Returns a usable executable (system or vendor)
+    # Do you like voodoo?
     #
-    # @return [String] youtube-dl executable path
-    def usable_executable_path
-      system_path = `which youtube-dl`
-      if $?.exitstatus == 0
-        system_path.strip
-      else
-        vendor_path = File.absolute_path("#{__FILE__}/../../../vendor/bin/youtube-dl")
-        File.chmod(775, vendor_path) unless File.executable?(vendor_path) # Make sure vendor binary is executable
-        vendor_path
+    # @param format_output [String] output from youtube-dl --list-formats
+    # @return [Array] Magic.
+    def parse_format_output(format_output)
+      # WARNING: This shit won't be documented or even properly tested. It's almost 3 in the morning and I have no idea what I'm doing.
+      this_shit = []
+      format_output.slice(format_output.index('format code')..-1).split("\n").each do |line|
+        a = {}
+        a[:format_code], a[:extension], a[:resolution], a[:note] = line.scan(/\A(\d+)\s+(\w+)\s+(\S+)\s(.*)/)[0]
+        this_shit.push a
       end
+      this_shit.shift
+      this_shit.map { |gipo| gipo[:note].strip!; gipo }
     end
   end
 end

data/lib/youtube-dl/support.rb

@@ -0,0 +1,20 @@
+module YoutubeDL
+  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
+        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
+      end
+    end
+  end
+end

data/lib/youtube-dl/version.rb

@@ -1,3 +1,3 @@
 module YoutubeDL
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/test/test_helper.rb

@@ -5,18 +5,23 @@ else
   require "codeclimate-test-reporter"
   CodeClimate::TestReporter.start
 end
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'purdytest' # minitest-colorize is broken in minitest version 5
 require 'pry'
+require 'fileutils'
 
-require_relative '../lib/youtube-dl.rb'
+require 'youtube-dl'
 
-TEST_URL = "https://www.youtube.com/watch?v=gvdf5n-zI14"
+TEST_URL = "https://www.youtube.com/watch?feature=endscreen&v=gvdf5n-zI14"
 TEST_URL2 = "https://www.youtube.com/watch?v=Mt0PUjh-nDM"
 TEST_FILENAME = "nope.avi.mp4"
 TEST_FORMAT = "5"
+TEST_GLOB = "nope*"
 
 def remove_downloaded_files
   Dir.glob("**/nope*").each do |nope|

data/test/youtube-dl/options_test.rb

@@ -7,8 +7,8 @@ describe YoutubeDL::Options do
 
   it 'should symbolize option keys' do
     @options.store['key'] = "value"
-    @options.symbolize_keys!
-    assert @options.store == {:key => 'value'}
+    @options.sanitize_keys!
+    assert_equal({key: 'value'}, @options.store)
   end
 
   it 'should be able to set options with method_missing' do
@@ -64,4 +64,20 @@ describe YoutubeDL::Options do
       assert_equal 'some-key', paramized_key
     end
   end
+
+  it 'should convert hyphens to underscores in keys' do # See issue #9
+    @options.store[:"hyphenated-key"] = 'value'
+    @options.sanitize_keys!
+    assert_equal({hyphenated_key: 'value'}, @options.to_h)
+  end
+
+  it 'should not modify the original by calling sanitize_keys without bang' do
+    @options.store['some-key'] = "some_value"
+    refute_equal @options.sanitize_keys, @options
+  end
+
+  it 'should return instance of Options when calling sanitize_keys' do
+    @options.store['some-key'] = "some_value"
+    assert_instance_of YoutubeDL::Options, @options.sanitize_keys
+  end
 end

data/test/youtube-dl/runner_test.rb

@@ -57,4 +57,27 @@ describe YoutubeDL::Runner do
     assert_includes r.to_command, "--some-key"
     assert_includes r.to_command, "--another-key"
   end
+
+  it 'might list formats' do
+    formats = @runner.formats
+    assert_instance_of Array, formats
+    assert_instance_of Hash, formats.first
+    assert_equal 4, formats.first.size
+    [:format_code, :resolution, :extension, :note].each do |key|
+      assert_includes formats.first, key
+      assert_includes formats.last, key
+    end
+  end
+  
+  it 'should handle strangely-formatted options correctly' do # See issue #9
+    options = {
+      format: 'bestaudio',
+      :"prefer-ffmpeg" => "true",
+      :"extract-audio" => true,
+      :"audio-format" => "mp3"
+    }
+
+    @runner.options = YoutubeDL::Options.new(options)
+    assert_match /youtube-dl --format 'bestaudio' --prefer-ffmpeg --extract-audio --audio-format 'mp3'/, @runner.to_command
+  end
 end

data/test/youtube-dl/support_test.rb

@@ -0,0 +1,36 @@
+require_relative '../test_helper'
+
+TestKlass = Class.new do
+  include YoutubeDL::Support
+
+  def executable_path
+    usable_executable_path_for 'youtube-dl'
+  end
+end
+
+describe YoutubeDL::Support do
+  before do
+    @klass = TestKlass.new
+  end
+
+  describe '#usable_executable_path' do
+    it 'should detect system executable' do
+      vendor_bin = File.join(Dir.pwd, 'vendor', 'bin', 'youtube-dl')
+      Dir.mktmpdir do |tmpdir|
+        FileUtils.cp vendor_bin, tmpdir
+
+        old_path = ENV["PATH"]
+        ENV["PATH"] = "#{tmpdir}:#{old_path}"
+
+        usable_path = @klass.usable_executable_path_for('youtube-dl')
+        assert_match usable_path, "#{tmpdir}/youtube-dl"
+
+        ENV["PATH"] = old_path
+      end
+    end
+
+    it 'should not have a newline char in the executable_path' do
+      assert_match /youtube-dl\z/, @klass.executable_path
+    end
+  end
+end

data/test/youtube-dl/youtube-dl_test.rb

@@ -1,17 +1,41 @@
 require_relative '../test_helper'
 
 describe YoutubeDL do
-  after do
-    remove_downloaded_files
+  describe '.download' do
+    after do
+      remove_downloaded_files
+    end
+
+    it 'should download videos' do
+      YoutubeDL.get TEST_URL, output: TEST_FILENAME, format: TEST_FORMAT
+      assert File.exist? TEST_FILENAME
+    end
+
+    it 'should download multiple videos' do
+      YoutubeDL.download [TEST_URL, TEST_URL2]
+      assert_equal Dir.glob('nope*').length, 2
+    end
   end
 
-  it 'should download videos' do
-    YoutubeDL.get TEST_URL, output: TEST_FILENAME, format: TEST_FORMAT
-    assert File.exist? TEST_FILENAME
+  describe '.extractors' do
+    it 'should return an Array of Strings' do
+      extractors = YoutubeDL.extractors
+      assert_instance_of Array, extractors
+      assert_instance_of String, extractors.first
+    end
   end
 
-  it 'should download multiple videos' do
-    YoutubeDL.download [TEST_URL, TEST_URL2]
-    assert_equal Dir.glob('nope*').length, 2
+  describe '.binary_version' do
+    before do
+      @version = YoutubeDL.binary_version
+    end
+
+    it 'should return a string' do
+      assert_instance_of String, @version
+    end
+
+    it 'should be a specific format with no newlines' do
+      assert_match /\d+.\d+.\d+\z/, @version
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youtube-dl.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - sapslaj
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-25 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -126,10 +126,12 @@ files:
 - lib/youtube-dl.rb
 - lib/youtube-dl/options.rb
 - lib/youtube-dl/runner.rb
+- lib/youtube-dl/support.rb
 - lib/youtube-dl/version.rb
 - test/test_helper.rb
 - test/youtube-dl/options_test.rb
 - test/youtube-dl/runner_test.rb
+- test/youtube-dl/support_test.rb
 - test/youtube-dl/youtube-dl_test.rb
 - vendor/bin/youtube-dl
 - vendor/bin/youtube-dl.exe
@@ -162,4 +164,5 @@ test_files:
 - test/test_helper.rb
 - test/youtube-dl/options_test.rb
 - test/youtube-dl/runner_test.rb
+- test/youtube-dl/support_test.rb
 - test/youtube-dl/youtube-dl_test.rb