prefab-cloud-ruby 0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1aa20885e129588b6ccf76b4fddae442b7d285495a384d3e4d2aeba11b802089
+  data.tar.gz: 37bd9186041e1931d00f4a5c9fd518f7961a1564147b8693f03befdd9dc78dc9
+SHA512:
+  metadata.gz: 1de0d80c388ceb6a68d65da6b4998c1e2a398664e3a9d04f4fce4fd8943176638f53c5b89a903d75449039fd1de713595eafeb930f3108f0fee59cdd35d176de
+  data.tar.gz: 917f146a34fa76b8440d126ebceff1d0bd79c7944135142b944389d259ab10295b9b80937832dd6438a7a2e38e276a546f2f96bd7638427996a46ec0646324f6

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

@@ -0,0 +1,46 @@
+# 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.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):
+    # 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
+      env:
+        PREFAB_INTEGRATION_TEST_API_KEY: ${{ secrets.PREFAB_INTEGRATION_TEST_API_KEY }}
+        PREFAB_INTEGRATION_TEST_ENCRYPTION_KEY: ${{ secrets.PREFAB_INTEGRATION_TEST_ENCRYPTION_KEY }}
+        NOT_A_NUMBER: "abcd"
+        IS_A_NUMBER: "1234"

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/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - prefab-cloud-ruby.gemspec
+    - lib/prefab_pb.rb
+
+Metrics:
+  Exclude:
+    - 'test/*.rb'
+
+Layout/LineLength:
+  Exclude:
+    - 'test/*.rb'

data/.tool-versions

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

data/CHANGELOG.md

@@ -0,0 +1,169 @@
+# Changelog
+
+## 1.5.0 - 2024-02-12
+
+- Fix potential inconsistent Context behavior (#172)
+
+## 1.4.5 - 2024-01-31
+
+- Refactor out a `should_log?` method (#170)
+
+## 1.4.4 - 2024-01-26
+
+- Raise when ENV var is missing
+
+## 1.4.3 - 2024-01-17
+
+- Updated proto definition file
+
+## 1.4.2 - 2023-12-14
+
+- Use reportable value even for invalid data (#166)
+
+## 1.4.1 - 2023-12-08
+
+- Include version in `get` request (#165)
+
+## 1.4.0 - 2023-11-28
+
+- ActiveJob tagged logger issue (#164)
+- Compact Log Format (#163)
+- Tagged Logging (#161)
+- ContextKey logging thread safety (#162)
+
+## 1.3.2 - 2023-11-15
+
+- Send back cloud.prefab logging telemetry (#160)
+
+## 1.3.1 - 2023-11-14
+
+- Improve path of rails.controller logging & fix strong param include (#159)
+
+## 1.3.0 - 2023-11-13
+
+- Less logging when wifi is off and we load from cache (#157)
+- Alpha: Add Provided & Secret Support (#152)
+- Alpha: x_datafile (#156)
+- Add single line action-controller output under rails.controller (#158)
+
+## 1.2.1 - 2023-11-01
+
+- Update protobuf definitions (#154)
+
+## 1.2.0 - 2023-10-30
+
+- Add `Prefab.get('key')` style usage after a `Prefab.init()` call (#151)
+- Add `add_context_keys` and `with_context_keys` method for LoggerClient (#145)
+
+## 1.1.2 - 2023-10-13
+
+- Add `cloud.prefab.client.criteria_evaluator` `debug` logging of evaluations (#150)
+- Add `x_use_local_cache` for local caching (#148)
+- Tests run in RubyMine (#147)
+
+## 1.1.1 - 2023-10-11
+
+- Migrate happy-path client-initialization logging to `DEBUG` level rather than `INFO` (#144)
+- Add `ConfigClientPresenter` for logging out stats upon successful client initialization (#144)
+- Add support for default context (#146)
+
+## 1.1.0 - 2023-09-18
+
+- Add support for structured logging (#143)
+  - Ability to pass a hash of key/value context pairs to any of the user-facing log methods
+
+## 1.0.1 - 2023-08-17
+
+- Bug fix for StringList w/ ExampleContextsAggregator (#141)
+
+## 1.0.0 - 2023-08-10
+
+- Removed EvaluatedKeysAggregator (#137)
+- Change `collect_evaluation_summaries` default to true (#136)
+- Removed some backwards compatibility shims (#133)
+- Standardizing options (#132)
+  - Note that the default value for `context_upload_mode` is `:periodic_example` which means example contexts will be collected.
+    This enables easy variant override assignment in our UI. More at https://prefab.cloud/blog/feature-flag-variant-assignment/
+
+## 0.24.6 - 2023-07-31
+
+- Logger Client compatibility (#129)
+- Replace EvaluatedConfigs with ExampleContexts (#128)
+- Add ConfigEvaluationSummaries (opt-in for now) (#123)
+
+## 0.24.5 - 2023-07-10
+
+- Report Client Version (#121)
+
+## [0.24.4] - 2023-07-06
+
+- Support Timed Loggers (#119)
+- Added EvaluatedConfigsAggregator (disabled by default) (#118)
+- Added EvaluatedKeysAggregator (disabled by default) (#117)
+- Dropped Ruby 2.6 support (#116)
+- Capture/report context shapes (#115)
+- Added bin/console (#114)
+
+## [0.24.3] - 2023-05-15
+
+- Add JSON log formatter (#106)
+
+# [0.24.2] - 2023-05-12
+
+- Fix bug in FF rollout eval consistency (#108)
+- Simplify forking (#107)
+
+# [0.24.1] - 2023-04-26
+
+- Fix misleading deprecation warning (#105)
+
+# [0.24.0] - 2023-04-26
+
+- Backwards compatibility for JIT context (#104)
+- Remove upsert (#103)
+- Add resolver presenter and `on_update` callback (#102)
+- Deprecate `lookup_key` and introduce Context (#99)
+
+# [0.23.8] - 2023-04-21
+
+- Update protobuf (#101)
+
+# [0.23.7] - 2023-04-21
+
+- Guard against ActiveJob not being loaded (#100)
+
+# [0.23.6] - 2023-04-17
+
+- Fix bug in FF rollout eval consistency (#98)
+- Add tests for block-form of logging (#96)
+
+# [0.23.5] - 2023-04-13
+
+- Cast the value to string when checking presence in string list (#95)
+
+# [0.23.4] - 2023-04-12
+
+- Remove GRPC (#93)
+
+# [0.23.3] - 2023-04-07
+
+- Use exponential backoff for log level uploading (#92)
+
+# [0.23.2] - 2023-04-04
+
+- Move log collection logs from INFO to DEBUG (#91)
+- Fix: Handle trailing slash in PREFAB_API_URL (#90)
+
+# [0.23.1] - 2023-03-30
+
+- ActiveStorage not defined in Rails < 5.2 (#87)
+
+# [0.23.0] - 2023-03-28
+
+- Convenience for setting Rails.logger (#85)
+- Log evaluation according to rules (#81)
+
+# [0.22.0] - 2023-03-15
+
+- Report log paths and usages (#79)
+- Accept hash or keyword args in `initialize` (#78)

data/CODEOWNERS

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

data/Gemfile

@@ -0,0 +1,26 @@
+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 'ld-eventsource'
+gem 'uuid'
+
+gem 'activesupport',  '>= 4'
+gem 'actionpack',  '>= 4'
+
+group :development do
+  gem 'benchmark-ips'
+  gem 'bundler'
+  gem 'juwelier', '~> 2.4.9'
+  gem 'rdoc'
+  gem 'simplecov', '>= 0'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'minitest-focus'
+  gem 'minitest-reporters'
+  gem 'timecop'
+end

data/Gemfile.lock

@@ -0,0 +1,188 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    base64 (0.2.0)
+    benchmark-ips (2.10.0)
+    bigdecimal (3.1.4)
+    builder (3.2.4)
+    concurrent-ruby (1.1.10)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    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)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    git (1.13.0)
+      addressable (~> 2.8)
+      rchardet (~> 1.8)
+    github_api (0.19.0)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (>= 0.8, < 2)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    google-protobuf (3.22.2)
+    googleapis-common-protos-types (1.5.0)
+      google-protobuf (~> 3.14)
+    hashie (3.6.0)
+    highline (2.0.3)
+    http (5.0.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.3.0)
+    http-cookie (1.0.4)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    juwelier (2.4.9)
+      builder
+      bundler
+      git
+      github_api
+      highline
+      kamelcase (~> 0)
+      nokogiri
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (2.2.2)
+    kamelcase (0.0.2)
+      semver2 (~> 3)
+    ld-eventsource (2.2.0)
+      concurrent-ruby (~> 1.0)
+      http (>= 4.4.1, < 6.0.0)
+    llhttp-ffi (0.3.1)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    loofah (2.21.4)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    macaddr (1.7.2)
+      systemu (~> 2.6.5)
+    mini_portile2 (2.8.2)
+    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)
+    mutex_m (0.2.0)
+    nokogiri (1.15.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    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, < 4)
+    psych (3.3.1)
+    public_suffix (4.0.6)
+    racc (1.7.0)
+    rack (3.0.6.1)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    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)
+    systemu (2.6.5)
+    thread_safe (0.3.6)
+    timecop (0.9.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8)
+    uuid (2.3.9)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 4)
+  activesupport (>= 4)
+  benchmark-ips
+  bundler
+  concurrent-ruby (~> 1.0, >= 1.0.5)
+  faraday
+  google-protobuf
+  googleapis-common-protos-types
+  juwelier (~> 2.4.9)
+  ld-eventsource
+  minitest
+  minitest-focus
+  minitest-reporters
+  rdoc
+  simplecov
+  timecop
+  uuid
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2023 Prefab, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,94 @@
+# prefab-cloud-ruby
+
+Ruby Client for Prefab Feature Flags, Dynamic log levels, and Config as a Service: https://www.prefab.cloud
+
+```ruby
+client = Prefab::Client.new
+
+context = {
+  user: {
+    team_id: 432,
+    id: 123,
+    subscription_level: 'pro',
+    email: "alice@example.com"
+  }
+}
+
+result = client.enabled? "my-first-feature-flag", context
+
+puts "my-first-feature-flag is: #{result}"
+```
+
+See full documentation https://docs.prefab.cloud/docs/ruby-sdk/ruby
+
+## Supports
+
+- Feature Flags
+- Dynamic log levels
+- Live Config
+- WebUI for tweaking config, log levels, and feature flags
+
+## Important note about Forking and realtime updates
+
+Many ruby web servers fork. When the process is forked, the current realtime update stream is disconnected. If you're using Puma or Unicorn, do the following.
+
+```ruby
+#config/initializers/prefab.rb
+$prefab = Prefab::Client.new
+$prefab.set_rails_loggers
+```
+
+```ruby
+#puma.rb
+on_worker_boot do
+  $prefab = $prefab.fork
+  $prefab.set_rails_loggers
+end
+```
+
+```ruby
+# unicorn.rb
+after_fork do |server, worker|
+  $prefab = $prefab.fork
+  $prefab.set_rails_loggers
+end
+```
+
+## Logging & Debugging
+
+In classpath or ~/.prefab.default.config.yaml set
+
+```
+log-level:
+  cloud.prefab: debug
+```
+
+To debug issues before this config file has been read, set env var
+
+```
+PREFAB_LOG_CLIENT_BOOTSTRAP_LOG_LEVEL=debug
+```
+
+## Contributing to prefab-cloud-ruby
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+- Fork the project.
+- Start a feature/bugfix branch.
+- Commit and push until you are happy with your contribution.
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Release
+
+```shell
+update the changelog
+update VERSION
+bundle exec rake gemspec:generate
+git commit & push
+REMOTE_BRANCH=main LOCAL_BRANCH=main bundle exec rake release
+```
+
+## Copyright
+
+Copyright (c) 2023 Jeff Dwyer. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  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 = %(Prefab Ruby Infrastructure)
+  gem.description = %(Feature Flags, Live Config, and Dynamic Log Levels as a service)
+  gem.email = 'jdwyer@prefab.cloud'
+  gem.authors = ['Jeff Dwyer']
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc 'Code coverage detail'
+task :simplecov do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end
+
+task default: :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "prefab-cloud-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.5.0

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'irb'
+require 'bundler/setup'
+
+gemspec = Dir.glob(File.expand_path("../../*.gemspec", __FILE__)).first
+spec = Gem::Specification.load(gemspec)
+
+# Add the require paths to the $LOAD_PATH
+spec.require_paths.each do |path|
+  full_path = File.expand_path("../" + path, __dir__)
+  $LOAD_PATH.unshift(full_path) unless $LOAD_PATH.include?(full_path)
+end
+
+spec.require_paths.each do |path|
+  require "./lib/prefab-cloud-ruby"
+end
+
+# Start an IRB session
+IRB.start(__FILE__)

data/compile_protos.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+set -e
+
+gem install grpc-tools
+
+(
+  cd ../prefab-cloud
+  git pull --rebase
+)
+
+grpc_tools_ruby_protoc -I ../prefab-cloud/ --ruby_out=lib --grpc_out=lib prefab.proto
+
+gsed -i 's/^module Prefab$/module PrefabProto/g' lib/prefab_pb.rb
+
+# on M1 you need to
+# 1. run in rosetta
+# 2. mv gems/2.6.0/gems/grpc-tools-1.43.1/bin/x86_64-macos x86-macos