logput 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Philip Lee
+
+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,46 @@
+# Logput
+
+Rack middleware to sit in a rails app to put put the current environments log to a webpage. eg /logput
+
+To be used in test and development environments to see logs without needing direct access to the box.
+
+This NOT to be used in production like environments.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'logput'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logput
+
+## Usage
+
+Inside you rails app. Add the following line to config/development.rb and/or any other environment you wish to use this in.
+
+    config.middleware.use(Logput::Middleware)
+
+The following configuration options are available.
+
+* :path_to_log_file => '/path/to/custom/log'. Defaults to current environments log file if in rails.
+* :lines_to_read => 1000. Defaults to 500.
+
+Example.
+
+    config.middleware.use(Logput::Middleware, :lines_to_read => 300, :path_to_log_file => './log/delayed_job')
+
+Start you rails server as normal in the set environemnt. Navigate to /logput e.g. [http://localhost:3000/logput](http://localhost:3000/logput)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/logput/middleware.rb

@@ -0,0 +1,32 @@
+module Logput
+  class Middleware
+    def initialize(app, options = {})
+      @app = app
+      @path_to_log_file = options[:path_to_log_file]
+      @lines_to_read = options[:lines_to_read] || 500
+    end
+
+    def call(env)
+      @path_to_log_file ||= default_path_to_log_file(env)
+
+      raise 'Log file does not exist' unless File.exists? @path_to_log_file
+
+      if env['PATH_INFO'] == '/logput'
+        out = `tail -n #{@lines_to_read} #{@path_to_log_file}`
+        [200, {"Content-Type" => "text/html"}, ["<pre>", out, "</pre>"]]
+      else
+        @app.call(env)
+      end
+    end
+
+    private
+
+    def default_path_to_log_file(env)
+      if defined? Rails
+        env['action_dispatch.logger'].instance_variable_get(:@logger).instance_variable_get(:@log_dest).path
+      else
+        raise Exception, 'Must specify path to log file'
+      end
+    end
+  end
+end

data/lib/logput/version.rb

@@ -0,0 +1,3 @@
+module Logput
+  VERSION = "0.0.1"
+end

data/lib/logput.rb

@@ -0,0 +1,6 @@
+require "logput/version"
+require 'rack'
+
+module Logput
+  autoload :Middleware, 'logput/middleware'
+end

data/logput.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/logput/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Philip Lee"]
+  gem.email         = ["asmega@ph-lee.com"]
+  gem.description   = 'Rack middleware to output rails logs to a webpage'
+  gem.summary       = 'Rack middleware to output rails logs to a webpage'
+  gem.homepage      = "https://github.com/asmega/logput"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "logput"
+  gem.require_paths = ["lib"]
+  gem.version       = Logput::VERSION
+
+  gem.add_dependency 'rack'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'pry'
+end

data/spec/middleware_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Logput::Middleware do
+  subject{ described_class.new(app, :path_to_log_file => './spec/support/test.log') }
+
+  let(:app) do
+    lambda do |env|
+      [200, {}, "hello world"]
+    end
+  end
+
+  let(:server){ Rack::MockRequest.new(subject) }
+
+  describe '/wrong_path' do
+    before :each do
+      @response = server.get('/wrong_path')
+    end
+
+    it 'outputs hello world' do
+      @response.body.should include('hello world')
+    end
+  end
+
+  describe 'default path to log file' do
+    subject { described_class.new(app) }
+
+    context 'when rails is not defined' do
+      it 'raises an error' do
+        expect{ server.get('/logput') }.to raise_exception
+      end
+    end
+
+    context 'when rails is defined' do
+      before :each do
+        class Rails; end
+      end
+
+      it 'returns ./log/development.log'
+    end
+  end
+
+  describe '/logput' do
+    context 'when there is no log file' do
+      subject{ described_class.new(app, :path_to_log_file => './file_does_not_exist') }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      it 'raises an exception' do
+        expect{ server.get('/logput')}.to raise_exception
+      end
+    end
+
+    context 'when there is log file' do
+      before :each do
+        @response = server.get('/logput')
+      end
+
+      subject{ described_class.new(app, :path_to_log_file => './spec/support/test.log', :lines_to_read => 5) }
+      let(:server){ Rack::MockRequest.new(subject) }
+
+      it 'responds with 200' do
+        @response.status.should == 200
+      end
+
+      it 'returns the last 5 lines of the log' do
+        @response.body.should_not include('2')
+        @response.body.should_not include('5')
+
+        @response.body.should include('6')
+        @response.body.should include('10')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # config.order = 'random'
+
+  config.requires = ['logput']
+end

data/spec/support/test.log

@@ -0,0 +1,10 @@
+1
+2
+3
+4
+5
+6
+7
+8
+9
+10

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: logput
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Philip Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack middleware to output rails logs to a webpage
+email:
+- asmega@ph-lee.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logput.rb
+- lib/logput/middleware.rb
+- lib/logput/version.rb
+- logput.gemspec
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/test.log
+homepage: https://github.com/asmega/logput
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware to output rails logs to a webpage
+test_files:
+- spec/middleware_spec.rb
+- spec/spec_helper.rb
+- spec/support/test.log