flagsmith 2.0.0 → 3.0.0

data/lib/flagsmith.rb

@@ -1,121 +1,99 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday/retry'
 require 'faraday_middleware'
 
-# Ruby client for flagsmith.com
-class Flagsmith
-  attr_reader :flagsmith_api
-
-  def initialize(opts = {})
-    @opts = determine_opts(opts)
-
-    @flagsmith_api = Faraday.new(url: @opts[:url]) do |faraday|
-      faraday.headers['Accept'] = 'application/json'
-      faraday.headers['Content-Type'] = 'application/json'
-      faraday.headers['x-environment-key'] = @opts[:api_key]
-      faraday.response :json
-      # TODO: add timeout adjustment here
-      faraday.adapter Faraday.default_adapter
+# Hash#slice was added in ruby version 2.5
+# This is the patch to use slice in earler versions
+require 'flagsmith/hash_slice'
+
+require 'flagsmith/sdk/analytics_processor'
+require 'flagsmith/sdk/api_client'
+require 'flagsmith/sdk/config'
+require 'flagsmith/sdk/errors'
+require 'flagsmith/sdk/intervals'
+require 'flagsmith/sdk/pooling_manager'
+require 'flagsmith/sdk/models/flag'
+require 'flagsmith/sdk/models/flags/collection'
+require 'flagsmith/sdk/instance_methods'
+
+require 'flagsmith/engine/core'
+
+# no-doc
+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.
+    # Basic Usage::
+    #
+    # flagsmith = Flagsmith::Client.new(environment_key: '<your API key>')
+    #
+    # environment_flags = flagsmith.get_environment_flags
+    # 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')
+    # feature_enabled_for_identity = identity_flags.is_feature_enabled('foo')
+    # feature_value_for_identity = identity_flags.get_feature_value('foo')
+
+    # Available Configs.
+    #
+    # :environment_key, :api_url, :custom_headers, :request_timeout_seconds, :enable_local_evaluation,
+    # :environment_refresh_interval_seconds, :retries, :enable_analytics, :default_flag_handler
+    # You can see full description in the Flagsmith::Config
+
+    attr_reader :config, :environment
+
+    delegate Flagsmith::Config::OPTIONS => :@config
+
+    def initialize(config)
+      @_mutex = Mutex.new
+      @config = Flagsmith::Config.new(config)
+
+      api_client
+      analytics_processor
+      environment_data_polling_manager
     end
-  end
 
-  def get_flags(user_id = nil)
-    if user_id.nil?
-      res = @flagsmith_api.get('flags/')
-      flags = transform_flags(res.body).select { |flag| flag[:segment].nil? }
-      flags_to_hash(flags)
-    else
-      res = @flagsmith_api.get("identities/?identifier=#{user_id}")
-      flags_to_hash(transform_flags(res.body['flags']))
+    def api_client
+      @api_client ||= Flagsmith::ApiClient.new(@config)
     end
-  end
-
-  def feature_enabled?(feature, user_id = nil, default = false)
-    flag = get_flags(user_id)[normalize_key(feature)]
-    return default if flag.nil?
-
-    flag[:enabled]
-  end
-
-  def get_value(key, user_id = nil, default = nil)
-    flag = get_flags(user_id)[normalize_key(key)]
-    return default if flag.nil?
-
-    flag[:value]
-  end
 
-  def set_trait(user_id, trait, value)
-    raise StandardError, 'user_id cannot be nil' if user_id.nil?
+    def analytics_processor
+      return nil unless @config.enable_analytics?
 
-    trait = {
-         identity:    { identifier: user_id },
-        trait_key:    normalize_key(trait),
-      trait_value:    value
-    }
-    res = @flagsmith_api.post('traits/', trait.to_json)
-    res.body
-  end
+      @analytics_processor ||=
+        Flagsmith::AnalyticsProcessor.new(
+          api_client: api_client,
+          timeout: request_timeout_seconds
+        )
+    end
 
-  def get_traits(user_id)
-    return {} if user_id.nil?
+    def environment_data_polling_manager
+      return nil unless @config.local_evaluation?
 
-    res = @flagsmith_api.get("identities/?identifier=#{user_id}")
-    traits_to_hash(res.body)
-  end
+      update_environment
 
-  # def remove_trait(user_id, trait_id)
-  #   # Request URL: https://api.flagsmith.com/api/v1/environments/API_KEY/identities/12345/traits/54321/
-  #   # Request Method: DELETE
-  # end
-
-  def transform_flags(flags)
-    flags.map do |flag|
-      {
-           name:    flag['feature']['name'],
-        enabled:    flag['enabled'],
-          value:    flag['feature_state_value'],
-        segment:    flag['feature_segment']
-      }
+      @environment_data_polling_manager ||= Flagsmith::EnvironmentDataPollingManager.new(
+        self, environment_refresh_interval_seconds
+      ).tap(&:start)
     end
-  end
 
-  def flags_to_hash(flags)
-    result = {}
-    flags.each do |flag|
-      key = normalize_key(flag.delete(:name))
-      result[key] = flag
+    # Updates the environment state for local flag evaluation.
+    # You only need to call this if you wish to bypass environment_refresh_interval_seconds.
+    def update_environment
+      @_mutex.synchronize { @environment = environment_from_api }
     end
-    result
-  end
 
-  def traits_to_hash(user_flags)
-    result = {}
-    user_flags['traits']&.each do |t|
-      key = normalize_key(t['trait_key'])
-      result[key] = t['trait_value']
+    def environment_from_api
+      environment_data = api_client.get(@config.environment_url).body
+      Flagsmith::Engine::Environment.build(environment_data)
     end
-    result
-  end
-
-  def normalize_key(key)
-    key.to_s.downcase
-  end
-
-  def determine_opts(opts)
-    opts = { api_key: opts } if opts.is_a? String
-
-    {
-      api_key: opts[:api_key] || self.class.api_key,
-          url: opts[:url] || self.class.api_url
-    }
-  end
-
-  def self.api_key
-    ENV['FLAGSMITH_API_KEY']
-  end
-
-  def self.api_url
-    ENV.fetch('FLAGSMITH_URL', 'https://api.flagsmith.com/api/v1/')
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: flagsmith
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Tom Stuart
 - Brian Moelk
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2021-01-04 00:00:00.000000000 Z
+date: 2022-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +123,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: semantic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 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
 email:
@@ -118,16 +160,72 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - LICENCE
 - README.md
 - Rakefile
-- flagsmith.gemspec
+- 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
 - lib/flagsmith.rb
+- lib/flagsmith/engine/core.rb
+- lib/flagsmith/engine/environments/models.rb
+- lib/flagsmith/engine/features/models.rb
+- lib/flagsmith/engine/identities/models.rb
+- lib/flagsmith/engine/organisations/models.rb
+- lib/flagsmith/engine/projects/models.rb
+- lib/flagsmith/engine/segments/constants.rb
+- lib/flagsmith/engine/segments/evaluator.rb
+- lib/flagsmith/engine/segments/models.rb
+- lib/flagsmith/engine/utils/hash_func.rb
+- lib/flagsmith/hash_slice.rb
+- lib/flagsmith/sdk/analytics_processor.rb
+- 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/flag.rb
+- lib/flagsmith/sdk/models/flags/collection.rb
+- lib/flagsmith/sdk/pooling_manager.rb
+- lib/flagsmith/version.rb
 homepage: https://flagsmith.com
 licenses: []
 metadata: {}
@@ -146,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Flagsmith - Ship features with confidence

data/.gitignore

@@ -1,57 +0,0 @@
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc

data/flagsmith.gemspec

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-Gem::Specification.new do |spec|
-  spec.required_ruby_version = '>= 2.4.0'
-  spec.name = 'flagsmith'
-  spec.version = '2.0.0'
-  spec.authors = ['Tom Stuart', 'Brian Moelk']
-  spec.email = ['tom@solidstategroup.com', 'bmoelk@gmail.com']
-  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-
-  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.add_development_dependency 'bundler'
-  spec.add_development_dependency 'gem-release'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday_middleware'
-end