optify-config 1.23.2-x86_64-linux → 1.24.0-x86_64-linux

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01c13ea944b1ee5447d544d0e0cb0fa2aa19bc1ce82ce570ba42b63b2c1bd28f
-  data.tar.gz: a02b00058b905e704f09ea02a5605798abc360748f254419671d1b3490030adf
+  metadata.gz: cec6e5e2929932aba37bb40ac6c4e209c4ae96379992574aaa952f08aeb2f8ec
+  data.tar.gz: 400466a499ed12ed8bfd529c026e63b53c5584543069589bcf4fbd607ae766bf
 SHA512:
-  metadata.gz: dd9d51dcf6419b827527886af0219364c90d231ff3c6973a50591622afc8ea56f0f30bb4d1594fd64a262ee14cf4cd5ed15c2a0115f8dfca3f66c0ae6948c8cb
-  data.tar.gz: 6aeed3628b069e22e07cb03bfee939b2bf393e69458bb91bee625547d01a11f4c0b557689d0e784a4d9fa9d43bb1dc85caf1d342de76c8d5e45fd0bc37de59de
+  metadata.gz: 1aee5fe5d95b34ede6d4f997497743d988211c503261897ca9f802c1657eab7b88d280514509053e8a39eda6988df530ebade304a12a5156b04667b5bd95bbbf
+  data.tar.gz: 70eb893fcd34bf565de02d3d8cb36aa86da3b9c0c4c1894a32ded55a8b5898eb901cbe9e04bd1aaf5acba87bf7b6023ba595bac95ad9805962dd7c2bd8d04b81

data/lib/optify_ruby/policies.rb

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+
+require 'optify-from_hash'
+
+module Optify
+  # The policy for the requester identifier passed via preferences.
+  #
+  # Either `allow` or `block` will be set, not both.
+  # - `allow`: only the listed requesters may use the feature; can be empty.
+  # - `block`: the listed requesters may not use the feature; all others are allowed.
+  class RequesterPolicy < FromHashable
+    extend T::Sig
+
+    sig { returns(T.nilable(T::Set[String])) }
+    attr_reader :allow
+
+    sig { returns(T.nilable(T::Set[String])) }
+    attr_reader :block
+  end
+
+  # Policies that restrict access to a feature based on values in the request's preferences.
+  #
+  # See https://github.com/juharris/optify#policies for details.
+  class Policies < FromHashable
+    extend T::Sig
+
+    sig { returns(T.nilable(RequesterPolicy)) }
+    attr_reader :requester
+  end
+end

data/lib/optify_ruby/provider_module.rb

@@ -5,9 +5,27 @@ require 'json'
 require 'lru_redux'
 require 'sorbet-runtime'
 
+require_relative './policies'
+
 module Optify
   # @!visibility private
-  module ProviderModule
+  module ProviderModule # rubocop:disable Metrics/ModuleLength
+    #: (String, Array[String], ?CacheOptions?) -> void
+    def check_policies(requester, feature_names, cache_options = nil)
+      if cache_options
+        init unless @cache
+        ProviderModule._cache_getset(
+          @cache, #: as !nil
+          [:check_policies, feature_names, requester],
+          cache_options.on_cache_event,
+        ) do
+          _check_policies(requester, feature_names)
+        end
+      else
+        _check_policies(requester, feature_names)
+      end
+    end
+
     #: [T] (LruRedux::Cache | Hash[Array[untyped], T], Array[untyped], (^(Array[untyped] key, T value, bool is_cache_hit) -> void)?) { -> T } -> T
     def self._cache_getset(cache, cache_key, on_cache_event, &block)
       is_cache_hit = true #: bool
@@ -69,6 +87,14 @@ module Optify
       OptionsMetadata.from_hash(JSON.parse(metadata_json))
     end
 
+    #: (String canonical_feature_name) -> Optify::Policies?
+    def get_policies(canonical_feature_name)
+      policies_json = get_policies_json(canonical_feature_name)
+      return nil if policies_json.nil?
+
+      Policies.from_hash(JSON.parse(policies_json))
+    end
+
     private
 
     #: -> Hash[String, OptionsMetadata]

data/rbi/optify.rbi

@@ -7,6 +7,31 @@ module Optify
   class UnknownFeatureError < StandardError
   end
 
+  # The policy for the requester identifier passed via preferences.
+  #
+  # Either `allow` or `block` will be set, not both.
+  # - `allow`: only the listed requesters may use the feature; can be empty.
+  # - `block`: the listed requesters may not use the feature; all others are allowed.
+  class RequesterPolicy < FromHashable
+    sig { returns(T.nilable(T::Set[String])) }
+    attr_reader :allow
+
+    sig { returns(T.nilable(T::Set[String])) }
+    attr_reader :block
+  end
+
+  # Policies that restrict access to a feature based on values in the request's preferences.
+  #
+  # See https://github.com/juharris/optify#policies for details.
+  class Policies < FromHashable
+    sig { returns(T.nilable(RequesterPolicy)) }
+    attr_reader :requester
+  end
+
+  # Raised when a requester is not permitted to use a feature due to its policies.
+  class PolicyDeniedError < StandardError
+  end
+
   # DEPRECATED: Use `Optify::FromHashable` instead.
   # A base class for classes from configuration files.
   # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
@@ -162,6 +187,22 @@ module Optify
 
     sig { returns(T::Boolean) }
     def skip_feature_name_conversion; end
+
+    # The requester identifier to use for policy enforcement.
+    # If not set, policy checks are bypassed.
+    sig { params(value: T.nilable(String)).void }
+    def requester=(value); end
+
+    sig { returns(T.nilable(String)) }
+    def requester; end
+
+    # When `true`, raises `PolicyDeniedError` if a feature is not permitted for the requester.
+    # When `false` (default), denied features are silently filtered out.
+    sig { params(value: T::Boolean).void }
+    def raise_if_policy_denied=(value); end
+
+    sig { returns(T::Boolean) }
+    def raise_if_policy_denied; end
   end
 
   # A registry of features that provides configurations.
@@ -233,6 +274,19 @@ module Optify
   # Some of the methods shown within this module are implemented in Rust
   # and are declared in this common module to avoid duplicate declarations in different classes.
   module ProviderModule
+    # Checks policies for a list of features for the given requester.
+    # Returns `nil` if there are no policy issues (or no policies defined).
+    # Raises `Optify::PolicyDeniedError` if any of the features are not allowed for the requester.
+    sig do
+      params(
+        requester: String,
+        feature_names: T::Array[String],
+        cache_options: T.nilable(CacheOptions),
+      )
+        .returns(T.nilable(String))
+    end
+    def check_policies(requester, feature_names, cache_options = nil); end
+
     # @param canonical_feature_name [String] A canonical feature name
     # @return Whether the feature has conditions.
     sig { params(canonical_feature_name: String).returns(T::Boolean) }
@@ -358,8 +412,22 @@ module Optify
     end
     def map_feature_names(feature_names, preferences); end
 
+    # @return The policies for the feature, or `nil` if the feature has no policies.
+    sig { params(canonical_feature_name: String).returns(T.nilable(Optify::Policies)) }
+    def get_policies(canonical_feature_name); end
+
     private
 
+    # Rust implementation.
+    sig do
+      params(
+        requester: String,
+        feature_names: T::Array[String],
+      )
+        .returns(T.nilable(String))
+    end
+    def _check_policies(requester, feature_names); end
+
     # Map aliases or canonical feature names (perhaps derived from a file names) to the canonical feature names.
     # Canonical feature names map to themselves.
     # This implementation calls the Rust implementation directly.
@@ -372,6 +440,10 @@ module Optify
     # @return The metadata for the feature.
     sig { params(canonical_feature_name: String).returns(T.nilable(String)) }
     def get_feature_metadata_json(canonical_feature_name); end
+
+    # @return The policies for the feature as JSON, or `nil` if the feature has no policies.
+    sig { params(canonical_feature_name: String).returns(T.nilable(String)) }
+    def get_policies_json(canonical_feature_name); end
   end
 
   # Provides configurations based on keys and enabled feature names.

data/sig/optify.rbs

@@ -6,6 +6,24 @@ end
 class Optify::UnknownFeatureError < StandardError
 end
 
+# The policy for the requester identifier passed via preferences.
+#
+# Either `allow` or `block` will be set, not both.
+# - `allow`: only the listed requesters may use the feature; can be empty.
+# - `block`: the listed requesters may not use the feature; all others are allowed.
+class Optify::RequesterPolicy < FromHashable
+end
+
+# Policies that restrict access to a feature based on values in the request's preferences.
+#
+# See https://github.com/juharris/optify#policies for details.
+class Optify::Policies < FromHashable
+end
+
+# Raised when a requester is not permitted to use a feature due to its policies.
+class Optify::PolicyDeniedError < StandardError
+end
+
 # DEPRECATED: Use `Optify::FromHashable` instead.
 # A base class for classes from configuration files.
 # Classes that derive from this can easily be used with `Optify::OptionsProvider.get_options`
@@ -18,7 +36,10 @@ end
 
 # Options for caching.
 class Optify::CacheOptions
-  def initialize: () -> (^(::Array[untyped] key, untyped value, bool is_cache_hit) -> void)?
+  def initialize: () -> ::Set[String]?
+                | () -> ::Set[String]?
+                | () -> RequesterPolicy?
+                | () -> (^(::Array[untyped] key, untyped value, bool is_cache_hit) -> void)?
                 | (?on_cache_event: (^(::Array[untyped] key, untyped value, bool is_cache_hit) -> void)? on_cache_event) -> void
 end
 
@@ -100,6 +121,18 @@ class Optify::GetOptionsPreferences
   def skip_feature_name_conversion=: (bool value) -> void
 
   def skip_feature_name_conversion: () -> bool
+
+  # The requester identifier to use for policy enforcement.
+  # If not set, policy checks are bypassed.
+  def requester=: (String? value) -> void
+
+  def requester: () -> String?
+
+  # When `true`, raises `PolicyDeniedError` if a feature is not permitted for the requester.
+  # When `false` (default), denied features are silently filtered out.
+  def raise_if_policy_denied=: (bool value) -> void
+
+  def raise_if_policy_denied: () -> bool
 end
 
 # A registry of features that provides configurations.
@@ -149,6 +182,8 @@ end
 # Some of the methods shown within this module are implemented in Rust
 # and are declared in this common module to avoid duplicate declarations in different classes.
 module Optify::ProviderModule
+  def check_policies: (String requester, ::Array[String] feature_names, ?CacheOptions? cache_options) -> String?
+
   # @param canonical_feature_name [String] A canonical feature name
   # @return Whether the feature has conditions.
   def conditions?: (String canonical_feature_name) -> bool
@@ -200,6 +235,11 @@ module Optify::ProviderModule
 
   def map_feature_names: (::Array[String] feature_names, GetOptionsPreferences preferences) -> ::Array[String?]
 
+  # @return The policies for the feature, or `nil` if the feature has no policies.
+  def get_policies: (String canonical_feature_name) -> Optify::Policies?
+
+  def _check_policies: (String requester, ::Array[String] feature_names) -> String?
+
   # Map aliases or canonical feature names (perhaps derived from a file names) to the canonical feature names.
   # Canonical feature names map to themselves.
   # This implementation calls the Rust implementation directly.
@@ -210,6 +250,9 @@ module Optify::ProviderModule
 
   # @return The metadata for the feature.
   def get_feature_metadata_json: (String canonical_feature_name) -> String?
+
+  # @return The policies for the feature as JSON, or `nil` if the feature has no policies.
+  def get_policies_json: (String canonical_feature_name) -> String?
 end
 
 # Provides configurations based on keys and enabled feature names.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 1.23.2
+  version: 1.24.0
 platform: x86_64-linux
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2026-08-05 00:00:00.000000000 Z
+date: 2026-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: optify-from_hash
@@ -179,6 +179,7 @@ files:
 - lib/optify_ruby/get_options_preferences.rb
 - lib/optify_ruby/implementation.rb
 - lib/optify_ruby/options_metadata.rb
+- lib/optify_ruby/policies.rb
 - lib/optify_ruby/provider_module.rb
 - lib/optify_ruby/watcher_implementation.rb
 - rbi/optify.rbi