tailslide 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d317d72da4b918e8c57feaf8072884cbc8ecdcb10ab3e49eefc9a392cb7a71ce
-  data.tar.gz: 4edf3d36bf65775916ed49d79ff8c28bd128c91c630bde5b21091353df495d2e
+  metadata.gz: 8d2f6a5d7784ee42f886c0b8e6565c283c49bdfd3b013bfa272380883f53f223
+  data.tar.gz: ead54dc39be41c0447981804958504b5454ee293e53709876bbfb55a3adbf50a
 SHA512:
-  metadata.gz: 796bfd026bb228dd49a089a8ed87b8785bc21e7e667e2b6c4f3237a0b3e4de41f3ace73be4efb3b9161baf2c187abb66a74a7f21f8f76c906fef554b1d230659
-  data.tar.gz: 41884a753fed4a3e7c77773ef76059f3cdb1ccd9e63b56cd5efa5ab040590d1726cd1862153ef0eed06eb342d19e5b61868f50a6c2fc17a2c5ef6b6776fc1345
+  metadata.gz: 41643f574dbc72661251707830be8abaf2ffa967d2828becbb85343a28b6346902a493ba52eb53c687c665b7ba8bd12b4bcc7dc2cca59d1a6a369286bebbefd7
+  data.tar.gz: 44647ce3c20988c60ea938e8d23de87e0639006a470c8711156964517b7ba9c1db05ec976855d5c340e679ac60c2a26ca0ec89999e13fc52eeeb2420e38031e5

data/README.md

@@ -55,7 +55,7 @@ After instantiating a `FlagManager`, invoke the `initialize` method. This method
 
 ### Using Feature Flag with Toggler
 
-Once the `FlagManager` is initialized, it can create a `Toggler`, with the `new_toggler` method, for each feature flag that the developer wants to wrap the new and old features in. A `Toggler`’s `is_flag_active` method checks whether the flag with its `flag_name` is active or not based on the flag ruleset. A `Toggler`’s `is_flag_active` method returns a boolean value, which is intended to be used to control branching logic flow within an application at runtime, to invoke new features.
+Once the `FlagManager` is initialized, it can create a `Toggler`, with the `new_toggler` method, for each feature flag that the developer wants to wrap the new and old features in. A `Toggler`’s `is_flag_active` method checks whether the flag with its `flag_name` is active or not based on the flag ruleset. A `Toggler`’s `is_flag_active` method returns a boolean value, which can be used to evaluate whether a new feature should be used or not.
 
 ```ruby
 flag_config = {
@@ -75,7 +75,7 @@ end
 
 ### Emitting Success or Failture
 
-To use the `Toggler` instances to record successful or failed operations, call its `emit_success` or `emit_failure` methods:
+To use a `Toggler` instance to record successful or failed operations, call its `emit_success` or `emit_failure` methods:
 
 ```ruby
 if successCondition
@@ -98,7 +98,8 @@ The `FlagManager` class is the entry point of the SDK. A new `FlagManager` objec
 **Parameters:**
 
 - An object with the following keys
-  - `server` a string that represents the URL and port of the NATS server.
+  - `nats_server` is the NATS JetStream server `address:port`
+  - `nats_stream` is the NATS JetStream’s stream name that stores all the apps and their flag rulesets
   - `app_id` a number representing the application the microservice belongs to
   - `sdk_key` a string generated via the Tower front-end for NATS JetStream authentication
   - `user_context` a string representing the user’s UUID
@@ -109,23 +110,39 @@ The `FlagManager` class is the entry point of the SDK. A new `FlagManager` objec
 
 #### Instance Methods
 
-##### `FlagManager.prototype.set_user_context(new_user_context)`
+##### `flagmanager.initialize()`
+
+Asynchronously initialize `flagmanager` connections to NATS JetStream and Redis database
+
+**Parameters:**
+
+- `nil`
+
+**Return Value:**
+
+- `nil`
+
+##### `flagmanaer.set_user_context(new_user_context)`
+
+Set the current user's context for the `flagmanager`
 
 **Parameters:**
 
-- A UUID string that represents the current active user
+- `new_user_context`: A UUID string that represents the current active user
 
 **Return Value:**
 
-- `null`
+- `nil`
 
 ---
 
-##### `FlagManager.prototype.get_user_context()`
+##### `flagmanaer.get_user_context()`
+
+Returns the current user context
 
 **Parameters:**
 
-- `null`
+- `nil`
 
 **Return Value:**
 
@@ -133,13 +150,13 @@ The `FlagManager` class is the entry point of the SDK. A new `FlagManager` objec
 
 ---
 
-##### `FlagManager.prototype.new_toggler(options)`
+##### `flagmanaer.new_toggler(options)`
 
 Creates a new toggler to check for a feature flag's status from the current app's flag ruleset by the flag's name.
 
 **Parameters:**
 
-- An object with key of `flag_name` and a string value representing the name of the feature flag for the new toggler to check whether the new feature is enabled
+- `options`: An object with key of `flag_name` and a string value representing the name of the feature flag for the new toggler to check whether the new feature is enabled
 
 **Return Value:**
 
@@ -147,29 +164,29 @@ Creates a new toggler to check for a feature flag's status from the current app'
 
 ---
 
-##### `FlagManager.prototype.disconnect()`
+##### `flagmanaer.disconnect()`
 
 Asynchronously disconnects the `FlagManager` instance from NATS JetStream and Redis database
 
 **Parameters:**
 
-- `null`
+- `nil`
 
 **Return Value:**
 
-- `null`
+- `nil`
 
 ---
 
 ### Toggler
 
-The Toggler class provides methods that determine whether or not new feature code is run and handles success/failure emissions. Each toggler handles one feature flag, and is created by `FlagManager.prototype.new_toggler()`.
+The Toggler class provides methods that determine whether or not new feature code is run and handles success/failure emissions. Each toggler handles one feature flag, and is created by `flagmanaer.new_toggler()`.
 
 ---
 
 #### Instance Methods
 
-##### `is_flag_active()`
+##### `toggler.is_flag_active()`
 
 Checks for flag status, whitelisted users, and rollout percentage in that order to determine whether the new feature is enabled.
 
@@ -180,36 +197,36 @@ Checks for flag status, whitelisted users, and rollout percentage in that order
 
 **Parameters:**
 
-- `null`
+- `nil`
 
 **Return Value**
 
-- `true` or `flase` depending on whether the feature flag is active
+- `true` or `false` depending on whether the feature flag is active
 
 ---
 
-##### `emit_success()`
+##### `toggler.emit_success()`
 
 Records a successful operation to the Redis Timeseries database, with key `flagId:success` and value of current timestamp
 
 **Parameters:**
 
-- `null`
+- `nil`
 
 **Return Value**
 
-- `null`
+- `nil`
 
 ---
 
-##### `emit_failure()`
+##### `toggler.emit_failure()`
 
 Records a failure operation to the Redis Timeseries database, with key `flagId:success` and value of current timestamp
 
 **Parameters:**
 
-- `null`
+- `nil`
 
 **Return Value**
 
-- `null`
+- `nil`

data/lib/tailslide/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tailslide
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tailslide
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Steven Liou
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -79,8 +79,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".vscode/launch.json"
-- ".vscode/settings.json"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -94,8 +92,6 @@ files:
 - lib/tailslide/toggler.rb
 - lib/tailslide/version.rb
 - sig/tailslide.rbs
-- tailslide-0.1.3.gem
-- test.rb
 homepage: https://github.com/tailslide-io/tailslide.rb
 licenses:
 - MIT

data/.vscode/launch.json

@@ -1,14 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Debug Local File",
-      "type": "Ruby",
-      "request": "launch",
-      "program": "./test.rb"
-    }
-  ]
-}

data/.vscode/settings.json

@@ -1,11 +0,0 @@
-{
-  "workbench.colorCustomizations": {
-    "sash.hoverBorder": "#3b3b3b",
-    "titleBar.activeBackground": "#222222",
-    "titleBar.activeForeground": "#e7e7e7",
-    "titleBar.inactiveBackground": "#22222299",
-    "titleBar.inactiveForeground": "#e7e7e799",
-    "commandCenter.border": "#e7e7e799"
-  },
-  "editor.acceptSuggestionOnEnter": "on"
-}

data/test.rb

@@ -1,132 +0,0 @@
-require "async"
-# require "./lib/tailslide/nats_client.rb"
-require_relative "lib/tailslide/flag_manager.rb"
-
-# def logMessage(message)
-#   p message
-# end
-
-# config = {server_url: "localhost:4222", callback: :p, token: 'myToken', stream:"flags", subject:'1'}
-app_id = "1"
-flag_name = 'App 1 Flag 1'
-flag_config = {"flag_name": flag_name}
-
-config = {nats_server:'localhost:4222', stream:'flags_ruleset', app_id:app_id, sdk_key:'myToken', user_context:'375d39e6-9c3f-4f58-80bd-e5960b710295',
-   redis_host:'localhost', redis_port:6379}
-
-
-Async do |task|
-  manager = FlagManager.new(**config) 
-  manager.initialize_flags
-  flag_toggler = manager.new_toggler(flag_config)
-  
-
-  if flag_toggler.is_flag_active
-    puts "Flag in #{app_id} with name \"#{flag_name}\" is active!"
-    flag_toggler.emit_success()
-  else
-    puts "Flag in #{app_id} with name \"#{flag_name}\" is not active!"
-    flag_toggler.emit_failure()
-  end
-  
-  count = 0
-  limit = 20
-  while count < limit do
-    if rand < 1
-      flag_toggler.emit_success
-      puts "Emitting success"
-    else
-      flag_toggler.emit_failure
-      puts "Emitting failure"
-    end
-    sleep 1
-  end
-end
-
-
-# require "nats/client"
-# require "async"
-# TimeoutError = NATS::IO::Timeout
-# require 'json'
-
-# token = "myToken"
-
-# nats_client = NATS.connect("nats://#{token}@127.0.0.1:4222")
-# jet_stream = nats_client.jetstream
-
-# # get last message
-# latest_msg = jet_stream.get_last_msg("flags", "test")
-# json_data = JSON.parse latest_msg.data
-# p json_data
-
-
-# # pull subscribe for new onging messages (workaround until Nats.rb make new update)
-# subscribed_stream = jet_stream.pull_subscribe("test", 'mydurable', config: { deliver_policy: 'new' })
-# Async do |task|
-#   task.async do 
-#       begin
-#       messages = subscribed_stream.fetch(1)
-#       messages.each do |message|
-#         message.ack
-#         json_data = JSON.parse message.data
-#         p json_data
-#       end
-#     rescue NATS::Timeout => e
-#       p e
-#     end until nats_client.closed?
-#   end
-#   p "hello past async"
-# end
-
-
-
-# push subscribe for new ongoing messages
-# setting deliver_policy still results in delivering all messages in "test" subject
-# push_sub = jetStream.subscribe("test", {manual_ack: true, deliver_policy:"new"} ) do |msg|
-#   msg.ack
-#   puts msg.data
-# end
-
-# Get ongoing messages
-# Push subscribe
-# consumer_req = {
-#   stream_name: "test",
-#   config: {
-#     durable_name: "sample",
-#     deliver_policy: "new",
-#     ack_policy: "explicit",
-#     max_deliver: -1,
-#     replay_policy: "instant"
-#   }
-# }
-
-# config = NATS::JetStream::API::ConsumerConfig.new({ deliver_policy: "new" })
-  # Create inbox for push consumer.
-# deliver = natsClient.new_inbox
-# config.deliver_subject = deliver
-
-# push_sub = jetStream.subscribe("test", {manual_ack: true, deliver_policy:"new"} ) do |msg|
-#   puts msg.data
-# end
-
-# cinfo = push_sub.consumer_info["config"]
-# puts cinfo
-# msg = push_sub.next_msg(timeout: 10000000000)
-# msg.ack
-# puts msg.data
-# push_sub.consumer_info["config"]["deliver_policy"] = "new"
-# puts cinfo
-
-# loop do
-#   msgs = push_sub.next_msg()
-#   puts msgs.data
-# rescue TimeoutError => e
-#   puts e
-#   sleep 1
-# end
-
-# js.publish("9", "Hello JetStream! 1")
-# js.publish("9", "Hello JetStream! 2")
-# js.publish("9", "Hello JetStream! 3")
-# js.publish("9", "Hello JetStream! 4")
-# js.publish("9", "Hello JetStream! Latest")