piston_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0b14b2788360074d5bfbeda204336c00985fd5c02e208f278583da7451ad1da
+  data.tar.gz: 406925f3cb0152ab40b0e3661d778429fc499cfb45e0cc960f17454e5e8c3f69
+SHA512:
+  metadata.gz: 412636f7247d509bf44532b557de671657702c9fc955013d89be1ba7f65c9823f8b0a87ed51cc946d4b83cbe442aafc89f2b1f2744e904eab3c53e403f95cd3a
+  data.tar.gz: e134bcf385bbc4fe5a737c3043409730522011cc9e5f31f0718bb9b15f671f8fff25131a675d973c6d33dd004a78b1ffcd1aa69b9b5553ea2f59945c349817c9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zahin Zaman
+
+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,39 @@
+<p align="center">
+    <img alt="piston_sdk logo" src="img/logo.svg" width=125 />
+</p>
+
+<h1 align="center">
+    Piston Ruby SDK
+</h1>
+
+<p align="center">
+    <strong><i>piston_sdk</i></strong> is a lightweight Ruby gem executing code using the <a href="https://github.com/engineer-man/piston"><i>Piston API</i></a>.
+</p>
+
+<div align="center">
+
+[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/alvii147/piston-ruby-sdk/main.yml?branch=main&label=GitHub%20Actions&logo=github)](https://github.com/alvii147/piston-ruby-sdk/actions) [![License](https://img.shields.io/github/license/alvii147/piston-ruby-sdk)](https://github.com/alvii147/piston-ruby-sdk/blob/main/LICENSE)
+
+</div>
+
+## Installation
+
+```bash
+gem install piston_sdk
+```
+
+## Usage
+
+```ruby
+require 'piston_sdk'
+
+client = PistonSDK::Client.new
+client.add_file(content: "puts 42", name: "app.rb")
+results = client.execute(language: "ruby", version: "3.0.1")
+
+puts results.run.stdout # 42
+```
+
+## Acknowledgements
+
+* [Piston API](https://github.com/engineer-man/piston)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/img/logo.svg

@@ -0,0 +1,24 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 512 512">
+  <defs>
+    <style>
+      .cls-1{
+        fill: #330a00;
+      }
+
+      .cls-2{
+        fill:url(#linear-gradient);
+      }
+    </style>
+    <linearGradient id="linear-gradient" x1="313.84" y1="162.5" x2="158.19" y2="318.15" gradientUnits="userSpaceOnUse">
+      <stop offset="0" stop-color="#ff8566"/>
+      <stop offset="0.5" stop-color="#ff1a1a"/>
+      <stop offset="1" stop-color="#991f00"/>
+    </linearGradient>
+  </defs>
+  <g id="Layer_2" data-name="Layer 2">
+    <g id="Layer_4" data-name="Layer 4">
+      <rect class="cls-1" width="512" height="512"/>
+      <path class="cls-2" d="M227.17,255.54V371.65l-44.95-29.47V281.23Zm30.38,47.15,98.23-51.21v-47l-128.19-64.1L182.22,163.2v55.13l45.37-25.54,69.09,35.38-39,17.08Z"/>
+    </g>
+  </g>
+</svg>

data/lib/piston_sdk/version.rb

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

data/lib/piston_sdk.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require_relative "piston_sdk/version"
+
+# A minimal Ruby gem for using the [Piston API](https://github.com/engineer-man/piston).
+module PistonSDK
+  # Data representation of a Piston runtime.
+  class Runtime
+    attr_reader :language, :version, :aliases, :runtime
+
+    # Create a new Piston runtime.
+    #
+    # @param data [Hash] JSON data.
+    def initialize(data)
+      @language = data["language"]
+      @version = data["version"]
+      @aliases = data["aliases"]
+      @runtime = data["runtime"]
+    end
+  end
+
+  # Data representation of Piston execution step details.
+  class ExecutionStepDetails
+    attr_reader :stdout, :stderr, :output, :code, :signal, :message, :status, :cpu_time, :wall_time, :memory
+
+    # Create new Piston execution step details.
+    #
+    # @param data [Hash] JSON data.
+    def initialize(data)
+      @stdout = data["stdout"] unless data["stdout"].nil?
+      @stderr = data["stderr"] unless data["stderr"].nil?
+      @output = data["output"] unless data["output"].nil?
+      @code = data["code"] unless data["code"].nil?
+      @signal = data["signal"] unless data["signal"].nil?
+      @message = data["message"] unless data["message"].nil?
+      @status = data["status"] unless data["status"].nil?
+      @cpu_time = data["cpu_time"] unless data["cpu_time"].nil?
+      @wall_time = data["wall_time"] unless data["wall_time"].nil?
+      @memory = data["memory"] unless data["memory"].nil?
+    end
+  end
+
+  # Data representation of Piston execution results.
+  class ExecutionResults
+    attr_reader :language, :version, :run, :compile
+
+    # Create new Piston execution results.
+    #
+    # @param data [Hash] JSON data.
+    def initialize(data)
+      @language = data["language"]
+      @version = data["version"]
+      @run = ExecutionStepDetails.new(data["run"]) unless data["run"].nil?
+      @compile = ExecutionStepDetails.new(data["compile"]) unless data["compile"].nil?
+    end
+  end
+
+  # HTTP client for the Piston API.
+  class Client
+    # Create a new client.
+    #
+    # @param base_url [String] Base URL for API.
+    # @param compile_timeout [Integer, nil] The maximum wall-time allowed for the compile stage to finish before bailing
+    # out in milliseconds.
+    # @param run_timeout [Integer, nil] The maximum wall-time allowed for the run stage to finish before bailing out in
+    # milliseconds.
+    # @param compile_cpu_time [Integer, nil] The maximum CPU-time allowed for the compile stage to finish before bailing
+    # out in milliseconds.
+    # @param run_cpu_time [Integer, nil] The maximum CPU-time allowed for the run stage to finish before bailing out in
+    # milliseconds.
+    # @param compile_memory_limit [Integer, nil] The maximum amount of memory the compile stage is allowed to use in
+    # bytes.
+    # @param run_memory_limit [Integer, nil] The maximum amount of memory the run stage is allowed to use in bytes.
+    def initialize(
+      base_url: "https://emkc.org/api/v2/piston",
+      retries: 3,
+      compile_timeout: nil,
+      run_timeout: nil,
+      compile_cpu_time: nil,
+      run_cpu_time: nil,
+      compile_memory_limit: nil,
+      run_memory_limit: nil
+    )
+      @uri = URI(base_url)
+      @retries = retries
+      @compile_timeout = compile_timeout
+      @run_timeout = run_timeout
+      @compile_cpu_time = compile_cpu_time
+      @run_cpu_time = run_cpu_time
+      @compile_memory_limit = compile_memory_limit
+      @run_memory_limit = run_memory_limit
+      @files = []
+
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.use_ssl = true
+
+      @method_classes = Hash.new(Net::HTTP::Get)
+      @method_classes[:get] = Net::HTTP::Get
+      @method_classes[:post] = Net::HTTP::Post
+    end
+
+    # Perform raw HTTP request using exponential backoff on retries.
+    #
+    # @param method [Symbol] HTTP method.
+    # @param path [String] URL Path.
+    # @param body [Hash, nil] Optional request body
+    # @return [Hash, Array] JSON response.
+    def request(method: :get, path: "", body: nil)
+      req = @method_classes[method].new("#{@uri}#{path}")
+      req["Content-Type"] = "application/json"
+      req.body = body.to_json unless body.nil?
+      res = @http.request(req)
+
+      (0...@retries).each do |attempt|
+        res = @http.request(req)
+
+        case res
+        when Net::HTTPOK
+          return JSON.parse(res.body)
+        when Net::HTTPTooManyRequests
+          sleep 2**attempt
+        else
+          raise "Request failed with status code #{res.code}, #{res.body}"
+        end
+      end
+    end
+
+    # Add file to be sent to Piston for execution.
+    #
+    # @param content [String] Content of the files to upload.
+    # @param name [String, nil] Name of the file to upload.
+    # @param encoding [String, nil] Encoding scheme used for the file content.
+    def add_file(content:, name: nil, encoding: nil)
+      file = {
+        name: name,
+        content: content,
+        encoding: encoding
+      }.compact
+
+      @files << file
+    end
+
+    # Clear all files.
+    def clear_files
+      @files.clear
+    end
+
+    # Get supported languages along with the current version and aliases.
+    #
+    # @return [Array<Runtime>] Array of runtimes.
+    def runtimes
+      request(method: :get, path: "/runtimes").map { |data| Runtime.new(data) }
+    end
+
+    # Execute code for a given language and version using the added files.
+    #
+    # @param language [String] Language to use for execution.
+    # @param version [String] Version of the language to use for execution.
+    # @param stdin [String, nil] Text to pass as stdin to the program.
+    # @param args [Array<String>] Arguments to pass to the program.
+    # @return [ExecutionResults] Execution results.
+    def execute(language:, version:, stdin: nil, args: nil)
+      body = {
+        language: language,
+        version: version,
+        files: @files,
+        stdin: stdin,
+        args: args,
+        compile_timeout: @compile_timeout,
+        run_timeout: @run_timeout,
+        compile_cpu_time: @compile_cpu_time,
+        run_cpu_time: @run_cpu_time,
+        compile_memory_limit: @compile_memory_limit,
+        run_memory_limit: @run_memory_limit
+      }.compact
+
+      ExecutionResults.new(request(method: :post, path: "/execute", body: body))
+    end
+
+    private :request
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: piston_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zahin Zaman
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: piston_sdk is a lightweight Ruby gem for using the Piston API (see https://github.com/engineer-man/piston).
+email:
+- alvii147@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- img/logo.svg
+- lib/piston_sdk.rb
+- lib/piston_sdk/version.rb
+homepage: https://github.com/alvii147/piston-ruby-sdk
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A lightweight Ruby gem for using the Piston API.
+test_files: []