prefab-cloud-ruby 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2525930a7f8c2e2924db43504b7dfb6d32e60647bbc359b8a85af8ae3c9f2db0
-  data.tar.gz: 583f5dc901866eaf206f7f693a95bec47b7ea04c54f3d56275a04bbf0a7bb75f
+  metadata.gz: 70fdeb9c1e8651a918fb7700a921e23843374ee9d5f3904a09d076e4be3b3669
+  data.tar.gz: bd1cd6750f66a4e1f1940010fdaef01596de605f84ec80034747c906203aa8fc
 SHA512:
-  metadata.gz: 6c4ff539c75a2d2cfc5e5d6c3ac7bbab494489386d9a1c66ec97af47ab11d46e723a86df862ab8f86a06b09e6ce93d93425f991656cc473395ccf7e2e5fa4da5
-  data.tar.gz: 1fe296a9c44484d2d8cc4a185929aaef80358fdee8f3bd83d47152933aa6f684fcf995c3f18bae6feb0389370620e9557d2d37f00d657cc72ef43fdd3b55e37e
+  metadata.gz: 47cd4f946a8ed79956d5b7f9822eb6b4d666db234bab4767990aa9fd79402acfbe569f4708d2ce08c57b65dedeafa374d6c9f97460ded8c6307d71293ee812fa
+  data.tar.gz: 5078a253a71a7166a00f45a325d3f5b1f3435d99f2011ad197ebeb0af8be38699caecdba18fb36d019b13b92992f6c7cef82ae14ef672cda4ae8a3ca199c7236

data/.github/workflows/ruby.yml

@@ -0,0 +1,39 @@
+# 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/Gemfile

@@ -9,10 +9,13 @@ gem 'googleapis-common-protos-types', :platforms => :ruby
 
 group :development do
   gem 'grpc-tools', :platforms => :ruby
-  gem "shoulda", ">= 0"
   gem "rdoc", "~> 3.12"
   gem "bundler"
   gem "juwelier", "~> 2.4.9"
   gem "simplecov", ">= 0"
   gem 'thin'
 end
+
+group :test do
+  gem "minitest"
+end

data/Gemfile.lock

@@ -1,15 +1,10 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.4.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     builder (3.2.4)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.10)
     daemons (1.4.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
@@ -34,7 +29,7 @@ GEM
       faraday (>= 0.8, < 2)
       hashie (~> 3.5, >= 3.5.2)
       oauth2 (~> 1.0)
-    google-protobuf (3.19.3)
+    google-protobuf (3.21.4)
     googleapis-common-protos-types (1.3.0)
       google-protobuf (~> 3.14)
     grpc (1.43.1)
@@ -51,8 +46,6 @@ GEM
     http-cookie (1.0.4)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    i18n (1.8.9)
-      concurrent-ruby (~> 1.0)
     json (1.8.6)
     juwelier (2.4.9)
       builder
@@ -76,7 +69,7 @@ GEM
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
     mini_portile2 (2.8.0)
-    minitest (5.14.4)
+    minitest (5.16.2)
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
@@ -92,19 +85,13 @@ GEM
     psych (3.3.1)
     public_suffix (4.0.6)
     racc (1.6.0)
-    rack (2.2.3)
+    rack (2.2.4)
     rake (13.0.3)
     rchardet (1.8.0)
     rdoc (3.12.2)
       json (~> 1.4)
     ruby2_keywords (0.0.4)
     semver2 (3.4.2)
-    shoulda (4.0.0)
-      shoulda-context (~> 2.0)
-      shoulda-matchers (~> 4.0)
-    shoulda-context (2.0.0)
-    shoulda-matchers (4.5.1)
-      activesupport (>= 4.2.0)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -114,8 +101,6 @@ GEM
       eventmachine (~> 1.0, >= 1.0.4)
       rack (>= 1, < 3)
     thread_safe (0.3.6)
-    tzinfo (1.2.9)
-      thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8)
@@ -133,8 +118,8 @@ DEPENDENCIES
   grpc-tools
   juwelier (~> 2.4.9)
   ld-eventsource
+  minitest
   rdoc (~> 3.12)
-  shoulda
   simplecov
   thin
 

data/Rakefile

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0

data/lib/prefab/auth_interceptor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class AuthInterceptor < GRPC::ClientInterceptor
     def initialize(api_key)

data/lib/prefab/cancellable_interceptor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class CancellableInterceptor < GRPC::ClientInterceptor
     WAIT_SEC = 3

data/lib/prefab/client.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 module Prefab
-
   class Client
     MAX_SLEEP_SEC = 10
     BASE_SLEEP_SEC = 0.5
+    NO_DEFAULT_PROVIDED = :no_default_provided
 
     attr_reader :project_id, :shared_cache, :stats, :namespace, :interceptor, :api_key, :prefab_api_url, :options
 
@@ -18,8 +19,7 @@ module Prefab
         log_internal Logger::INFO, "Prefab Running in Local Mode"
       else
         @api_key = @options.api_key
-        raise "No API key. Set PREFAB_API_KEY env var or use PREFAB_DATASOURCES=LOCAL_ONLY" if @api_key.nil? || @api_key.empty?
-        raise "PREFAB_API_KEY format invalid. Expecting 123-development-yourapikey-SDK" unless @api_key.count("-") == 3
+        raise Prefab::Errors::InvalidApiKeyError.new(@api_key) if @api_key.nil? || @api_key.empty? || api_key.count("-") != 3
         @project_id = @api_key.split("-")[0].to_i # unvalidated, but that's ok. APIs only listen to the actual passwd
         @interceptor = Prefab::AuthInterceptor.new(@api_key)
         @prefab_api_url = @options.prefab_api_url
@@ -91,6 +91,20 @@ module Prefab
       @_channel = nil
     end
 
+    def enabled?(feature_name, lookup_key=nil, attributes={})
+      feature_flag_client.feature_is_on_for?(feature_name, lookup_key, attributes: attributes)
+    end
+
+    def get(key, default_or_lookup_key=NO_DEFAULT_PROVIDED, attributes={}, ff_default=NO_DEFAULT_PROVIDED)
+      result = config_client.get(key, default_or_lookup_key)
+
+      if result.is_a?(Prefab::FeatureFlag)
+        feature_flag_client.get(key, default_or_lookup_key, attributes, default: ff_default)
+      else
+        result
+      end
+    end
+
     private
 
     def http_secure?

data/lib/prefab/config_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class ConfigClient
     include Prefab::ConfigHelper
@@ -73,9 +74,9 @@ module Prefab
                          rows: [Prefab::ConfigRow.new(value: config_value)])
     end
 
-    def get(key)
+    def get(key, default=Prefab::Client::NO_DEFAULT_PROVIDED)
       config = _get(key)
-      config ? value_of(config[:value]) : nil
+      config ? value_of(config[:value]) : handle_default(key, default)
     end
 
     def get_config_obj(key)
@@ -85,6 +86,18 @@ module Prefab
 
     private
 
+    def handle_default(key, default)
+      if default != Prefab::Client::NO_DEFAULT_PROVIDED
+        return default
+      end
+
+      if @options.on_no_default == Prefab::Options::ON_NO_DEFAULT::RAISE
+        raise Prefab::Errors::MissingDefaultError.new(key)
+      end
+
+      nil
+    end
+
     def _get(key)
       # wait timeout sec for the initalization to be complete
       @initialized_future.value(@options.initialization_timeout_sec)
@@ -93,7 +106,7 @@ module Prefab
           @base_client.log_internal Logger::WARN, "Couldn't Initialize In #{@options.initialization_timeout_sec}. Key #{key}. Returning what we have"
           @initialization_lock.release_write_lock
         else
-          raise "Prefab Couldn't Initialize In #{@options.initialization_timeout_sec} 2 timeout. Key #{key}. "
+          raise Prefab::Errors::InitializationTimeoutError.new(@options.initialization_timeout_sec, key)
         end
       end
       @config_resolver._get(key)
@@ -140,7 +153,6 @@ module Prefab
     rescue GRPC::Unauthenticated
       @base_client.log_internal Logger::WARN, "Unauthenticated"
     rescue => e
-      puts e.class
       @base_client.log_internal Logger::WARN, "Unexpected grpc_api problem loading checkpoint #{e}"
       false
     end

data/lib/prefab/config_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   module ConfigHelper
     def value_of(config_value)

data/lib/prefab/config_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 module Prefab
   class ConfigLoader
@@ -70,22 +72,35 @@ module Prefab
           if v.class == Hash
             v.each do |env_k, env_v|
               if k == @prefab_options.defaults_env
-                rtn[env_k] = { source: file,
-                               match: k,
-                               config: Prefab::Config.new(key: env_k, rows: [
-                                 Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(env_v)))
-                               ]) }
+                if env_v.class == Hash && env_v['feature_flag']
+                  rtn[env_k] = feature_flag_config(file, k, env_k, env_v)
+                else
+                  rtn[env_k] = {
+                    source: file,
+                    match: k,
+                    config: Prefab::Config.new(
+                      key: env_k,
+                      rows: [
+                        Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(env_v)))
+                      ]
+                    )
+                  }
+                end
               else
                 next
               end
             end
           else
-            rtn[k] = { source: file,
-                       match: "default",
-                       config: Prefab::Config.new(key: k, rows: [
-                         Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(v)))
-                       ]) }
-
+            rtn[k] = {
+              source: file,
+              match: "default",
+              config: Prefab::Config.new(
+                key: k,
+                rows: [
+                  Prefab::ConfigRow.new(value: Prefab::ConfigValue.new(value_from(v)))
+                ]
+              )
+            }
           end
         end
       end
@@ -114,5 +129,52 @@ module Prefab
         { double: raw }
       end
     end
+
+    def feature_flag_config(file, k, env_k, env_v)
+      criteria = Prefab::Criteria.new(operator: 'ALWAYS_TRUE')
+
+      if env_v['criteria']
+        criteria = Prefab::Criteria.new(criteria_values(env_v['criteria']))
+      end
+
+      row = Prefab::ConfigRow.new(
+        value: Prefab::ConfigValue.new(
+          feature_flag: Prefab::FeatureFlag.new(
+            active: true,
+            inactive_variant_idx: -1, # not supported
+            rules: [
+              Prefab::Rule.new(
+                variant_weights: [
+                  Prefab::VariantWeight.new(variant_idx: 0, weight: 1000)
+                ],
+                criteria: criteria
+              )
+            ]
+          )
+        )
+      )
+
+      unless env_v.has_key?('value')
+        raise Prefab::Error, "Feature flag config `#{env_k}` #{file} must have a `value`"
+      end
+
+      {
+        source: file,
+        match: k,
+        config: Prefab::Config.new(
+          key: env_k,
+          variants: [Prefab::FeatureFlagVariant.new(value_from(env_v['value']))],
+          rows: [row]
+        )
+      }
+    end
+
+    def criteria_values(criteria_hash)
+      if RUBY_VERSION < '2.7'
+        criteria_hash.transform_keys(&:to_sym)
+      else
+        criteria_hash
+      end
+    end
   end
 end

data/lib/prefab/config_resolver.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 module Prefab
   class ConfigResolver
     include Prefab::ConfigHelper
-    NAMESPACE_DELIMITER = ".".freeze
+    NAMESPACE_DELIMITER = "."
 
     attr_accessor :project_env_id # this will be set by the config_client when it gets an API response
 
@@ -28,7 +29,7 @@ module Prefab
             elements << "Match: #{v[:match]}".slice(0..29).ljust(30)
             elements << "Source: #{v[:source]}"
           end
-          str << elements.join(" | ") << "\n"
+          str += elements.join(" | ") << "\n"
         end
       end
       str

data/lib/prefab/error.rb

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

data/lib/prefab/errors/initialization_timeout_error.rb

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1,19 @@
+# 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

@@ -0,0 +1,13 @@
+# 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/feature_flag_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class FeatureFlagClient
     include Prefab::ConfigHelper
@@ -18,27 +19,48 @@ module Prefab
     def feature_is_on_for?(feature_name, lookup_key, attributes: {})
       @base_client.stats.increment("prefab.featureflag.on", tags: ["feature:#{feature_name}"])
 
-      return is_on?(get(feature_name, lookup_key, attributes))
+      return is_on?(_get(feature_name, lookup_key, attributes, default: false))
     end
 
-    def get(feature_name, lookup_key=nil, attributes={})
-      feature_obj = @base_client.config_client.get(feature_name)
-      config_obj = @base_client.config_client.get_config_obj(feature_name)
-      return nil if feature_obj.nil? || config_obj.nil?
-      variants = config_obj.variants
-      evaluate(feature_name, lookup_key, attributes, feature_obj, variants)
-    end
+    def get(feature_name, lookup_key=nil, attributes={}, default: false)
+      variant = _get(feature_name, lookup_key, attributes, default: default)
 
-    def evaluate(feature_name, lookup_key, attributes, feature_obj, variants)
-      value_of_variant(get_variant(feature_name, lookup_key, attributes, feature_obj, variants))
+      value_of_variant_or_nil(variant, default)
     end
 
     private
 
+    def value_of_variant_or_nil(variant_maybe, default)
+      if variant_maybe.nil?
+        default != Prefab::Client::NO_DEFAULT_PROVIDED ? default : nil
+      else
+        value_of_variant(variant_maybe)
+      end
+    end
+
+    def _get(feature_name, lookup_key=nil, attributes={}, default:)
+      feature_obj = @base_client.config_client.get(feature_name, default)
+      config_obj = @base_client.config_client.get_config_obj(feature_name)
+
+      return nil if feature_obj.nil? || config_obj.nil?
+
+      if feature_obj == !!feature_obj
+        return feature_obj
+      end
+
+      variants = config_obj.variants
+      get_variant(feature_name, lookup_key, attributes, feature_obj, variants)
+    end
+
     def is_on?(variant)
       if variant.nil?
         return false
       end
+
+      if variant == !!variant
+        return variant
+      end
+
       variant.bool
     rescue
       @base_client.log.info("is_on? methods only work for boolean feature flags variants. This feature flags variant is '#{variant}'. Returning false")
@@ -61,7 +83,6 @@ module Prefab
         end
       end
 
-
       percent_through_distribution = rand()
       if lookup_key
         percent_through_distribution = get_user_pct(feature_name, lookup_key)
@@ -104,7 +125,6 @@ module Prefab
     #
     # end
     def criteria_match?(criteria, lookup_key, attributes)
-
       if criteria.operator == :ALWAYS_TRUE
         return true
       elsif criteria.operator == :LOOKUP_KEY_IN

data/lib/prefab/internal_logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class InternalLogger < Logger
     def initialize(path, logger)

data/lib/prefab/logger_client.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 module Prefab
   class LoggerClient < Logger
 
-    SEP = ".".freeze
-    BASE = "log_level".freeze
+    SEP = "."
+    BASE = "log_level"
+    UNKNOWN = "unknown"
 
     def initialize(logdev, formatter: nil)
       super(logdev)
@@ -107,10 +109,10 @@ module Prefab
 
     # Find the closest match to 'log_level.path' in config
     def level_of(path)
-      closest_log_level_match = @config_client.get(BASE) || :warn
+      closest_log_level_match = @config_client.get(BASE, :warn)
       path.split(SEP).inject([BASE]) do |memo, n|
         memo << n
-        val = @config_client.get(memo.join(SEP))
+        val = @config_client.get(memo.join(SEP), nil)
         unless val.nil?
           closest_log_level_match = val
         end
@@ -122,12 +124,12 @@ module Prefab
     # sanitize & clean the path of the caller so the key
     # looks like log_level.app.models.user
     def get_path(absolute_path, base_label)
-      path = (absolute_path || "unknown") + ""
+      path = (absolute_path || UNKNOWN).dup
       path.slice! Dir.pwd
 
       path.gsub!(/.*?(?=\/lib\/)/im, "")
 
-      path = "#{path.gsub("/", SEP).gsub(".rb", "")}#{SEP}#{base_label}"
+      path = path.gsub("/", SEP).gsub(".rb", "") + SEP + base_label
       path.slice! ".lib"
       path.slice! SEP
       path
@@ -141,8 +143,8 @@ module Prefab
   # StubConfigClient to be used while config client initializes
   # since it may log
   class BootstrappingConfigClient
-    def get(key)
-      ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"] || :info
+    def get(key, default=nil)
+      ENV["PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL"] || default
     end
   end
 end

data/lib/prefab/murmer3.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Murmur3
   ## MurmurHash3 was written by Austin Appleby, and is placed in the public
   ## domain. The author hereby disclaims copyright to this source code.

data/lib/prefab/noop_cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class NoopCache
     def fetch(name, opts, &method)

data/lib/prefab/noop_stats.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
 
   class NoopStats

data/lib/prefab/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class Options
     attr_reader :api_key
@@ -25,7 +26,7 @@ module Prefab
     end
     module ON_NO_DEFAULT
       RAISE = 1
-      RETURN = 2
+      RETURN_NIL = 2
     end
     module DATASOURCES
       ALL = 1

data/lib/prefab/ratelimit_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Prefab
   class RateLimitClient
 

data/lib/prefab-cloud-ruby.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "concurrent/atomics"
 require 'concurrent'
 require 'faraday'
@@ -5,6 +6,10 @@ require 'openssl'
 require 'openssl'
 require 'ld-eventsource'
 require 'prefab_pb'
+require 'prefab/error'
+require 'prefab/errors/initialization_timeout_error'
+require 'prefab/errors/invalid_api_key_error'
+require 'prefab/errors/missing_default_error'
 require 'prefab_services_pb'
 require 'prefab/options'
 require 'prefab/internal_logger'

data/lib/prefab_pb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: prefab.proto
 

data/lib/prefab_services_pb.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: prefab.proto for package 'prefab'
 

data/prefab-cloud-ruby.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: prefab-cloud-ruby 0.12.0 ruby lib
+# stub: prefab-cloud-ruby 0.13.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "prefab-cloud-ruby".freeze
-  s.version = "0.12.0"
+  s.version = "0.13.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jeff Dwyer".freeze]
-  s.date = "2022-07-21"
+  s.date = "2022-08-10"
   s.description = "RateLimits & Config as a service".freeze
   s.email = "jdwyer@prefab.cloud".freeze
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".envrc",
+    ".github/workflows/ruby.yml",
     ".tool-versions",
     "CODEOWNERS",
     "Gemfile",
@@ -37,6 +38,10 @@ Gem::Specification.new do |s|
     "lib/prefab/config_helper.rb",
     "lib/prefab/config_loader.rb",
     "lib/prefab/config_resolver.rb",
+    "lib/prefab/error.rb",
+    "lib/prefab/errors/initialization_timeout_error.rb",
+    "lib/prefab/errors/invalid_api_key_error.rb",
+    "lib/prefab/errors/missing_default_error.rb",
     "lib/prefab/feature_flag_client.rb",
     "lib/prefab/internal_logger.rb",
     "lib/prefab/logger_client.rb",
@@ -44,7 +49,6 @@ Gem::Specification.new do |s|
     "lib/prefab/noop_cache.rb",
     "lib/prefab/noop_stats.rb",
     "lib/prefab/options.rb",
-    "lib/prefab/prefab.rb",
     "lib/prefab/ratelimit_client.rb",
     "lib/prefab_pb.rb",
     "lib/prefab_services_pb.rb",
@@ -52,6 +56,7 @@ Gem::Specification.new do |s|
     "run_test_harness_server.sh",
     "test/.prefab.test.config.yaml",
     "test/harness_server.rb",
+    "test/test_client.rb",
     "test/test_config_client.rb",
     "test/test_config_loader.rb",
     "test/test_config_resolver.rb",
@@ -76,7 +81,6 @@ Gem::Specification.new do |s|
     s.add_runtime_dependency(%q<google-protobuf>.freeze, [">= 0"])
     s.add_runtime_dependency(%q<googleapis-common-protos-types>.freeze, [">= 0"])
     s.add_development_dependency(%q<grpc-tools>.freeze, [">= 0"])
-    s.add_development_dependency(%q<shoulda>.freeze, [">= 0"])
     s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
     s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
     s.add_development_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])
@@ -90,7 +94,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<google-protobuf>.freeze, [">= 0"])
     s.add_dependency(%q<googleapis-common-protos-types>.freeze, [">= 0"])
     s.add_dependency(%q<grpc-tools>.freeze, [">= 0"])
-    s.add_dependency(%q<shoulda>.freeze, [">= 0"])
     s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
     s.add_dependency(%q<bundler>.freeze, [">= 0"])
     s.add_dependency(%q<juwelier>.freeze, ["~> 2.4.9"])

data/run_test_harness_server.sh

@@ -1,2 +1,8 @@
-PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug PREFAB_CLOUD_HTTP=true PREFAB_GRPC_URL="localhost:50051" ruby -Ilib test/harness_server.rb
-#GRPC_TRACE=all GRPC_VERBOSITY=DEBUG PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug PREFAB_CLOUD_HTTP=true PREFAB_API_KEY="1|local_development_api_key" PREFAB_API_URL="localhost:50051" ruby -Ilib test/harness_server.rb
+#! /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/.prefab.test.config.yaml

@@ -2,9 +2,31 @@ sample: default sample value
 sample_int: 123
 sample_double: 12.12
 sample_bool: true
+false_value: false
+zero_value: 0
 sample_to_override: Foo
 prefab.log_level: debug
 unit_tests:
   sample: test sample value
+  enabled_flag: true
+  disabled_flag: false
+  flag_with_a_value:
+    feature_flag: true
+    value: "all-features"
+  in_lookup_key:
+    feature_flag: true
+    value: true
+    criteria:
+      operator: LOOKUP_KEY_IN
+      values:
+        - abc123
+        - xyz987
+  just_my_domain:
+    feature_flag: true
+    value: new-version
+    criteria:
+      operator: PROP_IS_ONE_OF
+      property: domain
+      values: ["prefab.cloud", "example.com"]
 ignored_env:
   sample: ignored value

data/test/harness_server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'prefab-cloud-ruby'
 require 'rack'
 require 'base64'
@@ -20,11 +21,19 @@ class RackApp
     is_feature_flag = !props["feature_flag"].nil?
     attributes = props["attributes"]
     puts props
-    client = Prefab::Client.new(
+
+    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}"

data/test/test_client.rb

@@ -0,0 +1,91 @@
+# 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,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class TestConfigClient < Minitest::Test
@@ -6,8 +7,9 @@ class TestConfigClient < Minitest::Test
       prefab_config_override_dir: "none",
       prefab_config_classpath_dir: "test",
       defaults_env: "unit_tests",
-      local_only: true
+      prefab_datasources: Prefab::Options::DATASOURCES::LOCAL_ONLY
     )
+
     @config_client = Prefab::ConfigClient.new(MockBaseClient.new(options), 10)
   end
 
@@ -16,4 +18,39 @@ class TestConfigClient < Minitest::Test
     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

data/test/test_config_loader.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class TestConfigLoader < Minitest::Test
@@ -89,5 +90,4 @@ class TestConfigLoader < Minitest::Test
     assert_equal type, @loader.calc_config[key][:config].rows[0].value.type
     assert_equal value, @loader.calc_config[key][:config].rows[0].value.send(type)
   end
-
 end

data/test/test_config_resolver.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class TestConfigResolver < Minitest::Test
@@ -174,7 +175,6 @@ class TestConfigResolver < Minitest::Test
       assert_equal "value", @resolverKeyWith.get("Key:With:Colons")
 
       @resolverKeyWithExtra = resolver_for_namespace("Key:With:Extra", @loader)
-      puts @resolverKeyWithExtra.to_s
       assert_nil @resolverKeyWithExtra.get("Colons")
       assert_nil @resolverKeyWithExtra.get("With:Colons")
       assert_equal "value", @resolverKeyWithExtra.get("Key:With:Colons")

data/test/test_feature_flag_client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class TestFeatureFlagClient < Minitest::Test
@@ -8,6 +9,7 @@ class TestFeatureFlagClient < Minitest::Test
     @client = Prefab::FeatureFlagClient.new(@mock_base_client)
     Prefab::FeatureFlagClient.send(:public, :is_on?) #publicize for testing
     Prefab::FeatureFlagClient.send(:public, :segment_match?) #publicize for testing
+    Prefab::FeatureFlagClient.send(:public, :get_variant) #publicize for testing
   end
 
   def test_pct
@@ -37,10 +39,10 @@ class TestFeatureFlagClient < Minitest::Test
 
     # "1FlagNamehashes high" hashes to 86.322% through dist
     assert_equal false,
-                 @client.evaluate(feature, "hashes high", [], flag, variants)
+                 evaluate(feature, "hashes high", [], flag, variants)
     # "1FlagNamehashes low" hashes to 44.547% through dist
     assert_equal true,
-                 @client.evaluate(feature, "hashes low", [], flag, variants)
+                 evaluate(feature, "hashes low", [], flag, variants)
 
   end
 
@@ -56,9 +58,9 @@ class TestFeatureFlagClient < Minitest::Test
       rules: default_ff_rule(2)
     )
     assert_equal true,
-                 @client.evaluate(feature, "hashes high", [], flag, variants)
+                 evaluate(feature, "hashes high", [], flag, variants)
     assert_equal true,
-                 @client.evaluate(feature, "hashes low", [], flag, variants)
+                 evaluate(feature, "hashes low", [], flag, variants)
 
     variants = [
       Prefab::FeatureFlagVariant.new(bool: false),
@@ -70,9 +72,9 @@ class TestFeatureFlagClient < Minitest::Test
       rules: default_ff_rule(2)
     )
     assert_equal false,
-                 @client.evaluate(feature, "hashes high", [], flag, variants)
+                 evaluate(feature, "hashes high", [], flag, variants)
     assert_equal false,
-                 @client.evaluate(feature, "hashes low", [], flag, variants)
+                 evaluate(feature, "hashes low", [], flag, variants)
   end
 
   def test_inclusion_rule
@@ -108,9 +110,9 @@ class TestFeatureFlagClient < Minitest::Test
     )
 
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:1", [], flag, variants)
+                 evaluate(feature, "user:1", [], flag, variants)
     assert_equal "default",
-                 @client.evaluate(feature, "user:2", [], flag, variants)
+                 evaluate(feature, "user:2", [], flag, variants)
 
   end
 
@@ -148,13 +150,13 @@ class TestFeatureFlagClient < Minitest::Test
     )
 
     assert_equal "default",
-                 @client.evaluate(feature, "user:1", { email: "not@example.com" }, flag, variants)
+                 evaluate(feature, "user:1", { email: "not@example.com" }, flag, variants)
     assert_equal "default",
-                 @client.evaluate(feature, "user:2", {}, flag, variants)
+                 evaluate(feature, "user:2", {}, flag, variants)
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:2", { email: "b@example.com" }, flag, variants)
+                 evaluate(feature, "user:2", { email: "b@example.com" }, flag, variants)
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:2", { "email" => "b@example.com" }, flag, variants)
+                 evaluate(feature, "user:2", { "email" => "b@example.com" }, flag, variants)
 
   end
 
@@ -223,9 +225,9 @@ class TestFeatureFlagClient < Minitest::Test
     )
 
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:1", [], flag, variants)
+                 evaluate(feature, "user:1", [], flag, variants)
     assert_equal "default",
-                 @client.evaluate(feature, "user:2", [], flag, variants)
+                 evaluate(feature, "user:2", [], flag, variants)
 
   end
 
@@ -285,16 +287,20 @@ class TestFeatureFlagClient < Minitest::Test
     )
 
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:1", [], flag, variants)
+                 evaluate(feature, "user:1", [], flag, variants)
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:2", [], flag, variants), "matches segment 1"
+                 evaluate(feature, "user:2", [], flag, variants), "matches segment 1"
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:3", [], flag, variants)
+                 evaluate(feature, "user:3", [], flag, variants)
     assert_equal "rule target",
-                 @client.evaluate(feature, "user:4", [], flag, variants)
+                 evaluate(feature, "user:4", [], flag, variants)
     assert_equal "default",
-                 @client.evaluate(feature, "user:5", [], flag, variants)
+                 evaluate(feature, "user:5", [], flag, variants)
 
   end
 
+  def evaluate(feature_name, lookup_key, attributes, flag, variants)
+    variant = @client.get_variant(feature_name, lookup_key, attributes, flag, variants)
+    @client.value_of_variant(variant)
+  end
 end

data/test/test_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'minitest/autorun'
 require 'prefab-cloud-ruby'
 
@@ -35,8 +36,8 @@ class MockConfigClient
   def initialize(config_values = {})
     @config_values = config_values
   end
-  def get(key)
-    @config_values[key]
+  def get(key, default=nil)
+    @config_values.fetch(key, default)
   end
 
   def get_config(key)
@@ -67,3 +68,22 @@ def default_ff_rule(variant_idx)
     )
   ]
 end
+
+def with_env(key, value)
+  old_value = ENV[key]
+
+  ENV[key] = value
+ensure
+  ENV[key] = old_value
+end
+
+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

data/test/test_logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'test_helper'
 
 class TestCLogger < Minitest::Test
@@ -18,24 +19,27 @@ class TestCLogger < Minitest::Test
   end
 
   def test_level_of
-    assert_equal Logger::INFO,
-                 @logger.level_of("app.models.user"), "PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL is info"
-
-    @logger.set_config_client(MockConfigClient.new({}))
-    assert_equal Logger::WARN,
-                 @logger.level_of("app.models.user"), "default is warn"
-
-    @logger.set_config_client(MockConfigClient.new("log_level.app" => "info"))
-    assert_equal Logger::INFO,
-                 @logger.level_of("app.models.user")
-
-    @logger.set_config_client(MockConfigClient.new("log_level.app" => "debug"))
-    assert_equal Logger::DEBUG,
-                 @logger.level_of("app.models.user")
-
-    @logger.set_config_client(MockConfigClient.new("log_level.app" => "debug",
-                                                   "log_level.app.models" => "warn"))
-    assert_equal Logger::WARN,
-                 @logger.level_of("app.models.user")
+    with_env("PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL", "info") do
+      # env var overrides the default level
+      assert_equal Logger::INFO,
+        @logger.level_of("app.models.user"), "PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL is info"
+
+      @logger.set_config_client(MockConfigClient.new({}))
+      assert_equal Logger::WARN,
+                  @logger.level_of("app.models.user"), "default is warn"
+
+      @logger.set_config_client(MockConfigClient.new("log_level.app" => "info"))
+      assert_equal Logger::INFO,
+                  @logger.level_of("app.models.user")
+
+      @logger.set_config_client(MockConfigClient.new("log_level.app" => "debug"))
+      assert_equal Logger::DEBUG,
+                  @logger.level_of("app.models.user")
+
+      @logger.set_config_client(MockConfigClient.new("log_level.app" => "debug",
+                                                    "log_level.app.models" => "warn"))
+      assert_equal Logger::WARN,
+                  @logger.level_of("app.models.user")
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prefab-cloud-ruby
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Jeff Dwyer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -114,20 +114,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +193,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".envrc"
+- ".github/workflows/ruby.yml"
 - ".tool-versions"
 - CODEOWNERS
 - Gemfile
@@ -224,6 +211,10 @@ files:
 - lib/prefab/config_helper.rb
 - lib/prefab/config_loader.rb
 - lib/prefab/config_resolver.rb
+- lib/prefab/error.rb
+- lib/prefab/errors/initialization_timeout_error.rb
+- lib/prefab/errors/invalid_api_key_error.rb
+- lib/prefab/errors/missing_default_error.rb
 - lib/prefab/feature_flag_client.rb
 - lib/prefab/internal_logger.rb
 - lib/prefab/logger_client.rb
@@ -231,7 +222,6 @@ files:
 - lib/prefab/noop_cache.rb
 - lib/prefab/noop_stats.rb
 - lib/prefab/options.rb
-- lib/prefab/prefab.rb
 - lib/prefab/ratelimit_client.rb
 - lib/prefab_pb.rb
 - lib/prefab_services_pb.rb
@@ -239,6 +229,7 @@ files:
 - run_test_harness_server.sh
 - test/.prefab.test.config.yaml
 - test/harness_server.rb
+- test/test_client.rb
 - test/test_config_client.rb
 - test/test_config_loader.rb
 - test/test_config_resolver.rb

data/lib/prefab/prefab.rb

@@ -1,32 +0,0 @@
-module Prefab
-
-  @@singleton__mutex__ = Mutex.new
-
-  public
-
-  def self.initialize(options = nil)
-    @@singleton__mutex__.synchronize do
-      unless @singleton.nil?
-        puts 'Prefab Double Initialization'
-        return @singleton
-      end
-      @singleton = Prefab::Client.new(options)
-    end
-  end
-
-  def self.get(key)
-    require_initialization
-    @singleton.config_client.get(key)
-  end
-
-  private
-
-  def self.require_initialization
-    if @singleton.nil?
-      puts "Prefab initializing for you. You probably want to call Prefab.initialize(Prefab::Options.new())"
-      self.initialize
-    end
-  end
-  module_function initialize
-  module_function get
-end