pioneer_ruby_sdk 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d43602bc04e742e3049e6401d1a30ab173d6aa61affcab79f71a1be6028f208
-  data.tar.gz: '0835fb94ca06f8fee0de534b113fd13b7be8f3b68f95b6d29c6ac9d8d93336ed'
+  metadata.gz: 2f04719f85f42f76f879aba2f375dcb436c02792f585e7f9a3b9105a9b15582d
+  data.tar.gz: 293839fdfe2eabdcf69d307e990e69c1b6a890b976b5c8f49b0e596fed1f640f
 SHA512:
-  metadata.gz: 96314e8852a23e78a98d57e9deb5e763b3b508f1a8d59f5203e8ffcefe7419999fcb83975bb5760c318d1495797d06a2b2bce541ca019e88a847cf6df8cacf18
-  data.tar.gz: 26bb595a1552c1035924c280968ecd47c30f5ad42487ebfd1f167d8be88e0d3282c54aa729cbfef4f0f969498f8b4fd86801148f298b59bb607ed2c6166dae27
+  metadata.gz: 25dfae0e844f5b1ef31324094ea977eede067ef6e314500195212fc5e040ef36b8a8c9977cfea90530b66f1b4a6550aef3ab9493845be8d83046749f08e3fd76
+  data.tar.gz: 96cdd692ba161959aec50ce8b4d454c2f1f7143e6b497c65bba070a5f28366338f8cea1aeb943d13a96c852b03bfc8055dbe5e21500d5dc2c3682c898a378ed3

data/lib/pioneer_ruby_sdk.rb

@@ -1,6 +1,6 @@
-require_relative 'event_source_client'
-require_relative 'context'
-require_relative 'client_with_context'
+require_relative 'ruby_sdk/event_source_client'
+require_relative 'ruby_sdk/context'
+require_relative 'ruby_sdk/client_with_context'
 
 # wrapper for event source client
 class PioneerRubySdk
@@ -14,42 +14,44 @@ class PioneerRubySdk
 	end
 
 	def connect()
-		@client = Event_Source_Client.new(@configs)
+		@client = EventSourceClient.new(@configs)
 		@client.start
 		self
 	end
 
-	def with_wait_for_data(time_out = 1, polling_attempts = 5)
+	def with_wait_for_data()
+		time_out = 1
+		polling_attempts = 10
 		attempts = 0
 
 		until @client.has_data() do
 			attempts += 1
 			if attempts > polling_attempts
 				puts "Cannot connect to Scout, connection timed out"
+				@client.close()
 				break
 			end
 
-			sleep(time_out)
+			puts 'Attempting to connect to scout daemon...'
 		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)
+		return ClientWithContext.new(context_obj)
 	end
 
 	def get_server_address()
 		return @server_address
 	end
 
-	def get_feature(key, default_value)
+	def get_feature(key, default_value = nil)
 		@client.get_feature(key, default_value)
 	end
 end

data/lib/ruby_sdk/analytics_collector.rb

@@ -0,0 +1,25 @@
+require 'net/http'
+
+# class to handle connections to Google Analytics account
+class AnalyticsCollector
+	def initialize(config_object)
+		@tracking_id = config_object[:tracking_id]
+		@client_id = config_object[:client_id]
+	end
+
+	def log_event(event_object)
+		client_id = event_object[:client_id]
+
+		Net::HTTP.post_form(
+			URI("https://www.google-analytics.com/collect"),
+			v:   "1",             # API Version
+			tid: @tracking_id,    # Tracking ID / Property ID
+			cid: @client_id,       # Client ID
+			t:   "event",         # Event hit type
+			ec:  event_object[:category],        # Event category
+			ea:  event_object[:action],          # Event action
+			el:  event_object[:label],           # Event label
+			ev:  event_object[:value]            # Event value
+		)
+	end
+end

data/lib/ruby_sdk/client_with_context.rb

@@ -0,0 +1,29 @@
+require_relative 'mod/handle_undefined_feature.rb'
+
+class ClientWithContext
+	def initialize(context_obj)
+		@context = context_obj[:context]
+		@client = context_obj[:client]
+		@config = context_obj[:config]
+	end
+
+	def get_feature(key, default_value = nil)
+		feature_state = @client.get_feature_state(key)
+		return HandleUndefinedFeature.handle(key, default_value) if !feature_state
+
+		# if value of flag is true, use rollout
+		if feature_state.value
+			return feature_state.strategy.calculate(@context)
+		else
+			return feature_state.value
+		end
+	end
+
+	def add_google_analytics_collector(config_object)
+		@client.add_google_analytics_collector(config_object)	
+	end
+
+	def log_event(event_object)
+		@client.log_event(event_object)
+	end
+end

data/lib/{event_source_client.rb → ruby_sdk/event_source_client.rb}

@@ -1,15 +1,17 @@
 require 'ld-eventsource'
 require 'json'
 require_relative 'feature_state'
+require_relative 'analytics_collector'
 require_relative 'mod/handle_undefined_feature'
 
 # class for event source client instance
-class Event_Source_Client 
+class EventSourceClient 
 	attr_reader :has_data
 
 	def initialize(config)
 		@config = config
 		@features = {}
+		@analytics_collectors = []
 		@has_data = false
 		options = {
       headers: { Authorization: @config[:sdk_key]}
@@ -61,7 +63,7 @@ class Event_Source_Client
 		@has_data = true
 	end
 
-	def get_feature(key, default_value) 
+	def get_feature(key, default_value = nil)
 		feature_state = get_feature_state(key)
 		if feature_state.nil?
 			HandleUndefinedFeature.handle(key, default_value)
@@ -75,4 +77,16 @@ class Event_Source_Client
 	def get_feature_state(key) 
 		return @features[key]
 	end
+
+	def add_google_analytics_collector(config_object)
+		analytics_collector = AnalyticsCollector.new(config_object)
+		@analytics_collectors.push(analytics_collector)
+		return analytics_collector
+	end
+
+	def log_event(event_object)
+		@analytics_collectors.each do |analytics_collector|
+			analytics_collector.log_event(event_object)
+		end
+	end
 end

data/lib/ruby_sdk/mod/handle_undefined_feature.rb

@@ -0,0 +1,9 @@
+module HandleUndefinedFeature
+	def self.handle(key, default_value)
+		unless default_value.nil?
+			puts("Warning: Could not get '#{key}' from features, using provided default value!")
+			return default_value
+		end
+		raise StandardError.new("Error: flag with title '#{key}' does not exist, cannot get get feature!");
+	end
+end

data/lib/{strategy.rb → ruby_sdk/strategy.rb}

@@ -2,13 +2,13 @@
 
 # handles the calculation of rollout for a given context
 class Strategy
-  def initialize(percentage)
+	def initialize(percentage)
 		@percentage = percentage
 		@modulus = 100
 	end
 
 	def calculate(context)
-		key = context.get_key()
+		key = context.get_key
 		hashed_percentage = get_hash_based_percentage(key)
 		return hashed_percentage <= @percentage
 	end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pioneer_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Jimmy Zheng
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-21 00:00:00.000000000 Z
+date: 2021-08-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -19,13 +19,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/client_with_context.rb
-- lib/context.rb
-- lib/event_source_client.rb
-- lib/feature_state.rb
-- lib/mod/handle_undefined_feature.rb
 - lib/pioneer_ruby_sdk.rb
-- lib/strategy.rb
+- lib/ruby_sdk/analytics_collector.rb
+- lib/ruby_sdk/client_with_context.rb
+- lib/ruby_sdk/context.rb
+- lib/ruby_sdk/event_source_client.rb
+- lib/ruby_sdk/feature_state.rb
+- lib/ruby_sdk/mod/handle_undefined_feature.rb
+- lib/ruby_sdk/strategy.rb
 homepage: 
 licenses:
 - MIT

data/lib/client_with_context.rb

@@ -1,18 +0,0 @@
-require_relative 'mod/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 HandleUndefinedFeature.handle(key, default_value)
-		end
-
-		return feature_state.strategy.calculate(@context)
-	end
-end

data/lib/mod/handle_undefined_feature.rb

@@ -1,9 +0,0 @@
-module HandleUndefinedFeature
-	def self.handle(key, default_value)
-		unless 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
-end