audit-log 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3fe77595997c59059c5a91e1bc753aa017692ddea0a268dfa7f636304085d1d1
+  data.tar.gz: ddc300e06f79289ae8f5078479e272468df07d95992d82d6e20571515cdd6d2d
+SHA512:
+  metadata.gz: a493e052a5429903138bfbde7476ad6268c2fc3eae34cce1b1d9e1c3d38ae958f17808e65a5dc8063834216dd893cb8e1c40e130a326dafa193656470c2338c0
+  data.tar.gz: 69df72ffd3c5e8912c8006f5fe0f8159d123f2075e3590c13b7853ad0258620e206f114c77644f32a9c1050087f032388d9344ef4520f3f5fe3d3b8312e1f5ac

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Jason Lee
+
+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,54 @@
+# AuditLog
+
+Trail audit logs (Operation logs) into the database for user behaviors, including a web UI to query logs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'audit-log'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Usage
+
+Use in controllers:
+
+```rb
+class TicktsController < ApplicationController
+  def index
+    audit! :tickets, nil
+  end
+
+  def update
+    audit! :update_ticket, @ticket, payload: ticket_params
+  end
+
+  def destroy
+    audit! :delete_ticket
+  end
+
+  private
+
+    def ticket_params
+      params.required(:ticket).permit!(:title, :description, :status)
+    end
+end
+```
+
+In models or other places:
+
+```rb
+AuditLog.audit!(:update_password, @user, payload: { ip: request.ip })
+AuditLog.audit!(:sign_in, @user, payload: { ip: request.ip })
+AuditLog.audit!(:create_address, nil, payload: params)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  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    = "AuditLog"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/exception_track_manifest.js

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

data/app/assets/stylesheets/audit-log/application.css

@@ -0,0 +1,205 @@
+
+body {
+  margin: 0;
+  padding: 20px 0;
+  background-color: #eee;
+}
+
+body, textarea {
+  font-family: -apple-system, BlinkMacSystemFont, "Helvetica Neue", Arial, Helvetica, sans-serif;
+  font-size: 14px;
+  line-height: 1.4;
+  color: #333;
+}
+
+.footer {
+  padding: 15px;
+  text-align: center;
+  color: #999;
+}
+.footer a:link,
+.footer a:visited { color: #666; text-decoration: underline;}
+
+a, a:visited, a:active {
+  color: #364cc9;
+  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 1px #e0e0e0;
+}
+
+td.date { width: 150px; font-size: 12px; }
+
+h1 {
+  margin-top: 0;
+  font-size: 20px;
+  font-weight: bold;
+}
+
+h1, p {
+  margin-bottom: 20px;
+}
+
+h3 {
+  text-align: center;
+}
+
+ul {
+  list-style-type: none;
+  padding: 0;
+  margin: 0;
+}
+
+table td, table th {
+  padding: 10px 15px;
+}
+th { background: #f5f5f5; border-bottom: 1px solid #e0e0e0; }
+td {
+  border-top: solid 1px #e0e0e0;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  white-space: pre-wrap;
+  word-break: break-word;
+}
+
+textarea {
+  width: 100%;
+  height: 100px;
+  border: solid 1px #ddd;
+  padding: 10px;
+}
+
+hr {
+  border: none;
+  height: 0;
+  border-top: solid 1px #ddd;
+  margin-bottom: 15px;
+}
+
+.btn {
+  display: inline-block;
+  margin-bottom: 0;
+  font-size: 14px;
+  font-weight: 400;
+  line-height: 1.42857143;
+  text-align: center;
+  white-space: nowrap;
+  vertical-align: middle;
+  cursor: pointer;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+  border-radius: 3px;
+  border: 1px solid #ccc;
+  padding: 6px 16px;
+  color: #555 !important;
+  outline: 0 !important;
+  background: #FFF;
+}
+.btn:hover { text-decoration: none !important; background: #f7f7f7; }
+.btn-danger { background: #fff; color: #E33F00 !important; border-color: #E33F00;}
+.btn-danger:hover {
+  background: #FCEDEC;
+}
+
+.form-control {
+  font-size: 14px;
+  line-height: 1.42857143;
+  border: 1px solid #ccc;
+  padding: 6px 16px;
+  outline: 0 !important;
+  border-radius: 3px;
+}
+.container {
+  max-width: 1000px;
+  margin-left: auto;
+  margin-right: auto;
+  padding: 20px;
+  background-color: #fff;
+  box-shadow: 0 1px 8px rgba(200, 200, 200, 0.26);
+  border-radius: 3px;
+}
+
+.no-record {
+  padding: 50px;
+  text-align: center;
+  font-size: 16px;
+}
+
+.toolbar {
+  margin-bottom: 15px;
+  height: 34px;
+  line-height: 34px;
+}
+.toolbar form { display: inline; }
+.toolbar .pull-right { float: right; }
+
+#notice {
+  padding: 8px 15px;
+  background: #3CBD46;
+  color: #fff;
+  margin-bottom: 15px;
+  border-radius: 3px;
+}
+
+pre {
+  background: #f7f7f7;
+  padding: 8px;
+  border-radius: 3px;
+  font-size: 12px;
+  font-family: Menlo, Monaco, Consolas, monospace;
+}
+
+h1 { font-size: 16px; }
+
+.pagination {
+  padding-bottom: 15px;
+  font-size: 14px;
+}
+
+.pagination li { display: inline; }
+
+.pagination a {
+  display: inline-block;
+  padding: 5px 10px;
+  border: 1px solid #eee;
+  color: #555;
+  text-decoration: none;
+}
+.pagination a:hover {
+  background: #f7f7f7;
+}
+.pagination em,
+.pagination .current {
+  display: inline-block;
+  padding: 5px 10px;
+  border: 1px solid #f0f0f0;
+  background: #f0f0f0;
+  font-style: normal;
+}
+
+.detail-group {
+  margin-bottom: 8px;
+}
+.detail-group .control-label {
+  width: 120px;
+  color: #777;
+  display: inline-block;
+}

data/app/controllers/audit_log/logs_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AuditLog
+  class LogsController < ActionController::Base
+    layout "audit-log/application"
+    before_action :set_log, only: %i[show destroy]
+
+    def index
+      @logs = Log.order("id desc").includes(:user)
+
+      if params[:q]
+        @logs = @logs.where("action like ?", "%#{params[:q]}%")
+      end
+
+      @logs = @logs.page(params[:page]).per(15)
+    end
+
+    def show; end
+
+    private
+
+      # Use callbacks to share common setup or constraints between actions.
+      def set_log
+        @log = Log.find(params[:id])
+      end
+  end
+end

data/app/models/audit_log/log.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module AuditLog
+  class Log < ActiveRecord::Base
+    include AuditLog::Model
+  end
+end

data/app/views/audit_log/logs/index.html.erb

@@ -0,0 +1,41 @@
+<div class="toolbar">
+  <form class="form-inline" action="<%= audit_log.logs_path %>" method="GET">
+    <div class="form-group">
+      <input name="q" type="text" class="form-control" placeholder="Search action" value="<%= params[:q] %>" />
+      <button type="submit" class="btn btn-primary">Search</button>
+    </div>
+  </form>
+</div>
+<% if @logs.blank? %>
+  <div class="no-record">No audit logs.</div>
+<% else %>
+  <%= paginate @logs %>
+
+  <table class="table table-borded">
+    <thead>
+      <tr>
+        <th>#</th>
+        <th>User</th>
+        <th>Action</th>
+        <th class="date"></th>
+        <th></th>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% @logs.each do |log| %>
+        <tr>
+          <td><%= log.id %></td>
+          <td><%= log.user_name %></td>
+          <td><%= log.action_name %></td>
+          <td class="date"><%= log.created_at.to_s %></td>
+          <td>
+            <%= link_to "View", audit_log.log_path(log.id) %>
+          </td>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+
+  <%= paginate @logs %>
+<% end %>

data/app/views/audit_log/logs/show.html.erb

@@ -0,0 +1,41 @@
+<div class="toolbar">
+  <%= link_to 'Back', logs_path, class: 'btn' %>
+</div>
+
+<div class="audit-log-detail">
+<h1><%= @log.action_name %></h1>
+
+<div class="detail-group">
+  <label class="control-label">User:</label>
+  <%= @log.user_name %>
+</div>
+
+<div class="detail-group">
+  <label class="control-label">Time:</label>
+  <%= @log.created_at %>
+</div>
+
+<div class="detail-group">
+  <label class="control-label">URL:</label>
+  <%= @log.request["url"] %>
+</div>
+
+<div class="detail-group">
+  <label class="control-label">IP Address:</label>
+  <%= @log.request["ip"] %>
+</div>
+
+<div class="detail-group">
+  <label class="control-label">User Agent:</label>
+  <%= @log.request["user_agent"] %>
+</div>
+
+<h4>Payload<h4>
+<pre class="payload"><%= JSON.pretty_generate(@log.payload) %></pre>
+
+<% if @log.record %>
+<h4>Record<h4>
+<pre class="payload"><%= JSON.pretty_generate(@log.record.as_json) %></pre>
+<% end %>
+
+

data/app/views/layouts/audit-log/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Audit Log</title>
+  <%= stylesheet_link_tag "audit-log/application", media: "all" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<div class="container">
+  <% if notice %>
+  <div id="notice"><%= notice %></div>
+  <% end %>
+
+  <%= yield %>
+</div>
+
+<div class="footer">
+  <a href="https://github.com/rails-engine/audit-log">AuditLog</a> powered.
+</div>
+
+</body>
+</html>

data/config/initializers/audit-log.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+AuditLog.configure do
+  # class name of you User model, default: 'User'
+  # self.user_class = "User"
+  # current_user method name in your Controller, default: 'current_user'
+  # self.current_user_method = "current_user"
+end

data/config/routes.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+AuditLog::Engine.routes.draw do
+  resources :logs, path: ""
+end

data/db/migrate/20190527035005_create_audit_logs.rb

@@ -0,0 +1,17 @@
+class CreateAuditLogs < ActiveRecord::Migration[5.0]
+  def change
+    create_table "audit_logs", force: :cascade do |t|
+      t.string "action", null: false
+      t.integer "user_id"
+      t.integer "record_id"
+      t.string "record_type"
+      t.text "payload"
+      t.text "request"
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.index ["record_type", "record_id"], using: :btree
+      t.index ["user_id", "action"], using: :btree
+      t.index ["action"], using: :btree
+    end
+  end
+end

data/lib/audit-log.rb

@@ -0,0 +1,44 @@
+require_relative "./audit-log/version"
+require_relative "./audit-log/configuration"
+require_relative "./audit-log/model"
+require_relative "./audit-log/engine"
+require "kaminari"
+
+module AuditLog
+  class << self
+    def config
+      return @config if defined?(@config)
+      @config = Configuration.new
+      @config.user_class = "User"
+      @config.current_user_method = "current_user"
+      @config.user_name_method = "name"
+      @config
+    end
+
+    def configure(&block)
+      config.instance_exec(&block)
+    end
+
+    # Create an audit log
+    #
+    # AuditLog.audit!(:edit_account, @account, payload: account_params, user: current_user)
+    def audit!(action, record = nil, payload: nil, user: nil, request: nil)
+      request_info = {}
+      if request
+        request_info = {
+          ip: request.ip,
+          url: request.url,
+          user_agent: request.user_agent,
+        }
+      end
+
+      AuditLog::Log.create!(
+        action: action,
+        record: record,
+        payload: (payload || {}).to_h.deep_stringify_keys,
+        user: user,
+        request: request_info.deep_stringify_keys
+      )
+    end
+  end
+end

data/lib/audit-log/configuration.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module AuditLog
+  class Configuration
+    # class name of you User model, default: 'User'
+    attr_accessor :user_class
+
+    # current_user method name in your Controller, default: 'current_user'
+    attr_accessor :current_user_method
+
+    # user name method, default: "name"
+    attr_accessor :user_name_method
+  end
+end

data/lib/audit-log/controller_helper.rb

@@ -0,0 +1,11 @@
+module AuditLog
+  module ControllerHelper
+    # Create an audit log
+    #
+    # audit!(:edit_account, @account, payload: account_params)
+    def audit!(action, record = nil, payload: nil, user: nil)
+      user ||= self.send(AuditLog.config.current_user_method.to_sym)
+      AuditLog.audit!(action, record, payload: payload, request: request, user: user)
+    end
+  end
+end

data/lib/audit-log/engine.rb

@@ -0,0 +1,11 @@
+require_relative "./controller_helper"
+
+module AuditLog
+  class Engine < Rails::Engine
+    isolate_namespace AuditLog
+
+    ActiveSupport.on_load(:action_controller_base) do
+      prepend AuditLog::ControllerHelper
+    end
+  end
+end

data/lib/audit-log/model.rb

@@ -0,0 +1,34 @@
+module AuditLog
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      self.table_name = "audit_logs"
+
+      serialize :payload, JSON
+      serialize :request, JSON
+
+      belongs_to :user, class_name: AuditLog.config.user_class, required: false
+      belongs_to :record, polymorphic: true, required: false
+
+      validates :action, presence: true
+
+      after_initialize :initialize_payload_request
+    end
+
+    def initialize_payload_request
+      self.payload = {} if payload.nil?
+      self.request = {} if request.nil?
+    end
+
+    def user_name
+      return "none" if self.user.blank?
+
+      self.user.send(AuditLog.config.user_name_method)
+    end
+
+    def action_name
+      I18n.t("audit_log.action.#{self.action}", default: self.action)
+    end
+  end
+end

data/lib/audit-log/version.rb

@@ -0,0 +1,3 @@
+module AuditLog
+  VERSION = '0.1.0'
+end

data/lib/generators/audit_log/install_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+module AuditLog
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Create AuditLog's base files"
+      source_root File.expand_path("../../..", __dir__)
+
+      def add_initializer
+        template "config/initializers/audit-log.rb", "config/initializers/audit-log.rb"
+      end
+
+      def add_migrations
+        exec("rake audit_log:install:migrations")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: audit-log
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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'
+description: Trail audit logs (Operation logs) into the database for user behaviors,
+  including a web UI to query logs.
+email:
+- huacnlee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/exception_track_manifest.js
+- app/assets/stylesheets/audit-log/application.css
+- app/controllers/audit_log/logs_controller.rb
+- app/models/audit_log/log.rb
+- app/views/audit_log/logs/index.html.erb
+- app/views/audit_log/logs/show.html.erb
+- app/views/layouts/audit-log/application.html.erb
+- config/initializers/audit-log.rb
+- config/routes.rb
+- db/migrate/20190527035005_create_audit_logs.rb
+- lib/audit-log.rb
+- lib/audit-log/configuration.rb
+- lib/audit-log/controller_helper.rb
+- lib/audit-log/engine.rb
+- lib/audit-log/model.rb
+- lib/audit-log/version.rb
+- lib/generators/audit_log/install_generator.rb
+homepage: https://github.com/rails-engine/audit-log
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Trail audit logs (Operation logs) into the database for user behaviors, including
+  a web UI to query logs
+test_files: []