fluent_logger_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6a88bc428967e9ee7c2f81f9e747b0cc868f52fe9158587c4c847f1516c43d59
+  data.tar.gz: 175d618a1cc6cd67e7c137b02328040e256c8f8e101e6d8786501227792453fe
+SHA512:
+  metadata.gz: a1557f1bb328c7525b9c7341898c8cfeebe4646a1b2d0741b09cc7e65ae3e2e1de6654b59d8abd1b50818b9e94c2ddc8c95fd3bb40c9d08daf3d632cdf74f11b
+  data.tar.gz: ad952d449c9c9e53e3ac59da6da928cb1a34fd01fa4d34d9a2fce3d4160a48b3cca22fe75517b8b62144ae21a878e962abc915a21a97446bb9bc9919a79d6687

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Rubymine
+/.idea
+.rakeTasks

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=progress

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## Unreleased Changes
+
+[Full Changelog](https://github.com/Hacker0x01/fluent_logger_rails/compare/master)
+
+Bug Fixes:
+
+* None
+
+Enhancements:
+
+* Add a rake task to walk through your table/columns and easily classify and create a migration from it
+* Add a migration generator
+* Module helper to include in migrations to add data classification smart comment 
+
+Deprecations:
+* None

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@hackerone.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    fluent_logger_rails (0.1.0)
+      activesupport (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fluent_logger_rails!
+  pry
+  rspec (~> 3.6)
+  timecop
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 HackerOne Inc.
+
+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/fluent_logger_rails.gemspec

@@ -0,0 +1,35 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "fluent_logger_rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = 'fluent_logger_rails'
+  spec.version     = FluentLoggerRails::VERSION
+  spec.date        = '2020-07-14'
+  spec.summary     = "A wrapper for fluent-logger gem to support tagged logging"
+  spec.description = "A simple hello world gem"
+  spec.authors     = ["HackerOne Open Source", "Ben Willis"]
+  spec.email       = ["opensource+fluent_logger_rails@hackerone.com", "ben@hackeroen.com"]
+  spec.homepage      = "https://github.com/Hacker0x01/fluent_logger_rails"
+
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.add_dependency('activesupport', '~> 5.0')
+
+  spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'timecop'
+  spec.add_development_dependency 'pry'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Hacker0x01/fluent_logger_rails"
+  spec.metadata["changelog_uri"] = "https://github.com/Hacker0x01/fluent_logger_rails/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+end

data/lib/fluent_logger_rails.rb

@@ -0,0 +1,5 @@
+require 'fluent_logger_rails/logger'
+require 'fluent_logger_rails/tagged_logging'
+require 'fluent_logger_rails/hash_formatter'
+require 'fluent_logger_rails/json_formatter'
+require 'fluent_logger_rails/pretty_json_formatter'

data/lib/fluent_logger_rails/hash_formatter.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+class HashFormatter
+  def call(severity, timestamp, _progname, msg)
+    severity_display = if severity.blank?
+      'ANY'
+    elsif severity.is_a? Integer
+      ActiveSupport::Logger::SEV_LABEL[severity]
+    else
+      severity
+    end
+
+    {
+      severity: severity_display,
+      timestamp: timestamp.in_time_zone.strftime('%Y-%m-%d %H:%M:%S.%3N%z'),
+      message: msg.is_a?(String) ? msg.strip : msg,
+    }.merge(compact_tags)
+  end
+
+  def tagged(*tags)
+    add_tags(*tags)
+    yield self
+  ensure
+    remove_tags(*tags)
+  end
+
+  def add_tags(*tags)
+    tags = tags.first if tags.length == 1
+
+    if tags.is_a? Array
+      current_tags[:tags] ||= []
+      current_tags[:tags] += tags
+    elsif tags.is_a? String
+      current_tags[:tags] ||= []
+      current_tags[:tags] << tags
+    else
+      current_tags.merge! tags
+    end
+  end
+
+  def remove_tags(*tags)
+    tags = tags.first if tags.length == 1
+
+    if tags.is_a? Array
+      current_tags[:tags] ||= []
+      tags.each { |tag| current_tags[:tags].delete(tag) }
+    elsif tags.is_a? String
+      current_tags[:tags] ||= []
+      current_tags[:tags].delete(tags)
+    else
+      tags.each_key { |key| current_tags.delete(key) }
+    end
+  end
+
+  def clear_tags!
+    current_tags.clear
+  end
+
+  def current_tags
+    # We use our object ID here to avoid conflicting with other instances
+    thread_key = @thread_key ||= "fluent_logger_rails:#{object_id}"
+    Thread.current[thread_key] ||= {}
+  end
+
+  def compact_tags
+    current_tags.delete_if { |_k, v| v.blank? }
+  end
+end

data/lib/fluent_logger_rails/json_formatter.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class JsonFormatter < HashFormatter
+  def call(severity, timestamp, progname, msg)
+    super(severity, timestamp, progname, msg).to_json
+  end
+end

data/lib/fluent_logger_rails/logger.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'active_support'
+
+module FluentLoggerRails
+  class Logger < ::ActiveSupport::Logger
+    def initialize(logger, path:, level:)
+      @level = SEV_LABEL.index(level.to_s.upcase)
+      @path = path
+      @logger = logger
+      after_initialize if respond_to? :after_initialize
+    end
+
+    def add(severity, message = nil, progname = nil)
+      return true if severity < @level
+
+      message = (block_given? ? yield : progname) if message.blank?
+      return true if message.blank?
+
+      message = format_message(severity, Time.now, progname, message)
+      message = { message: message } unless message.is_a? Hash
+
+      @logger.post(@path, message)
+      true
+    end
+
+    def close
+      @logger.close
+    end
+  end
+end

data/lib/fluent_logger_rails/pretty_json_formatter.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class PrettyJsonFormatter < HashFormatter
+  def call(severity, timestamp, progname, msg)
+    JSON.pretty_generate(super(severity, timestamp, progname, msg))
+  end
+end

data/lib/fluent_logger_rails/tagged_logging.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module FluentLoggerRails
+  module TaggedLogging
+    def self.new(logger, format: :hash)
+      logger.formatter = if format == :hash
+        HashFormatter.new
+      elsif format == :pretty_json
+        PrettyJsonFormatter.new
+      elsif format == :json
+        JsonFormatter.new
+      else
+        fail "Unrecognized log format: '#{format}'"
+      end
+
+      logger.extend(self)
+    end
+
+    delegate :add_tags, :remove_tags, :clear_tags!, to: :formatter
+
+    def tagged(*tags)
+      formatter.tagged(*tags) { yield self }
+    end
+
+    def flush
+      clear_tags!
+      super if defined?(super)
+    end
+  end
+end

data/lib/fluent_logger_rails/version.rb

@@ -0,0 +1,3 @@
+module FluentLoggerRails
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: fluent_logger_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- HackerOne Open Source
+- Ben Willis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple hello world gem
+email:
+- opensource+fluent_logger_rails@hackerone.com
+- ben@hackeroen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- fluent_logger_rails.gemspec
+- lib/fluent_logger_rails.rb
+- lib/fluent_logger_rails/hash_formatter.rb
+- lib/fluent_logger_rails/json_formatter.rb
+- lib/fluent_logger_rails/logger.rb
+- lib/fluent_logger_rails/pretty_json_formatter.rb
+- lib/fluent_logger_rails/tagged_logging.rb
+- lib/fluent_logger_rails/version.rb
+homepage: https://github.com/Hacker0x01/fluent_logger_rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Hacker0x01/fluent_logger_rails
+  source_code_uri: https://github.com/Hacker0x01/fluent_logger_rails
+  changelog_uri: https://github.com/Hacker0x01/fluent_logger_rails/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A wrapper for fluent-logger gem to support tagged logging
+test_files: []