moesif_rack 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8bde32f3f60b62bfe1dfd5aef52ba6c56f21db3e2f8ac78743972c227ff1d2b
-  data.tar.gz: d0fe24cc62aa794dab07b04fa6ce943f85d015db045eb654cd66e9827e9b97fe
+  metadata.gz: 8c44fb915ecec7479c930ab41b3b74eeb58a368f387d3fa8d47211e41c4a0c80
+  data.tar.gz: 6974bb001d57faeffc0f58df1a4c4661ac52d4a6f5280d78c1e35c7deb5fb183
 SHA512:
-  metadata.gz: 0db637f28ba8d87d7e5e8a81b9642eeeb64f2c701d862c941e90ac0bdc5a2d15584f597df82420b736020dcd8f426c87e1e727cb9dcf081214e9aeecc07fdcd9
-  data.tar.gz: 134f36829793337b6d78a7a51dedddeadd2d4e2fc1353e5b0ae5962f7ddb72f08562c5ff9f5f93248b7ee80db14a987f4935c58eb152b0229bfae9f7ea9e128c
+  metadata.gz: '08b7997c9a683384cc7725dff3248a41b5ddb15974be2d259d9553fb1903075814260e8df0cda6a7d1e6340b7d8d27d3c99f725f0dd088caaae28476539f162c'
+  data.tar.gz: c0d75f0f8ab0f8d87d4a86fa4396e4100a94d7a0f37190260bbbe3db91ec40dcaa91f4d1d945f768a1fd0483dde2a816eb388a7e9cfd5fd89c4df33881104639

data/lib/moesif_rack/app_config.rb

@@ -3,71 +3,71 @@ require 'json'
 require 'time'
 require 'zlib'
 require 'stringio'
+require_relative './helpers.rb'
 
 class AppConfig
 
-    def get_config(api_controller, debug)
+    def initialize debug
+        @debug = debug
+        @helpers = Helpers.new(debug)
+    end
+
+    def get_config(api_controller)
         # Get Application Config
         begin 
             config_api_response = api_controller.get_app_config()
+            @helpers.log_debug("new config downloaded")
+            @helpers.log_debug(config_api_response.to_s)
             return config_api_response
         rescue MoesifApi::APIException => e
             if e.response_code.between?(401, 403)
-                puts 'Unauthorized access getting application configuration. Please check your Appplication Id.'
-            end
-            if debug
-                puts 'Error getting application configuration, with status code:'
-                puts e.response_code
+                @helpers.log_debug 'Unauthorized access getting application configuration. Please check your Appplication Id.'
             end
+            @helpers.log_debug 'Error getting application configuration, with status code:'
+            @helpers.log_debug e.response_code
         rescue => e
-            if debug
-                puts e.to_s
-            end
+            @helpers.log_debug e.to_s
         end
         rescue
     end
 
-    def parse_configuration(config_api_response, debug)
+    def parse_configuration(config_api_response)
         # Parse configuration object and return Etag, sample rate and last updated time
         begin
             # Rails return gzipped compressed response body, so decompressing it and getting JSON response body
-            response_body = decompress_gzip_body(config_api_response, debug)
+            response_body = decompress_gzip_body(config_api_response)
+            @helpers.log_debug(response_body.to_s)
 
             # Check if response body is not nil
             if !response_body.nil? then 
                 # Return Etag, sample rate and last updated time
-                return config_api_response.headers[:x_moesif_config_etag], response_body.fetch("sample_rate", 100), Time.now.utc
+                return response_body, config_api_response.headers[:x_moesif_config_etag], Time.now.utc
             else
-                if debug
-                    puts 'Response body is nil, assuming default behavior'
-                end
+                @helpers.log_debug 'Response body is nil, assuming default behavior'
                 # Response body is nil, so assuming default behavior
                 return nil, 100, Time.now.utc
             end
         rescue => exception
-            if debug
-                puts 'Error while parsing the configuration object, assuming default behavior'
-                puts exception.to_s
-            end
+            @helpers.log_debug 'Error while parsing the configuration object, assuming default behavior'
+            @helpers.log_debug exception.to_s
             # Assuming default behavior
             return nil, 100, Time.now.utc
         end
     end
 
-    def get_sampling_percentage(config_api_response, user_id, company_id, debug)
+    def get_sampling_percentage(config_api_response, user_id, company_id)
         # Get sampling percentage
         begin
-            # Rails return gzipped compressed response body, so decompressing it and getting JSON response body
-            response_body = decompress_gzip_body(config_api_response, debug)
-
             # Check if response body is not nil
-            if !response_body.nil? then 
-                
+            if !config_api_response.nil? then 
+                @helpers.log_debug("Getting sample rate for user #{user_id} company #{company_id}")
+                @helpers.log_debug(config_api_response.to_s)
+
                 # Get user sample rate object
-                user_sample_rate = response_body.fetch('user_sample_rate', nil)
+                user_sample_rate = config_api_response.fetch('user_sample_rate', nil)
 
                 # Get company sample rate object
-                company_sample_rate = response_body.fetch('company_sample_rate', nil)
+                company_sample_rate = config_api_response.fetch('company_sample_rate', nil)
 
                 # Get sample rate for the user if exist
                 if !user_id.nil? && !user_sample_rate.nil? && user_sample_rate.key?(user_id)
@@ -80,22 +80,18 @@ class AppConfig
                 end
 
                 # Return sample rate
-                return response_body.fetch('sample_rate', 100)
+                return config_api_response.fetch('sample_rate', 100)
             else 
-                if debug
-                    puts 'Assuming default behavior as response body is nil - '
-                end
+                @helpers.log_debug 'Assuming default behavior as response body is nil - '
                 return 100
             end
         rescue => exception
-            if debug
-                puts 'Error while geting sampling percentage, assuming default behavior'
-            end
+            @helpers.log_debug 'Error while geting sampling percentage, assuming default behavior'
             return 100
         end
     end
 
-    def decompress_gzip_body(config_api_response, debug)
+    def decompress_gzip_body(config_api_response)
         # Decompress gzip response body
         begin
             # Check if the content-encoding header exist and is of type zip
@@ -110,16 +106,12 @@ class AppConfig
                 # Return the parsed body
                 return JSON.parse( uncompressed_string )
             else
-                if debug
-                    puts 'Content Encoding is of type other than gzip, returning nil'
-                end
+                @helpers.log_debug 'Content Encoding is of type other than gzip, returning nil'
                 return nil
             end
         rescue => exception
-            if debug
-                puts 'Error while decompressing the response body'
-                puts exception.to_s
-            end
+            @helpers.log_debug 'Error while decompressing the response body'
+            @helpers.log_debug exception.to_s
             return nil
         end
     end

data/lib/moesif_rack/helpers.rb

@@ -0,0 +1,14 @@
+require 'time'
+
+class Helpers
+
+    def initialize debug
+        @debug = debug
+    end
+
+    def log_debug(message)
+        if @debug
+            puts("#{Time.now.to_s} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
+        end
+    end
+end

data/lib/moesif_rack/moesif_middleware.rb

@@ -6,6 +6,7 @@ require_relative './client_ip.rb'
 require_relative './app_config.rb'
 require_relative './update_user.rb'
 require_relative './update_company.rb'
+require_relative './helpers.rb'
 require 'zlib'
 require 'stringio'
 
@@ -28,10 +29,10 @@ module MoesifRack
       @mask_data = options['mask_data']
       @skip = options['skip']
       @debug = options['debug']
-      @app_config = AppConfig.new
-      @config = @app_config.get_config(@api_controller, @debug)
+      @app_config = AppConfig.new(@debug)
+      @helpers = Helpers.new(@debug)
+      @config = @app_config.get_config(@api_controller)
       @config_etag = nil
-      @sampling_percentage = 100
       @last_config_download_time = Time.now.utc
       @last_worker_run = Time.now.utc
       @config_dict = Hash.new
@@ -44,17 +45,18 @@ module MoesifRack
       start_worker()
 
       begin
-        if !@config.nil?
-          @config_etag, @sampling_percentage, @last_config_download_time = @app_config.parse_configuration(@config, @debug)
+        new_config = @app_config.get_config(@api_controller)
+        if !new_config.nil?
+          @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
         end
       rescue => exception
-        log_debug 'Error while parsing application configuration on initialization'
-        log_debug exception.to_s
+        @helpers.log_debug 'Error while parsing application configuration on initialization'
+        @helpers.log_debug exception.to_s
       end
       @capture_outoing_requests = options['capture_outoing_requests']
       @capture_outgoing_requests = options['capture_outgoing_requests']
       if @capture_outoing_requests || @capture_outgoing_requests
-        log_debug 'Start Capturing outgoing requests'
+        @helpers.log_debug 'Start Capturing outgoing requests'
         require_relative '../../moesif_capture_outgoing/httplog.rb'
         MoesifCaptureOutgoing.start_capture_outgoing(options)
       end
@@ -92,7 +94,7 @@ module MoesifRack
       return Base64.encode64(body), 'base64'
     end
 
-    def log_debug(message)
+    def @helpers.log_debug(message)
       if @debug
         puts("#{Time.now.to_s} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
       end
@@ -125,26 +127,26 @@ module MoesifRack
                 until batch_events.size == @batch_size || @events_queue.empty? do 
                   batch_events << @events_queue.pop
                 end 
-                log_debug("Sending #{batch_events.size.to_s} events to Moesif")
+                @helpers.log_debug("Sending #{batch_events.size.to_s} events to Moesif")
                 event_api_response =  @api_controller.create_events_batch(batch_events)
                 @event_response_config_etag = event_api_response[:x_moesif_config_etag]
-                log_debug(event_api_response.to_s)
-                log_debug("Events successfully sent to Moesif")
+                @helpers.log_debug(event_api_response.to_s)
+                @helpers.log_debug("Events successfully sent to Moesif")
             end
             
             if @events_queue.empty?
-              log_debug("No events to read from the queue")
+              @helpers.log_debug("No events to read from the queue")
             end
   
             sleep @batch_max_time
           rescue MoesifApi::APIException => e
             if e.response_code.between?(401, 403)
               puts "Unathorized accesss sending event to Moesif. Please verify your Application Id."
-              log_debug(e.to_s)
+              @helpers.log_debug(e.to_s)
             end
-            log_debug("Error sending event to Moesif, with status code #{e.response_code.to_s}")
+            @helpers.log_debug("Error sending event to Moesif, with status code #{e.response_code.to_s}")
           rescue => e
-            log_debug(e.to_s)
+            @helpers.log_debug(e.to_s)
           end
         end
       end
@@ -153,7 +155,7 @@ module MoesifRack
     def call env
       start_time = Time.now.utc.iso8601
 
-      log_debug('Calling Moesif middleware')
+      @helpers.log_debug('Calling Moesif middleware')
 
       status, headers, body = @app.call env
       end_time = Time.now.utc.iso8601
@@ -248,67 +250,71 @@ module MoesifRack
         event_model.direction = "Incoming"
         
         if @identify_user
-          log_debug "calling identify user proc"
+          @helpers.log_debug "calling identify user proc"
           event_model.user_id = @identify_user.call(env, headers, body)
         end
 
         if @identify_company
-          log_debug "calling identify company proc"
+          @helpers.log_debug "calling identify company proc"
           event_model.company_id = @identify_company.call(env, headers, body)
         end
 
         if @get_metadata
-          log_debug "calling get_metadata proc"
+          @helpers.log_debug "calling get_metadata proc"
           event_model.metadata = @get_metadata.call(env, headers, body)
         end
 
         if @identify_session
-          log_debug "calling identify session proc"
+          @helpers.log_debug "calling identify session proc"
           event_model.session_token = @identify_session.call(env, headers, body)
         end
         if @mask_data
-          log_debug "calling mask_data proc"
+          @helpers.log_debug "calling mask_data proc"
           event_model = @mask_data.call(event_model)
         end
 
-        log_debug "sending data to moesif"
-        log_debug event_model.to_json
+        @helpers.log_debug "sending data to moesif"
+        @helpers.log_debug event_model.to_json
         # Perform the API call through the SDK function
         begin
-          @random_percentage = Random.rand(0.00..100.00)
+          random_percentage  = Random.rand(0.00..100.00)
 
           begin 
-            @sampling_percentage = @app_config.get_sampling_percentage(@config, event_model.user_id, event_model.company_id, @debug)
+            sampling_percentage = @app_config.get_sampling_percentage(@config, event_model.user_id, event_model.company_id)
+            @helpers.log_debug "Using sample rate #{sampling_percentage}"
           rescue => exception
-            log_debug 'Error while getting sampling percentage, assuming default behavior'
-            log_debug exception.to_s
-            @sampling_percentage = 100
+            @helpers.log_debug 'Error while getting sampling percentage, assuming default behavior'
+            @helpers.log_debug exception.to_s
+            sampling_percentage = 100
           end
 
-          if @sampling_percentage > @random_percentage
-            event_model.weight = @app_config.calculate_weight(@sampling_percentage)
+          if sampling_percentage > random_percentage 
+            event_model.weight = @app_config.calculate_weight(sampling_percentage)
             # Add Event to the queue
             @events_queue << event_model
-            log_debug("Event added to the queue ")
+            @helpers.log_debug("Event added to the queue ")
             if Time.now.utc > (@last_config_download_time + 60)
               start_worker()
             end
 
             if !@event_response_config_etag.nil? && !@config_etag.nil? && @config_etag != @event_response_config_etag && Time.now.utc > (@last_config_download_time + 300)
               begin 
-                @config = @app_config.get_config(@api_controller, @debug)
-                @config_etag, @sampling_percentage, @last_config_download_time = @app_config.parse_configuration(@config, @debug)
+                new_config = @app_config.get_config(@api_controller)
+                if !new_config.nil?
+                  @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
+                end
+
               rescue => exception
-                log_debug 'Error while updating the application configuration'
-                log_debug exception.to_s
+                @helpers.log_debug 'Error while updating the application configuration'
+                @helpers.log_debug exception.to_s
               end
             end
           else
-            log_debug("Skipped Event due to sampling percentage: " + @sampling_percentage.to_s + " and random percentage: " + @random_percentage.to_s)
+            @helpers.log_debug("Skipped Event due to sampling percentage: " + sampling_percentage.to_s + " and random percentage: " + random_percentage .to_s)
           end
         rescue => exception
-          log_debug "Error adding event to the queue "
-          log_debug exception.to_s
+          @helpers.log_debug "Error adding event to the queue "
+          @helpers.log_debug exception.to_s
         end
 
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Moesif, Inc
@@ -62,6 +62,7 @@ files:
 - lib/moesif_rack.rb
 - lib/moesif_rack/app_config.rb
 - lib/moesif_rack/client_ip.rb
+- lib/moesif_rack/helpers.rb
 - lib/moesif_rack/moesif_middleware.rb
 - lib/moesif_rack/update_company.rb
 - lib/moesif_rack/update_user.rb