flagsmith 3.1.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 540a1b7662a35e22fd9acd04ff632ff0ac3178653aa1b154406d0b5f27420f70
-  data.tar.gz: 47a63fc9e165518bc8e7b0f946e3ebea50676771e4165ac9e383104950a54ce6
+  metadata.gz: f7e45006cc3caabc6941c7daaf58f339940cb1ea1fc3ec76be0a7897d84212fa
+  data.tar.gz: 32703828745194ea1befb791266e592e888c7fac888fd35c4cc6b6e9b6f3e204
 SHA512:
-  metadata.gz: 4f328cea0c2c2b56d0fda76244aab72a0314d590308f2ed2fbd458ebb2ba215c1feb57b02b1ac06034d6cebd19a2cecc236d496b8b929caf4083cb949e912b97
-  data.tar.gz: 5325e0fd19633dd3f91665635ebb10e0a3c88d447df1a5db8bcef3c0d492f392fa477a22ac2ad04a7b918c2493c3f80e56e69634628c5df9ae16876a1ba11103
+  metadata.gz: fa77df821acafa8ccc9d0580845573b47fe0287c1937a7f8200d08532f559d77af1c41e6862a52a0ab90fec30cc020ea63068120aa95a95da41cff2b2a48e84d
+  data.tar.gz: 25f98c085b4b8253356fbc203e5605fa6ac53930e7ac8bbe7d2be1f5ba8dc8bf0374ca9a85b57bebafb08b9e57077dcc18637fca9b9d91a758ec404398de663a

data/.rubocop.yml

@@ -4,8 +4,10 @@ Layout/HashAlignment:
   AllowMultipleStyles: true
   EnforcedColonStyle: key
 AllCops:
+  TargetRubyVersion: 3.0  # Pin to flagsmith.gemspec required_ruby_version
   NewCops: enable
   SuggestExtensions: false
   Exclude:
     - 'spec/**/*'
     - 'example/**/*'
+    - 'vendor/**/*'

data/.rubocop_todo.yml

@@ -1,29 +1,22 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2020-12-30 22:56:14 UTC using RuboCop version 1.7.0.
+# `rubocop --auto-gen-config`
+# on 2023-07-20 10:26:52 UTC using RuboCop version 1.54.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
-Metrics/BlockLength:
+# Offense count: 6
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
   Exclude:
-    - '**/*.gemspec'
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/flagsmith.rb'
+    - 'flagsmith.gemspec'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Exclude:
-    - 'flagsmith.gemspec'
+  Max: 183

data/.ruby-version

@@ -1 +1 @@
-2.4.0
+3.1.4

data/Gemfile.lock

@@ -1,84 +1,75 @@
 PATH
   remote: .
   specs:
-    flagsmith (3.1.1)
-      faraday
+    flagsmith (4.0.0)
+      faraday (>= 2.0.1)
       faraday-retry
-      faraday_middleware
       semantic
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
-    faraday_middleware (1.2.0)
-      faraday (~> 1.0)
-    gem-release (2.2.0)
+    diff-lcs (1.5.0)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    faraday-retry (2.2.0)
+      faraday (~> 2.0)
+    gem-release (2.2.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    multipart-post (2.2.3)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.4)
       ast (~> 2.4.1)
-    pry (0.14.1)
+      racc
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.7.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.60.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.3.0)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    ruby2_keywords (0.0.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
     semantic (1.6.1)
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
 
 PLATFORMS
   ruby
@@ -88,6 +79,7 @@ DEPENDENCIES
   flagsmith!
   gem-release
   pry
+  pry-byebug
   rake
   rspec
   rubocop

data/example/Gemfile

@@ -4,7 +4,7 @@ gem 'hanami', '~> 1.3'
 gem 'hanami-model', '~> 1.3'
 gem 'slim'
 gem 'sqlite3'
-gem "puma", "~> 5.6"
+gem "puma", "~> 6.3"
 
 gemspec path: '../'
 

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    flagsmith (3.0.0)
+    flagsmith (3.1.1)
       faraday
       faraday-retry
       faraday_middleware
@@ -10,8 +10,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     better_errors (2.9.1)
       coderay (>= 1.0.0)
@@ -20,13 +20,14 @@ GEM
     bigdecimal (1.4.4)
     binding_of_caller (0.8.0)
       debug_inspector (>= 0.0.1)
-    capybara (3.32.2)
+    capybara (3.39.0)
       addressable
+      matrix
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)
       rack (>= 1.6.0)
       rack-test (>= 0.6.3)
-      regexp_parser (~> 1.5)
+      regexp_parser (>= 1.5, < 3.0)
       xpath (~> 3.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
@@ -71,7 +72,7 @@ GEM
       dry-logic (~> 0.4, >= 0.4.0)
       dry-types (~> 0.11.0)
     erubi (1.10.0)
-    faraday (1.10.0)
+    faraday (1.10.3)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -87,8 +88,8 @@ GEM
     faraday-em_synchrony (1.0.0)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
     faraday-net_http (1.0.1)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
@@ -156,28 +157,31 @@ GEM
     inflecto (0.0.2)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
+    matrix (0.4.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    mini_portile2 (2.4.0)
-    multipart-post (2.1.1)
-    nio4r (2.5.8)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    multipart-post (2.3.0)
+    nio4r (2.5.9)
+    nokogiri (1.14.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.3-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.20.1)
     parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (4.0.7)
-    puma (5.6.4)
+    public_suffix (5.0.1)
+    puma (6.3.1)
       nio4r (~> 2.0)
-    rack (2.2.3.1)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (1.8.2)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
     rom (3.3.3)
       concurrent-ruby (~> 1.0)
@@ -245,6 +249,7 @@ GEM
       nokogiri (~> 1.8)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -257,7 +262,7 @@ DEPENDENCIES
   hanami-model (~> 1.3)
   hanami-webconsole
   pry
-  puma (~> 5.6)
+  puma (~> 6.3)
   rake
   rspec
   rubocop

data/flagsmith.gemspec

@@ -3,11 +3,11 @@
 require File.expand_path('lib/flagsmith/version', __dir__)
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.4.0'
+  spec.required_ruby_version = '>= 3.0.0'
   spec.name = 'flagsmith'
   spec.version = Flagsmith::VERSION
-  spec.authors = ['Tom Stuart', 'Brian Moelk']
-  spec.email = ['tom@solidstategroup.com', 'bmoelk@gmail.com']
+  spec.authors = ['Tom Stuart', 'Brian Moelk', 'Zach Aysan']
+  spec.email = ['tom@solidstategroup.com', 'bmoelk@gmail.com', 'zachaysan@gmail.com']
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(__dir__) do
@@ -27,12 +27,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'gem-release'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rubocop'
 
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday_middleware'
+  spec.add_dependency 'faraday', '>= 2.0.1'
   spec.add_dependency 'faraday-retry'
   spec.add_dependency 'semantic'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/flagsmith/engine/features/models.rb

@@ -40,9 +40,7 @@ module Flagsmith
         multivariate_feature_state_values.sort.each do |multi_fs_value|
           limit = multi_fs_value.percentage_allocation + start_percentage
 
-          if start_percentage <= percentage_value && percentage_value < limit
-            return multi_fs_value.multivariate_feature_option.value
-          end
+          return multi_fs_value.multivariate_feature_option.value if start_percentage <= percentage_value && percentage_value < limit
 
           start_percentage = limit
         end
@@ -165,7 +163,7 @@ module Flagsmith
         attr_reader :priority
 
         def initialize(params = {})
-          @priority = params[:priority].nil? ? nil : params[:priority].to_i
+          @priority = params[:priority]&.to_i
         end
       end
     end

data/lib/flagsmith/engine/segments/constants.rb

@@ -25,6 +25,7 @@ module Flagsmith
         IS_SET = 'IS_SET'
         IS_NOT_SET = 'IS_NOT_SET'
         MODULO = 'MODULO'
+        IN = 'IN'
 
         CONDITION_OPERATORS = [
           EQUAL,
@@ -37,7 +38,8 @@ module Flagsmith
           NOT_EQUAL,
           REGEX,
           PERCENTAGE_SPLIT,
-          MODULO
+          MODULO,
+          IN
         ].freeze
       end
     end

data/lib/flagsmith/engine/segments/evaluator.rb

@@ -36,6 +36,7 @@ module Flagsmith
             end
         end
 
+        # rubocop:disable Metrics/MethodLength
         def traits_match_segment_rule(identity_traits, rule, segment_id, identity_id)
           matching_block = lambda { |condition|
             traits_match_segment_condition(identity_traits, condition, segment_id, identity_id)
@@ -44,23 +45,25 @@ module Flagsmith
           matches_conditions =
             if rule.conditions&.length&.positive?
               rule.conditions.send(rule.matching_function, &matching_block)
-            else true
+            else
+              true
             end
 
           matches_conditions &&
             rule.rules.all? { |r| traits_match_segment_rule(identity_traits, r, segment_id, identity_id) }
         end
+        # rubocop:enable Metrics/MethodLength
 
         def traits_match_segment_condition(identity_traits, condition, segment_id, identity_id)
           if condition.operator == PERCENTAGE_SPLIT
-            return hashed_percentage_for_object_ids([segment_id, identity_id]) <= condition.value.to_f
+            return hashed_percentage_for_object_ids([segment_id,
+                                                     identity_id]) <= condition.value.to_f
           end
 
           trait = identity_traits.find { |t| t.key.to_s == condition.property }
 
-          if [IS_SET, IS_NOT_SET].include?(condition.operator)
-            return handle_trait_existence_conditions(trait, condition.operator)
-          end
+          return handle_trait_existence_conditions(trait, condition.operator) if [IS_SET,
+                                                                                  IS_NOT_SET].include?(condition.operator)
 
           return condition.match_trait_value?(trait.trait_value) if trait
 

data/lib/flagsmith/engine/segments/models.rb

@@ -56,10 +56,9 @@ module Flagsmith
 
         def match_trait_value?(trait_value)
           # handle some exceptions
-          if @value.is_a?(String) && @value.match?(/:semver$/)
-            trait_value = Semantic::Version.new(trait_value.gsub(/:semver$/, ''))
-          end
+          trait_value = Semantic::Version.new(trait_value.gsub(/:semver$/, '')) if @value.is_a?(String) && @value.match?(/:semver$/)
 
+          return match_in_value(trait_value) if @operator == IN
           return match_modulo_value(trait_value) if @operator == MODULO
 
           type_as_trait_value = format_to_type_of(trait_value)
@@ -73,8 +72,8 @@ module Flagsmith
           {
             'String' => ->(v) { v.to_s },
             'Semantic::Version' => ->(v) { Semantic::Version.new(v.to_s.gsub(/:semver$/, '')) },
-            'TrueClass' => ->(v) { ['True', 'true', 'TRUE', true, 1, '1'].include?(v) ? true : false },
-            'FalseClass' => ->(v) { ['False', 'false', 'FALSE', false, 0, '0'].include?(v) ? false : true },
+            'TrueClass' => ->(v) { ['True', 'true', 'TRUE', true, 1, '1'].include?(v) },
+            'FalseClass' => ->(v) { !['False', 'false', 'FALSE', false, 0, '0'].include?(v) },
             'Integer' => ->(v) { v.to_i },
             'Float' => ->(v) { v.to_f }
           }[input.class.to_s]
@@ -83,11 +82,17 @@ module Flagsmith
 
         def match_modulo_value(trait_value)
           divisor, remainder = @value.split('|')
-          trait_value.is_a?(Numeric) && trait_value % divisor.to_f == remainder.to_f
+          trait_value.is_a?(Numeric) && trait_value % divisor.to_f == remainder.to_f # rubocop:disable Lint/FloatComparison
         rescue StandardError
           false
         end
 
+        def match_in_value(trait_value)
+          return @value.split(',').include?(trait_value.to_s) if trait_value.is_a?(String) || trait_value.is_a?(Integer)
+
+          false
+        end
+
         class << self
           def build(json)
             new(**json.slice(:operator, :value).merge(property: json[:property_]))

data/lib/flagsmith/sdk/config.rb

@@ -6,7 +6,8 @@ module Flagsmith
     DEFAULT_API_URL = 'https://edge.api.flagsmith.com/api/v1/'
     OPTIONS = %i[
       environment_key api_url custom_headers request_timeout_seconds enable_local_evaluation
-      environment_refresh_interval_seconds retries enable_analytics default_flag_handler logger
+      environment_refresh_interval_seconds retries enable_analytics default_flag_handler
+      offline_mode offline_handler logger
     ].freeze
 
     # Available Configs
@@ -31,8 +32,12 @@ module Flagsmith
     #                                            API to power flag analytics charts
     #   +default_flag_handler+                 - ruby block which will be used in the case where
     #                                            flags cannot be retrieved from the API or
-    #                                            a non existent feature is requested.
+    #                                            a non-existent feature is requested.
     #                                            The searched feature#name will be passed to the block as an argument.
+    #   +offline_mode+                         - if enabled, uses a locally provided file and
+    #                                            bypasses requests to the api.
+    #   +offline_handler+                      - A file object that contains a JSON serialization of
+    #                                            the entire environment, project, flags, etc.
     #   +logger+                               - Pass your logger, default is Logger.new($stdout)
     #
     attr_reader(*OPTIONS)
@@ -51,6 +56,10 @@ module Flagsmith
       @enable_analytics
     end
 
+    def offline_mode?
+      @offline_mode
+    end
+
     def environment_flags_url
       'flags/'
     end
@@ -78,13 +87,15 @@ module Flagsmith
       @environment_refresh_interval_seconds = opts.fetch(:environment_refresh_interval_seconds, 60)
       @enable_analytics = opts.fetch(:enable_analytics, false)
       @default_flag_handler = opts[:default_flag_handler]
+      @offline_mode = opts.fetch(:offline_mode, false)
+      @offline_handler = opts[:offline_handler]
       @logger = options.fetch(:logger, Logger.new($stdout).tap { |l| l.level = :debug })
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
 
     class << self
       def environment_key
-        ENV['FLAGSMITH_ENVIRONMENT_KEY']
+        ENV.fetch('FLAGSMITH_ENVIRONMENT_KEY', nil)
       end
     end
   end

data/lib/flagsmith/sdk/models/flags.rb

@@ -4,32 +4,34 @@ module Flagsmith
   module Flags
     class NotFound < StandardError; end
 
+    # Base data class for the flag entity
     class BaseFlag
       include Comparable
 
       attr_reader :enabled, :value, :default
-      
+
       def initialize(enabled:, value:, default:)
         @enabled = enabled
         @value = value
         @default = default
       end
-  
+
       def enabled?
         enabled
       end
-      
+
       alias is_default default
     end
 
+    # Flag class to be used by default handler logic
     class DefaultFlag < BaseFlag
       def initialize(enabled:, value:)
         super(enabled: enabled, value: value, default: true)
       end
     end
 
+    # 'live' Flag class as returned by API or local evaluation
     class Flag < BaseFlag
-
       attr_reader :feature_name, :feature_id
 
       def initialize(feature_name:, enabled:, value:, feature_id:)
@@ -77,15 +79,18 @@ module Flagsmith
       end
     end
 
+    # Implementation of a class to hold a collection of flags.
+    # Implements methods for working with the list to avoid requesting flags for each feature evaluation.
     class Collection
       include Enumerable
 
-      attr_reader :flags, :default_flag_handler, :analytics_processor
+      attr_reader :flags, :default_flag_handler, :analytics_processor, :offline_handler
 
-      def initialize(flags = {}, analytics_processor: nil, default_flag_handler: nil)
+      def initialize(flags = {}, analytics_processor: nil, default_flag_handler: nil, offline_handler: nil)
         @flags = flags
         @default_flag_handler = default_flag_handler
         @analytics_processor = analytics_processor
+        @offline_handler = offline_handler
       end
 
       def each(&block)
@@ -115,16 +120,27 @@ module Flagsmith
       end
       alias get_feature_value feature_value
 
+      def get_flag_from_offline_handler(key)
+        @offline_handler.environment.feature_states.each do |feature_state|
+          return Flag.from_feature_state_model(feature_state, nil) if key == Flagsmith::Flags::Collection.normalize_key(feature_state.feature.name)
+        end
+        raise Flagsmith::Flags::NotFound,
+              "Feature does not exist: #{key}, offline_handler did not find a flag in this case."
+      end
+
       # Get a specific flag given the feature name.
       # :param feature_name: the name of the feature to retrieve the flag for.
       # :return: BaseFlag object.
       # :raises FlagsmithClientError: if feature doesn't exist
       def get_flag(feature_name)
         key = Flagsmith::Flags::Collection.normalize_key(feature_name)
+
         flag = flags.fetch(key)
         @analytics_processor.track_feature(flag.feature_name) if @analytics_processor && flag.feature_id
         flag
       rescue KeyError
+        return get_flag_from_offline_handler(key) if @offline_handler
+
         return @default_flag_handler.call(feature_name) if @default_flag_handler
 
         raise Flagsmith::Flags::NotFound,
@@ -159,7 +175,7 @@ module Flagsmith
         def from_feature_state_models(feature_states, identity_id: nil, **args)
           to_flag_object = lambda { |feature_state, acc|
             acc[normalize_key(feature_state.feature.name)] =
-            Flagsmith::Flags::Flag.from_feature_state_model(feature_state, identity_id)
+              Flagsmith::Flags::Flag.from_feature_state_model(feature_state, identity_id)
           }
 
           new(

data/lib/flagsmith/sdk/models/segments.rb

@@ -2,9 +2,10 @@
 
 module Flagsmith
   module Segments
+    # Data class to hold segment information.
     class Segment
       attr_reader :id, :name
-      
+
       def initialize(id:, name:)
         @id = id
         @name = name

data/lib/flagsmith/sdk/offline_handlers.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Flagsmith
+  module OfflineHandlers
+    # Provides the offline_handler to the Flagsmith::Client.
+    class LocalFileHandler
+      attr_reader :environment
+
+      def initialize(environment_document_path)
+        environment_file = File.open(environment_document_path)
+
+        data = JSON.parse(environment_file.read, symbolize_names: true)
+        @environment = Flagsmith::Engine::Environment.build(data)
+      end
+    end
+  end
+end

data/lib/flagsmith/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flagsmith
-  VERSION = '3.1.1'
+  VERSION = '4.0.0'
 end

data/lib/flagsmith.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
+require 'pry'
+require 'pry-byebug'
+
 require 'faraday'
 require 'faraday/retry'
-require 'faraday_middleware'
 
 # Hash#slice was added in ruby version 2.5
 # This is the patch to use slice in earler versions
@@ -16,13 +18,14 @@ require 'flagsmith/sdk/intervals'
 require 'flagsmith/sdk/pooling_manager'
 require 'flagsmith/sdk/models/flags'
 require 'flagsmith/sdk/models/segments'
+require 'flagsmith/sdk/offline_handlers'
 
 require 'flagsmith/engine/core'
 
 # no-doc
 module Flagsmith
   # Ruby client for flagsmith.com
-  class Client
+  class Client # rubocop:disable Metrics/ClassLength
     extend Forwardable
     # A Flagsmith client.
     #
@@ -44,7 +47,9 @@ module Flagsmith
     # Available Configs.
     #
     # :environment_key, :api_url, :custom_headers, :request_timeout_seconds, :enable_local_evaluation,
-    # :environment_refresh_interval_seconds, :retries, :enable_analytics, :default_flag_handler
+    # :environment_refresh_interval_seconds, :retries, :enable_analytics, :default_flag_handler,
+    # :offline_mode, :offline_handler
+    #
     # You can see full description in the Flagsmith::Config
 
     attr_reader :config, :environment
@@ -55,10 +60,24 @@ module Flagsmith
       @_mutex = Mutex.new
       @config = Flagsmith::Config.new(config)
 
+      validate_offline_mode!
+
       api_client
       analytics_processor
       environment_data_polling_manager
       engine
+      load_offline_handler
+    end
+
+    def validate_offline_mode!
+      if @config.offline_mode? && !@config.offline_handler
+        raise Flagsmith::ClientError,
+              'The offline_mode config param requires a matching offline_handler.'
+      end
+      return unless @config.offline_handler && @config.default_flag_handler
+
+      raise Flagsmith::ClientError,
+            'Cannot use offline_handler and default_flag_handler at the same time.'
     end
 
     def api_client
@@ -79,6 +98,10 @@ module Flagsmith
         )
     end
 
+    def load_offline_handler
+      @environment = offline_handler.environment if offline_handler
+    end
+
     def environment_data_polling_manager
       return nil unless @config.local_evaluation?
 
@@ -103,7 +126,7 @@ module Flagsmith
     # Get all the default for flags for the current environment.
     # @returns Flags object holding all the flags for the current environment.
     def get_environment_flags # rubocop:disable Naming/AccessorMethodName
-      return environment_flags_from_document if @config.local_evaluation?
+      return environment_flags_from_document if @config.local_evaluation? || @config.offline_mode
 
       environment_flags_from_api
     end
@@ -153,13 +176,13 @@ module Flagsmith
 
     def get_identity_segments(identifier, traits = {})
       unless environment
-        raise Flagsmith::ClientError, 
-          'Local evaluation required to obtain identity segments.'
+        raise Flagsmith::ClientError,
+              'Local evaluation or offline handler is required to obtain identity segments.'
       end
 
       identity_model = build_identity_model(identifier, traits)
       segment_models = engine.get_identity_segments(environment, identity_model)
-      return segment_models.map { |sm| Flagsmith::Segments::Segment.new(id: sm.id, name: sm.name) }.compact
+      segment_models.map { |sm| Flagsmith::Segments::Segment.new(id: sm.id, name: sm.name) }.compact
     end
 
     private
@@ -168,7 +191,8 @@ module Flagsmith
       Flagsmith::Flags::Collection.from_feature_state_models(
         engine.get_environment_feature_states(environment),
         analytics_processor: analytics_processor,
-        default_flag_handler: default_flag_handler
+        default_flag_handler: default_flag_handler,
+        offline_handler: offline_handler
       )
     end
 
@@ -178,45 +202,80 @@ module Flagsmith
       Flagsmith::Flags::Collection.from_feature_state_models(
         engine.get_identity_feature_states(environment, identity_model),
         analytics_processor: analytics_processor,
-        default_flag_handler: default_flag_handler
+        default_flag_handler: default_flag_handler,
+        offline_handler: offline_handler
       )
     end
 
+    # rubocop:disable Metrics/MethodLength
     def environment_flags_from_api
-      rescue_with_default_handler do
-        api_flags = api_client.get(@config.environment_flags_url).body
-        api_flags = api_flags.select { |flag| flag[:feature_segment].nil? }
-        Flagsmith::Flags::Collection.from_api(
-          api_flags,
-          analytics_processor: analytics_processor,
-          default_flag_handler: default_flag_handler
-        )
+      if offline_handler
+        begin
+          process_environment_flags_from_api
+        rescue StandardError
+          environment_flags_from_document
+        end
+      else
+        begin
+          process_environment_flags_from_api
+        rescue StandardError
+          if default_flag_handler
+            return Flagsmith::Flags::Collection.new(
+              {},
+              default_flag_handler: default_flag_handler
+            )
+          end
+          raise
+        end
       end
     end
+    # rubocop:enable Metrics/MethodLength
+
+    def process_environment_flags_from_api
+      api_flags = api_client.get(@config.environment_flags_url).body
+      api_flags = api_flags.select { |flag| flag[:feature_segment].nil? }
+      Flagsmith::Flags::Collection.from_api(
+        api_flags,
+        analytics_processor: analytics_processor,
+        default_flag_handler: default_flag_handler,
+        offline_handler: offline_handler
+      )
+    end
 
+    # rubocop:disable Metrics/MethodLength
     def get_identity_flags_from_api(identifier, traits = {})
-      rescue_with_default_handler do
-        data = generate_identities_data(identifier, traits)
-        json_response = api_client.post(@config.identities_url, data.to_json).body
-
-        Flagsmith::Flags::Collection.from_api(
-          json_response[:flags],
-          analytics_processor: analytics_processor,
-          default_flag_handler: default_flag_handler
-        )
+      if offline_handler
+        begin
+          process_identity_flags_from_api(identifier, traits)
+        rescue StandardError
+          get_identity_flags_from_document(identifier, traits)
+        end
+      else
+        begin
+          process_identity_flags_from_api(identifier, traits)
+        rescue StandardError
+          if default_flag_handler
+            return Flagsmith::Flags::Collection.new(
+              {},
+              default_flag_handler: default_flag_handler
+            )
+          end
+          raise
+        end
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
-    def rescue_with_default_handler
-      yield
-    rescue StandardError
-      if default_flag_handler
-        return Flagsmith::Flags::Collection.new(
-          {},
-          default_flag_handler: default_flag_handler
-        )
-      end
-      raise
+    def process_identity_flags_from_api(identifier, traits = {})
+      data = generate_identities_data(identifier, traits)
+      json_response = api_client.post(@config.identities_url, data.to_json).body
+
+      Flagsmith::Flags::Collection.from_api(
+        json_response[:flags],
+        analytics_processor: analytics_processor,
+        default_flag_handler: default_flag_handler,
+        offline_handler: offline_handler
+      )
     end
 
     def build_identity_model(identifier, traits = {})

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: flagsmith
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Tom Stuart
 - Brian Moelk
-autorequire:
+- Zach Aysan
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -68,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,7 +83,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -96,13 +97,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -110,19 +111,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +157,7 @@ description: Ruby Client for Flagsmith. Ship features with confidence using feat
 email:
 - tom@solidstategroup.com
 - bmoelk@gmail.com
+- zachaysan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -224,12 +226,14 @@ files:
 - lib/flagsmith/sdk/intervals.rb
 - lib/flagsmith/sdk/models/flags.rb
 - lib/flagsmith/sdk/models/segments.rb
+- lib/flagsmith/sdk/offline_handlers.rb
 - lib/flagsmith/sdk/pooling_manager.rb
 - lib/flagsmith/version.rb
 homepage: https://flagsmith.com
 licenses: []
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -237,15 +241,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: Flagsmith - Ship features with confidence
 test_files: []