moesif_rack 1.4.19 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9648d28da08853893881cd32fef5fcf61d4f8d2c6a573d06ced10bb4e01bda3c
-  data.tar.gz: cebdf8b64372dd77a80520e8cbec1da161f623a6435a8ced10a700aa86e57113
+  metadata.gz: fe86ff126bcaddeb96d24cc3216864727ba7be4f2e4ba7495b5fd6dda789369a
+  data.tar.gz: 2d1bc431a0a59e77a6f1eac898a78535870a424db164f381a52c61767da6d63d
 SHA512:
-  metadata.gz: 35bb379b52dc6f4323d5dc98154c5ba741e438ec1cf98030f06775405c405e4a34871b9435a9a3f89d0b32e6545c2f6ec88083e59d2c4e97c271e765200e89bc
-  data.tar.gz: 72422bb99d80d78e91af4034ff4dd31f7f94c8424a498819a6767ce066045209e4dc8c1e9784a88377cf100e79fad3cb0733989f0869b449dedf60e91b916f60
+  metadata.gz: 6ed3762486f9223b7562b36e38561f72a156a3be5ab836a0ad5b363d2034cfce912125b44e10b0eb9e330ce22b00cdc0bc8665ac59d90702742b5492dd061698
+  data.tar.gz: 376d83545ec2635c2980351f22fb277a99ac62e878385748d7c33e9767c40ca7731d2670f0c44f531f9350312066534eb593b6b729603dbeaec03ea3f70ac919

data/lib/moesif_rack/app_config.rb

@@ -3,134 +3,97 @@ require 'json'
 require 'time'
 require 'zlib'
 require 'stringio'
-require_relative './moesif_helpers.rb'
-require_relative './regex_config_helper.rb'
+require_relative './moesif_helpers'
+require_relative './regex_config_helper'
 
 class AppConfig
+  attr_accessor :config, :recent_etag, :last_download_time
 
-    def initialize debug
-        @debug = 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()
-            @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)
-                @moesif_helpers.log_debug 'Unauthorized access getting application configuration. Please check your Appplication Id.'
-            end
-            @moesif_helpers.log_debug 'Error getting application configuration, with status code:'
-            @moesif_helpers.log_debug e.response_code
-        rescue => e
-            @moesif_helpers.log_debug e.to_s
-        end
-        rescue
-    end
+  def initialize(debug)
+    @debug = debug
+    @moesif_helpers = MoesifHelpers.new(debug)
+    @regex_config_helper = RegexConfigHelper.new(debug)
+  end
 
-    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)
-            @moesif_helpers.log_debug(response_body.to_s)
+  def should_reload(etag_from_create_event)
+    if @last_download_time.nil?
+      return true
+    elsif Time.now.utc > (@last_download_time + 300)
+      return true
+    elsif !etag_from_create_event.nil? && !@recent_etag.nil?
+      @moesif_helpers.log_debug('comparing if etag from event and recent etag match ' + etag_from_create_event + ' ' + @recent_etag)
 
-            # 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
-                @moesif_helpers.log_debug 'Response body is nil, assuming default behavior'
-                # Response body is nil, so assuming default behavior
-                return nil, nil, Time.now.utc
-            end
-        rescue => exception
-            @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, nil, Time.now.utc
-        end
+      return etag_from_create_event != @recent_etag
     end
+    @moesif_helpers.log_debug('should skip reload config')
+    return false;
+  end
 
-    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 
-                @moesif_helpers.log_debug("Getting sample rate for user #{user_id} company #{company_id}")
-                @moesif_helpers.log_debug(config_api_response.to_s)
+  def get_config(api_controller)
+    # Get Application Config
+    @moesif_helpers.log_debug('try to loading etag')
+    config_json, _context = api_controller.get_app_config
+    @config = config_json
+    @recent_etag = _context.response.headers[:x_moesif_config_etag]
+    @last_download_time = Time.now.utc
+    @moesif_helpers.log_debug('new config downloaded')
+    @moesif_helpers.log_debug(config_json.to_s)
+  rescue MoesifApi::APIException => e
+    if e.response_code.between?(401, 403)
+      @moesif_helpers.log_debug 'Unauthorized access getting application configuration. Please check your Appplication Id.'
+    end
+    @moesif_helpers.log_debug 'Error getting application configuration, with status code:'
+    @moesif_helpers.log_debug e.response_code
+  rescue StandardError => e
+    @moesif_helpers.log_debug e.to_s
+  end
 
-                # Get Regex Sampling rate
-                regex_config = config_api_response.fetch('regex_config', nil)
+  def get_sampling_percentage(event_model, user_id, company_id)
+    # if we do not have config for some reason we return 100
+    if !@config.nil?
+    # Get sampling percentage
+      @moesif_helpers.log_debug("Getting sample rate for user #{user_id} company #{company_id}")
+      @moesif_helpers.log_debug(@config.to_s)
 
-                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 Regex Sampling rate
+      regex_config = @config.fetch('regex_config', nil)
 
-                # Get user sample rate object
-                user_sample_rate = config_api_response.fetch('user_sample_rate', 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)
+        return regex_sample_rate unless regex_sample_rate.nil?
+      end
 
-                # Get company sample rate object
-                company_sample_rate = config_api_response.fetch('company_sample_rate', nil)
+      # Get user sample rate object
+      user_sample_rate = @config.fetch('user_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)
-                    return user_sample_rate.fetch(user_id)
-                end
+      # Get company sample rate object
+      company_sample_rate = @config.fetch('company_sample_rate', nil)
 
-                # Get sample rate for the company if exist
-                if !company_id.nil? && !company_sample_rate.nil? && company_sample_rate.key?(company_id)
-                    return company_sample_rate.fetch(company_id)
-                end
+      # Get sample rate for the user if exist
+      if !user_id.nil? && !user_sample_rate.nil? && user_sample_rate.key?(user_id)
+        return user_sample_rate.fetch(user_id)
+      end
 
-                # Return sample rate
-                return config_api_response.fetch('sample_rate', 100)
-            else 
-                @moesif_helpers.log_debug 'Assuming default behavior as response body is nil - '
-                return 100
-            end
-        rescue => exception
-            @moesif_helpers.log_debug 'Error while geting sampling percentage, assuming default behavior'
-            @moesif_helpers.log_debug exception.to_s
-            return 100
-        end
-    end
+      # Get sample rate for the company if exist
+      if !company_id.nil? && !company_sample_rate.nil? && company_sample_rate.key?(company_id)
+        return company_sample_rate.fetch(company_id)
+      end
 
-    def decompress_gzip_body(config_api_response)
-        # Decompress gzip response body
-        begin
-            # Check if the content-encoding header exist and is of type zip
-            if config_api_response.headers.key?(:content_encoding) && config_api_response.headers[:content_encoding].eql?( 'gzip' ) then
-                
-                # Create a GZipReader object to read data
-                gzip_reader = Zlib::GzipReader.new(StringIO.new(config_api_response.raw_body.to_s))
-                
-                # Read the body
-                uncompressed_string = gzip_reader.read
-                
-                # Return the parsed body
-                return JSON.parse( uncompressed_string )
-            else
-                @moesif_helpers.log_debug 'Content Encoding is of type other than gzip, returning nil'
-                return nil
-            end
-        rescue => exception
-            @moesif_helpers.log_debug 'Error while decompressing the response body'
-            @moesif_helpers.log_debug exception.to_s
-            return nil
-        end
+      # Return overall sample rate
+      @config.fetch('sample_rate', 100)
+    else
+      @moesif_helpers.log_debug 'Assuming default behavior as response body is nil - '
+      100
     end
+  rescue StandardError => e
+    @moesif_helpers.log_debug 'Error while geting sampling percentage, assuming default behavior'
+    @moesif_helpers.log_debug e.to_s
+    100
+  end
 
-    def calculate_weight(sample_rate)
-        return sample_rate == 0 ? 1 : (100 / sample_rate).floor
-    end
+  def calculate_weight(sample_rate)
+    sample_rate == 0 ? 1 : (100 / sample_rate).floor
+  end
 end

data/lib/moesif_rack/client_ip.rb

@@ -1,119 +1,78 @@
-
 def is_ip?(value)
-    ipv4 = /^(?:(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])\.){3}(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])$/
-    ipv6 = /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/
-    # We use !! to convert the return value to a boolean
-    !!(value =~ ipv4 or value=~ ipv6)
+  ipv4 = /^(?:(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])\.){3}(?:\d|[1-9]\d|1\d{2}|2[0-4]\d|25[0-5])$/
+  ipv6 = /^\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/
+  # We use !! to convert the return value to a boolean
+  !!(value =~ ipv4 or value =~ ipv6)
 end
 
 def get_client_ip_from_x_forwarded_for(value)
-    begin
-        value = value.encode('utf-8')
-
-        if value.to_s.empty?
-            return nil
-        end
-
-        if !value.instance_of?(String)
-            puts ("Expected a string, got - " + value.class.to_s)
-        else
-            # x-forwarded-for may return multiple IP addresses in the format:
-            # "client IP, proxy 1 IP, proxy 2 IP"
-            # Therefore, the right-most IP address is the IP address of the most recent proxy
-            # and the left-most IP address is the IP address of the originating client.
-            # source: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/x-forwarded-headers.html
-            # Azure Web App's also adds a port for some reason, so we'll only use the first part (the IP)
-            forwardedIps = []
-
-            value.gsub(/\s+/, "").split(',').each do |e|
-               if e.include?(':') 
-                    splitted = e.split(':')
-                    if splitted.length == 2 
-                        forwardedIps << splitted.first
-                    end
-               end
-               forwardedIps << e
-            end
-
-            # Sometimes IP addresses in this header can be 'unknown' (http://stackoverflow.com/a/11285650).
-            # Therefore taking the left-most IP address that is not unknown
-            # A Squid configuration directive can also set the value to "unknown" (http://www.squid-cache.org/Doc/config/forwarded_for/)
-            return forwardedIps.find {|e| is_ip?(e) }
-        end
-    rescue
-        return value.encode('utf-8')
+  value = value.encode('utf-8')
+
+  return nil if value.to_s.empty?
+
+  if !value.instance_of?(String)
+    puts('Expected a string, got - ' + value.class.to_s)
+  else
+    # x-forwarded-for may return multiple IP addresses in the format:
+    # "client IP, proxy 1 IP, proxy 2 IP"
+    # Therefore, the right-most IP address is the IP address of the most recent proxy
+    # and the left-most IP address is the IP address of the originating client.
+    # source: http://docs.aws.amazon.com/elasticloadbalancing/latest/classic/x-forwarded-headers.html
+    # Azure Web App's also adds a port for some reason, so we'll only use the first part (the IP)
+    forwardedIps = []
+
+    value.gsub(/\s+/, '').split(',').each do |e|
+      if e.include?(':')
+        splitted = e.split(':')
+        forwardedIps << splitted.first if splitted.length == 2
+      end
+      forwardedIps << e
     end
+
+    # Sometimes IP addresses in this header can be 'unknown' (http://stackoverflow.com/a/11285650).
+    # Therefore taking the left-most IP address that is not unknown
+    # A Squid configuration directive can also set the value to "unknown" (http://www.squid-cache.org/Doc/config/forwarded_for/)
+    forwardedIps.find { |e| is_ip?(e) }
+  end
+rescue StandardError
+  value.encode('utf-8')
 end
 
 def get_client_address(env)
-    begin
-        # Standard headers used by Amazon EC2, Heroku, and others.
-        if env.key?('HTTP_X_CLIENT_IP')
-            if is_ip?(env['HTTP_X_CLIENT_IP'])
-                return env['HTTP_X_CLIENT_IP']
-            end
-        end
+  # Standard headers used by Amazon EC2, Heroku, and others.
+  return env['HTTP_X_CLIENT_IP'] if env.key?('HTTP_X_CLIENT_IP') && is_ip?(env['HTTP_X_CLIENT_IP'])
 
-        # Load-balancers (AWS ELB) or proxies.
-        if env.key?('HTTP_X_FORWARDED_FOR')
-            xForwardedFor = get_client_ip_from_x_forwarded_for(env['HTTP_X_FORWARDED_FOR'])
-            if is_ip?(xForwardedFor)
-                return xForwardedFor
-            end
-        end
+  # Load-balancers (AWS ELB) or proxies.
+  if env.key?('HTTP_X_FORWARDED_FOR')
+    xForwardedFor = get_client_ip_from_x_forwarded_for(env['HTTP_X_FORWARDED_FOR'])
+    return xForwardedFor if is_ip?(xForwardedFor)
+  end
 
-        # Cloudflare.
-        # @see https://support.cloudflare.com/hc/en-us/articles/200170986-How-does-Cloudflare-handle-HTTP-Request-headers-
-        # CF-Connecting-IP - applied to every request to the origin.
-        if env.key?('HTTP_CF_CONNECTING_IP')
-            if is_ip?(env['HTTP_CF_CONNECTING_IP'])
-                return env['HTTP_CF_CONNECTING_IP']
-            end
-        end
+  # Cloudflare.
+  # @see https://support.cloudflare.com/hc/en-us/articles/200170986-How-does-Cloudflare-handle-HTTP-Request-headers-
+  # CF-Connecting-IP - applied to every request to the origin.
+  return env['HTTP_CF_CONNECTING_IP'] if env.key?('HTTP_CF_CONNECTING_IP') && is_ip?(env['HTTP_CF_CONNECTING_IP'])
 
-        # Akamai and Cloudflare: True-Client-IP.
-        if env.key?('HTTP_TRUE_CLIENT_IP')
-            if is_ip?(env['HTTP_TRUE_CLIENT_IP'])
-                return env['HTTP_TRUE_CLIENT_IP']
-            end
-        end
+  # Akamai and Cloudflare: True-Client-IP.
+  return env['HTTP_TRUE_CLIENT_IP'] if env.key?('HTTP_TRUE_CLIENT_IP') && is_ip?(env['HTTP_TRUE_CLIENT_IP'])
 
-        # Default nginx proxy/fcgi; alternative to x-forwarded-for, used by some proxies.
-        if env.key?('HTTP_X_REAL_IP')
-            if is_ip?(env['HTTP_X_REAL_IP'])
-                return env['HTTP_X_REAL_IP']
-            end
-        end
+  # Default nginx proxy/fcgi; alternative to x-forwarded-for, used by some proxies.
+  return env['HTTP_X_REAL_IP'] if env.key?('HTTP_X_REAL_IP') && is_ip?(env['HTTP_X_REAL_IP'])
 
-        # (Rackspace LB and Riverbed's Stingray)
-        # http://www.rackspace.com/knowledge_center/article/controlling-access-to-linux-cloud-sites-based-on-the-client-ip-address
-        # https://splash.riverbed.com/docs/DOC-1926
-        if env.key?('HTTP_X_CLUSTER_CLIENT_IP')
-            if is_ip?(env['HTTP_X_CLUSTER_CLIENT_IP'])
-                return env['HTTP_X_CLUSTER_CLIENT_IP']
-            end
-        end
+  # (Rackspace LB and Riverbed's Stingray)
+  # http://www.rackspace.com/knowledge_center/article/controlling-access-to-linux-cloud-sites-based-on-the-client-ip-address
+  # https://splash.riverbed.com/docs/DOC-1926
+  if env.key?('HTTP_X_CLUSTER_CLIENT_IP') && is_ip?(env['HTTP_X_CLUSTER_CLIENT_IP'])
+    return env['HTTP_X_CLUSTER_CLIENT_IP']
+  end
 
-        if env.key?('HTTP_X_FORWARDED')
-            if is_ip?(env['HTTP_X_FORWARDED'])
-                return env['HTTP_X_FORWARDED']
-            end
-        end
+  return env['HTTP_X_FORWARDED'] if env.key?('HTTP_X_FORWARDED') && is_ip?(env['HTTP_X_FORWARDED'])
 
-        if env.key?('HTTP_FORWARDED_FOR')
-            if is_ip?(env['HTTP_FORWARDED_FOR'])
-                return env['HTTP_FORWARDED_FOR']
-            end
-        end
+  return env['HTTP_FORWARDED_FOR'] if env.key?('HTTP_FORWARDED_FOR') && is_ip?(env['HTTP_FORWARDED_FOR'])
 
-        if env.key?('HTTP_FORWARDED')
-            if is_ip?(env['HTTP_FORWARDED'])
-                return env['HTTP_FORWARDED']
-            end
-        end
+  return env['HTTP_FORWARDED'] if env.key?('HTTP_FORWARDED') && is_ip?(env['HTTP_FORWARDED'])
 
-        return env['REMOTE_ADDR']
-    rescue 
-        return env['REMOTE_ADDR']
-    end
-end
+  env['REMOTE_ADDR']
+rescue StandardError
+  env['REMOTE_ADDR']
+end