flipt_client 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d629e8ecefa5e1a68f25ebae475ae3238af2fc9eef9331f5dd6a674e68d50c6
-  data.tar.gz: 775349fdd7616a11cb77ad1e89dac5812ae7aa628c526183a14fc109f6f649de
+  metadata.gz: 20580ac221c34294feeb51f8a9198980d476fce87e8aafd50c9ac077df3ad498
+  data.tar.gz: f8342ae2127c00ca52b3f593bc094987050df738edf14567d4f5b988e22d4f47
 SHA512:
-  metadata.gz: 997654812c0accecbd6ba79c16d7dce379785734abc7dbdaa4c79ed2c9872b3ec8b65595ca01da6ce63e672144ca98f2b22745b166cb5070b95e23b35a0550ad
-  data.tar.gz: b3ebea80facd6b4634f1ca69fd9216ae459884b07c043eb4409e18bdf8b1c98338c47e46acf3996c7b8f38cd9be413252c3c6ce79928e7be59aa8988893c0ff0
+  metadata.gz: ab287927c314e8c00a930ca7bfb92eed25788ee82d9d600e2eabb564abba98e33e4af3bc0fa5706ff4a12c8e398c732db1b50697799bccd28d14cbaf59e0fafb
+  data.tar.gz: cfd783d6e15b9fb5613f1c793d06d965330f574491fd2046a284fc579542cef57ffb49b157e6db7deaaf032eedaa1ae694d68682dba17752bd10834530aab1b6

data/README.md

@@ -10,6 +10,28 @@ The `flipt-client-ruby` library contains the Ruby source code for the Flipt [cli
 gem install flipt_client
 ```
 
+## How Does It Work?
+
+The `flipt-client-ruby` library is a wrapper around the [flipt-engine-ffi](https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-engine-ffi) library.
+
+All evaluation happens within the SDK, using the shared library built from the [flipt-engine-ffi](https://github.com/flipt-io/flipt-client-sdks/tree/main/flipt-engine-ffi) library.
+
+Because the evaluation happens within the SDK, the SDKs can be used in environments where the Flipt server is not available or reachable after the initial data is fetched.
+
+## Data Fetching
+
+Upon instantiation, the `flipt-client-ruby` library will fetch the flag state from the Flipt server and store it in memory. This means that the first time you use the SDK, it will make a request to the Flipt server.
+
+### Polling (Default)
+
+By default, the SDK will poll the Flipt server for new flag state at a regular interval. This interval can be configured using the `update_interval` option when constructing a client. The default interval is 120 seconds.
+
+### Streaming (Flipt Cloud Only)
+
+[Flipt Cloud](https://flipt.io/cloud) users can use the `streaming` fetch method to stream flag state changes from the Flipt server to the SDK.
+
+When in streaming mode, the SDK will connect to the Flipt server and open a persistent connection that will remain open until the client is closed. The SDK will then receive flag state changes in real-time.
+
 ## Supported Architectures
 
 This SDK currently supports the following OSes/architectures:
@@ -61,11 +83,12 @@ puts resp
 The `Flipt::EvaluationClient` constructor accepts two optional arguments:
 
 - `namespace`: The namespace to fetch flag state from. If not provided, the client will default to the `default` namespace.
-- `engine_opts`: A hash that supports several options for the client. The structure is:
+- `opts`: A hash that supports several options for the client. The structure is:
   - `url`: The URL of the upstream Flipt instance. If not provided, the client will default to `http://localhost:8080`.
   - `update_interval`: The interval (in seconds) in which to fetch new flag state. If not provided, the client will default to 120 seconds.
   - `authentication`: The authentication strategy to use when communicating with the upstream Flipt instance. If not provided, the client will default to no authentication. See the [Authentication](#authentication) section for more information.
   - `reference`: The [reference](https://docs.flipt.io/guides/user/using-references) to use when fetching flag state. If not provided, reference will not be used.
+  - `fetch_mode`: The fetch mode to use when fetching flag state. If not provided, the client will default to polling.
 
 ### Authentication
 

data/lib/flipt_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flipt
-  VERSION = '0.11.0'
+  VERSION = '0.12.0'
 end

data/lib/flipt_client.rb

@@ -55,6 +55,8 @@ module Flipt
     # @option opts [AuthenticationStrategy] :authentication strategy to authenticate with Flipt
     # @option opts [Integer] :update_interval interval in seconds to update the cache
     # @option opts [String] :reference reference to use for namespace data
+    # @option opts [Symbol] :fetch_mode fetch mode to use for the client (:polling or :streaming).
+    #   Note: Streaming is currently only supported when using the SDK with Flipt Cloud (https://flipt.io/cloud).
     def initialize(namespace = 'default', opts = {})
       @namespace = namespace
 
@@ -65,6 +67,11 @@ module Flipt
               'invalid authentication strategy'
       end
 
+      fetch_mode = opts.fetch(:fetch_mode, :polling)
+      unless %i[polling streaming].include?(fetch_mode)
+        raise ArgumentError, 'invalid fetch mode'
+      end
+
       opts[:authentication] = authentication.strategy
 
       @engine = self.class.initialize_engine(namespace, opts.to_json)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flipt_client
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Flipt Devs
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-21 00:00:00.000000000 Z
 dependencies: []
 description: Flipt Client Evaluation SDK
 email: