remotion_lambda 4.0.237 → 4.0.240

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 817382860723edb867b6d78f22c21a1555bc3576a0ee5a19867e065aee857698
-  data.tar.gz: '0250259ebd44d459edddb82fb135f22ab9ed6ebd58e932ade180d4ac85162855'
+  metadata.gz: db049b473a23e60d311ca20b122b62815f3088332510a2051f33045758cbbb6f
+  data.tar.gz: 6e432c043aed7350b21b59cbbb892d41a9575a392a8c9d82bd3dfec4b2179205
 SHA512:
-  metadata.gz: 319cb6605bedbdedc3c8e291c655cb30b5f2caa3ee3e08f2821ceadb00c6195c49e5494fc156db30de7789988793bf4c07f2eac5beede5c43d21abef948f579e
-  data.tar.gz: a8d5f00288ac1bbc13cd9479f4d737a65a05cf125e77d3c1419671ac89d806ac790a5c155c605069997634492d309ca63f907488e9d2e5b170f22bd86332894e
+  metadata.gz: b611b0056001c614b1c1d625406eb37c09820d56fd32215258a5af7475c024479c770e319435556ba2fe63c3e6b3ed37a554b8396ef96f6dbbcef3763b496246
+  data.tar.gz: 758f064428317292f1dd3efeca70435512eb80e4d096b02228be2f44cbcf9bd650d87ac11d5117b22b4a5572a22958b926647f7037c4c7dff6877e12388f13f5

data/README.md

@@ -0,0 +1,7 @@
+# Remotion Lambda Ruby SDK
+Do not open issues or pull requests here.  
+The actual source code is located in the [Remotion repository](https://remotion.dev/github).  
+This repository is automatically updated when a new version of Remotion is released.
+
+## Installation
+Visit https://www.remotion.dev/docs/lambda/ruby to learn how to install the Remotion Lambda Ruby SDK.

data/lib/remotion_lambda/render_media_on_lambda_payload.rb

@@ -0,0 +1,98 @@
+require_relative 'version'
+
+def get_render_media_on_lambda_payload(
+  bucket_name: nil,
+  codec:,
+  audio_bitrate: nil,
+  audio_codec: nil,
+  color_space: nil,
+  composition: nil,
+  concurrency_per_lambda: 1,
+  crf: nil,
+  delete_after: nil,
+  download_behavior: nil,
+  encoding_buffer_size: nil,
+  encoding_max_rate: nil,
+  env_variables: {},
+  every_nth_frame: 1,
+  force_height: nil,
+  force_path_style: false,
+  force_width: nil,
+  frame_range: nil,
+  frames_per_lambda: nil,
+  image_format: "jpeg",
+  input_props: {},
+  jpeg_quality: 80,
+  log_level: "info",
+  max_retries: 1,
+  metadata: {},
+  muted: false,
+  number_of_gif_loops: 0,
+  offthread_video_cache_size_in_bytes: nil,
+  out_name: nil,
+  overwrite: false,
+  pixel_format: nil,
+  prefer_lossless: false,
+  privacy: "public",
+  pro_res_profile: nil,
+  renderer_function_name: nil,
+  scale: 1,
+  serve_url: "testbed-v6",
+  timeout_in_milliseconds: 30000,
+  video_bitrate: nil,
+  webhook: nil,
+  x264_preset: nil,
+  chromium_options: {}
+)
+
+payload = {
+    audioBitrate: audio_bitrate,
+    audioCodec: audio_codec,
+    codec: codec,
+    colorSpace: color_space,
+    composition: composition,
+    concurrencyPerLambda: concurrency_per_lambda,
+    chromiumOptions: chromium_options,
+    crf: crf,
+    deleteAfter: delete_after,
+    downloadBehavior: download_behavior,
+    encodingBufferSize: encoding_buffer_size,
+    encodingMaxRate: encoding_max_rate,
+    envVariables: env_variables,
+    everyNthFrame: every_nth_frame,
+    forceHeight: force_height,
+    forcePathStyle: force_path_style,
+    forceWidth: force_width,
+    frameRange: frame_range,
+    framesPerLambda: frames_per_lambda,
+    imageFormat: image_format,
+    inputProps: {
+      type: "payload",
+      payload: JSON.generate(input_props)
+    },
+    jpegQuality: jpeg_quality,
+    logLevel: log_level,
+    maxRetries: max_retries,
+    metadata: metadata,
+    muted: muted,
+    numberOfGifLoops: number_of_gif_loops,
+    offthreadVideoCacheSizeInBytes: offthread_video_cache_size_in_bytes,
+    outName: out_name,
+    overwrite: overwrite,
+    pixelFormat: pixel_format,
+    preferLossless: prefer_lossless,
+    privacy: privacy,
+    proResProfile: pro_res_profile,
+    rendererFunctionName: renderer_function_name,
+    scale: scale,
+    serveUrl: serve_url,
+    timeoutInMilliseconds: timeout_in_milliseconds,
+    type: "start",
+    version: VERSION,
+    videoBitrate: video_bitrate,
+    webhook: webhook,
+    x264Preset: x264_preset,
+    bucketName: bucket_name
+  }
+  payload
+end

data/lib/remotion_lambda/render_media_on_lambda_payload_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'render_media_on_lambda_payload'
+require 'json'
+
+# Call get_render_media_on_lambda with sample data
+payload = get_render_media_on_lambda_payload(
+  codec: "h264",
+  metadata: {
+    Author: "Lunar"
+  },
+  bucket_name: nil,
+  composition: "react-svg",
+  webhook: {
+    customData: {
+      hi: "there",
+    },
+    secret: "abc",
+    url: "https://example.com",
+  },
+  download_behavior: {
+    fileName: "hi",
+    type: "download",
+  },
+  input_props: {
+    hi: "there",
+  }
+)
+
+# Print as JSON
+puts JSON.generate(payload)

data/lib/remotion_lambda/render_progress_payload.rb

@@ -0,0 +1,19 @@
+def get_render_progress_payload(
+  render_id:,
+  bucket_name:,
+  force_path_style: false,
+  log_level: 'info',
+  s3_output_provider: nil
+)
+  payload = {
+    "type" => "status",
+    "renderId" => render_id,
+    "bucketName" => bucket_name,
+    "version" => VERSION,
+    "forcePathStyle" => force_path_style,
+    "logLevel" => log_level,
+    "s3OutputProvider" => s3_output_provider
+  }
+
+  payload
+end

data/lib/remotion_lambda/render_progress_payload_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'sdk'
+require_relative 's3_output_provider'
+require_relative 'render_progress_payload'
+
+require 'json'
+
+# Sample data
+render_id = "abcdef"
+bucket_name = "remotion-render"
+
+# Call get_render_progress_payload with sample data
+payload = get_render_progress_payload(
+  render_id: render_id,
+  bucket_name: bucket_name,
+  s3_output_provider: RemotionLambda::S3OutputProvider.new(
+    access_key_id: 'accessKeyId',
+    endpoint: 'https://s3.us-east-1.amazonaws.com',
+    region: 'us-east-1',
+    secret_access_key: 'secretAccessKey'
+  )
+)
+
+# Print as JSON
+puts JSON.generate(payload)

data/lib/remotion_lambda/render_still_on_lambda_payload.rb

@@ -0,0 +1,60 @@
+require_relative 'version'
+
+def get_render_still_on_lambda_payload(
+  bucket_name: nil,
+  composition: nil,
+  delete_after: nil,
+  download_behavior: nil,
+  env_variables: {},
+  force_height: nil,
+  force_path_style: false,
+  force_width: nil,
+  image_format: "jpeg",
+  input_props: {},
+  jpeg_quality: 80,
+  log_level: "info",
+  max_retries: 1,
+  metadata: {},
+  offthread_video_cache_size_in_bytes: nil,
+  out_name: nil,
+  overwrite: false,
+  privacy: "public",
+  scale: 1,
+  serve_url: "testbed-v6",
+  timeout_in_milliseconds: 30000,
+  chromium_options: {},
+  frame: 0
+)
+
+payload = {
+    composition: composition,
+    chromiumOptions: chromium_options,
+    deleteAfter: delete_after,
+    downloadBehavior: download_behavior,
+    envVariables: env_variables,
+    forceHeight: force_height,
+    forcePathStyle: force_path_style,
+    forceWidth: force_width,
+    imageFormat: image_format,
+    inputProps: {
+      type: "payload",
+      payload: JSON.generate(input_props)
+    },
+    jpegQuality: jpeg_quality,
+    logLevel: log_level,
+    maxRetries: max_retries,
+    offthreadVideoCacheSizeInBytes: offthread_video_cache_size_in_bytes,
+    outName: out_name,
+    privacy: privacy,
+    scale: scale,
+    serveUrl: serve_url,
+    timeoutInMilliseconds: timeout_in_milliseconds,
+    type: "still",
+    version: VERSION,
+    bucketName: bucket_name,
+    attempt: 1,
+    streamed: false,
+    frame: frame,
+  }
+  payload
+end

data/lib/remotion_lambda/render_still_on_lambda_payload_spec.rb

@@ -0,0 +1,15 @@
+require_relative 'render_still_on_lambda_payload'
+require 'json'
+
+payload = get_render_still_on_lambda_payload(
+  composition: "still-helloworld",
+  download_behavior: {
+    type: "play-in-browser",
+  },
+  input_props: {
+    message: "Hello from props!",
+  }
+)
+
+# Print as JSON
+puts JSON.generate(payload)

data/lib/remotion_lambda/s3_output_provider.rb

@@ -0,0 +1,19 @@
+module RemotionLambda
+  class S3OutputProvider
+    def initialize(access_key_id:, endpoint:, region:, secret_access_key:)
+      @region = region
+      @access_key_id = access_key_id
+      @secret_access_key = secret_access_key
+      @endpoint = endpoint  
+    end
+
+    def to_json(*args)
+      {
+        region: @region,
+        accessKeyId: @access_key_id,
+        secretAccessKey: @secret_access_key,
+        endpoint: @endpoint
+      }.to_json(*args)
+    end
+  end
+end

data/lib/remotion_lambda/sdk.rb

@@ -0,0 +1,61 @@
+require 'aws-sdk-lambda'
+require 'json'
+require 'logger'
+require_relative 'version'
+
+module RemotionLambda
+  class Client
+    attr_reader :bucket_name, :serve_url
+
+    def initialize(
+      region: ENV.fetch('AWS_REGION', 'us-east-1'),
+      aws_profile: nil
+    )
+      @region = region
+      @aws_profile = aws_profile
+      @lambda_client = create_lambda_client
+    end
+
+    def get_render_progress(function_name, payload)
+      body = invoke(function_name, payload)      
+      raise "Failed to fetch progress: #{body['message']}" if body["type"] == "error"
+      body
+    end
+
+    def render_media_on_lambda(function_name, payload)
+      body = invoke(function_name, payload)      
+      raise "Failed to call renderMediaOnLambda: #{body['message']}" if body["type"] == "error"
+      body
+    end
+
+    def render_still_on_lambda(function_name, payload)
+      body = invoke(function_name, payload)      
+      raise "Failed to call renderStillOnLambda: #{body['message']}" if body["type"] == "error"
+      body
+    end
+
+    private
+
+    # Lambda methods
+    def invoke(function_name, payload)
+      response = @lambda_client.invoke({
+        function_name: function_name,
+        payload: JSON.generate(payload)
+      })
+
+      JSON.parse(response.payload.string)
+    end
+
+    def create_lambda_client
+      Aws::Lambda::Client.new(region: @region, credentials: aws_credentials)
+    end
+
+    def aws_credentials
+      if @aws_profile
+        Aws::SharedCredentials.new(profile_name: @aws_profile)
+      else        
+        Aws::Credentials.new(ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'])
+      end
+    end
+  end
+end 

data/lib/remotion_lambda/version.rb

@@ -0,0 +1 @@
+VERSION = "4.0.240"

data/lib/remotion_lambda.rb

@@ -0,0 +1,14 @@
+require 'aws-sdk-lambda'
+require 'json'
+require 'logger'
+require_relative 'remotion_lambda/version'
+require_relative 'remotion_lambda/render_media_on_lambda_payload'
+require_relative 'remotion_lambda/render_progress_payload'
+require_relative 'remotion_lambda/render_still_on_lambda_payload'
+require_relative 'remotion_lambda/s3_output_provider'
+require_relative 'remotion_lambda/sdk'
+
+module RemotionLambda
+  # This module serves as the namespace for the RemotionLambda gem.
+  # Add any top-level methods, constants, or configuration here if needed.
+end

data/lib/render_media_on_lambda_payload_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'render_media_on_lambda_payload'
+require 'json'
+
+# Call get_render_media_on_lambda with sample data
+payload = get_render_media_on_lambda_payload(
+  codec: "h264",
+  metadata: {
+    Author: "Lunar"
+  },
+  bucket_name: nil,
+  composition: "react-svg",
+  webhook: {
+    customData: {
+      hi: "there",
+    },
+    secret: "abc",
+    url: "https://example.com",
+  },
+  download_behavior: {
+    fileName: "hi",
+    type: "download",
+  },
+  input_props: {
+    hi: "there",
+  }
+)
+
+# Print as JSON
+puts JSON.generate(payload)

data/lib/render_progress_payload_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'sdk'
+require_relative 's3_output_provider'
+require_relative 'render_progress_payload'
+
+require 'json'
+
+# Sample data
+render_id = "abcdef"
+bucket_name = "remotion-render"
+
+# Call get_render_progress_payload with sample data
+payload = get_render_progress_payload(
+  render_id: render_id,
+  bucket_name: bucket_name,
+  s3_output_provider: RemotionLambda::S3OutputProvider.new(
+    access_key_id: 'accessKeyId',
+    endpoint: 'https://s3.us-east-1.amazonaws.com',
+    region: 'us-east-1',
+    secret_access_key: 'secretAccessKey'
+  )
+)
+
+# Print as JSON
+puts JSON.generate(payload)

data/lib/render_still_on_lambda_payload_spec.rb

@@ -0,0 +1,15 @@
+require_relative 'render_still_on_lambda_payload'
+require 'json'
+
+payload = get_render_still_on_lambda_payload(
+  composition: "still-helloworld",
+  download_behavior: {
+    type: "play-in-browser",
+  },
+  input_props: {
+    message: "Hello from props!",
+  }
+)
+
+# Print as JSON
+puts JSON.generate(payload)

data/lib/test_render_spec_media.rb

@@ -0,0 +1,35 @@
+require_relative 'sdk'
+require_relative 'render_media_on_lambda_payload'
+require_relative 'render_progress_payload'
+
+client = RemotionLambda::Client.new(
+  region: 'eu-central-1',
+)  
+
+function_name = ENV.fetch('REMOTION_APP_FUNCTION_NAME')
+
+payload = get_render_media_on_lambda_payload(
+  composition: "still-helloworld",
+  download_behavior: {
+    type: "play-in-browser",
+  },
+  codec: "h264",
+  input_props: {
+    message: "Hello from props!",
+  }
+)
+
+res = client.render_media_on_lambda(function_name, payload)
+puts res
+while true
+  render_progress_payload = get_render_progress_payload(
+    render_id: res["renderId"],
+    bucket_name: res["bucketName"],
+  )
+  progress = client.get_render_progress(function_name, render_progress_payload)
+  puts progress["overallProgress"]
+  break if progress["done"]
+  break if progress["fatalErrorEncountered"]
+  sleep 1
+end
+

data/lib/test_render_spec_still.rb

@@ -0,0 +1,21 @@
+require_relative 'sdk'
+require_relative 'render_still_on_lambda_payload'
+
+client = RemotionLambda::Client.new(
+  region: 'eu-central-1',
+)  
+
+function_name = ENV.fetch('REMOTION_APP_FUNCTION_NAME')
+
+payload = get_render_still_on_lambda_payload(
+  composition: "still-helloworld",
+  download_behavior: {
+    type: "play-in-browser",
+  },
+  input_props: {
+    message: "Hello from props!",
+  }
+)
+
+res = client.render_still_on_lambda(function_name, payload)
+puts res

data/lib/version.rb

@@ -0,0 +1 @@
+VERSION = "4.0.237"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: remotion_lambda
 version: !ruby/object:Gem::Version
-  version: 4.0.237
+  version: 4.0.240
 platform: ruby
 authors:
 - Jonny Burger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-09 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-lambda
@@ -58,11 +58,28 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- lib/remotion_lambda.rb
+- lib/remotion_lambda/render_media_on_lambda_payload.rb
+- lib/remotion_lambda/render_media_on_lambda_payload_spec.rb
+- lib/remotion_lambda/render_progress_payload.rb
+- lib/remotion_lambda/render_progress_payload_spec.rb
+- lib/remotion_lambda/render_still_on_lambda_payload.rb
+- lib/remotion_lambda/render_still_on_lambda_payload_spec.rb
+- lib/remotion_lambda/s3_output_provider.rb
+- lib/remotion_lambda/sdk.rb
+- lib/remotion_lambda/version.rb
 - lib/render_media_on_lambda_payload.rb
+- lib/render_media_on_lambda_payload_spec.rb
 - lib/render_progress_payload.rb
+- lib/render_progress_payload_spec.rb
 - lib/render_still_on_lambda_payload.rb
+- lib/render_still_on_lambda_payload_spec.rb
 - lib/s3_output_provider.rb
 - lib/sdk.rb
+- lib/test_render_spec_media.rb
+- lib/test_render_spec_still.rb
+- lib/version.rb
 homepage: https://rubygems.org/gems/remotion_lambda
 licenses:
 - MIT