nexusq 4.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fc02cce3fd358aad750b503011f71a74be3788f74eae505f0f5ffa2295f8466c
+  data.tar.gz: 7a8f14601b0b7036eca9e83279b54abbfee9f0d1806b1689d37e2eec6c09ac85
+SHA512:
+  metadata.gz: 4507def0f5dd466ef8becd4bc1395436b33d7adfd0d5bdff73d2e493deac679eebafb031a64d189782b3ced2061655fa51a1af5fbc79f64a6cb7864aac7bcd58
+  data.tar.gz: 5f3bfde921eb8734001f5fefdb54db60540766c634980ffe9fa5e178fa7cb5559285b4c31440b7a967b10fdd02c5eec69a4b319ce063226f6ab3564d2788f09d

data/README.md

@@ -0,0 +1,71 @@
+# NEXUS-Q Ruby SDK
+
+Ruby bindings for NEXUS-Q. A thin wrapper over the [C SDK](../../crates/nexusq-c)
+using the `ffi` gem. It does not reimplement anything: every call goes
+through `libnexusq`.
+
+## Requirements
+
+- Ruby 3.0 or newer.
+- The `ffi` gem (`gem install ffi`).
+- The C SDK built (`cargo build -p nexusq-c`).
+- `libnexusq.so` available at runtime through `LD_LIBRARY_PATH` or
+  `NEXUSQ_LIBRARY`.
+
+## Usage
+
+```ruby
+require "ffi"
+require_relative "bindings/ruby/nexusq"
+
+puts "nexusq version: #{Nexusq.version}"
+
+vault = Nexusq::Vault.create("my.nqv", "password", "my-label")
+puts "vault created at #{vault.path}"
+puts "format version: #{vault.format_version}"
+```
+
+Run with:
+
+```bash
+NEXUSQ_LIBRARY=/path/to/nexusq/target/debug/libnexusq.so ruby your_program.rb
+```
+
+If the library directory is already on the dynamic loader path:
+
+```bash
+LD_LIBRARY_PATH=/path/to/nexusq/target/debug ruby your_program.rb
+```
+
+## What is available
+
+- `Nexusq.version` — returns the library version.
+- `Nexusq.last_error` — returns the last C SDK error message.
+- `Nexusq::Vault`:
+  - `Nexusq::Vault.create(path, password, label)` — creates a new vault.
+  - `vault.path` — returns the vault file path.
+  - `vault.format_version` — returns the format version.
+
+More operations land as the C SDK grows.
+
+## Testing
+
+The smoke test lives at `examples/smoke/smoke.rb`. From the repository root:
+
+```bash
+NEXUSQ_LIBRARY=target/debug/libnexusq.so \\
+ruby bindings/ruby/examples/smoke/smoke.rb
+```
+
+Expected output:
+
+```
+nexusq version: 0.1.0
+vault created at /tmp/nexusq_ruby_smoke_1234.nqv
+vault format version: 1
+smoke test passed
+```
+
+The Ruby binding is intentionally a thin wrapper over the C SDK, matching
+the Go SDK architecture. No cryptography or business logic is duplicated
+in Ruby.

data/examples/smoke/smoke.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# Smoke test for the NEXUS-Q Ruby SDK.
+#
+# Run from the repository root:
+#   NEXUSQ_LIBRARY=target/debug/libnexusq.so ruby bindings/ruby/examples/smoke/smoke.rb
+
+require "rubygems"
+require "tmpdir"
+require_relative "../../lib/nexusq"
+
+puts "nexusq version: #{Nexusq.version}"
+
+path = File.join(Dir.tmpdir, "nexusq_ruby_smoke_#{$$}.nqv")
+File.delete(path) if File.exist?(path)
+
+begin
+  vault = Nexusq::Vault.create(path, "ruby-test", "ruby-smoke")
+
+  abort "vault file was not created" unless File.file?(path)
+  abort "vault.path does not match input" unless vault.path == path
+  abort "format_version must be 1" unless vault.format_version == 1
+
+  puts "vault created at #{vault.path}"
+  puts "vault format version: #{vault.format_version}"
+  puts "smoke test passed"
+ensure
+  File.delete(path) if File.exist?(path)
+end

data/lib/nexusq.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# NEXUS-Q Ruby bindings.
+#
+# This is a thin FFI wrapper over the C SDK. It does not reimplement
+# cryptography or business logic; every operation delegates to libnexusq.
+
+require "ffi"
+
+module Nexusq
+  extend FFI::Library
+
+  ffi_lib ENV.fetch("NEXUSQ_LIBRARY", "nexusq")
+
+  attach_function :nexusq_version, [], :string
+  attach_function :nexusq_last_error_message, [], :string
+  attach_function :nexusq_vault_create, [:string, :string, :string], :int32
+  attach_function :nexusq_vault_format_version, [:string], :int32
+
+  def self.version
+    nexusq_version
+  end
+
+  def self.last_error
+    nexusq_last_error_message
+  end
+
+  class Vault
+    attr_reader :path, :format_version
+
+    def self.create(path, password, label = nil)
+      rc = Nexusq.nexusq_vault_create(path, password, label)
+      raise Error, Nexusq.last_error || "NEXUS-Q operation failed" unless rc.zero?
+
+      version = Nexusq.nexusq_vault_format_version(path)
+      raise Error, Nexusq.last_error || "NEXUS-Q operation failed" if version.negative?
+
+      new(path, version)
+    end
+
+    def initialize(path, format_version)
+      @path = path
+      @format_version = format_version
+    end
+    private_class_method :new
+  end
+
+  class Error < StandardError
+  end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: nexusq
+version: !ruby/object:Gem::Version
+  version: 4.1.0
+platform: ruby
+authors:
+- lecodev-26
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: Thin FFI wrapper over the NEXUS-Q C SDK (libnexusq). No cryptography
+  or business logic lives here.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- examples/smoke/smoke.rb
+- lib/nexusq.rb
+homepage: https://github.com/lecodev-26/nexus-q
+licenses:
+- MIT OR Apache-2.0
+metadata: {}
+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.6.9
+specification_version: 4
+summary: Ruby bindings for NEXUS-Q
+test_files: []