rb-youtube-dl 0.4.0.2021.12.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6913fa63ff896ab25c4ec4f4c73330aa58e0100440bcc4800dce2b039d8847dc
+  data.tar.gz: a2655038a8e1216712ff031644255bda24b83464721bffa7819fc68c56539a4e
+SHA512:
+  metadata.gz: 40ce388df3dc9e473463178483d1f422ae897a1c238c6df1dc90f505e02eeb4e354ae4d9f7e5733d34790850d9f8551125acc85cb10972fc11a679c0882daf37
+  data.tar.gz: f3ce7a79800c269e05f5869aab94e9fe5a40dae3662b19a615427675e0a7cfd4a1907ea5ab51c890ad27e4f0a84d5c65267d6cb9970cd39bb261e462a963668d

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 sapslaj
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# RbYoutubeDL
+
+Ruby wrapper for [youtube-dl](http://rg3.github.io/youtube-dl/), forked from [youtube-dl.rb](https://github.com/layer8x/youtube-dl.rb).
+
+## Install the gem
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rb-youtube-dl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rb-youtube-dl
+
+## Install youtube-dl
+This gem ships with the latest (working) version of youtube-dl built-in, so you don't have to install youtube-dl at all! Unless you want to.
+
+Refer to the gem version patch and revision to see what version of youtube-dl is being bundled.
+
+Some features of youtube-dl require ffmpeg or avconf to be installed.  Normally these are available for installation from your distribution's repositories.
+
+## Usage
+
+Pretty simple.
+
+```ruby
+RbYoutubeDL.download "https://www.youtube.com/watch?v=gvdf5n-zI14", output: 'some_file.mp4'
+```
+
+All options available to youtube-dl can be passed to the options hash
+
+```ruby
+options = {
+  username: 'someone',
+  password: 'password1',
+  rate_limit: '50K',
+  format: :worst,
+  continue: false
+}
+
+RbYoutubeDL.download "https://www.youtube.com/watch?v=gvdf5n-zI14", options
+```
+
+Options passed as `options = {option: true}` or `options = {option: false}` are passed to youtube-dl as `--option` or `--no-option`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Pass test suite (`rake test`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+Remember: commit now, commit often.

data/lib/rb-youtube-dl/options.rb

@@ -0,0 +1,173 @@
+module RbYoutubeDL
+  # Option and configuration getting, setting, and storage, and all that
+  class Options
+    # @return [Hash] key value storage object
+    attr_accessor :store
+
+    # @return [Array] array of keys that won't be saved to the options store
+    attr_accessor :banned_keys
+
+    # Options initializer
+    #
+    # @param options [Hash] a hash of options
+    def initialize(options = {})
+      if options.is_a? Hash
+        @store = options
+      else
+        @store = options.to_h
+      end
+
+      @banned_keys = []
+    end
+
+    # Returns options as a hash
+    #
+    # @return [Hash] hash of options
+    def to_hash
+      remove_banned
+      @store
+    end
+    alias_method :to_h, :to_hash
+
+    # Iterate through the paramized keys and values.
+    #
+    # @yield [paramized_key, value]
+    # @return [Object] @store
+    #
+    # 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]
+    # @return [Object] @store
+    def each_paramized_key
+      @store.each_key do |key|
+        yield(key, paramize(key))
+      end
+    end
+
+    # Set options using a block
+    #
+    # @yield [config] self
+    def configure
+      yield(self) if block_given?
+      remove_banned
+      self
+    end
+
+    # Get option with brackets syntax
+    #
+    # @param key [Object] key
+    # @return [Object] value
+    def [](key)
+      remove_banned
+      return nil if banned? key
+      @store[key.to_sym]
+    end
+
+    # Set option with brackets syntax
+    #
+    # @param key [Object] key
+    # @param value [Object] value
+    # @return [Object] whatever Hash#= returns
+    def []=(key, value)
+      remove_banned
+      return nil if banned? key
+      @store[key.to_sym] = value
+    end
+
+    # Merge options with given hash, removing banned keys, and returning a
+    # new instance of Options.
+    #
+    # @param hash [Hash] Hash to merge options with
+    # @return [RbYoutubeDL::Options] Merged Options instance
+    def with(hash)
+      merged = Options.new(@store.merge(hash.to_h))
+      merged.banned_keys = @banned_keys
+      merged.send(:remove_banned)
+      merged
+    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)
+      remove_banned
+      if method.to_s.include? '='
+        method = method.to_s.tr('=', '').to_sym
+        return nil if banned? method
+        @store[method] = args.first
+      else
+        return nil if banned? method
+        @store[method]
+      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
+    #
+    # @return [Object] @store
+    def sanitize_keys!
+      # Symbolize
+      manipulate_keys! { |key_name| key_name.is_a?(Symbol) ? key_name : key_name.to_sym }
+
+      # Underscoreize (because Terrapin 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 [RbYoutubeDL::Options] Options with sanitized keys.
+    def sanitize_keys
+      safe_copy = dup
+      safe_copy.sanitize_keys!
+      safe_copy
+    end
+
+    # Check if key is a banned key
+    #
+    # @param key [Object] key to check
+    # @return [Boolean] true if key is banned, false if not.
+    def banned?(key)
+      @banned_keys.include? key
+    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
+
+    # Helper to remove banned keys from store
+    def remove_banned
+      @store.delete_if { |key, value| banned? key }
+    end
+  end
+end

data/lib/rb-youtube-dl/runner.rb

@@ -0,0 +1,96 @@
+module RbYoutubeDL
+  # Utility class for running and managing youtube-dl
+  class Runner
+    include RbYoutubeDL::Support
+
+    # @return [String] URL to download
+    attr_accessor :url
+
+    # @return [RbYoutubeDL::Options] Options access.
+    attr_accessor :options
+
+    # @return [String] Executable path
+    attr_reader :executable_path
+
+    # @return [String] Executable name to use
+    attr_accessor :executable
+
+    # 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 = {})
+      @url = url
+      @options = RbYoutubeDL::Options.new(options)
+      @executable = 'youtube-dl'
+    end
+
+    # Returns usable executable path for youtube-dl
+    #
+    # @return [String] usable executable path for youtube-dl
+    def executable_path
+      @executable_path ||= usable_executable_path_for(@executable)
+    end
+
+    # Returns Terrapin's runner engine
+    #
+    # @return [CommandLineRunner] backend runner class
+    def backend_runner
+      Terrapin::CommandLine.runner
+    end
+
+    # Sets Terrapin's runner engine
+    #
+    # @param terrapin_runner [CommandLineRunner] backend runner class
+    # @return [Object] whatever Terrapin::CommandLine.runner= returns.
+    def backend_runner=(terrapin_runner)
+      Terrapin::CommandLine.runner = terrapin_runner
+    end
+
+    # Returns the command string without running anything
+    #
+    # @return [String] command line string
+    def to_command
+      terrapin_line(options_to_commands).command(@options.store)
+    end
+    alias_method :command, :to_command
+
+    # Runs the command
+    #
+    # @return [String] the output of youtube-dl
+    def run
+      terrapin_line(options_to_commands).run(@options.store)
+    end
+    alias_method :download, :run
+
+    # Options configuration.
+    # Just aliases to options.configure
+    #
+    # @yield [config] options
+    # @param a [Array] arguments to pass to options#configure
+    # @param b [Proc] block to pass to options#configure
+    def configure(*a, &b)
+      options.configure(*a, &b)
+    end
+
+    private
+
+    # Parses options and converts them to Terrapin's syntax
+    #
+    # @return [String] commands ready to do terrapin
+    def options_to_commands
+      commands = []
+      @options.sanitize_keys.each_paramized_key do |key, paramized_key|
+        if @options[key].to_s == 'true'
+          commands.push "--#{paramized_key}"
+        elsif @options[key].to_s == 'false'
+          commands.push "--no-#{paramized_key}"
+        else
+          commands.push "--#{paramized_key} :#{key}"
+        end
+      end
+      commands.push quoted(url)
+      commands.join(' ')
+    end
+  end
+end

data/lib/rb-youtube-dl/support.rb

@@ -0,0 +1,58 @@
+module RbYoutubeDL
+  # Some support methods and glue logic.
+  module Support
+    # 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)
+      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
+
+    alias_method :executable_path_for, :usable_executable_path_for
+
+    # Helper for doing lines of terrapin (initializing, auto executable stuff, etc)
+    #
+    # @param command [String] command switches to run
+    # @param executable_path [String] executable to run. Defaults to usable youtube-dl.
+    # @return [Terrapin::CommandLine] initialized Terrapin instance
+    def terrapin_line(command, executable_path = nil)
+      executable_path = executable_path_for('youtube-dl') if executable_path.nil?
+      Terrapin::CommandLine.new(executable_path, command)
+    end
+
+    # Helper to add quotes to beginning and end of a URL or whatever you want....
+    #
+    # @param url [String] Raw URL
+    # @return [String] Quoted URL
+    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 do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return exe if File.executable?(exe) && !File.directory?(exe)
+        end
+      end
+      nil
+    end
+  end
+end

data/lib/rb-youtube-dl/version.rb

@@ -0,0 +1,10 @@
+
+# Version file
+# If you are updating this code, make sure you are updating
+# lib/rb-youtube-dl/version.rb as well as the Rakefile.
+
+module RbYoutubeDL
+  # Semantic Version as well as the bundled binary version.
+  # "(major).(minor).(teeny).(pre-release).(binary-version)"
+  VERSION = '0.4.0.2021.12.17'.freeze
+end

data/lib/rb-youtube-dl/video.rb

@@ -0,0 +1,110 @@
+module RbYoutubeDL
+  # Video model for using and downloading a single video.
+  class Video < Runner
+    class << self
+      # Instantiate a new Video model and download the video
+      #
+      #   RbYoutubeDL.download 'https://www.youtube.com/watch?v=KLRDLIIl8bA' # => #<RbYoutubeDL::Video:0x00000000000000>
+      #   RbYoutubeDL.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 [RbYoutubeDL::Video] new Video model
+      def download(url, options = {})
+        video = new(url, options)
+        video.download
+        video
+      end
+      alias_method :get, :download
+    end
+
+    # @return [RbYoutubeDL::Options] Download Options for the last download
+    attr_reader :download_options
+
+    # Instantiate new model
+    #
+    # @param url [String] URL to initialize with
+    # @param options [Hash] Options to populate the everything with
+    def initialize(url, options = {})
+      @url = url
+      @options = RbYoutubeDL::Options.new(options.merge(default_options))
+      @options.banned_keys = banned_keys
+    end
+
+    # Download the video.
+    def download
+      raise ArgumentError.new('url cannot be nil') if @url.nil?
+      raise ArgumentError.new('url cannot be empty') if @url.empty?
+
+      set_information_from_json(RbYoutubeDL::Runner.new(url, runner_options).run)
+    end
+
+    alias_method :get, :download
+
+    # Returns the expected filename
+    #
+    # @return [String] Filename downloaded to
+    def filename
+      self._filename
+    end
+
+    # Metadata information for the video, gotten from --print-json
+    #
+    # @return [OpenStruct] information
+    def information
+      @information || grab_information_without_download
+    end
+
+    # Redirect methods for information getting
+    #
+    # @param method [Symbol] method name
+    # @param args [Array] method arguments
+    # @param block [Proc] explict block
+    # @return [Object] The value from @information
+    def method_missing(method, *args, &block)
+      value = information[method]
+
+      if value.nil?
+        super
+      else
+        value
+      end
+    end
+
+  private
+
+    # Add in other default options here.
+    def default_options
+      {
+        color: false,
+        progress: false,
+        print_json: true
+      }
+    end
+
+    def banned_keys
+      [
+        :get_url,
+        :get_title,
+        :get_id,
+        :get_thumbnail,
+        :get_description,
+        :get_duration,
+        :get_filename,
+        :get_format
+      ]
+    end
+
+    def runner_options
+      RbYoutubeDL::Options.new(@options.to_h.merge(default_options))
+    end
+
+    def set_information_from_json(json) # :nodoc:
+      @information = JSON.parse(json, symbolize_names: true)
+    end
+
+    def grab_information_without_download # :nodoc:
+      set_information_from_json(RbYoutubeDL::Runner.new(url, runner_options.with({ skip_download: true})).run)
+    end
+  end
+end

data/lib/rb-youtube-dl.rb

@@ -0,0 +1,51 @@
+require 'terrapin'
+require 'json'
+require 'ostruct'
+
+require 'rb-youtube-dl/version'
+require 'rb-youtube-dl/support'
+require 'rb-youtube-dl/options'
+require 'rb-youtube-dl/runner'
+require 'rb-youtube-dl/video'
+
+# Global RbYoutubeDL module. Contains some convenience methods and all of the business classes.
+module RbYoutubeDL
+  extend self
+  extend Support
+
+  # Downloads given array of URLs with any options passed
+  #
+  # @param urls [String, Array] URLs to download
+  # @param options [Hash] Downloader options
+  # @return [RbYoutubeDL::Video, Array] Video model or array of Video models
+  def download(urls, options = {})
+    if urls.is_a? Array
+      urls.map { |url| RbYoutubeDL::Video.get(url, options) }
+    else
+      RbYoutubeDL::Video.get(urls, options) # Urls should be singular but oh well. url = urls. There. Go cry in a corner.
+    end
+  end
+
+  alias_method :get, :download
+
+  # Lists extractors
+  #
+  # @return [Array] list of extractors
+  def extractors
+    @extractors ||= terrapin_line('--list-extractors').run.split("\n")
+  end
+
+  # Returns youtube-dl's version
+  #
+  # @return [String] youtube-dl version
+  def binary_version
+    @binary_version ||= terrapin_line('--version').run.strip
+  end
+
+  # Returns user agent
+  #
+  # @return [String] user agent
+  def user_agent
+    @user_agent ||= terrapin_line('--dump-user-agent').run.strip
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: rb-youtube-dl
+version: !ruby/object:Gem::Version
+  version: 0.4.0.2021.12.17
+platform: ruby
+authors:
+- drwl
+- sapslaj
+- xNightMare
+autorequire: 
+bindir: vendor/bin
+cert_chain: []
+date: 2022-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terrapin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: in the spirit of pygments.rb and MiniMagick, youtube-dl.rb is a command
+  line wrapper for the python script youtube-dl
+email:
+- git@drewlee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rb-youtube-dl.rb
+- lib/rb-youtube-dl/options.rb
+- lib/rb-youtube-dl/runner.rb
+- lib/rb-youtube-dl/support.rb
+- lib/rb-youtube-dl/version.rb
+- lib/rb-youtube-dl/video.rb
+- vendor/bin/test
+- vendor/bin/youtube-dl
+- vendor/bin/youtube-dl.exe
+homepage: https://github.com/drwl/rb-youtube-dl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/drwl/rb-youtube-dl
+  source_code_uri: https://github.com/drwl/rb-youtube-dl
+  bug_tracker_uri: https://github.com/drwl/rb-youtube-dl/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for youtube-dl, forked from youtube-dl.rb
+test_files: []