moesif_rack 1.4.4 → 1.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c44fb915ecec7479c930ab41b3b74eeb58a368f387d3fa8d47211e41c4a0c80
-  data.tar.gz: 6974bb001d57faeffc0f58df1a4c4661ac52d4a6f5280d78c1e35c7deb5fb183
+  metadata.gz: 91724c174f328bf7a8a4b988ee09b3d18438c043a1a64d321d779b21956f6be3
+  data.tar.gz: d5e702b86d078fd0655c13d2fc570e9403c91a6014f5c9c7f7705e2d22e4d1fd
 SHA512:
-  metadata.gz: '08b7997c9a683384cc7725dff3248a41b5ddb15974be2d259d9553fb1903075814260e8df0cda6a7d1e6340b7d8d27d3c99f725f0dd088caaae28476539f162c'
-  data.tar.gz: c0d75f0f8ab0f8d87d4a86fa4396e4100a94d7a0f37190260bbbe3db91ec40dcaa91f4d1d945f768a1fd0483dde2a816eb388a7e9cfd5fd89c4df33881104639
+  metadata.gz: a94ea5d908d57e8e148c126212d9470b17f4ceff266c3bdf3b02950517e5b77a4e544128ca7f7cfdbe01c12c975fdedad6694947a77d1e274e9bf301a3ca6f58
+  data.tar.gz: 829537f2b578b9b3f555cd4d3988f3799db3bd0d4ed11e6b98f49bffbaa4d7e557e88030f523622784546348b1b5151819148e52d20870bfb33bb0fe5d96c013

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'
 ```
-gem 'moesif_rack', '~> 1.4.2'
 
-```
+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
 }
 
 ```
@@ -500,11 +533,11 @@ response = MoesifRack::MoesifMiddleware.new(@app, @options).update_companies_bat
 5. Invoke 'ruby test/moesif_rack_test.rb'
 6. Invoke 'ruby -I test test/moesif_rack_test.rb -n test_capture_outgoing' to test capturing outgoing API calls from your app to third parties like Stripe, Github or to your own dependencies.
 
-## Example Code
-
-[Moesif Rack Example with Rails](https://github.com/Moesif/moesif-rails-example) is an example of Moesif Rack applied to a Rails application.
+## Example Projects
 
-[Moesif Rack Example](https://github.com/Moesif/moesif-rack-example) is an example of Moesif Rack applied to a Rack application.
+- [Moesif Rails 5 Example](https://github.com/Moesif/moesif-rails5-example) is an example of Moesif with a Ruby on Rails 5 application.
+- [Moesif Rails 4 Example](https://github.com/Moesif/moesif-rails4-example) is an example of Moesif with a Ruby on Rails 4 application.
+- [Moesif Rack Example](https://github.com/Moesif/moesif-rack-example) is an example of Moesif applied to a Rack application.
 
 ## Other integrations
 

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.4.9
 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-01 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:
     - - "~>"
@@ -73,7 +73,14 @@ files:
 homepage: https://moesif.com
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/Moesif/moesif-rack/issues
+  changelog_uri: https://github.com/Moesif/moesif-rack/releases
+  documentation_uri: https://www.moesif.com/docs/server-integration/rack/
+  homepage_uri: https://www.moesif.com
+  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:
 rdoc_options: []
 require_paths:
@@ -90,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.7.7
+rubygems_version: 2.7.10
 signing_key:
 specification_version: 4
 summary: moesif_rack