ytdl 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7ff16ab36991f68eb0ed450552918d2875c1b1d54c995d1dfe489975c3e263a0
+  data.tar.gz: 949f1257581559b86ce257b65f4bf3f7a1e9bd8c3ce678f00c58e43b3e88961e
+SHA512:
+  metadata.gz: 3bb295a1865bbd86332f0c36e57cd27a13e116af371eb21177c837b765c07a0a9f2c2477028e15c5a77f69fbdfe538399ff48259cbe88a32ac013462068515a5
+  data.tar.gz: 4fb9df0465aed1b3e8a96ffa4a6852dfad4fe3d393a58c04d4d475dd6b9fad24de6c57823732fd24faf349f3a9a61941b94d69d617c295875ccdf1ba81f10b7b

data/lib/youtube_dl.rb

@@ -0,0 +1,8 @@
+require 'youtube_dl/runner'
+require 'youtube_dl/command'
+
+module YoutubeDL
+  def self.download(url, **options)
+    Runner.new(Command.new(url, **options))
+  end
+end

data/lib/youtube_dl/command.rb

@@ -0,0 +1,49 @@
+require 'shellwords'
+require 'dry/configurable'
+
+module YoutubeDL
+  class Command
+    extend Dry::Configurable
+
+    def config
+      self.class.config
+    end
+
+    setting :executable, 'youtube-dl'
+    setting :default_options, {}
+    setting :forced_options, {
+      newline: true,
+      color: false,
+      write_info_json: true,
+      playlist: false,
+    }
+
+    def initialize(url, **options)
+      @url = url
+      @options =
+        config.default_options
+        .merge(options)
+        .merge(config.forced_options)
+    end
+
+    def arguments
+      @options.flat_map do |option, value|
+        option = option.to_s.gsub('_', '-')
+        case value
+        when [] then nil
+        when true then "--#{option}"
+        when false then "--no-#{option}"
+        else ["--#{option}", value]
+        end
+      end
+    end
+
+    def to_a
+      [config.executable] + arguments + [@url]
+    end
+
+    def to_s
+      Shellwords.join(to_a)
+    end
+  end
+end

data/lib/youtube_dl/listener.rb

@@ -0,0 +1,17 @@
+module YoutubeDL
+  class Listener
+    def initialize
+      @callbacks = Hash.new { |h, k| h[k] = [] }
+    end
+
+    def call(event, state:, line: nil)
+      (@callbacks[event] + @callbacks[:any]).each do |cb|
+        cb.call(state: state, line: line)
+      end
+    end
+
+    def register(event, &block)
+      @callbacks[event] << block
+    end
+  end
+end

data/lib/youtube_dl/output_parser.rb

@@ -0,0 +1,128 @@
+require 'filesize'
+require 'youtube_dl/state'
+
+module YoutubeDL
+  class OutputParser
+    def initialize
+      @state = State.new
+    end
+
+    attr_reader :state
+
+    def process(line)
+      line = line.strip
+
+      m = regex.match(line)
+      return :unparsable if m.nil?
+
+      if m[:destination]
+        state.destination = Pathname(m[:destination])
+        return :destination
+      end
+
+      if m[:info_json]
+        state.info_json = Pathname(m[:info_json]) if m[:info_json]
+        return :info_json
+      end
+
+      if m[:progress]
+        if m[:progress]
+          if m[:progress] == '100'
+            state.progress = 100
+          else
+            state.progress = m[:progress].to_f
+          end
+        end
+        state.total_size = Filesize.from("#{m[:total_size]} #{m[:total_size_unit]}") if m[:total_size]
+        state.speed = Filesize.from("#{m[:speed]} #{m[:speed_unit]}") if m[:speed]
+        return :progress
+      end
+
+      if m[:error]
+        state.error = m[:error] if m[:error]
+        return :error
+      end
+
+      raise 'Not sure how I got here...'
+    end
+
+    private
+
+    def regex
+      %r{
+        #{progress_regex} |
+        #{destination_regex} |
+        #{existing_destination_regex} |
+        #{info_json_regex} |
+        #{error_regex}
+      }x
+    end
+
+    def progress_regex
+      %r{
+        \[download\] \s+
+        #{num_regex('progress')}%
+        (
+          \s+ of \s+
+          #{num_with_unit_regex('total_size')}
+          (
+            \s+ at \s+
+            #{num_with_unit_regex('speed')}
+          )?
+        )?
+      }x
+    end
+
+    def destination_regex
+      %r{
+        \[download\] \s+ Destination: \s+
+        (?<destination>.*)
+      }x
+    end
+
+    def existing_destination_regex
+      %r{
+        \[download\] \s
+        (?<destination>.*?) \s
+        has \s already \s been \s downloaded
+      }x
+    end
+
+    def info_json_regex
+      %r{
+        \[info\] \s Writing \s video \s description \s metadata \s as \s JSON \s to: \s
+        (?<info_json>.*)
+      }x
+    end
+
+    def error_regex
+      %r{
+        ERROR: \s
+        (?<error>.*)
+      }x
+    end
+
+    def num_regex(name)
+      %r{
+        (?<#{name}>
+          \d+(\.\d+)?
+        )
+      }x
+    end
+
+    def unit_regex(name)
+      %r{
+        (?<#{name}_unit>
+          \w+
+        )
+      }x
+    end
+
+    def num_with_unit_regex(name)
+      %r{
+        #{num_regex(name)}
+        #{unit_regex(name)}
+      }x
+    end
+  end
+end

data/lib/youtube_dl/runner.rb

@@ -0,0 +1,58 @@
+require 'pty'
+require 'youtube_dl/listener'
+require 'youtube_dl/output_parser'
+
+module YoutubeDL
+  class Runner
+    def initialize(command, listener: Listener.new)
+      @command = command
+      @listener = listener
+    end
+
+    def call
+      parser = OutputParser.new
+      run(command: @command, parser: parser)
+
+      if parser.state.complete?
+        parser.state.load_and_delete_info_json
+        @listener.call(:complete, state: parser.state)
+      elsif parser.state.error?
+        @listener.call(:error, state: parser.state)
+      else
+        @listener.call(:unclear_exit_state, state: parser.state)
+      end
+
+      parser.state
+    end
+
+    def on(event, &block)
+      @listener.register(event, &block)
+      self
+    end
+
+    def respond_to_missing?(method, *)
+      method.to_s.start_with?('on_') || super
+    end
+
+    def method_missing(method, &block)
+      return super unless method.to_s.start_with?('on_')
+
+      event = method.to_s.sub(/^on_/, '').to_sym
+      on(event, &block)
+    end
+
+    private
+
+    def run(command:, parser:)
+      PTY.spawn(command.to_s) do |stdout, stdin, pid|
+        begin
+          stdout.each do |line|
+            type = parser.process(line)
+            @listener.call(type, state: parser.state, line: line)
+          end
+        rescue Errno::EIO
+        end
+      end
+    end
+  end
+end

data/lib/youtube_dl/state.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module YoutubeDL
+  class State
+    attr_accessor(
+      :progress,
+      :destination,
+      :total_size,
+      :speed,
+      :error,
+      :info_json,
+      :info,
+    )
+
+    def error?
+      !error.nil?
+    end
+
+    def complete?
+      destination&.exist? && (info || info_json&.exist?)
+    end
+
+    def load_and_delete_info_json
+      self.info = JSON.parse(info_json.read())
+      info_json.unlink()
+    end
+  end
+end

data/lib/youtube_dl/version.rb

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

data/lib/ytdl.rb

@@ -0,0 +1 @@
+require 'youtube_dl'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ytdl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Hollmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: 
+email:
+- maxhollmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/youtube_dl.rb
+- lib/youtube_dl/command.rb
+- lib/youtube_dl/listener.rb
+- lib/youtube_dl/output_parser.rb
+- lib/youtube_dl/runner.rb
+- lib/youtube_dl/state.rb
+- lib/youtube_dl/version.rb
+- lib/ytdl.rb
+homepage: https://github.com/maxhollmann/ruby-ytdl
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/maxhollmann/ruby-ytdl
+  bug_tracker_uri: https://github.com/maxhollmann/ruby-ytdl/issues
+  changelog_uri: https://github.com/maxhollmann/ruby-ytdl/releases
+  homepage_uri: https://github.com/maxhollmann/ruby-ytdl
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A wrapper for youtube-dl with progress callbacks
+test_files: []