toggly-cache 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 98811a45f8402f5bf321cd854cf39856d9bce478e946033c968c126c5abd7814
+  data.tar.gz: f9b84d051d6c332eee50b463cdbe481e67cd0af34363aa8f50b53c6974cea2c0
+SHA512:
+  metadata.gz: 7fa421237fd34448a03c1a9eef6f4c5e55bae773b2879242b753d4a8c3ec7c28ef0c362ce0196706bdc78a2c66f179ad928bbe56e55f61e6adb457b07e13ddb5
+  data.tar.gz: a1f5be53e00f43efdeb7f0a49a33e10e673d64f8a12b07886b2ea88a066779f134c1b0432d4750138e9bd1c22c8a178ebf163d9f038a729c0e091130073aedcb

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-XX-XX
+
+### Added
+
+- Initial release of Toggly Ruby SDK
+- `toggly` - Core SDK with zero dependencies
+  - Client for feature flag evaluation
+  - Context for user identity, groups, and traits
+  - Evaluation engine with multiple rule types
+  - Percentage rollouts with consistent hashing
+  - User and group targeting
+  - Contextual targeting with operators
+  - Time window rules
+  - Memory and file snapshot providers
+  - Background refresh support
+  - Offline mode with defaults
+
+- `toggly-rails` - Rails integration
+  - Railtie for auto-configuration
+  - Controller concern with `feature_enabled?` helper
+  - View helpers (`when_feature_enabled`, `feature_switch`)
+  - Rack middleware for request context
+  - Context builder from current_user
+  - Rails.cache snapshot provider
+  - Generator for initializer
+  - Rake tasks (list, check, refresh, config)
+  - RSpec and Minitest helpers
+
+- `toggly-cache` - Redis caching support
+  - Redis snapshot provider
+  - Connection pool support
+  - TTL configuration
+  - Touch/extend TTL support

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ops.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,33 @@
+# toggly-cache
+
+Redis caching support for [Toggly](https://toggly.io) feature flag management.
+
+## Installation
+
+```ruby
+gem 'toggly-cache'
+```
+
+## Quick Start
+
+```ruby
+require 'toggly'
+require 'toggly-cache'
+require 'redis'
+
+redis = Redis.new(url: ENV['REDIS_URL'])
+provider = Toggly::Cache::RedisSnapshotProvider.new(redis: redis)
+
+client = Toggly::Client.new(
+  app_key: 'your-app-key',
+  snapshot_provider: provider
+)
+```
+
+## Documentation
+
+See the [main README](../README.md) for full documentation.
+
+## License
+
+MIT

data/lib/toggly/cache/redis_snapshot_provider.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Toggly
+  module Cache
+    # Redis-based snapshot provider for Toggly.
+    #
+    # Stores feature definitions in Redis for persistence and sharing
+    # across multiple processes or servers.
+    #
+    # @example Basic usage
+    #   redis = Redis.new(url: "redis://localhost:6379")
+    #   provider = Toggly::Cache::RedisSnapshotProvider.new(redis: redis)
+    #
+    # @example With connection pool
+    #   pool = ConnectionPool.new(size: 5) { Redis.new }
+    #   provider = Toggly::Cache::RedisSnapshotProvider.new(redis: pool)
+    #
+    # @example With TTL
+    #   provider = Toggly::Cache::RedisSnapshotProvider.new(
+    #     redis: redis,
+    #     ttl: 3600,  # 1 hour
+    #     key_prefix: "myapp:toggly"
+    #   )
+    class RedisSnapshotProvider < Toggly::SnapshotProviders::Base
+      # @return [String] Key prefix for Redis keys
+      attr_reader :key_prefix
+
+      # @return [Integer, nil] TTL in seconds (nil = no expiration)
+      attr_reader :ttl
+
+      # Create a new Redis snapshot provider
+      #
+      # @param redis [Redis, ConnectionPool] Redis client or connection pool
+      # @param key_prefix [String] Prefix for Redis keys
+      # @param ttl [Integer, nil] TTL in seconds (nil = no expiration)
+      def initialize(redis:, key_prefix: "toggly", ttl: nil)
+        super()
+        @redis = redis
+        @key_prefix = key_prefix
+        @ttl = ttl
+      end
+
+      # Save definitions to Redis
+      #
+      # @param definitions [Hash<String, FeatureDefinition>] Definitions to save
+      # @param metadata [Hash] Optional metadata
+      def save(definitions, metadata = {})
+        data = {
+          "definitions" => serialize_definitions(definitions),
+          "metadata" => metadata.merge("saved_at" => Time.now.utc.iso8601)
+        }
+
+        json = JSON.generate(data)
+
+        with_redis do |redis|
+          if @ttl
+            redis.setex(snapshot_key, @ttl, json)
+          else
+            redis.set(snapshot_key, json)
+          end
+        end
+      rescue StandardError => e
+        raise Toggly::SnapshotError, "Failed to save snapshot to Redis: #{e.message}"
+      end
+
+      # Load definitions from Redis
+      #
+      # @return [Hash, nil] Hash with :definitions and :metadata, or nil if not found
+      def load
+        json = with_redis { |redis| redis.get(snapshot_key) }
+        return nil unless json
+
+        data = JSON.parse(json)
+
+        {
+          definitions: deserialize_definitions(data["definitions"]),
+          metadata: symbolize_keys(data["metadata"] || {})
+        }
+      rescue JSON::ParserError => e
+        raise Toggly::SnapshotError, "Failed to parse Redis snapshot: #{e.message}"
+      rescue StandardError => e
+        raise Toggly::SnapshotError, "Failed to load snapshot from Redis: #{e.message}"
+      end
+
+      # Clear the snapshot from Redis
+      def clear
+        with_redis { |redis| redis.del(snapshot_key) }
+      rescue StandardError => e
+        raise Toggly::SnapshotError, "Failed to clear Redis snapshot: #{e.message}"
+      end
+
+      # Check if snapshot exists in Redis
+      #
+      # @return [Boolean]
+      def exists?
+        result = with_redis { |redis| redis.exists?(snapshot_key) }
+        # Handle both Redis 4.x (returns Integer) and 5.x (returns Boolean)
+        result.is_a?(Integer) ? result.positive? : result
+      rescue StandardError
+        false
+      end
+
+      # Get TTL of the snapshot
+      #
+      # @return [Integer, nil] Remaining TTL in seconds, or nil if no TTL
+      def remaining_ttl
+        ttl = with_redis { |redis| redis.ttl(snapshot_key) }
+        return nil if ttl.nil? || ttl.negative?
+
+        ttl
+      rescue StandardError
+        nil
+      end
+
+      # Touch the snapshot to extend its TTL
+      #
+      # @return [Boolean] Whether the operation succeeded
+      def touch
+        return false unless @ttl
+
+        with_redis { |redis| redis.expire(snapshot_key, @ttl) }
+        true
+      rescue StandardError
+        false
+      end
+
+      private
+
+      def snapshot_key
+        "#{@key_prefix}:snapshot"
+      end
+
+      def with_redis(&block)
+        if @redis.respond_to?(:with)
+          # ConnectionPool
+          @redis.with(&block)
+        else
+          # Direct Redis client
+          yield @redis
+        end
+      end
+
+      def symbolize_keys(hash)
+        return {} unless hash.is_a?(Hash)
+
+        hash.transform_keys(&:to_sym)
+      end
+    end
+  end
+end

data/lib/toggly/cache/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Toggly
+  module Cache
+    VERSION = "0.1.0"
+  end
+end

data/lib/toggly-cache.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "toggly"
+require_relative "toggly/cache/version"
+require_relative "toggly/cache/redis_snapshot_provider"
+
+module Toggly
+  # Redis caching module for Toggly.
+  #
+  # Provides a Redis-based snapshot provider for storing and sharing
+  # feature definitions across processes and servers.
+  #
+  # @example Basic usage
+  #   redis = Redis.new(url: ENV["REDIS_URL"])
+  #   provider = Toggly::Cache::RedisSnapshotProvider.new(redis: redis)
+  #
+  #   client = Toggly::Client.new(
+  #     app_key: "your-app-key",
+  #     snapshot_provider: provider
+  #   )
+  #
+  # @example With connection pool
+  #   require "connection_pool"
+  #
+  #   pool = ConnectionPool.new(size: 5) { Redis.new(url: ENV["REDIS_URL"]) }
+  #   provider = Toggly::Cache::RedisSnapshotProvider.new(redis: pool)
+  #
+  # @example With Rails
+  #   # config/initializers/toggly.rb
+  #   Toggly::Rails.configure do |config|
+  #     config.app_key = Rails.application.credentials.toggly_app_key
+  #     config.snapshot_provider = Toggly::Cache::RedisSnapshotProvider.new(
+  #       redis: Redis.new(url: ENV["REDIS_URL"]),
+  #       key_prefix: "myapp:toggly"
+  #     )
+  #   end
+  module Cache
+    class << self
+      # Create a Redis snapshot provider with sensible defaults
+      #
+      # @param redis [Redis, ConnectionPool] Redis client or connection pool
+      # @param options [Hash] Additional options
+      # @return [RedisSnapshotProvider]
+      def redis_provider(redis:, **options)
+        RedisSnapshotProvider.new(redis: redis, **options)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: toggly-cache
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ops.ai
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: toggly
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Redis-based snapshot provider for Toggly feature flags. Enables persistent
+  caching and sharing of feature definitions across processes.
+email:
+- support@ops.ai
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/toggly-cache.rb
+- lib/toggly/cache/redis_snapshot_provider.rb
+- lib/toggly/cache/version.rb
+homepage: https://toggly.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://toggly.io
+  source_code_uri: https://github.com/ops-ai/toggly-ruby
+  changelog_uri: https://github.com/ops-ai/toggly-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://docs.toggly.io/sdks/ruby
+  rubygems_mfa_required: 'true'
+post_install_message:
+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: 3.5.22
+signing_key:
+specification_version: 4
+summary: Redis caching support for Toggly feature flags
+test_files: []