footprint-log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5cf211c57f05def50f656c737306176effeb084
+  data.tar.gz: fa7ece836a764e7be0fa5ef81ab3e9358e0788df
+SHA512:
+  metadata.gz: 24279ab4bcad20cc11ec2e505bd94066ae9cae8cabc9e2cc6198263d647c36bbf139aeec8175662ee7418aeca5eeea3fc0aba3f17aae5562960459db84cd2b76
+  data.tar.gz: ca646b801ac3d0313efa532c9d57ac4d63049feed5ed567d9898fa8ede431f5f9a796a55867c1af4e5944bc0009df2635fe1d350135fea34a61cd5a80cd479d6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Puiu Ionut
+
+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.rdoc

@@ -0,0 +1,114 @@
+= Footprint (Beta)
+Rack Application Logging Tools
+
+{<img src="https://travis-ci.org/ipuiu/footprint-log.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/ipuiu/footprint-log]
+{<img src="https://gemnasium.com/ipuiu/footprint-log.svg" alt="Dependency Status" />}[https://gemnasium.com/ipuiu/footprint-log]
+{<img src="https://codeclimate.com/github/ipuiu/footprint-log/badges/gpa.svg" />}[https://codeclimate.com/github/ipuiu/footprint-log]
+{<img src="https://coveralls.io/repos/ipuiu/footprint-log/badge.png?branch=master" alt="Coverage Status" />}[https://coveralls.io/r/ipuiu/footprint-log?branch=master]
+{<img src="http://inch-ci.org/github/ipuiu/footprint-log.svg?branch=master" alt="Inline docs" />}[http://inch-ci.org/github/ipuiu/footprint-log]
+
+== What is "Footprint" ?
+
+Footprint was started by the need to have a simple and smart way to deal with the logs.
+
+It is composed of:
+
+    require 'footprint/log' # some custom loggers.
+    require 'footprint/middleware' # middleware used to decorate Rack applications.
+
+== How to use it ?
+
+First you should add the gem to your Gemfile:
+
+    gem 'footprint-log'
+
+=== Basic Usage
+
+Let's say that we don't care about what logger we use, and we just wish a logger method in our app that acts like a logger instance.
+
+In that case we can do something like this:
+
+    require 'sinatra'
+    require 'footprint/middleware'
+
+    class MyApp < Sinatra
+
+        use Footprint::Middleware
+
+        get '/' do
+            logger.info 'I can use logger method inside my route!'
+        end
+
+    end
+
+=== Advanced Usage
+
+Let's say that we care about what logger we use, and we also wish a logger method in our app that acts like a logger instance.
+
+Let's assume we want to use a instance of the Logger class, initialized with log_device as STDOUT.
+
+In that case we can do something like this:
+
+    require 'sinatra'
+    require 'footprint/middleware'
+
+    class MyApp < Sinatra
+
+        use Footprint::Middleware do
+            set Logger, STDOUT
+        end
+
+        get '/' do
+            logger.info 'I can use a instance of Logger class, initialized with STDOUT option by calling the logger method inside my route!'
+        end
+
+    end
+
+
+Let's assume we want to use the following custom Logger class, initialized with log_device as STDOUT and level as 5.
+
+    class MyAwesomeLogger
+
+        attr_accesor :log_device, :level
+
+        def initialize log_device, level
+           @log_device = log_device
+           @level = level
+        end
+
+    end
+
+
+In that case we can do something like this:
+
+    require 'sinatra'
+    require 'footprint/middleware'
+
+    class MyApp < Sinatra
+
+        use Footprint::Middleware do
+            set MyAwesomeLogger, [STDOUT,5]
+        end
+
+        get '/' do
+            logger.info 'I can use a instance of MyAwesomeLogger class, initialized with STDOUT, 5 option by calling the logger method inside my route!'
+        end
+
+    end
+
+
+== Contributing to footprint
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Puiu Ionut. See LICENSE.txt for
+further details.
+

data/lib/footprint.rb

@@ -0,0 +1,9 @@
+require_relative 'footprint/log'
+
+module Footprint
+
+  attr_accessor :logger
+
+end
+
+

data/lib/footprint/log.rb

@@ -0,0 +1,4 @@
+require_relative 'log/basic'
+require_relative 'log/error_file'
+require_relative 'log/out_file'
+require_relative 'log/gelf'

data/lib/footprint/log/basic.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+module Footprint
+
+  module Log
+
+    class Basic < Logger
+
+      def initialize logdev = nil, shift_age = 0, shift_size = 1048576
+        super
+      end
+
+    end
+
+  end
+
+end

data/lib/footprint/log/error_file.rb

@@ -0,0 +1,17 @@
+require_relative 'basic'
+
+module Footprint
+
+  module Log
+
+    class ErrorFile < Basic
+
+      def write(message)
+        error message
+      end
+
+    end
+
+  end
+
+end

data/lib/footprint/log/gelf.rb

@@ -0,0 +1,13 @@
+require 'gelf'
+
+module Footprint
+
+  module Log
+
+    class Gelf < GELF::Logger
+
+    end
+
+  end
+
+end

data/lib/footprint/log/out_file.rb

@@ -0,0 +1,17 @@
+require_relative 'basic'
+
+module Footprint
+
+  module Log
+
+    class OutFile < Basic
+
+      def write(message)
+        info message
+      end
+
+    end
+
+  end
+
+end

data/lib/footprint/middleware.rb

@@ -0,0 +1 @@
+require_relative 'middleware/logger'

data/lib/footprint/middleware/logger.rb

@@ -0,0 +1,35 @@
+require_relative '../log'
+
+
+module Footprint
+
+  class Middleware
+
+    attr_accessor :app, :logger
+
+    def initialize(app, &block)
+
+      @app = app
+
+      set Footprint::Log::Basic, STDOUT
+
+      @app.class.send(:define_method, :logger,
+                      Proc.new do
+                        @env[:footprint_logger]
+                      end)
+
+      self.instance_eval &block if block
+    end
+
+    def call(env)
+      env[:footprint_logger] = @logger
+      @app.call env
+    end
+
+    def set clazz, options=nil
+      @logger = clazz.send(:new, options)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: footprint-log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Puiu Ionut
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gelf
+  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: rake
+  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: simplecov
+  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: rspec
+  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: rack
+  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: jeweler
+  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: coveralls
+  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: Provides functionality to decorate Rack applications like Sinatra with
+  loggers.
+email: ii.puiuionut@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/footprint.rb
+- lib/footprint/log.rb
+- lib/footprint/log/basic.rb
+- lib/footprint/log/error_file.rb
+- lib/footprint/log/gelf.rb
+- lib/footprint/log/out_file.rb
+- lib/footprint/middleware.rb
+- lib/footprint/middleware/logger.rb
+- LICENSE.txt
+- README.rdoc
+homepage: http://github.com/ipuiu/footprint-log
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Rack Application Log Decorator.
+test_files: []