sprites-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 696d67a3d2015a55e8eb2e5b6179e37b2594eecbd49c4f355000fc246e45827b
+  data.tar.gz: db6806ee207f88f94a251af9a5681d6c68b2910aa9b5f54d2db627f07bc55209
+SHA512:
+  metadata.gz: fcd1a087a9373e8c3a4d2cd82f2acd6070e5a78645c8b0e893310f2913585f805f0f4486d9a6475d1a3e4cd2dc271893af8b3b175deddb0a4bea15a12ae8d897
+  data.tar.gz: 1507c816cf3081bd407e391ab067160d04e4dd35cfd25a637a4e80ac7bad0bfecb880bb6f690f5058b4c2782980e99ad90644e87db5eb191039d11aff86d2a74

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ara Hacopian
+
+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,20 @@
+# Sprites Ruby
+
+Ruby client for the [Sprites](https://sprites.dev) API.
+
+## Installation
+
+```ruby
+gem "sprites-ruby"
+```
+
+## Development
+
+```sh
+bundle install
+rake test
+```
+
+## License
+
+MIT

data/lib/sprites/client.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+
+module Sprites
+  class Client
+    def initialize(token: nil, base_url: nil)
+      @token = token || Sprites.configuration.token
+      @base_url = base_url || Sprites.configuration.base_url
+    end
+
+    def sprites
+      Resources::Sprites.new(self)
+    end
+
+    def checkpoints
+      Resources::Checkpoints.new(self)
+    end
+
+    def policies
+      Resources::Policies.new(self)
+    end
+
+    def get(path) = handle_response(connection.get(path))
+
+    def post(path, body) = handle_response(connection.post(path, body.to_json, "Content-Type" => "application/json"))
+
+    def put(path, body) = handle_response(connection.put(path, body.to_json, "Content-Type" => "application/json"))
+
+    def delete(path) = handle_response(connection.delete(path))
+
+    def post_stream(path, body, &block)
+      response = connection.post(path, body.to_json, "Content-Type" => "application/json")
+
+      raise_error(response.body) unless response.success?
+
+      events = parse_ndjson(response.body)
+
+      if (error_event = events.find { |e| e[:type] == "error" })
+        raise Error, error_event[:error]
+      end
+
+      block_given? ? events.each(&block) : events
+    end
+
+    private
+
+    def handle_response(response)
+      case response.status
+      in 204
+        nil
+      in 200..299
+        parse_json(response.body)
+      else
+        raise_error(response.body)
+      end
+    end
+
+    def raise_error(body)
+      parsed = parse_json(body)
+      message = parsed[:error] || parsed[:errors]&.join(", ") || "Unknown error"
+      raise Error, message
+    rescue JSON::ParserError
+      raise Error, body.strip
+    end
+
+    def parse_json(json) = JSON.parse(json, symbolize_names: true)
+
+    def parse_ndjson(body) = body.each_line.map { parse_json(it) }
+
+    def connection
+      @connection ||= Faraday.new(url: @base_url) do |f|
+        f.request :authorization, "Bearer", @token
+      end
+    end
+  end
+end

data/lib/sprites/collection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Sprites
+  class Collection
+    attr_reader :sprites, :next_continuation_token
+
+    def initialize(sprites:, has_more:, next_continuation_token:)
+      @sprites = sprites
+      @has_more = has_more
+      @next_continuation_token = next_continuation_token
+    end
+
+    def has_more?
+      @has_more && !@next_continuation_token.nil?
+    end
+  end
+end

data/lib/sprites/configuration.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Sprites
+  class Configuration
+    attr_accessor :token, :base_url
+
+    def initialize
+      @base_url = "https://api.sprites.dev"
+    end
+  end
+end

data/lib/sprites/resources/checkpoints.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sprites
+  module Resources
+    class Checkpoints
+      def initialize(client)
+        @client = client
+      end
+
+      def list(sprite_name)
+        @client.get("/v1/sprites/#{sprite_name}/checkpoints")
+      end
+
+      def retrieve(sprite_name, checkpoint_id)
+        @client.get("/v1/sprites/#{sprite_name}/checkpoints/#{checkpoint_id}")
+      end
+
+      def create(sprite_name, comment: nil, &block)
+        @client.post_stream("/v1/sprites/#{sprite_name}/checkpoint", { comment: }, &block)
+      end
+
+      def restore(sprite_name, checkpoint_id, &block)
+        @client.post_stream("/v1/sprites/#{sprite_name}/checkpoints/#{checkpoint_id}/restore", {}, &block)
+      end
+    end
+  end
+end

data/lib/sprites/resources/policies.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sprites
+  module Resources
+    class Policies
+      def initialize(client)
+        @client = client
+      end
+
+      def retrieve(sprite_name)
+        @client.get("/v1/sprites/#{sprite_name}/policies")
+      end
+
+      def update(sprite_name, **attrs)
+        @client.post("/v1/sprites/#{sprite_name}/policies", attrs)
+      end
+    end
+  end
+end

data/lib/sprites/resources/sprites.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Sprites
+  module Resources
+    class Sprites
+      def initialize(client)
+        @client = client
+      end
+
+      def list
+        @client.get("/v1/sprites") => { sprites:, has_more:, next_continuation_token: }
+        sprites = sprites.map(&Sprite)
+        Collection.new(sprites:, has_more:, next_continuation_token:)
+      end
+
+      def retrieve(name) = @client.get("/v1/sprites/#{name}").then(&Sprite)
+
+      def create(name:) = @client.post("/v1/sprites", { name: }).then(&Sprite)
+
+      def update(name, **attrs) = @client.put("/v1/sprites/#{name}", attrs).then(&Sprite)
+
+      def delete(name) = @client.delete("/v1/sprites/#{name}")
+    end
+  end
+end

data/lib/sprites/sprite.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Sprites
+  class Sprite
+    def self.to_proc = ->(attrs) { new(**attrs) }
+
+    attr_reader :id, :name, :status, :version, :url, :created_at, :updated_at,
+                :organization, :url_settings, :environment_version
+
+    def initialize(id:, name:, status:, version:, url:, created_at:, updated_at:,
+                   organization:, url_settings:, environment_version:)
+      @id = id
+      @name = name
+      @status = status
+      @version = version
+      @url = url
+      @created_at = created_at
+      @updated_at = updated_at
+      @organization = organization
+      @url_settings = url_settings
+      @environment_version = environment_version
+    end
+  end
+end

data/lib/sprites/version.rb

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

data/lib/sprites.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "sprites/version"
+require_relative "sprites/configuration"
+require_relative "sprites/collection"
+require_relative "sprites/sprite"
+require_relative "sprites/resources/sprites"
+require_relative "sprites/resources/checkpoints"
+require_relative "sprites/resources/policies"
+require_relative "sprites/client"
+
+module Sprites
+  class Error < StandardError; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: sprites-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ara Hacopian
+bindir: bin
+cert_chain: []
+date: 1980-01-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'
+description: Ruby client for the Sprites API - stateful sandbox environments
+email:
+- ara@hacopian.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/sprites.rb
+- lib/sprites/client.rb
+- lib/sprites/collection.rb
+- lib/sprites/configuration.rb
+- lib/sprites/resources/checkpoints.rb
+- lib/sprites/resources/policies.rb
+- lib/sprites/resources/sprites.rb
+- lib/sprites/sprite.rb
+- lib/sprites/version.rb
+homepage: https://github.com/ahacop/sprites-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ahacop/sprites-ruby
+  source_code_uri: https://github.com/ahacop/sprites-ruby
+  changelog_uri: https://github.com/ahacop/sprites-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby client for the Sprites API
+test_files: []