youtube-dl.rb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d2e08f28b92fbb5f4648f62a80cb17c6e789880
-  data.tar.gz: a0156c53d24ff475811e5525f93005a6cb56d138
+  metadata.gz: e2f3b80e2f598cbea19cdb6aa760535bd1735ef1
+  data.tar.gz: 372eadeb8f68fe3d9bf659ea1d1528b26b028b72
 SHA512:
-  metadata.gz: 3f033ca22e27a6f6d9ff3954cf19e2bbf77406185d27a3cc977ad479af360b13065900e1c71e8c23292b4bb75e08fd91e7903c08481c5b1ecb0f4c1b16128b9c
-  data.tar.gz: fe4bbb6ed28c00d05b0fdd5a1c289b154abebecd2dafa427c323b6bf545f9e09d8da238d1b0a1d772c64c65b78a46d75f4ff70504bc55890366b909d98b1de4b
+  metadata.gz: 5bfdb2529020c00c0baa402acabd604e970c82cccd126aefb651ea26b39e89a15ea7d08ade283c1763785f46378fa6cced2ed3a548ea94b60bbc93ccbe8940c1
+  data.tar.gz: 4d151900a4a7a2dd3556e01c9f4236820b27b7532a71a1200678dc9e3dfe4603da960c4d4e5b07cdba6c88fce94d99383b76c789f6fa61be8f9d5e5caf1e1acc

data/.travis.yml

@@ -0,0 +1,7 @@
+before_install: 'sudo pip install youtube-dl'
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.5
+- jruby-19mode
+- rbx-2

data/README.md

@@ -1,9 +1,10 @@
 # youtube-dl.rb
 
-Ruby wrapper for youtube-dl
+Ruby wrapper for [youtube-dl](http://rg3.github.io/youtube-dl/).
+[![Build Status](https://travis-ci.org/layer8x/youtube-dl.rb.svg?branch=master)](https://travis-ci.org/layer8x/youtube-dl.rb)
 
 ## Installing youtube-dl
-This gem does not ship with youtube-dl built in (yet), so you need to install manually.
+This gem does not ship with the `youtube-dl` command-line program (yet!) so you will need to install `youtube-dl` manually.  Luckily there are three ways to do it.
 
 ### The easy way
 Use your distro's package manager!
@@ -51,7 +52,7 @@ All options available to youtube-dl can be passed to the options hash
 options = {
   username: 'someone',
   password: 'password1',
-  rate_limit: '50K'
+  rate_limit: '50K',
   format: :worst
 }
 

data/Rakefile

@@ -4,3 +4,5 @@ require 'rake/testtask'
 Rake::TestTask.new do |t|
   t.pattern = "test/**/*_test.rb"
 end
+
+task :default => [:test]

data/lib/youtube-dl.rb

@@ -4,9 +4,19 @@ require 'youtube-dl/runner'
 
 module YoutubeDL
   extend self
-  def download(url, options={})
-    runner = YoutubeDL::Runner.new(url, YoutubeDL::Options.new(options))
-    runner.run
+
+  # Downloads given array of URLs with any options passed
+  #
+  # @param urls [String, Array] URLs to download
+  # @param options [Hash] Downloader options
+  def download(urls, options={})
+    # force convert urls to array
+    urls = [urls] unless urls.is_a? Array
+
+    urls.each do |url|
+      runner = YoutubeDL::Runner.new(url, YoutubeDL::Options.new(options))
+      runner.run
+    end
   end
 
   alias_method :get, :download

data/lib/youtube-dl/options.rb

@@ -2,10 +2,21 @@ module YoutubeDL
   class Options
     attr_accessor :store
 
+    # Options initializer
+    #
+    # @param options [Hash] a hash of options
     def initialize(options={})
       @store = options
     end
 
+    # Returns options as a hash
+    #
+    # @return [Hash] hash of options
+    def to_hash
+      @store
+    end
+    alias_method :to_h, :to_hash
+
     def each_paramized
       @store.each do |key, value|
         yield(paramize(key), value)
@@ -18,18 +29,22 @@ module YoutubeDL
       end
     end
 
+    # Set options using a block
     def configure(&block)
       block.call(self)
     end
 
+    # Get option with brackets syntax
     def [](key)
       @store[key.to_sym]
     end
 
+    # Set option with brackets syntax
     def []=(key, value)
       @store[key.to_sym] = value
     end
 
+    # Option getting and setting using ghost methods
     def method_missing(method, *args, &block)
       if method.to_s.include? '='
         method = method.to_s.tr('=', '').to_sym
@@ -39,6 +54,7 @@ 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
@@ -49,6 +65,10 @@ module YoutubeDL
     end
 
     private
+    # Helper function to convert option keys into command-line-friendly parameters
+    #
+    # @param key [Symbol, String] key to paramize
+    # @return [String] paramized key
     def paramize(key)
       key.to_s.tr("_", '-')
     end

data/lib/youtube-dl/runner.rb

@@ -6,29 +6,48 @@ module YoutubeDL
     attr_accessor :options
     attr_accessor :executable_path
 
+    # Command Line runner initializer
+    #
+    # @param url [String] URL to pass to youtube-dl executable
+    # @param options [Hash, Options] options to pass to the executable. Automatically converted to Options if it isn't already
     def initialize(url, options=YoutubeDL::Options.new)
       @url = url
-      @options = options
+      @options = YoutubeDL::Options.new(options.to_hash)
       @executable_path = 'youtube-dl'
     end
 
+    # Returns Cocaine's runner engine
+    #
+    # @return [CommandLineRunner] backend runner class
     def backend_runner
       Cocaine::CommandLine.runner
     end
 
+    # Sets Cocaine's runner engine
+    #
+    # @param [CommandLineRunner] backend runner class
     def backend_runner=(cocaine_runner)
       Cocaine::CommandLine.runner = cocaine_runner
     end
 
+    # Returns the command string without running anything
+    #
+    # @return [String] command line string
     def to_command
       cocaine_line(options_to_commands).command(@options.store)
     end
+    alias_method :command, :to_command
 
+    # Runs the command
     def run
       cocaine_line(options_to_commands).run(@options.store)
     end
 
     private
+
+    # Parses options and converts them to Cocaine's syntax
+    #
+    # @return [String] commands ready to do cocaine
     def options_to_commands
       commands = []
       options.each_paramized_key do |key, paramized_key|
@@ -42,6 +61,10 @@ module YoutubeDL
       commands.join(' ')
     end
 
+    # Helper for doing lines of cocaine (initializing, auto executable stuff, etc)
+    #
+    # @param command [String] command switches to run
+    # @return [Cocaine::CommandLine] initialized Cocaine instance
     def cocaine_line(command)
       Cocaine::CommandLine.new(@executable_path, command)
     end

data/lib/youtube-dl/version.rb

@@ -1,3 +1,3 @@
 module YoutubeDL
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/spec'
 require 'purdytest' # minitest-colorize is broken in minitest version 5

data/test/youtube-dl/runner_test.rb

@@ -24,7 +24,7 @@ describe YoutubeDL::Runner do
   it 'should parse key-values from options' do
     @runner.options.some_key = "a value"
 
-    assert_includes @runner.to_command, "--some-key 'a value'"
+    refute_nil @runner.to_command.match(/--some-key\s.*a value.*/) 
   end
 
   it 'should not include the value if value is true' do
@@ -38,4 +38,14 @@ describe YoutubeDL::Runner do
     @runner.run
     assert File.exists? 'nope.avi'
   end
+
+  it 'should take options as a hash yet still have configuration blocks work' do
+    r = YoutubeDL::Runner.new(NOPE, {some_key: 'some value'})
+    r.options.configure do |c|
+      c.another_key = 'another_value'
+    end
+
+    assert_includes r.to_command, "--some-key"
+    assert_includes r.to_command, "--another-key"
+  end
 end

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

@@ -9,4 +9,9 @@ describe YoutubeDL do
     YoutubeDL.get NOPE, output: 'nope.avi'
     assert File.exist? 'nope.avi'
   end
+
+  it 'should download multiple videos' do
+    YoutubeDL.download [NOPE, "https://www.youtube.com/watch?v=Mt0PUjh-nDM"]
+    assert_equal Dir.glob('nope*').length, 2
+  end
 end

data/youtube-dl.rb.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["saps.laj@gmail.com"]
   spec.summary       = %q{youtube-dl wrapper for Ruby}
   spec.description   = %q{in the spirit of pygments.rb and MiniMagick, youtube-dl.rb is a command line wrapper for the python script youtube-dl}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/layer8x/youtube-dl.rb"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youtube-dl.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - sapslaj
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-16 00:00:00.000000000 Z
+date: 2015-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine
@@ -104,6 +104,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -117,7 +118,7 @@ files:
 - test/youtube-dl/runner_test.rb
 - test/youtube-dl/youtube-dl_test.rb
 - youtube-dl.rb.gemspec
-homepage: ''
+homepage: https://github.com/layer8x/youtube-dl.rb
 licenses:
 - MIT
 metadata: {}