audit-log 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fe77595997c59059c5a91e1bc753aa017692ddea0a268dfa7f636304085d1d1
-  data.tar.gz: ddc300e06f79289ae8f5078479e272468df07d95992d82d6e20571515cdd6d2d
+  metadata.gz: e0f1ddb5d2e2f1d9b84d0e83a02a83990cce0cc0a1c7fd931d84a607af1f4837
+  data.tar.gz: 8b072cf51106505f2100aa4dd7760cfef429b131d79b9d3c78e5fe738fcd7769
 SHA512:
-  metadata.gz: a493e052a5429903138bfbde7476ad6268c2fc3eae34cce1b1d9e1c3d38ae958f17808e65a5dc8063834216dd893cb8e1c40e130a326dafa193656470c2338c0
-  data.tar.gz: 69df72ffd3c5e8912c8006f5fe0f8159d123f2075e3590c13b7853ad0258620e206f114c77644f32a9c1050087f032388d9344ef4520f3f5fe3d3b8312e1f5ac
+  metadata.gz: 619bdc22b753f80b8b221c4a47531d03f17eaffc19a5f36d3ae3fab4a03562e082eae95335f94dc717de6f5b4cada0a512936c0f62353d57106ff7065081272d
+  data.tar.gz: f79ea23624ed6ccce2b7e51c8cdfdbbc8cc8229f9f0b508dfa349a6d637215db1c8d79404a6154daf3a3a055422250a990e4757288317aa62734a479eebf8975

data/README.md

@@ -2,12 +2,25 @@
 
 Trail audit logs (Operation logs) into the database for user behaviors, including a web UI to query logs.
 
+[![Build Status](https://travis-ci.org/rails-engine/audit-log.svg?branch=master)](https://travis-ci.org/rails-engine/audit-log)
+
+## Demo UI
+
+Audit log list:
+
+<img width="870" src="https://user-images.githubusercontent.com/5518/58676735-e9570d80-838b-11e9-8ac0-6c5145b7fbb0.png">
+
+Detail page:
+
+<img width="870" src="https://user-images.githubusercontent.com/5518/58676737-e9570d80-838b-11e9-9292-63389b2d54cb.png">
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'audit-log'
+gem "audit-log"
 ```
 
 And then execute:
@@ -15,6 +28,12 @@ And then execute:
 $ bundle
 ```
 
+Generate files:
+
+```bash
+$ rails g audit_log:install
+```
+
 ## Usage
 
 Use in controllers:
@@ -22,15 +41,34 @@ Use in controllers:
 ```rb
 class TicktsController < ApplicationController
   def index
-    audit! :tickets, nil
+    audit! :list_ticket, nil
+  end
+
+  def create
+    if @ticket.save
+      audit! :create_ticket, @ticket, payload: ticket_params
+    else
+      render :new
+    end
   end
 
   def update
-    audit! :update_ticket, @ticket, payload: ticket_params
+    if @ticket.save
+      audit! :update_ticket, @ticket, payload: ticket_params
+    else
+      render :edit
+    end
+  end
+
+  def approve
+    if @ticket.approve
+      audit! :approve_ticket, @ticket, payload: ticket_params
+    end
   end
 
   def destroy
-    audit! :delete_ticket
+    # store original attributes for destroy for keep values
+    audit! :delete_ticket, nil, @ticket.attributes
   end
 
   private
@@ -49,6 +87,32 @@ AuditLog.audit!(:sign_in, @user, payload: { ip: request.ip })
 AuditLog.audit!(:create_address, nil, payload: params)
 ```
 
+Change `config/routes.rb` to add Route:
+
+```rb
+Rails.application.routes.draw do
+  authenticate :user, -> (u) { u.admin? } do
+    mount AuditLog::Engine => "/audit-log"
+  end
+end
+```
+
+I18n for audit names, you need create a `config/locales/audit_log.zh-CN.yml`:
+
+```yml
+zh-CN:
+  audit_log:
+    action:
+      sign_in: 登录
+      update_password: 修改密码
+      create_address: 添加住址
+      list_ticket: 查看工单列表
+      create_ticket: 创建工单
+      update_ticket: 更新工单
+      delete_ticket: 删除工单
+      approve_ticket: 审批工单
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,34 +1,34 @@
 # frozen_string_literal: true
 
 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"
+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")
+  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"
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
 
-load "rails/tasks/statistics.rake"
+load 'rails/tasks/statistics.rake'
 
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
-require "rake/testtask"
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
 

data/app/controllers/audit_log/logs_controller.rb

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

data/config/routes.rb

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

data/db/migrate/20190527035005_create_audit_logs.rb

@@ -1,17 +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
+    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 %w[record_type record_id], using: :btree
+      t.index %w[user_id action], using: :btree
+      t.index ['action'], using: :btree
     end
   end
 end

data/lib/audit-log.rb

@@ -1,17 +1,18 @@
-require_relative "./audit-log/version"
-require_relative "./audit-log/configuration"
-require_relative "./audit-log/model"
-require_relative "./audit-log/engine"
-require "kaminari"
+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.user_class = 'User'
+      @config.current_user_method = 'current_user'
+      @config.user_name_method = 'name'
       @config
     end
 
@@ -28,7 +29,7 @@ module AuditLog
         request_info = {
           ip: request.ip,
           url: request.url,
-          user_agent: request.user_agent,
+          user_agent: request.user_agent
         }
       end
 
@@ -41,4 +42,4 @@ module AuditLog
       )
     end
   end
-end
+end

data/lib/audit-log/controller_helper.rb

@@ -8,4 +8,4 @@ module AuditLog
       AuditLog.audit!(action, record, payload: payload, request: request, user: user)
     end
   end
-end
+end

data/lib/audit-log/engine.rb

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

data/lib/audit-log/model.rb

@@ -3,7 +3,7 @@ module AuditLog
     extend ActiveSupport::Concern
 
     included do
-      self.table_name = "audit_logs"
+      self.table_name = 'audit_logs'
 
       serialize :payload, JSON
       serialize :request, JSON
@@ -22,7 +22,7 @@ module AuditLog
     end
 
     def user_name
-      return "none" if self.user.blank?
+      return 'none' if self.user.blank?
 
       self.user.send(AuditLog.config.user_name_method)
     end
@@ -31,4 +31,4 @@ module AuditLog
       I18n.t("audit_log.action.#{self.action}", default: self.action)
     end
   end
-end
+end

data/lib/audit-log/version.rb

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

data/lib/generators/audit_log/install_generator.rb

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

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: audit-log
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: kaminari
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement