bamm_log 0.0.5

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MjYxNTE0ZjU1ZGEzYjg0MWJmOWU2MzI2YjJhYzkyNzgzNzdmZDA3YQ==
+  data.tar.gz: !binary |-
+    MDgyNWU5NDFiOTE2N2QxOGEwZjc5YTBkODQ1NmIwMDA5ZGE3OTg2MQ==
+SHA512:
+  metadata.gz: !binary |-
+    NTAzMjU1NjE2NGVlYjc5YTk3Mjg4NDFiMjIyZmI4MWM3MmYwNmQ1NmQ0Nzk1
+    ZDA0N2ViOTQwZDk2NzA1NDRhOGQyMjA2ZWExYTM3YzY4N2JmMWExM2RlNzIy
+    NjJmOWQ2Nzk1ZTAyODdjOTc0ZGQ1ZWUxODgzZWUwYWQzMzBkNTg=
+  data.tar.gz: !binary |-
+    NDJmOTA4MjUwNmFiOTFkZjMzZjAwYjllNjEwMzE3OTgyOWVkZmMwY2UzOTU4
+    NTJlMjNkZGZlZjM1OGUyZDE3OTlkNTQyNDc0Mzc3YjUyMmQxMTZjM2YwMWYy
+    Y2JmMjkxY2RlNWI0MjhmNGNhMjkxMTlmYjVmNDFhZmY2ZDhlZGI=

data/LICENCE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 joaquimadraz
+
+MIT License
+
+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,75 @@
+# Bamm Log
+
+Who doen't need to log what's going on in your Modular Sinatra App? Well.. I need.
+By default sinatra logs this:
+
+
+> <sub>127.0.0.1 - - [25/Aug/2014 17:23:11] "GET /page HTTP/1.1" 200 6736 2.5322</sub><br />
+> <sub>127.0.0.1 - - [25/Aug/2014 17:24:33] "POST /create HTTP/1.1" 200 5833 0.0198</sub>
+
+
+/create with which params? 
+
+> <sub>127.0.0.1 - - [25/Aug/2014 17:24:33] "POST /error HTTP/1.1" 500 5443 0.1238</sub>
+
+This page returns 500 for what? You can check our apage error.log file or you can log everything in one file, like Rails!
+
+
+After reading some implementations, I joined some ideas and created this gem.
+It's not tested yet, so.. don't use it on production.
+
+
+> <sub>[2014-08-25 16:03:43 +0000] Started GET "/page?page=1&per_page=99"</sub><br />
+> <sub>[2014-08-25 16:03:43 +0000] Parameters: {"page"=>"1", "per_page"=>"99"}</sub>
+
+
+> <sub>[2014-08-25 17:36:59 +0000] Started POST "/create"</sub><br />
+> <sub>[2014-08-25 17:36:59 +0000] Parameters: {"page"=>{ "title" => "Nice and Clean" }}</sub>
+
+
+> <sub>[2014-08-25 17:36:59 +0100] Started GET "/v0/page?page=1&per_page=99"</sub><br />
+> <sub>[2014-08-25 17:36:59 +0100] Parameters: {"page"=>"1", "per_page"=>"99"}</sub><br />
+> <sub>[2014-08-25 17:37:05 +0100] Bamm! RuntimeError: bamm error</sub><br />
+> <sub>[2014-08-25 17:37:05 +0100] /app/routes/page.rb:4:in `block in <class:App>'</sub>
+
+> <sub>extended backtrace...</sub>
+ 
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bamm_log'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bamm_log
+
+## Usage
+
+    class RequisitionsService < Sinatra::Base
+
+      configure :staging do
+        include BammLog::Logger
+      end
+
+      # if you want to user logger in your application,
+      # being logged to the same "environment".log file
+      def logger
+        BammLog.logger
+      end
+
+    end
+    
+This will create a file with the name "environment".log (ex: staging.log) and log all the accesses and errors from you application.
+
+## Contributing
+
+1. Fork it ( http://github.com/joaquimadraz/bamm_log/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hola.gemspec

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bamm_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bamm_log"
+  spec.version       = BammLog::VERSION
+  spec.authors       = ["Joaquim Adráz"]
+  spec.email         = ["joaquim.adraz@gmail.com"]
+  spec.summary       = %q{Not so experimental Sinatra Logger}
+  spec.homepage      = "https://github.com/joaquimadraz/bamm_log"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/bamm_log}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry"
+end

data/lib/bamm_log/exception_middleware.rb

@@ -0,0 +1,40 @@
+module BammLog
+  class ExceptionMiddleware
+
+    def initialize(app, options={})
+      @app  = app
+    end
+
+    def call(env)
+
+      begin
+        BammLog.logger.info "Started #{env['REQUEST_METHOD']} \"#{env['REQUEST_URI']}\""
+        BammLog.logger.info "Parameters: #{request_params(env).inspect}"  
+        @app.call(env)
+      rescue Exception => e
+        log_exception env['sinatra.error']
+        @app.call(env)
+      end
+      
+    end
+
+    private
+
+    def request_params(env)
+      if env['REQUEST_METHOD'] == 'POST'
+        env['rack.request.form_hash']
+      else
+        Rack::Utils.parse_nested_query(env['QUERY_STRING'])
+      end
+    end
+
+    def log_exception(e)
+      BammLog.logger.info "Bamm! #{e.class}: #{e.message}"
+      
+      e.backtrace.each do |line|
+        BammLog.logger.info "#{line}"
+      end
+    end
+
+  end
+end

data/lib/bamm_log/formatter.rb

@@ -0,0 +1,23 @@
+module BammLog
+  module Formatter
+
+    def get_message(msg)
+      "#{String === msg ? msg : msg.inspect}"
+    end
+
+    def call_formatted(stamp, msg)
+      "[#{stamp.to_s(:log)}] #{msg}\n"
+    end
+
+    def included(klass)
+      ::Logger::Formatter.module_eval do
+        def call(severity, timestamp, progname, msg)
+          Formatter.call_formatted timestamp, Formatter.get_message(msg)
+        end
+      end
+    end
+  
+    extend self
+
+  end
+end

data/lib/bamm_log/version.rb

@@ -0,0 +1,3 @@
+module BammLog
+  VERSION = "0.0.5"
+end

data/lib/bamm_log.rb

@@ -0,0 +1,40 @@
+require_relative 'bamm_log/exception_middleware'
+require_relative 'bamm_log/formatter'
+require_relative 'bamm_log/version'
+
+module BammLog
+  module Logger
+
+    def self.included(klass)
+      @klass = klass
+
+      def self.instance
+        @instance ||= ::Logger.new(log_file).tap do |logger|
+          ::Logger.class_eval { alias :write :'<<' }
+          logger.level = ::Logger::INFO
+        end
+      end
+
+      def self.log_file
+        @log_file ||= File.new("#{@klass.root}/log/#{@klass.environment}.log", 'a+').tap do |log_file|
+          log_file.sync = true
+        end
+      end
+
+      klass.include(BammLog::Formatter)
+      
+      klass.configure do
+        klass.enable :logging
+        klass.use Rack::CommonLogger, BammLog::Logger.instance
+        klass.use BammLog::ExceptionMiddleware
+      end
+    end
+  
+  end
+
+  def logger
+    BammLog::Logger.instance
+  end
+
+  extend self
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: bamm_log
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Joaquim Adráz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !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: 
+email:
+- joaquim.adraz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENCE.txt
+- README.md
+- Rakefile
+- hola.gemspec
+- lib/bamm_log.rb
+- lib/bamm_log/exception_middleware.rb
+- lib/bamm_log/formatter.rb
+- lib/bamm_log/version.rb
+- pkg/bamm_log-0.0.1.gem
+- pkg/bamm_log-0.0.2.gem
+- pkg/bamm_log-0.0.3.gem
+- pkg/bamm_log-0.0.4.gem
+homepage: https://github.com/joaquimadraz/bamm_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.2.0
+signing_key: 
+specification_version: 4
+summary: Not so experimental Sinatra Logger
+test_files: []
+has_rdoc: