moesif_rack 1.4.5 → 1.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2366969ea63a6f2aeeb37498dc5bbfad99d4ea43753085237af1326689050cc4
-  data.tar.gz: 2ac98efe04dc86f79db515805ed5f45e7beff707c87c82e42fc7adc2eacbc883
+  metadata.gz: e9862b7c7e3a113f37599bff78bf6fbca9bd1edd439dac103f26ec54354dc862
+  data.tar.gz: 507fe6d85365f8588063e656d3085e34c8b6b7b5a9e17ec7b993dc8f31af60ac
 SHA512:
-  metadata.gz: f18420e49b9dbd3f6d8a1cba791a4c235a06d3568e8ed47d5be9059e93b09acdd6a71a7a7382f500daafe1d5d1b6dd3c3eb87b7d99612db042a41a3a881eb65c
-  data.tar.gz: a1a3174c9e701e6ccd809ee0ea113878ca53b0ed8194ca612ba5491f0aaa9aa2761e3b586b3acaf23f6317244700111026e6ae9ce84f212a87dd4a25bdda7619
+  metadata.gz: ef060aca2101ec875908456975537dba773fbbf4d721ed0a0797c0a03c23604e750a98fff8ec4d9b836b4aba6ba5b090ffa4aed1866d25ef0d49d36d5cad94fd
+  data.tar.gz: c7a845885a3fc2171e904e08c05f553b025037e72027e9dfea2c52a2b186266ea93d26ce51d091f14a9d514c8afe084e3dddab5886d7d70400669418a083cba8

data/README.md

@@ -7,33 +7,37 @@
 [![Source Code][ico-source]][link-source]
 
 Rack Middleware that logs API calls and sends 
-to [Moesif](https://www.moesif.com) for API analytics and log analysis.
+to [Moesif](https://www.moesif.com) for API analytics and monitoring.
 
-Supports Ruby on Rails apps and other Ruby frameworks built on Rack.
+Supports Ruby on Rails, Grape, and other Ruby frameworks built on Rack.
 
 [Source Code on GitHub](https://github.com/moesif/moesif-rack)
 
 ## How to install
 
+Install the Moesif gem. 
+
 ```bash
 gem install moesif_rack
 ```
 
-and if you have a `Gemfile` in your project, please add this line to
+If you're using Bundler, add the gem to your `Gemfile`.
 
-```
+```ruby
 gem 'moesif_rack'
-
 ```
 
+Then, run `bundle install`
+
 ## How to use
 
-### Create the options
+### 1. Enter Moesif Application Id
+
+Create an options hash containing application_id and any other options.
 
 ```ruby
 moesif_options = {
-  'application_id' => 'Your Moesif Application Id',
-  'log_body' => true,
+  'application_id' => 'Your Moesif Application Id'
 }
 ```
 
@@ -44,43 +48,67 @@ 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
+### 2. Add the middleware
+
+#### For Rails 5.0 or newer:
 
 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
+    moesif_options = {
+      'application_id' => 'Your Moesif Application Id'
+    }
 
     config.middleware.use MoesifRack::MoesifMiddleware, moesif_options
-
-    # snip
   end
 ```
 
-#### For other frameworks:
+#### For Rails 4.0 and other frameworks:
+
+For most rack-based frameworks including Rails 4.x or older, add the middleware `MoesifRack::MoesifMiddleware`.
 
 within `config/application.rb`
 
 ```ruby
   class Application < Rails::Application
-    # snip
+    moesif_options = {
+      'application_id' => 'Your Moesif Application Id'
+    }
 
     config.middleware.use "MoesifRack::MoesifMiddleware", moesif_options
+  end
+```
 
-    # snip
+#### For Grape API:
+
+For [Grape APIs](https://github.com/ruby-grape/grape), we can add the middleware after any custom parsers or formatters.
+
+```ruby
+module Acme
+  class Ping < Grape::API
+    format :json
+
+    moesif_options = {
+      'application_id' => 'Your Moesif Application Id'
+    }
+
+    insert_after Grape::Middleware::Formatter, MoesifRack::MoesifMiddleware, moesif_options
+
+    get '/ping' do
+      { ping: 'pong' }
+    end
   end
+end
 ```
 
 #### Order of Middleware Matters
 
-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.
+Since Moesif Rack is a logging middleware, the ordering of middleware matters.
+The best place for "MoesifRack::MoesifMidleware" is near the top (so it captures the data closest to the wire), but after 
+any body parsers or authentication  middleware.
 
-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"
 
@@ -107,7 +135,7 @@ To see your current list of middleware:
 
 ## Configuration options
 
-The options is a hash with these possible key value pairs.
+Options is a hash with these possible key/value pairs.
 
 #### __`application_id`__
 
@@ -206,7 +234,12 @@ Optional. A Proc that takes env, headers, body and returns a boolean.
 
 moesif_options['skip'] = Proc.new { |env, headers, body|
   # Add your custom code that returns true to skip logging the API call
-  false
+  if env.key?("REQUEST_URI") 
+      # Skip probes to health page
+      env["REQUEST_URI"].include? "/health"
+  else
+      false
+  end
 }
 
 ```

data/lib/moesif_rack/client_ip.rb

@@ -2,10 +2,8 @@
 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*$/
-    if 
-        # We use !! to convert the return value to a boolean
-        !!(value =~ ipv4 or value=~ ipv6)
-    end
+    # 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)

data/lib/moesif_rack/moesif_middleware.rb

@@ -102,7 +102,10 @@ module MoesifRack
 
     def parse_body(body, headers)
       begin
-        if start_with_json(body)
+        if (body.instance_of?(Hash) || body.instance_of?(Array))
+          parsed_body = body
+          transfer_encoding = 'json'
+        elsif start_with_json(body)
           parsed_body = JSON.parse(body)
           transfer_encoding = 'json'
         elsif headers.key?('content-encoding') && ((headers['content-encoding'].downcase).include? "gzip")
@@ -293,7 +296,7 @@ module MoesifRack
             # Add Event to the queue
             @events_queue << event_model
             @helpers.log_debug("Event added to the queue ")
-            if Time.now.utc > (@last_config_download_time + 60)
+            if Time.now.utc > (@last_worker_run + 60)
               start_worker()
             end
 
@@ -328,7 +331,12 @@ module MoesifRack
       end
 
       if !should_skip
-        process_send.call
+        begin 
+          process_send.call
+        rescue => exception
+          @helpers.log_debug 'Error while logging event - '
+          @helpers.log_debug exception.to_s
+        end
       end
 
       [status, headers, body]
@@ -336,6 +344,9 @@ module MoesifRack
 
     def get_response_body(response)
       body = response.respond_to?(:body) ? response.body : response
+      if (body.instance_of?(Hash) || body.instance_of?(Array))
+        return body
+      end
       body = body.inject("") { |i, a| i << a } if (body.respond_to?(:each) && body.respond_to?(:inject))
       body.to_s
     end

data/moesif_capture_outgoing/httplog/http_log.rb

@@ -24,15 +24,15 @@ module MoesifCaptureOutgoing
       @skip_outgoing = options['skip_outgoing']
       @mask_data_outgoing = options['mask_data_outgoing']
       @log_body_outgoing = options.fetch('log_body_outgoing', true)
-      @app_config = AppConfig.new
-      @config = @app_config.get_config(@api_controller, @debug)
+      @app_config = AppConfig.new(@debug)
       @config_etag = nil
       @sampling_percentage = 100
       @last_updated_time = Time.now.utc
       @config_dict = Hash.new
       begin
-        if !@config.nil?
-          @config_etag, @sampling_percentage, @last_updated_time = @app_config.parse_configuration(@config, @debug)
+        new_config = @app_config.get_config(@api_controller)
+        if !new_config.nil?
+          @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
         end
       rescue => exception
         if @debug
@@ -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, @debug)
+              @sampling_percentage = @app_config.get_sampling_percentage(@config, event_model.user_id, event_model.company_id)
             rescue => exception
               if @debug
                 puts 'Error while getting sampling percentage, assuming default behavior'
@@ -196,8 +196,10 @@ module MoesifCaptureOutgoing
 
               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)
+                  new_config = @app_config.get_config(@api_controller)
+                  if !new_config.nil?
+                    @config, @config_etag, @last_config_download_time = @app_config.parse_configuration(new_config)
+                  end
                 rescue => exception
                   if @debug
                     puts 'Error while updating the application configuration'
@@ -222,7 +224,7 @@ module MoesifCaptureOutgoing
               puts e.response_code
             end
           rescue => e
-            if debug
+            if @debug
                 puts e.to_s
             end
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.4.5
+  version: 1.4.10
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,10 +9,9 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2021-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -21,8 +20,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.5
-  type: :development
+  name: test-unit
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -32,7 +32,6 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.5
 - !ruby/object:Gem::Dependency
-  name: moesif_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -41,8 +40,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.12
-  type: :runtime
+  name: moesif_api
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -96,7 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubyforge_project:
+rubygems_version: 2.7.10
 signing_key:
 specification_version: 4
 summary: moesif_rack