runapi-runway-aleph 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9cd72262bb14fb7ac29abeb66862282450a02f228d38be91beb26c8d7394b01
-  data.tar.gz: 87e765ef46036b6ad3c7d3b7f0ab7521bd0655522a31868eb6f6fe7d6cfa1347
+  metadata.gz: 6cd1a2c7953995524e7ce7c3f88f2667e2b923ed82a239d62fa63e4b9a1870b3
+  data.tar.gz: d24449e7225a3550b3d4c060f05cdd39e36668cae35f0017b30de4d68afc879f
 SHA512:
-  metadata.gz: edeb73e9ee44afb57f8fd39e28462359a24a4176e506936ed2a0129ca457cf9d8960724c1f617d7419e50befba5b676b6af9ab8be139ecb34768443c4a027741
-  data.tar.gz: b4540434bdb476866a15e98b3f5edfcd9e2cd586f2fa3f1879ac256b25ca98f5404ad2f4bfa27fa26fc8f4c2a17d748d7e35756fff95b368a1b05660efcb4995
+  metadata.gz: fc7b7a96bb69611bc2efb285636fe28eab811cf00ec7552d34caf9d77036bab3cbefc0af2a279f0f2ef2e137b874c1434adf6d12d95100643c1cc49e2cdbca73
+  data.tar.gz: b1b83c07f3af2882cfce0f564d53ad7cd39bd9e54d95ac0b4ab13a42bd9ec3785de2f14f383c00cbb71cfe0289526f85afbbd4d49553c6be0d33322bbbd746c0

data/README.md

@@ -0,0 +1,47 @@
+# Runway Aleph API 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.
+
+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.
+
+## Install
+
+```bash
+gem install runapi-runway_aleph
+```
+
+## Quick start
+
+```ruby
+require "runapi-runway_aleph"
+
+client = RunApi::RunwayAleph::Client.new
+task = client.edit_video.create(
+  model: "runway-aleph",
+  prompt: "Transform the scene into a watercolor painting style",
+  video_url: "https://cdn.runapi.ai/public/samples/video.mp4"
+)
+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.
+
+## Links
+
+- Model page: https://runapi.ai/models/runway-aleph
+- SDK docs: https://runapi.ai/docs#sdk-runway-aleph
+- Product docs: https://runapi.ai/docs#runway-aleph
+- Pricing and rate limits: https://runapi.ai/models/runway-aleph
+- Provider comparison: https://runapi.ai/providers/runway
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/runway-aleph-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/runway_aleph/client.rb

@@ -2,15 +2,23 @@
 
 module RunApi
   module RunwayAleph
-    class Client
-      attr_reader :video_to_video
+    # 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)
-        @video_to_video = Resources::VideoToVideo.new(http)
+        super
+        @edit_video = Resources::EditVideo.new(http)
       end
     end
   end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+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
+
+        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)
+          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
+end

data/lib/runapi/runway_aleph/types.rb

@@ -2,27 +2,38 @@
 
 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
 
-      class VideoToVideoResponse < RunApi::Core::TaskResponse
+      # 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 }
-        optional :videos, [ -> { Video } ]
-        optional :image_url, String
-        optional :parent_task_id, String
+        optional :videos, [-> { Video }]
+        optional :images, [-> { Image }]
         optional :error, String
       end
 
-      class TaskCreateResponse < VideoToVideoResponse; end
+      # Initial response when a video editing task is created.
+      class TaskCreateResponse < EditVideoResponse; end
 
-      class CompletedVideoToVideoResponse < VideoToVideoResponse
-        required :videos, [ -> { Video } ]
+      # Completed video editing response with guaranteed output videos.
+      class CompletedEditVideoResponse < EditVideoResponse
+        required :videos, [-> { Video }]
       end
     end
   end

data/lib/runapi/runway_aleph.rb

@@ -2,7 +2,7 @@
 
 require "runapi/core"
 require_relative "runway_aleph/types"
-require_relative "runway_aleph/resources/video_to_video"
+require_relative "runway_aleph/resources/edit_video"
 require_relative "runway_aleph/client"
 
 module RunApi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-runway-aleph
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,33 +15,38 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: RunAPI Runway Aleph SDK for JavaScript, Ruby, and Go
+        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
+  RunAPI errors in Ruby.
 email:
 - support@runapi.ai
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - LICENSE
+- README.md
 - lib/runapi-runway_aleph.rb
 - lib/runapi/runway_aleph.rb
 - lib/runapi/runway_aleph/client.rb
-- lib/runapi/runway_aleph/resources/video_to_video.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:
   homepage_uri: https://runapi.ai/models/runway-aleph
-  documentation_uri: https://github.com/runapi-ai/runway-aleph-sdk/blob/main/README.md
+  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
   changelog_uri: https://github.com/runapi-ai/runway-aleph-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -60,5 +65,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Runway Aleph API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Runway Aleph API Ruby SDK for RunAPI
 test_files: []

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

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module RunApi
-  module RunwayAleph
-    module Resources
-      class VideoToVideo
-        include RunApi::Core::ResourceHelpers
-
-        ENDPOINT = "/api/v1/runway_aleph/video_to_video"
-        RESPONSE_CLASS = Types::TaskCreateResponse
-        COMPLETED_RESPONSE_CLASS = Types::CompletedVideoToVideoResponse
-
-        def initialize(http)
-          @http = http
-        end
-
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
-        end
-
-        def create(**params)
-          params = compact_params(params)
-          validate_params!(params)
-          request(:post, ENDPOINT, body: params)
-        end
-
-        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, "video_url is required" unless param(params, :video_url)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-        end
-      end
-    end
-  end
-end