rox-rollout 4.7.1 → 5.0.2

data/lib/rox/server/flags/server_entities_provider.rb

@@ -1,5 +1,7 @@
 require 'rox/server/flags/rox_flag'
-require 'rox/server/flags/rox_variant'
+require 'rox/server/flags/rox_string'
+require 'rox/server/flags/rox_int'
+require 'rox/server/flags/rox_double'
 
 module Rox
   module Server
@@ -8,9 +10,17 @@ module Rox
         Rox::Server::RoxFlag.new(default_value)
       end
 
-      def create_variant(default_value, options)
-        Rox::Server::RoxVariant.new(default_value, options)
+      def create_string(default_value, options)
+        Rox::Server::RoxString.new(default_value, options)
+      end
+
+      def create_int(default_value, options)
+        Rox::Server::RoxInt.new(default_value, options)
+      end
+
+      def create_double(default_value, options)
+        Rox::Server::RoxDouble.new(default_value, options)
       end
     end
   end
-end
+end

data/lib/rox/server/logging/server_logger.rb

@@ -4,7 +4,7 @@ module Rox
   module Server
     class ServerLogger
       def initialize
-        @logger = Logger.new(STDOUT)
+        @logger = Logger.new($stdout)
       end
 
       def debug(message, ex = nil)
@@ -32,4 +32,4 @@ module Rox
       end
     end
   end
-end
+end

data/lib/rox/server/rox_options.rb

@@ -3,25 +3,56 @@ require 'rox/server/logging/server_logger'
 
 module Rox
   module Server
+    class SelfManagedOptions
+      attr_reader :server_url, :analytics_url
+
+      def initialize(server_url:, analytics_url:)
+        @server_url = server_url
+        @analytics_url = analytics_url
+      end
+    end
+
     class RoxOptions
-      attr_accessor :dev_mode_key, :version, :fetch_interval, :logger, :impression_handler, :configuration_fetched_handler, :roxy_url
+      attr_reader :dev_mode_key, :version, :fetch_interval,
+                  :logger, :impression_handler,
+                  :configuration_fetched_handler,
+                  :roxy_url, :self_managed_options,
+                  :dynamic_property_rule_handler
 
-      def initialize(dev_mode_key: nil, version: nil, fetch_interval: nil, logger: nil, impression_handler: nil, configuration_fetched_handler: nil, roxy_url: nil)
+      def initialize(
+        dev_mode_key: nil,
+        version: nil,
+        fetch_interval: nil,
+        logger: nil,
+        impression_handler: nil,
+        configuration_fetched_handler: nil,
+        roxy_url: nil,
+        self_managed_options: nil,
+        dynamic_property_rule_handler: nil
+      )
         @dev_mode_key = dev_mode_key || 'stam'
         @version = version || '0.0'
 
-        if fetch_interval.nil?
-          @fetch_interval = 60
-        else
-          @fetch_interval = fetch_interval < 30 ? 30 : fetch_interval
-        end
+        @fetch_interval = if fetch_interval.nil?
+                            60
+                          else
+                            [fetch_interval, 30].max
+                          end
 
         Rox::Core::Logging.logger = logger || ServerLogger.new
 
         @impression_handler = impression_handler
         @configuration_fetched_handler = configuration_fetched_handler
         @roxy_url = roxy_url
+        @self_managed_options = self_managed_options
+        @dynamic_property_rule_handler = dynamic_property_rule_handler || proc do |prop_name, context|
+          context ? context[prop_name] : nil
+        end
+      end
+
+      def self_managed?
+        !@self_managed_options.nil?
       end
     end
   end
-end
+end

data/lib/rox/server/rox_server.rb

@@ -4,85 +4,110 @@ require 'rox/core/logging/logging'
 require 'rox/server/rox_options'
 require 'rox/server/client/sdk_settings'
 require 'rox/server/client/server_properties'
-require 'rox/core/properties/device_property'
-require 'rox/core/properties/custom_property'
-require 'rox/core/properties/custom_property_type'
-require 'rox/core/consts/property_type'
 require 'rox/server/flags/server_entities_provider'
-
+require 'rox/core/properties/property_factory'
 
 module Rox
   module Server
     class RoxServer
       @core = Rox::Core::Core.new
 
-      def self.setup(api_key, rox_options = nil)
-        rox_options = RoxOptions.new if rox_options.nil?
-
-        sdk_settings = SdkSettings.new(api_key, rox_options.dev_mode_key)
-        server_properties = ServerProperties.new(sdk_settings, rox_options)
-
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new(Rox::Core::PropertyType::PLATFORM.name, Rox::Core::CustomPropertyType::STRING, server_properties.all_properties[Rox::Core::PropertyType::PLATFORM.name]))
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new(Rox::Core::PropertyType::APP_RELEASE.name, Rox::Core::CustomPropertyType::SEMVER, server_properties.all_properties[Rox::Core::PropertyType::APP_RELEASE.name]))
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new(Rox::Core::PropertyType::DISTINCT_ID.name, Rox::Core::CustomPropertyType::STRING) {|_| SecureRandom.uuid})
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new('internal.realPlatform', Rox::Core::CustomPropertyType::STRING, server_properties.all_properties[Rox::Core::PropertyType::PLATFORM.name]))
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new('internal.customPlatform', Rox::Core::CustomPropertyType::STRING, server_properties.all_properties[Rox::Core::PropertyType::PLATFORM.name]))
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new('internal.appKey', Rox::Core::CustomPropertyType::STRING, server_properties.rollout_key))
-        @core.add_custom_property_if_not_exists(Rox::Core::DeviceProperty.new("internal.#{Rox::Core::PropertyType::DISTINCT_ID.name}", Rox::Core::CustomPropertyType::STRING) {|_| SecureRandom.uuid})
-
-        Thread.new do
-          Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception)
-          begin
-            @core.setup(sdk_settings, server_properties, rox_options).join
-          rescue StandardError => ex
-            Rox::Core::Logging.logger.error('Failed in Rox.setup', ex)
+      class << self
+        def setup(api_key, rox_options = nil)
+          validate_api_key(api_key)
+
+          rox_options = Rox::Server::RoxOptions.new if rox_options.nil?
+          sdk_settings = Rox::Server::SdkSettings.new(api_key, rox_options.dev_mode_key)
+          server_properties = Rox::Server::ServerProperties.new(sdk_settings, rox_options)
+
+          RoxServer.add_custom_properties(Rox::Core::PropertyFactory.new(server_properties))
+
+          @@thread = Thread.new do
+            Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception)
+            @core.setup(sdk_settings, server_properties).join
           end
         end
-      rescue StandardError => ex
-        Rox::Core::Logging.logger.error('Failed in Rox.setup', ex)
-      end
 
-      def self.register(namespace, rox_container)
-        @core.register(namespace, rox_container)
-      end
+        def shutdown
+          return if !defined?(@@thread) || @@thread.nil?
 
-      def self.context=(context)
-        @core.context = context
-      end
+          Thread.kill(@@thread)
+          @core.shutdown
+        end
 
-      def self.fetch
-        Thread.new do
-          Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception)
-          begin
-            @core.fetch.join
-          rescue StandardError => ex
-            Rox::Core::Logging.logger.error('Failed in Rox.fetch', ex)
+        def add_custom_properties(property_factory)
+          property_factory.all_properties.each do |property|
+            @core.add_custom_property_if_not_exists(property)
           end
         end
-      end
 
-      def self.set_custom_string_property(name, value = nil, &block)
-        @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::STRING, value, &block))
-      end
+        def register(rox_container)
+          @core.register(rox_container)
+        end
 
-      def self.set_custom_boolean_property(name, value = nil, &block)
-        @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::BOOL, value, &block))
-      end
+        def register_with_namespace(namespace, rox_container)
+          @core.register_with_namespace(namespace, rox_container)
+        end
 
-      def self.set_custom_int_property(name, value = nil, &block)
-        @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::INT, value, &block))
-      end
+        def use_userspace_unhandled_error_handler(&handler)
+          @core.userspace_unhandled_error_handler = handler
+        end
 
-      def self.set_custom_float_property(name, value = nil, &block)
-        @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::FLOAT, value, &block))
-      end
+        def context=(context)
+          @core.context = context
+        end
 
-      def self.set_custom_semver_property(name, value = nil, &block)
-        @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::SEMVER, value, &block))
-      end
+        def fetch
+          Thread.new do
+            Thread.current.report_on_exception = false if Thread.current.respond_to?(:report_on_exception)
+            begin
+              @core.fetch.join
+            rescue StandardError => e
+              Rox::Core::Logging.logger.error('Failed in Rox.fetch', e)
+            end
+          end
+        end
+
+        def set_custom_string_property(name, value = nil, &block)
+          @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::STRING, value,
+                                                                  &block))
+        end
+
+        def set_custom_boolean_property(name, value = nil, &block)
+          @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::BOOL, value,
+                                                                  &block))
+        end
+
+        def set_custom_int_property(name, value = nil, &block)
+          @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::INT, value,
+                                                                  &block))
+        end
+
+        def set_custom_float_property(name, value = nil, &block)
+          @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::FLOAT, value,
+                                                                  &block))
+        end
 
-      def self.dynamic_api
-        @core.dynamic_api(Rox::Server::ServerEntitiesProvider.new)
+        def set_custom_semver_property(name, value = nil, &block)
+          @core.add_custom_property(Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::SEMVER, value,
+                                                                  &block))
+        end
+
+        def dynamic_api
+          @core.dynamic_api(Rox::Server::ServerEntitiesProvider.new)
+        end
+
+        def dump_state
+          @core.dump_state
+        end
+
+        private
+
+        def validate_api_key(api_key)
+          raise ArgumentError, 'api_key is not valid' if (api_key =~ /^[a-f\d]{24}$/).nil?
+
+          true
+        end
       end
     end
   end

data/lib/rox/version.rb

@@ -1,3 +1,3 @@
 module Rox
-  VERSION = "4.7.1"
+  VERSION = '5.0.2'.freeze
 end

data/rox.gemspec

@@ -1,20 +1,19 @@
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rox/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'rox-rollout'
   spec.version       = Rox::VERSION
-  spec.authors       = ['Rollout.io']
+  spec.authors       = ['CloudBees']
   spec.email         = ['support@rollout.io']
-  spec.summary       = 'Rollout.io ROX Ruby SDK'
-  spec.homepage      = "https://github.com/rollout/rox-ruby"
+  spec.summary       = 'Feature Management ROX Ruby SDK'
+  spec.homepage      = 'https://github.com/rollout/rox-ruby'
   spec.license       = 'Nonstandard'
 
   # 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(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'
@@ -23,11 +22,14 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_runtime_dependency 'em-eventsource', '~> 0.3.0'
+  spec.add_runtime_dependency 'em-eventsource', '~> 0.3.2'
+  spec.add_runtime_dependency 'analytics-ruby', '~> 2.0.0'
+
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'bundler', '~> 2.2.3'
   spec.add_development_dependency 'minitest', '~> 5.11'
-  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'pry-byebug', '~> 3.7.0'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rubocop', '~> 1.10'
   spec.add_development_dependency 'webmock', '~> 3.7.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rox-rollout
 version: !ruby/object:Gem::Version
-  version: 4.7.1
+  version: 5.0.2
 platform: ruby
 authors:
-- Rollout.io
+- CloudBees
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-eventsource
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: analytics-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +95,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -102,36 +130,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".editorconfig"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- CODEOWNERS
+- ".rubocop.yml"
 - Gemfile
 - LICENSE
-- README_DEVELOP.md
+- README.md
 - Rakefile
-- _archive/.document
-- _archive/.rspec
-- _archive/Gemfile
-- _archive/Gemfile.lock
-- _archive/README.md
-- _archive/README.rdoc
-- _archive/Rakefile
-- _archive/lib/expr_function_definition.rb
-- _archive/lib/function_definition.rb
-- _archive/lib/function_token.rb
-- _archive/lib/object_extends.rb
-- _archive/lib/ruby_interpreter.rb
-- _archive/lib/stack.rb
-- _archive/lib/string_extends.rb
-- _archive/spec/ruby_interpreter_spec.rb
-- _archive/spec/spec_helper.rb
-- _archive/spec/stack_spec.rb
 - bin/console
 - bin/setup
+- e2e-server/run_server.sh
+- e2e-server/server.rb
 - e2e/container.rb
 - e2e/custom_props.rb
 - e2e/rox_e2e_test.rb
 - e2e/test_vars.rb
+- example/local.rb
 - lib/rox.rb
+- lib/rox/core/analytics.rb
 - lib/rox/core/client/buid.rb
 - lib/rox/core/client/device_properties.rb
 - lib/rox/core/client/dynamic_api.rb
@@ -150,9 +167,15 @@ files:
 - lib/rox/core/consts/property_type.rb
 - lib/rox/core/context/merged_context.rb
 - lib/rox/core/core.rb
+- lib/rox/core/entities/default_flag_values.rb
 - lib/rox/core/entities/flag.rb
 - lib/rox/core/entities/flag_setter.rb
-- lib/rox/core/entities/variant.rb
+- lib/rox/core/entities/rox_double.rb
+- lib/rox/core/entities/rox_int.rb
+- lib/rox/core/entities/rox_string.rb
+- lib/rox/core/error_handling/exception_trigger.rb
+- lib/rox/core/error_handling/userspace_handler_exception.rb
+- lib/rox/core/error_handling/userspace_unhandled_error_invoker.rb
 - lib/rox/core/impression/impression_args.rb
 - lib/rox/core/impression/impression_invoker.rb
 - lib/rox/core/impression/models/experiment.rb
@@ -163,6 +186,7 @@ files:
 - lib/rox/core/network/configuration_fetcher.rb
 - lib/rox/core/network/configuration_fetcher_base.rb
 - lib/rox/core/network/configuration_fetcher_roxy.rb
+- lib/rox/core/network/configuration_fetcher_self_managed.rb
 - lib/rox/core/network/configuration_source.rb
 - lib/rox/core/network/request.rb
 - lib/rox/core/network/request_configuration_builder.rb
@@ -173,6 +197,7 @@ files:
 - lib/rox/core/properties/custom_property.rb
 - lib/rox/core/properties/custom_property_type.rb
 - lib/rox/core/properties/device_property.rb
+- lib/rox/core/properties/property_factory.rb
 - lib/rox/core/register/registerer.rb
 - lib/rox/core/reporting/error_reporter.rb
 - lib/rox/core/repositories/custom_property_repository.rb
@@ -192,13 +217,17 @@ files:
 - lib/rox/core/roxx/tokenized_expression.rb
 - lib/rox/core/roxx/value_compare_extensions.rb
 - lib/rox/core/security/signature_verifier.rb
+- lib/rox/core/security/signature_verifier_mock.rb
 - lib/rox/core/utils/debouncer.rb
 - lib/rox/core/utils/periodic_task.rb
 - lib/rox/core/utils/type_utils.rb
 - lib/rox/server/client/sdk_settings.rb
 - lib/rox/server/client/server_properties.rb
+- lib/rox/server/flags/normalize_flag_type.rb
+- lib/rox/server/flags/rox_double.rb
 - lib/rox/server/flags/rox_flag.rb
-- lib/rox/server/flags/rox_variant.rb
+- lib/rox/server/flags/rox_int.rb
+- lib/rox/server/flags/rox_string.rb
 - lib/rox/server/flags/server_entities_provider.rb
 - lib/rox/server/logging/server_logger.rb
 - lib/rox/server/rox_options.rb
@@ -224,8 +253,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
-summary: Rollout.io ROX Ruby SDK
+summary: Feature Management ROX Ruby SDK
 test_files: []

data/CODEOWNERS

@@ -1 +0,0 @@
-* @joshpuetz

data/README_DEVELOP.md

@@ -1,25 +0,0 @@
-# Developer Guide
-
-Ruby versions supported: 2.3.x, 2.4.x, 2.5.x, 2.6.x
-
-## Run tests on current Ruby version
-
-```
-// Run unit tests (folder 'tests')
-rake test
-
-// Run E2E tests (folder 'e2e')
-rake e2e
-```
-
-## Publish new version
-
-### Steps
-
-1. Increment version in ```lib/rox/version.rb```, open a PR and wait for CI to clear
-2. Merge to master, wait for CI to clear
-2. Generate the gem package: ```gem build rox.gemspec```
-3. Install gem locally, and test with a sample project
-4. Upload to RubyGems: ```gem push rox-rollout-VERSION.gem```
-5. Update documentation at https://support.rollout.io/docs/ruby-changelog
-6. Celebrate! 🎉

data/_archive/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/_archive/.rspec

@@ -1 +0,0 @@
---color

data/_archive/Gemfile

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem 'pry'
-  gem "rspec", "~> 3.5.0"
-  gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 2.0.1"
-  gem "simplecov", ">= 0"
-end