moesif_rack 1.4.6 → 1.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4bc6206e2ea8335d66262ad33e0d6ea90a908e60
-  data.tar.gz: f64dedab2b3c2d34fd24a4106417a5610e2bf429
+SHA256:
+  metadata.gz: 2678540c8127f1b07cb8a1dac28bb681bc8b0816daa2f9d46d673c20967db417
+  data.tar.gz: 88d9fbe0dab363880469c208a9af2f205e6878b19798836f50e1ad6059e2c4e8
 SHA512:
-  metadata.gz: 31dfb4d45baec6e9aa896cb995ed811806b349faa27a79aad737d5974bc5123e43429fb6cae5db96cc5b5f569989d63cb98af26738e8907bf3ac88c965918261
-  data.tar.gz: f25cf1e4ddbbe87e37d8a58a0863d03dbe4e5e2111ae768395d1d2d8a4d58a162016d30f2fcb158e93f95409626be37608d73f76949795fbe583da931bce6afa
+  metadata.gz: 1407385871aa2466c1f74a8493628dd2d6614b8f25554cd676aeb302c7caa548bc554c5bedb2eeb856c099a7bd5475279db8b03bfd45886dfd2f37627dfa0359
+  data.tar.gz: 8d712814d497c179e02918ba66bd12ac8048866a6e19724cc192f2ab1c4ae77f14aa29d14766a9be26d398a81fc886ac6982b7065857255fe52e5edfd650e9ed

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")
@@ -153,12 +156,12 @@ module MoesifRack
     end
 
     def call env
-      start_time = Time.now.utc.iso8601
+      start_time = Time.now.utc.iso8601(3)
 
       @helpers.log_debug('Calling Moesif middleware')
 
       status, headers, body = @app.call env
-      end_time = Time.now.utc.iso8601
+      end_time = Time.now.utc.iso8601(3)
 
       process_send = lambda do
         req = Rack::Request.new(env)
@@ -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
 
@@ -341,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/adapters/net_http.rb

@@ -7,7 +7,7 @@ module Net
       def request(request, body = nil, &block)
 
         # Request Start Time
-        request_time = Time.now.utc.iso8601
+        request_time = Time.now.utc.iso8601(3)
         
         # URL
         url = "https://#{@address}#{request.path}"
@@ -16,7 +16,7 @@ module Net
         @response = orig_request(request, body, &block)
 
         # Response Time
-        response_time = Time.now.utc.iso8601
+        response_time = Time.now.utc.iso8601(3)
   
         # Log Event to Moesif
         if started?

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

data/test/moesif_rack_test.rb

@@ -46,7 +46,7 @@ class MoesifRackTest < Test::Unit::TestCase
     }
   }
     @moesif_rack_app = MoesifRack::MoesifMiddleware.new(@app, @options)
-    @app_config = AppConfig.new
+    @app_config = AppConfig.new(true)
   end
 
   def test_capture_outgoing
@@ -116,7 +116,7 @@ class MoesifRackTest < Test::Unit::TestCase
   def test_get_config
     @api_client = MoesifApi::MoesifAPIClient.new(@options['application_id'])
     @api_controller = @api_client.api
-    @config = @app_config.get_config(@api_controller, @debug)
+    @config = @app_config.get_config(@api_controller)
     @config_etag, @sampling_percentage, @last_updated_time = @app_config.parse_configuration(@config, @debug)
     assert_operator 100, :>=, @sampling_percentage
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.4.6
+  version: 1.4.11
 platform: ruby
 authors:
 - Moesif, Inc
 - Xing Wang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-09 00:00:00.000000000 Z
+date: 2021-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -81,7 +81,7 @@ metadata:
   mailing_list_uri: https://github.com/Moesif/moesif-rack
   source_code_uri: https://github.com/Moesif/moesif-rack
   wiki_uri: https://github.com/Moesif/moesif-rack
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: moesif_rack
 test_files: []