active_endpoint 0.2.0

data/Rakefile

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

data/active_endpoint.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_endpoint/version'
+
+Gem::Specification.new do |spec|
+  spec.version = ActiveEndpoint::VERSION
+
+  spec.name = 'active_endpoint'
+  spec.authors = ['Marat Khusnetdinov']
+  spec.email = ['marat@khusnetdinov.ru']
+
+  spec.summary = 'Your request tracking tool for rails applications'
+  spec.description = 'ActiveEndpoint is middleware for Rails applications that collects and analyses requests and responses per request for endpoint. It works with minimal impact on application\'s response time.'
+  spec.homepage = 'https://github.com/khusnetdinov/active_endpoint'
+  spec.license = 'MIT'
+
+  spec.homepage = 'https://github.com/khusnetdinov/active_endpoint'
+  spec.summary = 'Summary of ActiveEndpoint.'
+  spec.description = 'Description of ActiveEndpoint.'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/app/assets/config/active_endpoint_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/active_endpoint .js
+//= link_directory ../stylesheets/active_endpoint .css

data/app/assets/javascripts/active_endpoint/application.js

@@ -0,0 +1,2 @@
+//= require jquery
+//= require jquery_ujs

data/app/assets/stylesheets/active_endpoint/application.css

@@ -0,0 +1,10 @@
+/* = require_tree . */
+/* = require_self */
+
+.list-group-item > .badge {
+  background-color: auto !important;
+}
+
+.btn-sm {
+    padding: 0 9px !important;
+}

data/app/controllers/active_endpoint/application_controller.rb

@@ -0,0 +1,5 @@
+module ActiveEndpoint
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/active_endpoint/dashboard_controller.rb

@@ -0,0 +1,7 @@
+require_dependency 'active_endpoint/application_controller'
+
+module ActiveEndpoint
+  class DashboardController < ApplicationController
+    def index; end
+  end
+end

data/app/controllers/active_endpoint/probes_controller.rb

@@ -0,0 +1,22 @@
+require_dependency 'active_endpoint/application_controller'
+
+module ActiveEndpoint
+  class ProbesController < ApplicationController
+    def index
+      @probes_group = ActiveEndpoint::Probe.group_by_endpoint
+    end
+
+    def show
+      @probes = ActiveEndpoint::Probe.where(endpoint: params[:id])
+    end
+
+    def show_response
+      @probe = ActiveEndpoint::Probe.find(params[:probe_id])
+    end
+
+    def destroy
+      ActiveEndpoint::Probe.find(params[:id]).destroy
+      redirect_to :back
+    end
+  end
+end

data/app/controllers/active_endpoint/unregistred_probes_controller.rb

@@ -0,0 +1,14 @@
+require_dependency 'active_endpoint/application_controller'
+
+module ActiveEndpoint
+  class UnregistredProbesController < ApplicationController
+    def index
+      @probes = ActiveEndpoint::UnregistredProbe.all.select(:id, :uuid, :started_at, :path, :query_string)
+    end
+
+    def destroy
+      ActiveEndpoint::UnregistredProbe.find(params[:id]).destroy
+      redirect_to action: :index
+    end
+  end
+end

data/app/helpers/active_endpoint/application_helper.rb

@@ -0,0 +1,105 @@
+module ActiveEndpoint
+  module ApplicationHelper
+    SETTINGS = [
+      :cache_store_client,
+      :cache_prefix,
+      :constraint_limit,
+      :constraint_period,
+      :logger,
+      :log_probe_info,
+      :log_debug_info,
+      :storage_limit,
+      :storage_period,
+      :storage_keep_periods
+    ].freeze
+
+    TAGS_COLORS = [
+      'label-info',
+      'label-success',
+      'label-warning',
+      'label-danger',
+      'label-default'
+    ].freeze
+
+    def settings
+      SETTINGS
+    end
+
+    def tags
+      tags = []
+      ActiveEndpoint.tags.definition.to_a.each_with_index do |definition, index|
+        tags << [
+          definition.first,
+          tag_label_by(index),
+          definition.last,
+          "ActiveEndpoint::Probe.tagged_as(:#{definition.first})"
+        ]
+      end
+      tags
+    end
+
+    def label_for(tag)
+      TAGS_COLORS[ActiveEndpoint.tags.definition.keys.index(tag.to_sym)]
+    end
+
+    def endpoints
+      ActiveEndpoint.blacklist.endpoints
+    end
+
+    def resources
+      ActiveEndpoint.blacklist.resources
+    end
+
+    def actions
+      ActiveEndpoint.blacklist.actions
+    end
+
+    def scopes
+      ActiveEndpoint.blacklist.scopes
+    end
+
+    def endpoints_constraints
+      ActiveEndpoint.constraints.endpoints.map do |endpoint, constraints|
+        constraints_for_html(endpoint, constraints)
+      end
+    end
+
+    def resources_constraints
+      ActiveEndpoint.constraints.resources.map do |endpoint, constraints|
+        constraints_for_html(endpoint, constraints)
+      end
+    end
+
+    def actions_constraints
+      ActiveEndpoint.constraints.actions.map do |endpoint, constraints|
+        constraints_for_html(endpoint, constraints)
+      end
+    end
+
+    def scopes_constraints
+      ActiveEndpoint.constraints.scopes.map do |endpoint, constraints|
+        constraints_for_html(endpoint, constraints)
+      end
+    end
+
+    private
+
+    def tag_label_by(index)
+      if TAGS_COLORS.length > index
+        TAGS_COLORS[index]
+      else
+        TAGS_COLORS.last
+      end
+    end
+
+    def constraints_for_html(endpoint, constraints)
+      rule = constraints[:rule]
+      storage = constraints[:storage]
+
+      rules = "#{rule[:limit]} per #{distance_of_time_in_words(rule[:period])}"
+      storages = "#{storage[:limit]} per #{distance_of_time_in_words(storage[:period])}"
+
+      [endpoint, rules, storages]
+    end
+  end
+end

data/app/models/active_endpoint/application_record.rb

@@ -0,0 +1,5 @@
+module ActiveEndpoint
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/active_endpoint/probe.rb

@@ -0,0 +1,52 @@
+module ActiveEndpoint
+  class Probe < ApplicationRecord
+    validates :uuid, :started_at, :duration, :endpoint, :ip, :path,
+              :request_method, :url, presence: true
+
+    validates :finished_at, presence: true, unless: :skip_validation?
+
+    scope :unregistred, ->() { where(endpoint: :unregistred) }
+    scope :registred, ->() { where.not(endpoint: :unregistred) }
+    scope :probe, ->(endpoint) { where(endpoint: endpoint) }
+    scope :taken_before, ->(period) { where('created_at < ?', period) }
+    scope :group_by_endpoint, ->() {
+      execute_statement("
+        select count(*) as amount, endpoint, request_method as method, avg(duration) as duration
+        from active_endpoint_probes group by endpoint, request_method
+        having endpoint != 'unregistred'
+      ")
+    }
+
+    def tag
+      definitions = ActiveEndpoint.tags.definition
+      methods = ActiveEndpoint::Extentions::ActiveRecord::METHODS
+
+      definitions.each do |tag_name, operators|
+        last_operation_index = operators.length - 1
+
+        exec_operator = ''
+        operators.each_with_index do |(key, value), index|
+          exec_operator << "#{duration * 1000} #{methods[key]} #{value}"
+          exec_operator << (index == last_operation_index ? '' : ' && ')
+        end
+
+        return tag_name if eval(exec_operator)
+      end
+    end
+
+    private
+
+    def skip_validation?
+      type == 'ActiveEndpoint::UnregistredProbe'
+    end
+
+    def self.execute_statement(sql)
+      results = ActiveRecord::Base.connection.execute(sql)
+      if results.present?
+        return results.map(&:deep_symbolize_keys)
+      else
+        return nil
+      end
+    end
+  end
+end

data/app/models/active_endpoint/unregistred_probe.rb

@@ -0,0 +1,3 @@
+module ActiveEndpoint
+  class UnregistredProbe < Probe; end
+end

data/app/views/active_endpoint/application/_flashes.html.erb

@@ -0,0 +1,5 @@
+<% flash.each do |key, message| %>
+  <div class="alert alert-<%= key %>" style="border-radius: 0; margin: 0; text-align: center;" role="alert">
+    <%= message %>
+  </div>
+<% end %>

data/app/views/active_endpoint/application/_header.html.erb

@@ -0,0 +1,18 @@
+<nav class="navbar-default navbar-toggleable-md navbar-light bg-faded">
+  <div class="container">
+    <button class="navbar-toggler navbar-toggler-right" style="top: 16px;" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
+      <span class="navbar-toggler-icon"></span>
+    </button>
+    <%= link_to 'ActiveEndpoint', active_endpoint.root_path, class: 'navbar-brand'%>
+    <div class="collapse navbar-collapse" id="navbarNav">
+      <ul class="nav navbar-nav">
+        <li class="<%= controller_name == 'probes' ? 'active' : '' %>">
+          <%= link_to 'Probes', active_endpoint.probes_path, class: '' %>
+        </li>
+        <li class="<%= controller_name == 'unregistred_probes' ? 'active' : '' %>">
+          <%= link_to 'Unregistred Probes', active_endpoint.unregistred_probes_path, class: '' %>
+        </li>
+      </ul>
+    </div>
+  </div>
+</nav>

data/app/views/active_endpoint/dashboard/_blacklist.html.erb

@@ -0,0 +1,57 @@
+<div class="card">
+  <div class="card-header">Blacklist</div>
+  <ul class="list-group">
+    <li class="list-group-item">
+      <div class="row">
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+              <tr><th>Endpoints</th></tr>
+            </thead>
+            <tbody>
+              <%- endpoints.each do |endpoint| %>
+                <tr><td><%= endpoint %></td></tr>
+              <% end %>
+            </tbody>
+          </table>
+        </div>
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr><th>Resources</th></tr>
+            </thead>
+            <tbody>
+            <%- resources.each do |resource| %>
+                <tr><td><%= resource %></td></tr>
+            <% end %>
+            </tbody>
+          </table>
+        </div>
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr><th>Actions</th></tr>
+            </thead>
+            <tbody>
+            <%- actions.each do |actions| %>
+                <tr><td><%= actions %></td></tr>
+            <% end %>
+            </tbody>
+          </table>
+        </div>
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr><th>Scope</th></tr>
+            </thead>
+            <tbody>
+            <%- scopes.each do |scopes| %>
+                <tr><td><%= scopes %></td></tr>
+            <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    </li>
+  </ul>
+</div>

data/app/views/active_endpoint/dashboard/_constraints.html.erb

@@ -0,0 +1,117 @@
+<div class="card">
+  <div class="card-header">Constraints</div>
+  <ul class="list-group">
+    <li class="list-group-item">
+      <div class="row">
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr>
+              <th>Endpoints</th>
+              <th>Request limits</th>
+              <th>Storage limits</th>
+            </tr>
+            </thead>
+            <tbody>
+              <%- if endpoints_constraints.any? %>
+                <%- endpoints_constraints.each do |endpoint, request, storage| %>
+                  <tr>
+                    <td style="width: 33%;"><%= endpoint %></td>
+                    <td style="width: 33%;"><%= request %></td>
+                    <td style="width: 33%;"><%= storage %></td>
+                  </tr>
+                <% end %>
+              <% else %>
+                <tr><td colspan="3" style="text-align: center;">No Constraints</tr>
+              <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    </li>
+    <li class="list-group-item">
+      <div class="row">
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr>
+              <th>Resources</th>
+              <th>Request limits</th>
+              <th>Storage limits</th>
+            </tr>
+            </thead>
+            <tbody>
+            <% if resources_constraints.any? %>
+              <%- resources_constraints.each do |endpoint, request, storage| %>
+                  <tr>
+                    <td style="width: 33%;"><%= endpoint %></td>
+                    <td style="width: 33%;"><%= request %></td>
+                    <td style="width: 33%;"><%= storage %></td>
+                  </tr>
+              <% end %>
+            <% else %>
+              <tr><td colspan="3" style="text-align: center;">No Constraints</tr>
+            <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    </li>
+    <li class="list-group-item">
+      <div class="row">
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr>
+              <th>Actions</th>
+              <th>Request limits</th>
+              <th>Storage limits</th>
+            </tr>
+            </thead>
+            <tbody>
+            <% if actions_constraints.any? %>
+              <%- actions_constraints.each do |endpoint, request, storage| %>
+                  <tr>
+                    <td style="width: 33%;"><%= endpoint %></td>
+                    <td style="width: 33%;"><%= request %></td>
+                    <td style="width: 33%;"> <%= storage %></td>
+                  </tr>
+              <% end %>
+            <% else %>
+              <tr><td colspan="3" style="text-align: center;">No Constraints</tr>
+            <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    </li>
+    <li class="list-group-item">
+      <div class="row">
+        <div class="col">
+          <table class="table">
+            <thead class="thead-default">
+            <tr>
+              <th>Scopes</th>
+              <th>Request limits</th>
+              <th>Storage limits</th>
+            </tr>
+            </thead>
+            <tbody>
+            <% if scopes_constraints.any? %>
+              <%- scopes_constraints.each do |endpoint, request, storage| %>
+                  <tr>
+                    <td style="width: 33%;"><%= endpoint %></td>
+                    <td style="width: 33%;"><%= request %></td>
+                    <td style="width: 33%;"><%= storage %></td>
+                  </tr>
+              <% end %>
+            <% else %>
+              <tr><td colspan="3" style="text-align: center;">No Constraints</tr>
+            <% end %>
+            </tbody>
+          </table>
+        </div>
+      </div>
+    </li>
+  </ul>
+</div>