lex-openai 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8f5858ed3e18e95299a0e2c0df9069c4a96bff7bb1a72051dcc0e6e9ae0265a
-  data.tar.gz: bd6977abff97ae0e1428b3f2c2dace21a1c8bd817f3b2814ba46531f8cf8781c
+  metadata.gz: 90c6d63dfd5f751c914a536a7392e0d8ddfb9e8c50b06b29d714c9a27f20d958
+  data.tar.gz: 734c7f7eb7089efecbe0217b75f1bde7d2203593bd7298715024e1fb12ed4a5b
 SHA512:
-  metadata.gz: e093b207dc65fee0d62c6b17a8dd75b00b11a307ec893540f79942e522115c7f8eb8d6cafbbfdb2cbf54ea1ff999f16c61fed2d35e58a036bf4f024ebd6c92ec
-  data.tar.gz: e4b5f51079d5ea17effab271dd879665cf2fc03f2678fbd3f9f1d8d3504a05f235b825f6cdc99fd491a2b80ae751b11994e0355d09b117a8249c595ed80445b2
+  metadata.gz: 6d85f2b69e108f1b81b8596aed84763f66e9a02b54e981ac2228791ff017ca44238e3afc8d906e3effb47ea6c9217dfc7785b46bb04792cf7fc5bb9bf534c621
+  data.tar.gz: b7b973d63e125b00d5503aadcaca25127cc5529779022671af6c9fb2259de630336450cd48243e88cd0169e9c3c0973f978a3423760ec0fa4f6ac3f152eb924f

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.1.5] - 2026-04-06
+
+### Added
+- Credential-only identity module for Phase 8 Broker integration (`Identity` module with `provide_token`)
+
+## [0.1.4] - 2026-03-31
+
+### Added
+- add standardized usage tracking to all runner responses; all methods now return a `usage:` hash with `input_tokens`, `output_tokens`, `cache_read_tokens`, and `cache_write_tokens` keys compatible with legion-llm's CostEstimator (#2)
+
 ## [0.1.3] - 2026-03-30
 
 ### Changed

data/CLAUDE.md

@@ -10,8 +10,8 @@ Legion Extension that connects LegionIO to OpenAI. Provides runners for chat com
 
 **GitHub**: https://github.com/LegionIO/lex-openai
 **License**: MIT
-**Version**: 0.1.2
-**Specs**: 17 examples
+**Version**: 0.1.5
+**Specs**: 66 examples (8 spec files)
 
 ## Architecture
 
@@ -31,15 +31,16 @@ Legion::Extensions::Openai
 
 There is no standalone `Client` class in lex-openai. Runner modules are used directly via `extend` or by including them in a consuming class. This differs from lex-azure-ai, lex-bedrock, lex-claude, lex-foundry, and lex-xai which all ship a `Client` class.
 
-`Helpers::Client` is a **module** (not a class). It does not use `module_function` — instead, runner modules `extend` it so `client(...)` is available as a module-level method. `DEFAULT_BASE_URL` is `'https://api.openai.com'`.
+`Helpers::Client` is a **module** (not a class). Runner modules `extend` it so `client(...)` is available as a module-level method. `DEFAULT_BASE_URL = 'https://api.openai.com'`.
 
 ## Key Design Decisions
 
 - `faraday/multipart` is required unconditionally in `Helpers::Client` — the `:multipart` middleware is always loaded. This is a hard dependency (listed in gemspec), unlike lex-gemini where it is optional.
-- Images (edit, variation) and Audio (transcribe, translate) runners use `Faraday::Multipart::FilePart` directly.
+- `Images#edit` and `Images#variation` use `Faraday::Multipart::FilePart` directly.
 - `Images#generate` uses DALL-E 3 by default; `Images#edit` and `Images#variation` use DALL-E 2 by default.
 - Audio defaults: `model: 'tts-1'`, `voice: 'alloy'`, `response_format: 'mp3'` for speech; `model: 'whisper-1'` for transcription/translation.
-- All runners return `{ result: response.body }` (no `:status` key). This is consistent with lex-gemini runners. lex-claude runners add `:status` to the return hash.
+- All runners return `{ result: response.body }` (no `:status` key).
+- `multi_json` is NOT a declared dependency of lex-openai (unlike lex-azure-ai, lex-claude, lex-foundry, lex-xai). JSON parsing uses Faraday's built-in response middleware.
 - `include Legion::Extensions::Helpers::Lex` is guarded with `Legion::Extensions.const_defined?(:Helpers)` pattern.
 
 ## Dependencies
@@ -48,17 +49,19 @@ There is no standalone `Client` class in lex-openai. Runner modules are used dir
 |-----|---------|
 | `faraday` >= 2.0 | HTTP client |
 | `faraday-multipart` >= 1.0 | Multipart file uploads (images, audio, files) |
+| `legion-cache`, `legion-crypt`, `legion-data`, `legion-json`, `legion-logging`, `legion-settings`, `legion-transport` | LegionIO core |
 
-Note: `multi_json` is NOT a declared dependency of lex-openai (unlike the other extensions in this category). JSON parsing uses Faraday's built-in response middleware.
+Note: `multi_json` is NOT a declared dependency (differs from all other extensions in this category).
 
 ## Testing
 
 ```bash
 bundle install
-bundle exec rspec        # 17 examples
+bundle exec rspec        # 66 examples
 bundle exec rubocop
 ```
 
 ---
 
 **Maintained By**: Matthew Iverson (@Esity)
+**Last Updated**: 2026-04-06

data/README.md

@@ -100,7 +100,6 @@ puts image[:result]['data'].first['url']
 
 - `faraday` >= 2.0 - HTTP client
 - `faraday-multipart` >= 1.0 - Multipart file uploads (images, audio, files)
-- `multi_json` - JSON parser abstraction
 
 ## Requirements
 
@@ -114,6 +113,10 @@ puts image[:result]['data'].first['url']
 - `legion-llm` — High-level LLM interface including OpenAI via ruby_llm
 - `extensions-ai/CLAUDE.md` — Architecture patterns shared across all AI extensions
 
+## Version
+
+0.1.5
+
 ## License
 
 MIT

data/lib/legion/extensions/openai/identity.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Legion
+  module Extensions
+    module Openai
+      module Identity
+        module_function
+
+        def provider_name  = :openai
+        def provider_type  = :credential
+        def facing         = nil
+        def capabilities   = %i[credentials]
+
+        def resolve(canonical_name: nil) # rubocop:disable Lint/UnusedMethodArgument
+          nil
+        end
+
+        def provide_token
+          api_key = resolve_api_key
+          return nil unless api_key
+
+          Legion::Identity::Lease.new(
+            provider:   :openai,
+            credential: api_key,
+            expires_at: nil,
+            renewable:  false,
+            issued_at:  Time.now,
+            metadata:   { credential_type: :api_key }
+          )
+        end
+
+        def resolve_api_key
+          return nil unless defined?(Legion::Settings)
+
+          value = Legion::Settings.dig(:llm, :providers, :openai, :api_key)
+          value = value.find { |v| v && !v.empty? } if value.is_a?(Array)
+          value unless value.nil? || (value.is_a?(String) && (value.empty? || value.start_with?('env://')))
+        end
+
+        private_class_method :resolve_api_key
+      end
+    end
+  end
+end

data/lib/legion/extensions/openai/runners/audio.rb

@@ -14,7 +14,15 @@ module Legion
             body[:speed] = speed if speed
 
             response = client(api_key: api_key, **).post('/v1/audio/speech', body)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def transcribe(file:, api_key:, model: 'whisper-1', language: nil, prompt: nil, response_format: nil, **)
@@ -27,7 +35,15 @@ module Legion
             payload[:response_format] = response_format if response_format
 
             response = client(api_key: api_key, **).post('/v1/audio/transcriptions', payload)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def translate(file:, api_key:, model: 'whisper-1', prompt: nil, response_format: nil, **)
@@ -39,7 +55,15 @@ module Legion
             payload[:response_format] = response_format if response_format
 
             response = client(api_key: api_key, **).post('/v1/audio/translations', payload)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/runners/chat.rb

@@ -20,7 +20,16 @@ module Legion
             body[:stop] = stop if stop
 
             response = client(api_key: api_key, **).post('/v1/chat/completions', body)
-            { result: response.body }
+            resp_body = response.body
+            {
+              result: resp_body,
+              usage:  {
+                input_tokens:       resp_body.dig('usage', 'prompt_tokens') || 0,
+                output_tokens:      resp_body.dig('usage', 'completion_tokens') || 0,
+                cache_read_tokens:  resp_body.dig('usage', 'prompt_tokens_details', 'cached_tokens') || 0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/runners/embeddings.rb

@@ -15,7 +15,16 @@ module Legion
             body[:dimensions] = dimensions if dimensions
 
             response = client(api_key: api_key, **).post('/v1/embeddings', body)
-            { result: response.body }
+            resp_body = response.body
+            {
+              result: resp_body,
+              usage:  {
+                input_tokens:       resp_body.dig('usage', 'prompt_tokens') || 0,
+                output_tokens:      resp_body.dig('usage', 'completion_tokens') || 0,
+                cache_read_tokens:  resp_body.dig('usage', 'prompt_tokens_details', 'cached_tokens') || 0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/runners/files.rb

@@ -14,7 +14,15 @@ module Legion
             path += "?purpose=#{purpose}" if purpose
 
             response = client(api_key: api_key, **).get(path)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def upload(file:, purpose:, api_key:, **)
@@ -24,22 +32,54 @@ module Legion
             }
 
             response = client(api_key: api_key, **).post('/v1/files', payload)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def retrieve(file_id:, api_key:, **)
             response = client(api_key: api_key, **).get("/v1/files/#{file_id}")
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def delete(file_id:, api_key:, **)
             response = client(api_key: api_key, **).delete("/v1/files/#{file_id}")
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def content(file_id:, api_key:, **)
             response = client(api_key: api_key, **).get("/v1/files/#{file_id}/content")
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/runners/images.rb

@@ -17,7 +17,15 @@ module Legion
             body[:response_format] = response_format if response_format
 
             response = client(api_key: api_key, **).post('/v1/images/generations', body)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def edit(image:, prompt:, api_key:, model: 'dall-e-2', mask: nil, n: 1, size: '1024x1024', **)
@@ -31,7 +39,15 @@ module Legion
             payload[:mask] = Faraday::Multipart::FilePart.new(mask, 'image/png') if mask
 
             response = client(api_key: api_key, **).post('/v1/images/edits', payload)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def variation(image:, api_key:, model: 'dall-e-2', n: 1, size: '1024x1024', **)
@@ -43,7 +59,15 @@ module Legion
             }
 
             response = client(api_key: api_key, **).post('/v1/images/variations', payload)
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/runners/models.rb

@@ -11,17 +11,41 @@ module Legion
 
           def list(api_key:, **)
             response = client(api_key: api_key, **).get('/v1/models')
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def retrieve(model:, api_key:, **)
             response = client(api_key: api_key, **).get("/v1/models/#{model}")
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           def delete(model:, api_key:, **)
             response = client(api_key: api_key, **).delete("/v1/models/#{model}")
-            { result: response.body }
+            {
+              result: response.body,
+              usage:  {
+                input_tokens:       0,
+                output_tokens:      0,
+                cache_read_tokens:  0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/runners/moderations.rb

@@ -14,7 +14,16 @@ module Legion
             body[:model] = model if model
 
             response = client(api_key: api_key, **).post('/v1/moderations', body)
-            { result: response.body }
+            resp_body = response.body
+            {
+              result: resp_body,
+              usage:  {
+                input_tokens:       resp_body.dig('usage', 'prompt_tokens') || 0,
+                output_tokens:      resp_body.dig('usage', 'completion_tokens') || 0,
+                cache_read_tokens:  resp_body.dig('usage', 'prompt_tokens_details', 'cached_tokens') || 0,
+                cache_write_tokens: 0
+              }
+            }
           end
 
           include Legion::Extensions::Helpers::Lex if Legion::Extensions.const_defined?(:Helpers, false) &&

data/lib/legion/extensions/openai/version.rb

@@ -3,7 +3,7 @@
 module Legion
   module Extensions
     module Openai
-      VERSION = '0.1.3'
+      VERSION = '0.1.5'
     end
   end
 end

data/lib/legion/extensions/openai.rb

@@ -9,6 +9,7 @@ require 'legion/extensions/openai/runners/audio'
 require 'legion/extensions/openai/runners/embeddings'
 require 'legion/extensions/openai/runners/files'
 require 'legion/extensions/openai/runners/moderations'
+require 'legion/extensions/openai/identity'
 
 module Legion
   module Extensions

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lex-openai
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Esity
@@ -157,6 +157,7 @@ files:
 - lex-openai.gemspec
 - lib/legion/extensions/openai.rb
 - lib/legion/extensions/openai/helpers/client.rb
+- lib/legion/extensions/openai/identity.rb
 - lib/legion/extensions/openai/runners/audio.rb
 - lib/legion/extensions/openai/runners/chat.rb
 - lib/legion/extensions/openai/runners/embeddings.rb