pioneer_ruby_sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e909be278c86086ed47667127df968e8b75e1dc639dd718a1344b11e5ba96334
+  data.tar.gz: a88077557732acb48a49354805fe4d08d2f2ea0ba4db82ca8771bd8c465b6672
+SHA512:
+  metadata.gz: c31dfe2719112b871537b9b9e9649ce2b22775561bfe98964f123ab2014db724782433362075b7fb67089a730c7c4dc9813d0ef04bc1dda8f9b564b8b57c63bc
+  data.tar.gz: 8347f79aa3645304ebd8f1748787704e833330968e083972fb8541e38d3b8e72361f204d83c805a56f03cb92ea2bfa364c47b841012b9add596d836dc95f1a8d

data/lib/client_with_context.rb

@@ -0,0 +1,18 @@
+require_relative 'helper_methods/handle_undefined_feature.rb'
+
+class Client_With_Context
+	def initialize(context_obj)
+		@context = context_obj[:context]
+		@client = context_obj[:client]
+		@config = context_obj[:config]
+	end
+
+	def get_feature(key, default_value)
+		feature_state = @client.get_feature_state(key)
+		if !feature_state
+			return handle_undefined_feature(key, default_value)
+		end
+
+		return feature_state.strategy.calculate(@context)
+	end
+end

data/lib/context.rb

@@ -0,0 +1,9 @@
+class Context
+	def initialize(user_key)
+		@user_key = user_key
+	end
+
+	def get_key()
+		return @user_key
+	end
+end

data/lib/event_source_client.rb

@@ -0,0 +1,85 @@
+require 'ld-eventsource'
+require 'json'
+require_relative 'feature_state'
+require_relative 'helper_methods/handle_undefined_feature'
+
+# class for event source client instance
+class Event_Source_Client 
+	attr_reader :has_data
+
+	def initialize(config)
+		@config = config
+		@features = {}
+		@has_data = false
+		options = {
+      headers: { Authorization: @config[:sdk_key]}
+    }
+
+	sse_client = SSE::Client.new("localhost:3030/features", headers: options[:headers])
+
+	@api_client = sse_client
+	end
+
+	def start
+		handle_events()
+		handle_errors()
+	end
+
+	def handle_events
+		event_type = nil
+
+		@api_client.on_event do |event| 
+			data = JSON.parse(event[:data]) 
+			event_type = data[:type]
+			payload = data[:data]
+		end
+
+		puts event_type
+		case event_type
+		when "ALL_FEATURES" 
+			handle_all_features(payload)
+		when "CREATE_CONNECTION"
+			return
+		end
+	end
+
+	def handle_errors()
+		@api_client.on_error do |error|
+			puts "Event Source Failed: ", error
+		end
+	end
+
+
+	def handle_all_features(all_features)
+		all_features = JSON.parse(all_features)
+		feature_states = {}
+
+		all_features.each do |feature|
+			modified_feature_state_params = {
+				title: feature[:title],
+				value: feature[:is_active],
+				strategy: {percentage: feature[:rollout]}
+			}
+			feature_states[feature[:title]] = FeatureState.new(modified_feature_state_params)
+		end
+
+		@features = feature_states
+		@has_data = true
+	end
+
+	def get_feature(key, default_value) 
+		feature_state = get_feature_state(key)
+		if !feature_state
+			handle_undefined_feature(key, default_value)
+			return
+		end
+
+		value = feature_state[:value]
+		return value
+	end
+
+
+	def get_feature_state(key) 
+		return @features[:key]
+	end
+end

data/lib/feature_state.rb

@@ -0,0 +1,11 @@
+require_relative 'strategy'
+
+class FeatureState
+	def initialize(feature_state_object)
+		@title = feature_state_object[:title],
+		@value = feature_state_object[:value],
+		if feature_state_object[:strategy]
+			@strategy = Strategy.new(feature_state_object[:strategy][:percentage])
+		end
+	end
+end

data/lib/helper_methods/handle_undefined_feature.rb

@@ -0,0 +1,7 @@
+def handle_undefined_feature(key, default_value)
+	if !default_value.nil?
+    puts("Warning: Could not get #{key} from features, using provided default value!")
+    return default_value
+	end
+  raise("Error: #{key} does not exist, cannot get get feature!");
+end

data/lib/pioneer_ruby_sdk.rb

@@ -0,0 +1,50 @@
+require_relative 'event_source_client'
+require_relative 'context'
+require_relative 'client_with_context'
+
+class Pioneer_Ruby_Sdk
+	def initialize(server_address, sdk_key)
+		@server_address = server_address
+		@sdk_key = sdk_key
+		@configs = {
+			server_address: @server_address,
+			sdk_key: @sdk_key
+		}
+	end
+
+	def connect()
+	@client = Event_Source_Client.new(@configs)
+		@client.start()
+		return self
+	end
+
+	def with_wait_for_data(time_out = 1, polling_attempts = 5)
+		attempts = 0
+
+		until @client.has_data() do
+			attempts += 1
+			if attempts > polling_attempts
+				puts "Cannot connect to Scout, connection timed out"
+				break
+			end
+
+			sleep(time_out)
+		end
+		return self
+	end
+
+	def with_context(user_key)
+		user_key = user_key
+		context_obj = {
+			context: Context.new(user_key),
+			client: @client,
+			config: @configs
+		}
+
+		return Client_With_Context.new(context_obj)
+	end
+
+	def get_server_address()
+		return @server_address
+	end
+end

data/lib/strategy.rb

@@ -0,0 +1,18 @@
+class Strategy
+  def initialize(percentage)
+		@percentage = percentage
+		@modulus = 100
+	end
+
+
+	def calculate(context)
+		key = context.get_key()
+		hashed_percentage = get_hash_based_percentage(key)
+		return hashed_percentage <= @percentage
+	end
+
+	def get_hash_based_percentage(string) 
+		sum = string.bytes.sum()
+		return  ((sum % @modulus) + 1) / @modulus
+	end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: pioneer_ruby_sdk
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jimmy Zheng
+- Kyle Ledoux
+- Laura Davies
+- Elizabeth Tackett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-19 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/client_with_context.rb
+- lib/context.rb
+- lib/event_source_client.rb
+- lib/feature_state.rb
+- lib/helper_methods/handle_undefined_feature.rb
+- lib/pioneer_ruby_sdk.rb
+- lib/strategy.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: SDK wrapper for using Pioneer feature flag application
+test_files: []