flagsmith 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55ba6a7589045f62c03387dfb9fba16bdcf0eec278ee14b3db7549c6d16d0bcc
-  data.tar.gz: 1a91d635ec437cfe284492e11e57b2aa06edd13013dd562db0550cc5245a85a6
+  metadata.gz: f7e45006cc3caabc6941c7daaf58f339940cb1ea1fc3ec76be0a7897d84212fa
+  data.tar.gz: 32703828745194ea1befb791266e592e888c7fac888fd35c4cc6b6e9b6f3e204
 SHA512:
-  metadata.gz: 1e8bc92bbd6382240c16e9a3a48c5f3509ce4d68518d7152594c43095c722dfe3503216d9e77fa1ff740013c5164c998555ec1a95f98ec6c9b4eed35c037fa8b
-  data.tar.gz: 6b3c87dd50db25cc67bb9cca968f9b21ac1a9ed3f935978b6589479cc9ce76689cc9ae7eae9f05cfeb70fd4a8dc090dcd4d3dea6614121d30c08b2b9c9be22eb
+  metadata.gz: fa77df821acafa8ccc9d0580845573b47fe0287c1937a7f8200d08532f559d77af1c41e6862a52a0ab90fec30cc020ea63068120aa95a95da41cff2b2a48e84d
+  data.tar.gz: 25f98c085b4b8253356fbc203e5605fa6ac53930e7ac8bbe7d2be1f5ba8dc8bf0374ca9a85b57bebafb08b9e57077dcc18637fca9b9d91a758ec404398de663a

data/.rubocop.yml

@@ -4,6 +4,7 @@ Layout/HashAlignment:
   AllowMultipleStyles: true
   EnforcedColonStyle: key
 AllCops:
+  TargetRubyVersion: 3.0  # Pin to flagsmith.gemspec required_ruby_version
   NewCops: enable
   SuggestExtensions: false
   Exclude:

data/Gemfile.lock

@@ -1,90 +1,75 @@
 PATH
   remote: .
   specs:
-    flagsmith (3.2.0)
-      faraday
+    flagsmith (4.0.0)
+      faraday (>= 2.0.1)
       faraday-retry
-      faraday_middleware
       semantic
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
-    faraday (1.10.3)
-      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)
-    json (2.6.3)
+    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.3.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    net-http (0.4.1)
+      uri
+    parallel (1.24.0)
+    parser (3.3.0.4)
       ast (~> 2.4.1)
       racc
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.7.1)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.3)
-    regexp_parser (2.8.1)
-    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)
+    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.54.2)
+      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 (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
     semantic (1.6.1)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
+    uri (0.13.0)
 
 PLATFORMS
   ruby
@@ -94,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

@@ -161,7 +161,7 @@ GEM
     method_source (1.0.0)
     mini_mime (1.1.2)
     multipart-post (2.3.0)
-    nio4r (2.5.8)
+    nio4r (2.5.9)
     nokogiri (1.14.3-arm64-darwin)
       racc (~> 1.4)
     nokogiri (1.14.3-x86_64-linux)
@@ -173,7 +173,7 @@ GEM
       coderay (~> 1.1)
       method_source (~> 1.0)
     public_suffix (5.0.1)
-    puma (5.6.4)
+    puma (6.3.1)
       nio4r (~> 2.0)
     racc (1.6.2)
     rack (2.2.7)
@@ -262,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,12 @@ 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'

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,6 +87,8 @@ 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

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

@@ -84,12 +84,13 @@ module Flagsmith
     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)
@@ -119,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,

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.2.0'
+  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,6 +18,7 @@ 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'
 
@@ -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
@@ -154,7 +177,7 @@ module Flagsmith
     def get_identity_segments(identifier, traits = {})
       unless environment
         raise Flagsmith::ClientError,
-              'Local evaluation required to obtain identity segments.'
+              'Local evaluation or offline handler is required to obtain identity segments.'
       end
 
       identity_model = build_identity_model(identifier, traits)
@@ -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.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Tom Stuart
 - Brian Moelk
+- Zach Aysan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-25 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,6 +226,7 @@ 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
@@ -238,7 +241,7 @@ 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:
   - - ">="