featurehub-sdk 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d8c63466d2e3a9d0a83b3e536a7655a26399443eb593f95cad46ee5cf0ac50f
-  data.tar.gz: 8df77aebec08f1be8ee34c3a373043f9af5066aface8419897a7380c9530447f
+  metadata.gz: 0cd81cc23b520be9a702b06ab17071c1eddb40bd2a79cc0617c22509f1574cc9
+  data.tar.gz: e2c3cf069c8635fc574db0d6c5a8dcdef2170058d282747c2b0481f84998078b
 SHA512:
-  metadata.gz: e19c86bf6ed7ac3401d801d9b982915229472e518d35286d63d6d2ceef7904c8d8c86db765a73d60788a7c269214386d799297497abcac2b54f52fd49042c54f
-  data.tar.gz: 01aebf2525adcbc277555f918eec2757514b4de0cc945ccaec22e21a97ca55af5d5ad7745eac2121b27ede140e44ed1f1889d1bc016876394beee2f4864f8165
+  metadata.gz: 7092b35679401cd732ece4a49366a84e136df729d8bbdc3285da81ade5cb90ffad19a5431c9fe25e9c5b8f9b2c777a144e90859d22c9230c22f3278909de35af
+  data.tar.gz: a134bea6b240aa6aced1158e5c0bd70c4c3b7754d047387aeb517fdec8b35e2572599971aea11abfcdb477ed68dd2d29657b0747acd1a2c87fc93d59927e1457

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.2
 
 Style/StringLiterals:
   Enabled: true
@@ -35,7 +35,7 @@ Metrics/CyclomaticComplexity:
 Naming/FileName:
   Enabled: false
 
-Gemspec/DateAssignment: # new in 1.10
+Gemspec/DeprecatedAttributeAssignment:
   Enabled: true
 Gemspec/DeprecatedAttributeAssignment: # new in 1.30
   Enabled: true
@@ -101,6 +101,8 @@ Style/ArgumentsForwarding: # new in 1.1
   Enabled: true
 Style/CollectionCompact: # new in 1.2
   Enabled: true
+Style/Documentation:
+  Enabled: false
 Style/DocumentDynamicEvalDefinition: # new in 1.1
   Enabled: true
 Style/EndlessMethod: # new in 1.8

data/.ruby-version

@@ -1 +1 @@
-3.0.6
+3.2.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [1.3.0] - 2024-01-12
+
+- update gem dependencies
+- bump minimum ruby version to 3.2
+
+## [1.2.3] - 2024-01-12
+
+- fix for Interceptor contributed by Lukas
+
 ## [1.2.2] - 2023-08-07
 
 - Changed the log levels for API logging to debug

data/Gemfile

@@ -13,12 +13,12 @@ gem "rubocop", "~> 1.21"
 
 gem "simplecov", "~> 0.21"
 
-gem "concurrent-ruby", "~> 1.1"
+gem "concurrent-ruby", "~> 1.3"
 
 gem "faraday", "~> 2"
 
-gem "murmurhash3", "~> 0.1.6"
+gem "murmurhash3", "~> 0.1.7"
 
 gem "sem_version", "~> 2.0.0"
 
-gem "ld-eventsource", "~> 2.2.0"
+gem "ld-eventsource", "~> 2.3.0"

data/Gemfile.lock

@@ -1,107 +1,168 @@
 PATH
   remote: .
   specs:
-    featurehub-sdk (1.2.3)
-      concurrent-ruby (~> 1.1)
+    featurehub-sdk (1.3.0)
+      concurrent-ruby (~> 1.3)
       faraday (~> 2)
-      ld-eventsource (~> 2.2.0)
-      murmurhash3 (~> 0.1.6)
+      ld-eventsource (~> 2.3.0)
+      murmurhash3 (~> 0.1.7)
       sem_version (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    diff-lcs (1.5.0)
-    docile (1.4.0)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
-    faraday (2.3.0)
-      faraday-net_http (~> 2.0)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (2.0.3)
-    ffi (1.15.5)
-    ffi-compiler (1.0.1)
-      ffi (>= 1.0.0)
+    addressable (2.8.8)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    concurrent-ruby (1.3.6)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    domain_name (0.6.20240107)
+    faraday (2.14.0)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-net_http (3.4.2)
+      net-http (~> 0.5)
+    ffi (1.17.3-arm64-darwin)
+    ffi (1.17.3-x86_64-linux-gnu)
+    ffi-compiler (1.3.2)
+      ffi (>= 1.15.5)
       rake
-    http (5.0.4)
+    http (5.3.1)
       addressable (~> 2.8)
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
-      llhttp-ffi (~> 0.4.0)
-    http-cookie (1.0.5)
+      llhttp-ffi (~> 0.5.0)
+    http-cookie (1.1.0)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
-    ld-eventsource (2.2.0)
+    json (2.18.0)
+    language_server-protocol (3.17.0.5)
+    ld-eventsource (2.3.0)
       concurrent-ruby (~> 1.0)
       http (>= 4.4.1, < 6.0.0)
-    llhttp-ffi (0.4.0)
+    lint_roller (1.1.0)
+    llhttp-ffi (0.5.1)
       ffi-compiler (~> 1.0)
       rake (~> 13.0)
-    murmurhash3 (0.1.6)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    logger (1.7.0)
+    murmurhash3 (0.1.7)
+    net-http (0.9.1)
+      uri (>= 0.11.1)
+    parallel (1.27.0)
+    parser (3.3.10.0)
       ast (~> 2.4.1)
-    public_suffix (4.0.7)
+      racc
+    prism (1.6.0)
+    public_suffix (6.0.2)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.30.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+    rubocop (1.82.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    ruby2_keywords (0.0.5)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
     sem_version (2.0.1)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.8.2)
-    unicode-display_width (2.1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
 
 PLATFORMS
-  ruby
+  arm64-darwin
+  x86_64-linux
 
 DEPENDENCIES
-  concurrent-ruby (~> 1.1)
+  concurrent-ruby (~> 1.3)
   faraday (~> 2)
   featurehub-sdk!
-  ld-eventsource (~> 2.2.0)
-  murmurhash3 (~> 0.1.6)
+  ld-eventsource (~> 2.3.0)
+  murmurhash3 (~> 0.1.7)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   sem_version (~> 2.0.0)
   simplecov (~> 0.21)
 
+CHECKSUMS
+  addressable (2.8.8) sha256=7c13b8f9536cf6364c03b9d417c19986019e28f7c00ac8132da4eb0fe393b057
+  ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
+  concurrent-ruby (1.3.6) sha256=6b56837e1e7e5292f9864f34b69c5a2cbc75c0cf5338f1ce9903d10fa762d5ab
+  diff-lcs (1.6.2) sha256=9ae0d2cba7d4df3075fe8cd8602a8604993efc0dfa934cff568969efb1909962
+  docile (1.4.1) sha256=96159be799bfa73cdb721b840e9802126e4e03dfc26863db73647204c727f21e
+  domain_name (0.6.20240107) sha256=5f693b2215708476517479bf2b3802e49068ad82167bcd2286f899536a17d933
+  faraday (2.14.0) sha256=8699cfe5d97e55268f2596f9a9d5a43736808a943714e3d9a53e6110593941cd
+  faraday-net_http (3.4.2) sha256=f147758260d3526939bf57ecf911682f94926a3666502e24c69992765875906c
+  featurehub-sdk (1.3.0)
+  ffi (1.17.3-arm64-darwin) sha256=0c690555d4cee17a7f07c04d59df39b2fba74ec440b19da1f685c6579bb0717f
+  ffi (1.17.3-x86_64-linux-gnu) sha256=3746b01f677aae7b16dc1acb7cb3cc17b3e35bdae7676a3f568153fb0e2c887f
+  ffi-compiler (1.3.2) sha256=a94f3d81d12caf5c5d4ecf13980a70d0aeaa72268f3b9cc13358bcc6509184a0
+  http (5.3.1) sha256=c50802d8e9be3926cb84ac3b36d1a31fbbac383bc4cbecdce9053cb604231d7d
+  http-cookie (1.1.0) sha256=38a5e60d1527eebc396831b8c4b9455440509881219273a6c99943d29eadbb19
+  http-form_data (2.3.0) sha256=cc4eeb1361d9876821e31d7b1cf0b68f1cf874b201d27903480479d86448a5f3
+  json (2.18.0) sha256=b10506aee4183f5cf49e0efc48073d7b75843ce3782c68dbeb763351c08fd505
+  language_server-protocol (3.17.0.5) sha256=fd1e39a51a28bf3eec959379985a72e296e9f9acfce46f6a79d31ca8760803cc
+  ld-eventsource (2.3.0) sha256=b79187490fc567626c805b9f3d97d08a03d5e4cad045974b2089216bf37dba9f
+  lint_roller (1.1.0) sha256=2c0c845b632a7d172cb849cc90c1bce937a28c5c8ccccb50dfd46a485003cc87
+  llhttp-ffi (0.5.1) sha256=9a25a7fc19311f691a78c9c0ac0fbf4675adbd0cca74310228fdf841018fa7bc
+  logger (1.7.0) sha256=196edec7cc44b66cfb40f9755ce11b392f21f7967696af15d274dde7edff0203
+  murmurhash3 (0.1.7) sha256=370a2ce2e9ab0711e51554e530b5f63956927a6554a296855f42a1a4a5ed0936
+  net-http (0.9.1) sha256=25ba0b67c63e89df626ed8fac771d0ad24ad151a858af2cc8e6a716ca4336996
+  parallel (1.27.0) sha256=4ac151e1806b755fb4e2dc2332cbf0e54f2e24ba821ff2d3dcf86bf6dc4ae130
+  parser (3.3.10.0) sha256=ce3587fa5cc55a88c4ba5b2b37621b3329aadf5728f9eafa36bbd121462aabd6
+  prism (1.6.0) sha256=bfc0281a81718c4872346bc858dc84abd3a60cae78336c65ad35c8fbff641c6b
+  public_suffix (6.0.2) sha256=bfa7cd5108066f8c9602e0d6d4114999a5df5839a63149d3e8b0f9c1d3558394
+  racc (1.8.1) sha256=4a7f6929691dbec8b5209a0b373bc2614882b55fc5d2e447a21aaa691303d62f
+  rainbow (3.1.1) sha256=039491aa3a89f42efa1d6dec2fc4e62ede96eb6acd95e52f1ad581182b79bc6a
+  rake (13.3.1) sha256=8c9e89d09f66a26a01264e7e3480ec0607f0c497a861ef16063604b1b08eb19c
+  regexp_parser (2.11.3) sha256=ca13f381a173b7a93450e53459075c9b76a10433caadcb2f1180f2c741fc55a4
+  rspec (3.13.2) sha256=206284a08ad798e61f86d7ca3e376718d52c0bc944626b2349266f239f820587
+  rspec-core (3.13.6) sha256=a8823c6411667b60a8bca135364351dda34cd55e44ff94c4be4633b37d828b2d
+  rspec-expectations (3.13.5) sha256=33a4d3a1d95060aea4c94e9f237030a8f9eae5615e9bd85718fe3a09e4b58836
+  rspec-mocks (3.13.7) sha256=0979034e64b1d7a838aaaddf12bf065ea4dc40ef3d4c39f01f93ae2c66c62b1c
+  rspec-support (3.13.6) sha256=2e8de3702427eab064c9352fe74488cc12a1bfae887ad8b91cba480ec9f8afb2
+  rubocop (1.82.0) sha256=237b7dc24952d7ec469a9593c7a5283315515e2e7dc24ac91532819c254fc4ec
+  rubocop-ast (1.48.0) sha256=22df9bbf3f7a6eccde0fad54e68547ae1e2a704bf8719e7c83813a99c05d2e76
+  ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
+  sem_version (2.0.1) sha256=6d97d4f67e28546ba90b3c290f901d6c8031ddb8e08bce962139739c4d40b183
+  simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
+  simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
+  simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
+  unicode-display_width (3.2.0) sha256=0cdd96b5681a5949cdbc2c55e7b420facae74c4aaf9a9815eee1087cb1853c42
+  unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
+  uri (1.1.1) sha256=379fa58d27ffb1387eaada68c749d1426738bd0f654d812fcc07e7568f5c57c6
+
 BUNDLED WITH
-   2.1.4
+  4.0.3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 FeatureHub
+
+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,235 @@
+# Official FeatureHub Ruby SDK.
+
+## Overview
+To control the feature flags from the FeatureHub Admin console, either use our [demo](https://demo.featurehub.io) version for evaluation or install the app using our guide [here](https://docs.featurehub.io/featurehub/latest/installation.html)
+
+## SDK installation
+
+Add the featurehub sdk gem to your Gemfile and/or gemspec if you are creating a library:
+
+```
+gem `featurehub-sdk`
+```
+
+               
+To use it in your code, use:
+
+```ruby
+require 'featurehub-sdk'
+```
+
+## Options to get feature updates
+
+There are 2 ways to request for feature updates via this SDK:
+
+- **SSE (Server Sent Events) realtime updates mechanism**
+
+  In this mode, you will make a connection to the FeatureHub Edge server using using Server Sent Events, any updates to any features will come through in _near realtime_, automatically updating the feature values in the repository. This method is recommended for server applications.
+
+- **FeatureHub polling client (GET request updates)**
+
+  In this mode you can set an interval (from 0 - just once) to any number of seconds between polling. This is more useful for when you have short term single threaded
+  processes like command line tools. Batch tools that iterate over data sets and wish to control when updates happen can also benefit from this method.
+
+This SDK uses concurrent ruby to ensure whichever option you choose stays open and continually updates your data.
+
+## Example
+
+Check our example Sinatra app [here](https://github.com/featurehub-io/featurehub-ruby-sdk/tree/main/example/sinatra)
+
+## Quick start
+
+### Connecting to FeatureHub
+There are 3 steps to connecting:
+1) Copy FeatureHub API Key from the FeatureHub Admin Console
+2) Create FeatureHub config
+3) Check FeatureHub Repository readiness and request feature state
+
+#### 1. API Key from the FeatureHub Admin Console
+Find and copy your API Key from the FeatureHub Admin Console on the API Keys page -
+you will use this in your code to configure feature updates for your environments.
+It should look similar to this: ```default/71ed3c04-122b-4312-9ea8-06b2b8d6ceac/fsTmCrcZZoGyl56kPHxfKAkbHrJ7xZMKO3dlBiab5IqUXjgKvqpjxYdI8zdXiJqYCpv92Jrki0jY5taE```.
+There are two options - a Server Evaluated API Key and a Client Evaluated API Key. More on this [here](https://docs.featurehub.io/#_client_and_server_api_keys)
+
+Client Side evaluation is intended for use in secure environments (such as microservices) and is intended for rapid client side evaluation, per request for example.
+
+Server Side evaluation is more suitable when you are using an _insecure client_. (e.g. command line tool). This also means you evaluate one user per client.
+
+#### 2. Create FeatureHub config:
+
+Create `FeatureHubConfig`. You need to provide the API Key and the URL of the FeatureHub Edge server.
+
+```ruby
+config = FeatureHub::Sdk::FeatureHubConfig.new(ENV.fetch("FEATUREHUB_EDGE_URL"),
+                                                 [ENV.fetch("FEATUREHUB_CLIENT_API_KEY")])
+config.init
+
+```
+    
+Note, you only ever need to do this once, a Config consists of a Repository
+(which holds state) and an Edge Server (which gets the updates and passes them
+on to the Repository). You can have many of them if you wish, but you don't need
+to. 
+     
+to in Rails, you might create an initializer that does this:
+
+```ruby
+Rails.configuration.fh_client = FeatureHub::Sdk::FeatureHubConfig.new(ENV.fetch("FEATUREHUB_EDGE_URL"),
+                                                 [ENV.fetch("FEATUREHUB_CLIENT_API_KEY")]).init
+```
+
+in Sinatra (our example), it might do this:
+
+```ruby
+class App < Sinatra::Base
+    configure do
+        set :fh_config, FeatureHub::Sdk::FeatureHubConfig.new(ENV.fetch("FEATUREHUB_EDGE_URL"),
+                                                              [ENV.fetch("FEATUREHUB_CLIENT_API_KEY")])
+    end
+end
+```
+
+
+By default, this SDK will use SSE client. If you decide to use FeatureHub polling client, after initialising the config, you can add this:
+
+```ruby
+config.use_polling_edge_service(30)
+# OR
+config.use_polling_edge_service # uses environment variable FEATUREHUB_POLL_INTERVAL or default of 30 
+```
+
+in this case it is configured for requesting an update every 30 seconds.
+
+#### 3. Check FeatureHub Repository readiness and request feature state
+
+Check for FeatureHub Repository readiness:
+```ruby
+if config.repository.ready?
+  # do something
+end
+```
+
+If you are not intending to use rollout strategies, you can pass empty context to the SDK:
+
+```ruby
+def name_arg(name)
+    if config.new_context.build.feature("FEATURE_TITLE_TO_UPPERCASE").flag
+        "HELLO WORLD"
+    else
+        "hello world"
+    end
+end
+```
+
+
+If you are using rollout strategies and targeting rules they are all determined by the active _user context_. In this example we pass `user_key` to the context :
+
+```ruby
+def name_arg(name)
+    if config.new_context.user_key(name).build.feature("FEATURE_TITLE_TO_UPPERCASE").flag
+        "HELLO WORLD"
+    else
+        "hello world"
+    end
+end
+```
+
+Well known fields have their own methods, or you can add custom
+values for fields using `attribute_value(key, [values])`. For
+example if you wish to trigger on specific contract ids and each
+user could have a different set of contract ids, you can add those
+`attribute_value("contract_values", [2,17,45])` and have configured
+your strategy with a list of contract values which trigger the feature.
+
+
+See more options to request feature states [here](https://github.com/featurehub-io/featurehub-ruby-sdk/blob/main/featurehub-sdk/lib/feature_hub/sdk/context.rb)
+
+### Using inside popular web servers
+
+Because most of the popular webservers use a process per request distributed request distribution model, they
+will generally fork the process when they need more processes to handle the incoming traffic, and this will naturally
+kill the connection to FeatureHub. It does not however reset the cached repository. To ensure your fork is back
+up in running, for various frameworks you will need to ensure the Edge connection is restarted. This consists of
+
+```ruby
+config.force_new_edge_service
+```
+
+#### Resetting in Passenger 
+
+In your `config.ru` 
+
+```ruby
+if defined?(PhusionPassenger)
+  PhusionPassenger.on_event(:starting_worker_process) do |forked|
+    if forked
+      # e.g.
+      # App.settings.fh_config.force_new_edge_service
+    end
+  end
+end
+
+```
+
+#### Resetting in Puma
+
+```ruby
+on_worker_boot do
+      # e.g.
+      # App.settings.fh_config.force_new_edge_service
+end
+
+```
+
+#### Resetting in Unicorn
+
+```ruby
+after_fork do |_server, _worker|
+      # e.g.
+      # App.settings.fh_config.force_new_edge_service
+end
+
+```
+
+#### Resetting in Spring 
+
+```ruby
+Spring.after_fork do 
+      # e.g.
+      # App.settings.fh_config.force_new_edge_service
+end
+
+```
+        
+
+### Extracting the state 
+
+You can extract the state from a repository and store it somewhere and reload
+it, but it should be done so using the JSON mechanism so it parses correctly. 
+
+```ruby
+require 'json'
+
+state = config.repository.extract_feature_state
+
+# somehow save it
+save(state.to_json)
+
+# some later stage, reload it or use it as a cache
+config.repository.notify(:features, JSON.parse(read_state))
+```
+
+### Readyness
+
+It is encourage that you include the ready state of the repository in your
+readyness check. If your server cannot connect to your FeatureHub repository
+and cannot sensibly operate without it, it is not ready. Once it has received
+initial state it will remain ready even when it temporarily loses connections.
+
+It is only if the key is invalid, or if the repository has never received state,
+that the repository is marked not ready. To determine readyness: 
+
+```ruby
+config.repository.ready?
+```
+

data/examples/rails_example/.env.example

@@ -0,0 +1,13 @@
+# you may have to change this URL in your app. Assuming you're running the party server locally 
+# (i.e. what's described here https://www.featurehub.io/) to test out FeatureHub you can find this URL by running
+# docker ps and finding the container with an image name like 'featurehub/party-server:latest'
+# running via docker? use this URL:
+# "http://host.docker.internal:8085/",
+FEATUREHUB_EDGE_URL="http://0.0.0.0:8085/"
+# You can find this value in the admin console by navigating to the 'API Keys' section of the UI and choosing
+# between the client and the server API Keys for whatever service account you've set up. Learn more about the
+# differences between client-side evaluation here:
+# https://docs.featurehub.io/featurehub/latest/sdks-development.html#_client_side_evaluation
+# and server-side evaluation here (though it's almost never recommended):
+# https://docs.featurehub.io/featurehub/latest/sdks-development.html#_supporting_server_side_evaluation
+FEATUREHUB_CLIENT_API_KEY="CHANGE_ME"

data/examples/rails_example/.gitattributes

@@ -0,0 +1,7 @@
+# See https://git-scm.com/docs/gitattributes for more about git attribute files.
+
+# Mark the database schema as having been generated.
+db/schema.rb linguist-generated
+
+# Mark any vendored files as having been vendored.
+vendor/* linguist-vendored