moesif_rack 1.4.7 → 1.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4433b35813e25a0c20462510ff87fb2bb9849dff3edce0c5857884e1535dadb7
-  data.tar.gz: 9710968ac3ddfb6cb075e9d0ab5403d93a2e9b7830f5abb1da434ae7e11f907c
+  metadata.gz: 6c83ae80cf118c921a212121b0be6af3720b5cd9b0d0e83c6665828f4e542f10
+  data.tar.gz: 0a709decc75d43649da2e1305cd6370e44cbf8cb78b5c931e7df3afb894845c6
 SHA512:
-  metadata.gz: f3139d61e5b5e086e6543e40dd09ac9e2c4703f92b611ade3525a559589a9b7070afef1421c92da4ef39a653814c5c0b306dc818c43092c11352b933b74ee19f
-  data.tar.gz: 83529f4a1bebb1e28a096fd43897e3ebd5357892d64961da7208ba1d0862ddad3ca6f1baaaff5384b0003a25dabc220958fa2a5ccec80905f2e5e87e3b87a774
+  metadata.gz: 703794d208c4cceb7bcefa28e43fa7ae3c2e624569dbf6d8bf6697e70d3235d89e073f9b0c568967d0b7640b6b60650ba9d9bb2f3fa3277affae6ef75a6193b2
+  data.tar.gz: f95e69f49e07f89312c3e7d1c25347e35fd621f064cdf604fbd50f1159b73d3ade37098cfd13e2fead7d8110ebb3d74c11400701b66a0df6ce18e2f8fa058b6f

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`__
 

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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.4.8
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,10 +9,9 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-22 00:00:00.000000000 Z
+date: 2021-03-11 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