ghost_youtube 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7aea7c97a21eb1feee65de32dfba250dde128f273e04dbe70e42d445bff1d1f9
+  data.tar.gz: 5e72801bda63c3e61cbca48f15c757190315bbd82ae819018f24dfd93b0d7642
+SHA512:
+  metadata.gz: 4115cc8d836de229ba5c0e58fdaae6cf5660170f3e0656ddb4f85f3c634a72a5ef95953a9c5d99e9de4316e8353a1a14a78be7e758b240d5b8202e6c2abf195d
+  data.tar.gz: fa7ab99e242877ea5e5c7f37862a428ef5e452ecec703883778922558b70e5745a9a2a9625c9d3dbcf498580687d5f41aaf98f439cbbd328193a7397cbf405f7

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "rake"
+  gem "rspec"
+end

data/README.md

@@ -0,0 +1,236 @@
+# Ghost YouTube Library
+
+A lightweight Ruby gem for downloading videos, captions, and handling cookies with YouTube and Vimeo.
+
+## Requirements
+
+* Ruby 2.5+
+* [yt-dlp](https://github.com/yt-dlp/yt-dlp) must be installed on your system
+
+## Installation
+
+```bash
+# Install yt-dlp first
+pip install -U yt-dlp
+
+# Install the gem
+gem install ghost_youtube
+```
+
+Or add it to your Gemfile:
+
+```ruby
+gem 'ghost_youtube'
+```
+
+## Features
+
+- Download YouTube videos with progress bar
+- Download YouTube videos with specific quality
+- Download YouTube captions
+- Support for YouTube Shorts
+- Support for Vimeo videos
+- Support for using cookies to download videos
+
+## Usage Examples
+
+### 1. Basic Video Download
+
+```ruby
+require 'ghost_youtube'
+
+# Download a YouTube video with default options
+video = Ghost::Download.youtube("https://www.youtube.com/watch?v=ocV8fBuzeh8")
+
+# Download with full path
+puts "Video saved to: #{video}"
+```
+
+### 2. Download with Progress Bar
+
+```ruby
+require 'ghost_youtube'
+
+# Download a YouTube video with a progress bar using "#" character
+url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+Ghost::Download.youtube(url, pro: "#")
+
+# You can use any character for the progress bar
+Ghost::Download.youtube(url, pro: "█")
+```
+
+### 3. Download with Quality Settings
+
+```ruby
+require 'ghost_youtube'
+
+url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+
+# Download best quality
+Ghost::Download.youtube(url, quality: "best")
+
+# Download specific resolution
+Ghost::Download.youtube(url, quality: "bestvideo[height<=720]+bestaudio")
+
+# Video-only download (no audio)
+Ghost::Download.youtube(url, sounde: false)
+```
+
+### 4. Download YouTube Shorts
+
+```ruby
+require 'ghost_youtube'
+
+# YouTube Shorts work the same way as regular videos
+shorts_url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+Ghost::Download.youtube(shorts_url, quality: "best", pro: "#")
+```
+
+### 5. Download YouTube Captions
+
+```ruby
+require 'ghost_youtube'
+
+# Download captions in English
+url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+captions = Ghost::Caption.youtube(url, language: "en")
+puts "Caption file saved to: #{captions}"
+
+# Download captions in a different language
+captions_es = Ghost::Caption.youtube(url, language: "es")
+```
+
+### 6. Download Using Cookies
+
+```ruby
+require 'ghost_youtube'
+
+# Download a video using cookies (for age-restricted or private videos)
+url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+cookies_path = "/path/to/your/cookies.txt"
+video = Ghost::Cookies.youtube(url, cookies_file: cookies_path)
+```
+
+### 7. Download Vimeo Videos
+
+```ruby
+require 'ghost_youtube'
+
+# Download a Vimeo video
+vimeo_url = "https://vimeo.com/12345678"
+Ghost::Download.vimeo(vimeo_url)
+```
+
+### 8. Complete Example Script
+
+```ruby
+require 'ghost_youtube'
+
+puts "==== Ghost YouTube Downloader Demo ===="
+
+# Define a video to download
+video_url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+
+# Download a YouTube video with progress bar
+puts "\n[1] Downloading video with progress bar..."
+Ghost::Download.youtube(video_url, sounde: true, quality: "best", pro: "#")
+
+# Download captions if available
+puts "\n[2] Downloading captions..."
+begin
+  Ghost::Caption.youtube(video_url, language: "en")
+rescue => e
+  puts "Captions not available or error: #{e.message}"
+end
+
+# Download a YouTube Shorts
+puts "\n[3] Downloading a YouTube Shorts..."
+shorts_url = "https://www.youtube.com/watch?v=ocV8fBuzeh8"
+Ghost::Download.youtube(shorts_url, quality: "best", pro: "=")
+
+puts "\nDownloads completed!"
+```
+
+## Cookies Format
+
+For age-restricted videos or videos that require login, you need to provide a cookies file.
+You can export cookies from your browser using extensions like "Get cookies.txt" or "EditThisCookie".
+
+The cookies file should be in Netscape format:
+
+```
+# Netscape HTTP Cookie File
+.youtube.com	TRUE	/	FALSE	1739582099	GPS	1
+.youtube.com	TRUE	/	FALSE	1739582099	VISITOR_INFO1_LIVE	aBcDeFgHiJk
+.youtube.com	TRUE	/	FALSE	1739582099	YSC	AbCdEfGhIjK
+```
+
+## API Reference
+
+### Download Module
+
+- `Ghost::Download.youtube(url, options = {})`
+  - `url`: YouTube video URL
+  - `options`:
+    - `sounde`: Boolean (default: true) - Download with audio
+    - `quality`: String (default: "best") - Quality selection
+    - `pro`: String or nil (default: nil) - Progress bar character
+
+- `Ghost::Download.vimeo(url, options = {})`
+  - `url`: Vimeo video URL
+  - `options`: Currently not used
+
+### Caption Module
+
+- `Ghost::Caption.youtube(url, language: 'en')`
+  - `url`: YouTube video URL
+  - `language`: String (default: 'en') - Caption language code
+
+### Cookies Module
+
+- `Ghost::Cookies.youtube(url, cookies_file:)`
+  - `url`: YouTube video URL
+  - `cookies_file`: Path to cookies file in Netscape format
+
+## How It Works
+
+Ghost YouTube uses the powerful [yt-dlp](https://github.com/yt-dlp/yt-dlp) program under the hood, 
+which is a feature-rich YouTube-DL fork with additional features and fixes.
+
+The library provides a simple Ruby interface to access the most common functionality:
+
+```ruby
+# This Ruby code:
+Ghost::Download.youtube(url, sounde: true, quality: "best", pro: "#")
+
+# Executes this command:
+yt-dlp -f "bestvideo+bestaudio/best" --merge-output-format mp4 <url>
+```
+
+## Error Handling
+
+The library provides specific error classes for different failure scenarios:
+
+```ruby
+begin
+  Ghost::Download.youtube("https://invalid-url")
+rescue Ghost::Errors::DownloadError => e
+  puts "Download failed: #{e.message}"
+end
+
+begin
+  Ghost::Caption.youtube("https://www.youtube.com/watch?v=ocV8fBuzeh8", language: "xx")
+rescue Ghost::Errors::CaptionError => e
+  puts "Caption download failed: #{e.message}"
+end
+
+begin
+  Ghost::Cookies.youtube("https://www.youtube.com/watch?v=ocV8fBuzeh8", cookies_file: "/nonexistent/path")
+rescue Ghost::Errors::CookiesError => e
+  puts "Cookies download failed: #{e.message}"
+end
+```
+
+## License
+
+This project is licensed under the terms of the MIT license.# ghost_youtube

data/ghost_youtube.gemspec

@@ -0,0 +1,24 @@
+# ghost_youtube.gemspec
+Gem::Specification.new do |spec|
+    spec.name          = "ghost_youtube"
+    spec.version       = "0.1.0"
+    spec.authors       = ["Maven"]
+  
+    spec.summary       = %q{A Ruby library to download YouTube videos with audio and captions of Videos}
+    spec.description   = %q{
+      GhostYoutube is a pure Ruby gem that wraps the command-line tool, making it
+      easy to download YouTube videos, captions, and videos using cookies. It is designed
+      to be used in any Ruby environment (Ruby, Rails, JRuby, CRuby, etc.).
+    }
+    spec.homepage      = "https://github.com/Abo5/ghost_youtube"
+    spec.license       = "MIT"
+  
+    spec.required_ruby_version = ">= 2.5.0"
+  
+    spec.files         = Dir["lib/**/*", "ghost_youtube.rb", "README.md", "LICENSE", "Gemfile", "ghost_youtube.gemspec"]
+    spec.executables   = []
+    spec.require_paths = ["lib"]
+  
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  end
+  

data/ghost_youtube.rb

@@ -0,0 +1,66 @@
+# ghost_youtube.rb
+
+# Ensure that yt-dlp is installed on the system.
+def ensure_yt_dlp_installed
+  unless system("command -v yt-dlp > /dev/null 2>&1")
+    raise LoadError, "yt-dlp is not installed. Please install it from https://github.com/yt-dlp/yt-dlp"
+  end
+end
+
+ensure_yt_dlp_installed
+
+require_relative 'lib/errors'
+require_relative 'lib/download/youtube'
+require_relative 'lib/download/vimeo'
+require_relative 'lib/caption/youtube_caption'
+require_relative 'lib/cookies/cookies_handler'
+
+module Ghost
+  module Download
+    # DSL method for downloading a YouTube video.
+    # Example usage:
+    #   Ghost::Download.youtube("url", sounde: true, quality: "best", pro: "#")
+    def self.youtube(url, options = {})
+      sound = options.fetch(:sounde, true)
+      # Fix spelling error in parameter name from qualtiy to quality
+      quality = options.fetch(:quality, "best") 
+      # For backward compatibility with existing code
+      quality = options.fetch(:qualtiy, quality) if options.key?(:qualtiy)
+      progress_style = options.fetch(:pro, nil)
+      
+      # Print debug information
+      puts "Downloading video from: #{url}"
+      puts "Video quality: #{quality}"
+      puts "Audio enabled: #{sound}"
+      
+      downloader = Download::Youtube.new(url, quality: quality, sounde: sound, progress: progress_style)
+      downloader.download
+    end
+
+    # DSL method for downloading a Vimeo video.
+    def self.vimeo(url, options = {})
+      downloader = Download::Vimeo.new(url, options)
+      downloader.download
+    end
+  end
+
+  module Caption
+    # DSL method for downloading YouTube captions.
+    # Example usage:
+    #   Ghost::Caption.youtube("url", language: "en")
+    def self.youtube(url, language: 'en')
+      caption_downloader = Caption::YoutubeCaption.new(url, language)
+      caption_downloader.download
+    end
+  end
+
+  module Cookies
+    # DSL method for downloading a YouTube video using cookies.
+    # Example usage:
+    #   Ghost::Cookies.youtube("url", cookies_file: "path/to/cookies.txt")
+    def self.youtube(url, cookies_file:)
+      cookies_handler = Cookies::CookiesHandler.new(url, cookies_file)
+      cookies_handler.download
+    end
+  end
+end

data/lib/caption/youtube_caption.rb

@@ -0,0 +1,24 @@
+# lib/caption/youtube_caption.rb
+require 'open3'
+require_relative '../errors'
+
+module Ghost
+  module Caption
+    class YoutubeCaption
+      def initialize(url, language = 'en')
+        @url = url
+        @language = language
+      end
+
+      def download
+        command = "yt-dlp --write-auto-sub --sub-lang #{@language} --skip-download #{@url}"
+        stdout_str, stderr_str, status = Open3.capture3(command)
+        if status.success?
+          stdout_str
+        else
+          raise Ghost::Errors::CaptionError, "Error during caption download: #{stderr_str}"
+        end
+      end
+    end
+  end
+end

data/lib/cookies/cookies_handler.rb

@@ -0,0 +1,33 @@
+# lib/cookies/cookies_handler.rb
+require 'open3'
+require_relative '../errors'
+
+module Ghost
+  module Cookies
+    class CookiesHandler
+      def initialize(url, cookies_file)
+        @url = url
+        @cookies_file = cookies_file
+      end
+
+      def download
+        # Check if cookies file exists
+        unless File.exist?(@cookies_file)
+          raise Ghost::Errors::DownloadError, "Cookies file does not exist: #{@cookies_file}"
+        end
+        
+        command = "yt-dlp --cookies #{@cookies_file} -f \"bestvideo+bestaudio/best\" --merge-output-format mp4 #{@url}"
+        puts "Executing download with cookies command: #{command}"
+        
+        stdout_str, stderr_str, status = Open3.capture3(command)
+        if status.success?
+          puts "Download with cookies completed successfully!"
+          stdout_str
+        else
+          puts "Error during download with cookies: #{stderr_str}"
+          raise Ghost::Errors::DownloadError, "Error during download with cookies: #{stderr_str}"
+        end
+      end
+    end
+  end
+end

data/lib/download/vimeo.rb

@@ -0,0 +1,19 @@
+# lib/download/vimeo.rb
+require 'open3'
+require_relative '../errors'
+
+module Ghost
+  module Download
+    class Vimeo
+      def initialize(url, options = {})
+        @url = url
+      end
+
+      def download
+        command = "yt-dlp #{@url}"
+        result = system(command)
+        raise Ghost::Errors::DownloadError, "Error during Vimeo download" unless result
+      end
+    end
+  end
+end

data/lib/download/youtube.rb

@@ -0,0 +1,76 @@
+# lib/download/youtube.rb
+require 'open3'
+require_relative '../errors'
+
+module Ghost
+  module Download
+    class Youtube
+      def initialize(url, options = {})
+        @url = url
+        @quality = options.fetch(:quality, "best")
+        @sounde = options.fetch(:sounde, true)
+        @progress = options.fetch(:progress, nil)
+      end
+
+      def download
+        command = build_command
+        # Print the command for debugging
+        puts "Executing command: #{command}"
+        
+        if @progress
+          download_with_progress(command, @progress)
+        else
+          download_without_progress(command)
+        end
+      end
+
+      private
+
+      def build_command
+        if @sounde
+          # Modified command to ensure both video and audio are downloaded
+          "yt-dlp -f \"bestvideo+bestaudio/best\" --merge-output-format mp4 #{@url}"
+        else
+          "yt-dlp -f bestvideo #{@url}"
+        end
+      end
+
+      def download_without_progress(command)
+        stdout_str, stderr_str, status = Open3.capture3(command)
+        if status.success?
+          puts "Download completed successfully!"
+          stdout_str
+        else
+          puts "Error during download: #{stderr_str}"
+          raise Ghost::Errors::DownloadError, "Error during download: #{stderr_str}"
+        end
+      end
+
+      def download_with_progress(command, progress_style)
+        puts "Starting download with progress display..."
+        Open3.popen2e(command) do |stdin, stdout_err, wait_thr|
+          while (line = stdout_err.gets)
+            puts line if line.include?("Merging") # Print merging logs for debugging
+            if match = line.match(/(\d+\.\d+)%/)
+              percentage = match[1].to_f
+              print_progress_bar(percentage, progress_style)
+            end
+          end
+          exit_status = wait_thr.value
+          unless exit_status.success?
+            raise Ghost::Errors::DownloadError, "Error during download with progress"
+          end
+          puts "\nDownload completed successfully!"
+        end
+      end
+
+      def print_progress_bar(percentage, progress_style)
+        total_length = 20
+        filled_length = (percentage.to_f / 100 * total_length).round
+        bar = progress_style * filled_length
+        print "\r#{bar} %#{percentage.round(1)}"
+        $stdout.flush
+      end
+    end
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,13 @@
+# lib/errors.rb
+
+module Ghost
+    module Errors
+        class YlpDlpNotFounde  < StandardError; end
+        class UrlNotFounde < StandardError; end
+        class BaseError < StandardError; end
+        class DownloadError < BaseError; end
+        class CaptionError < BaseError; end
+        class CookiesError < BaseError; end
+    end
+end
+  

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: ghost_youtube
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maven
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-03-08 00:00:00.000000000 Z
+dependencies: []
+description: "\n      GhostYoutube is a pure Ruby gem that wraps the command-line
+  tool, making it\n      easy to download YouTube videos, captions, and videos using
+  cookies. It is designed\n      to be used in any Ruby environment (Ruby, Rails,
+  JRuby, CRuby, etc.).\n    "
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- ghost_youtube.gemspec
+- ghost_youtube.rb
+- lib/caption/youtube_caption.rb
+- lib/cookies/cookies_handler.rb
+- lib/download/vimeo.rb
+- lib/download/youtube.rb
+- lib/errors.rb
+homepage: https://github.com/Abo5/ghost_youtube
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: A Ruby library to download YouTube videos with audio and captions of Videos
+test_files: []