prefab-cloud-ruby 0.20.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d4612e27cae5a4e66065a16d8d70cb0b1c7120770eac8c7e09ce3ca0e48e82
-  data.tar.gz: 1d1f50b6b4605729b93d62194b17ed9a1fca739f435ec2a4e682482a293bffe6
+  metadata.gz: f5df09f0991b0d46c29ce33bc010116733960a5004ede7dd5a0df868b15e4a29
+  data.tar.gz: ded97aa4f8e2dc37e7581ee5d29c7bcb3eff88e7aa8f72fedb7bd9710050bfec
 SHA512:
-  metadata.gz: ed5a04b2a16a79b0963d9af2dd71955141fdd06e7d73a4897adf74245435cf33239f78b08bbde797b7420b7e988fbb76e5e4333e6da5350f1037502949c469e7
-  data.tar.gz: 1b6f556bb94a31c272d5cd3c585860cacb4698be61830379c1a1a7e2d2fdcb461c02777e0c6fdb6a2cc939dcb070a27237506bd3c21d69ccd723ec50dccfbf2a
+  metadata.gz: 5e44b86fabd88830aed86910f4ff9175df14a06dc30b19821c741c691a9637bcff69870de0d816c2348a650dc9eb5b3a3c54a4452f71039aaab2f042086c3536
+  data.tar.gz: d81cf8af71e9aa189e7ba8b7078af6472df4dc6e3b08a33771163363424986d8b194c0ed88fa961217758ee9e5d21ca5604810f96db53a80366d72df606cb6d7

data/.envrc.sample

@@ -0,0 +1,3 @@
+export AWS_ACCESS_KEY_ID=
+export AWS_SECRET_ACCESS_KEY=
+export PREFAB_INTEGRATION_TEST_API_KEY=

data/.github/workflows/ruby.yml

@@ -22,10 +22,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v3
+      with:
+        submodules: recursive
     - 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):
@@ -37,3 +39,5 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
       run: bundle exec rake
+      env:
+        PREFAB_INTEGRATION_TEST_API_KEY: ${{ secrets.PREFAB_INTEGRATION_TEST_API_KEY }}

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "test/prefab-cloud-integration-test-data"]
+	path = test/prefab-cloud-integration-test-data
+	url = git@github.com:prefab-cloud/prefab-cloud-integration-test-data

data/Gemfile

@@ -1,23 +1,25 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gem 'concurrent-ruby', '~> 1.0', '>= 1.0.5'
 gem 'faraday'
+gem 'googleapis-common-protos-types', platforms: :ruby
+gem 'google-protobuf', platforms: :ruby
+gem 'grpc', platforms: :ruby
 gem 'ld-eventsource'
-gem 'grpc', :platforms => :ruby
-gem 'google-protobuf', :platforms => :ruby
-gem 'googleapis-common-protos-types', :platforms => :ruby
+gem 'uuid'
 
 group :development do
   gem 'benchmark-ips'
-  gem 'grpc-tools', :platforms => :ruby
-  gem "rdoc"
-  gem "bundler"
-  gem "juwelier", "~> 2.4.9"
-  gem "simplecov", ">= 0"
-  gem 'thin'
+  gem 'bundler'
+  gem 'grpc-tools', platforms: :ruby
+  gem 'juwelier', '~> 2.4.9'
+  gem 'rdoc'
+  gem 'simplecov', '>= 0'
 end
 
 group :test do
-  gem "minitest"
-  gem "minitest-focus"
+  gem 'minitest'
+  gem 'minitest-focus'
+  gem 'minitest-reporters'
+  gem 'timecop'
 end

data/Gemfile.lock

@@ -3,16 +3,15 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
     benchmark-ips (2.10.0)
     builder (3.2.4)
     concurrent-ruby (1.1.10)
-    daemons (1.4.1)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     docile (1.3.5)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    eventmachine (1.2.7)
     faraday (1.3.0)
       faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
@@ -22,7 +21,8 @@ GEM
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
-    git (1.11.0)
+    git (1.13.0)
+      addressable (~> 2.8)
       rchardet (~> 1.8)
     github_api (0.19.0)
       addressable (~> 2.4)
@@ -68,43 +68,51 @@ GEM
     llhttp-ffi (0.3.1)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
+    macaddr (1.7.2)
+      systemu (~> 2.6.5)
     mini_portile2 (2.8.0)
     minitest (5.16.2)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
+    minitest-reporters (1.5.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
     multi_json (1.15.0)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    nokogiri (1.13.9)
+    nokogiri (1.13.10)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    oauth2 (1.4.7)
-      faraday (>= 0.8, < 2.0)
+    oauth2 (1.4.11)
+      faraday (>= 0.17.3, < 3.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
+      rack (>= 1.2, < 4)
     psych (3.3.1)
     public_suffix (4.0.6)
-    racc (1.6.0)
-    rack (2.2.4)
+    racc (1.6.1)
+    rack (3.0.4.1)
     rake (13.0.6)
     rchardet (1.8.0)
     rdoc (6.3.3)
+    ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.4)
     semver2 (3.4.2)
     simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
     simplecov-html (0.12.3)
-    thin (1.8.1)
-      daemons (~> 1.0, >= 1.0.9)
-      eventmachine (~> 1.0, >= 1.0.4)
-      rack (>= 1, < 3)
+    systemu (2.6.5)
     thread_safe (0.3.6)
+    timecop (0.9.4)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8)
+    uuid (2.3.9)
+      macaddr (~> 1.0)
 
 PLATFORMS
   ruby
@@ -122,9 +130,11 @@ DEPENDENCIES
   ld-eventsource
   minitest
   minitest-focus
+  minitest-reporters
   rdoc
   simplecov
-  thin
+  timecop
+  uuid
 
 BUNDLED WITH
    2.3.5

data/README.md

@@ -3,18 +3,20 @@ Ruby Client for Prefab FeatureFlags, Config as a Service: https://www.prefab.clo
 
 ```ruby
 client = Prefab::Client.new
-@feature_flags = client.feature_flag_client
 
-# Create a flag that is on for 10% of traffic, the entire beta group and user:1
-@feature_flags.upsert(Prefab::FeatureFlag.new(feature: "MyFeature", pct: 0.1, whitelisted: ["betas", "user:1"]))
+lookup_key = "user-123"
+identity_attributes = {
+  team_id: 432,
+  user_id: 123,
+  subscription_level: 'pro',
+  email: "alice@example.com"
+}
 
-# Use Flags By Themselves
-puts @feature_flags.feature_is_on? "MyFeature"  # returns yes 10 pct of the time
+result = client.enabled? "my-first-feature-flag", lookup_key, identity_attributes
 
-# A single user should get the same result each time
-puts @feature_flags.feature_is_on? "MyFeature", "user:1123"
+puts "my-first-feature-flag is: #{result} for #{lookup_key}"
 ```
-See full documentation https://www.prefab.cloud/documentation/installation
+See full documentation https://docs.prefab.cloud/docs/ruby-sdk/ruby
 
 ## Supports
 
@@ -41,7 +43,7 @@ end
 ```
 
 ## Logging & Debugging
-In classpath or ~/.prefab.overrides.config.yaml set
+In classpath or ~/.prefab.default.config.yaml set
 
 ```
 log-level:
@@ -74,5 +76,5 @@ REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
 
 ## Copyright
 
-Copyright (c) 2022 Jeff Dwyer. See LICENSE.txt for
+Copyright (c) 2023 Jeff Dwyer. See LICENSE.txt for
 further details.

data/Rakefile

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 require 'rubygems'
@@ -6,21 +5,21 @@ require 'bundler'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
 require 'juwelier'
 Juwelier::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
-  gem.name = "prefab-cloud-ruby"
-  gem.homepage = "http://github.com/prefab-cloud/prefab-cloud-ruby"
-  gem.license = "MIT"
-  gem.summary = %Q{Prefab Ruby Infrastructure}
-  gem.description = %Q{RateLimits & Config as a service}
-  gem.email = "jdwyer@prefab.cloud"
-  gem.authors = ["Jeff Dwyer"]
+  gem.name = 'prefab-cloud-ruby'
+  gem.homepage = 'http://github.com/prefab-cloud/prefab-cloud-ruby'
+  gem.license = 'MIT'
+  gem.summary = %(Prefab Ruby Infrastructure)
+  gem.description = %(RateLimits & Config as a service)
+  gem.email = 'jdwyer@prefab.cloud'
+  gem.authors = ['Jeff Dwyer']
 
   # dependencies defined in Gemfile
 end
@@ -32,17 +31,17 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-desc "Code coverage detail"
+desc 'Code coverage detail'
 task :simplecov do
-  ENV['COVERAGE'] = "true"
+  ENV['COVERAGE'] = 'true'
   Rake::Task['test'].execute
 end
 
-task :default => :test
+task default: :test
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "prefab-cloud-ruby #{version}"

data/VERSION

@@ -1 +1 @@
-0.20.0
+0.22.0

data/lib/prefab/auth_interceptor.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Prefab
   class AuthInterceptor < GRPC::ClientInterceptor
-    VERSION = File.exist?('VERSION') ? File.read('VERSION').chomp : ""
+    VERSION = File.exist?('VERSION') ? File.read('VERSION').chomp : ''
     CLIENT = "prefab-cloud-ruby.#{VERSION}".freeze
 
     def initialize(api_key)

data/lib/prefab/cancellable_interceptor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Prefab
   class CancellableInterceptor < GRPC::ClientInterceptor
     WAIT_SEC = 3
@@ -8,20 +9,20 @@ module Prefab
     end
 
     def cancel
-      @call.instance_variable_get("@wrapped").instance_variable_get("@call").cancel
+      @call.instance_variable_get('@wrapped').instance_variable_get('@call').cancel
       i = 0
-      while (i < WAIT_SEC) do
-        if @call.instance_variable_get("@wrapped").cancelled?
-          @base_client.log_internal Logger::DEBUG, "Cancelled streaming."
+      while i < WAIT_SEC
+        if @call.instance_variable_get('@wrapped').cancelled?
+          @base_client.log_internal ::Logger::DEBUG, 'Cancelled streaming.'
           return
         else
-          @base_client.log_internal Logger::DEBUG, "Unable to cancel streaming. Trying again"
-          @call.instance_variable_get("@wrapped").instance_variable_get("@call").cancel
+          @base_client.log_internal ::Logger::DEBUG, 'Unable to cancel streaming. Trying again'
+          @call.instance_variable_get('@wrapped').instance_variable_get('@call').cancel
           i += 1
           sleep(1)
         end
       end
-      @base_client.log_internal Logger::INFO, "Unable to cancel streaming."
+      @base_client.log_internal ::Logger::INFO, 'Unable to cancel streaming.'
     end
 
     def request_response(request:, call:, method:, metadata:, &block)

data/lib/prefab/client.rb

@@ -1,28 +1,41 @@
 # frozen_string_literal: true
+
+require 'uuid'
+
 module Prefab
   class Client
     MAX_SLEEP_SEC = 10
     BASE_SLEEP_SEC = 0.5
     NO_DEFAULT_PROVIDED = :no_default_provided
 
-    attr_reader :shared_cache, :stats, :namespace, :interceptor, :api_key, :prefab_api_url, :options
+    attr_reader :shared_cache
+    attr_reader :stats
+    attr_reader :namespace
+    attr_reader :interceptor
+    attr_reader :api_key
+    attr_reader :prefab_api_url
+    attr_reader :options
+    attr_reader :instance_hash
 
     def initialize(options = Prefab::Options.new)
-      @options = options
+      @options = options.is_a?(Prefab::Options) ? options : Prefab::Options.new(options)
       @shared_cache = @options.shared_cache
       @stats = @options.stats
       @namespace = @options.namespace
       @stubs = {}
+      @instance_hash = UUID.new.generate
 
       if @options.local_only?
-        log_internal Logger::INFO, "Prefab Running in Local Mode"
+        log_internal ::Logger::INFO, 'Prefab Running in Local Mode'
       else
         @api_key = @options.api_key
-        raise Prefab::Errors::InvalidApiKeyError.new(@api_key) if @api_key.nil? || @api_key.empty? || api_key.count("-") < 1
+        raise Prefab::Errors::InvalidApiKeyError, @api_key if @api_key.nil? || @api_key.empty? || api_key.count('-') < 1
+
         @interceptor = Prefab::AuthInterceptor.new(@api_key)
         @prefab_api_url = @options.prefab_api_url
         @prefab_grpc_url = @options.prefab_grpc_url
-        log_internal Logger::INFO, "Prefab Connecting to: #{@prefab_api_url} and #{@prefab_grpc_url} Secure: #{http_secure?}"
+        log_internal ::Logger::INFO,
+                     "Prefab Connecting to: #{@prefab_api_url} and #{@prefab_grpc_url} Secure: #{http_secure?}"
         at_exit do
           channel.destroy
         end
@@ -46,9 +59,17 @@ module Prefab
       @feature_flag_client ||= Prefab::FeatureFlagClient.new(self)
     end
 
+    def log_path_collector
+      return nil if @options.collect_max_paths <= 0
+
+      @log_path_collector ||= LogPathCollector.new(client: self, max_paths: @options.collect_max_paths,
+                                                   sync_interval: @options.collect_sync_interval)
+    end
+
     def log
       @logger_client ||= Prefab::LoggerClient.new(@options.logdev, formatter: @options.log_formatter,
-                                                                   prefix: @options.log_prefix)
+                                                                   prefix: @options.log_prefix,
+                                                                   log_path_collector: log_path_collector)
     end
 
     def log_internal(level, msg, path = nil)
@@ -56,6 +77,9 @@ module Prefab
     end
 
     def request(service, method, req_options: {}, params: {})
+      # Future-proofing since we previously bumped into a conflict with a service with a `send` method
+      raise ArgumentError, 'Cannot call public_send on an grpc service in Ruby' if method.to_s == 'public_send'
+
       opts = { timeout: 10 }.merge(req_options)
 
       attempts = 0
@@ -63,18 +87,17 @@ module Prefab
 
       begin
         attempts += 1
-        return stub_for(service, opts[:timeout]).send(method, *params)
-      rescue => exception
 
-        log_internal Logger::WARN, exception
+        stub_for(service, opts[:timeout]).public_send(method, *params)
+      rescue StandardError => e
+        log_internal ::Logger::WARN, e
 
-        if Time.now - start_time > opts[:timeout]
-          raise exception
-        end
-        sleep_seconds = [BASE_SLEEP_SEC * (2 ** (attempts - 1)), MAX_SLEEP_SEC].min
-        sleep_seconds = sleep_seconds * (0.5 * (1 + rand()))
+        raise e if Time.now - start_time > opts[:timeout]
+
+        sleep_seconds = [BASE_SLEEP_SEC * (2**(attempts - 1)), MAX_SLEEP_SEC].min
+        sleep_seconds *= (0.5 * (1 + rand))
         sleep_seconds = [BASE_SLEEP_SEC, sleep_seconds].max
-        log_internal Logger::INFO, "Sleep #{sleep_seconds} and Reset #{service} #{method}"
+        log_internal ::Logger::INFO, "Sleep #{sleep_seconds} and Reset #{service} #{method}"
         sleep sleep_seconds
         reset!
         retry
@@ -86,24 +109,28 @@ module Prefab
       @_channel = nil
     end
 
-    def enabled?(feature_name, lookup_key=nil, attributes={})
+    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)
+    def get(key, default_or_lookup_key = NO_DEFAULT_PROVIDED, properties = {}, ff_default = nil)
+      if is_ff?(key)
+        feature_flag_client.get(key, default_or_lookup_key, properties, default: ff_default)
       else
-        result
+        config_client.get(key, default_or_lookup_key, properties)
       end
     end
 
     private
 
+    def is_ff?(key)
+      raw = config_client.send(:raw, key)
+
+      raw && raw.allowable_values.any?
+    end
+
     def http_secure?
-      ENV["PREFAB_CLOUD_HTTP"] != "true"
+      ENV['PREFAB_CLOUD_HTTP'] != 'true'
     end
 
     def stub_for(service, timeout)
@@ -119,7 +146,7 @@ module Prefab
     end
 
     def ssl_certs
-      ssl_certs = ""
+      ssl_certs = ''
       Dir["#{OpenSSL::X509::DEFAULT_CERT_DIR}/*.pem"].each do |cert|
         ssl_certs += File.open(cert).read
       end
@@ -127,11 +154,9 @@ module Prefab
         ssl_certs += File.open(OpenSSL::X509::DEFAULT_CERT_FILE).read
       end
       ssl_certs
-    rescue => e
+    rescue StandardError => e
       log.warn("Issue loading SSL certs #{e.message}")
       ssl_certs
     end
-
   end
 end
-