rox-rollout 5.1.2 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1d81cc04111645ddde18f02d6ae020199aa46082f7dcddd4b193910a5a5d7a3
-  data.tar.gz: eee4b5026bc9b70d828e83eba5677c8d5e5a51c1a7e5926ad5eca12320e2f0f7
+  metadata.gz: 73d64c9e8123a69712c15cada3f6c9b2642c12953a8c25250eb9963d845dae41
+  data.tar.gz: 1e14bc76699a72e0f34dc3a5039025ab184049807b930a2c0fa407915c5380b1
 SHA512:
-  metadata.gz: 522d9dbc4659d022d081c3f067ad0533d0adef2ee50b93e6869e8c5e751e3b67ca8db800917c8c2cee3069aa77b4f5f3ce430f51c195516339f71e42cf24b20f
-  data.tar.gz: 60938d6f6c5b0f0a6934e88e9f4aa40b2f7240d60b2e2647cc71f540dc602f24de1afe9dc3eda5ff65634ad97eda176d5664d03022edd5e51669f6cd5d273f93
+  metadata.gz: a615f9162c302b51d2359d0bc645fa1965a0d28c556678ee7e8a471cc7d1e5cbfef1ca73b06aaaaa91335665c30309286747c31e3930ad4d09fb4547936f1e53
+  data.tar.gz: c92c4de2381d270ab77dfc543efe00eaa0182d217a0e1e792a5934c58d8cf1c9f0e8d22138839dfd3d63c0ca434835cb8eabe28fdc76a3335bb4e7867da09a44

data/.gitignore

@@ -9,3 +9,13 @@
 /tmp/
 Gemfile.lock
 .ruby-version
+
+# E2E test artifacts
+/e2e-logs/
+/sdk-end-2-end-tests/
+/scripts/
+*.gem
+
+# Project memory
+claude.md
+CLAUDE.md

data/Jenkinsfile

@@ -0,0 +1,212 @@
+pipeline {
+    agent any
+
+    libraries {
+        lib('fm-shared-library@main')
+    }//end libraries. Github Repo: https://github.com/rollout/fm-cbci-shared-library
+
+    options {
+        timeout(time: 45, unit: 'MINUTES')
+    }
+
+    stages {
+        stage('Checkout') {
+            steps {
+                checkout scm
+            }
+        }
+
+        stage("Run Unit tests"){
+            parallel {
+                stage("ruby-2.6") {
+                    agent {
+                        kubernetes {
+                            inheritFrom 'ruby'
+                            yamlFile './cbci-templates/sdkci-unit.yml'
+                        }
+                    }
+
+                    steps {
+                        container(name: "ruby-2-6", shell: "sh") {
+                            withCredentials([
+                                sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                            ]) {
+                                echo "Executing Run tests"
+                                sh script: 'gem install bundler -v 2.4.22 && bundle install && bundle exec rake test', 
+                                    label: "Running unit tests"
+                            }
+                        }
+                    }               
+                }
+                stage("ruby-2.7") {
+                    agent {
+                        kubernetes {
+                            inheritFrom 'ruby'
+                            yamlFile './cbci-templates/sdkci-unit.yml'
+                        }
+                    }
+
+                    steps {
+                        container(name: "ruby-2-7", shell: "sh") {
+                            withCredentials([
+                                sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                            ]) {
+                                echo "Executing Run tests"
+                                sh script: 'gem install bundler -v 2.4.22 && bundle install && bundle exec rake test', 
+                                    label: "Running unit tests"
+                            }
+                        }
+                    }               
+                }
+                stage("ruby-3.0") {
+                    agent {
+                        kubernetes {
+                            inheritFrom 'ruby'
+                            yamlFile './cbci-templates/sdkci-unit.yml'
+                        }
+                    }
+
+                    steps {
+                        container(name: "ruby-3-0", shell: "sh") {
+                            withCredentials([
+                                sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                            ]) {
+                                echo "Executing Run tests"
+                                sh script: 'gem install bundler -v 2.4.22 && bundle install && bundle exec rake test', 
+                                    label: "Running unit tests"
+                            }
+                        }
+                    }               
+                }
+                stage("ruby-3.1") {
+                    agent {
+                        kubernetes {
+                            inheritFrom 'ruby'
+                            yamlFile './cbci-templates/sdkci-unit.yml'
+                        }
+                    }
+
+                    steps {
+                        container(name: "ruby-3-1", shell: "sh") {
+                            withCredentials([
+                                sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                            ]) {
+                                echo "Executing Run tests"
+                                sh script: 'gem install bundler -v 2.4.22 && bundle install && bundle exec rake test', 
+                                    label: "Running unit tests"
+                            }
+                        }
+                    }               
+                }
+                stage("ruby-3.2") {
+                    agent {
+                        kubernetes {
+                            inheritFrom 'ruby'
+                            yamlFile './cbci-templates/sdkci-unit.yml'
+                        }
+                    }
+
+                    steps {
+                        container(name: "ruby-3-2", shell: "sh") {
+                            withCredentials([
+                                sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                            ]) {
+                                echo "Executing Run tests"
+                                sh script: 'gem install bundler -v 2.4.22 && bundle install && bundle exec rake test',
+                                    label: "Running unit tests"
+                            }
+                        }
+                    }
+                }
+                stage("ruby-3.3") {
+                    agent {
+                        kubernetes {
+                            inheritFrom 'ruby'
+                            yamlFile './cbci-templates/sdkci-unit.yml'
+                        }
+                    }
+
+                    steps {
+                        container(name: "ruby-3-3", shell: "sh") {
+                            withCredentials([
+                                sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                            ]) {
+                                echo "Executing Run tests"
+                                sh script: 'gem install bundler -v 2.4.22 && bundle install && bundle exec rake test',
+                                    label: "Running unit tests"
+                            }
+                        }
+                    }
+                }
+            }
+            post{
+                success{
+                    script {
+                        echo 'Unit Tests OK; posting results'
+                        currentBuild.result = 'SUCCESS'
+                    }
+                }
+                failure{
+                    echo 'Unit Tests Failed;'
+                }
+            }
+        }
+        stage("Run E2E tests"){
+            agent {
+                kubernetes {
+                    inheritFrom 'default'
+                    yamlFile './cbci-templates/sdkci-e2e.yml'
+                }
+            }
+
+            steps {
+                container("rox-proxy") {
+                    waitForRoxProxy()
+                }
+
+                container(name: "server", shell: 'sh') {
+                    withCredentials([
+                        string(credentialsId: 'TEST_E2E_BEARER', variable: 'TEST_E2E_BEARER'),
+                        sshUserPrivateKey(credentialsId: 'SDK_E2E_SSH_KEY', keyFileVariable: 'SDK_E2E_SSH_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),
+                        sshUserPrivateKey(credentialsId: 'SDK_E2E_TESTS_DEPLOY_KEY', keyFileVariable: 'SDK_E2E_TESTS_DEPLOY_KEY', passphraseVariable: '', usernameVariable: 'cloudbees.eslint@cloudbees.com'),                        
+                    ]) {
+                        script {
+                            addGitHubFingerprint()
+                            TESTENVPARAMS = "QA_E2E_BEARER=$TEST_E2E_BEARER API_HOST=https://api.test.rollout.io CD_API_ENDPOINT=https://api.test.rollout.io/device/get_configuration CD_S3_ENDPOINT=https://rox-conf.test.rollout.io/ SS_API_ENDPOINT=https://api.test.rollout.io/device/update_state_store/ SS_S3_ENDPOINT=https://rox-state.test.rollout.io/ CLIENT_DATA_CACHE_KEY=client_data ANALYTICS_ENDPOINT=https://analytic.test.rollout.io/ NOTIFICATIONS_ENDPOINT=https://push.test.rollout.io/sse"
+                            ROOT_DIR = pwd()
+
+                            withEnv(["GIT_SSH_COMMAND=ssh -i ${SDK_E2E_SSH_KEY}"]) {
+                                echo "Executing E2E tests"
+                                sh script: """
+                                    apt-get update && apt-get install -y curl gnupg
+                                    curl -sL https://deb.nodesource.com/setup_lts.x | bash - 
+                                    apt-get install -y nodejs && npm install -g yarn
+                                    
+                                    git clone git@github.com:rollout/sdk-end-2-end-tests.git
+                                    ln -s ${ROOT_DIR}/e2e-server/ ${ROOT_DIR}/sdk-end-2-end-tests/drivers/ruby
+
+                                    cd ${ROOT_DIR}/sdk-end-2-end-tests/drivers/nodejs && yarn install --frozen-lockfile
+                                    cd ${ROOT_DIR}/sdk-end-2-end-tests && yarn install --frozen-lockfile
+
+                                    ${TESTENVPARAMS} SDK_LANG=ruby NODE_ENV=container yarn test:env
+                                """, label: "Pull SDK end2 tests repository"
+                            }// end withEnv
+                        }
+                    }
+                }
+            }
+            post{
+                success{
+                    script {
+                        echo 'E2E Tests OK; posting results'
+                        currentBuild.result = 'SUCCESS'
+                    }
+                }
+                failure{
+                    echo 'E2E Tests Failed;'
+                }
+        
+            }
+        }
+    }
+}

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/rox-rollout.svg)](https://badge.fury.io/rb/rox-rollout)
 
-Ruby supported versions: 2.3.x, 2.4.x, 2.5.x, 2.6.x
+Ruby supported versions: 2.6, 2.7, 3.0, 3.1, 3.2, 3.3
 
 ## Run tests
 

data/cbci-templates/sdkci-e2e.yml

@@ -0,0 +1,29 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: rox-ruby-sdk-e2e
+spec:
+  serviceAccountName: ops-gcr-rw
+  containers:    
+    - name: server
+      image: ruby:3.2
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+    - name: rox-proxy
+      image: rollout/simple-proxy
+      tty: true
+      ports:
+        - containerPort: 8080
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "1Gi"
+            cpu: "1000m"

data/cbci-templates/sdkci-unit.yml

@@ -0,0 +1,67 @@
+apiVersion: v1
+kind: Pod
+metadata:
+  name: rox-ruby-sdk-unit
+spec:
+  serviceAccountName: ops-gcr-rw
+  containers:    
+    - name: ruby-2-6
+      image: ruby:2.6
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+    - name: ruby-2-7
+      image: ruby:2.7
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+    - name: ruby-3-0
+      image: ruby:3.0
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+    - name: ruby-3-1
+      image: ruby:3.1
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+    - name: ruby-3-2
+      image: ruby:3.2
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"
+    - name: ruby-3-3
+      image: ruby:3.3
+      tty: true
+      resources:
+          requests:
+            memory: "1Gi"
+            cpu: "1000m"
+          limits:
+            memory: "2Gi"
+            cpu: "1000m"

data/e2e-server/run_server.sh

@@ -8,9 +8,11 @@ gem install sinatra --conservative
 gem install sinatra-contrib --conservative
 gem install json --conservative
 gem install em-eventsource --conservative
+gem install rackup
+gem install webrick
 
 nohup ruby ./server.rb $1 1>"$DIR"/log_"$1".out 2>&1 &
 while true ; do
   curl -p http://127.0.0.1:$1/status-check && exit 
   sleep 1
-done
+done

data/examples/simple_example.rb

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Simple example to test Rox SDK with Ruby 3.3
+require 'bundler/setup'
+require 'rox/server/rox_server'
+require 'rox/server/flags/rox_flag'
+require 'rox/server/flags/rox_string'
+
+# Define a container class for flags
+class FeatureFlags
+  attr_reader :enable_tutorial, :color_variant, :timeout_value
+
+  def initialize
+    @enable_tutorial = Rox::Server::RoxFlag.new(false)
+    @color_variant = Rox::Server::RoxString.new('blue', ['red', 'green', 'blue'])
+    @timeout_value = Rox::Server::RoxInt.new(30, [10, 30, 60])
+  end
+end
+
+# Initialize flags
+flags = FeatureFlags.new
+
+# Register flags
+puts "Registering feature flags..."
+Rox::Server::RoxServer.register(flags)
+
+# Set custom properties
+puts "Setting custom properties..."
+Rox::Server::RoxServer.set_custom_string_property('tier', 'premium')
+Rox::Server::RoxServer.set_custom_boolean_property('is_beta') { true }
+
+# Setup SDK with test API key
+puts "Setting up Rox SDK..."
+puts "Ruby version: #{RUBY_VERSION}"
+puts "Rox SDK version: #{Rox::VERSION}"
+
+begin
+  # Use a test API key in valid format (24-char hex for MongoDB ObjectId)
+  # This will fail to connect but will test initialization
+  api_key = '507f1f77bcf86cd799439011'
+
+  options = Rox::Server::RoxOptions.new(
+    version: '1.0.0',
+    fetch_interval: 60
+  )
+
+  Rox::Server::RoxServer.setup(api_key, options)
+
+  # Give it a moment to initialize
+  sleep 2
+
+  # Test flag evaluation (will use defaults since we can't fetch)
+  puts "\nTesting flag evaluation:"
+  puts "enable_tutorial: #{flags.enable_tutorial.enabled?(nil)}"
+  puts "color_variant: #{flags.color_variant.value(nil)}"
+  puts "timeout_value: #{flags.timeout_value.value(nil)}"
+
+  # Test dynamic API
+  puts "\nTesting dynamic API:"
+  dynamic_api = Rox::Server::RoxServer.dynamic_api
+  puts "Dynamic flag (default false): #{dynamic_api.enabled?('dynamic.test', false, nil)}"
+  puts "Dynamic value (default 'test'): #{dynamic_api.value('dynamic.string', 'test', nil)}"
+
+  puts "\n✅ Ruby #{RUBY_VERSION} compatibility test PASSED!"
+  puts "SDK initialized and flags evaluated successfully."
+
+rescue StandardError => e
+  puts "\n❌ Error: #{e.message}"
+  puts e.backtrace.first(5)
+  exit 1
+ensure
+  # Shutdown SDK
+  puts "\nShutting down SDK..."
+  Rox::Server::RoxServer.shutdown
+end
+
+puts "\nSample app completed successfully!"

data/lib/rox/core/configuration/configuration_parser.rb

@@ -10,10 +10,11 @@ require 'rox/core/logging/logging'
 module Rox
   module Core
     class ConfigurationParser
-      def initialize(signature_verifier, error_reporter, configuration_fetched_invoker)
+      def initialize(signature_verifier, error_reporter, configuration_fetched_invoker, rox_options = nil)
         @signature_verifier = signature_verifier
         @error_reporter = error_reporter
         @configuration_fetched_invoker = configuration_fetched_invoker
+        @rox_options = rox_options
       end
 
       def parse(fetch_result, sdk_settings)
@@ -31,8 +32,8 @@ module Rox
           return nil
         end
 
-        if fetch_result.source != ConfigurationSource::ROXY && !@signature_verifier.verify(json_obj['data'],
-                                                                                           json_obj['signature_v0'])
+        if signature_verification_enabled? && fetch_result.source != ConfigurationSource::ROXY && !@signature_verifier.verify(json_obj['data'],
+                                                                                                                              json_obj['signature_v0'])
           @configuration_fetched_invoker.invoke_error(FetcherError::SIGNATURE_VERIFICATION_ERROR)
           @error_reporter.report('Failed to validate signature',
                                  StandardError.new("Data : #{json_obj['data']} Signature : #{json_obj['signature_v0']}"))
@@ -81,6 +82,14 @@ module Rox
       def parse_target_group(data)
         TargetGroupModel.new(data['_id'], data['condition'])
       end
+
+      private
+
+      def signature_verification_enabled?
+        return true if @rox_options.nil?
+
+        !@rox_options.disable_signature_verification
+      end
     end
   end
 end

data/lib/rox/core/consts/environment.rb

@@ -1,3 +1,5 @@
+require 'rox/server/self_managed_options'
+
 module Rox
   module Core
     module Environment
@@ -50,6 +52,16 @@ module Rox
         @notifications_path
       end
 
+      def self.set_platform(rox_options)
+        @cdn_path = 'https://rox-conf.cloudbees.io'
+        @state_cdn_path = 'https://rox-state.cloudbees.io'
+        alternative_api_url = rox_options&.self_managed_options&.server_url || 'https://api.cloudbees.io'
+        @api_path = "#{alternative_api_url}/device/get_configuration"
+        @state_api_path = "#{alternative_api_url}/device/update_state_store"
+        @analytics_path = rox_options&.self_managed_options&.analytics_url || 'https://fm-analytics.cloudbees.io'
+        @notifications_path = 'https://sdk-notification-service.cloudbees.io/sse'
+      end
+
       private
       def self.setQA()
         @cdn_path = 'https://qa-conf.rollout.io'
@@ -75,11 +87,11 @@ module Rox
         alternative_api_url = rox_options&.self_managed_options&.server_url || 'https://x-api.rollout.io'
         @api_path = "#{alternative_api_url}/device/get_configuration"
         @state_api_path = "#{alternative_api_url}/device/update_state_store"
-        @analytics_path = rox_options&.self_managed_options&.analytics_url ||'https://analytic.rollout.io'
+        @analytics_path = rox_options&.self_managed_options&.analytics_url || 'https://analytic.rollout.io'
         @notifications_path = 'https://push.rollout.io/sse'
       end
     end
   end
 end
 
-Rox::Core::Environment.reset
+Rox::Core::Environment.reset

data/lib/rox/core/core.rb

@@ -25,11 +25,14 @@ require 'rox/core/security/signature_verifier'
 require 'rox/core/security/signature_verifier_mock'
 require 'rox/core/utils/periodic_task'
 require 'rox/core/client/dynamic_api'
+require 'rox/core/helpers/api_key'
 require 'rox/core/error_handling/userspace_unhandled_error_invoker'
 
 module Rox
   module Core
     class Core
+      include Rox::Core::Helpers::ApiKey
+
       def initialize
         @flag_repository = FlagRepository.new
         @custom_property_repository = CustomPropertyRepository.new
@@ -59,7 +62,7 @@ module Rox
       def setup(sdk_settings, device_properties)
         @sdk_settings = sdk_settings
         @rox_options = device_properties.rox_options
-        Rox::Core::Environment.reset(@rox_options)
+        reset_environment!(sdk_settings&.api_key, @rox_options)
 
         experiments_extensions = ExperimentsExtensions.new(@parser, @target_group_repository, @flag_repository,
                                                            @experiment_repository)
@@ -156,7 +159,7 @@ module Rox
                                SignatureVerifier.new
                              end
         configuration_parser = ConfigurationParser.new(signature_verifier, @error_reporter,
-                                                       @configuration_fetched_invoker)
+                                                       @configuration_fetched_invoker, @rox_options)
         result = @configuration_fetcher.fetch
         return if result.nil?
 
@@ -220,12 +223,13 @@ module Rox
         @state_sender.dump_state
       end
 
-      def validate_api_key(api_key)
-        valid_api_key_pattern = /^[a-f\d]{24}$/
-        if api_key&.strip&.empty?
-          raise ArgumentError, 'Blank Rollout api key - must be specified'
-        elsif !valid_api_key_pattern.match(api_key)
-          raise ArgumentError, 'Illegal Rollout api key'
+      def reset_environment!(api_key, rox_options)
+        raise ArgumentError, 'Blank Feature Flag API key - must be specified' unless api_key
+
+        if is_cbp?(api_key)
+          Rox::Core::Environment.set_platform(rox_options)
+        else
+          Rox::Core::Environment.reset(rox_options)
         end
       end
 

data/lib/rox/core/entities/flag.rb

@@ -43,6 +43,10 @@ module Rox
       def disabled(context)
         yield unless enabled?(context)
       end
+
+      def external_type
+        'Boolean'
+      end
     end
   end
 end

data/lib/rox/core/entities/rox_double.rb

@@ -8,6 +8,10 @@ module Rox
         send_impressions(return_value, context)
         return_value
       end
+
+      def external_type
+        'Number'
+      end
     end
   end
 end

data/lib/rox/core/entities/rox_int.rb

@@ -8,6 +8,10 @@ module Rox
         send_impressions(return_value, context)
         return_value
       end
+
+      def external_type
+        'Number'
+      end
     end
   end
 end

data/lib/rox/core/entities/rox_string.rb

@@ -63,6 +63,10 @@ module Rox
 
         return_value
       end
+
+      def external_type
+        'String'
+      end
     end
   end
 end

data/lib/rox/core/helpers/api_key.rb

@@ -0,0 +1,28 @@
+
+module Rox
+  module Core
+    module Helpers
+      module ApiKey
+        MONGO_API_KEY_PATTERN = /^[a-f\d]{24}$/
+        UUID_API_KEY_PATTERN = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i
+
+        def is_cbp?(api_key)
+          validate_api_key(api_key) && UUID_API_KEY_PATTERN.match?(api_key)
+        rescue ArgumentError
+          false
+        end
+
+        def validate_api_key(api_key)
+          if api_key&.strip&.empty?
+            raise ArgumentError, 'Blank Rollout api key - must be specified'
+          elsif !MONGO_API_KEY_PATTERN.match(api_key) && !UUID_API_KEY_PATTERN.match(api_key)
+            raise ArgumentError, 'Illegal Rollout api key'
+          else
+            true
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/rox/core/network/state_sender.rb

@@ -8,10 +8,13 @@ require 'rox/core/network/request'
 require 'rox/core/network/request_data'
 require 'rox/core/network/response'
 require 'rox/core/utils/debouncer'
+require 'rox/core/helpers/api_key'
 
 module Rox
   module Core
     class StateSender
+      include Rox::Core::Helpers::ApiKey
+
       def initialize(sdk_settings, device_properties, flag_repository, custom_property_repository)
         @sdk_settings = sdk_settings
         @device_properties = device_properties
@@ -27,8 +30,8 @@ module Rox
 
       def send
         rollout_key = @device_properties.rollout_key
-        serialized_feature_flags = StateSender.seralize_flag_repository(@flag_repository)
-        serialized_custom_properties = StateSender.serialize_custom_properties_repository(@custom_property_repository)
+        serialized_feature_flags = seralize_flag_repository
+        serialized_custom_properties = serialize_custom_properties_repository
 
         state_payload = StateSender.state_payload(serialized_feature_flags, serialized_custom_properties,
                                                   @device_properties, @sdk_settings.dev_mode_secret)
@@ -39,7 +42,7 @@ module Rox
           response = get_state_from_CDN(rollout_key, md5_signature)
           if response.success?
             Rox::Core::Logging.logger.debug('Successfully fetched state from CDN')
-            return
+            return response, nil
           else
             Rox::Core::Logging.logger.debug('Failed to fetch state from CDN. Sending state to API...')
           end
@@ -52,6 +55,7 @@ module Rox
                     'Failed to send state to API.'
                   end
         Rox::Core::Logging.logger.debug(message)
+        return response, state_payload
       end
 
       def dump_state
@@ -108,7 +112,7 @@ module Rox
       def self.seralize_flag_repository_with_values(flag_repository)
         flags = []
         flag_repository.all_flags.sort_by(&:name).each do |f|
-          flags << {
+          flags <<  {
             name: f.name,
             enabled: f.enabled?,
             defaultValue: f.default_value,
@@ -142,6 +146,45 @@ module Rox
         end
         properties
       end
+
+      private
+
+      def cbp?
+        # Memoize assuming that @sdk_settings are not mutable during state sender lifetime
+        @cbp ||= is_cbp?(@sdk_settings&.api_key)
+      end
+
+      def seralize_flag_repository
+        flags = []
+        @flag_repository.all_flags.sort_by(&:name).each do |f|
+           flag = {
+            name: f.name,
+            defaultValue: f.default_value,
+            options: f.options
+          }
+
+          flag[:externalType] = f.external_type if cbp?
+
+          flags << flag
+        end
+        flags
+      end
+
+      def serialize_custom_properties_repository
+        properties = []
+        @custom_property_repository.all_custom_properties.sort_by(&:name).each do |p|
+          # Check not to send date custom properties to rollout
+          return if !is_cbp?(@sdk_settings&.api_key) && p.type.external_type == DateTime
+
+          properties << {
+            name: p.name,
+            type: p.type.type,
+            externalType: p.type.external_type
+          }
+        end
+        properties
+      end
+
     end
   end
 end

data/lib/rox/core/properties/custom_property_type.rb

@@ -13,6 +13,7 @@ module Rox
       INT = CustomPropertyType.new('int', 'Number')
       FLOAT = CustomPropertyType.new('double', 'Number')
       SEMVER = CustomPropertyType.new('semver', 'Semver')
+      DATETIME = CustomPropertyType.new("time", "DateTime")
     end
   end
 end

data/lib/rox/core/properties/property_factory.rb

@@ -113,6 +113,17 @@ module Rox
         )
       end
 
+      def internal_datetime
+        type = Rox::Core::CustomPropertyType::DATETIME
+
+        Rox::Core::DeviceProperty.new(
+          "now",
+          type
+        ) do
+          Time.now
+        end
+      end
+
       # rubocop:disable Metrics/MethodLength
       def all_properties
         [
@@ -124,7 +135,8 @@ module Rox
           internal_app_key,
           internal_distinct_id,
           internal_lib_version,
-          internal_api_version
+          internal_api_version,
+          internal_datetime
         ]
       end
     end

data/lib/rox/core/roxx/parser.rb

@@ -169,6 +169,15 @@ module Rox
             stack.push(TokenType::UNDEFINED)
           end
         end
+
+        add_operator('tsToNum') do |_parser, stack, _context|
+          datetime = stack.pop
+          if datetime.is_a?(DateTime)
+            stack.push(datetime.to_time.to_i)
+          else
+            stack.push(TokenType::UNDEFINED)
+          end
+        end
       end
     end
   end

data/lib/rox/server/rox_options.rb

@@ -1,15 +1,19 @@
 require 'rox/core/logging/logging'
 require 'rox/server/logging/server_logger'
+require 'rox/core/helpers/api_key'
 
 module Rox
   module Server
     class RoxOptions
+      include Rox::Core::Helpers::ApiKey
+
       attr_reader :dev_mode_key, :version, :fetch_interval,
                   :logger, :impression_handler,
                   :configuration_fetched_handler,
                   :roxy_url, :self_managed_options,
                   :network_configurations_options,
-                  :dynamic_property_rule_handler
+                  :dynamic_property_rule_handler,
+                  :disable_signature_verification
 
       def initialize(
         dev_mode_key: nil,
@@ -21,7 +25,8 @@ module Rox
         roxy_url: nil,
         self_managed_options: nil,
         network_configurations_options: nil,
-        dynamic_property_rule_handler: nil
+        dynamic_property_rule_handler: nil,
+        disable_signature_verification: nil
       )
         @dev_mode_key = dev_mode_key || 'stam'
         @version = version || '0.0'
@@ -42,11 +47,43 @@ module Rox
         @dynamic_property_rule_handler = dynamic_property_rule_handler || proc do |prop_name, context|
           context ? context[prop_name] : nil
         end
+        @disable_signature_verification = disable_signature_verification
       end
 
       def self_managed?
         !@self_managed_options.nil?
       end
+
+      def clone_with_options(options = {})
+        # Check if any keys that are not present as attributes were given as params
+        redundant_keys = options.keys - valid_attributes
+
+        # Filter options if there are such keys that are not present
+        if !redundant_keys.empty?
+          options = options.reduce({}) do |acc, (key, value)|
+            acc[key] = value unless redundant_keys.include?(key)
+            acc
+          end
+        end
+
+        valid_attributes.each do |va|
+          unless options.key?(va)
+            options[va] = self.instance_variable_get("@#{va}".to_sym)
+          end
+        end
+
+        self.class.new(**options)
+      end
+
+      private
+
+      def valid_attributes
+        return @valid_attributes if @valid_attributes
+
+        cons = self.class.instance_method(:initialize)
+        key_parameters = cons.parameters.select { |type, name| type == :keyreq || type == :key }
+        @valid_attributes = key_parameters.map(&:last)
+      end
     end
   end
 end

data/lib/rox/server/rox_server.rb

@@ -14,9 +14,20 @@ module Rox
 
       class << self
         def setup(api_key, rox_options = nil)
-          validate_api_key(api_key)
-
-          rox_options = Rox::Server::RoxOptions.new if rox_options.nil?
+          # @core.setup calls validate_api_key internally anyway, but it will happen in another thread
+          # because of the report_on_exception code below (which might effect older [maybe not supported Ruby versions])
+          # decided to call it explicity here too (to keep the current behavor)
+          # anyway, this also short circuit the initialization (no need for the initialization and Thread.new)
+          # and only costs us calling the validation twice instead of once
+          @core.validate_api_key(api_key)
+
+          rox_options = if rox_options.nil?
+                          Rox::Server::RoxOptions.new(disable_signature_verification: @core.is_cbp?(api_key))
+                        else
+                          rox_options = rox_options.clone_with_options({
+                            disable_signature_verification: @core.is_cbp?(api_key) || rox_options.disable_signature_verification
+                          })
+                        end
           sdk_settings = Rox::Server::SdkSettings.new(api_key, rox_options.dev_mode_key)
           server_properties = Rox::Server::ServerProperties.new(sdk_settings, rox_options)
 
@@ -93,6 +104,12 @@ module Rox
                                                                   &block))
         end
 
+        def set_custom_datetime_property(name, value = nil, &block)
+          @core.add_custom_property(
+            Rox::Core::CustomProperty.new(name, Rox::Core::CustomPropertyType::DATETIME, value, &block)
+          )
+        end
+
         def dynamic_api
           @core.dynamic_api(Rox::Server::ServerEntitiesProvider.new)
         end
@@ -100,14 +117,6 @@ module Rox
         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 = '5.1.2'.freeze
+  VERSION = '6.0.1'.freeze
 end

data/rox.gemspec

@@ -24,10 +24,10 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'em-eventsource', '~> 0.3.2'
 
-  spec.add_development_dependency 'bundler', '~> 2.4.6'
-  spec.add_development_dependency 'minitest', '~> 5.11'
-  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'
+  spec.add_development_dependency 'bundler', '~> 2.4'
+  spec.add_development_dependency 'minitest', '~> 5.20'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '~> 1.50'
+  spec.add_development_dependency 'webmock', '~> 3.20'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rox-rollout
 version: !ruby/object:Gem::Version
-  version: 5.1.2
+  version: 6.0.1
 platform: ruby
 authors:
 - CloudBees
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2026-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: em-eventsource
@@ -30,85 +30,85 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.6
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.6
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.20'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.50'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.50'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.5
+        version: '3.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.5
-description: 
+        version: '3.20'
+description:
 email:
 - support@rollout.io
 executables: []
@@ -116,20 +116,22 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
-- ".github/workflows/e2e_tests.yaml"
-- ".github/workflows/unit_tests.yaml"
 - ".gitignore"
 - ".rubocop.yml"
 - Gemfile
+- Jenkinsfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- cbci-templates/sdkci-e2e.yml
+- cbci-templates/sdkci-unit.yml
 - e2e-server/.gitignore
 - e2e-server/run_server.sh
 - e2e-server/server.rb
 - example/local.rb
+- examples/simple_example.rb
 - lib/rox.rb
 - lib/rox/core/analytics/backoff_policy.rb
 - lib/rox/core/analytics/client.rb
@@ -168,6 +170,7 @@ files:
 - 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/helpers/api_key.rb
 - lib/rox/core/impression/impression_args.rb
 - lib/rox/core/impression/impression_invoker.rb
 - lib/rox/core/impression/models/experiment.rb
@@ -232,7 +235,7 @@ homepage: https://github.com/rollout/rox-ruby
 licenses:
 - Nonstandard
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -247,8 +250,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.5.9
+signing_key:
 specification_version: 4
 summary: Feature Management ROX Ruby SDK
 test_files: []

data/.github/workflows/e2e_tests.yaml

@@ -1,52 +0,0 @@
-name: E2E tests
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    branches:
-      - master
-
-jobs:
-  build:
-
-    runs-on: macos-latest
-
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          path: rox-ruby
-      - name: Checkout e2e tests
-        uses: actions/checkout@v3
-        with:
-          repository: rollout/sdk-end-2-end-tests
-          ref: master
-          token: ${{ secrets.E2E_PAT }}
-          path: sdk-end-2-end-tests
-      - name: link driver
-        working-directory: ./sdk-end-2-end-tests/drivers
-        run: ln -s $GITHUB_WORKSPACE/rox-ruby/e2e-server ruby
-      - name: build e2e node driver
-        working-directory: ./sdk-end-2-end-tests/drivers/nodejs
-        run: |
-          yarn install --frozen-lockfile
-      - name: build and run e2e
-        working-directory: ./sdk-end-2-end-tests
-        run: |
-          yarn install --frozen-lockfile
-          QA_E2E_BEARER=$QA_E2E_BEARER API_HOST=https://api.test.rollout.io CD_API_ENDPOINT=https://api.test.rollout.io/device/get_configuration CD_S3_ENDPOINT=https://rox-conf.test.rollout.io/ SS_API_ENDPOINT=https://api.test.rollout.io/device/update_state_store/ SS_S3_ENDPOINT=https://rox-state.test.rollout.io/ CLIENT_DATA_CACHE_KEY=client_data ANALYTICS_ENDPOINT=https://analytic.test.rollout.io/ NOTIFICATIONS_ENDPOINT=https://push.test.rollout.io/sse SDK_LANG=ruby NODE_ENV=container yarn test:env
-        env:
-          QA_E2E_BEARER: ${{ secrets.QA_E2E_BEARER }}
-      - name: Show e2e server driver logs
-        if: ${{ always() }}
-        run: cat ./sdk-end-2-end-tests/drivers/ruby/log_1234.out || echo "no log file"
-      - name: Show e2e server sync driver logs
-        if: ${{ always() }}
-        run: cat ./sdk-end-2-end-tests/drivers/nodejs/log_1233.out || echo "no log file"
-      - name: Show e2e server init ClientData driver logs
-        if: ${{ always() }}
-        run: cat ./sdk-end-2-end-tests/drivers/ruby/log_2234.out || echo "no log file"
-      - name: Show e2e server init ClientData sync driver logs
-        if: ${{ always() }}
-        run: cat ./sdk-end-2-end-tests/drivers/nodejs/log_2233.out || echo "no log file"

data/.github/workflows/unit_tests.yaml

@@ -1,20 +0,0 @@
-name: Unit Tests
-
-on: [push]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [ubuntu-latest]
-        ruby: [2.6, 2.7, '3.0', 3.1, 3.2]
-    runs-on: ${{ matrix.os }}
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler: 2.4.6
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - run: bundle exec rake test