runapi-luma 0.2.5 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35d4110ccae524821e2f501565de79a887afd9e5074453b0c510c384039f94fc
-  data.tar.gz: c7255e052c18688fa8b82365b70b1699b7528d3c472bd0f0169d0522dea75430
+  metadata.gz: 564e060149498fd0586a42c53ddc6ca5379fa7c0d7f20d95f0ec3391521d7d91
+  data.tar.gz: d20f909564ecb4f108afa54b6370bfd1fa8b2169e47a7d3162712811fdfdda8a
 SHA512:
-  metadata.gz: '0348b4a54c531c072eca71e4d94774d96adc3174647d53da27c1dd4b8000e96f5548370bad78320a9e9216a11d1fe1f721175468ea304e2155cf81fdb2f4ae59'
-  data.tar.gz: 57869ae8dd131e7fd59f21e29214bb1559ee8b593c60189a5fa37c77c3f7fbaedb77172188c442475b8ec780fb70f9a545a828b44fbdbb41a900b0f5a1be50df
+  metadata.gz: 2b6c45120f464db14f633bd5131cf9b18fe9bc1c304e88e6a2432f745aaf287945be99655b676476a98f919a9bb44b8d1cf05cdd49c743e3b2454a5922d83a5c
+  data.tar.gz: 292f08bbaaeeac22b5ce62dd29c8bc17d67271b53f213e3bf1696d705db40469dc57320a7b957cf6ba4f17028153692f7bfd2f0b62b8028bc0073b1d1ee07cb1

data/README.md

@@ -1,8 +1,8 @@
-# Luma AI API Ruby SDK for RunAPI
+# Luma API Ruby SDK for RunAPI
 
-The luma ai api Ruby SDK is the language-specific package for Luma on RunAPI. Use this luma ai api package for text-to-video, image-to-video, video editing, and animation flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+The Luma Ruby SDK is the language-specific package for Luma 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 luma ai api README is the Ruby package guide inside the public `luma-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/luma; for API reference, use https://runapi.ai/docs#luma; for SDK docs, use https://runapi.ai/docs#sdk-luma.
+This README is the Ruby package guide inside the public `luma-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/luma; for API reference, use https://runapi.ai/docs#luma; for SDK docs, use https://runapi.ai/docs#sdk-luma.
 
 ## Install
 
@@ -16,17 +16,19 @@ gem install runapi-luma
 require "runapi-luma"
 
 client = RunApi::Luma::Client.new
-task = client.video_modifications.create(
+task = client.modify_video.create(
   # Pass the Luma JSON request body from https://runapi.ai/docs#luma.
 )
-status = client.video_modifications.get(task.id)
+status = client.modify_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::Luma` error classes when building video jobs, Rails workers, or scripts. The available resources include video modifications. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use Ruby keyword arguments and the `RunApi::Luma` error classes when building video jobs, Rails workers, or scripts. The available resources are `modify_video`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

data/lib/runapi/luma/client.rb

@@ -2,14 +2,22 @@
 
 module RunApi
   module Luma
-    class Client
+    # Luma prompt-guided video modification API client.
+    # Applies visual edits to an existing video -- changing style, adjusting atmosphere,
+    # or adding effects -- while preserving the source motion.
+    #
+    # @example
+    #   client = RunApi::Luma::Client.new(api_key: "your-api-key")
+    #   result = client.modify_video.run(
+    #     prompt: "Add a dramatic sunset lighting effect",
+    #     source_video_url: "https://cdn.runapi.ai/public/samples/video.mp4"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::ModifyVideo] Prompt-guided video editing that preserves source motion.
       attr_reader :modify_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
         @modify_video = Resources::ModifyVideo.new(http)
       end
     end

data/lib/runapi/luma/contract_gen.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Luma
+    CONTRACT = {
+      "modify-video" => {
+        "models" => ["luma-modify-video"],
+        "fields_by_model" => {
+          "luma-modify-video" => {
+            "prompt" => {
+              "required" => true
+            },
+            "source_video_url" => {
+              "required" => true
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

data/lib/runapi/luma/resources/modify_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Luma
     module Resources
+      # Luma video modification resource.
+      # Apply prompt-guided visual edits to an existing video while preserving its motion.
       class ModifyVideo
         include RunApi::Core::ResourceHelpers
 
@@ -14,27 +16,32 @@ module RunApi
           @http = http
         end
 
+        # Modify a video and wait until complete.
+        #
+        # @param params [Hash] modification parameters
+        # @return [RunApi::Luma::Types::CompletedModifyVideoResponse] completed task with videos
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
+        # Start a video modification task.
+        #
+        # @param params [Hash] modification parameters
+        # @return [RunApi::Luma::Types::ModifyVideoResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
-          validate_params!(params)
+          validate_contract!(CONTRACT["modify-video"], params)
           request(:post, ENDPOINT, body: params)
         end
 
+        # Get video modification task status by task ID.
+        #
+        # @param id [String] task ID
+        # @return [RunApi::Luma::Types::ModifyVideoResponse] 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)
-        end
       end
     end
   end

data/lib/runapi/luma/types.rb

@@ -2,22 +2,28 @@
 
 module RunApi
   module Luma
+    # Type definitions and constants for Luma video modification.
     module Types
+      # A video file with a download URL.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Base async task response with id and status tracking.
       class AsyncTaskResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
       end
 
+      # Task status response for a video modification operation.
+      # On completion, +videos+ contains the modified output and +sources+ contains the original input.
       class ModifyVideoResponse < AsyncTaskResponse
         optional :videos, [-> { Video }]
         optional :sources, [-> { Video }]
         optional :error, String
       end
 
+      # Completed video modification response with guaranteed output videos.
       class CompletedModifyVideoResponse < ModifyVideoResponse
         required :videos, [-> { Video }]
       end

data/lib/runapi/luma.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-luma
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ 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 luma ai api Ruby SDK is the language-specific package for Luma on
-  RunAPI. Use this luma ai api package for text-to-video, image-to-video, video editing,
-  and animation flows when your application needs JSON request bodies, task status
-  lookup, and consistent RunAPI errors in Ruby.
+        version: 0.2.7
+description: The Luma Ruby SDK is the language-specific package for Luma 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:
 - contact@runapi.ai
 executables: []
@@ -39,15 +39,18 @@ files:
 - lib/runapi-luma.rb
 - lib/runapi/luma.rb
 - lib/runapi/luma/client.rb
+- lib/runapi/luma/contract_gen.rb
 - lib/runapi/luma/resources/modify_video.rb
 - lib/runapi/luma/types.rb
 homepage: https://runapi.ai/models/luma
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: luma
   homepage_uri: https://runapi.ai/models/luma
   documentation_uri: https://github.com/runapi-ai/luma-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/luma-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/luma-sdk/issues
   changelog_uri: https://github.com/runapi-ai/luma-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: Luma AI API Ruby SDK for RunAPI
+summary: Luma API Ruby SDK for RunAPI
 test_files: []