flagsmith 4.0.1 → 4.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf49e28a71c8b23ec9ec005b827dd4354cef0471504ca65e40808d4c206f65ad
-  data.tar.gz: de53c7c6d6d17918b5a8ffdf0bdc505a641a63cb637d3dd74ac26c7da5442a99
+  metadata.gz: 8b908dee8f4935d4c754400d2e314e8a61e545dc242490ca396704f6b00ef1e1
+  data.tar.gz: 4c9203ad57f71fb3699b78ccb9a50aa7b4c89eaf1433803d0c16e3b7644a91c3
 SHA512:
-  metadata.gz: ff47303eae7c600cf32807a4b3aad303fa8fbac31678570d9262366e152e96342083ed31f9f8be91614ebfee10c525707ae66ec418a193dc32c35513686816bd
-  data.tar.gz: 0d2cc7b84114d1595c93c8e6adea2aa4de9e8f3576bd3bd2cab0fcaac54131ec25ba5cbdd7f74cf795b8846f74aeeeabf9fd0bccadf99e98c104030a134fa4f3
+  metadata.gz: a41d33186ccd7bf6b7405a123186888ea9aef9e0890762b2384d1681b897ceed602e471eb4903190bf09b0c1c48a6b99a831053f10dde55cbcd6e9875851dfde
+  data.tar.gz: e654da93bb040ce2a08fa0cb6b15d167a2b557853fec1e8deb3cd45df124177998d7fb40e6ccae777cf8e62b0cdc72efd0cbd3a8e6fd4fcd894ed2b23d228c90

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flagsmith (4.0.1)
+    flagsmith (4.1.1)
       faraday (>= 2.0.1)
       faraday-retry
       semantic
@@ -17,7 +17,7 @@ GEM
       faraday-net_http (>= 2.0, < 3.2)
     faraday-net_http (3.1.0)
       net-http
-    faraday-retry (2.2.0)
+    faraday-retry (2.2.1)
       faraday (~> 2.0)
     gem-release (2.2.2)
     json (2.7.1)
@@ -39,7 +39,8 @@ GEM
     rainbow (3.1.1)
     rake (13.1.0)
     regexp_parser (2.9.0)
-    rexml (3.2.6)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -68,6 +69,7 @@ GEM
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     semantic (1.6.1)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
 

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

@@ -6,24 +6,35 @@ module Flagsmith
     class Environment
       attr_reader :id, :api_key
       attr_accessor :project, :feature_states, :amplitude_config, :segment_config,
-                    :mixpanel_config, :heap_config
+                    :mixpanel_config, :heap_config, :identity_overrides
 
-      def initialize(id:, api_key:, project:, feature_states: [])
+      def initialize(id:, api_key:, project:, feature_states: [], identity_overrides: [])
         @id = id
         @api_key = api_key
         @project = project
         @feature_states = feature_states
+        @identity_overrides = identity_overrides
       end
 
       class << self
+        # rubocop:disable Metrics/MethodLength
         def build(json)
           project = Flagsmith::Engine::Project.build(json[:project])
           feature_states = json[:feature_states].map do |fs|
             Flagsmith::Engine::FeatureState.build(fs)
           end
 
-          new(**json.slice(:id, :api_key).merge(project: project, feature_states: feature_states))
+          identity_overrides = json.fetch(:identity_overrides, []).map do |io|
+            Flagsmith::Engine::Identity.build(io)
+          end
+
+          new(**json.slice(:id, :api_key).merge(
+            project: project,
+            feature_states: feature_states,
+            identity_overrides: identity_overrides
+          ))
         end
+        # rubocop:enable Metrics/MethodLength
       end
     end
 

data/lib/flagsmith/sdk/analytics_processor.rb

@@ -19,15 +19,20 @@ module Flagsmith
       @analytics_data = {}
       @api_client = data.fetch(:api_client)
       @timeout = data.fetch(:timeout, 3)
+      @logger = data.fetch(:logger)
     end
 
     # Sends all the collected data to the api asynchronously and resets the timer
     def flush
       return if @analytics_data.empty?
 
-      @api_client.post(ENDPOINT, @analytics_data.to_json)
+      begin
+        @api_client.post(ENDPOINT, @analytics_data.to_json)
+        @analytics_data = {}
+      rescue StandardError => e
+        @logger.warn "Temporarily unable to access flag analytics endpoint for exception: #{e}"
+      end
 
-      @analytics_data = {}
       @last_flushed = Time.now
     end
 

data/lib/flagsmith/sdk/config.rb

@@ -7,7 +7,7 @@ module Flagsmith
     OPTIONS = %i[
       environment_key api_url custom_headers request_timeout_seconds enable_local_evaluation
       environment_refresh_interval_seconds retries enable_analytics default_flag_handler
-      offline_mode offline_handler logger
+      offline_mode offline_handler polling_manager_failure_limit logger
     ].freeze
 
     # Available Configs
@@ -38,6 +38,8 @@ module Flagsmith
     #                                            bypasses requests to the api.
     #   +offline_handler+                      - A file object that contains a JSON serialization of
     #                                            the entire environment, project, flags, etc.
+    #   +polling_manager_failure_limit+        - An integer to control how long to suppress errors in
+    #                                            the polling manager for local evaluation mode.
     #   +logger+                               - Pass your logger, default is Logger.new($stdout)
     #
     attr_reader(*OPTIONS)
@@ -89,6 +91,7 @@ module Flagsmith
       @default_flag_handler = opts[:default_flag_handler]
       @offline_mode = opts.fetch(:offline_mode, false)
       @offline_handler = opts[:offline_handler]
+      @polling_manager_failure_limit = opts.fetch(:polling_manager_failure_limit, 10)
       @logger = options.fetch(:logger, Logger.new($stdout).tap { |l| l.level = :debug })
     end
     # rubocop:enable Metrics/AbcSize, Metrics/MethodLength

data/lib/flagsmith/sdk/pooling_manager.rb

@@ -7,20 +7,33 @@ module Flagsmith
   class EnvironmentDataPollingManager
     include Flagsmith::SDK::Intervals
 
-    def initialize(main, refresh_interval_seconds)
+    attr_reader :failures_since_last_update
+
+    def initialize(main, refresh_interval_seconds, polling_manager_failure_limit)
       @main = main
       @refresh_interval_seconds = refresh_interval_seconds
+      @polling_manager_failure_limit = polling_manager_failure_limit
+      @failures_since_last_update = 0
     end
 
+    # rubocop:disable Metrics/MethodLength
     def start
       update_environment = lambda {
         stop
-        @interval = set_interval(@refresh_interval_seconds) { @main.update_environment }
+        @interval = set_interval(@refresh_interval_seconds) do
+          @main.update_environment
+          @failures_since_last_update = 0
+        rescue StandardError => e
+          @failures_since_last_update += 1
+          @main.config.logger.warn "Failure to update the environment due to an error: #{e}"
+          raise e if @failures_since_last_update > @polling_manager_failure_limit
+        end
       }
 
       # TODO: this call should be awaited for getIdentityFlags/getEnvironmentFlags when enableLocalEvaluation is true
       update_environment.call
     end
+    # rubocop:enable Metrics/MethodLength
 
     def stop
       return unless @interval

data/lib/flagsmith/version.rb

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

data/lib/flagsmith.rb

@@ -45,17 +45,18 @@ module Flagsmith
     #
     # :environment_key, :api_url, :custom_headers, :request_timeout_seconds, :enable_local_evaluation,
     # :environment_refresh_interval_seconds, :retries, :enable_analytics, :default_flag_handler,
-    # :offline_mode, :offline_handler
+    # :offline_mode, :offline_handler, :polling_manager_failure_limit
     #
     # You can see full description in the Flagsmith::Config
 
-    attr_reader :config, :environment
+    attr_reader :config, :environment, :identity_overrides_by_identifier
 
     delegate Flagsmith::Config::OPTIONS => :@config
 
     def initialize(config)
       @_mutex = Mutex.new
       @config = Flagsmith::Config.new(config)
+      @identity_overrides_by_identifier = {}
 
       validate_offline_mode!
 
@@ -91,7 +92,8 @@ module Flagsmith
       @analytics_processor ||=
         Flagsmith::AnalyticsProcessor.new(
           api_client: api_client,
-          timeout: request_timeout_seconds
+          timeout: request_timeout_seconds,
+          logger: @config.logger
         )
     end
 
@@ -102,10 +104,10 @@ module Flagsmith
     def environment_data_polling_manager
       return nil unless @config.local_evaluation?
 
-      update_environment
+      update_environment if @environment_data_polling_manager.nil?
 
       @environment_data_polling_manager ||= Flagsmith::EnvironmentDataPollingManager.new(
-        self, environment_refresh_interval_seconds
+        self, environment_refresh_interval_seconds, @config.polling_manager_failure_limit
       ).tap(&:start)
     end
 
@@ -113,6 +115,16 @@ module Flagsmith
     # You only need to call this if you wish to bypass environment_refresh_interval_seconds.
     def update_environment
       @_mutex.synchronize { @environment = environment_from_api }
+      update_identity_overrides
+    end
+
+    def update_identity_overrides
+      return unless @environment
+
+      @identity_overrides_by_identifier = {}
+      @environment.identity_overrides.each do |identity|
+        @identity_overrides_by_identifier[identity.identifier] = identity
+      end
     end
 
     def environment_from_api
@@ -177,7 +189,7 @@ module Flagsmith
               'Local evaluation or offline handler is required to obtain identity segments.'
       end
 
-      identity_model = build_identity_model(identifier, traits)
+      identity_model = get_identity_model(identifier, traits)
       segment_models = engine.get_identity_segments(environment, identity_model)
       segment_models.map { |sm| Flagsmith::Segments::Segment.new(id: sm.id, name: sm.name) }.compact
     end
@@ -194,10 +206,11 @@ module Flagsmith
     end
 
     def get_identity_flags_from_document(identifier, traits = {})
-      identity_model = build_identity_model(identifier, traits)
+      identity_model = get_identity_model(identifier, traits)
 
       Flagsmith::Flags::Collection.from_feature_state_models(
         engine.get_identity_feature_states(environment, identity_model),
+        identity_id: identity_model.composite_key,
         analytics_processor: analytics_processor,
         default_flag_handler: default_flag_handler,
         offline_handler: offline_handler
@@ -275,19 +288,28 @@ module Flagsmith
       )
     end
 
-    def build_identity_model(identifier, traits = {})
+    # rubocop:disable Metrics/MethodLength
+    def get_identity_model(identifier, traits = {})
       unless environment
         raise Flagsmith::ClientError,
-              'Unable to build identity model when no local environment present.'
+              'Unable to get identity model when no local environment present.'
       end
 
       trait_models = traits.map do |key, value|
         Flagsmith::Engine::Identities::Trait.new(trait_key: key, trait_value: value)
       end
+
+      if identity_overrides_by_identifier.key? identifier
+        identity = identity_overrides_by_identifier[identifier]
+        identity.update_traits trait_models
+        return identity
+      end
+
       Flagsmith::Engine::Identity.new(
         identity_traits: trait_models, environment_api_key: environment_key, identifier: identifier
       )
     end
+    # rubocop:enable Metrics/MethodLength
 
     def generate_identities_data(identifier, traits = {})
       {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flagsmith
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.1
 platform: ruby
 authors:
 - Tom Stuart
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,41 +171,6 @@ files:
 - LICENCE
 - README.md
 - Rakefile
-- example/.env.development
-- example/.env.test
-- example/.gitignore
-- example/.hanamirc
-- example/.rspec
-- example/Gemfile
-- example/Gemfile.lock
-- example/README.md
-- example/Rakefile
-- example/apps/web/application.rb
-- example/apps/web/config/routes.rb
-- example/apps/web/controllers/.gitkeep
-- example/apps/web/controllers/home/index.rb
-- example/apps/web/templates/application.html.slim
-- example/apps/web/templates/home/index.html.slim
-- example/apps/web/views/application_layout.rb
-- example/apps/web/views/home/index.rb
-- example/config.ru
-- example/config/boot.rb
-- example/config/environment.rb
-- example/config/initializers/.gitkeep
-- example/config/initializers/flagsmith.rb
-- example/config/puma.rb
-- example/spec/example/entities/.gitkeep
-- example/spec/example/mailers/.gitkeep
-- example/spec/example/repositories/.gitkeep
-- example/spec/features_helper.rb
-- example/spec/spec_helper.rb
-- example/spec/support/.gitkeep
-- example/spec/support/capybara.rb
-- example/spec/web/controllers/.gitkeep
-- example/spec/web/controllers/home/index_spec.rb
-- example/spec/web/features/.gitkeep
-- example/spec/web/views/application_layout_spec.rb
-- example/spec/web/views/home/index_spec.rb
 - flagsmith.gemspec
 - lib/flagsmith.rb
 - lib/flagsmith/engine/core.rb

data/example/.env.development

@@ -1,5 +0,0 @@
-# Define ENV variables for development environment
-DATABASE_URL="sqlite://db/example_development.sqlite"
-SERVE_STATIC_ASSETS="true"
-WEB_SESSIONS_SECRET="4743628fa58981a0eaf99cc636146f49ceffd0ab6a8423c0e2493e67cd825f67"
-FLAGSMITH_ENVIRONMENT_KEY="YOUR_FLAGSMITH_ENVIRONMENT_KEY"

data/example/.env.test

@@ -1,4 +0,0 @@
-# Define ENV variables for test environment
-DATABASE_URL="sqlite://db/example_test.sqlite"
-SERVE_STATIC_ASSETS="true"
-WEB_SESSIONS_SECRET="50f1a22a68ccc6d06b48387f4cd4aa63cbaabd2b525c288f0f7a7046b10cc6ac"

data/example/.gitignore

@@ -1,5 +0,0 @@
-/db/*.sqlite
-/public/assets*
-/tmp
-.env.local
-.env.*.local

data/example/.hanamirc

@@ -1,3 +0,0 @@
-project=example
-test=rspec
-template=slim

data/example/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/example/Gemfile

@@ -1,25 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'hanami', '~> 1.3'
-gem 'hanami-model', '~> 1.3'
-gem 'slim'
-gem 'sqlite3'
-gem "puma", "~> 6.3"
-
-gemspec path: '../'
-
-group :development do
-  # Code reloading
-  # See: https://guides.hanamirb.org/projects/code-reloading
-  gem 'hanami-webconsole'
-  gem 'shotgun', platforms: :ruby
-end
-
-group :test, :development do
-  gem 'dotenv', '~> 2.4'
-end
-
-group :test do
-  gem 'capybara'
-  gem 'rspec'
-end

data/example/Gemfile.lock

@@ -1,274 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    flagsmith (3.1.1)
-      faraday
-      faraday-retry
-      faraday_middleware
-      semantic
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.8.4)
-      public_suffix (>= 2.0.2, < 6.0)
-    ast (2.4.2)
-    better_errors (2.9.1)
-      coderay (>= 1.0.0)
-      erubi (>= 1.0.0)
-      rack (>= 0.9.0)
-    bigdecimal (1.4.4)
-    binding_of_caller (0.8.0)
-      debug_inspector (>= 0.0.1)
-    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, < 3.0)
-      xpath (~> 3.2)
-    coderay (1.1.3)
-    concurrent-ruby (1.1.10)
-    debug_inspector (1.1.0)
-    diff-lcs (1.5.0)
-    dotenv (2.7.6)
-    dry-cli (0.7.0)
-    dry-configurable (0.11.6)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.4, >= 0.4.7)
-      dry-equalizer (~> 0.2)
-    dry-container (0.7.2)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
-      concurrent-ruby (~> 1.0)
-    dry-equalizer (0.3.0)
-    dry-initializer (1.4.1)
-    dry-logic (0.4.2)
-      dry-container (~> 0.2, >= 0.2.6)
-      dry-core (~> 0.2)
-      dry-equalizer (~> 0.2)
-    dry-struct (0.3.1)
-      dry-configurable (~> 0.1)
-      dry-core (~> 0.3)
-      dry-equalizer (~> 0.2)
-      dry-types (~> 0.9, >= 0.9.0)
-      ice_nine (~> 0.11)
-    dry-types (0.11.1)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1)
-      dry-container (~> 0.3)
-      dry-core (~> 0.2, >= 0.2.1)
-      dry-equalizer (~> 0.2)
-      dry-logic (~> 0.4, >= 0.4.0)
-      inflecto (~> 0.0.0, >= 0.0.2)
-    dry-validation (0.11.0)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.1, >= 0.1.3)
-      dry-core (~> 0.2, >= 0.2.1)
-      dry-equalizer (~> 0.2)
-      dry-logic (~> 0.4, >= 0.4.0)
-      dry-types (~> 0.11.0)
-    erubi (1.10.0)
-    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.2)
-    hanami (1.3.5)
-      bundler (>= 1.6, < 3)
-      concurrent-ruby (~> 1.0)
-      dry-cli (~> 0.5)
-      hanami-assets (~> 1.3)
-      hanami-controller (~> 1.3, >= 1.3.3)
-      hanami-helpers (~> 1.3)
-      hanami-mailer (~> 1.3)
-      hanami-router (~> 1.3)
-      hanami-utils (~> 1.3)
-      hanami-validations (>= 1.3, < 3)
-      hanami-view (~> 1.3)
-    hanami-assets (1.3.5)
-      hanami-helpers (~> 1.3)
-      hanami-utils (~> 1.3)
-      tilt (~> 2.0, >= 2.0.2)
-    hanami-controller (1.3.3)
-      hanami-utils (~> 1.3)
-      rack (~> 2.0)
-    hanami-helpers (1.3.3)
-      hanami-utils (~> 1.3)
-    hanami-mailer (1.3.3)
-      hanami-utils (~> 1.3)
-      mail (~> 2.6)
-      tilt (~> 2.0, >= 2.0.1)
-    hanami-model (1.3.3)
-      bigdecimal (~> 1.4)
-      concurrent-ruby (~> 1.0)
-      dry-logic (~> 0.4.2, < 0.5)
-      dry-types (~> 0.11.0)
-      hanami-utils (~> 1.3)
-      rom (~> 3.3, >= 3.3.3)
-      rom-repository (~> 1.4)
-      rom-sql (~> 1.3, >= 1.3.5)
-    hanami-router (1.3.2)
-      hanami-utils (~> 1.3)
-      http_router (= 0.11.2)
-      rack (~> 2.0)
-    hanami-utils (1.3.8)
-      concurrent-ruby (~> 1.0)
-      transproc (~> 1.0)
-    hanami-validations (1.3.8)
-      dry-configurable (<= 0.12)
-      dry-logic (~> 0.4.2, < 0.5)
-      dry-validation (~> 0.11, < 0.12)
-      hanami-utils (~> 1.3)
-    hanami-view (1.3.3)
-      hanami-utils (~> 1.3)
-      tilt (~> 2.0, >= 2.0.1)
-    hanami-webconsole (0.1.0)
-      better_errors (~> 2.4)
-      binding_of_caller (~> 0.8)
-    http_router (0.11.2)
-      rack (>= 1.0.0)
-      url_mount (~> 0.2.1)
-    ice_nine (0.11.2)
-    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)
-    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 (5.0.1)
-    puma (6.3.1)
-      nio4r (~> 2.0)
-    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 (2.8.0)
-    rexml (3.2.5)
-    rom (3.3.3)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 0.3)
-      dry-equalizer (~> 0.2)
-      dry-initializer (~> 1.3)
-      dry-types (~> 0.9, >= 0.9.4)
-      rom-mapper (~> 0.5, >= 0.5.1)
-    rom-mapper (0.5.1)
-      dry-core (~> 0.2, >= 0.2.3)
-      dry-equalizer (~> 0.2)
-      transproc (~> 1.0)
-    rom-repository (1.4.0)
-      dry-core (~> 0.3, >= 0.3.1)
-      dry-struct (~> 0.3)
-      rom (~> 3.3)
-      rom-mapper (~> 0.5)
-    rom-sql (1.3.5)
-      dry-core (~> 0.3)
-      dry-equalizer (~> 0.2)
-      dry-types (~> 0.11.0)
-      rom (~> 3.2, >= 3.2.2)
-      sequel (~> 4.43)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.12.1)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
-    semantic (1.6.1)
-    sequel (4.49.0)
-    shotgun (0.9.2)
-      rack (>= 1.0)
-    slim (4.1.0)
-      temple (>= 0.7.6, < 0.9)
-      tilt (>= 2.0.6, < 2.1)
-    sqlite3 (1.4.2)
-    temple (0.8.2)
-    tilt (2.0.10)
-    transproc (1.1.1)
-    unicode-display_width (2.1.0)
-    url_mount (0.2.1)
-      rack
-    xpath (3.2.0)
-      nokogiri (~> 1.8)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  bundler
-  capybara
-  dotenv (~> 2.4)
-  flagsmith!
-  gem-release
-  hanami (~> 1.3)
-  hanami-model (~> 1.3)
-  hanami-webconsole
-  pry
-  puma (~> 6.3)
-  rake
-  rspec
-  rubocop
-  shotgun
-  slim
-  sqlite3
-
-BUNDLED WITH
-   2.3.14

data/example/README.md

@@ -1,29 +0,0 @@
-# Flagsmith Basic Ruby Example
-
-This directory contains a basic Flask application which utilises Flagsmith. To run the example application, you'll 
-need to go through the following steps:
-
-1. Create an account, organisation and project on [Flagsmith](https://flagsmith.com)
-2. Create a feature in the project called "secret_button"
-3. Give the feature a value using the json editor as follows: 
-
-```json
-{"colour": "#ababab"}
-```
-
-4. Create a .env.local file from the template located in this directory with the environment key of one of the environments 
-in flagsmith (This can be found on the 'settings' page accessed from the menu on the left under the chosen environment.)
-5. From a terminal window, export those environment variables (either manually or by using `export $(cat .env)`)
-6. Install dependencies:
-```bash
-bundle install
-```
-7. Run the application:
-```
-bundle exec hanami server
-```
-8. Browse to http://localhost:2300
-
-Now you can play around with the 'secret_button' feature in flagsmith, turn it on to show it and edit the colour in the
-json value to edit the colour of the button. You can also identify as a given user and then update the settings for the
-secret button feature for that user in the flagsmith interface to see the affect that has too. 

data/example/Rakefile

@@ -1,9 +0,0 @@
-require 'rake'
-require 'hanami/rake_tasks'
-
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-  task default: :spec
-rescue LoadError
-end

data/example/apps/web/application.rb

@@ -1,162 +0,0 @@
-require 'hanami/helpers'
-require 'hanami/assets'
-
-require_relative '../../../lib/flagsmith'
-
-module Web
-  class Application < Hanami::Application
-    configure do
-      root __dir__
-
-      load_paths << %w[
-        controllers
-        views
-      ]
-
-      routes 'config/routes'
-
-      layout :application # It will load Web::Views::ApplicationLayout
-
-      templates 'templates'
-
-      ##
-      # ASSETS
-      #
-      assets do
-        # In order to skip JavaScript compression comment the following line
-        javascript_compressor :builtin
-
-        # In order to skip stylesheet compression comment the following line
-        stylesheet_compressor :builtin
-      end
-
-      ##
-      # SECURITY
-      #
-
-      # X-Frame-Options is a HTTP header supported by modern browsers.
-      # It determines if a web page can or cannot be included via <frame> and
-      # <iframe> tags by untrusted domains.
-      #
-      # Web applications can send this header to prevent Clickjacking attacks.
-      #
-      # Read more at:
-      #
-      #   * https://developer.mozilla.org/en-US/docs/Web/HTTP/X-Frame-Options
-      #   * https://www.owasp.org/index.php/Clickjacking
-      #
-      security.x_frame_options 'DENY'
-
-      # X-Content-Type-Options prevents browsers from interpreting files as
-      # something else than declared by the content type in the HTTP headers.
-      #
-      # Read more at:
-      #
-      #   * https://www.owasp.org/index.php/OWASP_Secure_Headers_Project#X-Content-Type-Options
-      #   * https://msdn.microsoft.com/en-us/library/gg622941%28v=vs.85%29.aspx
-      #   * https://blogs.msdn.microsoft.com/ie/2008/09/02/ie8-security-part-vi-beta-2-update
-      #
-      security.x_content_type_options 'nosniff'
-
-      # X-XSS-Protection is a HTTP header to determine the behavior of the
-      # browser in case an XSS attack is detected.
-      #
-      # Read more at:
-      #
-      #   * https://www.owasp.org/index.php/Cross-site_Scripting_(XSS)
-      #   * https://www.owasp.org/index.php/OWASP_Secure_Headers_Project#X-XSS-Protection
-      #
-      security.x_xss_protection '1; mode=block'
-
-      # Content-Security-Policy (CSP) is a HTTP header supported by modern
-      # browsers. It determines trusted sources of execution for dynamic
-      # contents (JavaScript) or other web related assets: stylesheets, images,
-      # fonts, plugins, etc.
-      #
-      # Web applications can send this header to mitigate Cross Site Scripting
-      # (XSS) attacks.
-      #
-      # The default value allows images, scripts, AJAX, fonts and CSS from the
-      # same origin, and does not allow any other resources to load (eg object,
-      # frame, media, etc).
-      #
-      # Inline JavaScript is NOT allowed. To enable it, please use:
-      # "script-src 'unsafe-inline'".
-      #
-      # Content Security Policy introduction:
-      #
-      #  * http://www.html5rocks.com/en/tutorials/security/content-security-policy/
-      #  * https://www.owasp.org/index.php/Content_Security_Policy
-      #  * https://www.owasp.org/index.php/Cross-site_Scripting_%28XSS%29
-      #
-      # Inline and eval JavaScript risks:
-      #
-      #   * http://www.html5rocks.com/en/tutorials/security/content-security-policy/#inline-code-considered-harmful
-      #   * http://www.html5rocks.com/en/tutorials/security/content-security-policy/#eval-too
-      #
-      # Content Security Policy usage:
-      #
-      #  * http://content-security-policy.com/
-      #  * https://developer.mozilla.org/en-US/docs/Web/Security/CSP/Using_Content_Security_Policy
-      #
-      # Content Security Policy references:
-      #
-      #  * https://developer.mozilla.org/en-US/docs/Web/Security/CSP/CSP_policy_directives
-      #
-      security.content_security_policy %(
-        form-action 'self';
-        frame-ancestors 'self';
-        base-uri 'self';
-        default-src 'none';
-        script-src 'self';
-        connect-src 'self';
-        img-src 'self' https: data:;
-        style-src 'self' 'unsafe-inline' https:;
-        font-src 'self';
-        object-src 'none';
-        plugin-types application/pdf;
-        child-src 'self';
-        frame-src 'self';
-        media-src 'self'
-      )
-
-      ##
-      # FRAMEWORKS
-      #
-
-      # Configure the code that will yield each time Web::Action is included
-      # This is useful for sharing common functionality
-      #
-      # See: http://www.rubydoc.info/gems/hanami-controller#Configuration
-      controller.prepare do
-        # include MyAuthentication # included in all the actions
-        # before :authenticate!    # run an authentication before callback
-      end
-
-      # Configure the code that will yield each time Web::View is included
-      # This is useful for sharing common functionality
-      #
-      # See: http://www.rubydoc.info/gems/hanami-view#Configuration
-      view.prepare do
-        include Hanami::Helpers
-        include Web::Assets::Helpers
-      end
-    end
-
-    ##
-    # DEVELOPMENT
-    #
-    configure :development do
-      # Don't handle exceptions, render the stack trace
-      handle_exceptions false
-    end
-
-    ##
-    # TEST
-    #
-    configure :test do
-      # Don't handle exceptions, render the stack trace
-      handle_exceptions false
-    end
-  end
-end

data/example/apps/web/config/routes.rb

@@ -1 +0,0 @@
-get '/', to: 'home#index'

data/example/apps/web/controllers/home/index.rb

@@ -1,32 +0,0 @@
-module Web
-  module Controllers
-    module Home
-      class Index
-        include Web::Action
-
-        expose :identifier, :show_button, :button_color
-
-        def call(params)
-          @identifier = params.get(:flagsmith, :identifier)
-
-          if @identifier.nil? || @identifier.blank?
-            # Get the default flags for the current environment
-            flags = $flagsmith.get_environment_flags
-            @show_button = flags.is_feature_enabled("secret_button")
-            @button_data = JSON.parse(flags.get_feature_value("secret_button"))["colour"]
-          else
-            trait_key = params.get(:flagsmith, :trait_key)
-            trait_value = params.get(:flagsmith, :trait_value)
-            traits = trait_key.nil? ? nil : { trait_key: trait_value }
-
-            # Get the flags for an identity, including the provided trait which will be
-            # persisted to the API for future requests.
-            identity_flags = $flagsmith.get_identity_flags(identifier, traits)
-            @show_button = identity_flags.is_feature_enabled('secret_button')
-            @button_color = JSON.parse(identity_flags.get_feature_value('secret_button'))['colour']
-          end
-        end
-      end
-    end
-  end
-end

data/example/apps/web/templates/application.html.slim

@@ -1,7 +0,0 @@
-doctype html
-html
-  head
-    title Flagsmith Example
-  body
-    main[style="max-width: 768px; margin: auto; text-align: center"]
-      = yield

data/example/apps/web/templates/home/index.html.slim

@@ -1,10 +0,0 @@
-p
-  ' Hello,
-  = (identifier.nil? || identifier.blank?) ? 'World' : identifier
-
-= if show_button
-  button[style="background-color: #{button_color}"] A secret button
-
-p
-
-= form

data/example/apps/web/views/application_layout.rb

@@ -1,7 +0,0 @@
-module Web
-  module Views
-    class ApplicationLayout
-      include Web::Layout
-    end
-  end
-end

data/example/apps/web/views/home/index.rb

@@ -1,29 +0,0 @@
-module Web
-  module Views
-    module Home
-      class Index
-        include Web::View
-
-        def form
-          form_for :flagsmith, '/', method: :get do
-            h3 'Identify as a User'
-            div style: 'margin-bottom: 1em;' do
-              label :identifier
-              text_field :identifier
-            end
-            p '... with an optional user trait'
-            div style: 'margin-bottom: 1em;' do
-              label :trait_key
-              text_field :trait_key
-            end
-            div style: 'margin-bottom: 1em;' do
-              label :trait_value
-              text_field :trait_value
-            end
-            div { submit 'Identify!' }
-          end
-        end
-      end
-    end
-  end
-end

data/example/config/boot.rb

@@ -1,2 +0,0 @@
-require_relative './environment'
-Hanami.boot

data/example/config/environment.rb

@@ -1,17 +0,0 @@
-require 'bundler/setup'
-require 'hanami/setup'
-require 'hanami/model'
-require_relative '../apps/web/application'
-
-Hanami.configure do
-  mount Web::Application, at: '/'
-
-  model do
-    adapter :sql, ENV.fetch('DATABASE_URL')
-  end
-
-  environment :development do
-    # See: https://guides.hanamirb.org/projects/logging
-    logger level: :debug
-  end
-end

data/example/config/initializers/flagsmith.rb

@@ -1,7 +0,0 @@
-$flagsmith = Flagsmith::Client.new(
-  enable_local_evaluation: true,
-  environment_refresh_interval_seconds: 60,
-  default_flag_handler: lambda { |feature_name|
-    Flagsmith::Flags::DefaultFlag.new(enabled: false, value: {}.to_json)
-  }
-)

data/example/config/puma.rb

@@ -1,15 +0,0 @@
-require_relative './environment'
-workers 1
-
-threads_count = 1
-threads threads_count, threads_count
-
-preload_app!
-
-rackup      DefaultRackup
-port        2300
-environment 'development'
-
-on_worker_boot do
-  Hanami.boot
-end

data/example/config.ru

@@ -1,3 +0,0 @@
-require_relative 'config/environment'
-
-run Hanami.app

data/example/spec/features_helper.rb

@@ -1,12 +0,0 @@
-# Require this file for feature tests
-require_relative './spec_helper'
-
-require 'capybara'
-require 'capybara/rspec'
-
-RSpec.configure do |config|
-  config.include RSpec::FeatureExampleGroup
-
-  config.include Capybara::DSL,           feature: true
-  config.include Capybara::RSpecMatchers, feature: true
-end

data/example/spec/spec_helper.rb

@@ -1,103 +0,0 @@
-# Require this file for unit tests
-ENV['HANAMI_ENV'] ||= 'test'
-
-require_relative '../config/environment'
-Hanami.boot
-Hanami::Utils.require!("#{__dir__}/support")
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Allows RSpec to persist some state between runs in order to support
-  # the `--only-failures` and `--next-failure` CLI options. We recommend
-  # you configure your source control system to ignore this file.
-  config.example_status_persistence_file_path = "spec/examples.txt"
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in many cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = false
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-end

data/example/spec/support/capybara.rb

@@ -1,8 +0,0 @@
-module RSpec
-  module FeatureExampleGroup
-    def self.included(group)
-      group.metadata[:type] = :feature
-      Capybara.app = Hanami.app
-    end
-  end
-end

data/example/spec/web/controllers/home/index_spec.rb

@@ -1,9 +0,0 @@
-RSpec.describe Web::Controllers::Home::Index, type: :action do
-  let(:action) { described_class.new }
-  let(:params) { Hash[] }
-
-  it 'is successful' do
-    response = action.call(params)
-    expect(response[0]).to eq 200
-  end
-end

data/example/spec/web/views/application_layout_spec.rb

@@ -1,10 +0,0 @@
-require "spec_helper"
-
-RSpec.describe Web::Views::ApplicationLayout, type: :view do
-  let(:layout)   { Web::Views::ApplicationLayout.new({ format: :html }, "contents") }
-  let(:rendered) { layout.render }
-
-  it 'contains application name' do
-    expect(rendered).to include('Web')
-  end
-end

data/example/spec/web/views/home/index_spec.rb

@@ -1,10 +0,0 @@
-RSpec.describe Web::Views::Home::Index, type: :view do
-  let(:exposures) { Hash[format: :html] }
-  let(:template)  { Hanami::View::Template.new('apps/web/templates/home/index.html.slim') }
-  let(:view)      { described_class.new(template, exposures) }
-  let(:rendered)  { view.render }
-
-  it 'exposes #format' do
-    expect(view.format).to eq exposures.fetch(:format)
-  end
-end