moesif_rack 1.4.12 → 1.4.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3799b11682e81edcbfbdba3161dcbf93054be9ef44d90973d52e156ed1b12f8e
-  data.tar.gz: 6894a3d3b39dddf42542b8fa5265e71b8b156d1d049ecdc0dcdc5c4faf469bc2
+  metadata.gz: a4dc902308676d3b9bb9a23a61f9fc166024b0848d06e026f98a68be8de336b7
+  data.tar.gz: 898963aa24db49d6772f4a037d2919650c93e989e9ba735db8ac5e0c6b65bc02
 SHA512:
-  metadata.gz: 89aa06ce4366280d076cac4db01734fa3a4565f7694e6f5151a309f97cfe31dd646151f025b83b5364f0319ba9a58b9095fbee07fd6e60e5136559538f9fb720
-  data.tar.gz: 93b2c0db052a1d5b95a0f3ef34afa2de0ccf82d448cf6921d45151da3196837b23ed467b018d0b45dc7d3fbd8afe88cd452ed2977de71f5461d0542117f128d9
+  metadata.gz: dfca38cca1df0bf26113b8c7198f478dd178f0cf925c2103972b4770e6bcfa032eaa9079801079224cc7127d6166d499e73bc826062835675efe3ff642ba8fd9
+  data.tar.gz: 89d1b57bddaa065bc338aad7c92451405ad6a077bfc0e17635da7e42412681a922a22a2395b15f4a478969a4c63114fea582b693523504a87c3f1aec76862c50

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

@@ -4,12 +4,14 @@ require 'time'
 require 'zlib'
 require 'stringio'
 require_relative './helpers.rb'
+require_relative './regex_config_helper.rb'
 
 class AppConfig
 
     def initialize debug
         @debug = debug
         @helpers = Helpers.new(debug)
+        @regex_config_helper = RegexConfigHelper.new(debug)
     end
 
     def get_config(api_controller)
@@ -45,17 +47,17 @@ class AppConfig
             else
                 @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
             # 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
@@ -63,6 +65,17 @@ class AppConfig
                 @helpers.log_debug("Getting sample rate for user #{user_id} company #{company_id}")
                 @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)
 
@@ -87,6 +100,7 @@ class AppConfig
             end
         rescue => exception
             @helpers.log_debug 'Error while geting sampling percentage, assuming default behavior'
+            @helpers.log_debug exception.to_s
             return 100
         end
     end

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'
 
 module MoesifRack
 
@@ -167,6 +167,9 @@ module MoesifRack
         req = Rack::Request.new(env)
         complex_copy = env.dup
 
+        # Filter hash to only have keys of type string
+        complex_copy = complex_copy.select { |k, v| k.is_a? String }
+
         req_headers = {}
         complex_copy.select {|k,v| k.start_with?('HTTP_', 'CONTENT_') }.each do |key, val|
           new_key = key.sub(/^HTTP_/, '')
@@ -283,7 +286,7 @@ module MoesifRack
           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)
             @helpers.log_debug "Using sample rate #{sampling_percentage}"
           rescue => exception
             @helpers.log_debug 'Error while getting sampling percentage, assuming default behavior'
@@ -338,6 +341,8 @@ module MoesifRack
           @helpers.log_debug exception.to_s
           @helpers.log_debug exception.backtrace
         end
+      else
+         @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 './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.12
+  version: 1.4.16
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-02 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -17,40 +17,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        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
+        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: []
@@ -64,6 +58,7 @@ files:
 - lib/moesif_rack/client_ip.rb
 - lib/moesif_rack/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,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: moesif_rack