sprites-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 846ab9c130433b7107216e8d45207e07b76ea05dd2ad38de7aa8dbd5c8a1f114
-  data.tar.gz: 04b994fac5b97a3f30394d88f04bc7d54a44f19631078df7a074117ea9fdda91
+  metadata.gz: 5da75311f037ca5acfc55a350835e258e792f06221d4f9fab135e7ba567676b0
+  data.tar.gz: c8ef0d1914539b8e618dea6aad2bf9641269d5396397950d1048a9295fc399f7
 SHA512:
-  metadata.gz: a0f1f83d06b4ab7c8f03e1ee78cec8b015dd14a5e2a3e4495a86967727da69cdba6da220ae905eb88fca983a69d413ea1ffe9551197bb040e8faecf1614a39be
-  data.tar.gz: d0e2e75d816cf7d024fca33e3fbd682c4b1ddf2054c8e48f24ac979ce3e051590442d967e2f307dc3a87229dcc8f7f559a7f3d986fa49a3cf2fc6f4c97034d59
+  metadata.gz: cd6283f8bee73c8a9adcb7a039cef763d2109e980da95fd4ec9eccd852af89a89b4b894b5299c2d76afa87edb2bbb61edbe3c4bab5d17dab8169c0d9b037d523
+  data.tar.gz: 9e96fe5d15b8f974fce96a1ced6740aa83ba6a77f78abb7e2a682668b29c03b49c4cd7b4f5f7938c1c3073b1e84e5be9b37ce44864be736d1442f3bf9a887e14

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.2.1
+
+- Fix parsing error for empty API responses
+
 ## 0.2.0
 
 - Command execution via HTTP (`exec.create`)

data/README.md

@@ -1,13 +1,184 @@
-# Sprites Ruby
+# Sprites
 
-Ruby client for the [Sprites](https://sprites.dev) API.
+Ruby client for the [Sprites](https://sprites.dev) API - stateful sandbox environments.
 
 ## Installation
 
+Add this line to your application's Gemfile:
+
 ```ruby
 gem "sprites-ruby"
 ```
 
+## Getting Started
+
+Create a client
+
+```ruby
+client = Sprites::Client.new(token: ENV["SPRITES_TOKEN"])
+```
+
+Or configure globally
+
+```ruby
+Sprites.configure do |config|
+  config.token = ENV["SPRITES_TOKEN"]
+end
+
+client = Sprites::Client.new
+```
+
+## Sprites
+
+Create a sprite
+
+```ruby
+sprite = client.sprites.create(name: "my-sprite")
+```
+
+Create and wait until ready
+
+```ruby
+sprite = client.sprites.create(name: "my-sprite", wait: true)
+```
+
+List sprites
+
+```ruby
+collection = client.sprites.list
+collection.sprites.each { |s| puts s.name }
+```
+
+Get a sprite
+
+```ruby
+sprite = client.sprites.retrieve("my-sprite")
+sprite.status # => "warm"
+```
+
+Update a sprite
+
+```ruby
+sprite = client.sprites.update("my-sprite", url_settings: { auth: "public" })
+```
+
+Delete a sprite
+
+```ruby
+client.sprites.delete("my-sprite")
+```
+
+## Command Execution
+
+Run a command (HTTP, simple)
+
+```ruby
+result = client.exec.create("my-sprite", command: "echo hello")
+result[:output]    # => "hello\n"
+result[:exit_code] # => 0
+```
+
+Run a command (WebSocket, streaming)
+
+```ruby
+result = client.exec.run("my-sprite", ["ls", "-la"])
+result.stdout
+result.stderr
+result.exit_code
+```
+
+Interactive terminal session
+
+```ruby
+client.exec.interactive("my-sprite", ["bash"])
+```
+
+With custom I/O
+
+```ruby
+client.exec.interactive("my-sprite", ["bash"], input: $stdin, output: $stdout)
+```
+
+## Sessions
+
+List active sessions
+
+```ruby
+sessions = client.exec.list("my-sprite")
+sessions.each { |s| puts "#{s[:id]}: #{s[:command]}" }
+```
+
+Attach to a session
+
+```ruby
+client.exec.attach("my-sprite", session_id)
+```
+
+Kill a session
+
+```ruby
+client.exec.kill("my-sprite", session_id)
+```
+
+With a specific signal
+
+```ruby
+client.exec.kill("my-sprite", session_id, signal: "SIGKILL")
+```
+
+## Checkpoints
+
+Create a checkpoint
+
+```ruby
+client.checkpoints.create("my-sprite", comment: "before deploy")
+```
+
+List checkpoints
+
+```ruby
+checkpoints = client.checkpoints.list("my-sprite")
+```
+
+Restore a checkpoint
+
+```ruby
+client.checkpoints.restore("my-sprite", checkpoint_id)
+```
+
+## Network Policies
+
+Get current policy
+
+```ruby
+policy = client.policies.retrieve("my-sprite")
+policy[:egress][:policy] # => "allow-all"
+```
+
+Update policy
+
+```ruby
+client.policies.update("my-sprite", egress: { policy: "block-all" })
+```
+
+## Low-Level WebSocket API
+
+For advanced use cases, use `connect` directly
+
+```ruby
+client.exec.connect("my-sprite", command: ["bash"], tty: true) do |task, session|
+  session.on_stdout { |data| print data }
+  session.on_stderr { |data| $stderr.print data }
+  session.on_exit { |code| puts "Exit: #{code}" }
+
+  task.async do
+    while (line = $stdin.gets)
+      session.write(line)
+    end
+  end
+end
+```
+
 ## Development
 
 ```sh

data/lib/sprites/client.rb

@@ -104,7 +104,11 @@ module Sprites
       raise Error, body.strip
     end
 
-    def parse_json(json) = JSON.parse(json, symbolize_names: true)
+    def parse_json(json)
+      return nil if json.to_s.empty?
+
+      JSON.parse(json, symbolize_names: true)
+    end
 
     def parse_ndjson(body) = body.each_line.map { parse_json(it) }
 

data/lib/sprites/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sprites
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprites-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Ara Hacopian