log15 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15778719187c022926549eebe3a808ee0374f8d7
+  data.tar.gz: e90453d30af6fe2a61a58ba9d11e9b70ddf075c1
+SHA512:
+  metadata.gz: ba82e4bc74b888d64db5aed928be551621c6d656857a89db9a43586375bb0afc09f129514c5567e30b6195fc6a055e69c0df7a575ec6ad012076cede00207a26
+  data.tar.gz: e25c7d4e3fc23d8bc812cb7046c0514f2e34d1e26a0724e1615d6af07457b2c3bd969a4ec218acf8196ed2d0b58c52247b341a438bb4302a371cca3eeea4fa29

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in log15.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Bigg
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# Log15
+
+![obligatory xkcd](http://imgs.xkcd.com/comics/standards.png)
+
+This library was inspired by [inconshreveable/log15](https://github.com/inconshreveable/log15).
+
+`log15` is a structured logger, outputting a message followed by key/value pairs containing more information about that particular line. This is useful if you're piping your logs to something like Kibana and want to make processing them simpler.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'log15'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install log15
+
+## Usage
+
+```ruby
+# Create a new log15 logger
+logger = Log15::Logger.default
+logger.info("Test message", foo: "bar")
+```
+
+This will output something like:
+
+```
+INFO[11-26|16:27:09] Test message foo="bar"\n"
+```
+
+Other log levels are also supported: `debug`, `warn`, and `error`.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/log15.rb

@@ -0,0 +1,6 @@
+require "log15/version"
+require "log15/logger"
+
+module Log15
+  class SanitizationError < StandardError; end
+end

data/lib/log15/logger.rb

@@ -0,0 +1,77 @@
+require 'logger'
+require 'json'
+
+module Log15
+  class Logger
+    attr_accessor :logger
+    def initialize(logger=Rails.logger)
+      @logger = logger.dup
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        date = "#{datetime.month}-#{datetime.day}"
+        time = "#{pad(datetime.hour)}:#{pad(datetime.min)}:#{pad(datetime.sec)}"
+        severities = { "ERROR" => "EROR", "DEBUG" => "DBUG" }
+        severity = severities.fetch(severity, severity)
+        "#{severity}[#{date}|#{time}] #{msg}\n"
+      end
+    end
+
+    def self.default
+      @logger ||= Log15.new
+    end
+
+    def self.sanitize(params, key, opts={})
+      if params[key]
+        raise SanitizationError, "expected #{key} to not be blank" if params[key] == ""
+        if opts[:expected_length]
+          minimum_size = opts[:expected_length].first
+          maximum_size = opts[:expected_length].last
+          length = params[key].length
+          if length < minimum_size || length > maximum_size
+            raise SanitizationError, "expected access_token to be between #{minimum_size} and #{maximum_size} characters long (is #{length})"
+          end
+        end
+        params[key] = params[key][0..5] + "****" + params[key][-6..-1]
+      else
+        raise SanitizationError, "expected #{key} to be present"
+      end
+      params
+    end
+
+    def debug(msg, data={})
+      logger.debug(process(msg, data))
+    end
+
+    def info(msg, data={})
+      logger.info(process(msg, data))
+    end
+
+    def warn(msg, data={})
+      logger.warn(process(msg, data))
+    end
+
+    def error(msg, data={})
+      logger.error(process(msg, data))
+    end
+
+    private
+
+    def process(msg, data)
+      output = ["#{msg}"]
+      if data.keys.count > 0
+        data.each do |k, v|
+          if v.is_a?(Array) || v.is_a?(Hash)
+            output << ["#{k}=#{JSON.dump(v).inspect}"]
+          else
+            output << ["#{k}=#{v.inspect}"]
+          end
+        end
+      end
+
+      output.join(" ")
+    end
+
+    def pad(number)
+      number.to_s.rjust(2, '0')
+    end
+  end
+end

data/lib/log15/version.rb

@@ -0,0 +1,3 @@
+module Log15
+  VERSION = "1.0.0"
+end

data/log15.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'log15/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "log15"
+  spec.version       = Log15::VERSION
+  spec.authors       = ["Ryan Bigg"]
+  spec.email         = ["radar@lifx.co"]
+  spec.summary       = %q{Structured logging.}
+  spec.description   = %q{Structured logging.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/spec/log15/logger_spec.rb

@@ -0,0 +1,82 @@
+require 'log15'
+
+describe Log15 do
+  let(:log) { StringIO.new }
+  let(:logger) { Logger.new(log) }
+  subject { Log15::Logger.new(logger) }
+
+  context "info" do
+    it "simple message" do
+      subject.info("msg", foo: "bar", baz: "foo")
+      output = log.string
+      expect(output).to match(/^INFO/)
+      expect(output).to match(/\[\d{2}-\d{2}|\d{2}:\d{2}:\d{2}\]/)
+      expect(output).to match(/msg foo="bar" baz="foo"\n$/)
+    end
+
+    it "message with quotes" do
+      subject.info("msg", foo: "\"bar\"")
+      output = log.string
+      expect(output).to match(/^INFO/)
+      expect(output).to match(/\[\d{2}-\d{2}|\d{2}:\d{2}:\d{2}\]/)
+      expect(output).to match(/msg foo="\\\"bar\\\""\n$/)
+    end
+
+    it "message with nested hash" do
+      subject.info("msg", foo: { bar: "baz"})
+      output = log.string
+      expect(output).to match(/^INFO/)
+      expect(output).to match(/\[\d{2}-\d{2}|\d{2}:\d{2}:\d{2}\]/)
+      expect(output).to match(/msg foo="{\\\"bar\\\":\\\"baz\\\"}"\n$/)
+    end
+
+    it "message with nested array" do
+      subject.info("msg", foo: ["bar", "baz"])
+      output = log.string
+      expect(output).to match(/^INFO/)
+      expect(output).to match(/\[\d{2}-\d{2}|\d{2}:\d{2}:\d{2}\]/)
+      expect(output).to match(/msg foo="\[\\\"bar\\\",\\\"baz\\\"\]"\n$/)
+    end
+  end
+
+  context "debug" do
+    it "simple message" do
+      subject.debug("msg", foo: "bar")
+      output = log.string
+      expect(output).to match(/^DBUG/)
+      expect(output).to match(/\[\d{2}-\d{2}|\d{2}:\d{2}:\d{2}\]/)
+      expect(output).to match(/msg foo="bar"\n$/)
+    end
+  end
+
+  context "sanitisation" do
+    it "sanitises a key" do
+      params = { "access_token" => "123456789012345678901234567890" }
+      Log15::Logger.sanitize(params, "access_token")
+      expect(params["access_token"]).to eq("123456****567890")
+    end
+
+    it "raises an error if key is not within a range" do
+      params = { "access_token" => "onetwo" }
+      expect do
+        Log15::Logger.sanitize(params, "access_token", expected_length: 8..24)
+      end.to raise_error(Log15::SanitizationError, "expected access_token to be between 8 and 24 characters long (is 6)")
+    end
+
+    it "doesn't sanitize a key if it doesn't exist" do
+      params = { "not_access_token" => "incognito" }
+      expect do
+        Log15::Logger.sanitize(params, "access_token")
+      end.to raise_error(Log15::SanitizationError, "expected access_token to be present")
+      expect(params).to eq(params)
+    end
+
+    it "doesn't sanitize a key if it is blank" do
+      params = { "access_token" => "" }
+      expect do
+        Log15::Logger.sanitize(params, "access_token")
+      end.to raise_error(Log15::SanitizationError, "expected access_token to not be blank")
+      expect(params).to eq(params)
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: log15
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ryan Bigg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Structured logging.
+email:
+- radar@lifx.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/log15.rb
+- lib/log15/logger.rb
+- lib/log15/version.rb
+- log15.gemspec
+- spec/log15/logger_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Structured logging.
+test_files:
+- spec/log15/logger_spec.rb
+has_rdoc: