runapi-runway-aleph 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56167311723e82f55c4fb956d06b4341f787b73b69a107e12e22d318ecd8366e
-  data.tar.gz: 93d5a544147ec1d698971b76ca604926ccd391585ff149c5685e7cb3ea391b71
+  metadata.gz: bb42250458bd715b11cf906d442464db0b72bef068064cc5f146ab523311c5e4
+  data.tar.gz: '079ac40cc707ac1926bb61f42e6f457f25d90370a5d8553f6e4fcaaa6b5772c3'
 SHA512:
-  metadata.gz: 7564b5a2e8bcd99e638505fbcf55d87c51ac77c5b2f91a8d8e28b9a4af51acc833167cc8505e6e8dd0f83ed8e0a158602ad7b4e1e8f520ec2b5c9d83967dd44e
-  data.tar.gz: b63e2ba44057ea67f67fea3bf7f58aa5724979170b300edc8c7c53f5285196b4125b10d641d8e4f0651e264aae0d1a36eff0765074e2c9f48bdaa0aa40ad6713
+  metadata.gz: 0a4bb38cd68b19705714d3bb22f105bcaf2f34586201d5cba595b286abdda34ad0cafb598a42b28a0e26338a13e6fe4ad1712dafd0327bb812b25048bc6c24bd
+  data.tar.gz: 9b3b4becf9d920b1c287094bdf5ab64a044f78fc2f4469c7253915726fc36f51081f4a352117ba76cec3ba5974ec70c5d68ab7b330a3db366e37b51eb147870b

data/README.md

@@ -1,19 +1,19 @@
-# Runway Aleph API Ruby SDK for RunAPI
+# Runway Aleph Ruby SDK for RunAPI
 
-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 RunAPI errors in Ruby.
+The Runway Aleph Ruby SDK is the language-specific package for Runway Aleph on RunAPI. Use this package for video generation, animation, and video editing workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.
 
-This runway aleph api README is the Ruby package guide inside the public `runway-aleph-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/runway-aleph; for API reference, use https://runapi.ai/docs#runway-aleph; for SDK docs, use https://runapi.ai/docs#sdk-runway-aleph.
+This README is the Ruby package guide inside the public `runway-aleph-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/runway-aleph; for API reference, use https://runapi.ai/docs#runway-aleph; for SDK docs, use https://runapi.ai/docs#sdk-runway-aleph.
 
 ## Install
 
 ```bash
-gem install runapi-runway_aleph
+gem install runapi-runway-aleph
 ```
 
 ## Quick start
 
 ```ruby
-require "runapi-runway_aleph"
+require "runapi-runway-aleph"
 
 client = RunApi::RunwayAleph::Client.new
 task = client.edit_video.create(
@@ -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://cdn.runapi.ai/public/samples/video.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/contract_gen.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RunApi
+  module RunwayAleph
+    CONTRACT = {
+      "edit-video" => {
+        "models" => ["runway-aleph"],
+        "fields_by_model" => {
+          "runway-aleph" => {
+            "aspect_ratio" => {
+              "enum" => ["16:9", "9:16", "4:3", "3:4", "1:1", "21:9"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_video_url" => {
+              "required" => true
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -3,39 +3,46 @@
 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
 
         ENDPOINT = "/api/v1/runway_aleph/edit_video"
         RESPONSE_CLASS = Types::TaskCreateResponse
         COMPLETED_RESPONSE_CLASS = Types::CompletedEditVideoResponse
+        MODEL = "runway-aleph"
 
         def initialize(http)
           @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)
+          validate_contract!(CONTRACT["edit-video"], params.merge(model: MODEL))
           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
-
-        private
-
-        def validate_params!(params)
-          raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "source_video_url is required" unless param(params, :source_video_url)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-        end
       end
     end
   end

data/lib/runapi/runway_aleph/types.rb

@@ -2,18 +2,21 @@
 
 module RunApi
   module RunwayAleph
+    # Type definitions and constants for Runway Aleph video editing.
     module Types
-      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 +25,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

data/lib/runapi/runway_aleph.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "runway_aleph/types"
+require_relative "runway_aleph/contract_gen"
 require_relative "runway_aleph/resources/edit_video"
 require_relative "runway_aleph/client"
 

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.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,17 +15,17 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-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
+        version: 0.2.7
+description: The Runway Aleph Ruby SDK is the language-specific package for Runway
+  Aleph on RunAPI. Use this package for video generation, animation, and video editing
+  workflows when your application needs request bodies, task status lookup, and consistent
   RunAPI errors in Ruby.
 email:
 - support@runapi.ai
@@ -39,15 +39,18 @@ files:
 - lib/runapi-runway_aleph.rb
 - lib/runapi/runway_aleph.rb
 - lib/runapi/runway_aleph/client.rb
+- lib/runapi/runway_aleph/contract_gen.rb
 - lib/runapi/runway_aleph/resources/edit_video.rb
 - lib/runapi/runway_aleph/types.rb
 homepage: https://runapi.ai/models/runway-aleph
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: runway-aleph
   homepage_uri: https://runapi.ai/models/runway-aleph
   documentation_uri: https://github.com/runapi-ai/runway-aleph-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/runway-aleph-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/runway-aleph-sdk/issues
   changelog_uri: https://github.com/runapi-ai/runway-aleph-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -65,5 +68,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Runway Aleph API Ruby SDK for RunAPI
+summary: Runway Aleph Ruby SDK for RunAPI
 test_files: []