logs_viewer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab05abaecdf3a5135fd390392cc4307e429ababe
+  data.tar.gz: deb97e3b295b5f43273b9b58a444d45076b074ab
+SHA512:
+  metadata.gz: 7c552143a68c2a8ef92b3fe07f89b2e97f7439f9bff3b7ae44dce4222c0693f9e97cf81edad8ef291c22c3b7bb23bff168cb7d899187702649d0ccb090e5ec05
+  data.tar.gz: 8d0d41075e0278f083d217370b55bfbdb6a0a0a31ff9c37d499b9ea6e15395f4a08a7c84f27bd96e7262129029fae673f6d71b55f08fff4fa493e4b41997536c

data/.gitignore

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

data/.idea/rails_logs_viewer.iml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="gem" name="Ruby Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$/../rails_logs_viewer" />
+        <option name="GEM_APP_TEST_PATH" value="" />
+        <option name="GEM_APP_LIB_PATH" value="$MODULE_DIR$/../rails_logs_viewer/lib" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, RVM: ruby-2.2.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.5.0, RVM: ruby-2.2.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.4.0, RVM: ruby-2.2.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.4.1, RVM: ruby-2.2.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.4.0, RVM: ruby-2.2.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.4.0, RVM: ruby-2.2.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.4.1, RVM: ruby-2.2.3) [gem]" level="application" />
+  </component>
+</module>

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,55 @@
+# LogsViewer
+
+This gem was developed to make possible the visualization of the application logs in the browser.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'logs_viewer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install logs_viewer
+
+## Configuration (Rails)
+
+Create file **config/initializers/logs_viewer.rb** with the following content:
+```ruby
+LogsViewer::Config.number_lines = 1000
+LogsViewer::Config.log_dir = "log"
+```
+
+Add the hack on their application in the file **config/application.rb**
+```ruby
+module YourApplicationModule
+  class Application < Rails::Application
+
+    # Rack to intercept path /logs
+    config.middleware.use LogsViewer::Display
+  end
+end
+
+```
+
+## Usage
+
+After creating the initialization file and add the rack, go to your project the path /logs: (http://your-app:port/logs)
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/logs_viewer.
+

data/Rakefile

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

data/bin/console

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

@@ -0,0 +1,10 @@
+module LogsViewer
+  class Config
+    cattr_reader :number_lines, :log_dir
+    cattr_writer :number_lines, :log_dir
+
+    @@number_lines ||= 1000
+    @@log_dir ||= "log"
+
+  end
+end

data/lib/logs_viewer/display.rb

@@ -0,0 +1,38 @@
+module LogsViewer
+  class Display
+
+    def initialize(app)
+      @app = app
+      @lines = LogsViewer::Config.number_lines
+      @log_dir = LogsViewer::Config.log_dir
+    end
+
+    def call(env = {})
+      if env["PATH_INFO"]=~/^\/logs/
+        @data = {
+          list: LogsViewer::Handler.list(@log_dir),
+          lines: []
+        }
+
+        if(env["QUERY_STRING"]=~/file/ )
+          log_name = env["QUERY_STRING"].clone
+          log_name = log_name.gsub(/file=/, '')
+
+          @data[:lines] = `tail -n "#{@lines}" "#{log_name}"`
+          [200,{"Content-Type"=>"text/html"},[view_generate(@data)]]
+        else
+          [200,{"Content-Type"=>"text/html"},[view_generate(@data)]]
+        end
+      else
+        @app.call(env)
+      end
+    end
+
+    def view_generate(data)
+      temp = LogsViewer::Handler.file_open("../views/display.html.erb")
+      temp = ERB.new(temp)
+      return temp.result(binding)
+    end
+
+  end
+end

data/lib/logs_viewer/display_helper.rb

@@ -0,0 +1,19 @@
+module LogsViewer
+  class DisplayHelper
+
+    def self.get_nested_logs(list)
+      html = "<ul style='list-style-type:none'>"
+      list.each do |(item)|
+        icon_file = '<i class="glyphicon glyphicon-file"></i>'
+        icon_dir = '<i class="glyphicon glyphicon-folder-open"></i>'
+        link = "<a href='/logs?file=#{item}'>#{icon_file} #{item}</a>"
+        html += (LogsViewer::Handler.is_file? item) ? "<li>#{link}": "<li>#{icon_dir} #{item}"
+        html +="  #{self.get_nested_logs(LogsViewer::Handler.list(item))}" if LogsViewer::Handler.is_directory? item
+        html +="</li>"
+      end
+      html += "</ul>"
+      html
+    end
+
+  end
+end

data/lib/logs_viewer/handler.rb

@@ -0,0 +1,25 @@
+module LogsViewer
+  class Handler
+
+    def self.list(dir, type: nil )
+      case type
+        when :file then Dir[File.join(dir, '**')].reject {|f| File.directory?(f)}
+        when :directory then Dir[File.join(dir, '**')].select {|f| File.directory?(f)}
+        else Dir[File.join(dir, '**')]
+      end
+    end
+
+    def self.file_open(path)
+      File.open(File.expand_path(path,__FILE__),"r").read
+    end
+
+    def self.is_file?(path)
+      File.file? path
+    end
+
+    def self.is_directory?(path)
+      File.directory? path
+    end
+
+  end
+end

data/lib/logs_viewer/version.rb

@@ -0,0 +1,3 @@
+module LogsViewer
+  VERSION = "0.1.0"
+end

data/lib/logs_viewer/views/display.html.erb

@@ -0,0 +1,62 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails Logs Viewer</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+  <!-- Latest compiled and minified CSS -->
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" integrity="sha384-1q8mTJOASx8j1Au+a5WDVnPi2lkFfwwEAa8hDDdjZlpLegxhjVME1fgjWPGmkzs7" crossorigin="anonymous">
+
+  <style type="text/css">
+      .menu-box {
+          height: 100vh;
+          overflow-x: auto;
+          overflow-y: auto;
+          margin-right: -30px;
+      }
+      .console-box {
+          padding: 20px;
+          font-family: Monospace;
+          background-color: #212121;
+          color: #ffffff;
+          height: 100vh;
+          overflow: auto;
+          font-size: 12px;
+      }
+  </style>
+
+</head>
+<body>
+
+<div class="container-fluid">
+
+    <div class="row">
+      <div class="col-md-3">
+        <div class="menu-box">
+          <h3>Logs</h3>
+          <%= (LogsViewer::DisplayHelper.get_nested_logs(data[:list]).html_safe) %>
+        </div>
+      </div>
+      <div class="col-md-9">
+        <div class="console-box">
+        <% unless data[:lines].empty? %>
+
+            <% data[:lines].each_line do |line| %>
+                <%= line %><br>
+            <% end %>
+
+        <% end %>
+        </div>
+      </div>
+
+    </div>
+
+</div>
+
+<!-- Latest compiled and minified JavaScript -->
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS" crossorigin="anonymous"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script>
+
+</body>
+</html>

data/lib/logs_viewer.rb

@@ -0,0 +1,10 @@
+require "logs_viewer/version"
+
+module LogsViewer
+  # Your code goes here...
+end
+
+require "logs_viewer/config"
+require "logs_viewer/handler"
+require "logs_viewer/display_helper"
+require "logs_viewer/display"

data/logs_viewer.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'logs_viewer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "logs_viewer"
+  spec.version       = LogsViewer::VERSION
+  spec.licenses      = ['MIT']
+  spec.platform      = Gem::Platform::RUBY
+  spec.authors       = ["Washington Silva"]
+  spec.email         = ["w-osilva@hotmail.com"]
+  spec.homepage      = ""
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = `git ls-files -- {test,spec}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.summary       = %q{ Gem to view the application logs in the browser }
+  spec.description   = %q{ This gem was developed to make possible the visualization of the application logs in the browser.}
+
+  spec.add_dependency "bundler"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/logs_viewer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe LogsViewer do
+  it 'has a version number' do
+    expect(LogsViewer::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(true).to eq(true)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'logs_viewer'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: logs_viewer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Washington Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: " This gem was developed to make possible the visualization of the application
+  logs in the browser."
+email:
+- w-osilva@hotmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/rails_logs_viewer.iml"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/logs_viewer.rb
+- lib/logs_viewer/config.rb
+- lib/logs_viewer/display.rb
+- lib/logs_viewer/display_helper.rb
+- lib/logs_viewer/handler.rb
+- lib/logs_viewer/version.rb
+- lib/logs_viewer/views/display.html.erb
+- logs_viewer.gemspec
+- spec/logs_viewer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gem to view the application logs in the browser
+test_files: []