moesif_rack 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f51cfc0456d2c898d431068cd68005dc755fcca2
-  data.tar.gz: 43fb1009abcf3c9a9f505cc6278a974c6c5c0a17
+  metadata.gz: 5ed5bc8ec291e937b9bcb0bcf51718eb50bb52e9
+  data.tar.gz: b1a58fcde2a75a2e66c98b880d7c11950c19ff38
 SHA512:
-  metadata.gz: 61d38475fcfa488153cab0726cdfc776d459cfc67709b66f12644d279db370abe124f2157e4d687e8512a1c03ffaf76d5854ff0752632b09b318937d81d2f1cb
-  data.tar.gz: 30111231d1298b6e99ed2cdd07c44d77c0727f381b42b5fe9eabd678f3f3a4cbe4986a3dfe26d2bb83ec6a34b3138636261c307f2b3bbb4474d5afbe45c659d9
+  metadata.gz: 78a04e6c691d1159e4663d40fbc56f1567c762ea850e3e36d6bd67996b361801bc8ab26556a1279d66f32497034d5f0be0ed1287ace7790bf521f901a8a1d5c6
+  data.tar.gz: 55cc196b84495efa264e3ade047ebe4ada5c1628cfebd1e2d14a7e01d53ea9aa86c87a3a8ae50257b82e26c2b5102104a936132efccfda8319d7ef7893ca5851

data/README.md

@@ -1,23 +1,27 @@
-Moesif Middleware for Ruby on Rails and Rack
-=============================================
+# Moesif Middleware for Ruby on Rails and Rack
 
-Middleware that logs APIs built on Ruby on Rails and Rack.
+Rack Middleware that logs _incoming_ API calls to Moesif for advanced error analysis for apps built on Ruby on Rails / Rack.
 
 [Source Code on GitHub](https://github.com/moesif/moesif-rack)
 
-__Check out Moesif's
-[Ruby developer documentation](https://www.moesif.com/developer-documentation/?ruby) to learn more__
+[Ruby Gem](https://rubygems.org/gems/moesif_rack)
 
-Install from RubyGems
-=====================
+## How to install
 
 ```bash
 gem install moesif_rack
 ```
-How to use:
-===========
 
-Create the options
+and if you have a `Gemfile` in your project, please add this line to
+
+```
+gem 'moesif_rack', '~> 1.1.0'
+
+```
+
+## How to use
+
+### Create the options
 
 ```ruby
 moesif_options = {
@@ -25,8 +29,9 @@ moesif_options = {
 }
 ```
 
-Add to Middleware
+You can find your Application Id from [_Moesif Dashboard_](https://www.moesif.com/) -> _Top Right Menu_ -> _App Setup_
 
+### Add to middleware
 
 within `config/application.rb`
 
@@ -43,24 +48,44 @@ within `config/application.rb`
 
 ```
 
+#### Order of Middleware Matters
+
+Since Moesif Rack is basically a logging middleware, the ordering of middleware matters for accuracy and completeness.
+Many middleware are installed by default by rails.
+
+To see the list of the middleware that your system already have, type this into the bash.
+
+```bash
+  bin/rails middleware
+```
+
+The best place for MoesifMidleware is on top as possible (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.
+
+You should use the following line of code to insert the middleware into the right spot.
+
+```ruby
+
+config.middleware.insert_before "Rails::Rack::Logger", "MoesifRack::MoesifMiddleware", moesif_options
 
-How to configure:
-=================
+```
 
-options is a hash with these possible key value pairs.
+## Configuration options
 
-#### application_id
+The options is a hash with these possible key value pairs.
+
+#### __`application_id`__
 
 Required. String. This is the Moesif application_id under settings
 from your [Moesif account.](https://www.moesif.com)
 
 
-#### api_version
+#### __`api_version`__
 
 Optional. String. Tag requests with the version of your API.
 
 
-#### identify_user
+#### __`identify_user`__
 
 Optional.
 identify_user is a Proc that takes env, headers, and body as arguments and returns a user_id string. This helps us attribute requests to unique users. Even though Moesif can automatically retrieve the user_id without this, this is highly recommended to ensure accurate attribution.
@@ -76,7 +101,7 @@ moesif_options['identify_user'] = Proc.new { |env, headers, body|
 
 ```
 
-#### identify_session
+#### __`identify_session`__
 
 Optional. A Proc that takes env, headers, body and returns a string.
 
@@ -91,7 +116,7 @@ moesif_options['identify_session'] = Proc.new { |env, headers, body|
 
 ```
 
-#### mask_data
+#### __`mask_data`__
 
 Optional. A Proc that takes event_model as an argument and returns event_model.
 With mask_data, you can make modifications to headers or body of the event before it is sent to Moesif.
@@ -109,7 +134,7 @@ moesif_options['mask_data'] = Proc.new { |event_model|
 
 For details for the spec of event model, please see the [moesifapi-ruby git](https://github.com/Moesif/moesifapi-ruby)
 
-#### skip
+#### __`skip`__
 
 Optional. A Proc that takes env, headers, body and returns a boolean.
 
@@ -124,11 +149,14 @@ moesif_options['skip'] = Proc.new { |env, headers, body|
 
 ```
 
-For details for the spec of event model, please see the [moesifapi-ruby git](https://github.com/Moesif/moesifapi-ruby)
+For details for the spec of event model, please see the [Moesif Ruby API Documentation](https://www.moesif.com/docs/api?ruby)
 
 
+#### __`debug`__
 
+Optional. Boolean. Default false. If true, it will print out debug messages. In debug mode, the processing is not done in backend thread.
 
-#### debug
 
-Optional. Boolean. Default false. If true, it will print out debug messages. In debug mode, the processing is not done in backend thread.
+## Other integrations
+
+To view more more documentation on integration options, please visit __[the Integration Options Documentation](https://www.moesif.com/docs/getting-started/integration-options/).__

data/lib/moesif_rack/moesif_middleware.rb

@@ -1,6 +1,7 @@
 require 'moesif_api'
 require 'json'
 require 'time'
+require 'base64'
 
 module MoesifRack
 
@@ -42,40 +43,28 @@ 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 = {
-              'moesif_error' => {
-                'code': 'json_parse_error',
-                'src': 'moesif-rack',
-                'msg' => ['Body is not a JSON Object or JSON Array'],
-                'args' => [req_body_string]
-              }
-            }
+            req_body = Base64.encode64(req_body_string)
+            req_body_transfer_encoding = 'base64'
           end
         end
 
         rsp_headers = headers.dup
 
-        content_type = rsp_headers['Content-Type'];
+        rsp_body_string = get_response_body(body);
+        rsp_body_transfer_encoding = nil
 
-        if body && body.body
+        if rsp_body_string && rsp_body_string.length != 0
           begin
-            rsp_body = JSON.parse(body.body)
+            rsp_body = JSON.parse(rsp_body_string)
           rescue
-            if content_type && (content_type.include? "json")
-              rsp_body = {
-                'moesif_error' => {
-                  'code': 'json_parse_error',
-                  'src': 'moesif-rack',
-                  'msg' => ['Body is not a JSON Object or JSON Array'],
-                  'args' => [body.body]
-                }
-              }
-            end
+            rsp_body = Base64.encode64(rsp_body_string)
+            rsp_body_transfer_encoding = 'base64'
           end
         end
 
@@ -90,12 +79,14 @@ module MoesifRack
         event_req.ip_address = req.ip
         event_req.headers = req_headers
         event_req.body = req_body
+        event_req.transfer_encoding = req_body_transfer_encoding
 
         event_rsp = MoesifApi::EventResponseModel.new()
         event_rsp.time = end_time
         event_rsp.status = status
         event_rsp.headers = rsp_headers
         event_rsp.body = rsp_body
+        event_rsp.transfer_encoding = rsp_body_transfer_encoding
 
         event_model = MoesifApi::EventModel.new()
         event_model.request = event_req
@@ -146,5 +137,12 @@ module MoesifRack
 
       [status, headers, body]
     end
+
+    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.to_s
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moesif_rack
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Moesif, Inc
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -59,14 +59,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.1.1
 description: Collection/Data Ingestion SDK for Rack (also Rails) Middleware / RoR
 email: xing@moesif.com
 executables: []