flipt_client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bab21f5cabb52c6b86a37148513ebc29840ac42fb7d8ce8430bfd24aeb15554f
-  data.tar.gz: e9bcc909c69d96b8a0eaeb1a328f680a1ac59dc8d0aac213f966e92bad01cab7
+  metadata.gz: 7de6ff1869c9845250a2eaafa0e9b85d9135eabac78b61ddbbe682a8843a2f28
+  data.tar.gz: 2b38cb9f4b60554cdadf1da74904f050f5594f13ef95b69e44ae40b7ceeb3b78
 SHA512:
-  metadata.gz: 9cec3ef4bc12b647dc779a925f940c9e90d1a14af7bf13b15f2c01d3de9e9920e81846cea5de2e6f819f63aa41d4e7e98c5cd10a547a65db58d3166b615cb3b2
-  data.tar.gz: 47751c409223146b2de9586171c30e8859f548004a361962e822d006f4404fecafa99889c277dbe6752a75cfb7fb085e2c7cb5699a55963075bac5b55076daf8
+  metadata.gz: 79fbec0e50c4139231536225a8faa53c44e13d87957e624e0078ef897abe574986e2aa8693dfcee5d6ee9920f095b058c250a6d713ab5c78bf27b0314cfff8fe
+  data.tar.gz: 4800d4efa7d12f6f439445f454ce9cb1b3829ec5d470c8624655b9e11985413b792309daf7ad5112cf4948ac05678cb9d3dbf956d0eae5b44bbd717eaaa3fa36

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/flipt_client.svg)](https://badge.fury.io/rb/flipt_client)
 
-The `flipt-client-ruby` directory contains the Ruby source code for the Flipt [client-side evaluation](https://www.flipt.io/docs/integration/client) client.
+The `flipt-client-ruby` library contains the Ruby source code for the Flipt [client-side evaluation](https://www.flipt.io/docs/integration/client) client.
 
 ## Installation
 
@@ -34,10 +34,10 @@ require 'flipt_client'
 #   "url": "http://localhost:8080",
 #   "update_interval": 120,
 #   "authentication": {
-#     "client_token": "secret" 
+#     "client_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()
@@ -50,17 +50,17 @@ puts resp
 
 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
-    ```
+   ```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
-    ```
+   ```bash
+   bundle exec ruby load_test.rb
+   ```

data/flipt-client-ruby.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   # 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.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'

data/lib/flipt_client/models.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
 module Flipt
+  # AuthenticationStrategy is a base class for different authentication strategies
   class AuthenticationStrategy
     def strategy
-        raise NotImplementedError
+      raise NotImplementedError
     end
   end
 
+  # NoAuthentication is a strategy that does not require authentication
   class NoAuthentication < AuthenticationStrategy
     def strategy
       nil
     end
   end
 
+  # ClientTokenAuthentication is a strategy that uses a client token for authentication
   class ClientTokenAuthentication < AuthenticationStrategy
     def initialize(token)
-        @token = token
+      @token = token
     end
 
     def strategy
@@ -25,6 +28,7 @@ module Flipt
     end
   end
 
+  # JWTAuthentication is a strategy that uses a JWT token for authentication
   class JWTAuthentication < AuthenticationStrategy
     def initialize(token)
       @token = token
@@ -36,4 +40,4 @@ module Flipt
       }
     end
   end
-end
+end

data/lib/flipt_client/version.rb

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

data/lib/flipt_client.rb

@@ -8,6 +8,7 @@ require 'json'
 module Flipt
   class Error < StandardError; end
 
+  # EvaluationClient is a Ruby Client Side Evaluation Library for Flipt
   class EvaluationClient
     extend FFI::Library
 
@@ -55,8 +56,11 @@ module Flipt
       @namespace = namespace
 
       # set default no auth if not provided
-      authentication = opts.fetch(:authentication, Flipt::NoAuthentication.new)
-      raise ArgumentError, "invalid authentication strategy" unless authentication && authentication.is_a?(Flipt::AuthenticationStrategy)
+      authentication = opts.fetch(:authentication, NoAuthentication.new)
+      unless authentication.is_a?(AuthenticationStrategy)
+        raise ArgumentError,
+              'invalid authentication strategy'
+      end
 
       opts[:authentication] = authentication.strategy
 
@@ -98,7 +102,7 @@ module Flipt
     #   - :entity_id [String] entity id
     #   - :flag_key [String] flag key
     def evaluate_batch(batch_evaluation_request = [])
-      for request in batch_evaluation_request do
+      batch_evaluation_request.each do |request|
         validate_evaluation_request(request)
       end
 
@@ -115,6 +119,7 @@ module Flipt
     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'

metadata

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