togglr-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 542035bde9fcea69f8665c1fff0487e77d49c0961e5d51abf5c93f653217f997
+  data.tar.gz: e0ee9e0f7f72759fab507139d0b94e6468aceb439ea1dd38e45a624dcdf4aa06
+SHA512:
+  metadata.gz: 8ac966a7faf9911269391ce637ecf880eaf28b348279ef1cb18a915be482c4ca338a7971e8603af1521f951cbadb72cf760b2d38c113f8d7f7c51eaa0fdd7bdd
+  data.tar.gz: 1bf501fa269bc33ca8a60fb8d1599a14083ef55e271377814616c8d55377daab54f387a1588a48347b3950dacddb029db4c985f56e76262b79e28cb771b65083

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 3.12'
+  gem 'rubocop', '~> 1.57'
+  gem 'rubocop-rspec', '~> 2.25'
+  gem 'simplecov', '~> 0.22'
+end
+
+group :development do
+  gem 'rake', '~> 13.0'
+  gem 'yard', '~> 0.9'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Togglr
+
+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,297 @@
+# Togglr Ruby SDK
+
+Ruby SDK for working with Togglr - feature flag management system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'togglr-sdk'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install togglr-sdk
+```
+
+## Quick Start
+
+```ruby
+require 'togglr'
+
+# Create client with default configuration
+client = Togglr::Client.new_with_defaults('your-api-key-here') do |config|
+  config.base_url = 'http://localhost:8090'
+  config.timeout = 1.0
+  config.cache_enabled = true
+  config.cache_size = 1000
+  config.cache_ttl = 10
+end
+
+# Create request context
+context = Togglr::RequestContext.new
+  .with_user_id('user123')
+  .with_country('US')
+  .with_device_type('mobile')
+
+# Evaluate feature flag
+value, enabled, found = client.evaluate('new_ui', context)
+
+if found
+  puts "Feature enabled: #{enabled}, value: #{value}"
+end
+
+client.close
+```
+
+## Configuration
+
+### Creating a client
+
+```ruby
+# With default settings
+client = Togglr::Client.new_with_defaults('api-key')
+
+# With custom configuration
+config = Togglr::Config.default('api-key')
+config.base_url = 'https://api.togglr.com'
+config.timeout = 2.0
+config.retries = 3
+
+client = Togglr::Client.new(config)
+```
+
+### Configuration options
+
+#### Using functional options (recommended)
+
+```ruby
+client = Togglr::Client.new_with_defaults('api-key',
+  Togglr::Options.with_base_url('https://api.togglr.com'),
+  Togglr::Options.with_timeout(2.0),
+  Togglr::Options.with_retries(3),
+  Togglr::Options.with_cache(1000, 10),
+  Togglr::Options.with_insecure  # Skip SSL verification for self-signed certificates
+)
+```
+
+#### Using configuration block
+
+```ruby
+client = Togglr::Client.new_with_defaults('api-key') do |config|
+  config.base_url = 'https://api.togglr.com'
+  config.timeout = 2.0
+  config.retries = 3
+  config.cache_enabled = true
+  config.cache_size = 1000
+  config.cache_ttl = 10
+  config.use_circuit_breaker = true
+  config.max_connections = 100
+  config.insecure = true  # Skip SSL verification for self-signed certificates
+end
+```
+
+## Usage
+
+### Creating request context
+
+```ruby
+context = Togglr::RequestContext.new
+  .with_user_id('user123')
+  .with_user_email('user@example.com')
+  .with_country('US')
+  .with_device_type('mobile')
+  .with_os('iOS')
+  .with_os_version('15.0')
+  .with_browser('Safari')
+  .with_language('en-US')
+```
+
+### Evaluating feature flags
+
+```ruby
+# Full evaluation
+value, enabled, found = client.evaluate('feature_key', context)
+
+# Simple enabled check
+is_enabled = client.is_enabled('feature_key', context)
+
+# With default value
+default_value = client.is_enabled_or_default('feature_key', context, false)
+```
+
+### Working with context
+
+```ruby
+# Custom attributes
+context.set('custom_key', 'custom_value')
+
+# Convert to hash
+hash = context.to_h
+```
+
+## Error Reporting and Auto-Disable
+
+The SDK supports reporting errors for features, which can trigger automatic disabling based on error rates:
+
+```ruby
+# Report an error for a feature
+client.report_error(
+  'feature_key',
+  'timeout',
+  'Service did not respond in 5s',
+  { service: 'payment-gateway', timeout_ms: 5000 }
+)
+
+puts "Error reported successfully - queued for processing"
+```
+
+### Error Types
+
+Supported error types:
+- `timeout` - Service timeout
+- `validation` - Data validation error
+- `service_unavailable` - External service unavailable
+- `rate_limit` - Rate limit exceeded
+- `network` - Network connectivity issue
+- `internal` - Internal application error
+
+### Context Data
+
+You can provide additional context with error reports:
+
+```ruby
+context = {
+  service: 'payment-gateway',
+  timeout_ms: 5000,
+  user_id: 'user123',
+  region: 'us-east-1'
+}
+
+client.report_error('feature_key', 'timeout', 'Service timeout', context)
+```
+
+## Feature Health Monitoring
+
+Monitor the health status of features:
+
+```ruby
+# Get detailed health information
+health = client.get_feature_health('feature_key')
+
+puts "Feature: #{health.feature_key}"
+puts "Enabled: #{health.enabled}"
+puts "Auto Disabled: #{health.auto_disabled}"
+puts "Error Rate: #{health.error_rate}"
+puts "Threshold: #{health.threshold}"
+puts "Last Error At: #{health.last_error_at}"
+
+# Simple health check
+is_healthy = client.is_feature_healthy('feature_key')
+puts "Feature is healthy: #{is_healthy}"
+```
+
+### FeatureHealth Model
+
+The `FeatureHealth` model provides:
+
+- `feature_key` - The feature identifier
+- `environment_key` - The environment identifier
+- `enabled` - Whether the feature is enabled
+- `auto_disabled` - Whether the feature was auto-disabled due to errors
+- `error_rate` - Current error rate (0.0 to 1.0)
+- `threshold` - Error rate threshold for auto-disable
+- `last_error_at` - Timestamp of the last error
+- `healthy?` - Boolean method to check if feature is healthy
+
+## Caching
+
+The SDK supports optional caching of evaluation results using LRU cache:
+
+```ruby
+client = Togglr::Client.new_with_defaults('api-key') do |config|
+  config.cache_enabled = true
+  config.cache_size = 1000  # number of items
+  config.cache_ttl = 10     # TTL in seconds
+end
+```
+
+## Retries
+
+The SDK automatically retries requests on temporary errors:
+
+```ruby
+client = Togglr::Client.new_with_defaults('api-key') do |config|
+  config.retries = 3
+  config.backoff.base_delay = 0.1
+  config.backoff.max_delay = 2.0
+  config.backoff.factor = 2.0
+end
+```
+
+## Logging and Metrics
+
+```ruby
+# Custom logger
+logger = Togglr::StdoutLogger.new
+client = Togglr::Client.new_with_defaults('api-key') do |config|
+  config.logger = logger
+end
+
+# Custom metrics
+metrics = Togglr::StdoutMetrics.new
+client = Togglr::Client.new_with_defaults('api-key') do |config|
+  config.metrics = metrics
+end
+```
+
+## Error Handling
+
+```ruby
+begin
+  value, enabled, found = client.evaluate('feature_key', context)
+rescue Togglr::UnauthorizedError
+  # Handle authorization error
+rescue Togglr::BadRequestError
+  # Handle bad request
+rescue Togglr::NetworkError
+  # Handle network error
+rescue => e
+  # Handle other errors
+  puts "Error: #{e.message}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bundle exec console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Testing
+
+```bash
+# Run tests
+bundle exec rspec
+
+# Run with coverage
+bundle exec rspec
+
+# Run RuboCop
+bundle exec rubocop
+
+# Run all checks
+bundle exec rake check
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rom8726/togglr-sdk-ruby.

data/generated/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/generated/README.md

@@ -0,0 +1,121 @@
+# togglr-client
+
+TogglrClient - the Ruby gem for the SDK API
+
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.15.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build togglr-client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./togglr-client-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./togglr-client-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'togglr-client', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'togglr-client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'togglr-client'
+
+# Setup authorization
+TogglrClient.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+  # Configure faraday connection
+  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
+end
+
+api_instance = TogglrClient::DefaultApi.new
+feature_key = 'feature_key_example' # String | 
+
+begin
+  #Get health status of feature (including auto-disable state)
+  result = api_instance.get_feature_health(feature_key)
+  p result
+rescue TogglrClient::ApiError => e
+  puts "Exception when calling DefaultApi->get_feature_health: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:8090*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*TogglrClient::DefaultApi* | [**get_feature_health**](docs/DefaultApi.md#get_feature_health) | **GET** /sdk/v1/features/{feature_key}/health | Get health status of feature (including auto-disable state)
+*TogglrClient::DefaultApi* | [**report_feature_error**](docs/DefaultApi.md#report_feature_error) | **POST** /sdk/v1/features/{feature_key}/report-error | Report feature execution error (for auto-disable)
+*TogglrClient::DefaultApi* | [**sdk_v1_features_feature_key_evaluate_post**](docs/DefaultApi.md#sdk_v1_features_feature_key_evaluate_post) | **POST** /sdk/v1/features/{feature_key}/evaluate | Evaluate feature for given context
+*TogglrClient::DefaultApi* | [**sdk_v1_health_get**](docs/DefaultApi.md#sdk_v1_health_get) | **GET** /sdk/v1/health | Health check for SDK server
+
+
+## Documentation for Models
+
+ - [TogglrClient::Error](docs/Error.md)
+ - [TogglrClient::ErrorBadRequest](docs/ErrorBadRequest.md)
+ - [TogglrClient::ErrorError](docs/ErrorError.md)
+ - [TogglrClient::ErrorInternalServerError](docs/ErrorInternalServerError.md)
+ - [TogglrClient::ErrorNotFound](docs/ErrorNotFound.md)
+ - [TogglrClient::ErrorPermissionDenied](docs/ErrorPermissionDenied.md)
+ - [TogglrClient::ErrorTooManyRequests](docs/ErrorTooManyRequests.md)
+ - [TogglrClient::ErrorUnauthorized](docs/ErrorUnauthorized.md)
+ - [TogglrClient::EvaluateResponse](docs/EvaluateResponse.md)
+ - [TogglrClient::FeatureErrorReport](docs/FeatureErrorReport.md)
+ - [TogglrClient::FeatureHealth](docs/FeatureHealth.md)
+ - [TogglrClient::HealthResponse](docs/HealthResponse.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### ApiKeyAuth
+
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/generated/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end