api_hammer 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62d257b84cb30c253738ffe4485eac1a378d9443
-  data.tar.gz: 804dfcd511a7c027f64d72eb62070f4c6698a058
+  metadata.gz: 5c7392029cd2bb252222f1f27c3040d6feb8ad6d
+  data.tar.gz: e93c54825807dc89e3772fd3221195f56d5aac0e
 SHA512:
-  metadata.gz: 587cd1a5b4e437b1871dfbb890b1c333c9d427cd178f5af2dd3ef0b52de6eade49504ba460259eecd57e10ffefb8413bf8917f64f66f0ad82ccfdbdefd7e4493
-  data.tar.gz: cf1a2c017ff9690c7245626a8609e56c4ec0a4d56cc102285913a7ac6132fa6a2090380cb1129b575175ded4aa7eadc0f61f77d47186f5ee2c4a6b5e86eee262
+  metadata.gz: f7f7900b48a6fec0843e12cadd3bed80bf769ac818f806af2aa2f2aad09fb05d8159ec6c2e9e38ff84cda55dacb8e7ec63f6a2d59f96dbb926675063d1771c8a
+  data.tar.gz: c6179c9bde78883ad9fa6927b52ad56c2e63af4a9cbbd31aa70b538b0e7136fb3f7ea51b292746876d6cdd67b39ba85c7db832acf4a5faf9a50fc87f13413d5d

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.4.0
+- ApiHammer::Faraday::RequestLogger
+
 # 0.3.3
 - be a little lazier about initializing ActiveRecord::Base.finder_cache - only on first actual usage 
 

data/lib/api_hammer/faraday/request_logger.rb

@@ -0,0 +1,89 @@
+require 'faraday'
+require 'rack'
+require 'term/ansicolor'
+require 'json'
+
+if Faraday.respond_to?(:register_middleware)
+  Faraday.register_middleware(:request, :api_hammer_request_logger => proc { ApiHammer::Faraday::RequestLogger })
+end
+if Faraday::Request.respond_to?(:register_middleware)
+  Faraday::Request.register_middleware(:api_hammer_request_logger => proc { ApiHammer::Faraday::RequestLogger })
+end
+
+module ApiHammer
+  class Faraday
+    # Faraday middleware for logging.
+    #
+    # two lines:
+    #
+    # - an info line, colored prettily to show a brief summary of the request and response
+    # - a debug line of json to record all relevant info. this is a lot of stuff jammed into one line, not 
+    #   pretty, but informative.
+    class RequestLogger < ::Faraday::Middleware
+      include Term::ANSIColor
+
+      def initialize(app, logger, options={})
+        @app = app
+        @logger = logger
+        @options = options
+      end
+
+      def call(request_env)
+        began_at = Time.now
+
+        log_tags = Thread.current[:activesupport_tagged_logging_tags]
+        saved_log_tags = log_tags.dup if log_tags && log_tags.any?
+
+        request_body = request_env[:body].dup if request_env[:body]
+
+        @app.call(request_env).on_complete do |response_env|
+          now = Time.now
+
+          status_color = case response_env.status.to_i
+          when 200..299
+            :intense_green
+          when 400..499
+            :intense_yellow
+          when 500..599
+            :intense_red
+          else
+            :white
+          end
+          status_s = bold(send(status_color, response_env.status.to_s))
+          data = {
+            'request' => {
+              'method' => request_env[:method],
+              'uri' => request_env[:url].normalize.to_s,
+              'headers' => request_env.request_headers,
+              'body' => request_body,
+            }.reject{|k,v| v.nil? },
+            'response' => {
+              'status' => response_env.status,
+              'headers' => response_env.response_headers,
+              'body' => response_env.body,
+            }.reject{|k,v| v.nil? },
+            'processing' => {
+              'began_at' => began_at.utc.to_i,
+              'duration' => now - began_at,
+              'activesupport_tagged_logging_tags' => @log_tags,
+            }.reject{|k,v| v.nil? },
+          }
+
+          json_data = JSON.dump(data)
+          dolog = proc do
+            now_s = now.strftime('%Y-%m-%d %H:%M:%S %Z')
+            @logger.info "#{bold(intense_magenta('>'))} #{status_s} : #{bold(intense_magenta(request_env[:method].to_s.upcase))} #{intense_magenta(request_env[:url].normalize.to_s)} @ #{intense_magenta(now_s)}"
+            @logger.info json_data
+          end
+
+          # reapply log tags from the request if they are not applied 
+          if @logger.respond_to?(:tagged) && saved_log_tags && Thread.current[:activesupport_tagged_logging_tags] != saved_log_tags
+            @logger.tagged(saved_log_tags, &dolog)
+          else
+            dolog.call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/api_hammer/request_logger.rb

@@ -108,7 +108,7 @@ module ApiHammer
       json_data = JSON.dump(data)
       dolog = proc do
         now_s = now.strftime('%Y-%m-%d %H:%M:%S %Z')
-        @logger.info "#{status_s} : #{bold(intense_cyan(request.request_method))} #{intense_cyan(request_uri.normalize)} @ #{intense_magenta(now_s)}"
+        @logger.info "#{bold(intense_cyan('<'))} #{status_s} : #{bold(intense_cyan(request.request_method))} #{intense_cyan(request_uri.normalize)} @ #{intense_cyan(now_s)}"
         @logger.info json_data
       end
       # do the logging with tags that applied to the request if appropriate 

data/lib/api_hammer/version.rb

@@ -1,3 +1,3 @@
 module ApiHammer
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

data/test/faraday_request_logger_test.rb

@@ -0,0 +1,44 @@
+proc { |p| $:.unshift(p) unless $:.any? { |lp| File.expand_path(lp) == p } }.call(File.expand_path('.', File.dirname(__FILE__)))
+require 'helper'
+require 'logger'
+require 'stringio'
+require 'api_hammer/faraday/request_logger'
+
+describe ApiHammer::RequestLogger do
+  let(:logio) { StringIO.new }
+  let(:logger) { Logger.new(logio) }
+
+  it 'logs' do
+    conn = Faraday.new do |f|
+      f.use ApiHammer::Faraday::RequestLogger, logger
+      f.use Faraday::Adapter::Rack, proc { |env| [200, {}, []] }
+    end
+    conn.get '/'
+    assert_match(/200/, logio.string)
+    lines = logio.string.split("\n")
+    assert_equal(2, lines.size)
+    assert lines.last =~ /INFO -- : /
+    json_bit = $'
+    JSON.parse json_bit # should not raise 
+  end
+
+  {200 => :intense_green, 400 => :intense_yellow, 500 => :intense_red, 300 => :white}.each do |status, color|
+    it "colors by #{status} status" do
+      conn = Faraday.new do |f|
+        f.use ApiHammer::Faraday::RequestLogger, logger
+        f.use Faraday::Adapter::Rack, proc { |env| [status, {}, []] }
+      end
+      conn.get '/'
+      assert(logio.string.include?(Term::ANSIColor.send(color, status.to_s)))
+    end
+  end
+
+  it 'registers by name' do
+    conn = Faraday.new do |f|
+      f.request :api_hammer_request_logger, logger
+      f.use Faraday::Adapter::Rack, proc { |env| [200, {}, []] }
+    end
+    conn.get '/'
+    assert_match(/200/, logio.string)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2014-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -226,6 +240,7 @@ files:
 - lib/api_hammer/active_record_cache_find_by.rb
 - lib/api_hammer/check_required_params.rb
 - lib/api_hammer/faraday/outputter.rb
+- lib/api_hammer/faraday/request_logger.rb
 - lib/api_hammer/halt.rb
 - lib/api_hammer/public_instance_exec.rb
 - lib/api_hammer/rails.rb
@@ -241,6 +256,7 @@ files:
 - lib/api_hammer/weblink.rb
 - test/active_record_cache_find_by_test.rb
 - test/check_required_params_test.rb
+- test/faraday_request_logger_test.rb
 - test/halt_test.rb
 - test/helper.rb
 - test/public_instance_exec_test.rb
@@ -275,6 +291,7 @@ summary: an API tool
 test_files:
 - test/active_record_cache_find_by_test.rb
 - test/check_required_params_test.rb
+- test/faraday_request_logger_test.rb
 - test/halt_test.rb
 - test/helper.rb
 - test/public_instance_exec_test.rb