blackman_client 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10646256d97ec239d7195c3317a38e5b3ec3278ab26921646139d71c8e379b89
+  data.tar.gz: 79daba76e677e18d10568db4d238401c11500663150df8736b2caa9ca04fdd22
+SHA512:
+  metadata.gz: 4ea08108aa027a9074214052d7c7c5bd76ac45ff3a3646e887b90c3edf681bc0897c7a28775dcb8f56eacab98bf47714dd4d52187e81ef543e50275125fba54a
+  data.tar.gz: dc1a6977997ddbb1b4f18016fe570051d11422085746b5f22db4699221c90bd41606313ff71f352e05cc597f3751713b52cc6eb5c497e3834c6f8cc06746c407

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Blackman AI
+
+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,266 @@
+# Blackman AI Ruby SDK
+
+Official Ruby client for [Blackman AI](https://www.useblackman.ai) - The AI API proxy that optimizes token usage to reduce costs.
+
+## Features
+
+- 🚀 Drop-in replacement for OpenAI, Anthropic, and other LLM APIs
+- 💰 Automatic token optimization (save 20-40% on costs)
+- 📊 Built-in analytics and cost tracking
+- 🔒 Enterprise-grade security with SSO support
+- ⚡ Low latency overhead (<50ms)
+- 🎯 Semantic caching for repeated queries
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'blackman_client', '~> 0.0.5'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself:
+
+```bash
+gem install blackman_client
+```
+
+## Quick Start
+
+```ruby
+require 'blackman_client'
+
+# Configure client
+BlackmanClient.configure do |config|
+  config.host = 'app.useblackman.ai'
+  config.scheme = 'https'
+  config.api_key['Authorization'] = 'Bearer sk_your_blackman_api_key'
+end
+
+api = BlackmanClient::CompletionsApi.new
+
+# Create completion request
+request = BlackmanClient::CompletionRequest.new(
+  provider: 'OpenAI',
+  model: 'gpt-4o',
+  messages: [
+    BlackmanClient::Message.new(
+      role: 'user',
+      content: 'Explain quantum computing in simple terms'
+    )
+  ]
+)
+
+# Send request
+begin
+  response = api.completions(request)
+  puts response.choices[0].message.content
+  puts "Tokens used: #{response.usage.total_tokens}"
+rescue BlackmanClient::ApiError => e
+  puts "Error: #{e}"
+end
+```
+
+## Authentication
+
+Get your API key from the [Blackman AI Dashboard](https://app.useblackman.ai/settings/api-keys).
+
+```ruby
+BlackmanClient.configure do |config|
+  config.host = 'app.useblackman.ai'
+  config.scheme = 'https'
+  config.api_key['Authorization'] = 'Bearer sk_your_blackman_api_key'
+end
+```
+
+## Framework Integration
+
+### Ruby on Rails
+
+Create an initializer `config/initializers/blackman.rb`:
+
+```ruby
+require 'blackman_client'
+
+BlackmanClient.configure do |config|
+  config.host = 'app.useblackman.ai'
+  config.scheme = 'https'
+  config.api_key['Authorization'] = "Bearer #{ENV['BLACKMAN_API_KEY']}"
+end
+```
+
+Create a service class `app/services/chat_service.rb`:
+
+```ruby
+class ChatService
+  def initialize
+    @api = BlackmanClient::CompletionsApi.new
+  end
+
+  def chat(message)
+    request = BlackmanClient::CompletionRequest.new(
+      provider: 'OpenAI',
+      model: 'gpt-4o',
+      messages: [
+        BlackmanClient::Message.new(
+          role: 'user',
+          content: message
+        )
+      ]
+    )
+
+    response = @api.completions(request)
+    response.choices[0].message.content
+  rescue BlackmanClient::ApiError => e
+    Rails.logger.error "Blackman API error: #{e}"
+    raise
+  end
+end
+```
+
+Use in a controller:
+
+```ruby
+class ChatsController < ApplicationController
+  def create
+    service = ChatService.new
+    response = service.chat(params[:message])
+    render json: { response: response }
+  rescue BlackmanClient::ApiError => e
+    render json: { error: e.message }, status: :bad_request
+  end
+end
+```
+
+### Sinatra
+
+```ruby
+require 'sinatra'
+require 'blackman_client'
+require 'json'
+
+# Configure Blackman
+BlackmanClient.configure do |config|
+  config.host = 'app.useblackman.ai'
+  config.scheme = 'https'
+  config.api_key['Authorization'] = "Bearer #{ENV['BLACKMAN_API_KEY']}"
+end
+
+post '/chat' do
+  content_type :json
+
+  data = JSON.parse(request.body.read)
+
+  api = BlackmanClient::CompletionsApi.new
+  request = BlackmanClient::CompletionRequest.new(
+    provider: 'OpenAI',
+    model: 'gpt-4o',
+    messages: [
+      BlackmanClient::Message.new(
+        role: 'user',
+        content: data['message']
+      )
+    ]
+  )
+
+  begin
+    response = api.completions(request)
+    { response: response.choices[0].message.content }.to_json
+  rescue BlackmanClient::ApiError => e
+    status 400
+    { error: e.message }.to_json
+  end
+end
+```
+
+## Advanced Usage
+
+### Custom Timeouts
+
+```ruby
+BlackmanClient.configure do |config|
+  config.host = 'app.useblackman.ai'
+  config.scheme = 'https'
+  config.api_key['Authorization'] = 'Bearer sk_your_blackman_api_key'
+  config.timeout = 60  # seconds
+end
+```
+
+### Error Handling
+
+```ruby
+begin
+  response = api.completions(request)
+  puts response.choices[0].message.content
+rescue BlackmanClient::ApiError => e
+  puts "HTTP Status Code: #{e.code}"
+  puts "Response Headers: #{e.response_headers}"
+  puts "Response Body: #{e.response_body}"
+rescue StandardError => e
+  puts "Unexpected error: #{e.message}"
+end
+```
+
+### Streaming Responses
+
+```ruby
+# For streaming, use a custom approach with Faraday
+require 'faraday'
+
+conn = Faraday.new(url: 'https://app.useblackman.ai') do |f|
+  f.headers['Authorization'] = 'Bearer sk_your_blackman_api_key'
+  f.adapter Faraday.default_adapter
+end
+
+response = conn.post('/v1/completions') do |req|
+  req.headers['Content-Type'] = 'application/json'
+  req.body = {
+    provider: 'OpenAI',
+    model: 'gpt-4o',
+    messages: [{ role: 'user', content: 'Hello!' }],
+    stream: true
+  }.to_json
+end
+
+response.body.each_line do |line|
+  puts line if line.start_with?('data:')
+end
+```
+
+### Retry Logic
+
+```ruby
+require 'retriable'
+
+Retriable.retriable(tries: 3, base_interval: 1, multiplier: 2) do
+  response = api.completions(request)
+  puts response.choices[0].message.content
+end
+```
+
+## Documentation
+
+- [Full API Reference](https://app.useblackman.ai/docs)
+- [Getting Started Guide](https://app.useblackman.ai/docs/getting-started)
+- [Ruby Examples](https://github.com/blackman-ai/ruby-sdk/tree/main/examples)
+- [RubyDoc](https://rubydoc.info/gems/blackman_client)
+
+## Requirements
+
+- Ruby 2.7 or higher
+
+## Support
+
+- 📧 Email: [support@blackman.ai](mailto:support@blackman.ai)
+- 💬 Discord: [Join our community](https://discord.gg/blackman-ai)
+- 🐛 Issues: [GitHub Issues](https://github.com/blackman-ai/ruby-sdk/issues)
+
+## License
+
+MIT © Blackman AI

data/lib/blackman_client/api/completions_api.rb

@@ -0,0 +1,89 @@
+=begin
+#Blackman AI API
+
+#A transparent AI API proxy that optimizes token usage to reduce costs.  ## Authentication  Blackman AI supports two authentication methods:  ### 1. API Key (Recommended for integrations)  Use the API key created from your dashboard:  ```bash curl -X POST https://ap.useblackman.ai/v1/completions \\   -H \"Authorization: Bearer sk_your_api_key_here\" \\   -H \"Content-Type: application/json\" \\   -d '{\"provider\": \"OpenAI\", \"model\": \"gpt-4\", \"messages\": [{\"role\": \"user\", \"content\": \"Hello!\"}]}' ```  ### 2. JWT Token (For web UI)  Obtain a JWT token by logging in:  ```bash curl -X POST https://ap.useblackman.ai/v1/auth/login \\   -H \"Content-Type: application/json\" \\   -d '{\"email\": \"user@example.com\", \"password\": \"yourpassword\"}' ```  Then use the token:  ```bash curl -X POST https://ap.useblackman.ai/v1/completions \\   -H \"Authorization: Bearer your_jwt_token\" \\   -H \"Content-Type: application/json\" \\   -d '{...}' ```  ### Provider API Keys (Optional)  You can optionally provide your own LLM provider API key via the `X-Provider-Api-Key` header, or store it in your account settings.  ## Client SDKs  Auto-generated SDKs are available for 10 languages:  - **TypeScript**: [View Docs](/v1/sdks/typescript) - **Python**: [View Docs](/v1/sdks/python) - **Go**: [View Docs](/v1/sdks/go) - **Java**: [View Docs](/v1/sdks/java) - **Ruby**: [View Docs](/v1/sdks/ruby) - **PHP**: [View Docs](/v1/sdks/php) - **C#**: [View Docs](/v1/sdks/csharp) - **Rust**: [View Docs](/v1/sdks/rust) - **Swift**: [View Docs](/v1/sdks/swift) - **Kotlin**: [View Docs](/v1/sdks/kotlin)  All SDKs are generated from this OpenAPI spec using [openapi-generator](https://openapi-generator.tech).  ## Quick Start  ```python # Python example with API key import blackman_client from blackman_client import CompletionRequest  configuration = blackman_client.Configuration(     host=\"http://localhost:8080\",     access_token=\"sk_your_api_key_here\"  # Your Blackman API key )  with blackman_client.ApiClient(configuration) as api_client:     api = blackman_client.CompletionsApi(api_client)     response = api.completions(         CompletionRequest(             provider=\"OpenAI\",             model=\"gpt-4o\",             messages=[{\"role\": \"user\", \"content\": \"Hello!\"}]         )     ) ```
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module BlackmanClient
+  class CompletionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # @param completion_request [CompletionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_provider_api_key Optional provider API key to override stored or system keys
+    # @return [CompletionResponse]
+    def completions(completion_request, opts = {})
+      data, _status_code, _headers = completions_with_http_info(completion_request, opts)
+      data
+    end
+
+    # @param completion_request [CompletionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :x_provider_api_key Optional provider API key to override stored or system keys
+    # @return [Array<(CompletionResponse, Integer, Hash)>] CompletionResponse data, response status code and response headers
+    def completions_with_http_info(completion_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CompletionsApi.completions ...'
+      end
+      # verify the required parameter 'completion_request' is set
+      if @api_client.config.client_side_validation && completion_request.nil?
+        fail ArgumentError, "Missing the required parameter 'completion_request' when calling CompletionsApi.completions"
+      end
+      # resource path
+      local_var_path = '/v1/completions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-Provider-Api-Key'] = opts[:'x_provider_api_key'] if !opts[:'x_provider_api_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(completion_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CompletionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CompletionsApi.completions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CompletionsApi#completions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/blackman_client/api/feedback_api.rb

@@ -0,0 +1,88 @@
+=begin
+#Blackman AI API
+
+#A transparent AI API proxy that optimizes token usage to reduce costs.  ## Authentication  Blackman AI supports two authentication methods:  ### 1. API Key (Recommended for integrations)  Use the API key created from your dashboard:  ```bash curl -X POST https://ap.useblackman.ai/v1/completions \\   -H \"Authorization: Bearer sk_your_api_key_here\" \\   -H \"Content-Type: application/json\" \\   -d '{\"provider\": \"OpenAI\", \"model\": \"gpt-4\", \"messages\": [{\"role\": \"user\", \"content\": \"Hello!\"}]}' ```  ### 2. JWT Token (For web UI)  Obtain a JWT token by logging in:  ```bash curl -X POST https://ap.useblackman.ai/v1/auth/login \\   -H \"Content-Type: application/json\" \\   -d '{\"email\": \"user@example.com\", \"password\": \"yourpassword\"}' ```  Then use the token:  ```bash curl -X POST https://ap.useblackman.ai/v1/completions \\   -H \"Authorization: Bearer your_jwt_token\" \\   -H \"Content-Type: application/json\" \\   -d '{...}' ```  ### Provider API Keys (Optional)  You can optionally provide your own LLM provider API key via the `X-Provider-Api-Key` header, or store it in your account settings.  ## Client SDKs  Auto-generated SDKs are available for 10 languages:  - **TypeScript**: [View Docs](/v1/sdks/typescript) - **Python**: [View Docs](/v1/sdks/python) - **Go**: [View Docs](/v1/sdks/go) - **Java**: [View Docs](/v1/sdks/java) - **Ruby**: [View Docs](/v1/sdks/ruby) - **PHP**: [View Docs](/v1/sdks/php) - **C#**: [View Docs](/v1/sdks/csharp) - **Rust**: [View Docs](/v1/sdks/rust) - **Swift**: [View Docs](/v1/sdks/swift) - **Kotlin**: [View Docs](/v1/sdks/kotlin)  All SDKs are generated from this OpenAPI spec using [openapi-generator](https://openapi-generator.tech).  ## Quick Start  ```python # Python example with API key import blackman_client from blackman_client import CompletionRequest  configuration = blackman_client.Configuration(     host=\"http://localhost:8080\",     access_token=\"sk_your_api_key_here\"  # Your Blackman API key )  with blackman_client.ApiClient(configuration) as api_client:     api = blackman_client.CompletionsApi(api_client)     response = api.completions(         CompletionRequest(             provider=\"OpenAI\",             model=\"gpt-4o\",             messages=[{\"role\": \"user\", \"content\": \"Hello!\"}]         )     ) ```
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module BlackmanClient
+  class FeedbackApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Submit feedback for a completion response
+    # @param submit_feedback_request [SubmitFeedbackRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SubmitFeedbackResponse]
+    def submit_feedback(submit_feedback_request, opts = {})
+      data, _status_code, _headers = submit_feedback_with_http_info(submit_feedback_request, opts)
+      data
+    end
+
+    # Submit feedback for a completion response
+    # @param submit_feedback_request [SubmitFeedbackRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubmitFeedbackResponse, Integer, Hash)>] SubmitFeedbackResponse data, response status code and response headers
+    def submit_feedback_with_http_info(submit_feedback_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FeedbackApi.submit_feedback ...'
+      end
+      # verify the required parameter 'submit_feedback_request' is set
+      if @api_client.config.client_side_validation && submit_feedback_request.nil?
+        fail ArgumentError, "Missing the required parameter 'submit_feedback_request' when calling FeedbackApi.submit_feedback"
+      end
+      # resource path
+      local_var_path = '/v1/feedback'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_feedback_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubmitFeedbackResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"FeedbackApi.submit_feedback",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FeedbackApi#submit_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end