rox-rollout 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f4ad60820f71ef8569f15f07fcb1ced8b05e99be
-  data.tar.gz: 327115ab21d5889e4783fcef71d33e1cbc72e7ab
+SHA256:
+  metadata.gz: 26085340d144a78eaae9eb85e07374d912d1fd2e516fdb51f38e940028ca191b
+  data.tar.gz: 7bc2113d91aeab8e2778a1c0b71d3c1ebd340b902b8b4a48483d5e1a74f59d5f
 SHA512:
-  metadata.gz: '0368035eb4d7f508749be64e32e89001af56475e57a9018d45654e854c3ac9e9bae322f800525b70ea606240efc35cb1b7c9d140537114e145d92390416b706b'
-  data.tar.gz: 75afe906a4eb22195d5020fdb546952bea785a80f49df4eb6cb85bd8cdd9cec7c47e25f702d013525a8e4474b4ef8bd24f4e6acfb33553fde4a48a859dbcd6da
+  metadata.gz: 4b5385b8da1f783e23b029834f7cb811c8f233ad962aa432447ea5766691610f6cdf63beca6d4d10bd43ee21b8bb2942bd56c78aa97134d6444886f4bbf22b31
+  data.tar.gz: ec71870af8f708fb7941a7455d130b672951f8119e793fb3590188b61fe61ea8fdff4823c9efb48f51beb2eab269bcabdffcc7f6bd488555da764d9b0eedc60a

data/.circleci/config.yml

@@ -1,45 +1,73 @@
-version: 2
-workflows:
-  version: 2
-  test:
-    jobs:
-    - test-2.5
-    - test-2.4
-    - test-2.3
+version: 2.1
 jobs:
-  test-2.5: &test-template
+  test_2-6: &test-template
     docker:
-    - image: circleci/ruby:2.5.1
+    - image: circleci/ruby:2.6.4
 
     working_directory: ~/repo
 
     steps:
     - checkout
 
-    - restore_cache:
-        keys:
-        - v1-dependencies-{{ checksum "Gemfile.lock" }}
-        - v1-dependencies-
+    - run:
+        name: install ssh
+        command: |
+          sudo apt-get update
+          sudo apt-get install libssl-dev
 
     - run:
         name: install dependencies
         command: |
           bundle install --jobs=4 --retry=3 --path vendor/bundle
 
-    - save_cache:
-        paths:
-        - ./vendor/bundle
-        key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
     - run:
         name: run tests
         command: |
           bundle exec rake test
-  test-2.4:
+
+    - run:
+        name: run tests
+        command: |
+          bundle exec rake e2e
+
+  test_2-5:
     <<: *test-template
     docker:
-    - image: circleci/ruby:2.4.4
-  test-2.3:
+    - image: circleci/ruby:2.5.6
+  test_2-4:
     <<: *test-template
     docker:
-    - image: circleci/ruby:2.3.7
+    - image: circleci/ruby:2.4.7
+  test_2-3:
+    <<: *test-template
+    docker:
+    - image: circleci/ruby:2.3.8
+
+  sdk-integration-test:
+      <<: *test-template
+      steps:
+      - run:
+          name: trigger sdk integration test workflow
+          command: >-
+            curl -X POST https://circleci.com/api/v2/project/gh/rollout/sdk-integration-tests/pipeline
+            --header 'Content-Type: application/json'
+            --header 'Accept: application/json'
+            --header 'x-attribution-login: rox-ruby'
+            --header 'x-attribution-actor-id: rox-ruby'
+            --header 'Circle-Token: '$CircleApiToken
+            --data '{"parameters": {"sdk_triggered_run": true, "repo_name": "'$CIRCLE_PROJECT_REPONAME'", "repo_owner": "'$CIRCLE_PROJECT_USERNAME'", "sha": "'$CIRCLE_SHA1'"  }}'
+
+workflows:
+  version: 2
+  test:
+    jobs:
+    - test_2-6
+    - test_2-5
+    - test_2-4
+    - test_2-3
+    - sdk-integration-test:
+        requires:
+          - test_2-6
+          - test_2-5
+          - test_2-4
+          - test_2-3

data/.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

data/.github/workflows/ruby.yml

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

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+Gemfile.lock
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  NewCops: enable
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*.rb
+    - e2e/**/*.rb
+    - e2e-server/**/*.rb
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*.rb
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in rox.gemspec
 gemspec

data/README.md

@@ -0,0 +1,32 @@
+# ROX SDK for Ruby
+
+[![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
+
+## Run tests
+
+Unit tests (folder tests)
+```bash
+bundle exec rake test
+```
+
+E2E tests (folder e2e)
+```bash
+bundle exec rake e2e
+```
+
+## Run linter (rubocop)
+
+```bash
+bundle exec rake lint
+```
+
+## Publish new version
+
+1. Increment version in ```lib/rox/version.rb```, open a PR and wait for CI to complete workflows
+2. Merge to master, wait for CI to complete workflows
+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. Celebrate! 🎉

data/Rakefile

@@ -1,16 +1,19 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 Rake::TestTask.new(:e2e) do |t|
-  t.libs << "lib"
-  t.libs << "e2e"
-  t.test_files = FileList["e2e/**/*_test.rb"]
+  t.libs << 'lib'
+  t.libs << 'e2e'
+  t.test_files = FileList['e2e/**/*_test.rb']
 end
 
-task :default => :test
+RuboCop::RakeTask.new(:lint)
+
+task default: :test

data/bin/console

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
-
-require "bundler/setup"
-require "rox"
+require 'bundler/setup'
+require 'rox'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +9,5 @@ require "rox"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/e2e-server/run_server.sh

@@ -0,0 +1,12 @@
+#!/bin/bash -x
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+cd -P "$DIR"
+DIR=`pwd`
+gem install sinatra
+gem install sinatra-contrib
+gem install json
+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

data/e2e-server/server.rb

@@ -0,0 +1,158 @@
+require 'sinatra'
+require 'sinatra/namespace'
+require 'json'
+require 'rox/server/flags/rox_flag'
+require 'rox/server/rox_server'
+require 'rox/server/rox_options'
+
+class Container
+  attr_accessor :first_flag
+  attr_reader :bool_default_false, :bool_default_true
+
+  def initialize
+    @bool_default_false = Rox::Server::RoxFlag.new(false)
+    @bool_default_true = Rox::Server::RoxFlag.new(true)
+    @first_flag = Rox::Server::RoxFlag.new(true)
+  end
+end
+
+class ServerLogger
+  def initialize
+    @logger = Logger.new($stdout)
+  end
+
+  def debug(message, exception = nil)
+    if exception.nil?
+      @logger.debug(message)
+    else
+      @logger.debug("#{message}. Exception: #{exception}")
+    end
+  end
+
+  def error(message, exception = nil)
+    if exception.nil?
+      @logger.error(message)
+    else
+      @logger.error("#{message}. Exception: #{exception}")
+    end
+  end
+
+  def warn(message, exception = nil)
+    if exception.nil?
+      @logger.warn(message)
+    else
+      @logger.warn("#{message}. Exception: #{exception}")
+    end
+  end
+end
+
+container = Container.new
+set :port, ARGV[0]
+
+namespace '/' do
+  before do
+    content_type 'application/json'
+  end
+
+  get 'status-check' do
+    [200, '']
+  end
+
+  get 'api/values/:id' do |id|
+    if container.first_flag.enabled?
+      [200, JSON.generate({ value: id })]
+    else
+      [200, 'Eladddddd']
+    end
+  end
+
+  put 'api/values/:id' do
+    [200, '']
+  end
+
+  delete 'api/values/:id' do
+    [200, '']
+  end
+
+  post '' do
+    data = JSON.parse(request.body.read)
+    action = data['action']
+    payload = data['payload']
+    puts data
+
+    case action
+    when 'staticFlagIsEnabled'
+      flag = payload['flag']
+      result = container.send(flag.to_sym).enabled?(payload['context'])
+      [200, JSON.generate({ result: result })]
+    when 'registerStaticContainers'
+      Rox::Server::RoxServer.register(container)
+      [200, JSON.generate({ result: 'done' })]
+    when 'setCustomPropertyToThrow'
+      def raise_(ex)
+        raise ex
+      end
+      Rox::Server::RoxServer.set_custom_string_property(payload['key'], raise_(Exception('error')))
+      [200, JSON.generate({ result: 'done' })]
+    when 'setCustomStringProperty'
+      Rox::Server::RoxServer.set_custom_string_property(payload['key'], payload['value'])
+      [200, JSON.generate({ result: 'done' })]
+    when 'dynamicFlagValue'
+      if payload['context']
+        puts "There is a payload[context] => #{payload['context']}"
+        payload['context'].each do |context|
+          key = context[0]
+          value = context[1]
+          Rox::Server::RoxServer.set_custom_string_property(key, value) if value.instance_of? String
+          if value.instance_of? TrueClass
+            Rox::Server::RoxServer.set_custom_boolean_property(key, value)
+          elsif value.instance_of? FalseClass
+            Rox::Server::RoxServer.set_custom_boolean_property(key, value)
+          end
+          Rox::Server::RoxServer.set_custom_int_property(key, value) if value.instance_of? Integer
+          Rox::Server::RoxServer.set_custom_float_property(key, value) if value.instance_of? Float
+        end
+      end
+      result = Rox::Server::RoxServer.dynamic_api.value(payload['flag'], payload['defaultValue'], payload['context'],
+                                                        [])
+      [200, JSON.generate({ result: result })]
+    when 'dynamicFlagIsEnabled'
+      payload['context']&.each do |context|
+        key = context[0]
+        value = context[1]
+        Rox::Server::RoxServer.set_custom_string_property(key, value) if value.instance_of? String
+        if value.instance_of? TrueClass
+          Rox::Server::RoxServer.set_custom_boolean_property(key, value)
+        elsif value.instance_of? FalseClass
+          Rox::Server::RoxServer.set_custom_boolean_property(key, value)
+        end
+        Rox::Server::RoxServer.set_custom_int_property(key, value) if value.instance_of? Integer
+        Rox::Server::RoxServer.set_custom_float_property(key, value) if value.instance_of? Float
+      end
+      result = Rox::Server::RoxServer.dynamic_api.enabled?(payload['flag'], payload['defaultValue'], payload['context'])
+      [200, JSON.generate({ result: result })]
+    when 'setupAndAwait'
+      env = 'stam'
+      if payload['options']
+        options = payload['options']
+        if options['configuration']
+          configuration = options['configuration']
+          env = configuration['env']
+        end
+      end
+      case env
+      when 'qa'
+        ENV['ROLLOUT_MODE'] = 'QA'
+      when 'localhost'
+        ENV['ROLLOUT_MODE'] = 'LOCAL'
+      end
+      options = Rox::Server::RoxOptions.new(logger: ServerLogger.new)
+      puts "options => #{options}"
+      Rox::Server::RoxServer.setup(payload['key'], options).value
+      [200, JSON.generate({ result: 'done' })]
+    when 'stop'
+      Thread.new { sleep 1; Process.kill 'INT', Process.pid }
+      halt 200, JSON.generate({ result: 'done' })
+    end
+  end
+end

data/e2e/container.rb

@@ -1,15 +1,13 @@
 require 'rox/server/flags/rox_flag'
-require 'rox/server/flags/rox_variant'
+require 'rox/server/flags/rox_string'
 
 module E2E
   class Container
-    attr_accessor :simple_flag, :simple_flag_overwritten
-    attr_accessor :flag_for_impression, :flag_for_impression_with_experiment_and_context
-    attr_accessor :flag_custom_properties
-    attr_accessor :flag_target_groups_all, :flag_target_groups_any, :flag_target_groups_none
-    attr_accessor :variant_with_context
-    attr_accessor :variant, :variant_overwritten
-    attr_accessor :flag_for_dependency, :flag_colors_for_dependency, :flag_dependent, :flag_color_dependent_with_context
+    attr_accessor :simple_flag, :simple_flag_overwritten, :flag_for_impression,
+                  :flag_for_impression_with_experiment_and_context, :flag_custom_properties,
+                  :flag_target_groups_all, :flag_target_groups_any, :flag_target_groups_none,
+                  :variant_with_context, :variant, :variant_overwritten, :flag_for_dependency,
+                  :flag_dependent, :flag_color_dependent_with_context
 
     def initialize
       @simple_flag = Rox::Server::RoxFlag.new(true)
@@ -24,15 +22,14 @@ module E2E
       @flag_target_groups_any = Rox::Server::RoxFlag.new
       @flag_target_groups_none = Rox::Server::RoxFlag.new
 
-      @variant_with_context = Rox::Server::RoxVariant.new('red', ['red', 'blue', 'green'])
+      @variant_with_context = Rox::Server::RoxString.new('red', %w[red blue green])
 
-      @variant = Rox::Server::RoxVariant.new('red', ['red', 'blue', 'green'])
-      @variant_overwritten = Rox::Server::RoxVariant.new('red', ['red', 'blue', 'green'])
+      @variant = Rox::Server::RoxString.new('red', %w[red blue green])
+      @variant_overwritten = Rox::Server::RoxString.new('red', %w[red blue green])
 
       @flag_for_dependency = Rox::Server::RoxFlag.new(false)
-      @flag_colors_for_dependency = Rox::Server::RoxVariant.new('White', ['White', 'Blue', 'Green', 'Yellow'])
       @flag_dependent = Rox::Server::RoxFlag.new(false)
-      @flag_color_dependent_with_context = Rox::Server::RoxVariant.new('White', ['White', 'Blue', 'Green', 'Yellow'])
+      @flag_color_dependent_with_context = Rox::Server::RoxString.new('White', %w[White Blue Green Yellow])
     end
   end
-end
+end