niboshi_json_formatter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f620bfa3ce8d8635ff3a49b7a5694bc1def3e47
-  data.tar.gz: 4c43324b09180947fca0ca398e90ffdfd7def934
+  metadata.gz: c095ee3fd7f44484940febd058790be42827dab7
+  data.tar.gz: 6d5bfa98e4a883234ff28da56e8f2aab1fe5d691
 SHA512:
-  metadata.gz: bd6dd60ca819f7302e79cb53a7a5da4d7ec67043fe09e115bbd35a9a63fdfbb1287b756a900c6c02a46de5da0442564b7b40d5465cbc0681446f072cc5aa6d8d
-  data.tar.gz: 7245d14a967ea25ed8929cd4f9a7b22f2710034e1362fe1be84a3c1543d4813c5f1848180814c5207cadd3ee02d506636bbd5f7c765a610b8d896de0dd74d7b0
+  metadata.gz: 5b7b221ee9a318da48a2f5793823703ce190d1ae4c73cb7e591247e3ae503d57281b9680a4107364b1bed393c0c8214cc998976d09ef2bf89f04623cb4573deb
+  data.tar.gz: 8ae8870b7b29bda779ba42c03720893b641fde274d42c423e0908a93852855cf648ea4b47bd84c8f396ad61d3ee06dbc2841b7c5bceff6b8a974f4732329ca10

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.gem

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+language: ruby
+
+gemfile:
+  - Gemfile
+  - Gemfile19-20
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+
+script: bundle exec rspec
+
+matrix:
+  exclude:
+    - rvm: 1.9.3
+      gemfile: Gemfile
+    - rvm: 2.0
+      gemfile: Gemfile
+    - rvm: 2.1
+      gemfile: Gemfile19-20
+    - rvm: 2.2
+      gemfile: Gemfile19-20

data/Gemfile19-20

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in niboshi_logger_json_formatter.gemspec
+gemspec
+gem 'string-scrub'

data/README.md

@@ -1,5 +1,7 @@
 # NiboshiJsonFormatter
 
+[![Circle CI](https://circleci.com/gh/ZCloud-Firstserver/niboshi_json_formatter/tree/master.svg?style=svg)](https://circleci.com/gh/ZCloud-Firstserver/niboshi_json_formatter/tree/master)
+
 A Ruby gem that makes your app log in JSON format. It may be useful if you ship all your logs to [ElasticSearch](http://www.elasticsearch.org/).
 
 ## Installation
@@ -7,7 +9,7 @@ A Ruby gem that makes your app log in JSON format. It may be useful if you ship
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'niboshi_json_formatter', github: "ZCloud-Firstserver/niboshi_json_formatter"
+gem 'niboshi_json_formatter'
 ```
 
 And then execute:
@@ -20,11 +22,25 @@ Or install it yourself as:
 
 ## Usage
 
-Add this to your `config/environments/*.rb` files:
+### Rails project
+
+Add this to your `config/environments/*.rb`:
 
 ```
 config.log_formatter = Niboshi::JsonFormatter.new
 ```
+### Logger
+
+Update the formatter:
+
+```
+require 'niboshi_json_formatter'
+@log = Logger.new(STDOUT)
+@log.formatter = Niboshi::JsonFormatter.new
+@log.info "foo bar"
+
+#=> {"time":1417595700.318135,"formatted_time":"2014-12-03 17:35:00 +0900","hostname":"macmini.local","pid":66419,"tid":70165887050860,"level":"INFO","program_name":null,"message":"foo bar"}
+```
 
 ## Contributing
 

data/circle.yml

@@ -0,0 +1,7 @@
+---
+dependencies:
+  pre:
+    - gem install bundler
+test:
+  override:
+    - bundle exec rspec

data/lib/niboshi/json_formatter.rb

@@ -3,7 +3,7 @@ require "json"
 
 module Niboshi
   class JsonFormatter < ::Logger::Formatter
-    Version = VERSION = "0.1.0"
+    Version = VERSION = "0.1.1"
 
     def hostname
       @hostname ||= Socket.gethostname
@@ -14,7 +14,7 @@ module Niboshi
     end
 
     def call(severity, time, program_name, message)
-      {
+      data = {
         time: time.to_f,
         formatted_time: time,
         hostname: hostname,
@@ -23,7 +23,12 @@ module Niboshi
         level: severity,
         program_name: program_name,
         message: message
-      }.to_json + "\n"
+      }
+
+      data.to_json + "\n"
+
+    rescue JSON::GeneratorError
+      (data.each_pair {|k,v| data[k] = v.scrub("?") if v.is_a?(String) }).to_json + "\n"
     end
   end
 end

data/spec/json_formatter_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'spec_helper'
 
 describe Niboshi::JsonFormatter do
@@ -17,4 +18,28 @@ describe Niboshi::JsonFormatter do
     it { expect(subject["program_name"]).to eql program_name }
     it { expect(subject["message"]).to eql message }
   end
+
+  context "cantain illegal utf-8 string" do
+    describe "fallback into scrub" do
+      let(:severity) { "INFO" }
+      let(:time) { Time.now }
+      let(:program_name) { "RSpec" }
+      let(:message) { "あいうえお".encode("SHIFT_JIS", "UTF-8").force_encoding("UTF-8") }
+      subject { JSON.parse(Niboshi::JsonFormatter.new.call(severity, time, program_name, message)) }
+
+      it { expect(subject["time"]).not_to be_nil }
+      it { expect(subject["formatted_time"]).not_to be_nil }
+      it { expect(subject["hostname"]).to eql Socket.gethostname }
+      it { expect(subject["pid"]).not_to be_nil }
+      it { expect(subject["tid"]).not_to be_nil }
+      it { expect(subject["level"]).to eql severity }
+      it { expect(subject["program_name"]).to eql program_name }
+
+      if RbConfig::CONFIG['ruby_version'] < "2.1.0"
+        it { expect(subject["message"]).to eql "\x82\xA0\x82\xA2\x82\xA4\x82\xA6\x82\xA8" }
+      else
+        it { expect(subject["message"]).to eql "??????????" }
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: niboshi_json_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - azukiwasher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-05 00:00:00.000000000 Z
+date: 2015-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -61,11 +61,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
+- Gemfile19-20
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - lib/niboshi/json_formatter.rb
 - lib/niboshi_json_formatter.rb
 - niboshi_json_formatter.gemspec

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2014 azukiwasher
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.