moesif_rack 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45a13b3f4b85664a0147ef4abe30bd73f1b11d21a96ce30b21d32f15185217e6
-  data.tar.gz: 02c92b07b397124108dd0eba645b830b9da5b222a4058e9048c8b7bc380b6dd9
+  metadata.gz: c829d3004e26c40536debc186d0c45a8a3cf08d854c75f0cf76dce20d142e951
+  data.tar.gz: ac8c4d6c2c66dae5348b7421128fdd6b5ce0b2c9a48e1712aa632817f2ade291
 SHA512:
-  metadata.gz: ccf6066387ea409cc74f7910bae06a33f2419442ddeba773b29329888e78ca61cd5ee8934168f2e38ea4ebc43fe58dbea8680716de3517d8d2a555ac52a690f7
-  data.tar.gz: a53a8a807d6f4e2c244e9466743e9fbe2d8949d462a50cc9d82d85fbff6c1b89c852ddb088c4ca74042e3f3775ddbdfdf9955762341943821053aabe95e094af
+  metadata.gz: 7f10f8c2e8c4cb8af3d55a4d5aee69626ddb893405ba866578af506834516848b5367f5361a07ca5eb6acb3adccae2a8429432d8792cfb197391b42db310dab6
+  data.tar.gz: 3ee6984671ab33f20dcf4b6b640935e315cc84c68e39bb9093b77a9e632aa3683e0e213d197140baa93f76f14809e0d19f701710900f0edc1e9575182121c27f

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.2.6'
+gem 'moesif_rack', '~> 1.3.4'
 
 ```
 
@@ -30,19 +32,40 @@ gem 'moesif_rack', '~> 1.2.6'
 
 ```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.
+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.
 
-```bash
-  bin/rails middleware
-```
-
-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,23 @@ moesif_options['identify_user'] = Proc.new { |env, headers, body|
 
   #snip
 
-  'the_user_id'
+  'my_user_id'
+}
+
+```
+
+#### __`identify_company`__
+
+Optional.
+identify_company is a Proc that takes env, headers, and body as arguments and returns a company_id string. This helps us attribute requests to unique company.
+
+```ruby
+
+moesif_options['identify_company'] = Proc.new { |env, headers, body|
+
+  #snip
+
+  'my_company_id'
 }
 
 ```
@@ -187,6 +228,10 @@ For details for the spec of event model, please see the [Moesif Ruby API Documen
 
 Optional. Boolean. Default false. If true, it will print out debug messages. In debug mode, the processing is not done in backend thread.
 
+#### __`log_body`__
+
+Optional. Boolean. Default true. If false, will not log request and response body to Moesif.
+
 #### __`capture_outoing_requests`__
 Optional. boolean, Default `false`. Set to `true` to capture all outgoing API calls from your app to third parties like Stripe, Github or to your own dependencies while using [Net::HTTP](https://ruby-doc.org/stdlib-2.6.3/libdoc/net/http/rdoc/Net/HTTP.html) package. The options below is applied to outgoing API calls. When the request is outgoing, for options functions that take request and response as input arguments, the request and response objects passed in are [Request](https://www.rubydoc.info/stdlib/net/Net/HTTPRequest) request and [Response](https://www.rubydoc.info/stdlib/net/Net/HTTPResponse) response objects.
 
@@ -207,6 +252,22 @@ moesif_options['identify_user_outgoing'] = Proc.new { |request, response|
 
 ```
 
+##### __`identify_company_outgoing`__
+
+Optional.
+identify_company_outgoing is a Proc that takes request and response as arguments and returns a company_id string. This helps us attribute requests to unique company.
+
+```ruby
+
+moesif_options['identify_company_outgoing'] = Proc.new { |request, response|
+
+  #snip
+
+  'the_company_id'
+}
+
+```
+
 ##### __`get_metadata_outgoing`__
 
 Optional.
@@ -274,6 +335,10 @@ moesif_options['mask_data_outgoing'] = Proc.new { |event_model|
 
 ```
 
+#### __`log_body_outgoing`__
+
+Optional. Boolean. Default true. If false, will not log request and response body to Moesif.
+
 ## Update User
 
 ### update_user method
@@ -287,7 +352,8 @@ metadata = JSON.parse('{'\
       '"custom": "testdata"'\
     '}')
 
-user_model = { "user_id" => "testrubyapiuser", 
+user_model = { "user_id" => "12345",
+                "company_id" => "67890",
                 "modified_time" => Time.now.utc.iso8601, 
                 "metadata" => metadata }
 
@@ -307,11 +373,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 }
 
@@ -332,7 +400,8 @@ metadata = JSON.parse('{'\
       '"custom": "testdata"'\
     '}')
 
-company_model = { "company_id" => "testrubyapicompany", 
+company_model = { "company_id" => "12345", 
+                  "company_domain" => "acmeinc.com",
                 "metadata" => metadata }
 
 update_company = MoesifRack::MoesifMiddleware.new(@app, @options).update_company(company_model)
@@ -351,10 +420,12 @@ 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 }
 
 company_models << company_model_A << company_model_B

data/lib/moesif_rack/moesif_middleware.rb

@@ -19,6 +19,7 @@ module MoesifRack
 
       @api_version = options['api_version']
       @identify_user = options['identify_user']
+      @identify_company = options['identify_company']
       @get_metadata = options['get_metadata']
       @identify_session = options['identify_session']
       @mask_data = options['mask_data']
@@ -26,6 +27,7 @@ module MoesifRack
       @debug = options['debug']
       @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"
@@ -109,13 +111,16 @@ module MoesifRack
         req_body_string = req.body.read
         req.body.rewind
         req_body_transfer_encoding = nil
-
-        if req_body_string && req_body_string.length != 0
-          begin
-            req_body = JSON.parse(req_body_string)
-          rescue
-            req_body = Base64.encode64(req_body_string)
-            req_body_transfer_encoding = 'base64'
+        req_body = nil
+
+        if @log_body
+          if req_body_string && req_body_string.length != 0
+            begin
+              req_body = JSON.parse(req_body_string)
+            rescue
+              req_body = Base64.encode64(req_body_string)
+              req_body_transfer_encoding = 'base64'
+            end
           end
         end
 
@@ -123,13 +128,16 @@ module MoesifRack
 
         rsp_body_string = get_response_body(body);
         rsp_body_transfer_encoding = nil
-
-        if rsp_body_string && rsp_body_string.length != 0
-          begin
-            rsp_body = JSON.parse(rsp_body_string)
-          rescue
-            rsp_body = Base64.encode64(rsp_body_string)
-            rsp_body_transfer_encoding = 'base64'
+        rsp_body = nil
+
+        if @log_body
+          if rsp_body_string && rsp_body_string.length != 0
+            begin
+              rsp_body = JSON.parse(rsp_body_string)
+            rescue
+              rsp_body = Base64.encode64(rsp_body_string)
+              rsp_body_transfer_encoding = 'base64'
+            end
           end
         end
 
@@ -194,6 +202,13 @@ module MoesifRack
           event_model.user_id = @identify_user.call(env, headers, body)
         end
 
+        if @identify_company
+          if @debug
+            puts "calling identify company proc"
+          end
+          event_model.company_id = @identify_company.call(env, headers, body)
+        end
+
         if @get_metadata
           if @debug
             puts "calling get_metadata proc"
@@ -270,7 +285,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/moesif_capture_outgoing/httplog/http_log.rb

@@ -18,9 +18,11 @@ module MoesifCaptureOutgoing
       @debug = @moesif_options['debug']
       @get_metadata_outgoing = @moesif_options['get_metadata_outgoing']
       @identify_user_outgoing = @moesif_options['identify_user_outgoing']
+      @identify_company_outgoing = @moesif_options['identify_company_outgoing']
       @identify_session_outgoing = @moesif_options['identify_session_outgoing']
       @skip_outgoing = options['skip_outgoing']
       @mask_data_outgoing = options['mask_data_outgoing']
+      @log_body_outgoing = options.fetch('log_body_outgoing', true)
     end
 
     def call (url, request, request_time, response, response_time)
@@ -49,25 +51,32 @@ module MoesifCaptureOutgoing
         # Request Body
         req_body_string = request.body.nil? || request.body.empty? ? nil : request.body
         req_body_transfer_encoding = nil
-        if req_body_string && req_body_string.length != 0
-          begin
-            req_body = JSON.parse(req_body_string)
-          rescue
-            req_body = Base64.encode64(req_body_string)
-            req_body_transfer_encoding = 'base64'
+        req_body = nil
+
+        if @log_body_outgoing
+          if req_body_string && req_body_string.length != 0
+            begin
+              req_body = JSON.parse(req_body_string)
+            rescue
+              req_body = Base64.encode64(req_body_string)
+              req_body_transfer_encoding = 'base64'
+            end
           end
         end
 
         # Response Body and encoding
         rsp_body_string = get_response_body(response.body)
         rsp_body_transfer_encoding = nil
-
-        if rsp_body_string && rsp_body_string.length != 0
-          begin
-            rsp_body = JSON.parse(rsp_body_string)
-          rescue
-            rsp_body = Base64.encode64(rsp_body_string)
-            rsp_body_transfer_encoding = 'base64'
+        rsp_body = nil
+
+        if @log_body_outgoing
+          if rsp_body_string && rsp_body_string.length != 0
+            begin
+              rsp_body = JSON.parse(rsp_body_string)
+            rescue
+              rsp_body = Base64.encode64(rsp_body_string)
+              rsp_body_transfer_encoding = 'base64'
+            end
           end
         end
 
@@ -78,7 +87,7 @@ module MoesifCaptureOutgoing
         event_req.verb = request.method.to_s.upcase
         event_req.headers = request.each_header.collect.to_h
         event_req.api_version = nil
-        event_req.body = req_body_string
+        event_req.body = req_body
         event_req.transfer_encoding = req_body_transfer_encoding
 
         # Event Response 
@@ -86,7 +95,7 @@ module MoesifCaptureOutgoing
         event_rsp.time = response_time
         event_rsp.status = response.code.to_i
         event_rsp.headers = response.each_header.collect.to_h
-        event_rsp.body = rsp_body_string
+        event_rsp.body = rsp_body
         event_rsp.transfer_encoding = rsp_body_transfer_encoding
 
         # Prepare Event Model
@@ -110,6 +119,14 @@ module MoesifCaptureOutgoing
           event_model.user_id = @identify_user_outgoing.call(request, response)
         end
 
+        # Identify Company
+        if @identify_company_outgoing
+          if @debug
+            puts "calling identify_company_outgoing proc"
+          end
+          event_model.company_id = @identify_company_outgoing.call(request, response)
+        end
+
         # Session Token
         if @identify_session_outgoing
           if @debug

data/test/moesif_rack_test.rb

@@ -6,18 +6,33 @@ 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,
+    'get_metadata' => Proc.new {|request, response|
+      {
+        'foo'  => 'abc',
+        'bar'  => '123'
+      }
+    },
     'get_metadata_outgoing' => Proc.new {|request, response|
       {
         'foo'  => 'abc',
         'bar'  => '123'
       }
     },
+    'identify_user' => Proc.new{|request, response|
+      'my_user_id'
+    },
+    'identify_company' => Proc.new{|request, response|
+      'my_company_id'
+    },
     'identify_user_outgoing' => Proc.new{|request, response|
-      'outgoing_user'
+      'outgoing_user_id'
+    },
+    'identify_company_outgoing' => Proc.new{|request, response|
+      'outgoing_company_id'
     },
     'identify_session_outgoing' => Proc.new{|request, response|
       'outgoing_session'
@@ -52,7 +67,8 @@ class MoesifRackTest < Test::Unit::TestCase
       '"custom": "testdata"'\
     '}')
 
-    user_model = { "user_id" => "testrubyapiuser", 
+    user_model = { "user_id" => "12345", 
+                   "company_id" => "67890",
                    "modified_time" => Time.now.utc.iso8601, 
                    "metadata" => metadata }
 
@@ -69,11 +85,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 }
 
@@ -98,7 +116,8 @@ class MoesifRackTest < Test::Unit::TestCase
       '"custom": "testdata"'\
     '}')
 
-    company_model = { "company_id" => "testrubyapicompany", 
+    company_model = { "company_id" => "12345", 
+                      "company_domain" => "acmeinc.com", 
                    "metadata" => metadata }
 
     response = @moesif_rack_app.update_company(company_model)
@@ -114,10 +133,12 @@ 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 }
 
     company_models << company_model_A << company_model_B

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-10-11 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.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.7
+        version: 1.2.8
 description: Collection/Data Ingestion SDK for Rack (also Rails) Middleware / RoR
 email: xing@moesif.com
 executables: []
@@ -75,7 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: moesif_rack