moesif_rack 1.3.3 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a597bcfb7083d6a0ac126dab64dee86b5dcb31ffcf0e018809768d4bd7e06ea3
-  data.tar.gz: cec0a5a1cb82abcb45314173b021534d02ab0a82d4111238a63e171343c7e4d4
+  metadata.gz: f7bb716388bcb7fda82c1f7cfc11530c01e9f0a9bbf6e4d84a171eae0cb75898
+  data.tar.gz: fb000cc8620126bc8031c678b89cd03c55bc0a32cd8c1c2889db84818261e6b0
 SHA512:
-  metadata.gz: 68de312a781cc558dd91a64db9be8510522b0d0241bd723989d2067c63882b0a5d1faecbb256dd843e122f475937cbf64b697ff85b496448aca460f1a6156fd3
-  data.tar.gz: 84aa2e7c2d95ba1474e6aeb71d72434d9401b52f372e59914eaaccfba96fde4268498f1cceb7393ab5a05b26d43944d1a75c8fa4e2138b1d6e40cd2e260b26f3
+  metadata.gz: 92511aab26e9a6f09d46fbdedbb2925aa0dc66cdd4537acaff8fe19d158dbbde9cc0531bd6374f544d3de448f32b8edad54d298824a9ee1ff8c0ce6687c7eb9c
+  data.tar.gz: 4d0e8d6ed2561a87ce9aa396a4510b66d91c186e409f44137bcaa3ef624298d1b8bf9195e62e837650ddf38e02eed07f41f91a2d18db73a973455b330903b66c

data/README.md

@@ -6,7 +6,9 @@
 [![Software License][ico-license]][link-license]
 [![Source Code][ico-source]][link-source]
 
-Rack Middleware that logs _incoming_ API calls to Moesif's AI-powered API analytics service.
+Rack Middleware that logs API calls and sends 
+to [Moesif](https://www.moesif.com) for API analytics and log analysis.
+
 Supports Ruby on Rails apps and other Ruby frameworks built on Rack.
 
 [Source Code on GitHub](https://github.com/moesif/moesif-rack)
@@ -20,7 +22,7 @@ gem install moesif_rack
 and if you have a `Gemfile` in your project, please add this line to
 
 ```
-gem 'moesif_rack', '~> 1.3.2'
+gem 'moesif_rack', '~> 1.3.8'
 
 ```
 
@@ -30,19 +32,40 @@ gem 'moesif_rack', '~> 1.3.2'
 
 ```ruby
 moesif_options = {
-  'application_id' => 'Your application Id'
+  'application_id' => 'Your Moesif Application Id',
+  'log_body' => true,
 }
 ```
 
-You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Top Right Menu_ -> _App Setup_
+Your Moesif Application Id can be found in the [_Moesif Portal_](https://www.moesif.com/).
+After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps. 
+
+You can always find your Moesif Application Id at any time by logging 
+into the [_Moesif Portal_](https://www.moesif.com/), click on the top right menu,
+and then clicking _Installation_.
 
 ### Add to middleware
 
-within `config/application.rb`
+Using strings or symbols for middleware class names is deprecated for newer frameworks like Ruby 5.0, 
+so you should pass the class directly.
+
+#### For Rails 5.0 or newer:
 
 ```ruby
+  class Application < Rails::Application
+    # snip
 
+    config.middleware.use MoesifRack::MoesifMiddleware, moesif_options
 
+    # snip
+  end
+```
+
+#### For other frameworks:
+
+within `config/application.rb`
+
+```ruby
   class Application < Rails::Application
     # snip
 
@@ -50,35 +73,37 @@ within `config/application.rb`
 
     # snip
   end
-
 ```
 
 #### Order of Middleware Matters
 
-Since Moesif Rack is basically a logging middleware, the ordering of middleware matters for accuracy and completeness.
-Many middlewares are installed by default by Rails.
-
-To see the list of middlewares that your system already have, type this into the bash.
-
-```bash
-  bin/rails middleware
-```
+Since Moesif Rack is a logging middleware, the ordering of middleware matters for accuracy and data collection.
+Many middleware are installed by default by Rails.
 
-The best place for "MoesifRack::MoesifMidleware" is on top as possible (so it captures the data closest to the wire).
+The best place for "MoesifRack::MoesifMidleware" is on top (so it captures the data closest to the wire).
 Typically, right above the default logger of Rails apps, "Rails::Rack::Logger" is a good spot.
 Or if you want to be as close as wire as possible, put it before "ActionDispatch::Static"
 
-You should use the following line of code to insert the middleware into the right spot.
+To insert the Moesif middleware before "Rails::Rack::Logger", you can use the `insert_before` method instead of 
+`use`
 
 ```ruby
+  class Application < Rails::Application
+    # snip
 
-config.middleware.insert_before "Rails::Rack::Logger", "MoesifRack::MoesifMiddleware", moesif_options
+    config.middleware.insert_before Rails::Rack::Logger, MoesifRack::MoesifMiddleware, moesif_options
 
+    # snip
+  end
 ```
+If you are using "Rack::Deflater" or other compression middleware, make sure Moesif is after
+it, so it can capture the uncompressed data.
 
-Please note, if you are using "Rack::Deflater" please make sure that "MoesifRack::MoesifMiddlware"
-is below it, so it can capture uncompressed data.
+To see your current list of middleware:
 
+```bash
+  bin/rails middleware
+```
 
 ## Configuration options
 
@@ -106,7 +131,7 @@ moesif_options['identify_user'] = Proc.new { |env, headers, body|
 
   #snip
 
-  'the_user_id'
+  'my_user_id'
 }
 
 ```
@@ -122,7 +147,7 @@ moesif_options['identify_company'] = Proc.new { |env, headers, body|
 
   #snip
 
-  'the_company_id'
+  'my_company_id'
 }
 
 ```
@@ -327,9 +352,14 @@ metadata = JSON.parse('{'\
       '"custom": "testdata"'\
     '}')
 
-user_model = { "user_id" => "testrubyapiuser", 
+campaign_model = {"utm_source" => "Newsletter",
+                  "utm_medium" => "Email"}
+
+user_model = { "user_id" => "12345",
+                "company_id" => "67890",
                 "modified_time" => Time.now.utc.iso8601, 
-                "metadata" => metadata }
+                "metadata" => metadata,
+                "campaign" => campaign_model }
 
 update_user = MoesifRack::MoesifMiddleware.new(@app, @options).update_user(user_model)
 ```
@@ -347,11 +377,13 @@ metadata = JSON.parse('{'\
 
 user_models = []
 
-user_model_A = { "user_id" => "testrubyapiuser", 
+user_model_A = { "user_id" => "12345",
+                "company_id" => "67890", 
                 "modified_time" => Time.now.utc.iso8601, 
                 "metadata" => metadata }
 
-user_model_B = { "user_id" => "testrubyapiuser1", 
+user_model_B = { "user_id" => "1234", 
+                "company_id" => "6789",
                 "modified_time" => Time.now.utc.iso8601, 
                 "metadata" => metadata }
 
@@ -372,9 +404,13 @@ metadata = JSON.parse('{'\
       '"custom": "testdata"'\
     '}')
 
-company_model = { "company_id" => "testrubyapicompany", 
+campaign_model = {"utm_source" => "Adwords",
+                  "utm_medium" => "Twitter"}
+
+company_model = { "company_id" => "12345", 
                   "company_domain" => "acmeinc.com",
-                "metadata" => metadata }
+                  "metadata" => metadata,
+                  "campaign" => campaign_model }
 
 update_company = MoesifRack::MoesifMiddleware.new(@app, @options).update_company(company_model)
 ```
@@ -392,11 +428,11 @@ metadata = JSON.parse('{'\
 
 company_models = []
 
-company_model_A = { "company_id" => "testrubyapicompany",
+company_model_A = { "company_id" => "12345",
                     "company_domain" => "nowhere.com", 
                 "metadata" => metadata }
 
-company_model_B = { "company_id" => "testrubyapicompany1",
+company_model_B = { "company_id" => "67890",
                     "company_domain" => "acmeinc.com",
                 "metadata" => metadata }
 
@@ -415,7 +451,9 @@ response = MoesifRack::MoesifMiddleware.new(@app, @options).update_companies_bat
 
 ## Example Code
 
-[Moesif Rack Example](https://github.com/Moesif/moesif-rack-example) is an example of Moesif Rack applied to an Rail application. Please check it out for reference.
+[Moesif Rack Example with Rails](https://github.com/Moesif/moesif-rails-example) is an example of Moesif Rack applied to a Rails application.
+
+[Moesif Rack Example](https://github.com/Moesif/moesif-rack-example) is an example of Moesif Rack applied to a Rack application.
 
 ## Other integrations
 

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,31 @@ module MoesifRack
         # 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, @debug)
+          rescue => exception
+            if @debug
+              puts 'Error while getting sampling percentage, assuming default behavior'
+              puts exception.to_s
+            end
+            @sampling_percentage = 100
+          end
+
           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")
@@ -285,7 +286,7 @@ module MoesifRack
 
     def get_response_body(response)
       body = response.respond_to?(:body) ? response.body : response
-      body = body.inject("") { |i, a| i << a } if body.respond_to?(:each)
+      body = body.inject("") { |i, a| i << a } if (body.respond_to?(:each) && body.respond_to?(:inject))
       body.to_s
     end
 

data/test/moesif_rack_test.rb

@@ -1,12 +1,13 @@
 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
   def setup
     @app = ->(env) { [200, { "Content-Type" => "application/json" }, ["{ \"key\": \"value\"}"]]}
-    @options = { 'application_id' => 'Your Application Id',
+    @options = { 'application_id' => 'Your Moesif Application Id',
     'debug' => true,
     'disable_transaction_id' => true,
     'capture_outoing_requests' => true,
@@ -26,7 +27,7 @@ class MoesifRackTest < Test::Unit::TestCase
       'my_user_id'
     },
     'identify_company' => Proc.new{|request, response|
-      '12345'
+      'my_company_id'
     },
     'identify_user_outgoing' => Proc.new{|request, response|
       'outgoing_user_id'
@@ -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
@@ -67,9 +69,14 @@ class MoesifRackTest < Test::Unit::TestCase
       '"custom": "testdata"'\
     '}')
 
-    user_model = { "user_id" => "testrubyapiuser", 
+    campaign_model = {"utm_source" => "Newsletter",
+                      "utm_medium" => "Email"}
+
+    user_model = { "user_id" => "12345", 
+                   "company_id" => "67890",
                    "modified_time" => Time.now.utc.iso8601, 
-                   "metadata" => metadata }
+                   "metadata" => metadata,
+                   "campaign" => campaign_model}
 
     response = @moesif_rack_app.update_user(user_model)
     assert_equal response, nil
@@ -84,11 +91,13 @@ class MoesifRackTest < Test::Unit::TestCase
 
     user_models = []
 
-    user_model_A = { "user_id" => "testrubyapiuser", 
+    user_model_A = { "user_id" => "12345", 
+                   "company_id" => "67890",
                    "modified_time" => Time.now.utc.iso8601, 
                    "metadata" => metadata }
     
-    user_model_B = { "user_id" => "testrubyapiuser1", 
+    user_model_B = { "user_id" => "1234",
+                    "company_id" => "6789", 
                     "modified_time" => Time.now.utc.iso8601, 
                     "metadata" => metadata }
 
@@ -103,7 +112,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
@@ -113,9 +126,13 @@ class MoesifRackTest < Test::Unit::TestCase
       '"custom": "testdata"'\
     '}')
 
-    company_model = { "company_id" => "testrubyapicompany", 
+    campaign_model = {"utm_source" => "Adwords",
+                      "utm_medium" => "Twitter"}
+
+    company_model = { "company_id" => "12345", 
                       "company_domain" => "acmeinc.com", 
-                   "metadata" => metadata }
+                      "metadata" => metadata,
+                      "campaign" => campaign_model }
 
     response = @moesif_rack_app.update_company(company_model)
     assert_equal response, nil
@@ -130,11 +147,11 @@ class MoesifRackTest < Test::Unit::TestCase
 
     company_models = []
 
-    company_model_A = { "company_id" => "testrubyapicompany",
+    company_model_A = { "company_id" => "12345",
                         "company_domain" => "nowhere.com", 
                    "metadata" => metadata }
     
-    company_model_B = { "company_id" => "testrubyapicompany1",
+    company_model_B = { "company_id" => "1234",
                         "company_domain" => "acmeinc.com", 
                     "metadata" => metadata }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.8
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.9
 description: Collection/Data Ingestion SDK for Rack (also Rails) Middleware / RoR
 email: xing@moesif.com
 executables: []
@@ -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