onelinejson 0.0.8 → 0.1.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in onelinejson.gemspec
 gemspec
+
+group :development, :test do
+  gem "rspec"
+  gem "lograge", git: "git@github.com:i0rek/lograge.git", branch: "before_format"
+end

data/Rakefile

@@ -1 +1,28 @@
-require "bundler/gem_tasks"
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rspec/core/rake_task"
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "onelinejson/version"
+
+task :gem => :build
+task :build do
+  system "gem build onelinejson.gemspec"
+end
+
+task :install => :build do
+  system "gem install #{FILE}"
+end
+
+task :release => :build do
+  system "git tag -a v#{Onelinejson::VERSION} -m 'Tagging #{Onelinejson::VERSION}'"
+  system "git push --tags"
+  system "gem push onelinejson-#{Onelinejson::VERSION}.gem"
+end
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.ruby_opts = "-W -I./spec -rspec_helper"
+end
+task :default => :spec

data/lib/onelinejson.rb

@@ -20,22 +20,23 @@ module Onelinejson
   ]
   ELIP = "\xe2\x80\xa6"
   LOG_MAX_LENGTH = 1900
-
-  def self.trim_values(hash, trim_to)
-    Hash[hash.map do |k, v|
-      if v.is_a? String
-        trimmed = if v.size > trim_to
-          v[0, trim_to] + ELIP
-        else
-          v
-        end
-        [k, trimmed]
-      else
-        [k, v]
-      end
-    end]
+  ENTRY_MAX_LENGTH = 128
+  BEFORE_HOOK = lambda do |data, payload|
+    request = data.select{ |k,_|
+      [:method, :path, :format].include?(k)
+    }.merge(payload[:request])
+    response = data.select{ |k,_|
+      [:status, :duration, :view, :view_runtime].include?(k)
+    }
+    Onelinejson.enforce_max_json_length(
+      {
+        debug_info: payload[:debug_info] || {},
+        request: request,
+        response: response,
+      })
   end
 
+
   def self.enforce_max_json_length(hash)
     return hash if JSON.dump(hash).size <= LOG_MAX_LENGTH
 
@@ -48,24 +49,50 @@ module Onelinejson
   end
 
   module AppControllerMethods
-    def append_info_to_payload(payload)
-      super
-      headers = if request.headers.respond_to?(:env)
-        request.headers.env
-      elsif request.headers.respond_to?(:to_hash)
-        request.headers.to_hash
+    extend self # for testing
+
+    def trim_values(hash)
+      Hash[hash.map do |k, v|
+        if v.is_a? String
+          trimmed = if v.size > ENTRY_MAX_LENGTH
+            v[0, ENTRY_MAX_LENGTH-1] + ELIP
+          else
+            v
+          end
+          [k, trimmed]
+        else
+          [k, v]
+        end
+      end]
+    end
+
+    def extract_headers(headers)
+      if headers.respond_to?(:env)
+        headers.env
+      elsif headers.respond_to?(:to_hash)
+        headers.to_hash
       end.select do |k, v|
         k =~ /^HTTP_/ && !REJECTED_HEADERS.any? {|regex| k =~ regex}
       end
-      parameters = params.reject do |k,v|
+    end
+
+    def extract_params(params)
+      params.reject do |k,v|
         k == 'controller' ||
           k == 'action' ||
           v.is_a?(ActionDispatch::Http::UploadedFile) ||
           v.is_a?(Hash)
       end
+    end
+
+    def append_info_to_payload(payload)
+      super
 
+      parameters = extract_params(params)
+      parameters = trim_values(parameters)
+      headers = extract_headers(request.headers)
       payload[:request] = {
-        params: Onelinejson.trim_values(parameters, 128),
+        params: parameters,
         headers: headers,
         ip: request.ip,
         uuid: request.env['action_dispatch.request_id'],
@@ -81,25 +108,12 @@ module Onelinejson
   end
 
   class Railtie < Rails::Railtie
+    puts 'FUUUU'
     config.log_tags = nil
     config.lograge = ActiveSupport::OrderedOptions.new
     config.lograge.formatter = ::Lograge::Formatters::Json.new
     config.lograge.enabled = true
-    config.lograge.before_format = lambda do |data, payload|
-      request = data.select{ |k,_|
-        [:method, :path, :format].include?(k)
-      }.merge(payload[:request])
-      response = data.select{ |k,_|
-        [:status, :duration, :view, :view_runtime].include?(k)
-      }
-      Onelinejson.enforce_max_json_length(
-        {
-          debug_info: payload[:debug_info] || {},
-          request: request,
-          response: response,
-        })
-    end
-
+    config.lograge.before_format = Onelinejson::BEFORE_HOOK
     ActiveSupport.on_load(:action_controller) do
       include AppControllerMethods
     end

data/lib/onelinejson/version.rb

@@ -1,3 +1,3 @@
 module Onelinejson
-  VERSION = "0.0.8"
+  VERSION = "0.1.0"
 end

data/onelinejson.gemspec

@@ -19,6 +19,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "lograge"
-  spec.add_development_dependency "bundler", "~> 1.4"
-  spec.add_development_dependency "rake"
 end

data/spec/lib/onelinejson_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Onelinejson::AppControllerMethods do
+  describe '.trim_values' do
+    let(:trimmed) { Onelinejson::AppControllerMethods.trim_values(hash) }
+    context 'when all good' do
+      let(:hash) { {a: 1, b: 2} }
+      it 'returns eq hash' do
+        expect(trimmed).to eq(hash)
+      end
+    end
+
+    context 'when entry too long' do
+      let(:hash) { {a: "aa"*Onelinejson::ENTRY_MAX_LENGTH} }
+      it 'trims entry' do
+        expect(trimmed[:a]).to have(Onelinejson::ENTRY_MAX_LENGTH).chars
+      end
+    end
+  end
+
+  describe '.extract_headers' do
+    context 'when rails 3' do
+      it 'extracts'
+    end
+
+    context 'when rails 4' do
+      it 'extracts'
+    end
+  end
+
+  describe '.extract_params' do
+    it 'returns sanetized params'
+    it 'rejects controller'
+    it 'rejects action'
+    context 'when value is a file' do
+      it 'rejects whenfiles'
+    end
+    context 'when value is a hash' do
+      it 'rejects'
+    end
+  end
+end
+
+describe Onelinejson do
+  describe Onelinejson::BEFORE_HOOK do
+    it 'works'
+  end
+
+  describe '.enforce_max_json_length' do
+    let(:enforced) { Onelinejson.enforce_max_json_length(hash) }
+    context 'when all good' do
+      let(:hash)  { {a: 1, b: 2} }
+      it 'returns hash' do
+        expect(enforced).to be(hash)
+      end
+    end
+
+    context 'when hash too long' do
+      context 'when removing params fixes it' do
+        let(:hash) { {a: 1, request: {
+          headers: 'a', params: 'b'*Onelinejson::LOG_MAX_LENGTH
+        }} }
+        it 'returns hash without params' do
+          expect(enforced[:request].keys).to eq([:headers])
+        end
+      end
+
+      context 'when removing params and headers fixes it' do
+        let(:hash) { {a: 1, request: {
+          headers: 'a'*Onelinejson::LOG_MAX_LENGTH, params: 'b'*Onelinejson::LOG_MAX_LENGTH
+        }} }
+        it 'returns hash without params and headers' do
+          expect(enforced[:request].keys).to be_empty
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+require "bundler"
+Bundler.setup
+
+module Rails
+end
+
+require "lograge"
+require "onelinejson"
+require "rspec"
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onelinejson
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lograge
@@ -27,38 +27,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Everything you need to log json oneliners
 email:
 - me@hans.io
@@ -67,6 +35,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,6 +43,8 @@ files:
 - lib/onelinejson.rb
 - lib/onelinejson/version.rb
 - onelinejson.gemspec
+- spec/lib/onelinejson_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -87,16 +58,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3268962913112188005
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3268962913112188005
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Everything you need to log json oneliners
-test_files: []
+test_files:
+- spec/lib/onelinejson_spec.rb
+- spec/spec_helper.rb