rack-request_police 0.0.2alpha → 0.0.3alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2a52c5c86d8e26cb59e35182aa408dbe54b2ab2
-  data.tar.gz: 55886777b2b8bd0b6f98404fea8e1f4dd6366340
+  metadata.gz: d13fc52b2497aa40b442a235a51589361abfe55c
+  data.tar.gz: 53861595d2c9c9608c818a18f9a9d716365feca1
 SHA512:
-  metadata.gz: 3fa3502d9c55f9fa32bb2c6b4bb8cf2e4a5f5c10decc36937dd09e8a61aa209e88cef0170e7bb981f4a356845e1cd7ab9e4eaf0bc362637024dd75a3a3c20270
-  data.tar.gz: ad73e34f990fc84b127607d188af98fd2bb7b7277dc9039858143e30c5f4b1099d46f36da9b887af9910a421347a1af7262d16fcb1b9c1b405181df3f0d85bcc
+  metadata.gz: e1bee036da587a96b5f140550c61d164f8af9ca3d12e1a8776fa99e6111455c7cab8f1c5db6e22de553a85a048c037fb63179bcf9e4c1a4c5b4fe4d10a0c8749
+  data.tar.gz: d10d467d3aaf8579a80e99773a37236b6bd81ba6295be316ca67a018d2c3ed438e1dbc3b5d292d844a992dfae641ac33940287305c19d1e39cf6c55afd011173

data/README.md

@@ -3,6 +3,7 @@
 [![Code Climate](https://codeclimate.com/github/emq/rack-request_police/badges/gpa.svg)](https://codeclimate.com/github/emq/rack-request_police)
 [![Build Status](https://travis-ci.org/emq/rack-request_police.svg)](https://travis-ci.org/emq/rack-request_police)
 [![Coverage Status](https://coveralls.io/repos/emq/rack-request_police/badge.svg)](https://coveralls.io/r/emq/rack-request_police)
+[![Gem Version](https://badge.fury.io/rb/rack-request_police.svg)](http://badge.fury.io/rb/rack-request_police)
 [![Dependency Status](https://gemnasium.com/emq/rack-request_police.svg)](https://gemnasium.com/emq/rack-request_police)
 
 Rack middleware for logging selected request for further investigation / analyze.

data/lib/rack/request_police/middleware.rb

@@ -17,7 +17,7 @@ module Rack
           if !::Rack::RequestPolice.regex || full_url =~ ::Rack::RequestPolice.regex
             request_params = {
               'url'    => full_url,
-              'ip'     => env['REMOTE_ADDR'],
+              'ip'     => ip_address(env),
               'method' => env['REQUEST_METHOD'].downcase,
               'time'   => Time.now.to_i
             }
@@ -31,6 +31,16 @@ module Rack
 
         @app.call(env)
       end
+
+      private
+
+      def ip_address(env)
+        if !env['HTTP_X_FORWARDED_FOR'] || env['HTTP_X_FORWARDED_FOR'].empty?
+          env['REMOTE_ADDR']
+        else
+          env['HTTP_X_FORWARDED_FOR']
+        end
+      end
     end
   end
 end

data/lib/rack/request_police/version.rb

@@ -1,5 +1,5 @@
 module Rack
   module RequestPolice
-    VERSION = "0.0.2alpha"
+    VERSION = "0.0.3alpha"
   end
 end

data/lib/rack/request_police/web_helpers.rb

@@ -33,6 +33,12 @@ module Rack
       def escape(text)
          ::Rack::Utils.escape_html(text)
       end
+
+      def parse_post_data(post_data)
+        JSON.pretty_generate(JSON.parse(post_data))
+      rescue JSON::ParserError
+        post_data
+      end
     end
   end
 end

data/spec/middleware_spec.rb

@@ -22,7 +22,7 @@ describe "My Middleware", type: :request do
     }
 
     it "logs request without query params" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/", 'ip' => "127.0.0.1", 'method' => "get", 'time' => Time.now.to_i)
 
       get '/'
@@ -31,13 +31,22 @@ describe "My Middleware", type: :request do
     end
 
     it "logs request with query params" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/?what-the&hell=", 'ip' => "127.0.0.1", 'method' => "get", 'time' => Time.now.to_i)
 
       get '/?what-the&hell='
 
       expect(last_response.status).to eq 200
     end
+
+    it "logs ip address from HTTP_X_FORWARDED_FOR header if avaiable" do
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
+        .with('url' => "http://example.org/", 'ip' => "1.2.3.4", 'method' => "get", 'time' => Time.now.to_i)
+
+      get '/', nil, { 'HTTP_X_FORWARDED_FOR' => '1.2.3.4' }
+
+      expect(last_response.status).to eq 200
+    end
   end
 
   context "logging only POST requests" do
@@ -58,13 +67,13 @@ describe "My Middleware", type: :request do
     }
 
     it "ignores get requests" do
-      expect_any_instance_of(DummyStorage).not_to receive(:log_request)
+      expect(Rack::RequestPolice.storage).not_to receive(:log_request)
       get '/'
       expect(last_response.status).to eq 200
     end
 
     it "logs post request with request data" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/form", 'ip' => "127.0.0.1", 'method' => "post", 'time' => Time.now.to_i, 'data' => 'user[name]=john&user[email]=john%40test.com')
 
       post '/form', { user: { name: 'john', email: 'john@test.com' } }
@@ -89,7 +98,7 @@ describe "My Middleware", type: :request do
     }
 
     it "logs patch request with request data" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/update", 'ip' => "127.0.0.1", 'method' => "patch", 'time' => Time.now.to_i, 'data' => 'user[name]=john')
 
       patch '/update', { user: { name: 'john' } }
@@ -114,7 +123,7 @@ describe "My Middleware", type: :request do
     }
 
     it "logs delete request with request data" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/destroy", 'ip' => "127.0.0.1", 'method' => "delete", 'time' => Time.now.to_i, 'data' => 'user[id]=1')
 
       delete '/destroy', { user: { id: 1 } }
@@ -141,13 +150,13 @@ describe "My Middleware", type: :request do
     }
 
     it "ignores queries that does not match given regex" do
-      expect_any_instance_of(DummyStorage).not_to receive(:log_request)
+      expect(Rack::RequestPolice.storage).not_to receive(:log_request)
       get '/account'
       expect(last_response.status).to eq 200
     end
 
     it "logs matching queries" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/user", 'ip' => "127.0.0.1", 'method' => "get", 'time' => Time.now.to_i)
 
       get '/user'
@@ -172,13 +181,13 @@ describe "My Middleware", type: :request do
     }
 
     it "ignores queries that does not match given regex" do
-      expect_any_instance_of(DummyStorage).not_to receive(:log_request)
+      expect(Rack::RequestPolice.storage).not_to receive(:log_request)
       get '/user?id=2'
       expect(last_response.status).to eq 200
     end
 
     it "logs matching queries" do
-      expect_any_instance_of(DummyStorage).to receive(:log_request)
+      expect(Rack::RequestPolice.storage).to receive(:log_request)
         .with('url' => "http://example.org/user?id=1", 'ip' => "127.0.0.1", 'method' => "get", 'time' => Time.now.to_i)
 
       get '/user?id=1'

data/web/views/index.erb

@@ -75,7 +75,7 @@
                       <tr class="details" id="details_<%= idx %>">
                         <td colspan="5">
                           <pre>
-                            <%= escape(log.data.inspect) %>
+                            <%= escape(parse_post_data(log.data)) %>
                           </pre>
                         </td>
                       </tr>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-request_police
 version: !ruby/object:Gem::Version
-  version: 0.0.2alpha
+  version: 0.0.3alpha
 platform: ruby
 authors:
 - Rafał Wojsznis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler