active_audit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3639ddec358dc194b95215ac12caa995fc05760f
+  data.tar.gz: 28917214926c09dab3beeb569c63ffaf46f4debe
+SHA512:
+  metadata.gz: 33ef0015420b4123923c6b0ce6c241f1fbafe353b4945ff49be485ac38ea00fe305c2c50620bf2196d968621e9a8560c26cca9ee71643c02891ca8568f1be365
+  data.tar.gz: eaa2b2385daf2418ac94a3eecc039e95c366e820e5653bc7b818345f96b8901db662124eb4b32cd3389cbf7b9adcb4db4101ae0d793153329df17a39c2fdbb93

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order defined

data/.travis.yml

@@ -0,0 +1,13 @@
+before_install:
+  - sudo apt-get install libxml2-dev
+cache: bundler
+language: ruby
+notifications:
+  email:
+    recipients:
+      - j.gomez@drexed.com
+    on_failure: change
+    on_success: never
+rvm:
+  - ruby-head
+script: 'bundle exec rake'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Juan Gomez
+
+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,82 @@
+# ActiveAudit
+
+[![Gem Version](https://badge.fury.io/rb/active_audit.svg)](http://badge.fury.io/rb/active_audit)
+[![Build Status](https://travis-ci.org/drexed/active_audit.svg?branch=master)](https://travis-ci.org/drexed/active_audit)
+[![Coverage Status](https://coveralls.io/repos/drexed/active_audit/badge.png)](https://coveralls.io/r/drexed/active_audit)
+
+ActiveAudit is a library for auditing record changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_audit'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_audit
+
+## Table of Contents
+
+* [Configurations](#configurations)
+* [Usage](#usage)
+
+## Configurations
+
+**Options:**
+ * auditor
+ * source
+
+`rails generate active_audit:install` will generate the following `active_audit.rb` file:
+
+```ruby
+# config/initalizers/active_audit.rb
+
+ActiveAudit.configure do |config|
+  # option = default
+
+  config.auditor = :current_user
+  config.source  = :app
+end
+
+# NOTE:
+# Will also generate the following files:
+# app/models/audit.rb
+# db/migrate/*_create_audits.rb
+```
+
+## Usage
+```ruby
+user = User.first.update(name: "bill")
+Audit.record!(user, :update, source: "api", remote_ip: "123.12.123.123")
+
+# OR:
+
+class Comment < ActiveRecord::Base
+
+  include ActiveAudit::Auditable
+
+  after_create :trigger_audit_create!
+  after_update :trigger_audit_update!
+  after_destroy :trigger_audit_destroy!
+
+end
+
+comment = Comment.create!(body: "Foobar comment")
+
+Audit.first #=> #<Audit id: 1, auditable_id: 1, auditable_type: "Comment", user_id: 1, source: 0, version: 0, action: "create", revisions: {"body"=>[nil, "Foobar"], "user_id"=>[nil, 1], "created_at"=>[nil, 2015-09-30 19:48:48 UTC], "updated_at"=>[nil, 2015-09-30 19:48:48 UTC], "id"=>[nil, 1]}, comment: "Foobar comment", remote_ip: nil, remote_uuid: nil, created_at: "2015-09-30 19:48:48", updated_at: "2015-09-30 19:48:48">
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/active_audit/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/gem_tasks"
+
+task default: :spec

data/active_audit.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_audit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_audit"
+  spec.version       = ActiveAudit::VERSION
+  spec.authors       = ["Juan Gomez"]
+  spec.email         = ["j.gomez@drexed.com"]
+
+  spec.summary       = %q{Gem for auditing record changes.}
+  spec.description   = %q{Library for auditing record changes.}
+  spec.homepage      = "https://github.com/drexed/active_audit"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "rails"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "generator_spec"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_audit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  active_audit:
+    archival:
+      archived: "Auditd"
+      unarchived: "Unarchived"

data/lib/active_audit/auditable.rb

@@ -0,0 +1,45 @@
+module ActiveAudit
+  module Auditable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :audits, as: :auditable
+
+      attr_accessor :audit_comment, :audit_remote_ip, :audit_remote_uuid, :audit_source
+
+      before_validation :set_audit_source!, if: -> (obj) { obj.audit_source.nil? }
+      before_destroy    :set_audit_source!, if: -> (obj) { obj.audit_source.nil? }
+    end
+
+    private
+
+    def audit_params
+      {
+        auditable:   self,
+        user:        ActiveAudit.configuration.auditor,
+        source:      audit_source,
+        revisions:   changes,
+        comment:     audit_comment,
+        remote_ip:   audit_remote_ip,
+        remote_uuid: audit_remote_uuid
+      }
+    end
+
+    def set_audit_source!
+      self.audit_source = ActiveAudit.configuration.source
+    end
+
+    def trigger_audit_create!
+      Audit.create!(audit_params.merge({ action: :create }))
+    end
+
+    def trigger_audit_update!
+      Audit.create!(audit_params.merge({ action: :update }))
+    end
+
+    def trigger_audit_destroy!
+      Audit.create!(audit_params.merge({ action: :destroy }))
+    end
+
+  end
+end

data/lib/active_audit/configuration.rb

@@ -0,0 +1,10 @@
+class ActiveAudit::Configuration
+
+  attr_accessor :auditor, :source
+
+  def initialize
+    @auditor = :current_user
+    @source  = :app
+  end
+
+end

data/lib/active_audit/version.rb

@@ -0,0 +1,3 @@
+module ActiveAudit
+  VERSION = "0.1.0"
+end

data/lib/active_audit.rb

@@ -0,0 +1,49 @@
+require "active_audit/version"
+require "active_audit/configuration"
+
+module ActiveAudit
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+end
+
+require "active_audit/auditable"
+require "generators/active_audit/install_generator"
+
+if defined?(Rails)
+  require 'rails'
+
+  module ActiveAudit
+    class Railtie < ::Rails::Railtie
+
+      initializer 'active_audit' do |app|
+        ActiveAudit::Railtie.instance_eval do
+          [app.config.i18n.available_locales].flatten.each do |locale|
+            (I18n.load_path << path(locale)) if File.file?(path(locale))
+          end
+        end
+      end
+
+      protected
+
+      def self.path(locale)
+        File.expand_path("../../config/locales/#{locale}.yml", __FILE__)
+      end
+
+    end
+  end
+end

data/lib/generators/active_audit/install_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+
+module ActiveAudit
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_migration_file
+      timestamp = [Time.now.utc.strftime("%Y%m%d%H%M%S"), "_"].join
+      copy_file("install_migration.rb", "db/migrate/#{timestamp if ActiveRecord::Base.timestamped_migrations }create_audits.rb")
+    end
+
+    def copy_initializer_file
+      copy_file("install_initializer.rb", "config/initializers/active_audit.rb")
+    end
+
+    def copy_model_file
+      copy_file("install_model.rb", "app/models/audit.rb")
+    end
+
+  end
+end

data/lib/generators/active_audit/templates/install_initializer.rb

@@ -0,0 +1,4 @@
+ActiveAudit.configure do |config|
+  config.auditor = :current_user
+  config.source  = :app
+end

data/lib/generators/active_audit/templates/install_migration.rb

@@ -0,0 +1,16 @@
+class CreateAudits < ActiveRecord::Migration
+  def change
+    create_table :audits do |t|
+      t.references :auditable,  null: false, index: true, polymorphic: true
+      t.references :user,       index: true
+      t.integer    :source,     null: false, default: 0
+      t.integer    :version,    null: false, default: 0
+      t.string     :action,     null: false
+      t.text       :revisions
+      t.text       :comment
+      t.string     :remote_ip
+      t.string     :remote_uuid
+      t.timestamps              null: false
+    end
+  end
+end

data/lib/generators/active_audit/templates/install_model.rb

@@ -0,0 +1,21 @@
+class Audit < ActiveRecord::Base
+
+  SOURCES = { app: 0, api: 1 }
+
+  belongs_to :auditable, polymorphic: true
+  belongs_to :user
+
+  enum source: SOURCES
+
+  serialize :revisions
+
+  validates :action,         presence: true
+  validates :auditable_id,   numericality: { integer: true }
+  validates :auditable_type, presence: true
+  validates :source,         inclusion: SOURCES.dup.keys.map { |key| key.to_s }
+  validates :user_id,        numericality: { integer: true },
+                             allow_blank: true,
+                             allow_nil: true
+  validates :version,        numericality: { integer: true }
+
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: active_audit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  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: Library for auditing record changes.
+email:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_audit.gemspec
+- bin/console
+- bin/rake
+- bin/setup
+- config/locales/en.yml
+- lib/active_audit.rb
+- lib/active_audit/auditable.rb
+- lib/active_audit/configuration.rb
+- lib/active_audit/version.rb
+- lib/generators/active_audit/install_generator.rb
+- lib/generators/active_audit/templates/install_initializer.rb
+- lib/generators/active_audit/templates/install_migration.rb
+- lib/generators/active_audit/templates/install_model.rb
+homepage: https://github.com/drexed/active_audit
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Gem for auditing record changes.
+test_files: []