traffic_orchestrator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 70635b2e17549aeb91e0aec3d144c254fe07a81978324dfaa62e5df697e3e0b1
+  data.tar.gz: df7c26f54a757112be4886a6b7d88aa195f1de32aa8be1cd4a29ea84990c6db8
+SHA512:
+  metadata.gz: 36da1c9cbe288d412e06fbc205198de3ed801f8d1bedfab2a651ab4c3d9273e7ebb13bb294cc8d4f275052a4f484f824992401995bad84999eb23a7663cae44a
+  data.tar.gz: 9dccaf4ab4690ff0c2e43370afbd080ceed638367fe5fa5eb94cb3d7e8be66a381a54445911b7c4d56d8be57d43735f248f741322b69c903942b93ba570a2283

data/README.md

@@ -0,0 +1,135 @@
+# traffic_orchestrator (Ruby)
+
+Official Ruby gem for [Traffic Orchestrator](https://trafficorchestrator.com) — enterprise-grade software license management.
+
+## Install
+
+```ruby
+# Gemfile
+gem 'traffic_orchestrator'
+```
+
+```bash
+bundle install
+# or
+gem install traffic_orchestrator
+```
+
+## Quick Start
+
+```ruby
+require 'traffic_orchestrator'
+
+client = TrafficOrchestrator::Client.new(
+  api_key: ENV['TO_API_KEY'],
+  timeout: 5,
+  retries: 3
+)
+
+result = client.validate_license('LK-xxxx', domain: 'example.com')
+puts "Valid: #{result.valid}, Plan: #{result.plan_id}" if result.valid
+```
+
+## API Methods
+
+### Core License Operations
+
+| Method | Description |
+|--------|-------------|
+| `validate_license(token, domain:)` | Validate a license key against a domain |
+| `verify_offline(token)` | Verify license locally using Ed25519 signatures |
+| `list_licenses` | List all licenses for the authenticated user |
+| `create_license(plan_id:, domains:)` | Create a new license |
+| `rotate_license(license_id)` | Rotate a license key (revoke old, generate new) |
+| `add_domain(license_id, domain)` | Add a domain to a license |
+| `remove_domain(license_id, domain)` | Remove a domain from a license |
+| `delete_license(license_id)` | Delete (revoke) a license |
+| `get_usage` | Get current usage statistics |
+
+### Portal & Enterprise Methods
+
+| Method | Description |
+|--------|-------------|
+| `get_analytics(days: 30)` | Detailed analytics for the specified period |
+| `get_dashboard` | Full dashboard overview |
+| `get_sla` | SLA compliance data |
+| `export_audit_logs(format: 'json')` | Export audit logs as JSON or CSV |
+| `get_webhook_deliveries(page: 1)` | Webhook delivery history |
+| `batch_license_operation(op:, ids:)` | Batch suspend/activate/extend licenses |
+| `get_ip_allowlist(license_id)` | Get IP allowlist for a license |
+| `set_ip_allowlist(license_id, ips:)` | Set IP allowlist for a license |
+| `health_check` | Check API health status |
+
+## Error Handling
+
+```ruby
+begin
+  client.validate_license(token, domain: 'example.com')
+rescue TrafficOrchestrator::ApiError => e
+  puts "#{e.code}: #{e.message} (HTTP #{e.status})"
+rescue TrafficOrchestrator::NetworkError => e
+  puts "Network: #{e.message}"
+end
+```
+
+## Rails Integration
+
+```ruby
+# config/initializers/traffic_orchestrator.rb
+TrafficOrchestrator.configure do |config|
+  config.api_key = Rails.application.credentials.dig(:traffic_orchestrator, :api_key)
+  config.timeout = 5
+  config.retries = 3
+end
+
+# In a controller
+class LicensesController < ApplicationController
+  def validate
+    result = TrafficOrchestrator.client.validate_license(
+      params[:license_key],
+      domain: request.host
+    )
+    render json: { valid: result.valid, plan: result.plan_id }
+  end
+end
+```
+
+## Multi-Environment Keys
+
+```ruby
+# Development
+dev_client = TrafficOrchestrator::Client.new(
+  api_key: ENV['TO_API_KEY_DEV'],
+  base_url: 'https://api-staging.trafficorchestrator.com'
+)
+
+# Production
+prod_client = TrafficOrchestrator::Client.new(
+  api_key: ENV['TO_API_KEY']
+)
+```
+
+## Offline Verification (Enterprise)
+
+```ruby
+client = TrafficOrchestrator::Client.new(
+  public_key: ENV['TO_PUBLIC_KEY']
+)
+result = client.verify_offline(license_token)
+puts "Plan: #{result.plan_id}" if result.valid
+```
+
+## Requirements
+
+- Ruby 3.0+
+- Faraday 2.x
+
+## Documentation
+
+- [API Reference](https://trafficorchestrator.com/docs)
+- [Ruby SDK Guide](https://trafficorchestrator.com/docs/sdk/ruby)
+- [OpenAPI Spec](https://api.trafficorchestrator.com/api/v1/openapi.json)
+
+## License
+
+MIT

data/lib/traffic_orchestrator.rb

@@ -0,0 +1,227 @@
+require 'net/http'
+require 'json'
+require 'uri'
+
+module TrafficOrchestrator
+  VERSION = '2.0.0'
+
+  class Client
+    attr_reader :base_url, :api_key, :timeout, :retries
+
+    def initialize(base_url = 'https://api.trafficorchestrator.com/api/v1', api_key: nil, timeout: 10, retries: 2)
+      @base_url = base_url.chomp('/')
+      @api_key  = api_key
+      @timeout  = timeout
+      @retries  = retries
+    end
+
+    # ── Core: License Validation ──────────────────────────────────────────
+
+    # Validate a license key against the API server.
+    def validate_license(token, domain = nil)
+      request('POST', '/validate', { token: token, domain: domain })
+    end
+
+    # Verify offline using Ed25519.
+    # Requires 'ed25519' and 'base64' gems.
+    def verify_offline(token, public_key_base64, domain = nil)
+      require 'ed25519'
+      require 'base64'
+
+      parts = token.split('.')
+      return { 'valid' => false, 'error' => 'Invalid token format' } unless parts.length == 3
+
+      header = JSON.parse(Base64.urlsafe_decode64(parts[0]))
+      payload = JSON.parse(Base64.urlsafe_decode64(parts[1]))
+      signature = Base64.urlsafe_decode64(parts[2])
+
+      return { 'valid' => false, 'error' => 'Algorithm not supported' } unless header['alg'] == 'EdDSA'
+
+      # Verify Signature
+      public_key_bytes = Base64.strict_decode64(public_key_base64)
+      verify_key = Ed25519::VerifyKey.new(public_key_bytes)
+
+      message = "#{parts[0]}.#{parts[1]}"
+
+      begin
+        verify_key.verify(signature, message)
+      rescue Ed25519::VerifyError
+        return { 'valid' => false, 'error' => 'Invalid signature' }
+      end
+
+      # Verify Expiration
+      if payload['exp'] && payload['exp'] < Time.now.to_i
+        return { 'valid' => false, 'error' => 'Token expired' }
+      end
+
+      # Verify Domain
+      if domain && payload['dom'].is_a?(Array)
+        match = payload['dom'].any? { |d| domain.include?(d) }
+        return { 'valid' => false, 'error' => 'Domain mismatch' } unless match
+      end
+
+      { 'valid' => true, 'payload' => payload }
+    rescue => e
+      { 'valid' => false, 'error' => e.message }
+    end
+
+    # ── License Management (requires API key) ────────────────────────────
+
+    # List all licenses for the authenticated user.
+    def list_licenses
+      data = request('GET', '/portal/licenses')
+      data['licenses'] || []
+    end
+
+    # Create a new license.
+    def create_license(app_name, domain: nil, plan_id: nil)
+      body = { appName: app_name }
+      body[:domain] = domain if domain
+      body[:planId] = plan_id if plan_id
+      request('POST', '/portal/licenses', body)
+    end
+
+    # Rotate a license key (revoke old, generate new).
+    def rotate_license(license_id)
+      request('POST', "/portal/licenses/#{license_id}/rotate")
+    end
+
+    # Add a domain to a license.
+    def add_domain(license_id, domain)
+      request('POST', "/portal/licenses/#{license_id}/domains", { domain: domain })
+    end
+
+    # Remove a domain from a license.
+    def remove_domain(license_id, domain)
+      request('DELETE', "/portal/licenses/#{license_id}/domains", { domain: domain })
+    end
+
+    # Delete (revoke) a license.
+    def delete_license(license_id)
+      request('DELETE', "/portal/licenses/#{license_id}")
+    end
+
+    # ── Usage & Analytics ────────────────────────────────────────────────
+
+    # Get current usage statistics.
+    def get_usage
+      request('GET', '/portal/stats')
+    end
+
+    # ── Health ───────────────────────────────────────────────────────────
+
+    # Check API health status.
+    def health_check
+      request('GET', '/health')
+    end
+
+    # ── Analytics & SLA ──────────────────────────────────────────────────
+
+    # Get detailed analytics for the specified number of days.
+    def get_analytics(days: 30)
+      request('GET', "/portal/analytics?days=#{days}")
+    end
+
+    # Get a full dashboard overview.
+    def get_dashboard
+      request('GET', '/portal/dashboard')
+    end
+
+    # Get SLA compliance data.
+    def get_sla(days: 30)
+      request('GET', "/portal/sla?days=#{days}")
+    end
+
+    # ── Audit & Webhooks ─────────────────────────────────────────────────
+
+    # Export audit logs in the specified format.
+    def export_audit_logs(format: 'json', since: nil)
+      path = "/portal/audit-logs/export?format=#{format}"
+      path += "&since=#{since}" if since
+      request('GET', path)
+    end
+
+    # Get webhook delivery history.
+    def get_webhook_deliveries(limit: 50, status: nil)
+      path = "/portal/webhooks/deliveries?limit=#{limit}"
+      path += "&status=#{status}" if status
+      request('GET', path)
+    end
+
+    # ── Batch Operations ─────────────────────────────────────────────────
+
+    # Perform a batch operation on multiple licenses.
+    def batch_license_operation(action, license_ids, days: nil)
+      body = { action: action, licenseIds: license_ids }
+      body[:days] = days if days
+      request('POST', '/portal/licenses/batch', body)
+    end
+
+    # ── IP Allowlist ─────────────────────────────────────────────────────
+
+    # Get the IP allowlist for a license.
+    def get_ip_allowlist(license_id)
+      request('GET', "/portal/licenses/#{license_id}/ip-allowlist")
+    end
+
+    # Set the IP allowlist for a license.
+    def set_ip_allowlist(license_id, allowed_ips)
+      request('PUT', "/portal/licenses/#{license_id}/ip-allowlist", { allowedIps: allowed_ips })
+    end
+
+    private
+
+    # ── Internal ─────────────────────────────────────────────────────────
+
+    def request(method, path, body = nil)
+      uri = URI.parse("#{@base_url}#{path}")
+      last_error = nil
+
+      (0..@retries).each do |attempt|
+        begin
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = true if uri.scheme == 'https'
+          http.open_timeout = @timeout
+          http.read_timeout = @timeout
+
+          headers = {
+            'Content-Type' => 'application/json',
+            'User-Agent' => "TrafficOrchestrator-Ruby/#{VERSION}"
+          }
+          headers['Authorization'] = "Bearer #{@api_key}" if @api_key
+
+          case method
+          when 'POST'
+            req = Net::HTTP::Post.new(uri.request_uri, headers)
+            req.body = body.to_json if body
+          when 'PUT'
+            req = Net::HTTP::Put.new(uri.request_uri, headers)
+            req.body = body.to_json if body
+          when 'DELETE'
+            req = Net::HTTP::Delete.new(uri.request_uri, headers)
+            req.body = body.to_json if body
+          when 'GET'
+            req = Net::HTTP::Get.new(uri.request_uri, headers)
+          end
+
+          response = http.request(req)
+          data = JSON.parse(response.body)
+
+          code = response.code.to_i
+          return data if code >= 200 && code < 300
+          return data if code >= 400 && code < 500
+
+          last_error = "HTTP #{code}"
+        rescue => e
+          last_error = e.message
+        end
+
+        if attempt < @retries
+          sleep([1.0 * (2 ** attempt), 5.0].min)
+        end
+      end
+
+      { 'valid' => false, 'error' => last_error || 'Request failed' }
+    end
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: traffic_orchestrator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Traffic Orchestrator
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: faraday
+  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'
+description: Ruby SDK for Traffic Orchestrator license validation with offline verification
+  support
+email:
+- contact@trafficorchestrator.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/traffic_orchestrator.rb
+homepage: https://trafficorchestrator.com
+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.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: Traffic Orchestrator License Validation SDK
+test_files: []