minodes-sinatra-logger 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f96224693b423f1410eebfe611aceba9495d7830
+  data.tar.gz: cfdc724ad9a2b6d4824327c4c1fe8f53fe8bb985
+SHA512:
+  metadata.gz: 6706476a5dadd4e37d1fbd2bbcd7fe5c539de616ada0b6ac95a2ae418002165567eff500ca172169f43e9e2aff2aa78c9ae33cece8fb62f24862375641faccfb
+  data.tar.gz: 257a09432d01ff98d1e2b310ba86df73196f3b9e5eb87797529c746d626a0664b4c19640ef24c714be274607ec8145d5d52b361f2dbe87c6f800641a58898885

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yehya Abouelnaga
+
+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,84 @@
+# Sinatra Logger
+
+For those who dealt with Sinatra Logging, and tried to configure it correctly (i.e. have Access logs, Error logs, and the normal `logger` functionality), they know how messy that is. Sinatra logging configuration is painful. To get a better understanding, refer to:
+* http://recipes.sinatrarb.com/p/middleware/rack_commonlogger (Just logs the access logs)
+* https://spin.atomicobject.com/2013/11/12/production-logging-sinatra/ (This goes further to add Errors to the logs as well. However, this breaks with modular Sinatra applications)
+* http://stackoverflow.com/questions/5995854/logging-in-sinatra (Or, just outdated answers)
+* https://github.com/kematzy/sinatra-logger (Or, outdated libraries)
+
+If you come from a Rails background, you are probably used to the simplicity of:
+```
+logger.info "some info"
+logger.debug "some debugging"
+...
+```
+
+We offer a slightly "better looking" option using our library.
+
+### Dependency
+This library is an interface for `SemanticLogger` library (found here: https://github.com/rocketjob/semantic_logger). It just does the wiring for your `Sinatra` app, and gets you up and running with a simple line of code.
+
+Please, check the `SemanticLogger` (http://rocketjob.github.io/semantic_logger/) to get a glimpse of their pretty neat logging solution.
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minodes-sinatra-logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minodes-sinatra-logger
+
+### Usage
+
+We assume that you use either: `Sinatra::Base` or `Sinatra::Application`.
+#### One-layer Applications
+```
+class MyApp < Sinatra::Base
+  logger filename: "log/#{settings.environment}.log", level: :trace
+
+  # ... remaining code ...
+end
+```
+
+#### Multi-layered Applications (Modular Applications)
+```
+class App1 < Sinatra::Application
+  # ... some App1 routes/code ...
+end
+
+class App2 < Sinatra::Application
+  # ... some App1 routes/code ...
+end
+
+class ContainerApp < Sinatra::Application
+  logger filename: "log/#{settings.environment}.log", level: :trace
+
+  use App1
+  use App2
+
+  # ... remaining code ...
+end
+```
+
+**NOTE**: You need to only use `logger filename: "", level: :trace` only once (precisely in the container app).
+
+### Development
+
+This gem is still in its beta phase. If you spot any errors, or propose some improvements, contact us: github [at] minodes [dot] com
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/minodes/sinatra-logger. We would love to see your suggestions, fixes or improvements.
+
+
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,45 @@
+require "minodes/sinatra/logger/version"
+require "sinatra"
+require "rack"
+require 'rack/body_proxy'
+require 'rack/utils'
+require "semantic_logger"
+require "logger"
+
+module Minodes
+  module Sinatra
+    class ErrorLogger
+      def puts(msg)
+        SemanticLogger["Error"].error msg
+      end
+    end
+
+    module Logger
+      ::Sinatra::Base.class_eval do
+        def self.logger(config)
+          if config[:filename].nil?
+            raise "Minodes::Sinatra::Logger -- File name is not specified. Please, set `file_name` in the configuration block!"
+          end
+
+          config[:level] ||= :trace
+
+          ::SemanticLogger.default_level = config[:level]
+          ::SemanticLogger.appenders.each { |a| ::SemanticLogger.remove_appender(a) }
+          ::SemanticLogger.add_appender(file_name: config[:filename], formatter: :color)
+
+          set :logging, true
+          use ::Rack::CommonLogger, ::SemanticLogger["Access"]
+
+          ::Sinatra::Base.before do
+            ::SemanticLogger.default_level = config[:level]
+            ::SemanticLogger.appenders.each { |a| ::SemanticLogger.remove_appender(a) }
+            ::SemanticLogger.add_appender(file_name: config[:filename], formatter: :color)
+
+            env["rack.errors"] = ::Minodes::Sinatra::ErrorLogger.new
+            env["rack.logger"] = ::SemanticLogger[self.class.name]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/minodes/sinatra/logger/version.rb

@@ -0,0 +1,7 @@
+module Minodes
+  module Sinatra
+    module Logger
+      VERSION = "0.2.1"
+    end
+  end
+end

data/minodes-sinatra-logger.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minodes/sinatra/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minodes-sinatra-logger"
+  spec.version       = Minodes::Sinatra::Logger::VERSION
+  spec.authors       = ["Yehya Abouelnaga"]
+  spec.email         = ["yehya.abouelnaga@minodes.com"]
+
+  spec.summary       = %q{A gem that wires `SemanticLogger` to Sinatra painlessly}
+  spec.description   = %q{Sinatra Logging is a pain. This gem helps with wiring Access logs, Error logs, and plain debugging logs (i.e. logger.info, logger.warn, ... etc).}
+  spec.homepage      = "https://github.com/minodes/sinatra-logger"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "http://rubygems.com"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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 = ["lib"]
+
+  spec.add_dependency "semantic_logger"
+  spec.add_dependency "sinatra"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: minodes-sinatra-logger
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Yehya Abouelnaga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  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: sinatra
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Sinatra Logging is a pain. This gem helps with wiring Access logs, Error
+  logs, and plain debugging logs (i.e. logger.info, logger.warn, ... etc).
+email:
+- yehya.abouelnaga@minodes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minodes/sinatra/logger.rb
+- lib/minodes/sinatra/logger/version.rb
+- minodes-sinatra-logger.gemspec
+homepage: https://github.com/minodes/sinatra-logger
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A gem that wires `SemanticLogger` to Sinatra painlessly
+test_files: []