stump 2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bae9bf51d8252bdbd0e75dbfcb11b94f111b0689
+  data.tar.gz: 2285b5967d3c8e00954d2e8a8af005439cbde24e
+SHA512:
+  metadata.gz: c379a2251d772b2508e5e4f7da346a1813127c207b52f19761610919338e6b622cf1ac4efce42bfc01e6d077ea01fa588a6034aa1138cab2e734facc2d5833b5
+  data.tar.gz: 5eb5bc706323e897773399c62a0f76e6d1477a353a74e2ae88e11e6756887d087e8d7d21e3c5798f4604c724fb0b9bc6d3bdcff733e56869d79821e158c5d146

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/*
+.github_token
+.idea/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stump.gemspec
+gemspec
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nicolay Hvidsten
+
+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,69 @@
+# Stump
+
+[![Code Climate](https://codeclimate.com/github/nicohvi/stump.png)](https://codeclimate.com/github/nicohvi/stump)
+[![Build Status](https://travis-ci.org/nicohvi/stump.png?branch=master)](https://travis-ci.org/nicohvi/stump)
+[![Dependency Status](https://gemnasium.com/nicohvi/stump.png)](https://gemnasium.com/nicohvi/stump)
+[![Gem Version](https://badge.fury.io/rb/stump.png)](http://badge.fury.io/rb/stump)
+
+Stump is a minimal wrapper around the basic ruby `logger` that provides
+logging to a log file in addition to STDOUT - something which is for some reason
+rather hard to do for rack-based applications not using Rails. It also provides
+an `access_log` which you can write to STDOUT and (if you wish) a log file.
+
+Why call it Stump? It's like a small (tree) log, get it? Get it?
+
+## Usage
+
+````
+# Gemfile
+gem 'stump'
+
+# configuration file for your rack-based application
+require 'stump'
+
+logger = Stump::Logger.new
+use Stump::AccessLog, logger
+
+````
+
+## Example
+The following example demonstrates usage of `stump`in a vanilla, minimal
+`sinatra` application. You can *literally* copy this code and run the example
+in less than a minute.
+
+````
+# Gemfile
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'stump'
+
+# hi.rb
+require 'sinatra'
+require 'stump'
+
+logger = Stump::Logger.new "tmp/log.log"
+logger.level = Logger::DEBUG
+use Stump::AccessLog, logger
+
+get '/hi' do
+  logger.debug 'hello'
+  'What came first - the cat or the internet?'
+end
+
+````
+
+Run `bundle` and `ruby hi.rb`, point your brower to `localhost:4567/hi`
+and witness the magic.
+
+
+## Issues
+
+"Hey, it's not working!"
+
+This can totally happen, so just open up an issue and I'll get right on it!
+
+
+## License
+
+Copyright (c) @nicovhi, released under the MIT License.

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+RSpec::Core::RakeTask.new

data/lib/stump.rb

@@ -0,0 +1,30 @@
+require 'stump/logger_targets'
+require 'stump/access_log'
+require 'stump/version'
+require 'logger'
+
+module Stump
+
+  module Logger
+
+    #
+    # Initialize a new Logger with the desired *targets*: either STDOUT,
+    # a log file or both.
+    # *path* is an array of file paths.
+    #
+    def self.new(path=nil)
+      return ::Logger.new(LoggerTargets.new(STDOUT)) unless path
+
+      if FileTest.exist?(path)
+        log_file = File.open(path, 'a')
+      else
+        FileUtils.mkdir_p(File.dirname(path))
+        log_file = File.new(path, 'w')
+      end
+
+      ::Logger.new LoggerTargets.new(STDOUT, log_file)
+    end
+
+  end
+
+end

data/lib/stump/access_log.rb

@@ -0,0 +1,57 @@
+module Stump
+
+  #
+  # The Middleware ensures that the logger provided (could be a standard Ruby Logger)
+  # gets called by Rack.
+  #
+  class AccessLog
+
+    # Adheres to the Apache Common Log format: http://en.wikipedia.org/wiki/Common_Log_Format
+    ACCESS_LOG_FORMAT = %{%s - %s [%s] "%s %s%s %s" %d %0.4f \n}
+
+    def initialize(app, logger)
+      @app = app
+      @logger = logger || ::Logger.new(STDOUT, 'daily')
+      @logger.level ||= 'info'
+    end
+
+    def call(env)
+      env['rack.logger'] = @logger
+      began_at = Time.now
+      status, header, body = @app.call(env)
+      log(env, status, began_at)
+      [status, header, body]
+    end
+
+    private
+
+    #
+    # Logs access log type messages to the logger's targets if the @access_log instance
+    # variable exists
+    #
+    def log(env, status, began_at)
+      now = Time.now
+      msg = ACCESS_LOG_FORMAT % [
+          env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR'] || '-',
+          env['REMOTE_USER'] || '-',
+          now.strftime('%d/%b/%Y:%H:%M:%S %z'),
+          env['REQUEST_METHOD'],
+          env['PATH_INFO'],
+          env['QUERY_STRING'].empty? ? '' : '?'+env['QUERY_STRING'],
+          env['HTTP_VERSION'],
+          status.to_s[0..3],
+          now - began_at ]
+
+      # Standard library logger doesn't support write but it supports << which actually
+      # calls to write on the log device without formatting
+      # logger = @logger || env['rack.logger']
+      if @logger.respond_to?(:write)
+        @logger.write(msg)
+      else
+        @logger << msg
+      end
+    end
+
+  end
+
+end

data/lib/stump/logger_targets.rb

@@ -0,0 +1,28 @@
+module Stump
+
+  #
+  # LoggerTargets gets passed to the Logger.rb instantiate method as its *logdevice*. Thus whenever *write*
+  # is called for the logger, the *write* method defined below is called. This method loops through the predefined
+  # targets (usually a file and STDOUT) and writes to them. *flush* is necessary due to the fact that *write* is
+  # a buffered method.
+  #
+  class LoggerTargets
+
+    def initialize(*targets)
+      @targets = targets
+    end
+
+    def write(*args)
+      @targets.each do |t|
+        t.write(*args)
+        t.flush
+      end
+    end
+
+    def close
+      @targets.each(&:close)
+    end
+
+  end
+
+end

data/lib/stump/version.rb

@@ -0,0 +1,3 @@
+module Stump
+  VERSION = '2.0'
+end

data/spec/file_creation_spec.rb

@@ -0,0 +1,24 @@
+require 'stump'
+require 'logger'
+
+describe 'file creation' do
+
+  before :all do
+    @log_file_name = 'tmp/test.log'
+  end
+
+  it 'does not create a file when one is not specified in the config' do
+    logger = Stump::Logger.new
+    File.exists?(@log_file_name).should eq(false)
+  end
+
+  it 'creates a new log file if none exists and path is supplied' do
+    logger = Stump::Logger.new(@log_file_name).should be_a(Logger)
+    File.exists?(@log_file_name).should eq(true)
+  end
+
+  after :all do
+    File.delete('tmp/test.log')
+  end
+
+end

data/spec/logger_spec.rb

@@ -0,0 +1,36 @@
+require 'stump'
+require 'logger'
+
+describe 'logging to STDOUT' do
+
+  it 'should log to STDOUT when no path is supplied' do
+    logger = Stump::Logger.new
+    $stdout.should_receive(:write)
+    logger.info('log entry')
+  end
+
+  it 'should log to STDOUT when a path is supplied as well' do
+    logger = Stump::Logger.new 'tmp/test.log'
+    $stdout.should_receive(:write)
+    logger.info('log entry')
+  end
+
+end
+
+describe 'logging to files' do
+
+  before :all do
+    @log_file_name = 'tmp/test.log'
+  end
+
+  after :all do
+    File.delete('tmp/test.log')
+  end
+
+  it 'logs to supplied file' do
+    logger = Stump::Logger.new @log_file_name
+    logger.info('log entry')
+    File.readlines(@log_file_name).any? { |line| line['log entry'] }.should eq(true)
+  end
+
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,38 @@
+require 'stump'
+require 'rack'
+
+describe Stump::AccessLog do
+
+  let(:app) { ->(env) { [200, env, "app"] } }
+  let(:log_file_name) { 'tmp/test.log' }
+
+  after :each do
+    File.delete(log_file_name) if File.exist?(log_file_name)
+  end
+
+  it 'should log requests to STDOUT' do
+    logger = Stump::Logger.new
+    middleware = Stump::AccessLog.new(app, logger)
+    $stdout.should_receive(:write)
+    middleware.call env_for '/'
+  end
+
+  it 'should create supplied log file' do
+    logger = Stump::Logger.new log_file_name
+    middleware = Stump::AccessLog.new(app, logger)
+    middleware.call env_for '/'
+    File.exists?(log_file_name).should eq(true)
+  end
+
+  it 'should log access log messages to supplied log file' do
+    logger = Stump::Logger.new log_file_name
+    middleware = Stump::AccessLog.new(app, logger)
+    middleware.call env_for '/'
+    File.readlines(log_file_name).length.should eq(1)
+  end
+
+  def env_for(url)
+    Rack::MockRequest.env_for(url)
+  end
+
+end

data/stump.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stump/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'stump'
+  spec.version       = Stump::VERSION
+  spec.authors       = ['Nicolay Hvidsten']
+  spec.email         = ['nicohvi@gmail.com']
+  spec.description   = 'Minute logging gem for small rack applications'
+  spec.summary       = 'Log all the things!'
+  spec.homepage      = 'http://nplol.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'logger'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'rspec', '~> 2.6'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: stump
+version: !ruby/object:Gem::Version
+  version: '2.0'
+platform: ruby
+authors:
+- Nicolay Hvidsten
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Minute logging gem for small rack applications
+email:
+- nicohvi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stump.rb
+- lib/stump/access_log.rb
+- lib/stump/logger_targets.rb
+- lib/stump/version.rb
+- spec/file_creation_spec.rb
+- spec/logger_spec.rb
+- spec/middleware_spec.rb
+- stump.gemspec
+homepage: http://nplol.com
+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: Log all the things!
+test_files:
+- spec/file_creation_spec.rb
+- spec/logger_spec.rb
+- spec/middleware_spec.rb