pipeops-rexec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: daf648a63c80b783c7701b1543ba59903618e531b5560a484b6274d3dde81bb1
+  data.tar.gz: d02a328b6ace511f14c478d3928f79fd5be132624c9b23ee649c9e77f2e3b0ef
+SHA512:
+  metadata.gz: d5e4289f26441de35cc62b9bbd10a354a4ed5b70ef541e90eab7fc9292402986a0e0e99fbc5f34220d4721a08fa1020f41d263f2c97b4b3bd338aac96b7ad91d
+  data.tar.gz: 892d324fd210063705b9722cff702c7680d4b972f6e8529ccbe27c4a84ae9f66cb6ce5acf1e21bc7769ff19ac9adc46fea1d6f0892589ae631dd69a99b0a2410

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-2026 PipeOpsHQ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,211 @@
+# Rexec Ruby SDK
+
+Official Ruby SDK for [Rexec](https://github.com/PipeOpsHQ/rexec) - Terminal as a Service.
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'pipeops-rexec'
+```
+
+Or install directly:
+
+```bash
+gem install pipeops-rexec
+```
+
+## Quick Start
+
+```ruby
+require 'rexec'
+
+client = Rexec::Client.new("https://your-instance.com", "your-token")
+
+# Create a container
+container = client.containers.create(
+  image: "ubuntu:24.04",
+  name: "my-sandbox"
+)
+puts "Created container: #{container.id}"
+
+# Connect to terminal
+terminal = client.terminal.connect(container.id)
+
+terminal.on_data { |data| print data }
+terminal.on_close { puts "\nConnection closed" }
+
+terminal.write("echo 'Hello from Rexec!'\n")
+
+sleep 2  # Wait for output
+
+# Clean up
+terminal.close
+client.containers.delete(container.id)
+```
+
+## API Reference
+
+### Client
+
+```ruby
+require 'rexec'
+
+# Create client
+client = Rexec::Client.new(
+  "https://your-instance.com",
+  "your-api-token",
+  timeout: 30  # optional
+)
+```
+
+### Containers
+
+```ruby
+# List all containers
+containers = client.containers.list
+containers.each do |c|
+  puts "#{c.name}: #{c.status}"
+end
+
+# Get a specific container
+container = client.containers.get("container-id")
+
+# Create a container
+container = client.containers.create(
+  image: "ubuntu:24.04",
+  name: "my-container",
+  environment: { "MY_VAR" => "value" },
+  labels: { "project" => "demo" }
+)
+
+# Start a container
+client.containers.start("container-id")
+
+# Stop a container
+client.containers.stop("container-id")
+
+# Delete a container
+client.containers.delete("container-id")
+```
+
+### Files
+
+```ruby
+# List files in a directory
+files = client.files.list("container-id", "/home")
+files.each do |f|
+  icon = f.directory? ? "📁" : "📄"
+  puts "#{icon} #{f.name}"
+end
+
+# Download a file
+content = client.files.download("container-id", "/etc/passwd")
+puts content
+
+# Create a directory
+client.files.mkdir("container-id", "/home/mydir")
+
+# Delete a file
+client.files.delete("container-id", "/home/file.txt")
+```
+
+### Terminal
+
+```ruby
+# Connect to terminal
+terminal = client.terminal.connect("container-id", cols: 120, rows: 40)
+
+# Send commands
+terminal.write("ls -la\n")
+
+# Handle output
+terminal.on_data do |data|
+  print data
+end
+
+# Handle close
+terminal.on_close do
+  puts "Connection closed"
+end
+
+# Handle errors
+terminal.on_error do |error|
+  puts "Error: #{error}"
+end
+
+# Resize terminal
+terminal.resize(150, 50)
+
+# Close connection
+terminal.close
+```
+
+## Examples
+
+### Run a Script
+
+```ruby
+def run_script(client, container_id, script)
+  output = []
+  done = false
+  
+  terminal = client.terminal.connect(container_id)
+  
+  terminal.on_data { |data| output << data }
+  terminal.on_close { done = true }
+  
+  terminal.write("#{script}\nexit\n")
+  
+  sleep 0.1 until done
+  
+  output.join
+end
+
+result = run_script(client, container.id, "apt update && apt install -y curl")
+puts result
+```
+
+### Batch Operations
+
+```ruby
+require 'concurrent'
+
+def create_batch(client, count)
+  futures = (0...count).map do |i|
+    Concurrent::Future.execute do
+      client.containers.create(
+        image: "ubuntu:24.04",
+        name: "worker-#{i}"
+      )
+    end
+  end
+  
+  futures.map(&:value)
+end
+
+containers = create_batch(client, 5)
+```
+
+## Error Handling
+
+```ruby
+begin
+  container = client.containers.get("invalid-id")
+rescue Rexec::APIError => e
+  puts "API Error #{e.status_code}: #{e.message}"
+rescue Rexec::ConnectionError => e
+  puts "Connection Error: #{e.message}"
+end
+```
+
+## Requirements
+
+- Ruby 3.0+
+- `faraday` for HTTP requests
+- `websocket-client-simple` for terminal connections
+
+## License
+
+MIT License - see [LICENSE](../../LICENSE) for details.

data/lib/rexec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "rexec/version"
+require_relative "rexec/error"
+require_relative "rexec/client"
+require_relative "rexec/container"
+require_relative "rexec/file_service"
+require_relative "rexec/terminal"
+
+# Rexec Ruby SDK - Official SDK for Rexec Terminal as a Service.
+#
+# @example Basic usage
+#   client = Rexec::Client.new("https://your-instance.com", "your-token")
+#   
+#   container = client.containers.create(image: "ubuntu:24.04")
+#   puts "Created: #{container.id}"
+#   
+#   terminal = client.terminal.connect(container.id)
+#   terminal.write("echo hello\n")
+#   terminal.on_data { |data| puts data }
+#   
+#   client.containers.delete(container.id)
+#
+module Rexec
+  class << self
+    # Create a new Rexec client.
+    #
+    # @param base_url [String] Base URL of your Rexec instance
+    # @param token [String] API token for authentication
+    # @return [Rexec::Client]
+    def new(base_url, token, **options)
+      Client.new(base_url, token, **options)
+    end
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: pipeops-rexec
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- PipeOpsHQ
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: websocket-client-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Ruby SDK for interacting with Rexec sandboxed environments. Create containers,
+  execute commands, manage files, and connect to terminals.
+email:
+- support@pipeops.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rexec.rb
+homepage: https://github.com/PipeOpsHQ/rexec
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/PipeOpsHQ/rexec
+  source_code_uri: https://github.com/PipeOpsHQ/rexec/tree/main/sdk/ruby
+  changelog_uri: https://github.com/PipeOpsHQ/rexec/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Official Ruby SDK for Rexec - Terminal as a Service
+test_files: []