moesif_rack 1.4.13 → 1.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b3a1d161ed29b64ba421ea3ce26eeca1a4c07e254026ddde7c309050698f6b7
-  data.tar.gz: 5b1c25138700a1d87aad3544a2fcdd9c60d937ba9e5a9520f8c1d76504b25e57
+  metadata.gz: b73acd14bb1af6f2d4ee8225fdd39ee19c6d1d9cf937ad37a9b10a7278842272
+  data.tar.gz: c1e74c3f4afdbdbfe0cef5fc75dca534f8d289c0f0befdac9085b9f48d4575bf
 SHA512:
-  metadata.gz: bb83df52630f55e46e87af701009adc52c88e0a3adf197482688fb6590f5b78f667123e356504dbe5ee8fb936e3e732879fb0c15d6531c7da9b6667e8aeb30ab
-  data.tar.gz: '087f2422c60f09f2aefd1e98ca84d99475257776950429cbdba67ea98adca0211ecdc81e9c2b9a751664f5b38e5630af1bc0b9e4633eff60bee95df4cdef7b0f'
+  metadata.gz: 186263e17ebe464783f65297d205c6fea8dcde346ecf979bc1c79c0fd2468e31f474ab278ca94ff2664f6ebd5b9b5a8bc991f00c7f82532ccf709091d6db543e
+  data.tar.gz: e7c29d009f3dc63464181025aa2679f45ee1b3972c72402934e43fa4fef0e778da300084d03b524f689c1b2dda81f3d16a351deb234c68d06cd01f21bd847111

data/README.md

@@ -529,7 +529,7 @@ response = MoesifRack::MoesifMiddleware.new(@app, @options).update_companies_bat
 1. Manually clone the git repo
 2. From terminal/cmd navigate to the root directory of the middleware.
 3. Invoke 'gem install moesif_rack'
-4. Add your own application id to 'test/moesif_rack_test.rb'. You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Top Right Menu_ -> _Installation_
+4. Add your own application id to 'test/moesif_rack_test.rb'. You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Bottom Left Menu_ -> _Installation_
 5. Invoke 'ruby test/moesif_rack_test.rb'
 6. Invoke 'ruby -I test test/moesif_rack_test.rb -n test_capture_outgoing' to test capturing outgoing API calls from your app to third parties like Stripe, Github or to your own dependencies.
 

data/lib/moesif_rack/app_config.rb

@@ -3,30 +3,32 @@ require 'json'
 require 'time'
 require 'zlib'
 require 'stringio'
-require_relative './helpers.rb'
+require_relative './moesif_helpers.rb'
+require_relative './regex_config_helper.rb'
 
 class AppConfig
 
     def initialize debug
         @debug = debug
-        @helpers = Helpers.new(debug)
+        @moesif_helpers = MoesifHelpers.new(debug)
+        @regex_config_helper = RegexConfigHelper.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)
+            @moesif_helpers.log_debug("new config downloaded")
+            @moesif_helpers.log_debug(config_api_response.to_s)
             return config_api_response
         rescue MoesifApi::APIException => e
             if e.response_code.between?(401, 403)
-                @helpers.log_debug 'Unauthorized access getting application configuration. Please check your Appplication Id.'
+                @moesif_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
+            @moesif_helpers.log_debug 'Error getting application configuration, with status code:'
+            @moesif_helpers.log_debug e.response_code
         rescue => e
-            @helpers.log_debug e.to_s
+            @moesif_helpers.log_debug e.to_s
         end
         rescue
     end
@@ -36,32 +38,43 @@ class AppConfig
         begin
             # Rails return gzipped compressed response body, so decompressing it and getting JSON response body
             response_body = decompress_gzip_body(config_api_response)
-            @helpers.log_debug(response_body.to_s)
+            @moesif_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 response_body, config_api_response.headers[:x_moesif_config_etag], Time.now.utc
             else
-                @helpers.log_debug 'Response body is nil, assuming default behavior'
+                @moesif_helpers.log_debug 'Response body is nil, assuming default behavior'
                 # Response body is nil, so assuming default behavior
-                return nil, 100, Time.now.utc
+                return nil, nil, Time.now.utc
             end
         rescue => exception
-            @helpers.log_debug 'Error while parsing the configuration object, assuming default behavior'
-            @helpers.log_debug exception.to_s
+            @moesif_helpers.log_debug 'Error while parsing the configuration object, assuming default behavior'
+            @moesif_helpers.log_debug exception.to_s
             # Assuming default behavior
-            return nil, 100, Time.now.utc
+            return nil, nil, Time.now.utc
         end
     end
 
-    def get_sampling_percentage(config_api_response, user_id, company_id)
+    def get_sampling_percentage(event_model, config_api_response, user_id, company_id)
         # Get sampling percentage
         begin
             # Check if response body is not nil
             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)
+                @moesif_helpers.log_debug("Getting sample rate for user #{user_id} company #{company_id}")
+                @moesif_helpers.log_debug(config_api_response.to_s)
+
+                # Get Regex Sampling rate
+                regex_config = config_api_response.fetch('regex_config', nil)
+
+                if !regex_config.nil? and !event_model.nil?
+                    config_mapping = @regex_config_helper.prepare_config_mapping(event_model)
+                    regex_sample_rate = @regex_config_helper.fetch_sample_rate_on_regex_match(regex_config, config_mapping)
+                    if !regex_sample_rate.nil?
+                        return regex_sample_rate
+                    end
+                end
 
                 # Get user sample rate object
                 user_sample_rate = config_api_response.fetch('user_sample_rate', nil)
@@ -82,11 +95,12 @@ class AppConfig
                 # Return sample rate
                 return config_api_response.fetch('sample_rate', 100)
             else 
-                @helpers.log_debug 'Assuming default behavior as response body is nil - '
+                @moesif_helpers.log_debug 'Assuming default behavior as response body is nil - '
                 return 100
             end
         rescue => exception
-            @helpers.log_debug 'Error while geting sampling percentage, assuming default behavior'
+            @moesif_helpers.log_debug 'Error while geting sampling percentage, assuming default behavior'
+            @moesif_helpers.log_debug exception.to_s
             return 100
         end
     end
@@ -106,12 +120,12 @@ class AppConfig
                 # Return the parsed body
                 return JSON.parse( uncompressed_string )
             else
-                @helpers.log_debug 'Content Encoding is of type other than gzip, returning nil'
+                @moesif_helpers.log_debug 'Content Encoding is of type other than gzip, returning nil'
                 return nil
             end
         rescue => exception
-            @helpers.log_debug 'Error while decompressing the response body'
-            @helpers.log_debug exception.to_s
+            @moesif_helpers.log_debug 'Error while decompressing the response body'
+            @moesif_helpers.log_debug exception.to_s
             return nil
         end
     end

data/lib/moesif_rack/{helpers.rb → moesif_helpers.rb}

@@ -1,6 +1,6 @@
 require 'time'
 
-class Helpers
+class MoesifHelpers
 
     def initialize debug
         @debug = debug

data/lib/moesif_rack/moesif_middleware.rb

@@ -2,13 +2,13 @@ require 'moesif_api'
 require 'json'
 require 'time'
 require 'base64'
+require 'zlib'
+require 'stringio'
 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'
+require_relative './moesif_helpers.rb'
 
 module MoesifRack
 
@@ -30,7 +30,7 @@ module MoesifRack
       @skip = options['skip']
       @debug = options['debug']
       @app_config = AppConfig.new(@debug)
-      @helpers = Helpers.new(@debug)
+      @moesif_helpers = MoesifHelpers.new(@debug)
       @config = @app_config.get_config(@api_controller)
       @config_etag = nil
       @last_config_download_time = Time.now.utc
@@ -50,13 +50,13 @@ module MoesifRack
           @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
         end
       rescue => exception
-        @helpers.log_debug 'Error while parsing application configuration on initialization'
-        @helpers.log_debug exception.to_s
+        @moesif_helpers.log_debug 'Error while parsing application configuration on initialization'
+        @moesif_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
-        @helpers.log_debug 'Start Capturing outgoing requests'
+        @moesif_helpers.log_debug 'Start Capturing outgoing requests'
         require_relative '../../moesif_capture_outgoing/httplog.rb'
         MoesifCaptureOutgoing.start_capture_outgoing(options)
       end
@@ -94,7 +94,7 @@ module MoesifRack
       return Base64.encode64(body), 'base64'
     end
 
-    def @helpers.log_debug(message)
+    def @moesif_helpers.log_debug(message)
       if @debug
         puts("#{Time.now.to_s} [Moesif Middleware] PID #{Process.pid} TID #{Thread.current.object_id} #{message}")
       end
@@ -130,26 +130,26 @@ module MoesifRack
                 until batch_events.size == @batch_size || @events_queue.empty? do 
                   batch_events << @events_queue.pop
                 end 
-                @helpers.log_debug("Sending #{batch_events.size.to_s} events to Moesif")
+                @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]
-                @helpers.log_debug(event_api_response.to_s)
-                @helpers.log_debug("Events successfully sent to Moesif")
+                @moesif_helpers.log_debug(event_api_response.to_s)
+                @moesif_helpers.log_debug("Events successfully sent to Moesif")
             end
             
             if @events_queue.empty?
-              @helpers.log_debug("No events to read from the queue")
+              @moesif_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."
-              @helpers.log_debug(e.to_s)
+              @moesif_helpers.log_debug(e.to_s)
             end
-            @helpers.log_debug("Error sending event to Moesif, with status code #{e.response_code.to_s}")
+            @moesif_helpers.log_debug("Error sending event to Moesif, with status code #{e.response_code.to_s}")
           rescue => e
-            @helpers.log_debug(e.to_s)
+            @moesif_helpers.log_debug(e.to_s)
           end
         end
       end
@@ -158,7 +158,7 @@ module MoesifRack
     def call env
       start_time = Time.now.utc.iso8601(3)
 
-      @helpers.log_debug('Calling Moesif middleware')
+      @moesif_helpers.log_debug('Calling Moesif middleware')
 
       status, headers, body = @app.call env
       end_time = Time.now.utc.iso8601(3)
@@ -256,41 +256,41 @@ module MoesifRack
         event_model.direction = "Incoming"
         
         if @identify_user
-          @helpers.log_debug "calling identify user proc"
+          @moesif_helpers.log_debug "calling identify user proc"
           event_model.user_id = @identify_user.call(env, headers, body)
         end
 
         if @identify_company
-          @helpers.log_debug "calling identify company proc"
+          @moesif_helpers.log_debug "calling identify company proc"
           event_model.company_id = @identify_company.call(env, headers, body)
         end
 
         if @get_metadata
-          @helpers.log_debug "calling get_metadata proc"
+          @moesif_helpers.log_debug "calling get_metadata proc"
           event_model.metadata = @get_metadata.call(env, headers, body)
         end
 
         if @identify_session
-          @helpers.log_debug "calling identify session proc"
+          @moesif_helpers.log_debug "calling identify session proc"
           event_model.session_token = @identify_session.call(env, headers, body)
         end
         if @mask_data
-          @helpers.log_debug "calling mask_data proc"
+          @moesif_helpers.log_debug "calling mask_data proc"
           event_model = @mask_data.call(event_model)
         end
 
-        @helpers.log_debug "sending data to moesif"
-        @helpers.log_debug event_model.to_json
+        @moesif_helpers.log_debug "sending data to moesif"
+        @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)
 
           begin 
-            sampling_percentage = @app_config.get_sampling_percentage(@config, event_model.user_id, event_model.company_id)
-            @helpers.log_debug "Using sample rate #{sampling_percentage}"
+            sampling_percentage = @app_config.get_sampling_percentage(event_model, @config, event_model.user_id, event_model.company_id)
+            @moesif_helpers.log_debug "Using sample rate #{sampling_percentage}"
           rescue => exception
-            @helpers.log_debug 'Error while getting sampling percentage, assuming default behavior'
-            @helpers.log_debug exception.to_s
+            @moesif_helpers.log_debug 'Error while getting sampling percentage, assuming default behavior'
+            @moesif_helpers.log_debug exception.to_s
             sampling_percentage = 100
           end
 
@@ -298,7 +298,7 @@ module MoesifRack
             event_model.weight = @app_config.calculate_weight(sampling_percentage)
             # Add Event to the queue
             @events_queue << event_model
-            @helpers.log_debug("Event added to the queue ")
+            @moesif_helpers.log_debug("Event added to the queue ")
             if Time.now.utc > (@last_worker_run + 60)
               start_worker()
             end
@@ -311,16 +311,16 @@ module MoesifRack
                 end
 
               rescue => exception
-                @helpers.log_debug 'Error while updating the application configuration'
-                @helpers.log_debug exception.to_s
+                @moesif_helpers.log_debug 'Error while updating the application configuration'
+                @moesif_helpers.log_debug exception.to_s
               end
             end
           else
-            @helpers.log_debug("Skipped Event due to sampling percentage: " + sampling_percentage.to_s + " and random percentage: " + random_percentage .to_s)
+            @moesif_helpers.log_debug("Skipped Event due to sampling percentage: " + sampling_percentage.to_s + " and random percentage: " + random_percentage.to_s)
           end
         rescue => exception
-          @helpers.log_debug "Error adding event to the queue "
-          @helpers.log_debug exception.to_s
+          @moesif_helpers.log_debug "Error adding event to the queue "
+          @moesif_helpers.log_debug exception.to_s
         end
 
       end
@@ -337,10 +337,12 @@ module MoesifRack
         begin 
           process_send.call
         rescue => exception
-          @helpers.log_debug 'Error while logging event - '
-          @helpers.log_debug exception.to_s
-          @helpers.log_debug exception.backtrace
+          @moesif_helpers.log_debug 'Error while logging event - '
+          @moesif_helpers.log_debug exception.to_s
+          @moesif_helpers.log_debug exception.backtrace
         end
+      else
+         @moesif_helpers.log_debug "Skipped Event using should_skip configuration option."
       end
 
       [status, headers, body]

data/lib/moesif_rack/regex_config_helper.rb

@@ -0,0 +1,119 @@
+require 'moesif_api'
+
+require_relative './moesif_helpers.rb'
+
+class RegexConfigHelper
+
+    def initialize debug
+        @debug = debug
+    end
+
+    def prepare_config_mapping(event)
+        # Function to prepare config mapping
+        # Params:
+        #  - event: Event to be logged
+        # Return:
+        #  - regex_config: Regex config mapping
+        regex_config = {}
+
+        # Config mapping for request.verb
+        if defined? event.request.verb
+            regex_config["request.verb"] = event.request.verb
+        end
+
+        # Config mapping for request.uri
+        if defined? event.request.uri
+            extracted = /http[s]*:\/\/[^\/]+(\/[^?]+)/.match(event.request.uri)
+            if !extracted.nil?
+              route_mapping = extracted.captures[0]
+            else
+              route_mapping = '/'
+            end
+            regex_config["request.route"] = route_mapping
+        end
+
+        # Config mapping for request.ip_address
+        if defined? event.request.ip_address
+            regex_config["request.ip_address"] = event.request.ip_address
+        end
+
+        # Config mapping for response.status
+        if defined? event.response.status
+            regex_config["response.status"] = event.response.status
+        end
+
+        return regex_config
+
+    end
+
+    def regex_match(event_value, condition_value)
+        # Function to perform the regex matching with event value and condition value
+        # Params:
+        #  - event_value: Value associated with event (request)
+        #  - condition_value: Value associated with the regex config condition
+        # Return:
+        #  - regex_matched: Regex matched value to determine if the regex match was successful
+
+        extracted = Regexp.new(condition_value).match(event_value)
+        if !extracted.nil?
+          return extracted.to_s
+        end
+    end
+
+    def fetch_sample_rate_on_regex_match(regex_configs, config_mapping)
+        # Function to fetch the sample rate and determine if request needs to be block or not
+        # Args:
+        #  - regex_configs: Regex configs
+        #  - config_mapping: Config associated with the request
+        # Return:
+        #  - sample_rate: Sample rate
+
+        # Iterate through the list of regex configs
+        regex_configs.each { |regex_rule|
+            # Fetch the sample rate
+            sample_rate = regex_rule["sample_rate"]
+            # Fetch the conditions
+            conditions = regex_rule["conditions"]
+            # Bool flag to determine if the regex conditions are matched
+            regex_matched = false
+            # Create a table to hold the conditions mapping (path and value)
+            condition_table = {}
+
+            # Iterate through the regex rule conditions and map the path and value
+            conditions.each { |condition|
+                # Add condition path -> value to the condition table
+                condition_table[condition["path"]] = condition["value"]
+            }
+
+            # Iterate through conditions table and perform `and` operation between each conditions
+            condition_table.each do |path, values|
+
+                # Check if the path exists in the request config mapping
+                if !config_mapping[path].nil?
+                    # Fetch the value of the path in request config mapping
+                    event_data = config_mapping[path]
+
+                    # Perform regex matching with event value
+                    regex_matched = regex_match(event_data, values)
+                else
+                    # Path does not exists in request config mapping, so no need to match regex condition rule
+                    regex_matched = false
+                end
+
+                # If one of the rule does not match, skip the condition & avoid matching other rules for the same condition
+                if !regex_matched
+                    break
+                end
+            end
+
+            # If regex conditions matched, return sample rate
+            if regex_matched
+                return sample_rate
+            end
+        }
+
+        # If regex conditions are not matched, return sample rate as None and will use default sample rate
+        return nil
+    end
+
+end

data/moesif_capture_outgoing/httplog/http_log.rb

@@ -176,7 +176,7 @@ module MoesifCaptureOutgoing
           begin
             @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)
+              @sampling_percentage = @app_config.get_sampling_percentage(event_model, @config, event_model.user_id, event_model.company_id)
             rescue => exception
               if @debug
                 puts 'Error while getting sampling percentage, assuming default behavior'

data/test/moesif_rack_test.rb

@@ -117,7 +117,8 @@ class MoesifRackTest < Test::Unit::TestCase
     @api_client = MoesifApi::MoesifAPIClient.new(@options['application_id'])
     @api_controller = @api_client.api
     @config = @app_config.get_config(@api_controller)
-    @config_etag, @sampling_percentage, @last_updated_time = @app_config.parse_configuration(@config, @debug)
+    @config_body, @config_etag, @last_updated_time = @app_config.parse_configuration(@config)
+    @sampling_percentage = @app_config.get_sampling_percentage(nil, @config_body, nil, nil)
     assert_operator 100, :>=, @sampling_percentage
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.4.13
+  version: 1.4.17
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,48 +9,42 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.5
-  name: test-unit
-  prerelease: false
+        version: 3.5.0
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
+  name: moesif_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.12
-  name: moesif_api
-  prerelease: false
+        version: 1.2.14
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.12
+        version: 1.2.14
 description: Rack/Rails middleware to log API calls to Moesif API analytics and monitoring
 email: xing@moesif.com
 executables: []
@@ -62,8 +56,9 @@ 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_helpers.rb
 - lib/moesif_rack/moesif_middleware.rb
+- lib/moesif_rack/regex_config_helper.rb
 - lib/moesif_rack/update_company.rb
 - lib/moesif_rack/update_user.rb
 - moesif_capture_outgoing/httplog.rb
@@ -87,7 +82,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -96,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.10
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: moesif_rack