flipt_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fba410b0fcad63979b3cb5f1e0128afccf64054e3b4ad0712c3040c946beaff
+  data.tar.gz: 56b652a202967aae88db7c4915a259f4490f5f9be043e008215728acf018dcd4
+SHA512:
+  metadata.gz: f64f29f65b557a948ee83e20dea471b21c7c7c55561145c223c94e7dd35090dc61265ae0017ce8975bf271552fe8ed09a1140b5f549edc483d9e73e8be1a9514
+  data.tar.gz: ed2f3b489f6931b4bcd057d4f60a75c04d26d6b1b618bd69c8583631f74b1405f47f86859ebab42d898b766c62b1b9b535c7e8eb68d59e93d5cc1c6114aada14

data/README.md

@@ -0,0 +1,90 @@
+# Flipt Client Ruby
+
+The `flipt-client-ruby` directory contains the Ruby source code for the Flipt client-side evaluation client.
+
+## Installation
+
+Currently, to use this client, you'll need to build the dynamic library and the gem locally and install it. This is a temporary solution until we can figure out a better way to package and distribute the libraries.
+
+The dynamic library will contain the functionality necessary for the client to make calls to the Flipt engine via FFI. See [flipt-engine](../flipt-engine) for more information on the Flipt engine and FFI.
+
+### Prerequisites
+
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Ruby](https://www.ruby-lang.org/en/documentation/installation/)
+- [Make](https://www.gnu.org/software/make/)
+
+### Automated Build
+
+1. Build and copy the dynamic library to the `flipt-client-ruby/lib/ext` directory for your platform. This will also build and install the `flipt_client` gem on your local machine. You can do this by running the following command from the root of the repository:
+
+    ```bash
+    make ruby
+    ```
+
+### Manual Build
+
+1. Build the Rust dynamic library
+
+    ```bash
+    cargo build --release
+    ```
+
+This should generate a `target/` directory in the root of this repository, which contains the dynamically linked library built for your platform.
+
+2. You'll need to copy the dynamic library to the `flipt-client-ruby/lib/ext/$OS_$ARCH/` directory. This is a temporary solution until we can figure out a better way to package the libraries with the gem.
+
+The `path/to/lib` will be the path to the dynamic library which will have the following paths depending on your platform.
+
+- **Linux**: `{REPO_ROOT}/target/release/libfliptengine.so`
+- **Windows**: `{REPO_ROOT}/target/release/libfliptengine.dll`
+- **MacOS**: `{REPO_ROOT}/target/release/libfliptengine.dylib`
+
+3. You can then build the gem and install it locally. You can do this by running the following command from the `flipt-client-ruby` directory:
+
+    ```bash
+    rake build
+    gem install pkg/flipt_client-{version}.gem
+    ```
+
+## Usage
+
+In your Ruby code you can import this client and use it as so:
+
+```ruby
+require 'flipt_client'
+
+# namespace is the first positional argument and is optional here and will have a value of "default" if not specified.
+# opts is the second positional argument and is also optional, the structure is:
+# {
+#   "url": "http://localhost:8080",
+#   "update_interval": 120,
+#   "auth_token": "secret"
+# }
+# 
+# You can replace the url with where your upstream Flipt instance points to, the update interval for how long you are willing
+# to wait for updated flag state, and the auth token if your Flipt instance requires it.
+client = Flipt::EvaluationClient.new()
+resp = client.evaluate_variant({ flag_key: 'buzz', entity_id: 'someentity', context: { fizz: 'buzz' } })
+
+puts resp
+```
+
+## Load Test
+
+1. To run the load test, you'll need to have Flipt running locally. You can do this by running the following command from the root of the repository:
+
+    ```bash
+    docker run -d \
+        -p 8080:8080 \
+        -p 9000:9000 \
+        docker.flipt.io/flipt/flipt:latest
+    ```
+
+2. You'll also need to have the `flipt_client` gem installed locally. See [Installation](#installation) above.
+3. In the Flipt UI (<http://localhost:8080>) you'll also need to create a new boolean flag with the key `my-feature` in the default namespace.
+4. You can then run the load test by running the following command from this folder:
+
+    ```bash
+    bundle exec ruby load_test.rb
+    ```

data/flipt-client-ruby.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'lib/flipt_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flipt_client'
+  spec.version       = Flipt::VERSION
+  spec.authors       = ['Flipt Devs']
+  spec.email         = ['dev@flipt.io']
+  spec.summary       = 'Flipt Client Evaluation SDK'
+  spec.description   = 'Flipt Client Evaluation SDK'
+  spec.homepage      = 'https://www.flipt.io'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata["source_code_uri"] =  "https://github.com/flipt-io/flipt-client-sdks"
+
+  spec.files = Dir.glob('{lib}/**/*') + ['README.md', 'flipt-client-ruby.gemspec']
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/ext/darwin_arm64/libfliptengine.d

@@ -0,0 +1 @@
+/Users/runner/work/flipt-client-sdks/flipt-client-sdks/target/aarch64-apple-darwin/release/libfliptengine.rlib: /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/build.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/error/mod.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/evaluator/mod.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/lib.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/common.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/flipt.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/mod.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/source.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/parser/mod.rs /Users/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/store/mod.rs

data/lib/ext/flipt_engine.h

@@ -0,0 +1,32 @@
+#include <stdarg.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdlib.h>
+
+/**
+ * # Safety
+ *
+ * This function will initialize an Engine and return a pointer back to the caller.
+ */
+void *initialize_engine(const char *const *namespaces, const char *opts);
+
+/**
+ * # Safety
+ *
+ * This function will take in a pointer to the engine and return a variant evaluation response.
+ */
+const char *evaluate_variant(void *engine_ptr, const char *evaluation_request);
+
+/**
+ * # Safety
+ *
+ * This function will take in a pointer to the engine and return a boolean evaluation response.
+ */
+const char *evaluate_boolean(void *engine_ptr, const char *evaluation_request);
+
+/**
+ * # Safety
+ *
+ * This function will free the memory occupied by the engine.
+ */
+void destroy_engine(void *engine_ptr);

data/lib/ext/linux_arm64/libfliptengine.d

@@ -0,0 +1 @@
+/target/aarch64-unknown-linux-gnu/release/libfliptengine.rlib: /project/flipt-engine/build.rs /project/flipt-engine/src/error/mod.rs /project/flipt-engine/src/evaluator/mod.rs /project/flipt-engine/src/lib.rs /project/flipt-engine/src/models/common.rs /project/flipt-engine/src/models/flipt.rs /project/flipt-engine/src/models/mod.rs /project/flipt-engine/src/models/source.rs /project/flipt-engine/src/parser/mod.rs /project/flipt-engine/src/store/mod.rs

data/lib/ext/linux_x86_64/flipt_engine.h

@@ -0,0 +1,32 @@
+#include <stdarg.h>
+#include <stdbool.h>
+#include <stdint.h>
+#include <stdlib.h>
+
+/**
+ * # Safety
+ *
+ * This function will initialize an Engine and return a pointer back to the caller.
+ */
+void *initialize_engine(const char *const *namespaces, const char *opts);
+
+/**
+ * # Safety
+ *
+ * This function will take in a pointer to the engine and return a variant evaluation response.
+ */
+const char *evaluate_variant(void *engine_ptr, const char *evaluation_request);
+
+/**
+ * # Safety
+ *
+ * This function will take in a pointer to the engine and return a boolean evaluation response.
+ */
+const char *evaluate_boolean(void *engine_ptr, const char *evaluation_request);
+
+/**
+ * # Safety
+ *
+ * This function will free the memory occupied by the engine.
+ */
+void destroy_engine(void *engine_ptr);

data/lib/ext/linux_x86_64/libfliptengine.d

@@ -0,0 +1 @@
+/home/runner/work/flipt-client-sdks/flipt-client-sdks/target/x86_64-unknown-linux-gnu/release/libfliptengine.rlib: /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/build.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/error/mod.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/evaluator/mod.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/lib.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/common.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/flipt.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/mod.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/models/source.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/parser/mod.rs /home/runner/work/flipt-client-sdks/flipt-client-sdks/flipt-engine/src/store/mod.rs

data/lib/flipt_client/version.rb

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

data/lib/flipt_client.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'flipt_client/version'
+require 'ffi'
+require 'json'
+
+module Flipt
+  class Error < StandardError; end
+
+  class EvaluationClient
+    extend FFI::Library
+
+    FLIPTENGINE = 'libfliptengine'
+
+    def self.libfile
+      case RbConfig::CONFIG['arch']
+      when /arm64-darwin/
+        "ext/darwin_arm64/#{FLIPTENGINE}.dylib"
+      when /arm64-linux|aarch64-linux/
+        "ext/linux_arm64/#{FLIPTENGINE}.so"
+      when /x86_64-linux/
+        "ext/linux_x86_64/#{FLIPTENGINE}.so"
+      else
+        raise "unsupported platform #{RbConfig::CONFIG['arch']}"
+      end
+    end
+
+    ffi_lib File.expand_path(libfile, __dir__)
+
+    # void *initialize_engine(const char *const *namespaces, const char *opts);
+    attach_function :initialize_engine, %i[pointer string], :pointer
+    # void destroy_engine(void *engine_ptr);
+    attach_function :destroy_engine, [:pointer], :void
+    # const char *evaluate_variant(void *engine_ptr, const char *evaluation_request);
+    attach_function :evaluate_variant, %i[pointer string], :string
+    # const char *evaluate_boolean(void *engine_ptr, const char *evaluation_request);
+    attach_function :evaluate_boolean, %i[pointer string], :string
+
+    def initialize(namespace = 'default', opts = {})
+      @namespace = namespace
+      namespace_list = [namespace]
+      ns = FFI::MemoryPointer.new(:pointer, namespace_list.size)
+      namespace_list.each_with_index do |namespace, i|
+        ns[i].put_pointer(0, FFI::MemoryPointer.from_string(namespace))
+      end
+
+      @engine = self.class.initialize_engine(ns, opts.to_json)
+      ObjectSpace.define_finalizer(self, self.class.finalize(@engine))
+    end
+
+    def self.finalize(engine)
+      proc { destroy_engine(engine) }
+    end
+
+    def evaluate_variant(evaluation_request = {})
+      evaluation_request[:namespace_key] = @namespace
+      validate_evaluation_request(evaluation_request)
+      resp = self.class.evaluate_variant(@engine, evaluation_request.to_json)
+      JSON.parse(resp)
+    end
+
+    def evaluate_boolean(evaluation_request = {})
+      evaluation_request[:namespace_key] = @namespace
+      validate_evaluation_request(evaluation_request)
+      resp = self.class.evaluate_boolean(@engine, evaluation_request.to_json)
+      JSON.parse(resp)
+    end
+
+    private
+    def validate_evaluation_request(evaluation_request)
+      if evaluation_request[:entity_id].nil? || evaluation_request[:entity_id].empty?
+        raise ArgumentError, 'entity_id is required'
+      elsif evaluation_request[:namespace_key].nil? || evaluation_request[:namespace_key].empty?
+        raise ArgumentError, 'namespace_key is required'
+      elsif evaluation_request[:flag_key].nil? || evaluation_request[:flag_key].empty?
+        raise ArgumentError, 'flag_key is required'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: flipt_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Flipt Devs
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-25 00:00:00.000000000 Z
+dependencies: []
+description: Flipt Client Evaluation SDK
+email:
+- dev@flipt.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- flipt-client-ruby.gemspec
+- lib/ext/darwin_arm64/libfliptengine.d
+- lib/ext/darwin_arm64/libfliptengine.dylib
+- lib/ext/darwin_arm64/libfliptengine.rlib
+- lib/ext/flipt_engine.h
+- lib/ext/linux_arm64/libfliptengine.d
+- lib/ext/linux_arm64/libfliptengine.rlib
+- lib/ext/linux_arm64/libfliptengine.so
+- lib/ext/linux_x86_64/flipt_engine.h
+- lib/ext/linux_x86_64/libfliptengine.d
+- lib/ext/linux_x86_64/libfliptengine.rlib
+- lib/ext/linux_x86_64/libfliptengine.so
+- lib/flipt_client.rb
+- lib/flipt_client/version.rb
+homepage: https://www.flipt.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.flipt.io
+  source_code_uri: https://github.com/flipt-io/flipt-client-sdks
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Flipt Client Evaluation SDK
+test_files: []