api_hammer 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ae180a72b1ebca9d3f4806d6adb646247900aff
-  data.tar.gz: 658496ca213bf67761890117ec56497b534764ed
+  metadata.gz: 96ebda010e8ade01533266d0f06a7e13026fd746
+  data.tar.gz: a5e217afbf69ec2d4c0fb2635cce63ba4baf2c9a
 SHA512:
-  metadata.gz: c83bcc6fb8e5ab284ff7a005a1abb4daa494251cdf8be8e3c5eecf3e81823b5b059c2e615c67e0320cfa208ebec72dd5a001c826a9efe2cb5b83de43f029f71f
-  data.tar.gz: 75da8ae6628b64fb630c010dc88a29ff7aef5f1cd7e58c4886a8cf1b8647d4b70511b50ed42f3044f946785db79bcf48a764febed8b7c088900864d5719aa5d2
+  metadata.gz: 8f7a065899bd65bc13b9dee409796d9778c3104a7bb2addc7a65e33409e3f94de247fa3d4ae2a3dd826d5ee630b9beb1af32a0f96a410c65dd629b616e88716d
+  data.tar.gz: f4c8bd00c8c74a02517594fd55e45ba08f46ebb44ad87104ddc87d13e59c75acbfc48a04dc13a48a048a9add4676c5ce39c7a1383c3a50777e5a02b5d1c238c5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.2.2
+- RequestLogger, in addition to logging response bodies on error, logs id/uuid fields from request body and 
+  response body if there's no error
+- support a logger instead of a device in FaradayOutputter
+
 # 0.2.1
 - small RequestLogger tweaks
 

data/bin/hc

@@ -88,7 +88,7 @@ connection = Faraday.new(faraday_options) do |builder|
     OAuthenticator::FaradaySigner
     builder.use OAuthenticator::FaradaySigner, $oauth
   end
-  builder.use($options[:verbose] ? FaradayCurlVOutputter : FaradayOutputter, $options)
+  builder.use($options[:verbose] ? ApiHammer::FaradayCurlVOutputter : ApiHammer::FaradayOutputter, $options)
   builder.adapter Faraday.default_adapter
 end
 

data/lib/api_hammer/faraday/outputter.rb

@@ -1,137 +1,149 @@
 require 'faraday'
 require 'rack'
 
-# outputs the response body to the given output device (defaulting to STDOUT) 
-class FaradayOutputter < Faraday::Middleware
-  def initialize(app, options={})
-    @app=app
-    @options = options
-    @outdev = @options[:outdev] || STDOUT
-  end
+module ApiHammer
+  # outputs the response body to the given logger or output device (defaulting to STDOUT) 
+  class FaradayOutputter < Faraday::Middleware
+    def initialize(app, options={})
+      @app=app
+      @options = options
+      @outdev = @options[:outdev] || STDOUT
+    end
+
+    def call(request_env)
+      @app.call(request_env).on_complete do |response_env|
+        puts(response_env[:body] || '')
+      end
+    end
 
-  def call(request_env)
-    @app.call(request_env).on_complete do |response_env|
-      @outdev.puts(response_env[:body] || '')
+    def puts(str)
+      meth = @options[:logger] ? @options[:logger].method(:info) : (@options[:outdev] || STDOUT).method(:puts)
+      meth.call(str)
     end
   end
-end
 
-# this is to approximate `curl -v`s output. but it's all faked, whereas curl gives you 
-# the real text written and read for request and response. whatever, close enough. 
-class FaradayCurlVOutputter < FaradayOutputter
+  # this is to approximate `curl -v`s output. but it's all faked, whereas curl gives you 
+  # the real text written and read for request and response. whatever, close enough. 
+  class FaradayCurlVOutputter < FaradayOutputter
 
-  # defines a method with the given name, applying coloring defined by any additional arguments. 
-  # if @options[:color] is set, respects that; otherwise, applies color if the output device is a tty. 
-  def self.color(name, *color_args)
-    define_method(name) do |arg|
-      if color?
-        require 'term/ansicolor'
-        color_args.inject(arg) do |result, color_arg|
-          Term::ANSIColor.send(color_arg, result)
+    # defines a method with the given name, applying coloring defined by any additional arguments. 
+    # if @options[:color] is set, respects that; otherwise, applies color if the output device is a tty. 
+    def self.color(name, *color_args)
+      define_method(name) do |arg|
+        if color?
+          require 'term/ansicolor'
+          color_args.inject(arg) do |result, color_arg|
+            Term::ANSIColor.send(color_arg, result)
+          end
+        else
+          arg
         end
-      else
-        arg
       end
     end
-  end
 
-  color :info, :intense_yellow
-  color :info_body, :yellow
-  color :protocol
+    color :info, :intense_yellow
+    color :info_body, :yellow
+    color :protocol
 
-  color :request, :intense_cyan
-  color :request_verb, :bold
-  color :request_header
-  color :request_blankline, :intense_cyan, :bold
+    color :request, :intense_cyan
+    color :request_verb, :bold
+    color :request_header
+    color :request_blankline, :intense_cyan, :bold
 
-  color :response, :intense_green
-  color :response_status, :bold, :green
-  color :response_header
-  color :response_blankline, :intense_green, :bold
+    color :response, :intense_green
+    color :response_status, :bold, :green
+    color :response_header
+    color :response_blankline, :intense_green, :bold
 
-  def call(request_env)
-    @outdev.puts "#{info('*')} #{info_body("connect to #{request_env[:url].host} on port #{request_env[:url].port}")}"
-    @outdev.puts "#{info('*')} #{info_body("getting our SSL on")}" if request_env[:url].scheme=='https'
-    @outdev.puts "#{request('>')} #{request_verb(request_env[:method].to_s.upcase)} #{request_env[:url].request_uri} #{protocol("HTTP/#{Net::HTTP::HTTPVersion}")}"
-    request_env[:request_headers].each do |k, v|
-      @outdev.puts "#{request('>')} #{request_header(k)}#{request(':')} #{v}"
-    end
-    @outdev.puts "#{request_blankline('>')} "
-    request_body = alter_body_by_content_type(request_env[:body], request_env[:request_headers]['Content-Type'])
-    (request_body || '').split("\n", -1).each do |line|
-      @outdev.puts "#{request('>')} #{line}"
-    end
-    @app.call(request_env).on_complete do |response_env|
-      @outdev.puts "#{response('<')} #{protocol('HTTP/1.1' || 'or something - TODO')} #{response_status(response_env[:status].to_s)}"
-      request_env[:response_headers].each do |k, v|
-        @outdev.puts "#{response('<')} #{response_header(k)}#{response(':')} #{v}"
+    def call(request_env)
+      puts "#{info('*')} #{info_body("connect to #{request_env[:url].host} on port #{request_env[:url].port}")}"
+      puts "#{info('*')} #{info_body("getting our SSL on")}" if request_env[:url].scheme=='https'
+      puts "#{request('>')} #{request_verb(request_env[:method].to_s.upcase)} #{request_env[:url].request_uri} #{protocol("HTTP/#{Net::HTTP::HTTPVersion}")}"
+      request_env[:request_headers].each do |k, v|
+        puts "#{request('>')} #{request_header(k)}#{request(':')} #{v}"
+      end
+      puts "#{request_blankline('>')} "
+      request_body = alter_body_by_content_type(request_env[:body], request_env[:request_headers]['Content-Type'])
+      (request_body || '').split("\n", -1).each do |line|
+        puts "#{request('>')} #{line}"
       end
-      @outdev.puts "#{response_blankline  ('<')} "
-      response_body = alter_body_by_content_type(response_env[:body], response_env[:response_headers]['Content-Type'])
-      (response_body || '').split("\n", -1).each do |line|
-        @outdev.puts "#{response('<')} #{line}"
+      @app.call(request_env).on_complete do |response_env|
+        puts "#{response('<')} #{protocol("HTTP/#{Net::HTTP::HTTPVersion}")} #{response_status(response_env[:status].to_s)}"
+        request_env[:response_headers].each do |k, v|
+          puts "#{response('<')} #{response_header(k)}#{response(':')} #{v}"
+        end
+        puts "#{response_blankline  ('<')} "
+        response_body = alter_body_by_content_type(response_env[:body], response_env[:response_headers]['Content-Type'])
+        (response_body || '').split("\n", -1).each do |line|
+          puts "#{response('<')} #{line}"
+        end
       end
     end
-  end
 
-  def pretty?
-    @options[:pretty].nil? ? true : @options[:pretty]
-  end
+    def pretty?
+      @options[:pretty].nil? ? true : @options[:pretty]
+    end
 
-  # whether to use color
-  def color?
-    @options[:color].nil? ? @outdev.tty? : @options[:color]
-  end
+    # whether to use color. if we're writing to a device, check if it's a tty; otherwise we should have a 
+    # logger and just assume color.
+    def color?
+      if @options[:color].nil?
+        @options[:outdev] ? @options[:outdev].tty? : true
+      else
+        @options[:color]
+      end
+    end
 
-  # a mapping for each registered CodeRay scanner to the Media Types which represent 
-  # that language. extremely incomplete! 
-  CodeRayForMediaTypes = {
-    :c => [],
-    :cpp => [],
-    :clojure => [],
-    :css => ['text/css', 'application/css-stylesheet'],
-    :delphi => [],
-    :diff => [],
-    :erb => [],
-    :groovy => [],
-    :haml => [],
-    :html => ['text/html'],
-    :java => [],
-    :java_script => ['application/javascript', 'text/javascript', 'application/x-javascript'],
-    :json => ['application/json'],
-    :php => [],
-    :python => ['text/x-python'],
-    :ruby => [],
-    :sql => [],
-    :xml => ['text/xml', 'application/xml', %r(\Aapplication/.*\+xml\z)],
-    :yaml => [],
-  }
+    # a mapping for each registered CodeRay scanner to the Media Types which represent 
+    # that language. extremely incomplete! 
+    CodeRayForMediaTypes = {
+      :c => [],
+      :cpp => [],
+      :clojure => [],
+      :css => ['text/css', 'application/css-stylesheet'],
+      :delphi => [],
+      :diff => [],
+      :erb => [],
+      :groovy => [],
+      :haml => [],
+      :html => ['text/html'],
+      :java => [],
+      :java_script => ['application/javascript', 'text/javascript', 'application/x-javascript'],
+      :json => ['application/json'],
+      :php => [],
+      :python => ['text/x-python'],
+      :ruby => [],
+      :sql => [],
+      :xml => ['text/xml', 'application/xml', %r(\Aapplication/.*\+xml\z)],
+      :yaml => [],
+    }
 
-  # takes a body and a content type; returns the body, altered according to options.
-  #
-  # - with coloring (ansi colors for terminals) possibly added, if it's a recognized content type and 
-  #   #color? is true 
-  # - formatted prettily if #pretty? is true
-  def alter_body_by_content_type(body, content_type)
-    return body unless body.is_a?(String)
-    media_type = ::Rack::Request.new({'CONTENT_TYPE' => content_type}).media_type
-    if pretty?
-      case media_type
-      when 'application/json'
-        require 'json'
-        begin
-          body = JSON.pretty_generate(JSON.parse(body))
-        rescue JSON::ParserError
+    # takes a body and a content type; returns the body, altered according to options.
+    #
+    # - with coloring (ansi colors for terminals) possibly added, if it's a recognized content type and 
+    #   #color? is true 
+    # - formatted prettily if #pretty? is true
+    def alter_body_by_content_type(body, content_type)
+      return body unless body.is_a?(String)
+      media_type = ::Rack::Request.new({'CONTENT_TYPE' => content_type}).media_type
+      if pretty?
+        case media_type
+        when 'application/json'
+          require 'json'
+          begin
+            body = JSON.pretty_generate(JSON.parse(body))
+          rescue JSON::ParserError
+          end
         end
       end
-    end
-    if color?
-      coderay_scanner = CodeRayForMediaTypes.reject{|k,v| !v.any?{|type| type === media_type} }.keys.first
-      if coderay_scanner
-        require 'coderay'
-        body = CodeRay.scan(body, coderay_scanner).encode(:terminal)
+      if color?
+        coderay_scanner = CodeRayForMediaTypes.reject{|k,v| !v.any?{|type| type === media_type} }.keys.first
+        if coderay_scanner
+          require 'coderay'
+          body = CodeRay.scan(body, coderay_scanner).encode(:terminal)
+        end
       end
+      body
     end
-    body
   end
 end

data/lib/api_hammer/halt.rb

@@ -45,6 +45,16 @@ module ApiHammer::Rails
 
   # halt and render the given errors in the body on the 'errors' key 
   def halt_error(status, errors, render_options = {})
+    errors_as_json = errors.respond_to?(:as_json) ? errors.as_json : errors
+    unless errors_as_json.is_a?(Hash)
+      raise ArgumentError, "errors be an object representable in JSON as a Hash; got errors = #{errors.inspect}"
+    end
+    unless errors_as_json.keys.all? { |k| k.is_a?(String) || k.is_a?(Symbol) }
+      raise ArgumentError, "errors keys must all be string or symbol; got errors = #{errors.inspect}"
+    end
+    unless errors_as_json.values.all? { |v| v.is_a?(Array) && v.all? { |e| e.is_a?(String) } }
+      raise ArgumentError, "errors values must all be arrays of strings; got errors = #{errors.inspect}"
+    end
     halt(status, {'errors' => errors}, render_options)
   end
 

data/lib/api_hammer/request_logger.rb

@@ -24,7 +24,7 @@ module ApiHammer
       env["rack.input"].rewind
 
       log_tags = Thread.current[:activesupport_tagged_logging_tags]
-      @log_tags = log_tags.dup if log_tags
+      @log_tags = log_tags.dup if log_tags && log_tags.any?
 
       status, headers, body = @app.call(env)
       headers = ::Rack::Utils::HeaderHash.new(headers)
@@ -76,8 +76,6 @@ module ApiHammer
           'length' => headers['Content-Length'] || body.to_enum.map(&::Rack::Utils.method(:bytesize)).inject(0, &:+),
           'Location' => response.location,
           'Content-Type' => response.content_type,
-          # only log response body if there was an error (either client or server) 
-          'body' => (400..599).include?(status.to_i) ? body.to_enum.to_a.join('') : nil
         }.reject{|k,v| v.nil? },
         'processing' => {
           'began_at' => began_at.utc.to_i,
@@ -85,6 +83,27 @@ 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
+        if media_type == 'application/json'
+          body_object = JSON.parse(body_string) rescue nil
+        # TODO form encoded
+        end
+        if body_object.is_a?(Hash)
+          body_object.reject { |key, value| !(key =~ /\b(uu)?id\b/ && value.is_a?(String)) }
+        end
+      end
+      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_string = body.to_enum.to_a.join('')
+      if (400..599).include?(status.to_i)
+        # only log response body if there was an error (either client or server) 
+        data['response']['body'] = response_body_string
+      else
+        # otherwise, log id and uuid fields 
+        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)
       dolog = proc do

data/lib/api_hammer/version.rb

@@ -1,3 +1,3 @@
 module ApiHammer
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-23 00:00:00.000000000 Z
+date: 2014-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack