notable_web 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 902f5f6885cfba1cc9ff01f2fe722946f6649cc5
+  data.tar.gz: d469613856482c398e7667ec2426e4a9256a4838
+SHA512:
+  metadata.gz: 45bb114548b59f29f2c213f1cb388a9074825bba71579d86a77797d39d334973ad0aacce42b0690649fc54c8dfcba0ea52684be87e561b94b2a906eb5f9930cc
+  data.tar.gz: d0a480918cc03c3af1116753c2bd5f6ae89c1fa498459fa2f1969b3ec63ca0f90d3f98de6d26020d907d281288a77e45634f7e28bcf5392e7819b3e8d39ebf65

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Kane
+
+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,45 @@
+# Notable Web
+
+A web interface for [Notable](https://github.com/ankane/notable)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'notable_web'
+```
+
+And add it to your `config/routes.rb`.
+
+```ruby
+mount NotableWeb::Engine, at: "notable"
+```
+
+Be sure to secure the dashboard in production.
+
+#### Basic Authentication
+
+Set the following variables in your environment or an initializer.
+
+```ruby
+ENV["NOTABLE_USERNAME"] = "andrew"
+ENV["NOTABLE_PASSWORD"] = "secret"
+```
+
+#### Devise
+
+```ruby
+authenticate :user, lambda {|user| user.admin? } do
+  mount NotableWeb::Engine, at: "notable"
+end
+```
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/notable_web/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/notable_web/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/controllers/notable_web/home_controller.rb

@@ -0,0 +1,68 @@
+module NotableWeb
+  class HomeController < ActionController::Base
+    layout "notable_web/application"
+
+    http_basic_authenticate_with name: ENV["NOTABLE_USERNAME"], password: ENV["NOTABLE_PASSWORD"] if ENV["NOTABLE_PASSWORD"]
+
+    def index
+      where = Hash[ params.slice(:status, :note_type, :note, :user_id, :user_type).permit!.map{|k,v| ["notable_requests.#{k}", v] } ]
+
+      # https://github.com/rails/rails/issues/9055
+      @requests = Notable::Request.order("notable_requests.id DESC").where(where).preload(:user).page(params[:page]).per(100)
+
+      if params[:action_name]
+        @requests = @requests.where(action: params[:action_name])
+      end
+
+      if params[:status]
+        @requests = @requests.where("note_type != 'Slow Request'")
+      end
+
+      @requests =
+        case params[:scope]
+        when "slow_requests"
+          @requests.where("action IS NOT NULL AND (status = 503 OR note_type = 'Slow Request')")
+        when "referrer"
+          @requests.where("referrer IS NOT NULL")
+        when "external_referrer"
+          domain = PublicSuffix.parse(request.host).domain rescue request.host
+          @requests.where("referrer IS NOT NULL").where("referrer NOT LIKE ?", "%#{domain}%")
+        else
+          @requests
+        end
+    end
+
+    def users
+      requests = Notable::Request.where("created_at > ?", 1.day.ago)
+      # yuck make this better
+      user_ids = []
+      counts = Hash.new(0)
+      requests.select("user_id, user_type").order("created_at desc").where("user_id IS NOT NULL").each do |request|
+        keys = [request.user_id, request.user_type]
+        counts[keys] += 1
+        user_ids << keys if counts[keys] == 3
+        break if user_ids.size >= 20
+      end
+      groups = user_ids.group_by{|v| v[1] }
+      where = [groups.map{|_, v| "(user_type = ? AND user_id IN (?))" }.join(" OR ")] + groups.flat_map{|v| [v[0], v[1].map{|v1| v1[0] }] }
+      @users = requests.includes(:user).where(where).order("created_at DESC").group_by(&:user)
+    end
+
+    def slow_actions
+      @top_actions = slow_requests.where("created_at > ?", 3.days.ago).select("action, SUM(request_time) AS total_time, AVG(request_time) AS average_time, COUNT(*) AS requests, SUM(CASE WHEN status = 503 THEN 1 ELSE 0 END) AS timeouts").group("action").order("total_time DESC").limit(50)
+      @total_time_by_day = [{name: "Total Time (min)", data: slow_requests.group_by_day(:created_at, last: 14).sum("request_time").map{|k, v| [k, (v / 60.0).round] }}]
+    end
+
+    def slow_action
+      @action = params[:action_name]
+      @total_time_by_day = [{name: "Total Time (min)", data: slow_requests.where(action: @action).group_by_day(:created_at, last: 14).sum("request_time").map{|k, v| [k, (v / 60.0).round] }}]
+    end
+
+    protected
+
+    def slow_requests
+      Notable::Request.where("action IS NOT NULL AND (status = 503 OR note_type = 'Slow Request')")
+    end
+
+  end
+end

data/app/views/layouts/notable_web/application.html.erb

@@ -0,0 +1,105 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Notable</title>
+
+    <meta charset="utf-8" />
+
+    <style>
+      body {
+        font-family: "Helvetica Neue", Arial, Helvetica, sans-serif;
+        margin: 0;
+        padding: 20px;
+        font-size: 14px;
+        line-height: 1.4;
+        color: #333;
+      }
+
+      a, a:visited, a:active {
+        color: #428bca;
+        text-decoration: none;
+      }
+
+      a:hover {
+        text-decoration: underline;
+      }
+
+      table {
+        width: 100%;
+        border-collapse: collapse;
+        border-spacing: 0;
+        margin-bottom: 20px;
+      }
+
+      th {
+        text-align: left;
+        border-bottom: solid 2px #ddd;
+      }
+
+      table td, table th {
+        padding: 8px;
+      }
+
+      td {
+        border-top: solid 1px #ddd;
+      }
+
+      .nav li {
+        display: inline;
+        margin-right: 20px;
+      }
+
+      ul {
+        padding-left: 0;
+      }
+
+      .stream li {
+        display: block;
+        border-top: solid 1px #eee;
+      }
+
+      .more {
+        display: none;
+        padding-bottom: 1em;
+      }
+    </style>
+
+    <script src="//ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+    <%= javascript_include_tag "//www.google.com/jsapi", "chartkick" %>
+  </head>
+  <body>
+    <div class="container">
+      <ul class="nav">
+        <li><%= link_to "Stream", root_path %></li>
+        <li><%= link_to "Slow Requests", root_path(scope: "slow_requests") %></li>
+        <li><%= link_to "Timeouts", root_path(note_type: "Timeout") %></li>
+        <li><%= link_to "Not Found", root_path(note_type: "Not Found") %></li>
+        <li><%= link_to "Errors", root_path(note_type: "Error") %></li>
+        <li><%= link_to "Validation Errors", root_path(note_type: "Validation Errors") %></li>
+        <li><%= link_to "Unpermitted Parameters", root_path(note_type: "Unpermitted Parameters") %></li>
+        <li><%= link_to "Unverified Request", root_path(note_type: "Unverified Request") %></li>
+      </ul>
+      <ul class="nav">
+        <li><%= link_to "Users", users_path %></li>
+        <li><%= link_to "Slow Actions", slow_actions_path %></li>
+      </ul>
+      <form method="get" action="<%= root_path %>">
+        <!-- <%= select_tag :user_type, options_for_select([["User", "User"]]) %> -->
+        User
+        <%= hidden_field_tag :user_type, "User" %>
+        <%= text_field_tag :user_id %>
+        <input type="submit" value="Go" />
+      </form>
+      <%= yield %>
+    </div>
+
+    <script>
+      $(".stream li").click( function(e) {
+        if (e.target.tagName != "A") {
+          e.preventDefault();
+          $(this).find(".more").slideToggle();
+        }
+      });
+    </script>
+  </body>
+</html>

data/app/views/notable_web/home/_stream.html.erb

@@ -0,0 +1,33 @@
+<ul class="stream">
+  <% requests.each do |request| %>
+    <li>
+      <p>
+        <%= request.created_at.in_time_zone(NotableWeb.time_zone).strftime("#{request.created_at < 24.hours.ago ? "%b %-e, " : nil}%-l:%M %P") %>
+        <span style="color: #999;"><%= request.status %></span>
+        <strong><%= request.note_type %></strong>
+<!--         <% if request.note_type == "Not Found" %>
+          /<%= request.url.sub(/https?:\/\//i, "").split("/", 2).last %>
+        <% end %> -->
+        <%= request.note %>
+        <span style="color: #999;"><%= request.action %></span>
+        <% if request.user and show_user %>
+          <%= link_to NotableWeb.user_name_method.call(request.user), params.slice(:status, :note_type, :scope).merge(user_id: request.user_id, user_type: request.user_type) %>
+        <% end %>
+        <% if params[:scope] == "referrer" %>
+          <br /><%= link_to nil, request.referrer, target: "_blank" %>
+        <% end %>
+      </p>
+
+      <div class="more">
+        <%= link_to nil, request.url, target: "_blank" %><br />
+        <% if request.referrer.present? %>
+          from <%= link_to nil, request.referrer, target: "_blank" %><br />
+        <% end %>
+        <%= request.ip %><br />
+        <%= request.user_agent %><br />
+        <%= request.request_id %><br />
+        <%= request.request_time.round(3) %>
+      </div>
+    </li>
+  <% end %>
+</ul>

data/app/views/notable_web/home/index.html.erb

@@ -0,0 +1,38 @@
+<% if (params[:note_type] == "Validation Errors" or params[:note_type] == "Error") && !params[:action_name] %>
+  <h3>Top</h3>
+
+  <table>
+    <thead>
+      <tr>
+        <th>Errors</th>
+        <th style="width: 15%; text-align: right;">Users</th>
+        <th style="width: 15%; text-align: right;">Count</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% Notable::Request.select("note, action, COUNT(DISTINCT (user_type || user_id)) as count_user, COUNT(*) as count_all").where(note_type: params[:note_type]).group([:note, :action]).order("count_all desc").each do |agg| %>
+        <tr>
+          <td>
+            <%= agg.note %> <span style="color: #999;"><%= agg.action %></span>
+            <%= link_to "view", params.merge(note: agg.note, action_name: agg.action) %>
+          </td>
+          <td style="text-align: right;"><%= agg.count_user %></td>
+          <td style="text-align: right;"><%= agg.count_all %></td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+<% end %>
+
+<% if params[:user_type] and params[:user_id] %>
+  <h3><%= params[:user_type] %> <%= params[:user_id] %></h3>
+<% end %>
+
+<%= render partial: "stream", locals: {requests: @requests, show_user: !(params[:user_id] && params[:user_type])} %>
+
+<% if @requests.current_page != 1 %>
+  <%= link_to "Prev", params.merge(page: @requests.current_page - 1), style: "margin-right: 20px;" %>
+<% end %>
+<% if @requests.size == @requests.limit_value %>
+  <%= link_to "Next", params.merge(page: @requests.current_page + 1) %>
+<% end %>

data/app/views/notable_web/home/slow_action.html.erb

@@ -0,0 +1,3 @@
+<h4><%= @action %></h4>
+
+<%= line_chart @total_time_by_day %>

data/app/views/notable_web/home/slow_actions.html.erb

@@ -0,0 +1,26 @@
+<%= line_chart @total_time_by_day %>
+
+<h4>Last 3 Days</h4>
+
+<table>
+  <thead>
+    <tr>
+      <th style="width: 40%;">Action</th>
+      <th style="width: 15%;">Total Time (min)</th>
+      <th style="width: 15%;">Average Time (sec)</th>
+      <th style="width: 15%;">Requests</th>
+      <th style="width: 15%;">Timeouts</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @top_actions.each do |action| %>
+      <tr>
+        <td><%= link_to action.action, slow_action_path(action_name: action.action) %></td>
+        <td><%= (action.total_time / 60.0).round %></td>
+        <td><%= action.average_time.round(1) %></td>
+        <td><%= action.requests %></td>
+        <td><%= action.timeouts %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/notable_web/home/users.html.erb

@@ -0,0 +1,7 @@
+<% @users.each do |user, requests| %>
+  <% next if !user %>
+  <% requests = requests.sort_by(&:created_at).reverse.first(5) %>
+  <h3><%= NotableWeb.user_name_method.call(user) %></h3>
+  <%= render partial: "stream", locals: {requests: requests, show_user: false} %>
+  <p style="margin-bottom: 40px;"><%= link_to "more", root_path(user_id: user.id, user_type: user.class.name) %></p>
+<% end %>

data/config/routes.rb

@@ -0,0 +1,6 @@
+NotableWeb::Engine.routes.draw do
+  get "users", to: "home#users"
+  get "slow_actions", to: "home#slow_actions"
+  get "slow_action", to: "home#slow_action"
+  root to: "home#index"
+end

data/lib/notable_web/engine.rb

@@ -0,0 +1,9 @@
+module NotableWeb
+  class Engine < ::Rails::Engine
+    isolate_namespace NotableWeb
+
+    initializer "notable_web" do |app|
+      NotableWeb.time_zone ||= Time.zone
+    end
+  end
+end

data/lib/notable_web/version.rb

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

data/lib/notable_web.rb

@@ -0,0 +1,19 @@
+require "notable_web/version"
+
+# dependencies
+require "notable"
+require "groupdate"
+require "chartkick"
+require "kaminari"
+require "public_suffix"
+
+# engine
+require "notable_web/engine"
+
+module NotableWeb
+  class << self
+    attr_accessor :user_name_method
+    attr_accessor :time_zone
+  end
+  self.user_name_method = proc{|user| user.try(:name) || "#{user.class.name} #{user.id}" }
+end

data/notable_web.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'notable_web/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "notable_web"
+  spec.version       = NotableWeb::VERSION
+  spec.authors       = ["Andrew Kane"]
+  spec.email         = ["andrew@chartkick.com"]
+  spec.summary       = %q{A web interface for Notable}
+  spec.description   = %q{A web interface for Notable}
+  spec.homepage      = "https://github.com/ankane/notable_web"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "notable"
+  spec.add_dependency "groupdate"
+  spec.add_dependency "chartkick"
+  spec.add_dependency "kaminari"
+  spec.add_dependency "public_suffix"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: notable_web
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kane
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: notable
+  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: groupdate
+  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: chartkick
+  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: kaminari
+  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: public_suffix
+  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.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A web interface for Notable
+email:
+- andrew@chartkick.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/controllers/notable_web/home_controller.rb
+- app/views/layouts/notable_web/application.html.erb
+- app/views/notable_web/home/_stream.html.erb
+- app/views/notable_web/home/index.html.erb
+- app/views/notable_web/home/slow_action.html.erb
+- app/views/notable_web/home/slow_actions.html.erb
+- app/views/notable_web/home/users.html.erb
+- config/routes.rb
+- lib/notable_web.rb
+- lib/notable_web/engine.rb
+- lib/notable_web/version.rb
+- notable_web.gemspec
+homepage: https://github.com/ankane/notable_web
+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: A web interface for Notable
+test_files: []