rubytube 0.3.0 → 0.4.0

data/lib/rubytube/stream_format.rb

@@ -1,152 +1,152 @@
-module RubyTube
-  class StreamFormat
-    PROGRESSIVE_VIDEO = {
-      5 => ["240p", "64kbps"],
-      6 => ["270p", "64kbps"],
-      13 => ["144p", nil],
-      17 => ["144p", "24kbps"],
-      18 => ["360p", "96kbps"],
-      22 => ["720p", "192kbps"],
-      34 => ["360p", "128kbps"],
-      35 => ["480p", "128kbps"],
-      36 => ["240p", nil],
-      37 => ["1080p", "192kbps"],
-      38 => ["3072p", "192kbps"],
-      43 => ["360p", "128kbps"],
-      44 => ["480p", "128kbps"],
-      45 => ["720p", "192kbps"],
-      46 => ["1080p", "192kbps"],
-      59 => ["480p", "128kbps"],
-      78 => ["480p", "128kbps"],
-      82 => ["360p", "128kbps"],
-      83 => ["480p", "128kbps"],
-      84 => ["720p", "192kbps"],
-      85 => ["1080p", "192kbps"],
-      91 => ["144p", "48kbps"],
-      92 => ["240p", "48kbps"],
-      93 => ["360p", "128kbps"],
-      94 => ["480p", "128kbps"],
-      95 => ["720p", "256kbps"],
-      96 => ["1080p", "256kbps"],
-      100 => ["360p", "128kbps"],
-      101 => ["480p", "192kbps"],
-      102 => ["720p", "192kbps"],
-      132 => ["240p", "48kbps"],
-      151 => ["720p", "24kbps"],
-      300 => ["720p", "128kbps"],
-      301 => ["1080p", "128kbps"],
-    }
-
-    DASH_VIDEO = {
-      133 => ["240p", nil],
-      134 => ["360p", nil],
-      135 => ["480p", nil],
-      136 => ["720p", nil],
-      137 => ["1080p", nil],
-      138 => ["2160p", nil],
-      160 => ["144p", nil],
-      167 => ["360p", nil],
-      168 => ["480p", nil],
-      169 => ["720p", nil],
-      170 => ["1080p", nil],
-      212 => ["480p", nil],
-      218 => ["480p", nil],
-      219 => ["480p", nil],
-      242 => ["240p", nil],
-      243 => ["360p", nil],
-      244 => ["480p", nil],
-      245 => ["480p", nil],
-      246 => ["480p", nil],
-      247 => ["720p", nil],
-      248 => ["1080p", nil],
-      264 => ["1440p", nil],
-      266 => ["2160p", nil],
-      271 => ["1440p", nil],
-      272 => ["4320p", nil],
-      278 => ["144p", nil],
-      298 => ["720p", nil],
-      299 => ["1080p", nil],
-      302 => ["720p", nil],
-      303 => ["1080p", nil],
-      308 => ["1440p", nil],
-      313 => ["2160p", nil],
-      315 => ["2160p", nil],
-      330 => ["144p", nil],
-      331 => ["240p", nil],
-      332 => ["360p", nil],
-      333 => ["480p", nil],
-      334 => ["720p", nil],
-      335 => ["1080p", nil],
-      336 => ["1440p", nil],
-      337 => ["2160p", nil],
-      394 => ["144p", nil],
-      395 => ["240p", nil],
-      396 => ["360p", nil],
-      397 => ["480p", nil],
-      398 => ["720p", nil],
-      399 => ["1080p", nil],
-      400 => ["1440p", nil],
-      401 => ["2160p", nil],
-      402 => ["4320p", nil],
-      571 => ["4320p", nil],
-      694 => ["144p", nil],
-      695 => ["240p", nil],
-      696 => ["360p", nil],
-      697 => ["480p", nil],
-      698 => ["720p", nil],
-      699 => ["1080p", nil],
-      700 => ["1440p", nil],
-      701 => ["2160p", nil],
-      702 => ["4320p", nil]
-    }
-
-    DASH_AUDIO = {
-      139 => [nil, "48kbps"],
-      140 => [nil, "128kbps"],
-      141 => [nil, "256kbps"],
-      171 => [nil, "128kbps"],
-      172 => [nil, "256kbps"],
-      249 => [nil, "50kbps"],
-      250 => [nil, "70kbps"],
-      251 => [nil, "160kbps"],
-      256 => [nil, "192kbps"],
-      258 => [nil, "384kbps"],
-      325 => [nil, nil],
-      328 => [nil, nil],
-    }
-
-    ITAGS = {
-      **PROGRESSIVE_VIDEO,
-      **DASH_VIDEO,
-      **DASH_AUDIO
-    }
-
-    HDR = [330, 331, 332, 333, 334, 335, 336, 337]
-    FORMAT_3D = [82, 83, 84, 85, 100, 101, 102]
-    LIVE = [91, 92, 93, 94, 95, 96, 132, 151]
-
-    attr_reader :itag, :resolution, :abr
-
-    def initialize(_itag)
-      @itag = _itag
-
-      @resolution, @abr = ITAGS.fetch(itag)
-    end
-
-    def is_live?
-      !!LIVE[itag]
-    end
-
-    def is_3d?
-      !!FORMAT_3D[itag]
-    end
-
-    def is_hdr?
-      !!HDR[itag]
-    end
-
-    def is_dash?
-      !!DASH_AUDIO[itag] || !!DASH_VIDEO[itag]
-    end
-  end
-end
+module RubyTube
+  class StreamFormat
+    PROGRESSIVE_VIDEO = {
+      5 => ["240p", "64kbps"],
+      6 => ["270p", "64kbps"],
+      13 => ["144p", nil],
+      17 => ["144p", "24kbps"],
+      18 => ["360p", "96kbps"],
+      22 => ["720p", "192kbps"],
+      34 => ["360p", "128kbps"],
+      35 => ["480p", "128kbps"],
+      36 => ["240p", nil],
+      37 => ["1080p", "192kbps"],
+      38 => ["3072p", "192kbps"],
+      43 => ["360p", "128kbps"],
+      44 => ["480p", "128kbps"],
+      45 => ["720p", "192kbps"],
+      46 => ["1080p", "192kbps"],
+      59 => ["480p", "128kbps"],
+      78 => ["480p", "128kbps"],
+      82 => ["360p", "128kbps"],
+      83 => ["480p", "128kbps"],
+      84 => ["720p", "192kbps"],
+      85 => ["1080p", "192kbps"],
+      91 => ["144p", "48kbps"],
+      92 => ["240p", "48kbps"],
+      93 => ["360p", "128kbps"],
+      94 => ["480p", "128kbps"],
+      95 => ["720p", "256kbps"],
+      96 => ["1080p", "256kbps"],
+      100 => ["360p", "128kbps"],
+      101 => ["480p", "192kbps"],
+      102 => ["720p", "192kbps"],
+      132 => ["240p", "48kbps"],
+      151 => ["720p", "24kbps"],
+      300 => ["720p", "128kbps"],
+      301 => ["1080p", "128kbps"],
+    }
+
+    DASH_VIDEO = {
+      133 => ["240p", nil],
+      134 => ["360p", nil],
+      135 => ["480p", nil],
+      136 => ["720p", nil],
+      137 => ["1080p", nil],
+      138 => ["2160p", nil],
+      160 => ["144p", nil],
+      167 => ["360p", nil],
+      168 => ["480p", nil],
+      169 => ["720p", nil],
+      170 => ["1080p", nil],
+      212 => ["480p", nil],
+      218 => ["480p", nil],
+      219 => ["480p", nil],
+      242 => ["240p", nil],
+      243 => ["360p", nil],
+      244 => ["480p", nil],
+      245 => ["480p", nil],
+      246 => ["480p", nil],
+      247 => ["720p", nil],
+      248 => ["1080p", nil],
+      264 => ["1440p", nil],
+      266 => ["2160p", nil],
+      271 => ["1440p", nil],
+      272 => ["4320p", nil],
+      278 => ["144p", nil],
+      298 => ["720p", nil],
+      299 => ["1080p", nil],
+      302 => ["720p", nil],
+      303 => ["1080p", nil],
+      308 => ["1440p", nil],
+      313 => ["2160p", nil],
+      315 => ["2160p", nil],
+      330 => ["144p", nil],
+      331 => ["240p", nil],
+      332 => ["360p", nil],
+      333 => ["480p", nil],
+      334 => ["720p", nil],
+      335 => ["1080p", nil],
+      336 => ["1440p", nil],
+      337 => ["2160p", nil],
+      394 => ["144p", nil],
+      395 => ["240p", nil],
+      396 => ["360p", nil],
+      397 => ["480p", nil],
+      398 => ["720p", nil],
+      399 => ["1080p", nil],
+      400 => ["1440p", nil],
+      401 => ["2160p", nil],
+      402 => ["4320p", nil],
+      571 => ["4320p", nil],
+      694 => ["144p", nil],
+      695 => ["240p", nil],
+      696 => ["360p", nil],
+      697 => ["480p", nil],
+      698 => ["720p", nil],
+      699 => ["1080p", nil],
+      700 => ["1440p", nil],
+      701 => ["2160p", nil],
+      702 => ["4320p", nil]
+    }
+
+    DASH_AUDIO = {
+      139 => [nil, "48kbps"],
+      140 => [nil, "128kbps"],
+      141 => [nil, "256kbps"],
+      171 => [nil, "128kbps"],
+      172 => [nil, "256kbps"],
+      249 => [nil, "50kbps"],
+      250 => [nil, "70kbps"],
+      251 => [nil, "160kbps"],
+      256 => [nil, "192kbps"],
+      258 => [nil, "384kbps"],
+      325 => [nil, nil],
+      328 => [nil, nil],
+    }
+
+    ITAGS = {
+      **PROGRESSIVE_VIDEO,
+      **DASH_VIDEO,
+      **DASH_AUDIO
+    }
+
+    HDR = [330, 331, 332, 333, 334, 335, 336, 337]
+    FORMAT_3D = [82, 83, 84, 85, 100, 101, 102]
+    LIVE = [91, 92, 93, 94, 95, 96, 132, 151]
+
+    attr_reader :itag, :resolution, :abr
+
+    def initialize(_itag)
+      @itag = _itag
+
+      @resolution, @abr = ITAGS.fetch(itag)
+    end
+
+    def is_live?
+      !!LIVE[itag]
+    end
+
+    def is_3d?
+      !!FORMAT_3D[itag]
+    end
+
+    def is_hdr?
+      !!HDR[itag]
+    end
+
+    def is_dash?
+      !!DASH_AUDIO[itag] || !!DASH_VIDEO[itag]
+    end
+  end
+end

data/lib/rubytube/stream_query.rb

@@ -1,36 +1,57 @@
-module RubyTube
-  class StreamQuery < Array
-    attr_reader :streams
-
-    def initialize(fmt_streams)
-      super
-      @streams = fmt_streams
-    end
-
-    def filter(file_extension: nil, only_audio: false, only_video: false, resolution: nil, progressive: false, adaptive: false)
-      filters = []
-
-      filters << ->(stream) { stream.subtype == file_extension } if file_extension
-      filters << ->(stream) { stream.is_audio? } if only_audio
-      filters << ->(stream) { stream.is_video? } if only_video
-      filters << ->(stream) { stream.resolution == resolution } if resolution
-      filters << ->(stream) { stream.is_progressive? } if progressive
-      filters << ->(stream) { stream.is_adaptive? } if adaptive
-
-      r = streams
-      filters.each do |f|
-        r = r.select(&f)
-      end
-
-      StreamQuery.new(r)
-    end
-
-    def get_by_itag(itag)
-      streams.find { |s| s.itag == itag }
-    end
-
-    def get_by_resolution(resolution)
-      streams.find { |s| s.resolution == resolution }
-    end
-  end
-end
+module RubyTube
+  class StreamQuery < Array
+    attr_reader :streams
+
+    def initialize(fmt_streams)
+      super
+      @streams = fmt_streams
+    end
+
+    def filter(file_extension: nil, only_audio: false, only_video: false, resolution: nil, progressive: false, adaptive: false)
+      filters = []
+
+      filters << ->(stream) { stream.subtype == file_extension } if file_extension
+      filters << ->(stream) { stream.is_audio? } if only_audio
+      filters << ->(stream) { stream.is_video? } if only_video
+      filters << ->(stream) { stream.resolution == resolution } if resolution
+      filters << ->(stream) { stream.is_progressive? } if progressive
+      filters << ->(stream) { stream.is_adaptive? } if adaptive
+
+      r = streams
+      filters.each do |f|
+        r = r.select(&f)
+      end
+
+      StreamQuery.new(r)
+    end
+
+    def get_by_itag(itag)
+      streams.find { |s| s.itag == itag }
+    end
+
+    def get_by_resolution(resolution)
+      streams.find { |s| s.resolution == resolution }
+    end
+
+    def order(arg)
+      case arg
+      when Symbol
+        field = arg
+        dir = :asc
+      when Hash
+        field = arg.keys.first
+        dir = arg[field] == :desc ? :desc : :asc
+      end
+
+      allowed_fields = [:file_size, :itag, :resolution]
+      raise InvalidArgumentError unless allowed_fields.include? field
+
+      r = streams
+      r.sort! {|a, b| a.send(field).to_i <=> b.send(field).to_i }
+
+      r.reverse! if dir == :desc
+
+      StreamQuery.new(r)
+    end
+  end
+end

data/lib/rubytube/utils.rb

@@ -1,24 +1,24 @@
-module RubyTube
-  module Utils
-    module_function
-
-    def regex_search(pattern, string, group)
-      match = string.match(pattern)
-      if match
-        return match[group]
-      end
-      nil
-    end
-
-    def target_directory(output_path = nil)
-      if output_path
-        result = File.join(Dir.pwd, output_path) unless File.absolute_path?(output_path)
-      else
-        result = Dir.pwd
-      end
-
-      FileUtils.mkdir_p(result) unless Dir.exist?(result)
-      result
-    end
-  end
-end
+module RubyTube
+  module Utils
+    module_function
+
+    def regex_search(pattern, string, group)
+      match = string.match(pattern)
+      if match
+        return match[group]
+      end
+      nil
+    end
+
+    def target_directory(output_path = nil)
+      if output_path
+        result = File.join(Dir.pwd, output_path) unless File.absolute_path?(output_path)
+      else
+        result = Dir.pwd
+      end
+
+      FileUtils.mkdir_p(result) unless Dir.exist?(result)
+      result
+    end
+  end
+end

data/lib/rubytube/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module RubyTube
-  VERSION = "0.3.0"
-end
+# frozen_string_literal: true
+
+module RubyTube
+  VERSION = "0.4.0"
+end

data/lib/rubytube.rb

@@ -1,68 +1,69 @@
-# frozen_string_literal: true
-
-require 'faraday'
-require 'faraday/follow_redirects'
-
-require_relative 'rubytube/version'
-
-require_relative 'rubytube/cipher'
-require_relative 'rubytube/client'
-require_relative 'rubytube/extractor'
-require_relative 'rubytube/innertube'
-require_relative 'rubytube/monostate'
-require_relative 'rubytube/parser'
-require_relative 'rubytube/request'
-require_relative 'rubytube/stream_format'
-require_relative 'rubytube/stream_query'
-require_relative 'rubytube/stream'
-require_relative 'rubytube/utils'
-
-module RubyTube
-  class Error < StandardError; end
-  class HTMLParseError < StandardError; end
-  class ExtractError < StandardError; end
-  class MaxRetriesExceeded < StandardError; end
-  class VideoUnavailable < StandardError; end
-
-  class RegexMatchError < StandardError
-    def initialize(caller, pattern)
-      super("Regex match error in #{caller} for pattern #{pattern}")
-    end
-  end
-
-  class MembersOnly < StandardError
-    def initialize(video_id)
-      super("Members only video: #{video_id}")
-    end
-  end
-  
-  class RecordingUnavailable < StandardError
-    def initialize(video_id)
-      super("Recording unavailable: #{video_id}")
-    end
-  end
-  
-  class VideoUnavailable < StandardError
-    def initialize(video_id)
-      super("Video unavailable: #{video_id}")
-    end
-  end
-  
-  class VideoPrivate < StandardError
-    def initialize(video_id)
-      super("Video is private: #{video_id}")
-    end
-  end
-  
-  class LiveStreamError < StandardError
-    def initialize(video_id)
-      super("Video is a live stream: #{video_id}")
-    end
-  end
-
-  class << self
-    def new(url)
-      Client.new(url)
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/follow_redirects'
+
+require_relative 'rubytube/version'
+
+require_relative 'rubytube/cipher'
+require_relative 'rubytube/client'
+require_relative 'rubytube/extractor'
+require_relative 'rubytube/innertube'
+require_relative 'rubytube/monostate'
+require_relative 'rubytube/parser'
+require_relative 'rubytube/request'
+require_relative 'rubytube/stream_format'
+require_relative 'rubytube/stream_query'
+require_relative 'rubytube/stream'
+require_relative 'rubytube/utils'
+
+module RubyTube
+  class Error < StandardError; end
+  class HTMLParseError < StandardError; end
+  class ExtractError < StandardError; end
+  class MaxRetriesExceeded < StandardError; end
+  class VideoUnavailable < StandardError; end
+  class InvalidArgumentError < ArgumentError; end
+
+  class RegexMatchError < StandardError
+    def initialize(caller, pattern)
+      super("Regex match error in #{caller} for pattern #{pattern}")
+    end
+  end
+
+  class MembersOnly < StandardError
+    def initialize(video_id)
+      super("Members only video: #{video_id}")
+    end
+  end
+  
+  class RecordingUnavailable < StandardError
+    def initialize(video_id)
+      super("Recording unavailable: #{video_id}")
+    end
+  end
+  
+  class VideoUnavailable < StandardError
+    def initialize(video_id)
+      super("Video unavailable: #{video_id}")
+    end
+  end
+  
+  class VideoPrivate < StandardError
+    def initialize(video_id)
+      super("Video is private: #{video_id}")
+    end
+  end
+  
+  class LiveStreamError < StandardError
+    def initialize(video_id)
+      super("Video is a live stream: #{video_id}")
+    end
+  end
+
+  class << self
+    def new(url)
+      Client.new(url)
+    end
+  end
+end

data/sig/rubytube.rbs

@@ -1,4 +1,4 @@
-module RubyTube
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end
+module RubyTube
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubytube
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - nightswinger
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-28 00:00:00.000000000 Z
+date: 2023-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - stardustkids83@gmail.com
 executables: []
@@ -74,7 +74,7 @@ metadata:
   homepage_uri: https://github.com/nightswinger/rubytube
   source_code_uri: https://github.com/nightswinger/rubytube
   changelog_uri: https://github.com/nightswinger/rubytube
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: RubyTube is a Ruby adaptation of pytube, enabling simplified downloading
   and streaming of YouTube videos in a Ruby-friendly manner.