rack-logs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e41cba44bb13dd1cb47253fe02c2e098a53df2de
+  data.tar.gz: 498c846612eb65afc5bc9c8bbe27d24c66804434
+SHA512:
+  metadata.gz: 9f2adf14ab42fb7e2b08a7cdb6adb6be8cb881f084abd81c547393e69be5c6c4a9af731fcfe667dfbb61d678ba25dbb759559814bab8fc7901fd3cb25acc3efb
+  data.tar.gz: eb243ac4724ba8ec15b4fe622f2bb4e218646ed11cc8ab8996b4abdc21e93798717e89ea96150fc54526f56d71bae988a2fe48d66f0a5f60e6a59c4d24c965eb

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg
+tmp

data/.rspec

@@ -0,0 +1,4 @@
+--colour
+--order random
+-I ./lib
+-r spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+bundler_args: "--standalone --binstubs"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-2.2.1
+  - 2.0.0
+  - 2.1.0
+matrix:
+  allow_failures:
+    - rvm: rbx-2.2.1

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-logs.gemspec
+gemspec
+
+platforms :rbx do
+  gem 'rubysl'
+  gem 'rubysl-logger' # for rake
+  gem 'racc'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jon Rowe
+
+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,42 @@
+# Rack::Logs
+
+Simple rack mountable log viewer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-logs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-logs
+
+## Usage
+
+Mount as `rack` middleware to expose your logs.
+
+** `rack-logs` exposes potentially sensitive information that may be contained
+in your logs, please secure your stack against unauthorised access**
+
+```Ruby
+use Rack::Logs do |config|
+  # controls the pattern used to find logs, defaults to *.log
+  config.pattern = '*.log'
+
+  # controls the directory searched for logs, defaults to `./log`
+  config.log_dir = File.expand_path('../log',__FILE__)
+end
+```
+
+## Contributing
+
+1. Fork it
+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,23 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run unit tests"
+  RSpec::Core::RakeTask.new(:unit) do |t|
+    t.ruby_opts = %w[-w]
+    t.pattern = 'spec/unit/**/*_spec.rb'
+  end
+
+  desc "Run integration tests"
+  RSpec::Core::RakeTask.new(:integration) do |t|
+    t.ruby_opts = %w[-w]
+    t.pattern = 'spec/integration/**/*_spec.rb'
+  end
+
+  desc "Run both spec suites in order by default"
+  task default: %w[unit integration]
+
+rescue LoadError
+  puts "RSpec Unavailable"
+end

data/lib/rack/logs/config.rb

@@ -0,0 +1,14 @@
+module Rack
+  module Logs
+    class Config
+
+      def initialize
+        @pattern = '*.log'
+        @log_dir = './log'
+      end
+
+      attr_accessor :pattern, :log_dir
+
+    end
+  end
+end

data/lib/rack/logs/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Logs
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/logs/viewer.rb

@@ -0,0 +1,41 @@
+module Rack
+  module Logs
+    class Viewer
+
+      def initialize config
+        @config = config
+      end
+      attr_reader :config
+
+      def call env
+        [200, headers, [joined_logs]]
+      end
+
+    private
+
+      def headers
+        {
+          'Content-Type' => 'text/plain'
+        }
+      end
+
+      def joined_logs
+        logs.inject("") do |string, (filename, contents)|
+          string + "## " + filename + "\n\n" + contents
+        end
+      end
+
+      def logs
+        files.inject({}) do |hash, filename|
+          hash[filename] = ::File.read(filename)
+          hash
+        end
+      end
+
+      def files
+        Dir[@config.log_dir+'/'+@config.pattern]
+      end
+
+    end
+  end
+end

data/lib/rack/logs.rb

@@ -0,0 +1,19 @@
+require "rack/logs/version"
+
+module Rack
+  module Logs
+    module_function
+
+    autoload 'Viewer', 'rack/logs/viewer'
+    autoload 'Config', 'rack/logs/config'
+
+    def configure
+      Rack::Logs::Viewer.new Config.new.tap { |c| yield c }
+    end
+
+    def call env
+      configure {}.call env
+    end
+
+  end
+end

data/lib/rack-logs.rb

@@ -0,0 +1 @@
+require 'rack/logs'

data/rack-logs.gemspec

@@ -0,0 +1,28 @@
+# enccoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/logs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-logs"
+  spec.version       = Rack::Logs::VERSION
+  spec.authors       = ["Jon Rowe"]
+  spec.email         = ["hello@jonrowe.co.uk"]
+  spec.description   = %q{Simple rack based log viewer}
+  spec.summary       = %q{Simple rack based log viewer}
+  spec.homepage      = "https://github.com/JonRowe/rack-logs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(spec)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '> 1.9'
+
+  spec.add_runtime_dependency "rack", "~> 1.5.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "fakefs"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec",   "~> 3.0.0.beta1"
+end

data/spec/integration/running_rack_logs_via_rack_spec.rb

@@ -0,0 +1,45 @@
+require 'rack/test'
+require 'rack/logs'
+
+describe 'running `Rack::Logs` via `Rack::Builder`', type: :integration do
+  include Rack::Test::Methods
+
+  context 'running with defaults' do
+    let(:app) { Rack::Builder.app { run Rack::Logs } }
+
+    before { get '/' }
+
+    example 'returns a 200 response code' do
+      expect(last_response).to be_ok
+    end
+    example 'returns no logs because there are no files' do
+      expect(last_response.body).to eq ''
+    end
+  end
+
+  context 'given a log in a configured directory' do
+    let(:app) do
+      Rack::Builder.app do
+        logs = Rack::Logs.configure do |config|
+          config.log_dir = './tmp'
+        end
+        run logs
+      end
+    end
+
+    before do
+      File.open('./tmp/my_log_file.log','w') do |f|
+        f.write "LOG ENTRY 1234"
+      end
+      get '/'
+    end
+
+    example 'returns a 200 response code' do
+      expect(last_response).to be_ok
+    end
+
+    example 'accessing the log returns log contents' do
+      expect(last_response.body).to match 'LOG ENTRY 1234'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+# required by .rspec

data/spec/unit/rack/logs/config_spec.rb

@@ -0,0 +1,25 @@
+require 'rack/logs/config'
+
+describe 'Rack::Logs::Config' do
+  let(:config) { Rack::Logs::Config.new }
+
+  describe '#log_dir' do
+    it 'defaults to *.log' do
+      expect(config.log_dir).to eq './log'
+    end
+    it 'is configurable' do
+      config.log_dir = './tmp'
+      expect(config.log_dir).to eq './tmp'
+    end
+  end
+
+  describe '#pattern' do
+    it 'defaults to *.log' do
+      expect(config.pattern).to eq '*.log'
+    end
+    it 'is configurable' do
+      config.pattern = '*.doge'
+      expect(config.pattern).to eq '*.doge'
+    end
+  end
+end

data/spec/unit/rack/logs/viewer_spec.rb

@@ -0,0 +1,37 @@
+require 'fakefs/safe'
+require 'rack/logs/viewer'
+
+describe 'Rack::Logs::Viewer' do
+  let(:config) { instance_double "Rack::Logs::Config", pattern: '*.doge', log_dir: './tmp' }
+
+  describe '#initialize' do
+    it 'takes a configuration' do
+      Rack::Logs::Viewer.new config
+    end
+  end
+
+  describe '#call env' do
+    let(:viewer)   { Rack::Logs::Viewer.new config }
+    let(:response) { viewer.call({}) }
+
+    before do
+      FakeFS.activate!
+      FileUtils.mkdir_p('./tmp')
+      File.open('./tmp/not_log.txt','w') { |file| file.write 'Nothing to see here' }
+      File.open('./tmp/my_log.doge','w') { |file| file.write 'Much log, such information' }
+    end
+    after do
+      FakeFS.deactivate!
+    end
+
+    it 'returns a rack response' do
+      expect(response[0]).to be_a Fixnum
+      expect(response[1]).to be_a Hash
+      expect(response[1].keys).to include 'Content-Type'
+      expect(response[2].respond_to? :each).to be true
+    end
+    it 'returns the contents of the logs' do
+      expect(response[2]).to eq ["## tmp/my_log.doge\n\nMuch log, such information"]
+    end
+  end
+end

data/spec/unit/rack/logs_spec.rb

@@ -0,0 +1,53 @@
+require 'rack/logs'
+
+describe 'Rack::Logs' do
+  before do
+    stub_const "Rack::Logs::Config", Class.new
+    stub_const "Rack::Logs::Viewer", (Class.new do
+      def initialize config
+        @config = config
+      end
+      attr_reader :config
+    end)
+  end
+
+  describe '.configure' do
+    let(:viewer) { Rack::Logs.configure { } }
+
+    it 'takes a block that yields configuration' do
+      config = nil
+      Rack::Logs.configure { |object| config = object }
+      expect(config).to be_a Rack::Logs::Config
+    end
+    it 'creates a Rack::Logs::Viewer with the config' do
+      expect(viewer.config).to be_an_instance_of Rack::Logs::Config
+    end
+    it 'returns a Rack::Logs::Viewer' do
+      expect(viewer).to be_a Rack::Logs::Viewer
+    end
+  end
+
+  describe '.call' do
+    let(:viewer_response) { double }
+    let(:viewer) { instance_double "Rack::Logs::Viewer" }
+    let(:env) { double }
+
+    before do
+      allow(Rack::Logs::Viewer).to receive(:new).and_return(viewer)
+      allow(viewer).to receive(:call).and_return(viewer_response)
+    end
+
+    it 'creates a default Rack::Logs::Config' do
+      expect(Rack::Logs::Config).to receive(:new).once
+      Rack::Logs.call env
+    end
+    it 'creates a Rack::Logs::Viewer' do
+      expect(Rack::Logs::Viewer).to receive(:new).once
+      Rack::Logs.call env
+    end
+    it 'delegates to Rack::Logs::Viewer' do
+      expect(viewer).to receive(:call).with env
+      expect(Rack::Logs.call env).to eq viewer_response
+    end
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: rack-logs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Rowe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !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: fakefs
+  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: 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-test
+  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: 3.0.0.beta1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta1
+description: Simple rack based log viewer
+email:
+- hello@jonrowe.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rack-logs.rb
+- lib/rack/logs.rb
+- lib/rack/logs/config.rb
+- lib/rack/logs/version.rb
+- lib/rack/logs/viewer.rb
+- rack-logs.gemspec
+- spec/integration/running_rack_logs_via_rack_spec.rb
+- spec/spec_helper.rb
+- spec/unit/rack/logs/config_spec.rb
+- spec/unit/rack/logs/viewer_spec.rb
+- spec/unit/rack/logs_spec.rb
+- tmp/.gitkeep
+homepage: https://github.com/JonRowe/rack-logs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '1.9'
+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: Simple rack based log viewer
+test_files:
+- spec/integration/running_rack_logs_via_rack_spec.rb
+- spec/spec_helper.rb
+- spec/unit/rack/logs/config_spec.rb
+- spec/unit/rack/logs/viewer_spec.rb
+- spec/unit/rack/logs_spec.rb