api_hammer 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2efd3cea2d6c262bff720e983354d944f0de16da
-  data.tar.gz: 9611db21a814571891d2d17ed017c82d2048b52e
+  metadata.gz: ac61ce80519fdf3583b64584b95987a4c19c1f70
+  data.tar.gz: 3b9b20ab3729e8c9a473747f54652da7cc947284
 SHA512:
-  metadata.gz: 8b0dbb63040d700c2c137e24c4d84eb4804d2a234a68f3b02fdc001a78ff9364cb04975466e571bac801436be222174cd7fb7def879766c1af15afadddc1a093
-  data.tar.gz: 01d61498c3db5d7ef844b6c4c8bd4524a7f98c5d2b8bd738b3a8d5ac42e952c11eab9e85c48d794e9e9d1c8fdbdbff5f2317b78d95b8f4e3af954b35729228e9
+  metadata.gz: e3cac57cc7ac0e03057b8b5bb5b2c10cc96af35e1df16ff635476ce332bd3855f5a7c13aab42051e29543b7f734615984f99bbbe0d7327bed55eeee7aefb56e3
+  data.tar.gz: ed7d082a200f2b6c4cab977afb1c32cb02dc997b65c0f5369197cac176f53dd1f13c6adc3ab408b94fd47f5948a8dc18eae1e88eb21f1854d67c7b6a3088d624

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v0.8.0
+- log request and response bodies - not just IDs from them - if they aren't too big
+
 # v0.7.1
 - logstash filters for sidekiq, activesupport tags, and of course ApiHammer's request logging 
 - use i18n for errors and add error_message to response

data/lib/api_hammer/request_logger.rb

@@ -15,6 +15,8 @@ module ApiHammer
   class RequestLogger < Rack::CommonLogger
     include Term::ANSIColor
 
+    LARGE_BODY_SIZE = 4096
+
     def call(env)
       began_at = Time.now
 
@@ -97,31 +99,29 @@ module ApiHammer
           'activesupport_tagged_logging_tags' => log_tags,
         }.merge(env['request_logger.info'] || {}).merge(Thread.current['request_logger.info'] || {}).reject { |k,v| v.nil? },
       }
-      ids_from_body = proc do |body_string, content_type|
-        media_type = ::Rack::Request.new({'CONTENT_TYPE' => content_type}).media_type
-        body_object = begin
-          if media_type == 'application/json'
-            JSON.parse(body_string) rescue nil
-          elsif media_type == 'application/x-www-form-urlencoded'
-            CGI.parse(body_string).map { |k, vs| {k => vs.last} }.inject({}, &:update)
+      response_body_string = response_body.to_enum.to_a.join('')
+      body_info = [['request', request_body, request.content_type], ['response', response_body_string, response.content_type]]
+      body_info.map do |(role, body, content_type)|
+        if (400..599).include?(status.to_i) || body.size < LARGE_BODY_SIZE
+          # log bodies if they are not large, or if there was an error (either client or server) 
+          data[role]['body'] = body
+        else
+          # otherwise, log id and uuid fields 
+          media_type = ::Rack::Request.new({'CONTENT_TYPE' => content_type}).media_type
+          body_object = begin
+            if media_type == 'application/json'
+              JSON.parse(body) rescue nil
+            elsif media_type == 'application/x-www-form-urlencoded'
+              CGI.parse(body).map { |k, vs| {k => vs.last} }.inject({}, &:update)
+            end
           end
+          if body_object.is_a?(Hash)
+            sep = /(?:\b|\W|_)/
+            body_ids = body_object.reject { |key, value| !(key =~ /#{sep}([ug]u)?id#{sep}/ && value.is_a?(String)) }
+          end
+
+          data[role]['body_ids'] = body_ids if body_ids && body_ids.any?
         end
-        if body_object.is_a?(Hash)
-          sep = /(?:\b|\W|_)/
-          body_object.reject { |key, value| !(key =~ /#{sep}([ug]u)?id#{sep}/ && value.is_a?(String)) }
-        end
-      end
-      response_body_string = response_body.to_enum.to_a.join('')
-      if (400..599).include?(status.to_i)
-        # only log bodies if there was an error (either client or server) 
-        data['request']['body'] = request_body
-        data['response']['body'] = response_body_string
-      else
-        # otherwise, log id and uuid fields 
-        request_body_ids = ids_from_body.call(request_body, request.content_type)
-        data['request']['body_ids'] = request_body_ids if request_body_ids && request_body_ids.any?
-        response_body_ids = ids_from_body.call(response_body_string, response.content_type)
-        data['response']['body_ids'] = response_body_ids if response_body_ids && response_body_ids.any?
       end
       Thread.current['request_logger.info'] = nil
       json_data = JSON.dump(data)

data/lib/api_hammer/version.rb

@@ -1,3 +1,3 @@
 module ApiHammer
-  VERSION = "0.7.1"
+  VERSION = "0.8.0"
 end

data/test/check_required_params_test.rb

@@ -25,43 +25,43 @@ describe 'ApiHammer::Rails#check_required_params' do
     it 'is missing id' do
       c = controller_with_params(:person => {:name => 'hammer', :height => '3'}, :lucky_numbers => ['2'])
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'id' => ['is required but was not provided']}}, err.body)
+      assert_equal({'error_message' => 'id is required but was not provided', 'errors' => {'id' => ['id is required but was not provided']}}, err.body)
     end
 
     it 'is missing person' do
       c = controller_with_params(:id => '99', :lucky_numbers => ['2'])
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'person' => ['is required but was not provided']}}, err.body)
+      assert_equal({'error_message' => 'person is required but was not provided', 'errors' => {'person' => ['person is required but was not provided']}}, err.body)
     end
 
     it 'is has the wrong type for person' do
       c = controller_with_params(:id => '99', :person => ['hammer', '3'], :lucky_numbers => ['2'])
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'person' => ['must be a Hash']}}, err.body)
+      assert_equal({'error_message' => 'person must be a Hash', 'errors' => {'person' => ['person must be a Hash']}}, err.body)
     end
 
     it 'is missing person#name' do
       c = controller_with_params(:id => '99', :person => {:height => '3'}, :lucky_numbers => ['2'])
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'person#name' => ['is required but was not provided']}}, err.body)
+      assert_equal({'error_message' => 'person#name is required but was not provided', 'errors' => {'person#name' => ['person#name is required but was not provided']}}, err.body)
     end
 
     it 'is missing lucky_numbers' do
       c = controller_with_params(:id => '99', :person => {:name => 'hammer', :height => '3'})
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'lucky_numbers' => ['is required but was not provided']}}, err.body)
+      assert_equal({'error_message' => 'lucky_numbers is required but was not provided', 'errors' => {'lucky_numbers' => ['lucky_numbers is required but was not provided']}}, err.body)
     end
 
     it 'has the wrong type for lucky_numbers' do
       c = controller_with_params(:id => '99', :person => {:name => 'hammer', :height => '3'}, :lucky_numbers => '2')
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'lucky_numbers' => ['must be a Array']}}, err.body)
+      assert_equal({'error_message' => 'lucky_numbers must be a Array', 'errors' => {'lucky_numbers' => ['lucky_numbers must be a Array']}}, err.body)
     end
 
     it 'has multiple problems' do
       c = controller_with_params({})
       err = assert_raises(ApiHammer::Halt) { c.check_required_params(checks) }
-      assert_equal({'errors' => {'id' => ['is required but was not provided'], 'person' => ['is required but was not provided'], 'lucky_numbers' => ['is required but was not provided']}}, err.body)
+      assert_equal({'error_message' => 'id is required but was not provided. person is required but was not provided. lucky_numbers is required but was not provided.', 'errors' => {'id' => ['id is required but was not provided'], 'person' => ['person is required but was not provided'], 'lucky_numbers' => ['lucky_numbers is required but was not provided']}}, err.body)
     end
   end
 end

data/test/halt_test.rb

@@ -50,7 +50,7 @@ describe 'ApiHammer::Rails#halt' do
         end
       end
       haltex = assert_raises(ApiHammer::Halt) { FakeController.new.find_or_halt(model, {:id => 'anid'}) }
-      assert_equal({'errors' => {'record' => ['Unknown record! id: anid']}}, haltex.body)
+      assert_equal({'error_message' => 'Unknown record! id: anid', 'errors' => {'record' => ['Unknown record! id: anid']}}, haltex.body)
       assert_equal(404, haltex.render_options[:status])
     end
   end

data/test/request_logger_test.rb

@@ -22,23 +22,30 @@ describe ApiHammer::RequestLogger do
   end
 
   it 'logs id and uuid (json)' do
-    body = %q({"uuid": "theuuid", "foo_uuid": "thefoouuid", "id": "theid", "id_for_x": "theidforx", "bar.id": "thebarid", "baz-guid": "bazzz"})
+    body = %Q({"uuid": "theuuid", "foo_uuid": "thefoouuid", "id": "theid", "id_for_x": "theidforx", "bar.id": "thebarid", "baz-guid": "bazzz", "bigthing": "#{' ' * 4096}"})
     app = ApiHammer::RequestLogger.new(proc { |env| [200, {"Content-Type" => 'application/json; charset=UTF8'}, [body]] }, logger)
     app.call(Rack::MockRequest.env_for('/')).last.close
     assert_match(%q("body_ids":{"uuid":"theuuid","foo_uuid":"thefoouuid","id":"theid","id_for_x":"theidforx","bar.id":"thebarid","baz-guid":"bazzz"}), logio.string)
   end
 
   it 'logs id and uuid (form encoded)' do
-    body = %q(uuid=theuuid&foo_uuid=thefoouuid&id=theid&id_for_x=theidforx&bar.id=thebarid&baz-guid=bazzz)
+    body = %Q(uuid=theuuid&foo_uuid=thefoouuid&id=theid&id_for_x=theidforx&bar.id=thebarid&baz-guid=bazzz&bigthing=#{' ' * 4096})
     app = ApiHammer::RequestLogger.new(proc { |env| [200, {"Content-Type" => 'application/x-www-form-urlencoded; charset=UTF8'}, [body]] }, logger)
     app.call(Rack::MockRequest.env_for('/')).last.close
     assert_match(%q("body_ids":{"uuid":"theuuid","foo_uuid":"thefoouuid","id":"theid","id_for_x":"theidforx","bar.id":"thebarid","baz-guid":"bazzz"}), logio.string)
   end
 
-  it 'logs request and response body on error' do
-    app = ApiHammer::RequestLogger.new(proc { |env| [400, {}, ['the_response_body']] }, logger)
+  it 'logs not-too-big request response bodies' do
+    app = ApiHammer::RequestLogger.new(proc { |env| [200, {}, ['the_response_body']] }, logger)
     app.call(Rack::MockRequest.env_for('/', :input => 'the_request_body')).last.close
-    assert_match(/"request":\{.*"body":"the_request_body"/, logio.string)
-    assert_match(/"response":\{.*"body":"the_response_body"/, logio.string)
+    assert_match(/"request":\{.*"body":"the_request_body/, logio.string)
+    assert_match(/"response":\{.*"body":"the_response_body/, logio.string)
+  end
+
+  it 'logs request and response body on error (even if big)' do
+    app = ApiHammer::RequestLogger.new(proc { |env| [400, {}, ["the_response_body #{' ' * 4096}"]] }, logger)
+    app.call(Rack::MockRequest.env_for('/', :input => "the_request_body #{' ' * 4096}")).last.close
+    assert_match(/"request":\{.*"body":"the_request_body/, logio.string)
+    assert_match(/"response":\{.*"body":"the_response_body/, logio.string)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-07 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack