shivanshu-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 233f4306a9c4a05d17246f5efcc0b4d50f0645fe66b153bef4f51d436ebe833a
+  data.tar.gz: '0518bcf2320490c3b35465e8ae88bd12b4991d55cef9d7d273d983c77ccf5df1'
+SHA512:
+  metadata.gz: 56ab9496eb77d395803311b14a7a5c2daf1cbfb375052707d54438acb917a667a87fd3d0e4294d9d32865289fe3ff9f74201967580b31c04867a3571278450ae
+  data.tar.gz: 64ad5ae8e185c3d0b08132d38dffcaeade8ce960ccac3238fdeb825d97d89bfb452573c7e393dc73d6fdd57c7f79ef72efd3b6626d8c910dfb90347f25c98d06

data/README.md

@@ -0,0 +1,69 @@
+# Shivanshu Tiwari Ruby SDK — `shivanshu-sdk`
+
+Official Ruby client library for integrating with **Shivanshu Tiwari Portfolio APIs**, project catalogs, asynchronous background jobs, sandbox testing, and ephemeral test keys.
+
+[![Gem Version](https://img.shields.io/badge/rubygems-v1.0.0-blue.svg)](https://rubygems.org/gems/shivanshu-sdk)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+
+## Installation
+
+```bash
+gem install shivanshu-sdk
+```
+
+*Note: The SDK relies solely on the Ruby standard library (`net/http`, `json`, `uri`) with zero external dependencies.*
+
+## Quick Start
+
+```ruby
+require "shivanshu"
+
+client = Shivanshu::Client.new
+
+# 1. Query engineering projects
+projects = client.list_projects(domain: "ai-agents")
+puts "Found #{projects["data"].length} AI agent projects"
+projects["data"].each { |p| puts "- #{p["title"]} (#{p["slug"]})" }
+
+# 2. Inspect project architecture and technical tradeoffs
+honeypot = client.get_project("agentic-honey-pot")
+puts "Architecture: #{honeypot.dig("architecture", "summary")}"
+
+# 3. Test sandbox environment
+sandbox = client.ping_sandbox
+puts "Sandbox status: #{sandbox["sandbox"]}"
+
+# 4. Generate ephemeral test key
+key_data = client.generate_key
+puts "Test API key: #{key_data["apiKey"]}"
+```
+
+## Features
+
+- **Zero Dependencies:** Pure Ruby 3.0+ using standard library primitives.
+- **Project Intelligence:** Query 19 engineering projects, architecture diagrams, and honest limitation disclosures.
+- **Batch Processing:** Run multi-step operations in an atomic batch.
+- **Async Jobs:** Dispatch long-running jobs and poll their status.
+- **Idempotency Built-In:** `Idempotency-Key` header support for safe contact transmissions.
+- **AI Agent Friendly:** Built for ingestion by autonomous agents and agent frameworks.
+
+## API Reference
+
+- `client.list_projects(limit: nil, cursor: nil, domain: nil)`
+- `client.get_project(slug)`
+- `client.compare_projects(slug_a, slug_b)`
+- `client.generate_key`
+- `client.ping_sandbox`
+- `client.sandbox_contact(name, email, message)`
+- `client.run_batch(operations)`
+- `client.create_job(task, payload: nil)`
+- `client.get_job(job_id)`
+- `client.submit_contact(name, email, message, idempotency_key: nil)`
+- `client.get_docs(path = "llms.txt")`
+
+## Links
+
+- **Homepage:** [https://shivanshutiwari.in](https://shivanshutiwari.in)
+- **Developer Portal:** [https://shivanshutiwari.in/developers](https://shivanshutiwari.in/developers)
+- **SDK Documentation:** [https://shivanshutiwari.in/developers/sdk](https://shivanshutiwari.in/developers/sdk)
+- **OpenAPI Specification:** [https://shivanshutiwari.in/openapi.json](https://shivanshutiwari.in/openapi.json)

data/lib/shivanshu/client.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+module Shivanshu
+  # Raised when the Portfolio API returns a non-2xx response.
+  class APIError < StandardError; end
+
+  # Official zero-dependency Ruby client for the Shivanshu Tiwari Portfolio API.
+  #
+  #   client = Shivanshu::Client.new
+  #   projects = client.list_projects(domain: "ai-agents")
+  #
+  # Homepage: https://shivanshutiwari.in
+  class Client
+    DEFAULT_BASE_URL = "https://shivanshutiwari.in"
+
+    attr_reader :base_url, :api_key
+
+    def initialize(base_url: DEFAULT_BASE_URL, api_key: nil)
+      @base_url = base_url
+      @api_key = api_key
+    end
+
+    # GET /api/v1/projects — list projects with optional pagination and domain filter.
+    def list_projects(limit: nil, cursor: nil, domain: nil)
+      query = {}
+      query["limit"] = limit if limit
+      query["cursor"] = cursor if cursor
+      query["domain"] = domain if domain
+      get("/api/v1/projects", query)
+    end
+
+    # GET /api/v1/projects/{slug} — project details, architecture, and honest limitations.
+    def get_project(slug)
+      get("/api/v1/projects/#{URI.encode_www_form_component(slug)}")
+    end
+
+    # GET /api/v1/projects/{slug_a}/compare?slugB=... — side-by-side project comparison.
+    def compare_projects(slug_a, slug_b)
+      get("/api/v1/projects/#{URI.encode_www_form_component(slug_a)}/compare", { "slugB" => slug_b })
+    end
+
+    # POST /api/v1/keys — generate an ephemeral 24-hour sandbox API key.
+    def generate_key
+      post("/api/v1/keys", nil)
+    end
+
+    # GET /api/v1/sandbox/ping — verify connectivity to the isolated sandbox environment.
+    def ping_sandbox
+      get("/api/v1/sandbox/ping")
+    end
+
+    # POST /api/v1/sandbox/contact — safe contact-submission test against the sandbox.
+    def sandbox_contact(name, email, message)
+      post("/api/v1/sandbox/contact", { name: name, email: email, message: message })
+    end
+
+    # POST /api/v1/batch — execute multiple operations in a single atomic round-trip.
+    def run_batch(operations)
+      post("/api/v1/batch", { operations: operations })
+    end
+
+    # POST /api/v1/jobs — dispatch an asynchronous job.
+    def create_job(task, payload: nil)
+      body = { "task" => task }
+      body["payload"] = payload if payload
+      post("/api/v1/jobs", body)
+    end
+
+    # GET /api/v1/jobs/{job_id} — fetch the status and result of an async job.
+    def get_job(job_id)
+      get("/api/v1/jobs/#{URI.encode_www_form_component(job_id)}")
+    end
+
+    # POST /api/v1/contact — submit a message with optional Idempotency-Key.
+    def submit_contact(name, email, message, idempotency_key: nil)
+      headers = {}
+      headers["Idempotency-Key"] = idempotency_key if idempotency_key
+      post("/api/v1/contact", { name: name, email: email, message: message }, headers)
+    end
+
+    # Raw markdown documentation twins (llms.txt, about.md, developers.md, ...).
+    def get_docs(path = "llms.txt")
+      uri = build_uri("/#{path.sub(%r{\A/}, "")}")
+      request(:get, uri, nil, { "Accept" => "text/markdown" }, raw: true)
+    end
+
+    private
+
+    def get(path, query = {})
+      request(:get, build_uri(path, query), nil, {})
+    end
+
+    def post(path, body, headers = {})
+      request(:post, build_uri(path), body, headers)
+    end
+
+    def build_uri(path, query = {})
+      uri = URI.join(base_url, path)
+      uri.query = URI.encode_www_form(query) unless query.empty?
+      uri
+    end
+
+    def request(method, uri, body, headers, raw: false)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+      http.open_timeout = 10
+      http.read_timeout = 30
+
+      klass = method == :post ? Net::HTTP::Post : Net::HTTP::Get
+      req = klass.new(uri)
+      req["User-Agent"] = "shivanshu-ruby-sdk/#{Shivanshu::VERSION}"
+      req["Accept"] = "application/json"
+      req["Content-Type"] = "application/json" if body
+      req["Authorization"] = "Bearer #{@api_key}" if @api_key
+      headers.each { |k, v| req[k] = v }
+      req.body = JSON.generate(body) if body
+
+      res = http.request(req)
+      unless res.is_a?(Net::HTTPSuccess)
+        raise APIError, "api error: #{res.code} #{res.body.to_s[0, 500]}"
+      end
+
+      return res.body if raw
+
+      JSON.parse(res.body || "{}")
+    end
+  end
+end

data/lib/shivanshu/version.rb

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

data/lib/shivanshu.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "shivanshu/version"
+require_relative "shivanshu/client"
+
+module Shivanshu
+  # Homepage: https://shivanshutiwari.in
+  # Documentation: https://shivanshutiwari.in/developers/sdk#ruby
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: shivanshu-sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Shivanshu Tiwari
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-05 00:00:00.000000000 Z
+dependencies: []
+description: Zero-dependency Ruby client for the Shivanshu Tiwari Portfolio API —
+  project intelligence, architecture details, sandbox testing, ephemeral test keys,
+  batch operations, and async jobs.
+email:
+- sht4bharat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/shivanshu.rb
+- lib/shivanshu/client.rb
+- lib/shivanshu/version.rb
+homepage: https://shivanshutiwari.in
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://shivanshutiwari.in
+  source_code_uri: https://github.com/SHT4BHARAT/NoIntroNeeded/tree/main/sdk/ruby
+  documentation_uri: https://shivanshutiwari.in/developers/sdk#ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.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 Shivanshu Tiwari Portfolio APIs
+test_files: []