pepys 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5eee120a3b7177df9c00b15c5984e52d0e43d36
+  data.tar.gz: 0c89f815f2f8f09c63961352c0f6f9bab6aa977d
+SHA512:
+  metadata.gz: 8586dee9d97171b557868fff027c661eefc576867b1276efa0d244953f85ece53a13324525160d44443fa0881db52bf3cbfe1a46737d2fb76d21526b06c8bf6d
+  data.tar.gz: 5bef2e7f57f920cc7b3a9cbc081758b668e442784dfed5a8387411ad655055f000f932def67d0af611df19d69fdccbd9dc1bc9987ea256b52eac0bc97ce21a98

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at dev@caius.name. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Caius Durling
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Caius Durling
+
+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,46 @@
+# pepys
+
+Ruby Logger outputting JSON logs. Inspired by & compatible with [node-bunyan](https://github.com/trentm/node-bunyan)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pepys'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pepys
+
+## Usage
+
+```ruby
+require "pepys"
+
+logger = Pepys::Logger.new("example_script", STDOUT)
+logger.info "Example script started"
+logger.fatal "Example script aborted due to lack of code"
+# >> {"name":"example_script","pid":36279,"hostname":"Thrax","level":30,"time":"2016-09-15T22:48:30Z","msg":"Example script started","v":0}
+# >> {"name":"example_script","pid":36279,"hostname":"Thrax","level":60,"time":"2016-09-15T22:48:30Z","msg":"Example script aborted due to lack of code","v":0}
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/caius/pepys. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pepys"
+
+# 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/pepys.rb

@@ -0,0 +1,6 @@
+require "pepys/version"
+require "pepys/logger"
+
+module Pepys
+  LOG_FORMAT_VERSION = 0
+end

data/lib/pepys/formatter.rb

@@ -0,0 +1,46 @@
+require "json"
+require "time"
+
+module Pepys
+  class Formatter
+    LEVEL_MAPPINGS = {
+      "FATAL".freeze => 60,
+      "ERROR".freeze => 50,
+      "WARN" .freeze => 40,
+      "INFO" .freeze => 30,
+      "DEBUG".freeze => 20,
+      # "TRACE" => 10,
+    }.freeze
+
+    FORMAT_VERSION = 0
+
+    attr_reader :logger
+
+    def initialize(logger)
+      self.logger = logger
+    end
+
+    def call(level, timestamp, name, message)
+      data = logger.base_fields.merge(
+        level: level_number(level),
+        time: timestamp.utc.iso8601,
+        msg: message,
+        v: FORMAT_VERSION,
+      )
+
+      # Only override the default name if we have a value
+      data[:name] = name if name
+
+      JSON.dump(data) + "\n"
+    end
+
+    private
+
+    attr_writer :logger
+
+    def level_number(name)
+      # Defaults to INFO if unknown
+      LEVEL_MAPPINGS.fetch(name, 30)
+    end
+  end
+end

data/lib/pepys/logger.rb

@@ -0,0 +1,43 @@
+require "logger"
+require "socket"
+require "pepys/formatter"
+
+module Pepys
+  class Logger
+    REFUSE_TO_FORWARD = %i(formatter=)
+
+    attr_reader :hostname, :program_name
+
+    def initialize(program_name, io, hostname: Socket.gethostname)
+      self.program_name = program_name
+      self.hostname = hostname
+      self.logger = ::Logger.new(io)
+      logger.formatter = Formatter.new(self)
+    end
+
+    def base_fields
+      {
+        name: program_name,
+        pid: Process.pid,
+        hostname: hostname,
+      }
+    end
+
+    def respond_to_missing?(meffod)
+      logger.respond_to?(meffod) && !REFUSE_TO_FORWARD.include?(meffod)
+    end
+
+    def method_missing(meffod, *args)
+      return super if REFUSE_TO_FORWARD.include?(meffod)
+
+      if block_given?
+        logger.public_send(meffod, *args, &Proc.new)
+      else
+        logger.public_send(meffod, *args)
+      end
+    end
+
+    private
+    attr_accessor :hostname, :logger, :program_name
+  end
+end

data/lib/pepys/version.rb

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

data/pepys.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pepys/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pepys"
+  spec.version       = Pepys::VERSION
+  spec.authors       = ["Caius Durling"]
+  spec.email         = %w(dev@caius.name)
+
+  spec.summary       = %{Logger that emits JSON}
+  spec.description   = %{Inspired by node-bunyan, compatible with stdlib's Logger API}
+  spec.homepage      = "https://github.com/caius/pepys"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "json"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: pepys
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caius Durling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-16 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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'
+description: Inspired by node-bunyan, compatible with stdlib's Logger API
+email:
+- dev@caius.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pepys.rb
+- lib/pepys/formatter.rb
+- lib/pepys/logger.rb
+- lib/pepys/version.rb
+- pepys.gemspec
+homepage: https://github.com/caius/pepys
+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.6.6
+signing_key: 
+specification_version: 4
+summary: Logger that emits JSON
+test_files: []