log_inspector 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c96a745595e8031c493b24b098041635f7b48085
-  data.tar.gz: 0404e4a74f8f8112c769b1482a4918ec8dfbf52d
+  metadata.gz: 948e30ec725f4dcb419ec60957a15c30a347df21
+  data.tar.gz: 863e7272b3399337ed0401843210d7bd0227fca5
 SHA512:
-  metadata.gz: 80d0b510b2ca650461374e3ce542151606abf10ea1ed0540267ba68689dbd33c672514c5b1bf73705732eb6e9bdf45db1d6aedd9116eae0b0fc825938efb08e8
-  data.tar.gz: 04e6d1a2de13122a1ba03ce5db6272721adc49bd0fd296101390dacd1ae0235efad03750d4588cae57144a740b0a3bd959b1d6f4c0849f019e162dea75b6cb55
+  metadata.gz: 76bcb0ca53bbb0afd35c1e07076b84fc9e734dda4689d9c1576e1e579d592aae60e316996eaf64aafaed79f666c8e7c87c5353a10941549f2c17b4b798be28b2
+  data.tar.gz: 4ebdf6e924af8ded6f353783b746540062ea94880477518760b81e6a569fca27fb23ca87c60c5b954b0b5dec51ad4d0feabae8677b2d656771d97622d16e50ff

data/Rakefile

@@ -1,37 +1,21 @@
+#!/usr/bin/env rake
 begin
-  require 'bundler/setup'
+ require 'bundler/setup'
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'LogInspector'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
-
-load 'rails/tasks/statistics.rake'
-
-
-
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+require 'rspec/core'
+require 'rspec/core/rake_task'
 
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new spec: 'app:db:test:prepare'
 
-task default: :test
+task default: :spec

data/app/assets/javascripts/log_inspector/folder-tree.js

@@ -2,6 +2,7 @@
 (function($) {
   $.widget( 'sh.folderTree', {
     options: {
+      api_token: '', // optional token to be set as an authorization header when making ajax requests to contents_url
       root: 'root_folder',
       contents_url: 'folder contents url',
       file_click: function(event, data) {}
@@ -39,9 +40,18 @@
 
     _refreshFolder: function(path) {
       var that = this;
-      $.get(that.options.contents_url, $.param({path: path}), function(data) {
-        that._updateFolderContents(path, data);
-      });
+      var ajax_opts = {
+        data: {path: path},
+        complete: function( jqXHR, textStatus ) {
+          that._updateFolderContents(path, jqXHR.responseJSON);
+        }
+      }
+      if (that.options.api_token != '') {
+        ajax_opts.beforeSend = function (xhr) {
+          xhr.setRequestHeader('Authorization', 'Token token='+that.options.api_token);
+        }
+      }
+      $.ajax(that.options.contents_url, ajax_opts);
     },
 
     _updateFolderContents: function(path, f_contents) {

data/app/assets/javascripts/log_inspector/log_inspector.js

@@ -1,6 +1,7 @@
 (function($) {
   $.widget( 'sh.logInspector', {
     options: {
+      api_token:  '', // authorization token passed up as header
       file_url:   '', // file api url
       folder_url: ''  // folder api url
     },
@@ -23,23 +24,30 @@
 
     _fileClick: function(path, all_lines) {
       var that = this;
-      $.get(that.options.file_url, $.param({path: path, all_lines: all_lines}), function(data) {
-        var $pane = that.element.find('.file-pane');
-        $pane.empty();
+      $.ajax( that.options.file_url, {
+        beforeSend: function (xhr) {
+          xhr.setRequestHeader('Authorization', 'Token token='+that.options.api_token);
+        },
+        data: {path: path, all_lines: all_lines},
+        complete: function( jqXHR, textStatus ) {
+          data = jqXHR.responseJSON;
+          var $pane = that.element.find('.file-pane');
+          $pane.empty();
 
-        $("<div class='file-details'>"+$.map({'File': 'basename', 'Size': 'size', 'Lines': 'lines'}, function( data_key,label ) {
-          return "<p class='"+data_key+"'><label>"+label+':</label><span>'+data[data_key]+'</span></p>';
-        }).join('')+'</div>').appendTo($pane);
+          $("<div class='file-details'>"+$.map({'File': 'basename', 'Size': 'size', 'Lines': 'lines'}, function( data_key,label ) {
+            return "<p class='"+data_key+"'><label>"+label+':</label><span>'+data[data_key]+'</span></p>';
+          }).join('')+'</div>').appendTo($pane);
 
-        if (data.truncated) {
-          var $truncated = $("<div class='truncated'><p>Displaying last 500 lines of "+data.basename+".</p><a href='#'>Show all lines</a> <span class='disp-all-caption'>(This may respond slowly)</span></div>").appendTo($pane);
-          $truncated.find('a').click( function() { that._fileClick(path, true); });
-        }
+          if (data.truncated) {
+            var $truncated = $("<div class='truncated'><p>Displaying last 500 lines of "+data.basename+".</p><a href='#'>Show all lines</a> <span class='disp-all-caption'>(This may respond slowly)</span></div>").appendTo($pane);
+            $truncated.find('a').click( function() { that._fileClick(path, true); return false; });
+          }
 
-        if (data.lines == '0') {
-          $("<div><hr/><div class='no-contents'>No contents.</pre></div>").appendTo($pane);
-        } else {
-          $('<div><hr/><pre>'+data.contents+'</pre></div>').appendTo($pane);
+          if (data.lines == '0') {
+            $("<div><hr/><div class='no-contents'>No contents.</pre></div>").appendTo($pane);
+          } else {
+            $('<div><hr/><pre>'+data.contents+'</pre></div>').appendTo($pane);
+          }
         }
       });
     },
@@ -48,6 +56,7 @@
       var $tree = $("<div class='folder-tree'></div>").prependTo(this.element.find('.tree-pane'));
       var that = this;
       $tree.folderTree({
+        api_token: that.options.api_token,
         root: 'log',
         contents_url: that.options.folder_url,
         file_click: function(event, data) { that._fileClick(data.path, false); }

data/app/controllers/log_inspector/log_controller.rb

@@ -2,6 +2,8 @@ module LogInspector
   class LogController < ApplicationController
     include ActionView::Helpers::NumberHelper
 
+    before_filter :restrict_access, only: [:file_api, :folder_api]
+
     def file_api
       path = ensure_path :file?
 
@@ -26,6 +28,7 @@ module LogInspector
       render json: resp_h
     end
 
+    # TODO: document restricting access: http://guides.rubyonrails.org/routing.html#advanced-constraints
     def index
       render 'log_inspector/index'
     end
@@ -40,5 +43,11 @@ module LogInspector
       raise ArgumentError, "Bad path: #{path}" unless File.send file_method, path
       path
     end
+
+    def restrict_access
+      authenticate_or_request_with_http_token do |token, options|
+        LogInspector::Encryptor.api_token token
+      end
+    end
   end
 end

data/app/views/log_inspector/_panes.html.erb

@@ -0,0 +1,9 @@
+<div class='log-inspector'></div>
+
+<script>
+  $('.log-inspector').logInspector({
+    api_token:  '<%= j LogInspector::Encryptor.api_token %>',
+    file_url:   '<%= log_inspector.file_path %>',
+    folder_url: '<%= log_inspector.folder_path %>'
+  });
+</script>

data/app/views/log_inspector/index.html.erb

@@ -1,8 +1 @@
-<div class='log-inspector'></div>
-
-<script>
-  $('.log-inspector').logInspector({
-    file_url:   '<%= file_path %>',
-    folder_url: '<%= folder_path %>'
-  });
-</script>
+<%= render partial: 'log_inspector/panes' %>

data/lib/log_inspector/encryptor.rb

@@ -0,0 +1,20 @@
+module LogInspector
+  class Encryptor
+    def self.api_token enc_token = nil
+      key_base = Rails.application.secrets[:secret_key_base][0..20]
+      passphrase = ActiveSupport::KeyGenerator.new(key_base).generate_key(key_base)
+      encryptor = ActiveSupport::MessageEncryptor.new(passphrase)
+
+      if enc_token
+        ret_v = false
+        begin
+          ret_v = encryptor.decrypt_and_verify(enc_token) == key_base
+        rescue => e
+        end
+        ret_v
+      else
+        encryptor.encrypt_and_sign(key_base)
+      end
+    end
+  end
+end

data/lib/log_inspector/engine.rb

@@ -1,5 +1,13 @@
 module LogInspector
   class Engine < ::Rails::Engine
     isolate_namespace LogInspector
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+      g.assets false
+      g.helper false
+    end
+
+    engine_name 'log_inspector'
   end
 end

data/lib/log_inspector/version.rb

@@ -1,3 +1,3 @@
 module LogInspector
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/log_inspector.rb

@@ -1,4 +1,5 @@
 require 'log_inspector/engine'
+require 'log_inspector/encryptor'
 
 module LogInspector
 end

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require log_inspector/folder-tree
+//= require log_inspector/log_inspector
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,17 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require log_inspector/folder-tree
+ *= require log_inspector/log-inspector
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/demo_controller.rb

@@ -0,0 +1,2 @@
+class DemoController < ApplicationController
+end

data/spec/dummy/app/views/demo/index.html.erb

@@ -0,0 +1 @@
+<%= render partial: 'log_inspector/panes' %>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,29 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <script src='https://code.jquery.com/jquery-2.2.4.min.js' integrity='sha256-BbhdlvQf/xTY9gja0Dq3HiwQF8LaCRTXxZKRutelT44=' crossorigin='anonymous'></script>
+
+  <script src='https://code.jquery.com/ui/1.11.4/jquery-ui.min.js' integrity='sha256-xNjb53/rY+WmG+4L6tTl9m6PpqknWZvRt0rO1SRnJzw=' crossorigin='anonymous'></script>
+
+  <link rel='stylesheet' href='https://code.jquery.com/ui/1.11.4/themes/black-tie/jquery-ui.css' crossorigin='anonymous'>
+
+  <!-- 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'>
+
+  <!-- Optional theme -->
+  <link rel='stylesheet' href='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap-theme.min.css' integrity='sha384-fLW2N01lMqjakBkx3l/M9EahuwpSfeNvV63J5ezn3uZzapT0u7EYsXMjQV+0En5r' crossorigin='anonymous'>
+
+  <!-- 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>
+
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config/routes.rb

@@ -0,0 +1,4 @@
+Rails.application.routes.draw do
+  root 'demo#index'
+  mount LogInspector::Engine => "/log_inspector"
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 0) do
+
+end