screenkit 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3dc4a6ebfa5fb6725aa40e4bbe699bcafca860135ef8cca01fc48ab66731392f
-  data.tar.gz: 42df45d24c11f800e20fff4dfc030102bef5747f758ee47378d98a56dd8732f8
+  metadata.gz: 9432b0beeacae6f145c48e9935c18d92c62c08c69ea7177a3d282db689b0d9d5
+  data.tar.gz: 9cbf970a8998f0cb3bd5778489faa0ecc521b800862c1d8c8112cb11e0232bcd
 SHA512:
-  metadata.gz: c0eac47f990100559123217b0a54f1ae84629ea6ff7039c38d6212d72284cce07b10552f92b6504588ab74a013bb3242d8bc19fe66a7a06b0cb3a8014822248b
-  data.tar.gz: 5c43aae473d552c8f0d233c0ab19b8ca1a1eab91b26225b7533c53eb4caeb44e5909cbc5e20c04b66bad939acee49219d0a75f61edb1617e00e209e498546567
+  metadata.gz: 4b952dc0d719ccdf1496b2ee0cb430e9ba8271e5e9373f1859d8132ed68febf86daa9ff063cbc05a75a314de32d8a279eb4336021344caf70e9cc297e8eaac37
+  data.tar.gz: 4660532603407564ab3315a0d21d6af592d5fad3179cbd7bafade4438e97708a95ba2d9eab34fd61507aee02b58c90bed5d487f7affa4951351a1d3442c37d46

data/CHANGELOG.md

@@ -11,6 +11,10 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+# v0.0.8
+
+- [Fixed] Further improvements to support extensions.
+
 ## v0.0.7
 
 - [Fixed] Improve support for extensions.

data/DOCUMENTATION.md

@@ -719,7 +719,9 @@ tts:
 
 ### ElevenLabs Engine
 
-Professional AI voice synthesis.
+The ElevenLabs TTS engine requires an API key. Set it via the `--tts-api-key`
+option when exporting an episode. The API key must be prefixed with
+`eleven_labs:`, e.g. `eleven_labs:sk_c195c0131de...`.
 
 ```yaml
 tts:
@@ -764,21 +766,26 @@ module. Custom engines must implement the `generate` method:
 module ScreenKit
   module TTS
     class CustomEngine < Base
-      extend Shell
-
       # Optional: Define schema path for validation
       def self.schema_path
-        ScreenKit.root_dir.join("screenkit/schemas/tts/custom_engine.json")
+        File.join(__dir__, "yourschema.json")
       end
 
       # This method is required.
+      # The keyword arguments will be all the configuration options, plus
+      # api_key and segments. If you don't care about those, remember to use
+      # the `**` operator to ignore them.
       def self.available?(**)
-        command_exist?("some-command")
+        # If you're running a local command:
+        # command_exist?("some-command")
+
+        # If you're using an API key:
+        # api_key.to_s.start_with?("#{engine_name}:")
       end
 
       # This method is required.
       def generate(text:, output_path:, log_path: nil)
-        # Optional: validate options against JSON schema.
+        # Optional, but recommended: validate options against JSON schema.
         self.class.validate!(options)
 
         # If you need access to previous/next text, you can access the method
@@ -790,11 +797,19 @@ module ScreenKit
         # Write output to output_path
         # Optionally log to log_path
 
-        # Example implementation:
+        # Example calling a command (provided by ScreenKit::Shell)
         # self.class.run_command "some-command",
         #                        "-o", output_path.sub_ext(".wav"),
         #                        text,
         #                        log_path:
+
+        # Example using an API (provided by ScreenKit::HTTP)
+        # response = json_post(
+        #   url: "https://api.example.com/tts",
+        #   headers: {authorization: "Bearer #{api_key}"},
+        #   api_key:,
+        #   log_path:
+        # )
       end
     end
   end
@@ -821,6 +836,7 @@ The engine name is camelized (e.g., `custom_engine` → `CustomEngine`,
 
 - [Search Github](https://github.com/topics/screenkit-tts)
 - [Google Text to Speech](https://github.com/fnando/screenkit-tts-google)
+- [Minimax Text to Speech](https://github.com/fnando/screenkit-tts-minimax)
 
 > [!TIP]
 >
@@ -1121,26 +1137,26 @@ be processed).
 
 ### Common Issues
 
-**"Gem not found" error:**
+#### "Gem not found" error
 
 ```bash
 bundle install
 bundle exec screenkit ...
 ```
 
-**"Schema validation failed":**
+#### Schema validation failed
 
 - Check YAML syntax
 - Verify required fields are present
 - Use schema hints with `yaml-language-server`
 
-**Missing resources:**
+#### Missing resources
 
 - Check `resources_dir` configuration
 - Verify file paths are relative to resource directories
 - Use absolute paths for system resources
 
-**TTS not working:**
+#### TTS not working
 
 - For ElevenLabs: Set `--tts-api-key`
 - For macOS `say`: Verify voice name with `say -v ?`

data/lib/screenkit/http.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module ScreenKit
+  module HTTP
+    # Sends a POST request.
+    # @param url [String] The request URL.
+    # @param params [Hash] The request parameters.
+    # @param headers [Hash] The request headers.
+    # @param api_key [String] The API key to redact from logs.
+    # @param log_path [String, nil] The path to log the request details.
+    # @return [Aitch::Response] The response.
+    def post(url:, params:, headers:, api_key:, log_path: nil)
+      if log_path
+        File.open(log_path, "w") do |f|
+          f << JSON.pretty_generate(url:, params:, headers:)
+        end
+      end
+
+      client = Aitch::Namespace.new
+      client.configure do |config|
+        config.logger = Logger.new(log_path) if log_path
+      end
+
+      client.post(
+        url:,
+        params:,
+        options: {expect: 200},
+        headers: headers.merge(user_agent: "ScreenKit/#{ScreenKit::VERSION}")
+      )
+    ensure
+      redact_file(log_path, api_key)
+    end
+
+    # Sends a JSON POST request.
+    # @param url [String] The request URL.
+    # @param params [Hash] The request parameters.
+    # @param headers [Hash] The request headers.
+    # @param api_key [String] The API key to redact from logs.
+    # @param log_path [String, nil] The path to log the request details.
+    # @return [Aitch::Response] The response.
+    def json_post(headers:, **)
+      headers = headers.merge(content_type: "application/json")
+      post(headers:, **)
+    end
+
+    # Redacts sensitive text from a file.
+    # @param path [String] The file path.
+    # @param text [String] The text to redact.
+    # @return [void]
+    def redact_file(path, text)
+      return unless path
+      return unless File.file?(path)
+
+      content = File.read(path).gsub(text, "[REDACTED]")
+      File.write(path, content)
+    end
+  end
+end

data/lib/screenkit/tts/base.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
+require "json-schema"
+require "aitch"
+require "logger"
+
 module ScreenKit
   module TTS
     class Base
-      require_relative "../core_ext"
       require_relative "../schema_validator"
+      require_relative "../shell"
+      require_relative "../http"
+      require_relative "../core_ext"
+      require_relative "../version"
 
       extend SchemaValidator
+      extend Shell
+      include HTTP
 
       using CoreExt
 
@@ -33,18 +42,18 @@ module ScreenKit
         name.split("::").last.underscore
       end
 
+      def self.api_key_prefix
+        "#{engine_name}:"
+      end
+
       def initialize(id: nil, segments: nil, api_key: nil, **options)
         @segments = Array(segments)
         @options = options
         @id = id
-        @api_key = api_key
-      end
 
-      def redact_file(path, text)
-        return unless File.file?(path)
+        return unless api_key
 
-        content = File.read(path).gsub(text, "[REDACTED]")
-        File.write(path, content)
+        @api_key = api_key.delete_prefix("#{self.class.engine_name}:")
       end
     end
   end

data/lib/screenkit/tts/eleven_labs.rb

@@ -3,13 +3,15 @@
 module ScreenKit
   module TTS
     class ElevenLabs < Base
+      include HTTP
+
       def self.schema_path
         ScreenKit.root_dir
                  .join("screenkit/schemas/tts/elevenlabs.json")
       end
 
       def self.available?(api_key: nil, **)
-        api_key.to_s.empty?
+        api_key.to_s.start_with?(api_key_prefix)
       end
 
       def all_texts
@@ -19,18 +21,6 @@ module ScreenKit
       def generate(output_path:, text:, log_path: nil)
         voice_id = options[:voice_id]
 
-        if log_path
-          File.open(log_path, "w") do |f|
-            f << JSON.pretty_generate(options.merge(text:))
-          end
-        end
-
-        require "aitch"
-
-        Aitch.configure do |config|
-          config.logger = Logger.new(log_path) if log_path
-        end
-
         current_index = all_texts.index { it == text }
 
         if current_index
@@ -41,20 +31,15 @@ module ScreenKit
         params = options.merge(text:, previous_text:, next_text:)
                         .except(:voice_id)
 
-        response = Aitch.post(
+        response = json_post(
           url: "https://api.elevenlabs.io/v1/text-to-speech/#{voice_id}",
-          body: JSON.dump(params),
-          options: {expect: 200},
-          headers: {
-            "content-type": "application/json",
-            "user-agent": "ScreenKit/#{ScreenKit::VERSION}",
-            "xi-api-key": api_key
-          }
+          params:,
+          headers: {"xi-api-key": api_key},
+          api_key:,
+          log_path:
         )
 
         File.binwrite(output_path, response.body)
-      ensure
-        redact_file(log_path, api_key)
       end
     end
   end

data/lib/screenkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ScreenKit
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/screenkit.rb

@@ -10,6 +10,7 @@ require "tty-spinner"
 require "etc"
 require "securerandom"
 require "demo_tape/duration"
+require "aitch"
 
 module ScreenKit
   require_relative "screenkit/version"
@@ -23,6 +24,7 @@ module ScreenKit
   require_relative "screenkit/watermark"
   require_relative "screenkit/spinner"
   require_relative "screenkit/shell"
+  require_relative "screenkit/http"
   require_relative "screenkit/schema_validator"
   require_relative "screenkit/generators/project"
   require_relative "screenkit/generators/episode"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: screenkit
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Nando Vieira
@@ -328,6 +328,7 @@ files:
 - lib/screenkit/generators/project/resources/sounds/pop.mp3
 - lib/screenkit/generators/project/resources/sounds/whoosh.mp3
 - lib/screenkit/generators/project/screenkit.yml
+- lib/screenkit/http.rb
 - lib/screenkit/logfile.rb
 - lib/screenkit/parallel_processor.rb
 - lib/screenkit/path_lookup.rb
@@ -387,10 +388,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/screenkit
   bug_tracker_uri: https://github.com/fnando/screenkit/issues
-  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.7
-  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.7/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.7/README.md
-  license_uri: https://github.com/fnando/screenkit/tree/v0.0.7/LICENSE.md
+  source_code_uri: https://github.com/fnando/screenkit/tree/v0.0.8
+  changelog_uri: https://github.com/fnando/screenkit/tree/v0.0.8/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/screenkit/tree/v0.0.8/README.md
+  license_uri: https://github.com/fnando/screenkit/tree/v0.0.8/LICENSE.md
 rdoc_options: []
 require_paths:
 - lib