biola_logs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c88ba89e5b0b199c4a3aefb09177eaae64625e8
+  data.tar.gz: 21aedaa234cc64351544c6beee922066d2f0dd31
+SHA512:
+  metadata.gz: 78d53ecc58bb570425e606fa806968c08efaf4f385f7a9be89b40f46750c7047c9f8f2f9477dfeddfdc32a0ff6ebb747c5fbb435c1cb42f6a086e6484b417cbf
+  data.tar.gz: eafc64f9f9541a096a3eecff8000c8b12a6c7dbb7de8ae741bbb3ac44afd2dcaeaf5be374dcd5bb5a2b3653c740fc7aef0cbdae89e9a8433e094886d57c6b80e

data/MIT-LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 by Biola University
+
+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,20 @@
+Biola Logs
+==========
+
+A simple gem to standardize log formatting across all our Rails apps
+
+Usage
+-----
+
+Add the following to your `Gemfile`
+
+```ruby
+gem 'biola_logs'
+```
+
+And you're done.
+
+License
+-------
+
+MIT

data/lib/biola_logs.rb

@@ -0,0 +1,8 @@
+require 'lograge'
+require 'biola_logs/generators'
+require 'biola_logs/generators/base'
+require 'biola_logs/generators/params'
+require 'biola_logs/railtie'
+
+module BiolaLogs
+end

data/lib/biola_logs/generators.rb

@@ -0,0 +1,15 @@
+module BiolaLogs
+  module Generators
+    def self.all
+      self.constants.map(&self.method(:const_get)).grep(Class) - [Base]
+    end
+
+    def self.handler
+      Proc.new do |event|
+        self.all.each_with_object({}) do |klass, hash|
+          hash.merge! klass.new(event).to_hash
+        end
+      end
+    end
+  end
+end

data/lib/biola_logs/generators/base.rb

@@ -0,0 +1,16 @@
+module BiolaLogs
+  module Generators
+    class Base
+      attr_reader :event
+
+      # event should quack like ActiveSupport::Notifications::Event
+      def initialize(event)
+        @event = event
+      end
+
+      def to_hash
+        raise ArgumentError, 'This method should be overridden in a subclass'
+      end
+    end
+  end
+end

data/lib/biola_logs/generators/params.rb

@@ -0,0 +1,27 @@
+module BiolaLogs
+  module Generators
+    class Params < Base
+      NON_QUERY_STRING_PARAMS = ['controller', 'action', 'id']
+      # We don't need form POST data in the logs since it can be very verbose.
+      SUPPORTED_HTTP_METHODS = ['GET']
+
+      def to_hash
+        if method_supported? && clean_params.any?
+          {params: clean_params.to_json}
+        else
+          {}
+        end
+      end
+
+      private
+
+      def clean_params
+        @clean_params ||= event.payload[:params].except(*NON_QUERY_STRING_PARAMS)
+      end
+
+      def method_supported?
+        SUPPORTED_HTTP_METHODS.include?(event.payload[:method])
+      end
+    end
+  end
+end

data/lib/biola_logs/railtie.rb

@@ -0,0 +1,8 @@
+module BiolaLogs
+  class Railtie < Rails::Railtie
+    initializer :biola_logs, before: :lograge do |app|
+      config.lograge.enabled = true
+      config.lograge.custom_options = Generators.handler
+    end
+  end
+end

data/lib/biola_logs/version.rb

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

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: biola_logs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Crownoble
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lograge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: Standardized, opinionated log formatting
+email: adam.crownoble@biola.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/biola_logs.rb
+- lib/biola_logs/generators.rb
+- lib/biola_logs/generators/base.rb
+- lib/biola_logs/generators/params.rb
+- lib/biola_logs/railtie.rb
+- lib/biola_logs/version.rb
+homepage: https://github.com/biola/biola-logs
+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: Standardized log formatter
+test_files: []