flagsmith 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 963916124a96866380ffb9defdda64421c2205e28f46a2dfe0fdecbb1c068989
-  data.tar.gz: 97ecf1f596db52665c0c69d46df178ab47223c7eede56e6a2c2da222b2d760e2
+  metadata.gz: 18c4f2e2e68aaffe9c18d2b1e2af5f0018695ecc17c5af3a94051c8bf4cde1b8
+  data.tar.gz: 53e41364ca7a0347f0358d80616c4781f81835bff43b8f2aedc15d5fa53bb77d
 SHA512:
-  metadata.gz: 73dd7ed243d419f59259c04edc73fde2e8a6bd915da45e2ac2db1c5ff802771e1ab59669a718f0e0af36cf2ff3f33206625785a52268e50fdc96cc9440537027
-  data.tar.gz: 33248a4a9343cb15898d4db5821260f83c1d3ec4fed858cb7adbf612e6c0c355ccbe1e68b4e1f0861fe5fdd72d48ce9713bee4b12127d9bfb5d89e6a3b812888
+  metadata.gz: 3da8964610c7fa4dbd31b94fdbc74b323711b49a4b9be7ad6f92738fc4c9b38e9a69f6a97c1875b78d6ccb86283325cc579b3f16d8b7d97e3b23eab89e8f8c1d
+  data.tar.gz: c464168ac8cfaff3611e95503b291b4e136e9bc944549b8ad66689232e0ef7411c2074781fbb8f7fd92bdb80775b3317400eb101f8c95bd83bb4d94206891033

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    flagsmith (3.0.1)
+    flagsmith (3.1.0)
       faraday
       faraday-retry
       faraday_middleware
@@ -40,7 +40,7 @@ GEM
       faraday (~> 1.0)
     gem-release (2.2.0)
     method_source (1.0.0)
-    multipart-post (2.2.0)
+    multipart-post (2.2.3)
     parallel (1.20.1)
     parser (3.0.0.0)
       ast (~> 2.4.1)
@@ -50,7 +50,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.0.3)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)

data/README.md

@@ -6,7 +6,7 @@ The SDK clients for Ruby [https://www.flagsmith.com/](https://www.flagsmith.com/
 
 ## Adding to your project
 
-For full documentation visit [https://docs.flagsmith.com/clients/ruby/](https://docs.flagsmith.com/clients/ruby/)
+For full documentation visit [https://docs.flagsmith.com/clients/server-side](https://docs.flagsmith.com/clients/server-side).
 
 ## Contributing
 

data/example/Gemfile.lock

@@ -172,7 +172,7 @@ GEM
     public_suffix (4.0.7)
     puma (5.6.4)
       nio4r (~> 2.0)
-    rack (2.2.3)
+    rack (2.2.3.1)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rainbow (3.1.1)

data/flagsmith.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/flagsmith/version', __dir__)
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.4.0'
+  spec.name = 'flagsmith'
+  spec.version = Flagsmith::VERSION
+  spec.authors = ['Tom Stuart', 'Brian Moelk']
+  spec.email = ['tom@solidstategroup.com', 'bmoelk@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
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.summary = 'Flagsmith - Ship features with confidence'
+  spec.description = 'Ruby Client for Flagsmith. Ship features with confidence using feature flags and remote config. Host yourself or use our hosted version at https://flagsmith.com'
+  spec.homepage = 'https://flagsmith.com'
+
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'gem-release'
+  spec.add_development_dependency 'pry'
+  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-retry'
+  spec.add_dependency 'semantic'
+end

data/lib/flagsmith/engine/core.rb

@@ -15,7 +15,7 @@ require_relative 'utils/hash_func'
 module Flagsmith
   module Engine
     # Flags engine methods
-    module Core
+    class Engine
       include Flagsmith::Engine::Segments::Evaluator
 
       def get_identity_feature_state(environment, identity, feature_name, override_traits = nil)

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

@@ -22,6 +22,9 @@ module Flagsmith
         NOT_EQUAL = 'NOT_EQUAL'
         REGEX = 'REGEX'
         PERCENTAGE_SPLIT = 'PERCENTAGE_SPLIT'
+        IS_SET = 'IS_SET'
+        IS_NOT_SET = 'IS_NOT_SET'
+        MODULO = 'MODULO'
 
         CONDITION_OPERATORS = [
           EQUAL,
@@ -33,7 +36,8 @@ module Flagsmith
           NOT_CONTAINS,
           NOT_EQUAL,
           REGEX,
-          PERCENTAGE_SPLIT
+          PERCENTAGE_SPLIT,
+          MODULO
         ].freeze
       end
     end

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

@@ -56,12 +56,24 @@ module Flagsmith
             return hashed_percentage_for_object_ids([segment_id, identity_id]) <= condition.value.to_f
           end
 
-          trait = identity_traits.find { |t| t.key == condition.property }
+          trait = identity_traits.find { |t| t.key.to_s == condition.property }
 
-          return condition.match_trait_value?(trait.value) if trait
+          if [IS_SET, IS_NOT_SET].include?(condition.operator)
+            return handle_trait_existence_conditions(trait, condition.operator)
+          end
+
+          return condition.match_trait_value?(trait.trait_value) if trait
 
           false
         end
+
+        private
+
+        def handle_trait_existence_conditions(matching_trait, operator)
+          return operator == IS_NOT_SET if matching_trait.nil?
+
+          operator == IS_SET
+        end
       end
     end
   end

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

@@ -55,10 +55,13 @@ module Flagsmith
         end
 
         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
 
+          return match_modulo_value(trait_value) if @operator == MODULO
+
           type_as_trait_value = format_to_type_of(trait_value)
           formatted_value = type_as_trait_value ? type_as_trait_value.call(@value) : @value
 
@@ -78,6 +81,13 @@ module Flagsmith
         end
         # rubocop:enable Metrics/AbcSize
 
+        def match_modulo_value(trait_value)
+          divisor, remainder = @value.split('|')
+          trait_value.is_a?(Numeric) && trait_value % divisor.to_f == remainder.to_f
+        rescue StandardError
+          false
+        end
+
         class << self
           def build(json)
             new(**json.slice(:operator, :value).merge(property: json[:property_]))

data/lib/flagsmith/sdk/analytics_processor.rb

@@ -31,8 +31,8 @@ module Flagsmith
       @last_flushed = Time.now
     end
 
-    def track_feature(feature_id)
-      @analytics_data[feature_id] = @analytics_data.fetch(feature_id, 0) + 1
+    def track_feature(feature_name)
+      @analytics_data[feature_name] = @analytics_data.fetch(feature_name, 0) + 1
       flush if (Time.now - @last_flushed) > TIMER * 1000
     end
   end

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

@@ -122,7 +122,7 @@ module Flagsmith
       def get_flag(feature_name)
         key = Flagsmith::Flags::Collection.normalize_key(feature_name)
         flag = flags.fetch(key)
-        @analytics_processor.track_feature(flag.feature_id) if @analytics_processor && flag.feature_id
+        @analytics_processor.track_feature(flag.feature_name) if @analytics_processor && flag.feature_id
         flag
       rescue KeyError
         return @default_flag_handler.call(feature_name) if @default_flag_handler

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Flagsmith
+  module Segments
+    class Segment
+      attr_reader :id, :name
+      
+      def initialize(id:, name:)
+        @id = id
+        @name = name
+      end
+    end
+  end
+end

data/lib/flagsmith/version.rb

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

data/lib/flagsmith.rb

@@ -15,7 +15,7 @@ require 'flagsmith/sdk/errors'
 require 'flagsmith/sdk/intervals'
 require 'flagsmith/sdk/pooling_manager'
 require 'flagsmith/sdk/models/flags'
-require 'flagsmith/sdk/instance_methods'
+require 'flagsmith/sdk/models/segments'
 
 require 'flagsmith/engine/core'
 
@@ -24,8 +24,6 @@ module Flagsmith
   # Ruby client for flagsmith.com
   class Client
     extend Forwardable
-    include Flagsmith::SDK::InstanceMethods
-    include Flagsmith::Engine::Core
     # A Flagsmith client.
     #
     # Provides an interface for interacting with the Flagsmith http API.
@@ -37,9 +35,11 @@ module Flagsmith
     # feature_enabled = environment_flags.is_feature_enabled('foo')
     # feature_value = identity_flags.get_feature_value('foo')
     #
-    # identity_flags = flagsmith.get_identity_flags('identifier', 'foo': 'bar')
+    # identity_flags = flagsmith.get_identity_flags('identifier', {'foo': 'bar'})
     # feature_enabled_for_identity = identity_flags.is_feature_enabled('foo')
     # feature_value_for_identity = identity_flags.get_feature_value('foo')
+    #
+    # identity_segments = flagsmith.get_identity_segments('identifier', {'foo': 'bar'})
 
     # Available Configs.
     #
@@ -58,12 +58,17 @@ module Flagsmith
       api_client
       analytics_processor
       environment_data_polling_manager
+      engine
     end
 
     def api_client
       @api_client ||= Flagsmith::ApiClient.new(@config)
     end
 
+    def engine
+      @engine ||= Flagsmith::Engine::Engine.new
+    end
+
     def analytics_processor
       return nil unless @config.enable_analytics?
 
@@ -94,5 +99,145 @@ module Flagsmith
       environment_data = api_client.get(@config.environment_url).body
       Flagsmith::Engine::Environment.build(environment_data)
     end
+
+    # 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?
+
+      environment_flags_from_api
+    end
+
+    # Get all the flags for the current environment for a given identity. Will also
+    # upsert all traits to the Flagsmith API for future evaluations. Providing a
+    # trait with a value of None will remove the trait from the identity if it exists.
+    #
+    # identifier a unique identifier for the identity in the current
+    # environment, e.g. email address, username, uuid
+    # traits { key => value } is a dictionary of traits to add / update on the identity in
+    # Flagsmith, e.g. { "num_orders": 10 }
+    # returns Flags object holding all the flags for the given identity.
+    def get_identity_flags(identifier, **traits)
+      return get_identity_flags_from_document(identifier, traits) if environment
+
+      get_identity_flags_from_api(identifier, traits)
+    end
+
+    def feature_enabled?(feature_name, default: false)
+      flag = get_environment_flags[feature_name]
+      return default if flag.nil?
+
+      flag.enabled?
+    end
+
+    def feature_enabled_for_identity?(feature_name, user_id, default: false)
+      flag = get_identity_flags(user_id)[feature_name]
+      return default if flag.nil?
+
+      flag.enabled?
+    end
+
+    def get_value(feature_name, default: nil)
+      flag = get_environment_flags[feature_name]
+      return default if flag.nil?
+
+      flag.value
+    end
+
+    def get_value_for_identity(feature_name, user_id = nil, default: nil)
+      flag = get_identity_flags(user_id)[feature_name]
+      return default if flag.nil?
+
+      flag.value
+    end
+
+    def get_identity_segments(identifier, traits = {})
+      unless environment
+        raise Flagsmith::ClientError, 
+          'Local evaluation 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
+    end
+
+    private
+
+    def environment_flags_from_document
+      Flagsmith::Flags::Collection.from_feature_state_models(
+        engine.get_environment_feature_states(environment),
+        analytics_processor: analytics_processor,
+        default_flag_handler: default_flag_handler
+      )
+    end
+
+    def get_identity_flags_from_document(identifier, traits = {})
+      identity_model = build_identity_model(identifier, traits)
+
+      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
+      )
+    end
+
+    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
+        )
+      end
+    end
+
+    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
+        )
+      end
+    end
+
+    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
+    end
+
+    def build_identity_model(identifier, traits = {})
+      unless environment
+        raise Flagsmith::ClientError,
+              'Unable to build 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
+      Flagsmith::Engine::Identity.new(
+        identity_traits: trait_models, environment_api_key: environment_key, identifier: identifier
+      )
+    end
+
+    def generate_identities_data(identifier, traits = {})
+      {
+        identifier: identifier,
+        traits: traits.map { |key, value| { trait_key: key, trait_value: value } }
+      }
+    end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: flagsmith
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Tom Stuart
 - Brian Moelk
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,6 +204,7 @@ files:
 - 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
 - lib/flagsmith/engine/environments/models.rb
@@ -220,15 +221,15 @@ files:
 - lib/flagsmith/sdk/api_client.rb
 - lib/flagsmith/sdk/config.rb
 - lib/flagsmith/sdk/errors.rb
-- lib/flagsmith/sdk/instance_methods.rb
 - lib/flagsmith/sdk/intervals.rb
 - lib/flagsmith/sdk/models/flags.rb
+- lib/flagsmith/sdk/models/segments.rb
 - lib/flagsmith/sdk/pooling_manager.rb
 - lib/flagsmith/version.rb
 homepage: https://flagsmith.com
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -243,8 +244,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Flagsmith - Ship features with confidence
 test_files: []

data/lib/flagsmith/sdk/instance_methods.rb

@@ -1,137 +0,0 @@
-# frozen_string_literal: true
-
-module Flagsmith
-  module SDK
-    # Available Flagsmith Functions
-    module InstanceMethods
-      # 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?
-
-        environment_flags_from_api
-      end
-
-      # Get all the flags for the current environment for a given identity. Will also
-      # upsert all traits to the Flagsmith API for future evaluations. Providing a
-      # trait with a value of None will remove the trait from the identity if it exists.
-      #
-      # identifier a unique identifier for the identity in the current
-      # environment, e.g. email address, username, uuid
-      # traits { key => value } is a dictionary of traits to add / update on the identity in
-      # Flagsmith, e.g. { "num_orders": 10 }
-      # returns Flags object holding all the flags for the given identity.
-      def get_identity_flags(identifier, **traits)
-        return get_identity_flags_from_document(identifier, traits) if environment
-
-        get_identity_flags_from_api(identifier, traits)
-      end
-
-      def feature_enabled?(feature_name, default: false)
-        flag = get_environment_flags[feature_name]
-        return default if flag.nil?
-
-        flag.enabled?
-      end
-
-      def feature_enabled_for_identity?(feature_name, user_id, default: false)
-        flag = get_identity_flags(user_id)[feature_name]
-        return default if flag.nil?
-
-        flag.enabled?
-      end
-
-      def get_value(feature_name, default: nil)
-        flag = get_environment_flags[feature_name]
-        return default if flag.nil?
-
-        flag.value
-      end
-
-      def get_value_for_identity(feature_name, user_id = nil, default: nil)
-        flag = get_identity_flags(user_id)[feature_name]
-        return default if flag.nil?
-
-        flag.value
-      end
-
-      private
-
-      def environment_flags_from_document
-        Flagsmith::Flags::Collection.from_feature_state_models(
-          get_environment_feature_states(environment),
-          analytics_processor: analytics_processor,
-          default_flag_handler: default_flag_handler
-        )
-      end
-
-      def get_identity_flags_from_document(identifier, traits = {})
-        identity_model = build_identity_model(identifier, traits)
-
-        Flagsmith::Flags::Collection.from_feature_state_models(
-          get_identity_feature_states(environment, identity_model),
-          analytics_processor: analytics_processor,
-          default_flag_handler: default_flag_handler
-        )
-      end
-
-      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
-          )
-        end
-      end
-
-      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
-          )
-        end
-      end
-
-      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
-      end
-
-      def build_identity_model(identifier, traits = {})
-        unless environment
-          raise Flagsmith::ClientError,
-                'Unable to build 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
-        Flagsmith::Engine::Identity.new(
-          identity_traits: trait_models, environment_api_key: environment_key, identifier: identifier
-        )
-      end
-
-      def generate_identities_data(identifier, traits = {})
-        {
-          identifier: identifier,
-          traits: traits.map { |key, value| { trait_key: key, trait_value: value } }
-        }
-      end
-    end
-  end
-end