moesif_rack 1.3.5 → 1.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c829d3004e26c40536debc186d0c45a8a3cf08d854c75f0cf76dce20d142e951
-  data.tar.gz: ac8c4d6c2c66dae5348b7421128fdd6b5ce0b2c9a48e1712aa632817f2ade291
+  metadata.gz: f40e229ac134210c6703c176f6ce81a6de3c1fd483f5430c88ebb93dd60ad67e
+  data.tar.gz: c7afe14c3db3328dfe93fa824a245d2bea5ac88e89e48bb29735e6a0696f14e0
 SHA512:
-  metadata.gz: 7f10f8c2e8c4cb8af3d55a4d5aee69626ddb893405ba866578af506834516848b5367f5361a07ca5eb6acb3adccae2a8429432d8792cfb197391b42db310dab6
-  data.tar.gz: 3ee6984671ab33f20dcf4b6b640935e315cc84c68e39bb9093b77a9e632aa3683e0e213d197140baa93f76f14809e0d19f701710900f0edc1e9575182121c27f
+  metadata.gz: ba2af16c43d3f9887b013edd3cfedac7cc032d713b51cc32c6250dfad367df96d7c1b848563aaf1889ce01ec2eb8d6b952ff08f12f40ebb210205570a7a59ace
+  data.tar.gz: 36acfefacd5edc2810185aa3b6096397e0ea2e0ee2b3003f7c3c9b99897d245be36dad84e45b35c3feded80fff6032d9704cc7edd2499a609354ded37e323ff5

data/lib/moesif_rack/app_config.rb

@@ -0,0 +1,121 @@
+require 'moesif_api'
+require 'json'
+require 'time'
+require 'zlib'
+require 'stringio'
+
+class AppConfig
+
+    def get_config(api_controller, debug)
+        # Get Application Config
+        begin 
+            config_api_response = api_controller.get_app_config()
+            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
+            end
+        end
+    end
+
+    def parse_configuration(config_api_response, debug)
+        # 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)
+
+            # 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
+            else
+                if debug
+                    puts 'Response body is nil, assuming default behavior'
+                end
+                # 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
+            # Assuming default behavior
+            return nil, 100, Time.now.utc
+        end
+    end
+
+    def get_sampling_percentage(config_api_response, user_id, company_id, debug)
+        # 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 
+                
+                # Get user sample rate object
+                user_sample_rate = response_body.fetch('user_sample_rate', nil)
+
+                # Get company sample rate object
+                company_sample_rate = response_body.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)
+                    return user_sample_rate.fetch(user_id)
+                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
+
+                # Return sample rate
+                return response_body.fetch('sample_rate', 100)
+            else 
+                if debug
+                    puts 'Assuming default behavior as response body is nil - '
+                end
+                return 100
+            end
+        rescue => exception
+            if debug
+                puts 'Error while geting sampling percentage, assuming default behavior'
+            end
+            return 100
+        end
+    end
+
+    def decompress_gzip_body(config_api_response, debug)
+        # 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
+                if debug
+                    puts 'Content Encoding is of type other than gzip, returning nil'
+                end
+                return nil
+            end
+        rescue => exception
+            if debug
+                puts 'Error while decompressing the response body'
+                puts exception.to_s
+            end
+            return nil
+        end
+    end
+end

data/lib/moesif_rack/moesif_middleware.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'time'
 require 'base64'
 require_relative './client_ip.rb'
+require_relative './app_config.rb'
 require_relative './update_user.rb'
 require_relative './update_company.rb'
 
@@ -12,7 +13,7 @@ module MoesifRack
     def initialize app, options = {}
       @app = app
       if not options['application_id']
-        raise 'application_id requird for Moesif Middleware'
+        raise 'application_id required for Moesif Middleware'
       end
       @api_client = MoesifApi::MoesifAPIClient.new(options['application_id'])
       @api_controller = @api_client.api
@@ -25,12 +26,23 @@ 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)
+      @config_etag = nil
+      @sampling_percentage = 100
+      @last_updated_time = Time.now.utc
       @config_dict = Hash.new
       @disable_transaction_id = options['disable_transaction_id'] || false
       @log_body = options.fetch('log_body', true)
-      @sampling_percentage = get_config(nil)
-      if not @sampling_percentage.is_a? Numeric
-        raise "Sampling Percentage should be a number"
+      begin
+        if !@config.nil?
+          @config_etag, @sampling_percentage, @last_updated_time = @app_config.parse_configuration(@config, @debug)
+        end
+      rescue => exception
+        if @debug
+          puts 'Error while parsing application configuration on initialization'
+          puts exception.to_s
+        end
       end
       @capture_outoing_requests = options['capture_outoing_requests']
       if @capture_outoing_requests
@@ -42,35 +54,6 @@ module MoesifRack
       end
     end
 
-    def get_config(cached_config_etag)
-      sample_rate = 100
-      begin
-        # Calling the api
-        config_api_response = @api_controller.get_app_config()
-        # Fetch the response ETag
-        response_config_etag = JSON.parse( config_api_response.to_json )["headers"]["x_moesif_config_etag"]
-        # Remove ETag from the global dict if exist
-        if !cached_config_etag.nil? && @config_dict.key?(cached_config_etag)
-            @config_dict.delete(cached_config_etag)
-        end
-        # Fetch the response body
-        @config_dict[response_config_etag] = JSON.parse(JSON.parse( config_api_response.to_json )["raw_body"])
-        # 
-        app_config = @config_dict[response_config_etag]
-        # Fetch the sample rate
-        if !app_config.nil?
-          sample_rate = app_config.fetch("sample_rate", 100)
-        end
-        # Set the last updated time
-        @last_updated_time = Time.now.utc
-        rescue
-          # Set the last updated time
-          @last_updated_time = Time.now.utc
-      end
-      # Return the sample rate
-      return sample_rate
-    end
-
     def update_user(user_profile)
       UserHelper.new.update_user(@api_controller, @debug, user_profile)
     end
@@ -236,13 +219,28 @@ module MoesifRack
         # Perform the API call through the SDK function
         begin
           @random_percentage = Random.rand(0.00..100.00)
+
+          # Event UserId
+          user_id = !event_model.user_id.nil?  ? event_model.user_id : nil
+          # Event CompanyId
+          company_id = !event_model.company_id.nil?  ? event_model.company_id : nil
+          # Get sampling percentage
+          @sampling_percentage = @app_config.get_sampling_percentage(@config, user_id, company_id, @debug)
+
           if @sampling_percentage > @random_percentage
             event_api_response = @api_controller.create_event(event_model)
-            cached_config_etag = @config_dict.keys[0]
             event_response_config_etag = event_api_response[:x_moesif_config_etag]
 
-            if !event_response_config_etag.nil? && cached_config_etag != event_response_config_etag && Time.now.utc > @last_updated_time + 30
-              @sampling_percentage = get_config(cached_config_etag)
+            if !event_response_config_etag.nil? && !@config_etag.nil? && @config_etag != event_response_config_etag && Time.now.utc > @last_updated_time + 300
+              begin 
+                @config = @app_config.get_config(@api_controller, @debug)
+                @config_etag, @sampling_percentage, @last_updated_time = @app_config.parse_configuration(@config, @debug)
+              rescue => exception
+                if @debug
+                  puts 'Error while updating the application configuration'
+                  puts exception.to_s
+                end    
+              end
             end
             if @debug
               puts("Event successfully sent to Moesif")

data/test/moesif_rack_test.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'rack'
 require 'net/http'
+require_relative '../lib/moesif_rack/app_config.rb'
 require_relative '../lib/moesif_rack'
 
 class MoesifRackTest < Test::Unit::TestCase
@@ -45,6 +46,7 @@ class MoesifRackTest < Test::Unit::TestCase
     }
   }
     @moesif_rack_app = MoesifRack::MoesifMiddleware.new(@app, @options)
+    @app_config = AppConfig.new
   end
 
   def test_capture_outgoing
@@ -106,7 +108,11 @@ class MoesifRackTest < Test::Unit::TestCase
   end
 
   def test_get_config
-    assert_operator 100, :>=, @moesif_rack_app.get_config(nil)
+    @api_client = MoesifApi::MoesifAPIClient.new(@options['application_id'])
+    @api_controller = @api_client.api
+    @config = @app_config.get_config(@api_controller, @debug)
+    @config_etag, @sampling_percentage, @last_updated_time = @app_config.parse_configuration(@config, @debug)
+    assert_operator 100, :>=, @sampling_percentage
   end
 
   def test_update_company

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -48,6 +48,7 @@ files:
 - LICENSE
 - README.md
 - lib/moesif_rack.rb
+- lib/moesif_rack/app_config.rb
 - lib/moesif_rack/client_ip.rb
 - lib/moesif_rack/moesif_middleware.rb
 - lib/moesif_rack/update_company.rb
@@ -75,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: moesif_rack