runapi-runway-aleph 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56167311723e82f55c4fb956d06b4341f787b73b69a107e12e22d318ecd8366e
-  data.tar.gz: 93d5a544147ec1d698971b76ca604926ccd391585ff149c5685e7cb3ea391b71
+  metadata.gz: 6cd1a2c7953995524e7ce7c3f88f2667e2b923ed82a239d62fa63e4b9a1870b3
+  data.tar.gz: d24449e7225a3550b3d4c060f05cdd39e36668cae35f0017b30de4d68afc879f
 SHA512:
-  metadata.gz: 7564b5a2e8bcd99e638505fbcf55d87c51ac77c5b2f91a8d8e28b9a4af51acc833167cc8505e6e8dd0f83ed8e0a158602ad7b4e1e8f520ec2b5c9d83967dd44e
-  data.tar.gz: b63e2ba44057ea67f67fea3bf7f58aa5724979170b300edc8c7c53f5285196b4125b10d641d8e4f0651e264aae0d1a36eff0765074e2c9f48bdaa0aa40ad6713
+  metadata.gz: fc7b7a96bb69611bc2efb285636fe28eab811cf00ec7552d34caf9d77036bab3cbefc0af2a279f0f2ef2e137b874c1434adf6d12d95100643c1cc49e2cdbca73
+  data.tar.gz: b1b83c07f3af2882cfce0f564d53ad7cd39bd9e54d95ac0b4ab13a42bd9ec3785de2f14f383c00cbb71cfe0289526f85afbbd4d49553c6be0d33322bbbd746c0

data/README.md

@@ -26,6 +26,8 @@ status = client.edit_video.get(task.id)
 
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
 
+RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
 ## Language notes
 
 Use Ruby keyword arguments and the `RunApi::RunwayAleph` error classes when building video jobs, Rails workers, or scripts. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/runway_aleph/client.rb

@@ -2,14 +2,22 @@
 
 module RunApi
   module RunwayAleph
-    class Client
+    # Runway Aleph prompt-driven video editing API client.
+    # Unlike generation from scratch, Runway Aleph transforms an existing video
+    # using a text prompt, with optional style reference images.
+    #
+    # @example
+    #   client = RunApi::RunwayAleph::Client.new(api_key: "your-api-key")
+    #   result = client.edit_video.run(
+    #     prompt: "Make it look like a watercolor painting",
+    #     source_video_url: "https://example.com/input.mp4"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::EditVideo] Prompt-driven video editing with optional style reference.
       attr_reader :edit_video
 
       def initialize(api_key: nil, **options)
-        @api_key = Core::Auth.resolve_api_key(api_key)
-
-        client_options = Core::ClientOptions.new(api_key: @api_key, **options)
-        http = client_options.http_client || Core::HttpClient.new(client_options)
+        super
         @edit_video = Resources::EditVideo.new(http)
       end
     end

data/lib/runapi/runway_aleph/resources/edit_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module RunwayAleph
     module Resources
+      # Runway Aleph video editing resource.
+      # Transform an existing video using a text prompt and optional style reference image.
       class EditVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,17 +16,29 @@ module RunApi
           @http = http
         end
 
+        # Transform a video and wait until complete.
+        #
+        # @param params [Hash] edit parameters
+        # @return [RunApi::RunwayAleph::Types::CompletedEditVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Start a video editing task.
+        #
+        # @param params [Hash] edit parameters
+        # @return [RunApi::RunwayAleph::Types::TaskCreateResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get video editing task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::RunwayAleph::Types::EditVideoResponse] current task status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end

data/lib/runapi/runway_aleph/types.rb

@@ -2,18 +2,24 @@
 
 module RunApi
   module RunwayAleph
+    # Type definitions and constants for Runway Aleph video editing.
     module Types
+      # Output aspect ratio options. Includes 21:9 ultra-wide for cinematic letterbox output.
       ASPECT_RATIOS = %w[16:9 9:16 4:3 3:4 1:1 21:9].freeze
 
+      # A generated output video.
       class Video < RunApi::Core::BaseModel
         optional :id, String
         required :url, String
       end
 
+      # A reference or extracted image.
       class Image < RunApi::Core::BaseModel
         required :url, String
       end
 
+      # Task status response for a video editing operation.
+      # Includes output videos and images when the task completes.
       class EditVideoResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -22,8 +28,10 @@ module RunApi
         optional :error, String
       end
 
+      # Initial response when a video editing task is created.
       class TaskCreateResponse < EditVideoResponse; end
 
+      # Completed video editing response with guaranteed output videos.
       class CompletedEditVideoResponse < EditVideoResponse
         required :videos, [-> { Video }]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-runway-aleph
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
 description: The runway aleph api Ruby SDK is the language-specific package for Runway
   Aleph on RunAPI. Use this runway aleph api package for prompt-guided video editing
   when your application needs JSON request bodies, task status lookup, and consistent