sdk-reforge 1.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c692e3a481a6340630232b56282b7e2dfa1e55102a03e910bb2522cc49a7660
+  data.tar.gz: e4485f45667650616b375e9b1d4aa76b03f3377744fb223d2807e4a30e99a7f4
+SHA512:
+  metadata.gz: a378c5553acaf78760bdad194c3843f2d565a3cb8e66e4db3f462b5555748394674df9fa5a599eea144d533f6069dd3bc7a052bce3e604ede4193703e79fa719
+  data.tar.gz: 39b53e20a22e1c793bbb9bbe4dbde40c90dcea9ac0298be835fea3a22c222dec28e1cb12741fe8564952201de30db3e5700204430104df475c99c514cca3d611

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/CODEOWNERS

@@ -0,0 +1,2 @@
+# All changes require review from prefabdevs team
+* @prefab-cloud/prefabdevs

data/.github/pull_request_template.md

@@ -0,0 +1,8 @@
+## Description
+*(Brief overview of what this PR changes and/or why the changes are needed)*
+
+## Testing & Validation
+*(Outline the steps needed to be taken to verify the changes.)*
+
+## Rollout
+*(Optional section: Provide rollout and rollback procedures, when outside the bounds or requiring additional work beyond standard deployment)*

data/.github/workflows/ruby.yml

@@ -0,0 +1,48 @@
+# 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: ['3.1','3.2','3.3','3.4']
+
+    steps:
+    - uses: actions/checkout@v4
+      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: false # runs 'bundle install' and caches installed gems automatically
+    - name: Install dependencies
+      run: bundle install --without development --jobs 4 --retry 3
+    - name: Run tests
+      run: bundle exec rake --trace
+      env:
+        REFORGE_INTEGRATION_TEST_SDK_KEY: ${{ secrets.REFORGE_INTEGRATION_TEST_SDK_KEY }}
+        REFORGE_INTEGRATION_TEST_ENCRYPTION_KEY: c87ba22d8662282abe8a0e4651327b579cb64a454ab0f4c170b45b15f049a221
+        NOT_A_NUMBER: "abcd"
+        IS_A_NUMBER: "1234"

data/.gitmodules

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

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.2.7

data/CHANGELOG.md

@@ -0,0 +1,257 @@
+# Changelog
+
+
+## 1.9.0 - 2025-08-23
+
+- Moved to reforge gem name `sdk-reforge`
+- Add automated gem publishing via GitHub Actions trusted publishing
+- Add support for `reforge.current-time` virtual context
+- Dropped the previous implementation of dynamic logging support
+- Removed local file loading based on prefab-envs
+
+## 1.8.9 - 2025-04-15
+
+- Fix support for virtual context `prefab.current-time` [#229]
+
+## 1.8.8 - 2025-02-28
+
+- Add conditional fetch support for configurations [#226]
+- Operator support for string starts with, contains [#212]
+- Operator support for regex, semver (protobuf update) [#215]
+- Operator support for date comparison (before/after) [#221]
+- Operator support for numeric comparisons [#220]
+
+
+## 1.8.7 - 2024-10-25
+
+- Add option symbolize_json_names [#211]
+
+
+## 1.8.6 - 2024-10-07
+
+- Fix deprecation warning caused by x_datafile being set by default [#208]
+
+## 1.8.5 - 2024-09-27
+
+- Fix JS bootstrapping and improve performance [#206]
+- Promote `datafile` from `x_datafile` [#205]
+
+## 1.8.4 - 2024-09-19
+
+- Use `stream` subdomain for SSE [#203]
+
+## 1.8.3 - 2024-09-16
+
+- Add JavaScript stub & bootstrapping [#200]
+
+## 1.8.2 - 2024-09-03
+
+- Forbid bad semantic_logger version [#198]
+
+## 1.8.1 - 2024-09-03
+
+- Fix SSE reconnection bug [#197]
+
+## 1.8.0 - 2024-08-22
+
+- Load config from belt and failover to suspenders [#195]
+
+## 1.7.2 - 2024-06-24
+
+- Support JSON config values [#194]
+
+## 1.7.1 - 2024-04-11
+
+- Ergonomics [#191]
+
+## 1.7.0 - 2024-04-10
+
+- Add duration support [#187]
+
+## 1.6.2 - 2024-03-29
+
+- Fix context telemetry when JIT and Block contexts are combined [#185]
+- Remove logger prefix [#186]
+
+## 1.6.1 - 2024-03-28
+
+- Performance optimizations [#178]
+- Global context [#182]
+
+## 1.6.0 - 2024-03-27
+
+- Use semantic_logger for internal logging [#173]
+- Remove Prefab::LoggerClient as a logger for end users [#173]
+- Provide log_filter for end users [#173]
+
+## 1.5.1 - 2024-02-22
+
+- Fix: Send context shapes by default [#174]
+
+## 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,29 @@
+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 'semantic_logger', '!= 4.16.0', require: "semantic_logger/sync"
+
+group :development do
+  gem 'allocation_stats'
+  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'
+  gem 'webrick'
+end

data/Gemfile.lock

@@ -0,0 +1,182 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.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.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    allocation_stats (0.1.5)
+    ansi (1.5.0)
+    base64 (0.2.0)
+    benchmark-ips (2.13.0)
+    bigdecimal (3.1.7)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.4.0)
+    domain_name (0.6.20240107)
+    drb (2.2.1)
+    faraday (1.10.3)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    ffi (1.16.3)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
+      rake
+    git (1.19.1)
+      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.25.5)
+    googleapis-common-protos-types (1.14.0)
+      google-protobuf (~> 3.18)
+    hashie (3.6.0)
+    highline (3.0.1)
+    http (5.2.0)
+      addressable (~> 2.8)
+      base64 (~> 0.1)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    juwelier (2.4.9)
+      builder
+      bundler
+      git
+      github_api
+      highline
+      kamelcase (~> 0)
+      nokogiri
+      psych
+      rake
+      rdoc
+      semver2
+    jwt (2.8.1)
+      base64
+    kamelcase (0.0.2)
+      semver2 (~> 3)
+    ld-eventsource (2.2.2)
+      concurrent-ruby (~> 1.0)
+      http (>= 4.4.1, < 6.0.0)
+    llhttp-ffi (0.5.0)
+      ffi-compiler (~> 1.0)
+      rake (~> 13.0)
+    macaddr (1.7.2)
+      systemu (~> 2.6.5)
+    mini_portile2 (2.8.7)
+    minitest (5.22.3)
+    minitest-focus (1.4.0)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.6.1)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.4.0)
+    mutex_m (0.2.0)
+    nokogiri (1.16.7)
+      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 (5.1.2)
+      stringio
+    public_suffix (5.0.4)
+    racc (1.8.1)
+    rack (3.0.16)
+    rake (13.1.0)
+    rchardet (1.8.0)
+    rdoc (6.6.3.1)
+      psych (>= 4.0.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    semantic_logger (4.15.0)
+      concurrent-ruby (~> 1.0)
+    semver2 (3.4.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    stringio (3.1.0)
+    systemu (2.6.5)
+    thread_safe (0.3.6)
+    timecop (0.9.8)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    uuid (2.3.9)
+      macaddr (~> 1.0)
+    webrick (1.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 4)
+  allocation_stats
+  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
+  semantic_logger (!= 4.16.0)
+  simplecov
+  timecop
+  uuid
+  webrick
+
+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,105 @@
+# Reforge SDK for Ruby
+
+Ruby Client for Reforge Feature Flags and Config as a Service: https://launch.reforge.com
+
+```ruby
+client = Reforge::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/sdks/ruby
+
+## Supports
+
+- Feature Flags
+- Live Config
+- WebUI for tweaking config and feature flags
+
+## Installation
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'sdk-reforge'
+```
+
+Or install directly:
+
+```bash
+gem install sdk-reforge
+```
+
+## 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/application.rb
+Prefab.init # reads REFORGE_SDK_KEY env var by default
+```
+
+```ruby
+#puma.rb
+on_worker_boot do
+  Reforge.fork
+end
+```
+
+```ruby
+# unicorn.rb
+after_fork do |server, worker|
+  Reforge.fork
+end
+```
+
+
+
+## Contributing to reforge sdk for 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
+
+Release is automated via GitHub Actions using RubyGems trusted publishing. When tests pass on the main branch, a new version is automatically published to RubyGems.
+
+To release a new version:
+
+```shell
+# Update the version
+echo "1.9.1" > VERSION
+
+# Update the changelog with your changes
+# Edit CHANGELOG.md
+
+# Regenerate the gemspec
+bundle exec rake gemspec:generate
+
+# Create PR with changes
+git checkout -b release-1.9.1
+git commit -am "Release 1.9.1"
+git push origin release-1.9.1
+# Then create and merge PR to main
+```
+
+## Copyright
+
+Copyright (c) 2025 Reforge Inc. See LICENSE.txt for further details.
+