youtube-dl.rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc95699d01465f5cb0881852a1e8d37e1a9c0794
-  data.tar.gz: ab8b547a79cfa7a04ac8e3c56ab46da1f7df31dd
+  metadata.gz: d7c86b235fb38c06bc33f5984e8993d166da84c8
+  data.tar.gz: 3711e90fbc95e01c0f1175ccdf2833c1f188908d
 SHA512:
-  metadata.gz: f4620ff0634fd5cfad55178b623ccc267e57576f4ab5f79fb8f1f967cd926c3f9e3062f5b26fd994de52c1536813c94ec5be2c0f33fecbc1d8f70d9f3fa403e9
-  data.tar.gz: 5f3f979b7fa7ea34cdf7f170d5a2e2466502ad753704baa11a065016e0ddac735bbab08fbfdacd2d7c0403c95651f02c7d6bde175841d5d473a78d1aa7ae07f6
+  metadata.gz: aad917d66ff21d4ecb11bf1f8228c1091dd9b618ab56cded145ed0bac9ef4685d6098860cbeb06cf5c66d7abd651259fe76fc157af82934ab1cc02e4f34b8795
+  data.tar.gz: dea3940ed3ef94ad31e38f177c4b6824ec11f086038d014e590425d15d5760767b29614ca01948bf4b406854c60e5c8b7932b0f302367d31ef18b9826d5c57bb

data/.travis.yml

@@ -2,6 +2,9 @@ before_install: 'sudo chmod 755 ./vendor/bin/youtube-dl'
 rvm:
 - 1.9.3 # EOL, but still supporting
 - 2.0.0 # Oldest stable
-- 2.2.2 # Current stable
-# - jruby-19mode # JRuby
+- 2.2.3 # Current stable
+- jruby-head # JRuby
 - rbx-2 # Rubinius
+
+notifications:
+  slack: layer8x:cvixULdjCINfq7u9Zs1rS0VY

data/README.md

@@ -5,8 +5,13 @@ 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)
 [![Code Climate](https://codeclimate.com/github/layer8x/youtube-dl.rb/badges/gpa.svg)](https://codeclimate.com/github/layer8x/youtube-dl.rb)
 [![Test Coverage](https://codeclimate.com/github/layer8x/youtube-dl.rb/badges/coverage.svg)](https://codeclimate.com/github/layer8x/youtube-dl.rb/coverage)
+[![security](https://hakiri.io/github/layer8x/youtube-dl.rb/master.svg)](https://hakiri.io/github/layer8x/youtube-dl.rb/master)
+[![Inline docs](http://inch-ci.org/github/layer8x/youtube-dl.rb.svg?branch=master)](http://inch-ci.org/github/layer8x/youtube-dl.rb)
+[![Dependency Status](https://gemnasium.com/layer8x/youtube-dl.rb.svg)](https://gemnasium.com/layer8x/youtube-dl.rb)
+
 [![Stories in Ready](https://badge.waffle.io/layer8x/youtube-dl.rb.svg?label=ready&title=Ready)](http://waffle.io/layer8x/youtube-dl.rb)
 
+
 ## Install the gem
 
 Add this line to your application's Gemfile:

data/lib/youtube-dl/options.rb

@@ -17,12 +17,20 @@ module YoutubeDL
     end
     alias_method :to_h, :to_hash
 
+    # Iterate through the paramized keys and values.
+    #
+    # @yield [paramized_key, value]
+    #
+    # TODO: Enumerable?
     def each_paramized
       @store.each do |key, value|
         yield(paramize(key), value)
       end
     end
 
+    # Iterate through the keys and their paramized counterparts.
+    #
+    # @yield [key, paramized_key]
     def each_paramized_key
       @store.each_key do |key|
         yield(key, paramize(key))
@@ -30,16 +38,25 @@ module YoutubeDL
     end
 
     # Set options using a block
+    #
+    # @yield [config] self
+    # TODO: support calling without arguments
     def configure(&block)
       block.call(self)
     end
 
     # Get option with brackets syntax
+    #
+    # @param key [Object] key
+    # @return [Object] value
     def [](key)
       @store[key.to_sym]
     end
 
     # Set option with brackets syntax
+    #
+    # @param key [Object] key
+    # @param value [Object] value
     def []=(key, value)
       @store[key.to_sym] = value
     end
@@ -54,15 +71,34 @@ module YoutubeDL
       end
     end
 
+    # Calls a block to do operations on keys
+    # See sanitize_keys! for examples
+    #
+    # @param block [Proc] Block with operations on keys
+    # @yieldparam key [Object] Original key
+    # @yieldreturn [Object] Manipulated key
+    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
+
     # 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
+      # Underscoreize (because Cocaine doesn't like hyphens)
       manipulate_keys! { |key_name| key_name.to_s.tr('-', '_').to_sym }
     end
 
+    # Symbolizes and sanitizes keys and returns a copy of self
+    #
+    # @return [YoutubeDL::Options] Options with sanitized keys.
     def sanitize_keys
       safe_copy = self.dup
       safe_copy.sanitize_keys!
@@ -77,15 +113,5 @@ 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

@@ -46,7 +46,12 @@ module YoutubeDL
     end
     alias_method :download, :run
 
+    # Returns a list of supported formats for the video in the form of
+    # [{:format_code => '000', :extension => 'avi', :resolution => '320x240', :note => 'More details about the format'}]
+    #
+    # @return [Array] Format list
     def formats
+      # TODO: Move formats to its own model?
       parse_format_output(cocaine_line("--list-formats #{quoted(url)}").run)
     end
 
@@ -68,6 +73,10 @@ module YoutubeDL
       commands.join(' ')
     end
 
+    # Helper to add quotes to beginning and end of a URL.
+    #
+    # @param url [String] Raw URL
+    # @return [String] Quoted URL
     def quoted(url)
       "\"#{url}\""
     end

data/lib/youtube-dl/support.rb

@@ -11,6 +11,7 @@ module YoutubeDL
       if $?.exitstatus == 0 # $? is an object with information on that last command run with backticks.
         system_path.strip
       else
+        # 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

data/lib/youtube-dl/version.rb

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

data/test/youtube-dl/options_test.rb

@@ -80,4 +80,12 @@ describe YoutubeDL::Options do
     @options.store['some-key'] = "some_value"
     assert_instance_of YoutubeDL::Options, @options.sanitize_keys
   end
+
+  it 'should manipulate keys' do
+    @options.some_key = 'value'
+    @options.manipulate_keys! do |key|
+      key.to_s.upcase
+    end
+    assert_equal({'SOME_KEY' => 'value'}, @options.store)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: youtube-dl.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - sapslaj
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocaine