api_hammer 0.6.3 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 002d518d717450a30af8921565ffe152625133aa
-  data.tar.gz: 9bae35c5c3917d005ec60b662923d3bcf69317e8
+  metadata.gz: 2efd3cea2d6c262bff720e983354d944f0de16da
+  data.tar.gz: 9611db21a814571891d2d17ed017c82d2048b52e
 SHA512:
-  metadata.gz: 166eefca239f0809baf6a54eb4d0de4b43ae5f2944ac57dcdab980df6be1be21572868575d3af3a15b07380ef367811b4e005c047e491cceab6c8c66f5a291f4
-  data.tar.gz: e60133dfd3a348b375e34ac6075435ce7e4784d8d8dae5ff68428398f2340ba78653f168eea849b82d9c3db086f4e3f2cfaef43fa2a2c7a9d8c901606bf38d4f
+  metadata.gz: 8b0dbb63040d700c2c137e24c4d84eb4804d2a234a68f3b02fdc001a78ff9364cb04975466e571bac801436be222174cd7fb7def879766c1af15afadddc1a093
+  data.tar.gz: 01d61498c3db5d7ef844b6c4c8bd4524a7f98c5d2b8bd738b3a8d5ac42e952c11eab9e85c48d794e9e9d1c8fdbdbff5f2317b78d95b8f4e3af954b35729228e9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 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
+- hc assumes http if no protocol specified
+
 # v0.6.3
 - add request role to the request logging
 

data/bin/hc

@@ -94,6 +94,10 @@ end
 
 httpmethod, url, body = *ARGV
 
+unless url['://']
+  url = 'http://' + url
+end
+
 unless Faraday::Connection::METHODS.map{|m| m.to_s.downcase }.include?(httpmethod.downcase)
   abort "Unrecognized HTTP method given: #{httpmethod}\n\n" + opt_parser.help
 end

data/lib/api_hammer/check_required_params.rb

@@ -29,7 +29,7 @@ module ApiHammer::Rails
     key = parents.join('#')
     add_error = proc { |message| errors[key] << message unless errors[key].include?(message) }
     if subparams.nil?
-      add_error.call("is required but was not provided")
+      add_error.call(I18n.t(:"errors.required_params.not_provided", :default => "%{key} is required but was not provided", :key => key))
     elsif check
       case check
       when Array
@@ -40,17 +40,17 @@ module ApiHammer::Rails
             check_required_params_helper(subcheck, subparams[key], errors, parents + [key])
           end
         else
-          add_error.call("must be a Hash")
+          add_error.call(I18n.t(:"errors.required_params.must_be_hash", :default => "%{key} must be a Hash", :key => key))
         end
       when Class
         unless subparams.is_a?(check)
-          add_error.call("must be a #{check.name}")
+          add_error.call(I18n.t(:"errors.required_params.must_be_type", :default => "%{key} must be a %{type}", :key => key, :type => check.name))
         end
       else
         if subparams.is_a?(Hash)
           check_required_params_helper(nil, subparams[check], errors, parents + [check])
         else
-          add_error.call("must be a Hash")
+          add_error.call(I18n.t(:"errors.required_params.must_be_hash", :default => "%{key} must be a Hash", :key => key))
         end
       end
     end

data/lib/api_hammer/halt.rb

@@ -44,7 +44,7 @@ module ApiHammer::Rails
   end
 
   # halt and render the given errors in the body on the 'errors' key 
-  def halt_error(status, errors, render_options = {})
+  def halt_error(status, errors, 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}"
@@ -55,7 +55,19 @@ module ApiHammer::Rails
     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)
+    render_options = options.dup.with_indifferent_access
+    body = {'errors' => errors}
+    error_message = render_options.delete('error_message') || begin
+      error_values = errors.values.inject([], &:+)
+      if error_values.size <= 1
+        error_values.first
+      else
+        # sentencify with periods 
+        error_values.map { |v| v =~ /\.\s*\z/ ? v : v + '.' }.join(' ')
+      end
+    end
+    body['error_message'] = error_message if error_message
+    halt(status, body, render_options)
   end
 
   # attempts to find and return the given model (an ActiveRecord::Base subclass) with the given attributes. 
@@ -73,7 +85,11 @@ module ApiHammer::Rails
       attributes = find_attrs.map{|attr, val| "#{attr}: #{val}" }.join(", ")
       model_name = model.table_name
       model_name = model_name.singularize if model_name.respond_to?(:singularize)
-      halt_error(options[:status], {model_name => ["Unknown #{model_name}! #{attributes}"]})
+      message = I18n.t(:"errors.unknown_record_with_attributes", :default => "Unknown %{model_name}! %{attributes}",
+        :model_name => model_name,
+        :attributes => attributes
+      )
+      halt_error(options[:status], {model_name => [message]})
     end
     record
   end

data/lib/api_hammer/version.rb

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

data/lib/logstash/filters/active_support_tags.rb

@@ -0,0 +1,27 @@
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::ActiveSupportTags < LogStash::Filters::Base
+  config_name "active_support_tags"
+  milestone 1
+
+  config :consume, :validate => :boolean, :default => true
+  config :source, :validate => :string, :default => 'message'
+
+  public
+  def register
+  end
+
+  public
+  def filter(event)
+    as_tags = []
+    message = event[@source]
+    while message =~ /\A\[([^\]]+?)\]\s+/
+      as_tags << $1
+      message = $'
+    end
+    event['as_tags'] = as_tags if as_tags.any?
+
+    event[@source] = message if @consume
+  end
+end

data/lib/logstash/filters/api_hammer_request.rb

@@ -0,0 +1,49 @@
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::ApiHammerRequest < LogStash::Filters::Base
+  config_name "api_hammer_request"
+  milestone 1
+
+  config :consume, :validate => :boolean, :default => true
+  config :source, :validate => :string, :default => 'message'
+
+  public
+  def register
+  end
+
+  public
+  def filter(event)
+    # discard the request status line for humans - always followed by json which we'll parse 
+    col = /[\e\[\dm]*/.source
+    human_request = [/\A/, /[<>]/, /\s/, /\d+/, / : /, /\w+/, / /, /[^\e]+/, / @ /, /[^\e]+/, /\z/].map(&:source).join(col)
+    event.cancel if event[@source] =~ /#{human_request}/
+
+    begin
+      parsed_message = JSON.parse(event[@source])
+      if @consume
+        # replace the source with a brief human-readable message
+        role = parsed_message['request_role']
+        dir = role == 'server' ? '<' : role == 'client' ? '>' : '*'
+        status = parsed_message['response'] && parsed_message['response']['status']
+        request_method = parsed_message['request'] && parsed_message['request']['method']
+        request_uri = parsed_message['request'] && parsed_message['request']['uri']
+        now_s = Time.now.strftime('%Y-%m-%d %H:%M:%S %Z')
+        event[@source] = "#{dir} #{status} : #{request_method} #{request_uri} @ #{now_s}"
+      end
+    rescue JSON::ParserError
+      nil
+    end
+
+    if parsed_message
+      if parsed_message.is_a?(Hash)
+        event.to_hash.update(parsed_message)
+        if parsed_message['processing'].is_a?(Hash) && parsed_message['processing']['began_at'].is_a?(Integer)
+          event['@timestamp'] = Time.at(parsed_message['processing']['began_at']).utc
+        end
+      else
+        event['parsed_message'] = parsed_message
+      end
+    end
+  end
+end

data/lib/logstash/filters/request_bodies_parsed.rb

@@ -0,0 +1,34 @@
+require "logstash/filters/base"
+require "logstash/namespace"
+require 'rack'
+require 'cgi'
+require 'json'
+class LogStash::Filters::RequestBodiesParsed < LogStash::Filters::Base
+  config_name "request_bodies_parsed"
+  milestone 1
+
+  public
+  def register
+  end
+
+  public
+  def filter(event)
+    %w(request response).each do |re|
+      if event[re].is_a?(Hash) && event[re]['body'].is_a?(String)
+        _, content_type = event[re].detect { |(k,_)| k =~ /\Acontent.type\z/i }
+        if event[re]['headers'].is_a?(Hash) && !content_type
+          _, content_type = event[re]['headers'].detect { |(k,_)| k =~ /\Acontent.type\z/i }
+        end
+        media_type = ::Rack::Request.new({'CONTENT_TYPE' => content_type}).media_type
+        body_parsed = begin
+          if media_type == 'application/json'
+            JSON.parse(event[re]['body']) rescue nil
+          elsif media_type == 'application/x-www-form-urlencoded'
+            CGI.parse(event[re]['body']).map { |k, vs| {k => vs.last} }.inject({}, &:update)
+          end
+        end
+        event[re]['body_parsed'] = body_parsed if body_parsed
+      end
+    end
+  end
+end

data/lib/logstash/filters/ruby_logger.rb

@@ -0,0 +1,28 @@
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::RubyLogger < LogStash::Filters::Base
+  config_name "ruby_logger"
+  milestone 1
+
+  config :consume, :validate => :boolean, :default => true
+  config :source, :validate => :string, :default => 'message'
+
+  public
+  def register
+  end
+
+  public
+  def filter(event)
+    ruby_logged = /\A(?<severity_letter>\w), +\[(?<time>[\d\-T.:]+) +#(?<pid>\d+)\] +(?<severity>(?i:DEBUG|INFO|WARN|ERROR|FATAL|UNKNOWN|ANY)) +-- +(?<progname>.*?): /
+    if ruby_log_match = event[@source].match(ruby_logged)
+      uninteresting_names = %w(severity_letter time)
+      interesting_names = ruby_log_match.names - uninteresting_names
+      event.to_hash.update(interesting_names.map { |name| {name => ruby_log_match[name]} }.inject({}, &:update))
+
+      event['@timestamp'] = Time.parse(ruby_log_match['time']).utc
+
+      event[@source] = ruby_log_match.post_match if @consume
+    end
+  end
+end

data/lib/logstash/filters/sidekiq.rb

@@ -0,0 +1,33 @@
+require "logstash/filters/base"
+require "logstash/namespace"
+
+class LogStash::Filters::Sidekiq < LogStash::Filters::Base
+  config_name "sidekiq"
+  milestone 1
+
+  config :consume, :validate => :boolean, :default => true
+  config :source, :validate => :string, :default => 'message'
+
+  public
+  def register
+  end
+
+  public
+  def filter(event)
+    sidekiq_logged = /\A(?<time>[\d\-]+T[\d:]+Z) (?<pid>\d+) TID-(?<tid>\w+)(?<context>.*?) (?<severity>(?i:DEBUG|INFO|WARN|ERROR|FATAL|UNKNOWN|ANY)): /
+    if sidekiq_match = event[@source].match(sidekiq_logged)
+      event['sidekiq'] ||= {}
+      event['sidekiq'].update(sidekiq_match.names.map { |name| {name => sidekiq_match[name]} }.inject({}, &:update))
+
+      event['@timestamp'] = Time.parse(sidekiq_match['time']).utc
+
+      # extract more info from context 
+      job_context = /\A\s*(?<job_name>.+) JID-(?<jid>\w+)\z/
+      if context_match = sidekiq_match['context'].match(job_context)
+        event['sidekiq']['context'] = context_match.names.map { |name| {name => context_match[name]} }.inject({}, &:update)
+      end
+
+      event[@source] = sidekiq_match.post_match if @consume
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_hammer
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.1
 platform: ruby
 authors:
 - Ethan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -255,6 +255,11 @@ files:
 - lib/api_hammer/unmunged_request_params.rb
 - lib/api_hammer/version.rb
 - lib/api_hammer/weblink.rb
+- lib/logstash/filters/active_support_tags.rb
+- lib/logstash/filters/api_hammer_request.rb
+- lib/logstash/filters/request_bodies_parsed.rb
+- lib/logstash/filters/ruby_logger.rb
+- lib/logstash/filters/sidekiq.rb
 - test/active_record_cache_find_by_test.rb
 - test/check_required_params_test.rb
 - test/faraday_request_logger_test.rb