vidload 0.1.11 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f49b5b5ccfd0249511e3d7d9f14e13409d8c578efc202351fd5ebc5d82bbeba
-  data.tar.gz: 88f6b50466ce36d590f1407ad8daecd0dddeee00c4739b9d315d9feab8a3293c
+  metadata.gz: e25ffa5a4bdbfdadd4ee261da31fab7f78e15f6865196bec9ed6824d827918cc
+  data.tar.gz: 85cbad777cffda334cf26c8992fe42b8a209eaed2b6210cea733e1f54f7cadcb
 SHA512:
-  metadata.gz: ff4a4ecf10a0df9d1d339f1d7e2d2af8c033d967b98a137bea85c41e65179e15f28e031c0bbf9fb7eeda36c1c16d05870072c4f98739912cf04241c05bb546bc
-  data.tar.gz: 8867c690eaac5b3ecfa177e22b6d44699657ca50d99f820a71b0f50dda3db8b34c56df99ddcd37c7c2a6a00ead4eda672725daaa6a3c4dce601ee7a0681851b4
+  metadata.gz: 898294dbb222d1d84f31cde9b4b30f7689de6cd18bacf2dd452496346be24f83245d24f52c1125291256020533e5b759091f4c67a7d7a9b47ed7457416a29633
+  data.tar.gz: 6bfae7fb0047df91c7aecfc6cc0f6302f895b6872e52dedad7751a2fbb39f97ee29966a437a5f1ba8b1dfd8324c34704e846cd930e1768324e8a2f0d64343bde

data/lib/vidload/cli.rb

@@ -1,34 +1,32 @@
-require "thor"
+# frozen_string_literal: true
 
-class Vidload::Cli < Thor
-  desc "mp2t VIDEO_URL", "download a mp2t containerized video"
-  method_option :video_name, type: :string, required: false
-  method_option :author_name, type: :string, required: false
-  method_option :hls_url, type: :string, required: true
-  method_option :master_playlist_name, type: :string, required: true
-  method_option :playwright_cli_path, type: :string, required: true
-  method_option :video_referer, type: :string, required: true
-  method_option :ts_seg_pattern, type: :string, required: true
-  method_option :hls_index_pattern, type: :string, required: true
-  def mp2t(video_url)
-    params = {
-      video_url: video_url,
-      video_name: options[:video_name],
-      hls_url: options[:hls_url],
-      master_playlist_name: options[:master_playlist_name],
-      playwright_cli_path: options[:playwright_cli_path],
-      video_referer: options[:video_referer],
-      ts_seg_pattern: options[:ts_seg_pattern],
-      hls_index_pattern: options[:hls_index_pattern],
-      author_name: options[:author_name]
-    }
+require 'thor'
 
-    process_mp2t(params)
-  end
+module Vidload
+  class Cli < Thor
+    desc 'mp2t VIDEO_URL', 'download a mp2t containerized video'
+    method_option :video_name, type: :string, required: false
+    method_option :author_name, type: :string, required: false
+    method_option :output_dir, type: :string, required: false
+    method_option :hls_url, type: :string, required: true
+    method_option :master_playlist_name, type: :string, required: true
+    method_option :playwright_cli_path, type: :string, required: true
+    method_option :video_referer, type: :string, required: true
+    method_option :ts_seg_pattern, type: :string, required: true
+    method_option :hls_index_pattern, type: :string, required: true
+    def mp2t(video_url)
+      params = {
+        video_url: video_url,
+        **options
+      }
+
+      process_mp2t(params)
+    end
 
-  private 
+    private
 
-  def process_mp2t(params)
-    raise NotImplementedError
+    def process_mp2t(params)
+      raise NotImplementedError
+    end
   end
 end

data/lib/vidload/mp2t/api.rb

@@ -1,218 +1,239 @@
-require "playwright"
-require "thread"
-require "tty-spinner"
-require "open3"
-require "m3u8"
-require "io/console"
-
-module Vidload::Mp2t::Api
-  DEMUXER_PATH = "#{__dir__}/remuxer.sh"
-  VIDEO_DOWNLOADED_EVENT_QUEUE = Queue.new
-  VIDEO_INDEX_EVENT_QUEUE = Queue.new
-  ANSI_BOLD_WHITE="\033[1;97m"
-  ANSI_LIGHT_GREY="\033[37m"
-  ANSI_RESET="\033[0m"
-
-  class Downloader
-    attr_reader :video_url, :video_name, :hls_url, :master_playlist_name, :playwright_cli_path, :video_referer
-
-    def initialize(
-      video_url:,
-      video_name:,
-      hls_url:,
-      master_playlist_name:,
-      playwright_cli_path:,
-      video_referer:,
-      ts_seg_pattern:,
-      hls_index_pattern:,
-      author_name:
-    )
-      raise ArgumentError, "video_url must be provided" unless video_url
-      raise ArgumentError, "hls_url must be provided" unless hls_url
-      raise ArgumentError, "master_playlist_name must be provided" unless master_playlist_name
-      raise ArgumentError, "playwright_cli_path must be provided" unless playwright_cli_path
-      raise ArgumentError, "video_referer must be provided" unless video_referer
-      raise ArgumentError, "ts_seg_pattern must be provided" unless ts_seg_pattern
-      raise ArgumentError, "hls_index_pattern must be provided" unless hls_index_pattern
-
-      @video_url = video_url
-      @hls_url = hls_url
-      @master_playlist_name = master_playlist_name
-      @playwright_cli_path = playwright_cli_path
-      @video_referer = video_referer
-      @ts_seg_pattern = ts_seg_pattern
-      @hls_index_pattern = hls_index_pattern
-      @max_lines = IO.console.winsize[0]
-      @author_name = author_name
-      @video_name = if @author_name then "#{@author_name}_#{video_name}" else nil end
-    end
+# frozen_string_literal: true
+
+require 'playwright'
+require 'tty-spinner'
+require 'open3'
+require 'm3u8'
+require 'io/console'
+
+module Vidload
+  module Mp2t
+    module Api
+      DEMUXER_PATH = "#{__dir__}/remuxer.sh"
+      VIDEO_DOWNLOADED_EVENT_QUEUE = Queue.new
+      VIDEO_INDEX_EVENT_QUEUE = Queue.new
+      ANSI_BOLD_WHITE = "\033[1;97m"
+      ANSI_LIGHT_GREY = "\033[37m"
+      ANSI_RESET = "\033[0m"
+
+      class DownloaderBuilder
+        REQUIRED_ARGS = %i[video_url hls_url master_playlist_name playwright_cli_path video_referer
+                           ts_seg_pattern hls_index_pattern].freeze
+
+        def initialize
+          @kwargs = {}
+        end
 
-    def self.from_argv
-      new(
-        video_url: ARGV[0],
-        video_name: ARGV[1],
-        hls_url: ARGV[2],
-        master_playlist_name: ARGV[3],
-        playwright_cli_path: ARGV[4],
-        video_referer: ARGV[5],
-        ts_seg_pattern: ARGV[6],
-        hls_index_pattern: ARGV[7],
-        author_name: ARGV[8],
-      )
-    end
+        def with_kwargs(**kwargs)
+          @kwargs = kwargs
+          self
+        end
 
-    def self.from_hash(hash)
-      new(
-        video_url: hash[:video_url],
-        author_name: hash[:author_name],
-        video_name: hash[:video_name],
-        hls_url: hash[:hls_url],
-        master_playlist_name: hash[:master_playlist_name],
-        playwright_cli_path: hash[:playwright_cli_path],
-        video_referer: hash[:video_referer],
-        ts_seg_pattern: hash[:ts_seg_pattern],
-        hls_index_pattern: hash[:hls_index_pattern],
-      )
-    end
+        def with_video_url(video_url)
+          @kwargs[:video_url] = video_url
+          self
+        end
 
-    # main func to be called in your own scripts defined under web/
-    def download_video(video_starter_callbacks: [])
-      Playwright.create(playwright_cli_executable_path: @playwright_cli_path) do |playwright|
-        browser = playwright.chromium.launch
-        page = browser.new_page
+        def with_video_name(video_name)
+          @kwargs[:video_name] = video_name
+          self
+        end
 
-        manage_video_download(page, *video_starter_callbacks)
-        wait_until_video_downloaded
+        def with_author_name(author_name)
+          @kwargs[:author_name] = author_name
+          self
+        end
 
-        browser.close
-      end
-    end
+        def with_hls_url(hls_url)
+          @kwargs[:hls_url] = hls_url
+          self
+        end
 
-    def display_calling_args
-      puts "Constants:"
-      puts "\tDEMUXER_PATH=#{DEMUXER_PATH}"
-      puts "Called with:"
-      puts "\tvideo_url=#{@video_url}"
-      puts "\tvideo_name=#{@video_name}"
-      puts "\thls_url=#{@hls_url}"
-      puts "\tmaster_playlist_name=#{@master_playlist_name}"
-      puts "\tplaywright_cli_path=#{@playwright_cli_path}"
-      puts "\tvideo_referer=#{@video_referer}"
-      puts "\tts_seg_pattern=#{@ts_seg_pattern}"
-      puts "\thls_index_pattern=#{@hls_index_pattern}"
-      puts "\tauthor_name=#{@author_name}"
-    end
+        def with_master_playlist_name(master_playlist_name)
+          @kwargs[:master_playlist_name] = master_playlist_name
+          self
+        end
 
-    def self.display_with_spinner(loading_msg = "Loading...")
-      spinner = TTY::Spinner.new("[:spinner] #{loading_msg}")
-      spinner.auto_spin
-      yield
-      spinner.success("(done)")
-    end
+        def with_playwright_cli_path(playwright_cli_path)
+          @kwargs[:playwright_cli_path] = playwright_cli_path
+          self
+        end
 
-    private
+        def with_video_referer(video_referer)
+          @kwargs[:video_referer] = video_referer
+          self
+        end
 
-    def manage_video_download(page, *video_starter_callbacks)
-      @seg_qty = nil
-      @pending_hls_response = nil
-      @lines = [""] * @max_lines
-      page.on("response", -> (resp) { listen_to_video_starts(resp) })
-      navigate_to_url(@video_url, page)
-      video_starter_callbacks.each do |callback|
-        res = callback.call(page)
-        if !@video_name && res[:video_name]
-          @video_name = res[:video_name]
+        def with_ts_seg_pattern(ts_seg_pattern)
+          @kwargs[:ts_seg_pattern] = ts_seg_pattern
+          self
         end
-        if !@author_name && res[:author_name]
-          @author_name = res[:author_name]
-          @video_name = "#{@author_name}_#{@video_name}"
+
+        def with_hls_index_pattern(hls_index_pattern)
+          @kwargs[:hls_index_pattern] = hls_index_pattern
+          self
         end
-      end
-    end
 
-    def wait_until_video_downloaded
-      VIDEO_DOWNLOADED_EVENT_QUEUE.pop
-    end
+        def with_output_dir(output_dir)
+          @kwargs[:output_dir] = output_dir
+          self
+        end
 
-    def trigger_video_download(video_url, seg_qty)
-      puts "Video starts. Starting download..."
-      run_cmd(DEMUXER_PATH, video_url, @video_name, @video_referer) do |line|
-        if (line.include?("hls @") || line.include?("https @")) && line.match?(/#{@ts_seg_pattern}/i)
-          seg_nb = line.match(/#{@ts_seg_pattern}/i)[:seg_nb]
-          add_line(line)
-          progress_bar(seg_nb, seg_qty)
+        def build
+          REQUIRED_ARGS.each do |required_arg|
+            raise ArgumentError, "#{required_arg} must be provided" unless @kwargs[required_arg]
+          end
+
+          @kwargs[:output_dir] = './' unless @kwargs[:output_dir]
+          @kwargs[:video_name] = "#{@kwargs[:author_name]}_#{@kwargs[:video_name]}" if @kwargs[:author_name]
+
+          Downloader.new(**@kwargs)
         end
       end
-      print "\r\e[2K"
-      puts "✔ Video downloaded successfully! Available in ./#{@video_name}.mp4"
-      VIDEO_DOWNLOADED_EVENT_QUEUE << true
-    end
 
-    def listen_to_video_starts(response)
-      if response.url.start_with?(@hls_url) && response.url.match?(/#{@hls_index_pattern}/i)
-        body = response.text
-        playlist = M3u8::Playlist.read(body)
-        last_item = playlist.items.last.segment
-        match = last_item.match(/#{@ts_seg_pattern}/i)
-        @seg_qty = match[:seg_nb].to_i
+      class Downloader
+        def initialize(**kwargs)
+          @max_lines = IO.console.winsize[0]
+          @kwargs = kwargs
+        end
 
-        if @pending_hls_response
-          trigger_video_download(@pending_hls_response.url, @seg_qty)
+        def self.builder
+          DownloaderBuilder.new
         end
-      elsif response.url.start_with?(@hls_url) && response.url.include?(@master_playlist_name)
-        if @seg_qty
-          trigger_video_download(response.url, @seg_qty)
-        else
-          @pending_hls_response = response
+
+        def self.from_hash(hash)
+          builder.with_kwargs(**hash).build
         end
-      end
-    end
 
-    def navigate_to_url(url, page)
-      Downloader.display_with_spinner("Page #{url} loading...") do
-        page.goto(url)
-      end
-    end
+        # main func to be called in your own scripts defined under web/
+        def download_video(video_starter_callbacks: [])
+          Playwright.create(playwright_cli_executable_path: @kwargs[:playwright_cli_path]) do |playwright|
+            browser = playwright.chromium.launch
+            page = browser.new_page
 
-    def run_cmd(*cmd)
-      Open3.popen2e(*cmd) do |_stdin, stdout_and_stderr, wait_thr|
-        stdout_and_stderr.each_line do |line|
-          yield line
+            manage_video_download(page, *video_starter_callbacks)
+            wait_until_video_downloaded
+
+            browser.close
+          end
         end
-      end
-    end
 
-    def redraw_lines()
-      return if @lines.empty?
+        def display_calling_args
+          puts 'Constants:'
+          puts "\tDEMUXER_PATH=#{DEMUXER_PATH}"
+          puts 'Called with:'
+          @kwargs.each do |key, value|
+            puts "\t#{key}=#{value}"
+          end
+        end
 
-      printf "\e[H"
-      printf "\e[0J"
+        def self.display_with_spinner(loading_msg = 'Loading...')
+          spinner = TTY::Spinner.new("[:spinner] #{loading_msg}")
+          spinner.auto_spin
+          yield
+          spinner.success('(done)')
+        end
 
-      _rows, cols = IO.console.winsize
-      @lines.each do |line|
-        if line.length > cols
-          puts "#{line.slice(0, cols - 3)}..."
-        else
-          puts line
+        private
+
+        def manage_video_download(page, *video_starter_callbacks)
+          @seg_qty = nil
+          @pending_hls_response = nil
+          @lines = [''] * @max_lines
+          page.on('response', ->(resp) { listen_to_video_starts(resp) })
+          navigate_to_url(@kwargs[:video_url], page)
+          video_starter_callbacks.each do |callback|
+            res = callback.call(page)
+            @kwargs[:video_name] = res[:video_name] if !@kwargs[:video_name] && res[:video_name]
+            if !@kwargs[:author_name] && res[:author_name]
+              @kwargs[:author_name] = res[:author_name]
+              @kwargs[:video_name] = "#{@kwargs[:author_name]}_#{@kwargs[:video_name]}"
+            end
+          end
         end
-      end
-    end
 
-    def add_line(line)
-      @lines << line
-      @lines.shift if @lines.size > @max_lines
-      redraw_lines()
-    end
+        def wait_until_video_downloaded
+          VIDEO_DOWNLOADED_EVENT_QUEUE.pop
+        end
 
-    def progress_bar(current, total, width: 40)
-      ratio = current.to_f / total
-      filled = (ratio * width).round
-      empty = width - filled
+        def trigger_video_download(video_url, seg_qty)
+          puts 'Video starts. Starting download...'
+          run_cmd(DEMUXER_PATH, video_url, "#{@kwargs[:output_dir]}#{@kwargs[:video_name]}",
+                  @kwargs[:video_referer]) do |line|
+            if (line.include?('hls @') || line.include?('https @')) && line.match?(/#{@kwargs[:ts_seg_pattern]}/i)
+              seg_nb = line.match(/#{@kwargs[:ts_seg_pattern]}/i)[:seg_nb]
+              add_line(line)
+              progress_bar(seg_nb, seg_qty)
+            end
+          end
+          print "\r\e[2K"
+          puts "✔ Video downloaded successfully! Available in #{@kwargs[:output_dir]}#{@kwargs[:video_name]}.mp4"
+          VIDEO_DOWNLOADED_EVENT_QUEUE << true
+        end
 
-      bar = "█" * filled + "░" * empty
-      percent = (ratio * 100).round(1)
+        def listen_to_video_starts(response)
+          if response.url.start_with?(@kwargs[:hls_url]) && response.url.match?(/#{@kwargs[:hls_index_pattern]}/i)
+            body = response.text
+            playlist = M3u8::Playlist.read(body)
+            last_item = playlist.items.last.segment
+            match = last_item.match(/#{@kwargs[:ts_seg_pattern]}/i)
+            @seg_qty = match[:seg_nb].to_i
+
+            trigger_video_download(@pending_hls_response.url, @seg_qty) if @pending_hls_response
+          elsif response.url.start_with?(@kwargs[:hls_url]) && response.url.include?(@kwargs[:master_playlist_name])
+            if @seg_qty
+              trigger_video_download(response.url, @seg_qty)
+            else
+              @pending_hls_response = response
+            end
+          end
+        end
 
-      print "\r[#{bar}] #{percent}% (#{current}/#{total})"
+        def navigate_to_url(url, page)
+          Downloader.display_with_spinner("Page #{url} loading...") do
+            page.goto(url)
+          end
+        end
+
+        def run_cmd(*cmd, &block)
+          Open3.popen2e(*cmd) do |_stdin, stdout_and_stderr, _wait_thr|
+            stdout_and_stderr.each_line(&block)
+          end
+        end
+
+        def redraw_lines
+          return if @lines.empty?
+
+          printf "\e[H"
+          printf "\e[0J"
+
+          _rows, cols = IO.console.winsize
+          @lines.each do |line|
+            if line.length > cols
+              puts "#{line.slice(0, cols - 3)}..."
+            else
+              puts line
+            end
+          end
+        end
+
+        def add_line(line)
+          @lines << line
+          @lines.shift if @lines.size > @max_lines
+          redraw_lines
+        end
+
+        def progress_bar(current, total, width: 40)
+          ratio = current.to_f / total
+          filled = (ratio * width).round
+          empty = width - filled
+
+          bar = '█' * filled + '░' * empty
+          percent = (ratio * 100).round(1)
+
+          print "\r[#{bar}] #{percent}% (#{current}/#{total})"
+        end
+      end
     end
   end
 end

data/lib/vidload/mp2t.rb

@@ -1,3 +1,7 @@
-module Vidload::Mp2t
-  require_relative "mp2t/api"
+# frozen_string_literal: true
+
+module Vidload
+  module Mp2t
+    require_relative 'mp2t/api'
+  end
 end

data/lib/vidload/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Vidload
-  VERSION = "0.1.11"
+  VERSION = '0.2.1'
 end

data/lib/vidload.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Vidload
-  require_relative "vidload/version"
-  require_relative "vidload/mp2t"
-  require_relative "vidload/cli"
+  require_relative 'vidload/version'
+  require_relative 'vidload/mp2t'
+  require_relative 'vidload/cli'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vidload
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.1
 platform: ruby
 authors:
 - Patacode <pata.codegineer@gmail.com>
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2026-03-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: m3u8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: playwright-ruby-client
   requirement: !ruby/object:Gem::Requirement
@@ -25,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.58'
 - !ruby/object:Gem::Dependency
-  name: tty-spinner
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: m3u8
+  name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
+        version: '13.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '13.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.85'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.85'
 description:
 email:
 executables: []