nypl_log_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60730bd69179897e8034dc0f71f6fab5aedf28daebe19922bbad9d344d3b2ea6
+  data.tar.gz: aa18c24a46170dcff292a9b22d0e9770e80dc6fee537efa6ceb5bde2bae00ccb
+SHA512:
+  metadata.gz: 1afcdc8a0d9245e73fe0404d0b581ba018dc4d4cbe51b649270241fd777b254e4aec815e813826c10efc7c8bbf5e6a398ea097fc6a83412adb9d9916ab6dd1b8
+  data.tar.gz: 1fcb2c3cad872e2d8eedd39481f232740dad491705bc0cf4a831dd5a25f4399dacd9a6c83c3dae6d6c6501d92220015462236f53b7027b1d0b233a73b268e390

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+nypl_log_formatter

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# NyplLogFormatter
+
+This is a logger that logs according to [NYPL's agreed-upon format](https://github.com/NYPL/engineering-general/blob/master/standards/logging.md).  
+It is a subclass of the stdlib Logger class, so it works exactly as a regular Logger does.
+The only advantage to subclassing is that we can bake in [custom formatting](https://stackoverflow.com/questions/14382252/how-to-format-ruby-logger).
+
+## Ruby Version Support
+
+This has only been tested against ruby 2.4.1 but _should_ work in ruby 2.x.
+We should have a very basic test suite and run it across multiple ruby versions
+using a CI service like Travis.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nypl_log_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nypl_log_formatter
+
+## Usage
+
+```ruby
+require 'nypl_log_formatter'
+
+my_logger = NyplLogFormatter.new('path/to/file.log')
+my_logger.info('this will log JSON')
+my_logger.warn('So will this')
+
+# Contents of file.log
+  # Logfile created on 2018-01-17 15:51:31 -0500 by logger.rb/61378
+  #{"level":"INFO","message":"this will log JSON","timestamp":"2018-01-17T15:51:53.481-0500"}
+  #{"level":"WARN","message":"So will this","timestamp":"2018-01-17T15:51:54.279-0500"}
+```
+
+### Instantiating A Logger
+
+The constructor (and all other methods, really) of NyplLogFormatter are the same as a Logger.
+Which means you can do EVERYTHING you can with a `Logger`, in the same way.
+That includes:
+
+* Setting Log level
+* Using `STDOUT` instead of a file.
+* Setting log rotation.
+
+For more info see your ruby version's documentation for the `Logger` class.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nypl/ruby_nypl_log_formatter.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nypl_log_formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nypl_log_formatter/version.rb

@@ -0,0 +1,3 @@
+module NyplLogFormatterVersion
+  VERSION = "0.1.0"
+end

data/lib/nypl_log_formatter.rb

@@ -0,0 +1,28 @@
+require 'nypl_log_formatter/version'
+require 'logger'
+require 'json'
+
+class NyplLogFormatter < ::Logger
+
+  include NyplLogFormatterVersion
+
+  def initialize(*args)
+    super(*args)
+    # This has to happen _after_ call to super, otherwise ::Logger will set the formatter
+    set_formatter
+  end
+
+private
+
+  def set_formatter
+    self.formatter = proc do |severity, datetime, progname, msg|
+      message_hash = {
+        level:     severity.upcase,
+        message:   msg,
+        timestamp: Time.now.strftime("%Y-%m-%dT%H:%M:%S.%L%z")
+      }
+      "#{JSON.generate(message_hash)}\n"
+    end
+  end
+
+end

data/nypl_log_formatter.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require File.join(__dir__, 'lib', 'nypl_log_formatter', 'version')
+
+Gem::Specification.new do |spec|
+  spec.name          = "nypl_log_formatter"
+  spec.version       = NyplLogFormatterVersion::VERSION
+  spec.authors       = ["nodanaonlyzuul"]
+  spec.email         = ["stephenschor@nypl.org"]
+
+  spec.summary       = %q{A logger that conforms to NYPL's formatting standard}
+  spec.homepage      = "https://github.com/NYPL/ruby_nypl_log_formatter"
+
+  # To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry", '~> 0.11.3'
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: nypl_log_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- nodanaonlyzuul
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+description: 
+email:
+- stephenschor@nypl.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nypl_log_formatter.rb
+- lib/nypl_log_formatter/version.rb
+- nypl_log_formatter.gemspec
+homepage: https://github.com/NYPL/ruby_nypl_log_formatter
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.3
+signing_key: 
+specification_version: 4
+summary: A logger that conforms to NYPL's formatting standard
+test_files: []