prefab-cloud-ruby 0.13.0 → 0.13.1

data/.github/workflows/ruby.yml

@@ -1,39 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: Ruby
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-permissions:
-  contents: read
-
-jobs:
-  test:
-
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
-
-    steps:
-    - uses: actions/checkout@v3
-    - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-    # uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby-version }}
-        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Run tests
-      run: bundle exec rake

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.0.3

data/CODEOWNERS

@@ -1 +0,0 @@
-*    @prefab-cloud/prefabdevs @prefab-cloud/prefabmaintainers @prefab-cloud/prefabadmins

data/lib/prefab/config_helper.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-module Prefab
-  module ConfigHelper
-    def value_of(config_value)
-      case config_value.type
-      when :string
-        config_value.string
-      when :int
-        config_value.int
-      when :double
-        config_value.double
-      when :bool
-        config_value.bool
-      when :feature_flag
-        config_value.feature_flag
-      when :segment
-        config_value.segment
-      end
-    end
-
-    def value_of_variant(feature_flag_variant)
-      return feature_flag_variant.string if feature_flag_variant.has_string?
-      return feature_flag_variant.int if feature_flag_variant.has_int?
-      return feature_flag_variant.double if feature_flag_variant.has_double?
-      return feature_flag_variant.bool if feature_flag_variant.has_bool?
-      return nil
-    end
-  end
-end

data/lib/prefab/error.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  class Error < StandardError
-  end
-end

data/lib/prefab/errors/initialization_timeout_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  module Errors
-    class InitializationTimeoutError < Prefab::Error
-      def initialize(timeout_sec, key)
-        message = "Prefab couldn't initialize in #{timeout_sec} second timeout. Trying to fetch key `#{key}`."
-
-        super(message)
-      end
-    end
-  end
-end

data/lib/prefab/errors/invalid_api_key_error.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  module Errors
-    class InvalidApiKeyError < Prefab::Error
-      def initialize(key)
-        if key.nil? || key.empty?
-          message = "No API key. Set PREFAB_API_KEY env var or use PREFAB_DATASOURCES=LOCAL_ONLY"
-
-          super(message)
-        else
-          message = "Your API key format is invalid. Expecting something like 123-development-yourapikey-SDK. You provided `#{key}`"
-
-          super(message)
-        end
-      end
-    end
-  end
-end

data/lib/prefab/errors/missing_default_error.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-module Prefab
-  module Errors
-    class MissingDefaultError < Prefab::Error
-      def initialize(key)
-        message = "No value found for key '#{key}' and no default was provided.\n\nIf you'd prefer returning `nil` rather than raising when this occurs, modify the `on_no_default` value you provide in your Prefab::Options."
-
-        super(message)
-      end
-    end
-  end
-end

data/lib/prefab/internal_logger.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-module Prefab
-  class InternalLogger < Logger
-    def initialize(path, logger)
-      @path = path
-      @logger = logger
-    end
-
-    def debug(progname = nil, &block)
-      @logger.log_internal yield, @path, progname, DEBUG
-    end
-
-    def info(progname = nil, &block)
-      @logger.log_internal yield, @path, progname, INFO
-    end
-
-    def warn(progname = nil, &block)
-      @logger.log_internal yield, @path, progname, WARN
-    end
-
-    def error(progname = nil, &block)
-      @logger.log_internal yield, @path, progname, ERROR
-    end
-
-    def fatal(progname = nil, &block)
-      @logger.log_internal yield, @path, progname, FATAL
-    end
-  end
-end

data/lib/prefab/options.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-module Prefab
-  class Options
-    attr_reader :api_key
-    attr_reader :logdev
-    attr_reader :log_formatter
-    attr_reader :stats
-    attr_reader :shared_cache
-    attr_reader :namespace
-    attr_reader :prefab_api_url
-    attr_reader :prefab_grpc_url
-    attr_reader :on_no_default
-    attr_reader :initialization_timeout_sec
-    attr_reader :on_init_failure
-    attr_reader :prefab_config_override_dir
-    attr_reader :prefab_config_classpath_dir
-    attr_reader :defaults_env
-
-    DEFAULT_LOG_FORMATTER = proc { |severity, datetime, progname, msg|
-      "#{severity.ljust(5)} #{datetime}: #{progname} #{msg}\n"
-    }
-
-    module ON_INITIALIZATION_FAILURE
-      RAISE = 1
-      RETURN = 2
-    end
-    module ON_NO_DEFAULT
-      RAISE = 1
-      RETURN_NIL = 2
-    end
-    module DATASOURCES
-      ALL = 1
-      LOCAL_ONLY = 2
-    end
-
-    def initialize(
-      api_key: ENV['PREFAB_API_KEY'],
-      logdev: $stdout,
-      stats: NoopStats.new, # receives increment("prefab.limitcheck", {:tags=>["policy_group:page_view", "pass:true"]})
-      shared_cache: NoopCache.new, # Something that quacks like Rails.cache ideally memcached
-      namespace: "",
-      log_formatter: DEFAULT_LOG_FORMATTER,
-      prefab_api_url: ENV["PREFAB_API_URL"] || 'https://api.prefab.cloud',
-      prefab_grpc_url: ENV["PREFAB_GRPC_URL"] || 'grpc.prefab.cloud:443',
-      on_no_default: ON_NO_DEFAULT::RAISE, # options :raise, :warn_and_return_nil,
-      initialization_timeout_sec: 10, # how long to wait before on_init_failure
-      on_init_failure: ON_INITIALIZATION_FAILURE::RAISE, #options :unlock_and_continue, :lock_and_keep_trying, :raise
-      # new_config_callback: nil, #callback method
-      # live_override_url: nil,
-      prefab_datasources: ENV['PREFAB_DATASOURCES'] == "LOCAL_ONLY" ? DATASOURCES::LOCAL_ONLY : DATASOURCES::ALL,
-      prefab_config_override_dir: Dir.home,
-      prefab_config_classpath_dir: ".",
-      defaults_env: ""
-    )
-      # debugger
-      @api_key = api_key
-      @logdev = logdev
-      @stats = stats
-      @shared_cache = shared_cache
-      @namespace = namespace
-      @log_formatter = log_formatter
-      @prefab_api_url = prefab_api_url
-      @prefab_grpc_url = prefab_grpc_url
-      @on_no_default = on_no_default
-      @initialization_timeout_sec = initialization_timeout_sec
-      @on_init_failure = on_init_failure
-      @prefab_datasources = prefab_datasources
-      @prefab_config_classpath_dir = prefab_config_classpath_dir
-      @prefab_config_override_dir = prefab_config_override_dir
-      @defaults_env = defaults_env
-    end
-
-    def local_only?
-      @prefab_datasources == DATASOURCES::LOCAL_ONLY
-    end
-
-    # https://api.prefab.cloud -> https://api-prefab-cloud.global.ssl.fastly.net
-    def url_for_api_cdn
-      ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, "-")}.global.ssl.fastly.net"
-    end
-  end
-end

data/run_test_harness_server.sh

@@ -1,8 +0,0 @@
-#! /usr/bin/env bash
-
-PREFAB_CDN_URL="https://api-prefab-cloud.global.ssl.fastly.net" \
-  PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug \
-  PREFAB_CLOUD_HTTP=true \
-  PREFAB_API_KEY="1|local_development_api_key" \
-  PREFAB_GRPC_URL="localhost:50051" \
-  ruby -Ilib test/harness_server.rb

data/test/harness_server.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-require 'prefab-cloud-ruby'
-require 'rack'
-require 'base64'
-require 'json'
-
-handler = Rack::Handler::Thin
-
-#
-# This is a very lightweight server that allows the compliance harness to excercise the prefab client
-#
-class RackApp
-  def call(env)
-    props = CGI::parse(env["QUERY_STRING"])
-    props = JSON.parse(Base64.decode64(props["props"][0]))
-
-    key = props["key"]
-    namespace = props["namespace"]
-    api_key = props["api_key"]
-    user_key = props["user_key"]
-    is_feature_flag = !props["feature_flag"].nil?
-    attributes = props["attributes"]
-    puts props
-
-    options = Prefab::Options.new(
-      api_key: api_key,
-      namespace: namespace,
-      initialization_timeout_sec: 1,
-      # We want to `return` rather than raise so we'll use the initial payload if we can't connect to the SSE server
-      on_init_failure: Prefab::Options::ON_INITIALIZATION_FAILURE::RETURN,
-      # Want to return `nil` rather than raise so we can verify empty values
-      on_no_default: Prefab::Options::ON_NO_DEFAULT::RETURN_NIL
-    )
-
-    client = Prefab::Client.new(options)
-
-    puts "Key #{key}"
-    puts "User #{user_key}"
-    puts "api_key #{api_key}"
-    puts "Namespace #{namespace}"
-    puts "Props! #{props}"
-    puts "is_feature_flag! #{is_feature_flag}"
-
-    puts client.config_client.to_s
-
-    if is_feature_flag
-      puts "EVALFF #{key} #{user_key}"
-      rtn = client.feature_flag_client.get(key, user_key, attributes).to_s
-    else
-      rtn = client.config_client.get(key).to_s
-    end
-
-    puts "return #{rtn}"
-
-    [200, { "Content-Type" => "text/plain" }, rtn]
-
-    rescue Exception => e
-      puts "ERROR #{e.message}"
-      puts e.backtrace
-      [500, { "Content-Type" => "text/plain" }, e.message]
-  end
-end
-
-handler.run RackApp.new

data/test/test_client.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-require 'test_helper'
-
-class TestClient < Minitest::Test
-  def setup
-    @client = new_client
-  end
-
-  def test_get
-    assert_equal "test sample value", @client.get("sample")
-    assert_equal 123, @client.get("sample_int")
-  end
-
-  def test_get_with_default
-    # A `false` value is not replaced with the default
-    assert_equal false, @client.get("false_value", "red")
-
-    # A falsy value is not replaced with the default
-    assert_equal 0, @client.get("zero_value", "red")
-
-    # A missing value returns the default
-    assert_equal "buckets", @client.get("missing_value", "buckets")
-  end
-
-  def test_get_with_missing_default
-    # it raises by default
-    err = assert_raises(Prefab::Errors::MissingDefaultError) do
-      assert_nil @client.get("missing_value")
-    end
-
-    assert_match(/No value found for key/, err.message)
-    assert_match(/on_no_default/, err.message)
-
-    # you can opt-in to return `nil` instead
-    client = new_client(on_no_default: Prefab::Options::ON_NO_DEFAULT::RETURN_NIL)
-    assert_nil client.get("missing_value")
-  end
-
-  def test_enabled
-    assert_equal false, @client.enabled?("does_not_exist")
-    assert_equal true, @client.enabled?("enabled_flag")
-    assert_equal false, @client.enabled?("disabled_flag")
-    assert_equal false, @client.enabled?("flag_with_a_value")
-  end
-
-  def test_ff_enabled_with_lookup_key
-    assert_equal false, @client.enabled?("in_lookup_key", "jimmy")
-    assert_equal true, @client.enabled?("in_lookup_key", "abc123")
-    assert_equal true, @client.enabled?("in_lookup_key", "xyz987")
-  end
-
-  def test_ff_get_with_lookup_key
-    assert_nil @client.get("in_lookup_key", "jimmy")
-    assert_equal "DEFAULT", @client.get("in_lookup_key", "jimmy", {}, "DEFAULT")
-
-    assert_equal true, @client.get("in_lookup_key", "abc123")
-    assert_equal true, @client.get("in_lookup_key", "xyz987")
-  end
-
-  def test_ff_enabled_with_attributes
-    assert_equal false, @client.enabled?("just_my_domain", "abc123", { domain: "gmail.com" })
-    assert_equal false, @client.enabled?("just_my_domain", "abc123", { domain: "prefab.cloud" })
-    assert_equal false, @client.enabled?("just_my_domain", "abc123", { domain: "example.com" })
-  end
-
-  def test_ff_get_with_attributes
-    assert_nil @client.get("just_my_domain", "abc123", { domain: "gmail.com" })
-    assert_equal "DEFAULT", @client.get("just_my_domain", "abc123", { domain: "gmail.com" }, "DEFAULT")
-
-    assert_equal "new-version", @client.get("just_my_domain", "abc123", { domain: "prefab.cloud" })
-    assert_equal "new-version", @client.get("just_my_domain", "abc123", { domain: "example.com" })
-  end
-
-  def test_getting_feature_flag_value
-    assert_equal false, @client.enabled?("flag_with_a_value")
-    assert_equal "all-features", @client.get("flag_with_a_value")
-  end
-
-  private
-
-  def new_client(overrides = {})
-    options = Prefab::Options.new(**{
-      prefab_config_override_dir: "none",
-      prefab_config_classpath_dir: "test",
-      defaults_env: "unit_tests",
-      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
-    }.merge(overrides))
-
-    Prefab::Client.new(options)
-  end
-end

data/test/test_config_client.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-require 'test_helper'
-
-class TestConfigClient < Minitest::Test
-  def setup
-    options = Prefab::Options.new(
-      prefab_config_override_dir: "none",
-      prefab_config_classpath_dir: "test",
-      defaults_env: "unit_tests",
-      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
-    )
-
-    @config_client = Prefab::ConfigClient.new(MockBaseClient.new(options), 10)
-  end
-
-  def test_load
-    assert_equal "test sample value", @config_client.get("sample")
-    assert_equal 123, @config_client.get("sample_int")
-  end
-
-  def test_initialization_timeout_error
-    options = Prefab::Options.new(
-      api_key: "123-ENV-KEY-SDK",
-      initialization_timeout_sec: 0.01,
-      logdev: StringIO.new
-    )
-
-    err = assert_raises(Prefab::Errors::InitializationTimeoutError) do
-      Prefab::Client.new(options).config_client.get("anything")
-    end
-
-    assert_match(/couldn't initialize in 0.01 second timeout/, err.message)
-  end
-
-  def test_invalid_api_key_error
-    options = Prefab::Options.new(
-      api_key: "",
-    )
-
-    err = assert_raises(Prefab::Errors::InvalidApiKeyError) do
-      Prefab::Client.new(options).config_client.get("anything")
-    end
-
-    assert_match(/No API key/, err.message)
-
-    options = Prefab::Options.new(
-      api_key: "invalid",
-    )
-
-    err = assert_raises(Prefab::Errors::InvalidApiKeyError) do
-      Prefab::Client.new(options).config_client.get("anything")
-    end
-
-    assert_match(/format is invalid/, err.message)
-  end
-end