ff-ruby-server-sdk 0.0.2 → 1.0.2.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 817b19ae2d914cd44f1cda5e8dea8eb019fa0cf8e367d71fd56990dc8150efdf
-  data.tar.gz: '088dd7868cb6c17ad2633082f6592e07642b54ea9897a34a3074ca0a2108afae'
+  metadata.gz: 2597658c1a6717df136035cd00ddc1f0208d62cb625ace39c33d7e5a34b3e468
+  data.tar.gz: 3fb99b5496bb97802c55d2946641583b4f4bd2568827f4c8a02f4f7b909cc55e
 SHA512:
-  metadata.gz: c0549f021ca93e1b6cd0e913370caa69b43dc4247a86e4e8e288259124482903a7316e7bd489afedcbb2d42317107c3300d961567a8ad6cf7552b69f98572ec8
-  data.tar.gz: aa76f04ad606997faa49d4c61506ba86198e15cb9f61356ff76d6fa11332077eeb525640ff5bd2336dd554b113993b89d2da21d8434cd7610e562a5a122625b9
+  metadata.gz: 68e2be8404dc2e1ba3ba77119eff42d26c3799213a6473a6908f447f8f4f8e18b006c887d1685a45a9810a274fa493eccb4e98969b8ebb5e8c0793c05b3fda27
+  data.tar.gz: 699491d8f605fd94061f0bad2ab491237bd0dd77cdb494908fbd079e7a4a92cd69755133596492c97c0aab8fdac07d79dc3f55206ecbb93c7289d7df0ab41452

data/.run/sdk_test.rb.run.xml

@@ -1,5 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="sdk_test.rb" type="TestUnitRunConfigurationType" factoryName="Test::Unit/Shoulda/Minitest" nameIsGenerated="true">
+  <configuration default="false" name="SDK test" type="TestUnitRunConfigurationType" factoryName="Test::Unit/Shoulda/Minitest">
     <module name="ff-ruby-server-sdk" />
     <predefined_log_file enabled="true" id="RUBY_TESTUNIT" />
     <RTEST_RUN_CONFIG_SETTINGS_ID NAME="RUBY_ARGS" VALUE="-Ilib:test" />
@@ -19,8 +19,8 @@
     </EXTENSION>
     <EXTENSION ID="org.jetbrains.plugins.ruby.rails.run.RailsRunConfigurationExtension" SCRATCH_USE_RAILS_RUNNER="false" />
     <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TESTS_FOLDER_PATH" VALUE="" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/test/ff/ruby/server/sdk_test.rb" />
-    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPTS_PATHS" VALUE="$MODULE_DIR$/test/ff/ruby/server/sdk_test.rb" />
+    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPT_PATH" VALUE="$MODULE_DIR$/test/ff/ruby/server/sdk/sdk_test.rb" />
+    <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_SCRIPTS_PATHS" VALUE="$MODULE_DIR$/test/ff/ruby/server/sdk/sdk_test.rb" />
     <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_FILE_MASK" VALUE="" />
     <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_METHOD_NAME" VALUE="" />
     <RTEST_RUN_CONFIG_SETTINGS_ID NAME="TEST_TEST_TYPE" VALUE="CUSTOM_SET_OF_FILES" />

data/CHANGELOG.md

@@ -1,5 +1,15 @@
-## [Unreleased]
+## [1.0.2]
 
-## [0.0.1] - 2021-11-16
+- Runtime and development dependencies specified.
+
+- ## [1.0.1]
+
+- OpenAPI issues fixed
+
+## [1.0.0]
+
+- The first SDK release
+
+## [0.0.1, 0.0.2] - 2021-11-16
 
 - Initial release

data/Gemfile

@@ -2,11 +2,25 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in ff-ruby-server-sdk.gemspec
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "minitest", "~> 5.0"
-
 gem "standard", "~> 1.3"
+
+# Caching support:
+gem "pp"
+gem "rufus-scheduler"
+gem "libcache"
+gem "jwt"
+gem "moneta"
+
+# SSE support:
+gem "rest-client"
+gem "sse-client"
+
+# Concurrency support:
+gem "concurrent-ruby", require: "concurrent"
+
+# Evaluator dependencies:
+gem "murmurhash3"

data/README.md

@@ -1,14 +1,162 @@
-Before you Begin
+Harness CF Ruby Server SDK
+========================
 
-Harness Feature Flags (FF) is a feature management solution that enables users to change the software’s functionality, without deploying new code. FF uses feature flags to hide code or behaviours without having to ship new versions of the software. A feature flag is like a powerful if statement.
+## Overview
 
-For more information, see https://harness.io/products/feature-flags/
+-------------------------
+[Harness](https://www.harness.io/) is a feature management platform that helps teams to build better software and to
+test features quicker.
 
-To read more, see https://ngdocs.harness.io/category/vjolt35atg-feature-flags
+-------------------------
 
-To sign up, https://app.harness.io/auth/#/signup/
+## Setup
+
+Add the following snippet to your project's `Gemfile` file:
+
+```
+gem "ff-ruby-server-sdk"
+```
+
+## Cloning the SDK repository
+
+In order to clone SDK repository properly perform cloning like in the following example:
+
+```
+git clone --recurse-submodules git@github.com:harness/ff-ruby-server-sdk.git
+```
+
+After dependency has been added, the SDK elements, primarily `CfClient` should be accessible in the main application.
+
+## Initialization
+
+`CfClient` is a base class that provides all features of the SDK.
+
+We can instantiate by calling the `instance` method or by using public
+constructor (making multiple instances).
+
+```ruby
+require 'ff/ruby/server/sdk/api/config'
+require 'ff/ruby/server/sdk/dto/target'
+require 'ff/ruby/server/sdk/api/cf_client'
+require 'ff/ruby/server/sdk/api/config_builder'
+
+client = CfClient.instance
+
+key = "YOUR_API_KEY_GOES_HERE"
+
+logger = Logger.new(STDOUT)
+
+# Or saving logs into the filesystem with daily rotation:
+# logger = Logger.new("example.log", "daily")
+
+config = ConfigBuilder.new
+                      .logger(logger)
+                      .build
+
+client.init(key, config)
+
+config.logger.debug 'We will wait for the initialization'
+
+client.wait_for_initialization
+
+config.logger.debug 'Initialization is complete'
+
+target = Target.new("YOUR_TARGET_NAME")
+```
+
+`target` represents the desired target for which we want features to be evaluated.
+
+`"YOUR_API_KEY"` is an authentication key, needed for access to Harness services.
+
+**Your Harness SDK is now initialized. Congratulations!**
+
+### Public API Methods ###
+
+The Public API exposes a few methods that you can utilize:
+
+Instantiate, initialize and close when done:
+
+* `def initialize(api_key = nil, config = nil, connector = nil)`
+* `def init(api_key = nil, config = nil, connector = nil)`
+* `def wait_for_initialization`
+* `def close`
+
+Evaluations:
+
+* `def bool_variation(identifier, target, default_value)`
+* `def string_variation(identifier, target, default_value)`
+* `def number_variation(identifier, target, default_value)`
+* `def json_variation(identifier, target, default_value)`
+
+## Fetch evaluation's value
+
+It is possible to fetch a value for a given evaluation. Evaluation is performed based on a different type. In case there
+is no evaluation with provided id, the default value is returned.
+
+Use the appropriate method to fetch the desired Evaluation of a certain type.
+
+### Bool variation
+
+```
+bool_result = client.bool_variation(bool_flag, target, false)  
+```
+
+### Number variation
+
+```
+number_result = client.number_variation(number_flag, target, -1)  
+```
+
+### String variation
+
+```
+string_result = client.string_variation(string_flag, target, "unavailable !!!")  
+```
+
+### JSON variation
+
+```
+json_result = client.json_variation(json_flag, target, JSON.parse("{}"))
+```
+
+## Using feature flags metrics
+
+Metrics API endpoint can be changed like this (if ever needed):
+
+```
+config = ConfigBuilder.new
+                      .event_url("SOME_ENDPOINT_URL")
+                      .build
+```
+
+Otherwise, the default metrics endpoint URL will be used.
+
+## Connector
+
+This is a new feature that allows you to create or use other connectors.
+Connector is just a proxy to your data. Currently supported connectors:
+
+* Harness (the default implementation)
+
+```
+connector = YourConnectorImplementation.new
+
+client.init(
+
+  key,
+  config,
+  connector
+)
+```
+
+## Shutting down the SDK
+
+To avoid potential memory leak, when SDK is no longer needed
+(when the app is closed, for example), a caller should call the `close` method:
+
+```
+client.close
+```
 
 
-# Harness FFM Server-side SDK for Ruby
 
-Tbd.