dexa-ai-sdk 0.3.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 89029c150650fa7fadcc17e73039f62f2215b503299399d85532bb1e738e3243
+  data.tar.gz: aa5c528001b1869d3f3bb6ed704a4c168c27cc4df713b12adfbbd2ae61fc1f80
+SHA512:
+  metadata.gz: 0aafbd9558802782b5b369d3da7c92f4bf4f70f660fd42a42a6d81aad2100f12da61ed4e23be39d45cbb568f505ba71cc46cfcdf806faf9b617598cae45f4fa7
+  data.tar.gz: 6baceb703451c8988b4808fcd4c5fadd44303e5b6c7c0c87c2c691e7a45c8126df867782113f49ac5a0da0a61c0afd7e6b1135ed08e2f57586e785a4f20d09ac

data/.fernignore

@@ -0,0 +1,5 @@
+# Fern overwrites these on every generation, which would undo the gem's identity.
+# custom.gemspec.rb is the documented hook for setting the gem name, authors,
+# licence and links, because the Fern API has no name of its own and the
+# generator otherwise falls back to the organization name.
+custom.gemspec.rb

data/.rubocop.yml

@@ -0,0 +1,107 @@
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: normalcase
+  Severity: warning
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+# Docstrings come from API definitions and often start with words like "Note:".
+Style/CommentAnnotation:
+  Enabled: false
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Minitest/UselessAssertion:
+  Enabled: false
+
+# Dynamic snippets are code samples for documentation, not standalone Ruby files.
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# Indent hash elements 2 spaces from the start of the enclosing line rather than
+# aligning with the preceding paren or bracket. Generated code nests hashes inside
+# arrays and method calls; the "consistent" style is more readable there.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# Match Layout/FirstHashElementIndentation: indent the first argument 2 spaces
+# from the start of the method call's line, regardless of parenthesis position.
+# Dynamic snippets are code samples, not standalone Ruby files; exclude them to
+# keep this config symmetric with Layout/FirstHashElementIndentation above.
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# The generator emits non-idiomatic class names (e.g. Get_With_Query, JSON_)
+# derived from IR type names whose wire form contains underscores or digits.
+# Rubocop never auto-corrected these (naming cops have no autocorrecter), so
+# disabling the cop keeps CI green without changing customer output. Fixing at
+# source would rename public types across every existing SDK and therefore
+# requires a ruby-v2 major-version bump with a generator migration.
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+# Integer literals are emitted unformatted (e.g. 1000000, not 1_000_000).
+# Rubocop has an autocorrecter for this cop, but the only caller of integer
+# emission is the dynamic-snippets path, which feeds customer-facing surfaces:
+# (1) snippet markdown in reference docs, (2) dynamic-snippets/*.rb sample
+# files. Neither is rubocop-gated (markdown isn't Ruby, dynamic-snippets/**/*
+# is excluded above), so formatting integers there would change docs/dashboard
+# output without any rubocop benefit. Disabling the cop keeps integers raw
+# everywhere and avoids customer-visible diffs.
+Style/NumericLiterals:
+  Enabled: false

data/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Ruby 3.0+
+- Bundler
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+bundle install
+```
+
+### Building
+
+Build the gem:
+
+```bash
+gem build *.gemspec
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+bundle exec rubocop
+```
+
+Fix code style issues:
+
+```bash
+bundle exec rubocop -a
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `lib/` - API client classes and types
+- Most Ruby files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Ruby SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/ruby-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `bundle exec rspec`
+4. Run linting: `bundle exec rubocop`
+5. Build the gem: `gem build *.gemspec`
+6. Commit your changes with a clear commit message
+7. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses RuboCop for code formatting. Run `bundle exec rubocop` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

data/README.md

@@ -0,0 +1,199 @@
+# DexaAiSdk Ruby Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=DexaAiSdk%2FRuby)
+
+The DexaAiSdk Ruby library provides convenient access to the DexaAiSdk APIs from Ruby.
+
+## Table of Contents
+
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Errors](#errors)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Additional Headers](#additional-headers)
+  - [Additional Query Parameters](#additional-query-parameters)
+  - [Additional Body Properties](#additional-body-properties)
+- [Contributing](#contributing)
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```ruby
+require "dexa-ai-sdk"
+
+client = DexaAiSdk::Client.new
+
+client.tasks.run_tasks(
+  model: "model",
+  tasks: []
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments or custom URLs for API requests. You can either use the predefined environments or specify your own custom URL.
+### Environments
+```ruby
+require "dexa-ai-sdk"
+
+dexa-ai-sdk = DexaAiSdk::Client.new(
+    base_url: DexaAiSdk::Environment::DEFAULT
+)
+```
+
+### Custom URL
+```ruby
+require "dexa-ai-sdk"
+
+client = DexaAiSdk::Client.new(
+    base_url: "https://example.com"
+)
+```
+
+## Errors
+
+Failed API calls will raise errors that can be rescued from granularly.
+
+```ruby
+require "dexa-ai-sdk"
+
+client = DexaAiSdk::Client.new(
+    base_url: "https://example.com"
+)
+
+begin
+    result = client.tasks.run_tasks
+rescue DexaAiSdk::Errors::TimeoutError
+    puts "API didn't respond before our timeout elapsed"
+rescue DexaAiSdk::Errors::ConnectionError => e
+    puts "Could not reach the API (connection refused, reset, DNS or TLS failure): #{e.message}"
+rescue DexaAiSdk::Errors::ServiceUnavailableError
+    puts "API returned status 503, is probably overloaded, try again later"
+rescue DexaAiSdk::Errors::ServerError
+    puts "API returned some other 5xx status, this is probably a bug"
+rescue DexaAiSdk::Errors::ResponseError => e
+    puts "API returned an unexpected status other than 5xx: #{e.code} #{e.message}"
+rescue DexaAiSdk::Errors::ApiError => e
+    puts "Some other error occurred when calling the API: #{e.message}"
+end
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries. A request will be retried as long as the request is deemed
+retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) (Internal Server Error)
+
+The `retryStatusCodes` configuration controls which [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status#server_error_responses) status codes are retried:
+
+- `legacy` (default): Retries `408`, `429`, `500`, `502`, `503`, `504`, `521`, `522`, `524`
+- `recommended`: Retries `408`, `429`, `502`, `503`, `504` only (excludes `500 Internal Server Error` to avoid retrying non-idempotent failures)
+
+Use the `max_retries` option to configure this behavior.
+
+```ruby
+require "dexa-ai-sdk"
+
+client = DexaAiSdk::Client.new(
+    base_url: "https://example.com",
+    max_retries: 3  # Configure max retries (default is 2)
+)
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. Use the `timeout` option to configure this behavior.
+
+```ruby
+require "dexa-ai-sdk"
+
+# Set the default timeout (in seconds) for every request made by the client.
+client = DexaAiSdk::Client.new(
+    base_url: "https://example.com",
+    timeout: 30
+)
+
+# Override the timeout for an individual request.
+response = client.tasks.run_tasks(
+    ...,
+    request_options: { timeout_in_seconds: 10 }
+)
+```
+
+### Additional Headers
+
+If you would like to send additional headers as part of the request, use the `additional_headers` request option.
+
+```ruby
+require "dexa-ai-sdk"
+
+response = client.tasks.run_tasks(
+    ...,
+    request_options: {
+        additional_headers: {
+            "X-Custom-Header" => "custom-value"
+        }
+    }
+)
+```
+
+### Additional Query Parameters
+
+If you would like to send additional query parameters as part of the request, use the `additional_query_parameters` request option.
+
+```ruby
+require "dexa-ai-sdk"
+
+response = client.tasks.run_tasks(
+    ...,
+    request_options: {
+        additional_query_parameters: {
+            "custom_param" => "custom-value"
+        }
+    }
+)
+```
+
+### Additional Body Properties
+
+If you would like to send additional body properties as part of the request, use the `additional_body_parameters` request option.
+Properties are merged into the serialized request body using their API (wire-format) names and override any field the SDK sets with the same name. If the endpoint has no body, one is created from these properties, except for GET and HEAD requests, which are always sent without a body (the properties are ignored).
+This applies to JSON and form-urlencoded requests; it is not applied to multipart (file upload) requests.
+
+```ruby
+require "dexa-ai-sdk"
+
+response = client.tasks.run_tasks(
+    ...,
+    request_options: {
+        additional_body_parameters: {
+            "custom_field" => "custom-value"
+        }
+    }
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test]
+
+task lint: %i[rubocop]
+
+# Run only the custom test file
+Minitest::TestTask.create(:customtest) do |t|
+  t.libs << "test"
+  t.test_globs = ["test/custom.test.rb"]
+end

data/custom.gemspec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Custom gemspec configuration, loaded by the generated gemspec through the 'spec'
+# variable. Kept out of regeneration with .fernignore so these values survive.
+#
+# Fern has no API name to work from here, so the generated symbols are rewritten to
+# dexa-ai-sdk after generation. Set the published identity here.
+
+def add_custom_gemspec_data(spec)
+  spec.name = "dexa-ai-sdk"
+  spec.authors = ["Durga Sai"]
+  spec.email = ["dexa-ai-sdk.20.12.24@kgpian.iitkgp.ac.in"]
+  spec.homepage = "https://github.com/dsainvg/decide-extract-sdk"
+  spec.license = "Apache-2.0"
+  spec.summary = "Dexa is the Ruby client for the Decide + Extract API"
+  spec.description = "Dexa runs decide and extract tasks against one context in a single request, from Ruby."
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "#{spec.homepage}#readme"
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+end

data/lib/dexa-ai-sdk/client.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  class Client
+    # @param base_url [String, nil]
+    # @param max_retries [Integer]
+    # @param timeout [Numeric]
+    #
+    # @return [void]
+    def initialize(base_url: nil, max_retries: 2, timeout: 60)
+      @raw_client = DexaAiSdk::Internal::Http::RawClient.new(
+        base_url: base_url || DexaAiSdk::Environment::DEFAULT,
+        headers: {
+          "X-Fern-Language" => "Ruby"
+        },
+        max_retries: max_retries,
+        timeout: timeout
+      )
+    end
+
+    # @return [DexaAiSdk::Tasks::Client]
+    def tasks
+      @tasks ||= DexaAiSdk::Tasks::Client.new(client: @raw_client)
+    end
+  end
+end

data/lib/dexa-ai-sdk/environment.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  class Environment
+    DEFAULT = "http://localhost:8080"
+  end
+end

data/lib/dexa-ai-sdk/errors/api_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    class ApiError < StandardError
+    end
+  end
+end

data/lib/dexa-ai-sdk/errors/client_error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    class ClientError < ResponseError
+    end
+
+    class UnauthorizedError < ClientError
+    end
+
+    class ForbiddenError < ClientError
+    end
+
+    class NotFoundError < ClientError
+    end
+  end
+end

data/lib/dexa-ai-sdk/errors/connection_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    # Raised when the request fails before a response is received: the connection is refused,
+    # reset or closed early, the host name cannot be resolved, or the TLS handshake fails.
+    # The original exception is available as `cause`.
+    class ConnectionError < ApiError
+    end
+  end
+end

data/lib/dexa-ai-sdk/errors/redirect_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    class RedirectError < ResponseError
+    end
+  end
+end

data/lib/dexa-ai-sdk/errors/response_error.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    class ResponseError < ApiError
+      attr_reader :code, :body
+
+      # @param msg [String] The raw response body.
+      # @param code [Integer] The HTTP status code.
+      # @param body [Object, nil] The response body parsed into the endpoint's declared error type, if any.
+      def initialize(msg, code:, body: nil)
+        @code = code
+        @body = body
+        super(msg)
+      end
+
+      def inspect
+        "#<#{self.class.name} @code=#{code} @body=#{message}>"
+      end
+
+      # Parses a raw error response body into the type declared for its status code.
+      #
+      # @param code [Integer]
+      # @param raw_body [String, nil]
+      # @param types [Hash{Integer, Range => Class}] Matchers in priority order.
+      # @return [Object, nil] nil when no type matches or the body cannot be parsed.
+      def self.load_error_body(code, raw_body, types)
+        type = types.find { |matcher, _| matcher.is_a?(::Range) ? matcher.cover?(code) : matcher == code }&.last
+        return nil if type.nil? || raw_body.to_s.empty?
+
+        begin
+          type.load(raw_body)
+        rescue StandardError
+          nil
+        end
+      end
+
+      # Returns the most appropriate error class for the given code.
+      #
+      # @return [Class]
+      def self.subclass_for_code(code)
+        case code
+        when 300..399
+          RedirectError
+        when 401
+          UnauthorizedError
+        when 403
+          ForbiddenError
+        when 404
+          NotFoundError
+        when 400..499
+          ClientError
+        when 503
+          ServiceUnavailableError
+        when 500..599
+          ServerError
+        else
+          ResponseError
+        end
+      end
+    end
+  end
+end

data/lib/dexa-ai-sdk/errors/server_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    class ServerError < ResponseError
+    end
+
+    class ServiceUnavailableError < ResponseError
+    end
+  end
+end

data/lib/dexa-ai-sdk/errors/timeout_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Errors
+    class TimeoutError < ApiError
+    end
+  end
+end

data/lib/dexa-ai-sdk/internal/errors/constraint_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Internal
+    module Errors
+      class ConstraintError < StandardError
+      end
+    end
+  end
+end

data/lib/dexa-ai-sdk/internal/errors/type_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DexaAiSdk
+  module Internal
+    module Errors
+      class TypeError < StandardError
+      end
+    end
+  end
+end