qyro_sdk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13a5288829f36672738079f90a911ad8346fb6715362d93395ad0183d483a1d9
+  data.tar.gz: f7649a0ac5305789983e5180295121f4481da4481b09ee09d20a3ab4239f8064
+SHA512:
+  metadata.gz: 9d395f1b1d5fb88b1f755de0836c69540e352abb946499909c885255949d15d91f188af255cec08cda601b4d00e752d5ea19e6d8e2bea570c045aceaebaab866
+  data.tar.gz: 672dd587d799e9523d091b1a1ca9ed50f10bfffb0326fe038f3806a06f94640e3918776536a3b09b785d579ac45fc7164ec39c81b789aba1319a8f11cfb93fde

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 QyroAI
+
+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,65 @@
+Qyro Ruby SDK
+================
+
+Ruby SDK for interacting with Qyro AI server & client APIs.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "qyro_sdk"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install qyro_sdk
+```
+
+### Usage
+
+```ruby
+require "qyro_sdk"
+
+BASE_URL      = "https://qyroai.com"
+API_KEY_ID    = "<API_KEY_ID>"
+API_KEY_SECRET = "<API_KEY_SECRET>"
+ASSISTANT_ID  = "<ASSISTANT_ID>"
+
+if __FILE__ == $0
+  # --- Server-side Example ---
+  puts "=== Server SDK Example ==="
+  server_client = QyroSDK::QyroServerClient.new(
+    base_url: BASE_URL,
+    api_key_id: API_KEY_ID,
+    api_key_secret: API_KEY_SECRET
+  )
+
+  # create a new session
+  session = server_client.create_session(ASSISTANT_ID, { user_id: "123" })
+  puts "Created server session: #{session.id}"
+
+  # send a chat message
+  messages = server_client.chat(ASSISTANT_ID, session.id, "Hello from Ruby (server)")
+  messages.each { |m| puts "[#{m.role}] #{m.content}" }
+
+  # --- Client-side Example ---
+  puts "\n=== Client SDK Example ==="
+  token_generator = QyroSDK::ClientTokenGenerator.new(API_KEY_ID, API_KEY_SECRET)
+  token = token_generator.generate({ client: "ruby-sdk-example" })
+
+  client = QyroSDK::QyroClient.new(base_url: BASE_URL, token: token)
+  client_session = client.create_session(ASSISTANT_ID, { locale: "en" })
+  puts "Created client session: #{client_session.id}"
+
+  client_messages = client.chat(ASSISTANT_ID, client_session.id, "Hello from Ruby (client)")
+  client_messages.each { |m| puts "[#{m.role}] #{m.content}" }
+end
+```

data/lib/qyro_sdk/auth.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'json'
+require 'time'
+require 'securerandom'
+require 'jwt'
+
+module QyroSDK
+  class ApiKeyAuth
+    attr_reader :api_key_id, :api_key_secret
+
+    def initialize(api_key_id, api_key_secret)
+      @api_key_id = api_key_id
+      @api_key_secret = api_key_secret
+    end
+
+    def header_value
+      "ApiKey #{@api_key_secret}"
+    end
+  end
+
+  class ClientTokenGenerator
+    attr_reader :api_key_id, :api_key_secret
+
+    # note: depends on the 'jwt' gem
+    def initialize(api_key_id, api_key_secret)
+      @api_key_id = api_key_id
+      @api_key_secret = api_key_secret
+    end
+
+    # context: a Ruby Hash that will be JSON-dumped into the token "sub"
+    def generate(context)
+      subject = JSON.dump(context)
+      now_ts = Time.now.to_i
+      payload = {
+        "sub"  => subject,
+        "iat"  => now_ts,
+        # 30 days from now
+        "exp"  => now_ts + 24 * 3600 * 30,
+        "type" => "client",
+        "iss"  => api_key_id.to_s,
+        "aud"  => "qyro",
+        "jti"  => SecureRandom.uuid
+      }
+      headers = { kid: api_key_id.to_s }
+      JWT.encode(payload, api_key_secret, 'HS256', headers)
+    end
+  end
+end

data/lib/qyro_sdk/client.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+require_relative 'http_helper'
+require_relative 'models'
+require_relative 'exceptions'
+
+module QyroSDK
+  class QyroClient
+    include HttpHelper
+    include Models
+
+    def initialize(base_url:, token:, timeout: 30)
+      raise ConfigurationError, "base_url is required" if base_url.nil? || base_url.to_s.strip.empty?
+
+      @base_url = base_url.end_with?('/') ? base_url : "#{base_url}/"
+      @token = token
+      @timeout = timeout
+    end
+
+    def create_session(assistant_id, context = {})
+      path = "/client/api/v1/assistants/#{assistant_id}/sessions"
+      headers = client_headers
+      resp = request('POST', path, headers: headers, body: { context: context }, timeout: @timeout)
+      Session.new(id: resp['id'])
+    end
+
+    def fetch_session_messages(assistant_id, session_id)
+      path = "/client/api/v1/assistants/#{assistant_id}/sessions/#{session_id}/messages"
+      headers = client_headers
+      resp = request('GET', path, headers: headers, timeout: @timeout)
+      array_to_messages(resp)
+    end
+
+    def chat(assistant_id, session_id, message_text)
+      path = "/client/api/v1/assistants/#{assistant_id}/sessions/#{session_id}/chat"
+      headers = client_headers
+      resp = request('POST', path, headers: headers, body: { message: message_text }, timeout: @timeout)
+      array_to_messages(resp)
+    end
+
+    private
+
+    def client_headers
+      { "Authorization" => "Bearer #{@token}", "Content-Type" => "application/json" }
+    end
+
+    def array_to_messages(arr)
+      (arr || []).map do |m|
+        Message.new(id: m['id'], content: m['content'], role: m['role'])
+      end
+    end
+  end
+end

data/lib/qyro_sdk/exceptions.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module QyroSDK
+  class QyroError < StandardError; end
+
+  class HTTPError < QyroError
+    attr_reader :status_code, :response
+
+    def initialize(status_code, message, response: nil)
+      super("HTTP #{status_code}: #{message}")
+      @status_code = status_code
+      @response = response
+    end
+  end
+
+  class ConfigurationError < QyroError; end
+end

data/lib/qyro_sdk/http_helper.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+require 'net/http'
+require 'uri'
+require 'json'
+
+module QyroSDK
+  module HttpHelper
+    private
+
+    def request(method, path, headers: {}, body: nil, timeout: nil)
+      uri = URI.join(@base_url, path)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.open_timeout = timeout if timeout
+      http.read_timeout = timeout if timeout
+
+      req = case method.to_s.upcase
+            when 'GET' then Net::HTTP::Get.new(uri)
+            when 'POST' then Net::HTTP::Post.new(uri)
+            when 'PUT' then Net::HTTP::Put.new(uri)
+            when 'DELETE' then Net::HTTP::Delete.new(uri)
+            else
+              raise ArgumentError, "Unsupported HTTP method: #{method}"
+            end
+
+      headers.each { |k, v| req[k] = v } if headers
+      if body
+        req.body = body.is_a?(String) ? body : JSON.dump(body)
+        req['Content-Type'] ||= 'application/json'
+      end
+
+      resp = http.request(req)
+      handle_response(resp)
+    end
+
+    def handle_response(resp)
+      code = resp.code.to_i
+      body = resp.body.to_s
+      parsed = begin
+                 JSON.parse(body)
+               rescue StandardError
+                 body
+               end
+
+      unless code.between?(200, 299)
+        message = parsed.is_a?(Hash) ? (parsed['message'] || parsed) : parsed
+        raise HTTPError.new(code, message, response: resp)
+      end
+
+      parsed
+    end
+  end
+end

data/lib/qyro_sdk/models.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'ostruct'
+
+module QyroSDK
+  module Models
+    Session = Struct.new(:id, keyword_init: true)
+    Message = Struct.new(:id, :role, :content, keyword_init: true)
+  end
+end

data/lib/qyro_sdk/server.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require_relative 'http_helper'
+require_relative 'models'
+require_relative 'auth'
+require_relative 'exceptions'
+
+module QyroSDK
+  class QyroServerClient
+    include HttpHelper
+    include Models
+
+    def initialize(base_url:, api_key_id:, api_key_secret:, timeout: 30)
+      raise ConfigurationError, "base_url is required" if base_url.nil? || base_url.to_s.strip.empty?
+
+      @base_url = base_url.end_with?('/') ? base_url : "#{base_url}/"
+      @auth = ApiKeyAuth.new(api_key_id, api_key_secret)
+      @timeout = timeout
+    end
+
+    def create_session(assistant_id, context = {})
+      path = "/server/api/v1/assistants/#{assistant_id}/sessions"
+      headers = { "Authorization" => @auth.header_value }
+      resp = request('POST', path, headers: headers, body: { context: context }, timeout: @timeout)
+      Session.new(id: resp['id'])
+    end
+
+    def fetch_session_messages(assistant_id, session_id)
+      path = "/server/api/v1/assistants/#{assistant_id}/sessions/#{session_id}/messages"
+      headers = { "Authorization" => @auth.header_value }
+      resp = request('GET', path, headers: headers, timeout: @timeout)
+      array_to_messages(resp)
+    end
+
+    def chat(assistant_id, session_id, message_text)
+      path = "/server/api/v1/assistants/#{assistant_id}/sessions/#{session_id}/chat"
+      headers = { "Authorization" => @auth.header_value }
+      resp = request('POST', path, headers: headers, body: { message: message_text }, timeout: @timeout)
+      array_to_messages(resp)
+    end
+
+    private
+
+    def array_to_messages(arr)
+      (arr || []).map do |m|
+        Message.new(id: m['id'], content: m['content'], role: m['role'])
+      end
+    end
+  end
+end

data/lib/qyro_sdk/version.rb

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

data/lib/qyro_sdk.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "qyro_sdk/version"
+
+require_relative "qyro_sdk/models"
+require_relative "qyro_sdk/auth"
+require_relative "qyro_sdk/exceptions"
+require_relative "qyro_sdk/http_helper"
+require_relative "qyro_sdk/server"
+require_relative "qyro_sdk/client"
+
+module QyroSDK
+  # Namespace for the Qyro Ruby SDK
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: qyro_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- QyroAI
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby SDK for interacting with the Qyro AI API (server & client).
+email:
+- support@qyroai.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/qyro_sdk.rb
+- lib/qyro_sdk/auth.rb
+- lib/qyro_sdk/client.rb
+- lib/qyro_sdk/exceptions.rb
+- lib/qyro_sdk/http_helper.rb
+- lib/qyro_sdk/models.rb
+- lib/qyro_sdk/server.rb
+- lib/qyro_sdk/version.rb
+homepage: https://github.com/qyroai/qyro-ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.27
+signing_key:
+specification_version: 4
+summary: Ruby SDK for Qyro AI
+test_files: []