flagkit 1.0.1

data/lib/flagkit.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require_relative "flagkit/version"
+
+# Error module (must be loaded first as other modules depend on it)
+require_relative "flagkit/error/error_code"
+require_relative "flagkit/error/error_sanitizer"
+require_relative "flagkit/error/flagkit_error"
+
+# Utils module
+require_relative "flagkit/utils/security"
+require_relative "flagkit/utils/version"
+
+# Types module
+require_relative "flagkit/types/flag_type"
+require_relative "flagkit/types/evaluation_reason"
+require_relative "flagkit/types/flag_state"
+require_relative "flagkit/types/evaluation_context"
+require_relative "flagkit/types/evaluation_result"
+
+# HTTP module
+require_relative "flagkit/http/circuit_breaker"
+require_relative "flagkit/http/http_client"
+
+# Core module
+require_relative "flagkit/core/cache"
+require_relative "flagkit/core/encrypted_cache"
+require_relative "flagkit/core/polling_manager"
+require_relative "flagkit/core/event_persistence"
+require_relative "flagkit/core/event_queue"
+
+# Main components
+require_relative "flagkit/options"
+require_relative "flagkit/client"
+
+# FlagKit Ruby SDK
+#
+# @example Basic usage
+#   client = FlagKit.initialize("sdk_your_api_key")
+#   enabled = FlagKit.get_boolean_value("my-feature", false)
+#   FlagKit.shutdown
+#
+module FlagKit
+  class << self
+    # @return [Client, nil] The singleton client instance
+    attr_reader :instance
+
+    # Initializes the FlagKit SDK with the given API key.
+    #
+    # @param api_key [String] The API key for authentication
+    # @param options [Hash] Additional configuration options
+    # @return [Client] The initialized client
+    # @raise [Error] If initialization fails or SDK is already initialized
+    def initialize(api_key, **options)
+      raise Error.new(ErrorCode::INIT_ALREADY_INITIALIZED, "FlagKit is already initialized") if @instance
+
+      opts = Options.new(api_key: api_key, **options)
+      opts.validate!
+
+      @instance = Client.new(opts)
+      @instance.initialize_sdk
+      @instance
+    end
+
+    # Returns the singleton client instance.
+    #
+    # @return [Client, nil] The client instance, or nil if not initialized
+    def client
+      @instance
+    end
+
+    # Checks if the SDK has been initialized.
+    #
+    # @return [Boolean]
+    def initialized?
+      !@instance.nil?
+    end
+
+    # Shuts down the SDK and releases resources.
+    def shutdown
+      return unless @instance
+
+      @instance.close
+      @instance = nil
+    end
+
+    # Evaluates a boolean flag.
+    #
+    # @param key [String] The flag key
+    # @param default_value [Boolean] Default value if flag not found
+    # @param context [EvaluationContext, nil] Optional evaluation context
+    # @return [Boolean]
+    def get_boolean_value(key, default_value, context: nil)
+      require_client.get_boolean_value(key, default_value, context: context)
+    end
+
+    # Evaluates a string flag.
+    #
+    # @param key [String] The flag key
+    # @param default_value [String] Default value if flag not found
+    # @param context [EvaluationContext, nil] Optional evaluation context
+    # @return [String]
+    def get_string_value(key, default_value, context: nil)
+      require_client.get_string_value(key, default_value, context: context)
+    end
+
+    # Evaluates a number flag.
+    #
+    # @param key [String] The flag key
+    # @param default_value [Numeric] Default value if flag not found
+    # @param context [EvaluationContext, nil] Optional evaluation context
+    # @return [Numeric]
+    def get_number_value(key, default_value, context: nil)
+      require_client.get_number_value(key, default_value, context: context)
+    end
+
+    # Evaluates a JSON flag.
+    #
+    # @param key [String] The flag key
+    # @param default_value [Hash] Default value if flag not found
+    # @param context [EvaluationContext, nil] Optional evaluation context
+    # @return [Hash]
+    def get_json_value(key, default_value, context: nil)
+      require_client.get_json_value(key, default_value, context: context)
+    end
+
+    # Evaluates a flag and returns the full result.
+    #
+    # @param key [String] The flag key
+    # @param default_value [Object] Default value if flag not found
+    # @param context [EvaluationContext, nil] Optional evaluation context
+    # @return [EvaluationResult]
+    def evaluate(key, default_value = nil, context: nil)
+      require_client.evaluate(key, default_value, context: context)
+    end
+
+    # Identifies a user.
+    #
+    # @param user_id [String] The user ID
+    # @param attributes [Hash] Optional user attributes
+    def identify(user_id, **attributes)
+      require_client.identify(user_id, **attributes)
+    end
+
+    # Resets to anonymous user.
+    def reset_context
+      require_client.reset_context
+    end
+
+    # Tracks a custom event.
+    #
+    # @param event_type [String] The event type
+    # @param data [Hash, nil] Optional event data
+    def track(event_type, data = nil)
+      require_client.track(event_type, data)
+    end
+
+    private
+
+    def require_client
+      raise "FlagKit is not initialized. Call FlagKit.initialize first." unless @instance
+
+      @instance
+    end
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: flagkit
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- FlagKit
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+description: FlagKit Ruby SDK enables feature flag evaluation with local caching,
+  background polling, and analytics tracking.
+email:
+- support@flagkit.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/flagkit.rb
+- lib/flagkit/client.rb
+- lib/flagkit/core/cache.rb
+- lib/flagkit/core/encrypted_cache.rb
+- lib/flagkit/core/event_persistence.rb
+- lib/flagkit/core/event_queue.rb
+- lib/flagkit/core/polling_manager.rb
+- lib/flagkit/core/streaming_manager.rb
+- lib/flagkit/error/error_code.rb
+- lib/flagkit/error/error_sanitizer.rb
+- lib/flagkit/error/flagkit_error.rb
+- lib/flagkit/http/circuit_breaker.rb
+- lib/flagkit/http/http_client.rb
+- lib/flagkit/options.rb
+- lib/flagkit/types/evaluation_context.rb
+- lib/flagkit/types/evaluation_reason.rb
+- lib/flagkit/types/evaluation_result.rb
+- lib/flagkit/types/flag_state.rb
+- lib/flagkit/types/flag_type.rb
+- lib/flagkit/utils/security.rb
+- lib/flagkit/utils/version.rb
+- lib/flagkit/version.rb
+homepage: https://github.com/teracrafts/flagkit-sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/teracrafts/flagkit-sdk
+  source_code_uri: https://github.com/teracrafts/flagkit-sdk
+  changelog_uri: https://github.com/teracrafts/flagkit-sdk/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Official Ruby SDK for FlagKit feature flag management
+test_files: []