youtube-transcript-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3a1c99bcacf517440c8be67c4e72f29406c2a7cee87cb844317a5693d5f1aea
+  data.tar.gz: d19bc462f35d6d50dd13c452b3be468c5efb57bf5cdb894c22ad99be409485da
+SHA512:
+  metadata.gz: b87fab280855a4f3f3b22786789085349492d42dd8fff3b14284b762c656757c8bd07fcfbc084ed551bd489c60ab175e4e57216edcd93c27345cfbeac53507f8
+  data.tar.gz: bba30d381a9a685e8c6f1bfeae9fdb40a81a758142a3c0c1659cc1de182266bcb6d85cff575ffade9559c945c9ae23e4c829e10821955605974ee12d499e61e3

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.serena/.gitignore

@@ -0,0 +1 @@
+/cache

data/.serena/memories/code_style_and_conventions.md

@@ -0,0 +1,35 @@
+# Code Style and Conventions
+
+## Ruby Style
+- All Ruby files start with `# frozen_string_literal: true`
+- Uses standard Ruby 3.2+ features
+- Module nesting: `Youtube::Transcript::Rb`
+
+## Naming Conventions
+- Classes: PascalCase (e.g., `YouTubeTranscriptApi`, `FetchedTranscript`)
+- Methods: snake_case (e.g., `find_transcript`, `find_generated_transcript`)
+- Constants: SCREAMING_SNAKE_CASE
+- Files: snake_case matching class names
+
+## Documentation
+- Use YARD-style documentation comments
+- `@param` for parameters
+- `@return` for return values
+- `@raise` for exceptions
+
+## Testing
+- RSpec for tests
+- WebMock for HTTP stubbing
+- Test files in `spec/` directory
+- Naming: `*_spec.rb`
+
+## Error Handling
+- Custom exception classes inheriting from base `Error` class
+- Exception hierarchy matching Python library structure:
+  - `PoTokenRequired`
+  - `TranscriptsDisabled`
+  - `NoTranscriptFound`
+  - `NoTranscriptAvailable`
+  - `VideoUnavailable`
+  - `TranslationLanguageNotAvailable`
+  - `TooManyRequests`

data/.serena/memories/project_overview.md

@@ -0,0 +1,40 @@
+# YouTube Transcript Ruby - Project Overview
+
+## Purpose
+This gem is a Ruby port of the Python library [youtube-transcript-api](https://github.com/jdepoix/youtube-transcript-api).
+It retrieves transcripts/subtitles from YouTube videos without requiring an API key or headless browser.
+
+## Python Library Features to Port
+Based on the original Python library:
+- Fetch transcripts for YouTube videos
+- Support for automatically generated and manually created captions
+- Language preference selection
+- Translation support for translatable transcripts
+- Multiple output formatters (JSON, WebVTT, SRT, plain text, PrettyPrint)
+- HTML formatting preservation option
+- Proxy support (Webshare, Generic HTTP/HTTPS/SOCKS)
+- Error handling for various YouTube states
+
+## Current Implementation Status
+The gem has a basic skeleton but most implementation files are missing:
+- ✅ `lib/youtube/transcript/rb.rb` - Main entry point with convenience methods
+- ✅ `lib/youtube/transcript/rb/version.rb` - Version file (0.1.0)
+- ❌ `lib/youtube/transcript/rb/errors.rb` - Not created yet
+- ❌ `lib/youtube/transcript/rb/transcript.rb` - Not created yet
+- ❌ `lib/youtube/transcript/rb/transcript_list.rb` - Not created yet
+- ❌ `lib/youtube/transcript/rb/transcript_list_fetcher.rb` - Not created yet
+- ❌ `lib/youtube/transcript/rb/api.rb` - Not created yet
+- ❌ `lib/youtube/transcript/rb/formatters.rb` - Not created yet
+
+## Key Classes Expected
+- `YouTubeTranscriptApi` - Main API class with `fetch` and `list` methods
+- `FetchedTranscript` - Represents fetched transcript data with snippets
+- `TranscriptSnippet` / `FetchedTranscriptSnippet` - Individual transcript segments
+- `TranscriptList` - List of available transcripts for a video
+- `Transcript` - Metadata about a transcript (language, is_generated, etc.)
+- Formatters: `TextFormatter`, `JSONFormatter`, `WebVTTFormatter`, `SRTFormatter`, `PrettyPrintFormatter`
+
+## Module Namespace
+```ruby
+Youtube::Transcript::Rb
+```

data/.serena/memories/suggested_commands.md

@@ -0,0 +1,50 @@
+# Suggested Commands
+
+## Setup
+```bash
+# Install dependencies
+bin/setup
+# or
+bundle install
+```
+
+## Testing
+```bash
+# Run all tests
+bundle exec rspec
+
+# Run specific test file
+bundle exec rspec spec/youtube_transcript_api_spec.rb
+
+# Run with verbose output
+bundle exec rspec --format documentation
+```
+
+## Interactive Console
+```bash
+bin/console
+```
+
+## Build & Install Gem
+```bash
+# Build the gem
+bundle exec rake build
+
+# Install locally
+bundle exec rake install
+```
+
+## Git Commands (macOS/Darwin)
+```bash
+git status
+git add .
+git commit -m "message"
+git push
+```
+
+## Utility Commands
+```bash
+ls -la      # List files
+find . -name "*.rb"   # Find Ruby files
+grep -r "pattern" .   # Search in files
+```

data/.serena/memories/task_completion_checklist.md

@@ -0,0 +1,25 @@
+# Task Completion Checklist
+
+When completing a task on this project, ensure:
+
+## Before Committing
+1. Run tests: `bundle exec rspec`
+2. Ensure all tests pass
+3. Check for syntax errors by loading the gem: `bundle exec ruby -e "require 'youtube/transcript/rb'"`
+
+## Code Quality
+- Add `# frozen_string_literal: true` to all new Ruby files
+- Follow existing naming conventions
+- Add YARD documentation for public methods
+- Handle errors appropriately with custom exception classes
+
+## Testing
+- Add/update specs for new functionality
+- Use WebMock to stub HTTP requests
+- Test both success and error cases
+
+## Python Library Alignment
+When porting features, refer to the original Python library:
+https://github.com/jdepoix/youtube-transcript-api
+
+Ensure API compatibility where possible for a similar developer experience.

data/.serena/memories/tech_stack.md

@@ -0,0 +1,20 @@
+# Tech Stack
+
+## Language
+- Ruby (>= 3.2.0)
+
+## Dependencies (Runtime)
+- `faraday` (~> 2.0) - HTTP client library
+- `faraday-follow_redirects` (~> 0.3) - Redirect handling for Faraday
+- `nokogiri` (~> 1.15) - XML/HTML parsing
+
+## Dependencies (Development/Test)
+- `rake` (~> 13.0) - Task runner
+- `rspec` (~> 3.0) - Testing framework
+- `webmock` (~> 3.0) - HTTP request stubbing for tests
+- `irb` - Interactive Ruby console
+
+## Gem Structure
+- Uses bundler gem conventions
+- Gem name: `youtube-transcript-rb`
+- Gemspec: `youtube-transcript-rb.gemspec`

data/.serena/project.yml

@@ -0,0 +1,84 @@
+# list of languages for which language servers are started; choose from:
+#   al               bash             clojure          cpp              csharp           csharp_omnisharp
+#   dart             elixir           elm              erlang           fortran          go
+#   haskell          java             julia            kotlin           lua              markdown
+#   nix              perl             php              python           python_jedi      r
+#   rego             ruby             ruby_solargraph  rust             scala            swift
+#   terraform        typescript       typescript_vts   yaml             zig
+# Note:
+#   - For C, use cpp
+#   - For JavaScript, use typescript
+# Special requirements:
+#   - csharp: Requires the presence of a .sln file in the project folder.
+# When using multiple languages, the first language server that supports a given file will be used for that file.
+# The first language is the default language and the respective language server will be used as a fallback.
+# Note that when using the JetBrains backend, language servers are not used and this list is correspondingly ignored.
+languages:
+- ruby
+
+# the encoding used by text files in the project
+# For a list of possible encodings, see https://docs.python.org/3.11/library/codecs.html#standard-encodings
+encoding: "utf-8"
+
+# whether to use the project's gitignore file to ignore files
+# Added on 2025-04-07
+ignore_all_files_in_gitignore: true
+
+# list of additional paths to ignore
+# same syntax as gitignore, so you can use * and **
+# Was previously called `ignored_dirs`, please update your config if you are using that.
+# Added (renamed) on 2025-04-07
+ignored_paths: []
+
+# whether the project is in read-only mode
+# If set to true, all editing tools will be disabled and attempts to use them will result in an error
+# Added on 2025-04-18
+read_only: false
+
+# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
+# Below is the complete list of tools for convenience.
+# To make sure you have the latest list of tools, and to view their descriptions, 
+# execute `uv run scripts/print_tool_overview.py`.
+#
+#  * `activate_project`: Activates a project by name.
+#  * `check_onboarding_performed`: Checks whether project onboarding was already performed.
+#  * `create_text_file`: Creates/overwrites a file in the project directory.
+#  * `delete_lines`: Deletes a range of lines within a file.
+#  * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
+#  * `execute_shell_command`: Executes a shell command.
+#  * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
+#  * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
+#  * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
+#  * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
+#  * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
+#  * `initial_instructions`: Gets the initial instructions for the current project.
+#     Should only be used in settings where the system prompt cannot be set,
+#     e.g. in clients you have no control over, like Claude Desktop.
+#  * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
+#  * `insert_at_line`: Inserts content at a given line in a file.
+#  * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
+#  * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
+#  * `list_memories`: Lists memories in Serena's project-specific memory store.
+#  * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
+#  * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
+#  * `read_file`: Reads a file within the project directory.
+#  * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
+#  * `remove_project`: Removes a project from the Serena configuration.
+#  * `replace_lines`: Replaces a range of lines within a file with new content.
+#  * `replace_symbol_body`: Replaces the full definition of a symbol.
+#  * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
+#  * `search_for_pattern`: Performs a search for a pattern in the project.
+#  * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
+#  * `switch_modes`: Activates modes by providing a list of their names
+#  * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
+#  * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
+#  * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
+#  * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
+excluded_tools: []
+
+# initial prompt for the project. It will always be given to the LLM upon activating the project
+# (contrary to the memories, which are loaded on demand).
+initial_prompt: ""
+
+project_name: "youtube-transcript-rb"
+included_optional_tools: []

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 jeff.dean
+
+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.