validation_auditor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e11ee0bdea5ce733ed1a994b32c21c5de80bb239
+  data.tar.gz: 8d2b38478f274fa566e8691514ca701a932caa2e
+SHA512:
+  metadata.gz: 80d6eaa8a29043d2d7d6b581469535a263efe1066a238094799028bdf5831045599d029b889ca7e717123a45bd1e3227ace941f91335ecd872ec7dc5de4a4c57
+  data.tar.gz: 77ef7c6da46f74b9017d049b7042e245138137c98d879f4fd3c20f54392c135adbd5c0b155096d31154fe686d79167b7ba44b2467c103a4d5ff0b67c8c6a637d

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+coverage
+test/coverage

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+gemfile:
+  - gemfiles/rails_4_0.Gemfile

data/Gemfile

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+source "https://rubygems.org"
+
+gem "assert_difference"
+gem "bundler", "~> 1.3"
+gem "coveralls", require: false
+gem "minitest", "~> 4.7.5"
+gem "minitest-reporters"
+gem "rake"
+gem "simplecov"
+gem "shoulda"
+gem "sqlite3"
+gem "activerecord", "~> 4.0.0"
+gem "actionpack", "~> 4.0.0"
+gem "railties", "~> 4.0.0"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012, 2013, 2014, Watu
+
+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,61 @@
+# Validation Auditor
+
+[![Build Status](https://travis-ci.org/watu/validation_auditor.png?branch=master)](https://travis-ci.org/watu/validation_auditor)
+[![Coverage Status](https://coveralls.io/repos/watu/validation_auditor/badge.png?branch=master)](https://coveralls.io/r/watu/validation_auditor?branch=master)
+[![Code Climate](https://codeclimate.com/github/watu/validation_auditor.png)](https://codeclimate.com/github/watu/validation_auditor)
+[![Gem Version](https://badge.fury.io/rb/validation_auditor.png)](http://badge.fury.io/rb/validation_auditor)
+
+A user visits your web app, tries to do something with it but it fails due to a validation error. Generally, the
+validation is stopping a user from doing something bad, but every now and then it's the validation that is bad. Don't
+you hate it when the credit card processor won't accept your name as written in the credit card due to an unexpected
+character and won't accept anything else because that's not your name? We all do.
+
+This gem allows you to easily keep a log of validation errors, so you can later inspect them to try to find those cases
+where things are going wrong.
+
+This gem was extracted out of a Ruby 1.9 / Rails 3.2 project, but it's being prepared for work with Ruby 2.0 /
+Rails 4.0. The core functionality should work with Ruby 1.9 / Rails 3.2, if it doesn't, it's a bug. The tests, at the
+moment, are heavily dependent on Rails 4.0.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "validation_auditor"
+
+And then execute:
+
+    $ bundle
+
+You need to install the migration file in your Rails project, which you can do by:
+
+    $ rails generate validation_auditor:install
+
+## Usage
+
+After you run the migration, you need to enable the validation auditor in each model by calling the class method:
+`audit_validation_errors`, for example:
+
+    class Blog < ActiveRecord::Base
+      audit_validation_errors
+    end
+
+From then on, every time saving that record fails, a record will be saved to validation_audits with the failure message
+and some extra information.
+
+If you enable validation audit on the controller, by calling `audit_validation_errors` as in:
+
+    class BlogsController < ApplicationController
+      audit_validation_errors
+    end
+
+then you'll also get params, url and user agent in the validation audit. This breaks the model-controller separation, so
+it's optional.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/gemfiles/rails_3_2.Gemfile

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# Copyright © 2013, 2014, Watu
+
+source "https://rubygems.org"
+
+gem "bundler", "~> 1.3"
+gem "coveralls", require: false
+gem "minitest", "~> 2.5.1"
+gem "minitest-reporters"
+gem "mocha"
+gem "rake"
+gem "simplecov"
+gem "shoulda"
+gem "sqlite3"
+gem "activesupport", "~> 3.2.0"
+gem "activerecord", "~> 3.2.0"

data/gemfiles/rails_4_0.Gemfile

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+source "https://rubygems.org"
+
+gem "assert_difference"
+gem "bundler", "~> 1.3"
+gem "coveralls", require: false
+gem "minitest", "~> 4.7.5"
+gem "minitest-reporters"
+gem "rake"
+gem "simplecov"
+gem "shoulda"
+gem "sqlite3"
+gem "activerecord", "~> 4.0.0"
+gem "actionpack", "~> 4.0.0"
+gem "railties", "~> 4.0.0"

data/lib/generators/validation_auditor/install_generator.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
+# Extend the DelayedJobGenerator so that it creates an AR migration
+module ValidationAuditor
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    self.source_paths << File.join(File.dirname(__FILE__), "templates")
+
+    def create_migration_file
+      migration_template "migration.rb", "db/migrate/create_validation_audits.rb"
+    end
+
+    # Implement the required interface for Rails::Generators::Migration.
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/validation_auditor/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateValidationAudits < ActiveRecord::Migration
+  def up
+    create_table :validation_audits do |t|
+      t.integer :record_id
+      t.string :record_type
+      t.text :failure_messages
+      t.text :failures
+      t.text :data
+      t.text :params
+      t.text :url
+      t.text :user_agent
+      t.timestamps
+    end
+
+    add_index :validation_audits, :created_at
+  end
+end

data/lib/validation_auditor.rb

@@ -0,0 +1,75 @@
+# encoding: UTF-8
+# Copyright © 2012, 2013, 2014, Watu
+
+require "validation_auditor/version"
+require "active_record"
+require "action_controller"
+
+module ValidationAuditor
+  class ValidationAudit < ActiveRecord::Base
+    belongs_to :record, :polymorphic => true
+
+    serialize :failures, Hash
+    serialize :failure_messages, Array
+    serialize :data, Hash
+    serialize :params, Hash
+
+    # Define no accessibility to the attributes but don't crash if attr_accessible is the default Rails 4 one, which raises an exception.
+    begin
+      attr_accessible # Nothing
+    rescue RuntimeError
+    end
+  end
+
+  module Controller
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def audit_validation_errors
+        before_filter :make_request_auditable
+      end
+    end
+
+    def make_request_auditable
+      Thread.current[:validation_auditor_request] = self.request
+    end
+
+    def self.request
+      Thread.current[:validation_auditor_request]
+    end
+  end
+
+  module Model
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def audit_validation_errors
+        after_rollback :audit_validation
+      end
+    end
+
+    def audit_validation
+      if !errors.empty? # We don't use :valid? to avoid re-running validations
+        va = ValidationAudit.new
+        va.failures = self.errors.to_hash
+        va.failure_messages = self.errors.full_messages.to_a
+        va.data = self.attributes
+        if self.new_record? # For new records
+          va.record_type = self.class.name # we only store the class's name.
+        else
+          va.record = self
+        end
+        if ValidationAuditor::Controller.request.present?
+          request = ValidationAuditor::Controller.request
+          va.params = request.params
+          va.url = request.url
+          va.user_agent = request.env["HTTP_USER_AGENT"]
+        end
+        va.save
+      end
+    end
+  end
+end
+
+ActionController::Base.send(:include, ValidationAuditor::Controller)
+ActiveRecord::Base.send(:include, ValidationAuditor::Model)

data/lib/validation_auditor/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+module ValidationAuditor
+  VERSION = "0.1.0"
+end

data/test/controller_test.rb

@@ -0,0 +1,80 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+require_relative "test_helper"
+
+# Controller setup
+class AuditedRecordsController < ActionController::Base
+  audit_validation_errors
+
+  def create
+    @audited_record = AuditedRecord.create(audited_record_params)
+    render text: ""
+  end
+
+  def update
+    @audited_record = AuditedRecord.find(params[:id])
+    @audited_record.update_attributes(audited_record_params)
+    render text: ""
+  end
+
+  private
+
+  def audited_record_params
+    params.require(:audited_record).permit(:name, :email)
+  end
+end
+
+class ControllerTest < ActionController::TestCase
+  setup do
+    @controller = AuditedRecordsController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+    @routes = ActionDispatch::Routing::RouteSet.new
+    @routes.draw { resources :audited_records }
+    AuditedRecordsController.send(:include, @routes.url_helpers)
+  end
+
+  should "not create a validation audit due to no validation failing when creating a new record" do
+    assert_difference "ValidationAuditor::ValidationAudit.count" => 0 do
+      post :create, audited_record: {name: "John Doe", email: "john.doe@example.com"}
+    end
+  end
+
+  should "create a validation audit when creating a new record" do
+    assert_difference "ValidationAuditor::ValidationAudit.count" => +1 do
+      post :create, audited_record: {name: "John Doe"} # Missing email
+    end
+    audit = ValidationAuditor::ValidationAudit.order(:id).last
+    assert_nil audit.record # New records cannot be referenced because they don't exist...
+    assert_equal "AuditedRecord", audit.record_type # but we still record the name.
+    assert_equal audit.data["name"], "John Doe"
+    assert_nil audit.data["email"]
+    assert_equal ["can't be blank"], audit.failures[:email]
+  end
+
+  context "With a record" do
+    setup do
+      @audited_record = AuditedRecord.create(name: "John Doe", email: "john.doe@example.com")
+    end
+
+    should "not create a validation audit due to no validation failing when updating an existing record" do
+      assert_difference "ValidationAuditor::ValidationAudit.count" => 0 do
+        put :update, id: @audited_record.id, audited_record: {name: "John Smith", email: "john.smith@example.com"}
+      end
+    end
+
+    should "create a validation audit due to no validation failing when updating an existing record" do
+      assert_difference "ValidationAuditor::ValidationAudit.count" => +1 do
+        put :update, id: @audited_record.id, audited_record: {name: "John Smith", email: ""} # Missing email
+      end
+      @audited_record.reload
+      audit = ValidationAuditor::ValidationAudit.order(:id).last
+      assert_equal @audited_record, audit.record
+      assert_equal audit.data["name"], "John Smith"
+      assert audit.data["email"].blank?
+      assert_equal ["can't be blank"], audit.failures[:email]
+      assert_equal audit.params, @request.params
+    end
+  end
+end

data/test/install_generator_test.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+require_relative "test_helper"
+
+require "generators/validation_auditor/install_generator"
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests ValidationAuditor::InstallGenerator
+  destination File.expand_path("../../tmp", __FILE__)
+
+  should "generate migration" do
+    prepare_destination
+    run_generator ["validation_auditor:install"]
+    migration_dir = File.join(destination_root, "db", "migrate")
+    assert File.directory?(migration_dir)
+    migration_files = Dir["#{migration_dir}/*"]
+    assert_equal 1, migration_files.count
+    File.open(migration_files.first) do |migration|
+      assert migration.read.include?("create_table :validation_audits")
+    end
+  end
+end
+

data/test/model_test.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+require_relative "test_helper"
+
+class ModelTest < ActiveSupport::TestCase
+  should "not create a validation audit when no errors occurs" do
+    assert_difference "ValidationAuditor::ValidationAudit.count" => 0 do
+      AuditedRecord.create!(name: "John Doe", email: "john.doe@example.com")
+    end
+  end
+
+  should "create a validation audit when an errors occur for a new record" do
+    assert_difference "ValidationAuditor::ValidationAudit.count" => +1 do
+      AuditedRecord.create(name: "John Doe") # Missing email.
+    end
+    audit = ValidationAuditor::ValidationAudit.order(:id).last
+    assert_nil audit.record # New records cannot be referenced because they don't exist...
+    assert_equal "AuditedRecord", audit.record_type # but we still record the name.
+    assert_equal audit.data["name"], "John Doe"
+    assert_nil audit.data["email"]
+    assert_equal ["can't be blank"], audit.failures[:email]
+  end
+
+  should "create a validation audit when an errors occur for an existing record" do
+    audited_record = AuditedRecord.create!(name: "John Doe", email: "john.doe@example.com")
+    assert_difference "ValidationAuditor::ValidationAudit.count" => +1 do
+      audited_record.name = "John Smith"
+      audited_record.email = nil # Missing email.
+      audited_record.save
+    end
+    audit = ValidationAuditor::ValidationAudit.order(:id).last
+    assert_equal audited_record, audit.record
+    assert_equal audit.data["name"], "John Smith"
+    assert_nil audit.data["email"]
+    assert_equal ["can't be blank"], audit.failures[:email]
+  end
+
+  should "not create a validation audit when no errors occurs for an existing record" do
+    audited_record = AuditedRecord.create!(name: "John Doe", email: "john.doe@example.com")
+    assert_difference "ValidationAuditor::ValidationAudit.count" => 0 do
+      audited_record.name = "John Smith"
+      audited_record.email = "john.smith@example.com"
+      audited_record.save!
+    end
+  end
+
+  should "not create a validation audit for non audited models" do
+    assert_difference "ValidationAuditor::ValidationAudit.count" => 0 do
+      NonAuditedRecord.create(name: "John Doe") # Missing email.
+    end
+  end
+end
+
+
+
+

data/test/test_helper.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+# Copyright © 2013, 2014, Watu
+
+require "rubygems"
+
+# Test coverage
+require "simplecov"
+require "coveralls"
+SimpleCov.start do
+  add_filter "/test/"
+end
+Coveralls.wear! # Comment out this line to have the local coverage generated.
+
+require "minitest/autorun"
+require "minitest/reporters"
+MiniTest::Reporters.use!
+
+require "active_support/test_case"
+require "action_controller"
+require "action_controller/test_case"
+
+require "shoulda"
+require "shoulda-context"
+require "shoulda-matchers"
+
+# Make the code to be tested easy to load.
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+# Database setup
+require "active_record"
+ActiveRecord::Base.logger = Logger.new(STDERR)
+ActiveRecord::Base.logger.level = Logger::WARN
+ActiveRecord::Base.configurations = {"sqlite3" => {adapter: "sqlite3", database: ":memory:"}}
+ActiveRecord::Base.establish_connection("sqlite3")
+
+# Models setup.
+require "validation_auditor"
+ActiveRecord::Schema.define(version: 0) do
+  create_table :audited_records do |t|
+    t.string :name
+    t.string :email
+  end
+  create_table :non_audited_records do |t|
+    t.string :name
+    t.string :email
+  end
+end
+class AuditedRecord < ActiveRecord::Base
+  audit_validation_errors
+  validates :email, presence: true
+end
+class NonAuditedRecord < ActiveRecord::Base
+  validates :email, presence: true
+end
+require "generators/validation_auditor/templates/migration"
+CreateValidationAudits.migrate("up")
+
+# Shutup.
+I18n.enforce_available_locales = false # TODO: remove this line when it's not needed anymore.
+
+require "assert_difference"
+class ActiveSupport::TestCase
+  include AssertDifference
+end

data/validation_auditor.gemspec

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+# Copyright © 2014, Watu
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validation_auditor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "validation_auditor"
+  spec.version       = ValidationAuditor::VERSION
+  spec.authors       = ["J. Pablo Fernández"]
+  spec.email         = ["pupeno@watuapp.com"]
+  spec.description   = %q{Log validation errors to the database for later inspection.}
+  spec.summary       = %q{Log validation errors to the database for later inspection.}
+  spec.homepage      = "https://github.com/watu/validation_auditor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "activerecord", "> 3.2.0"
+  spec.add_dependency "actionpack", "> 3.2.0"
+  spec.add_dependency "railties", "> 3.2.0"
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: validation_auditor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- J. Pablo Fernández
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Log validation errors to the database for later inspection.
+email:
+- pupeno@watuapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/rails_3_2.Gemfile
+- gemfiles/rails_4_0.Gemfile
+- lib/generators/validation_auditor/install_generator.rb
+- lib/generators/validation_auditor/templates/migration.rb
+- lib/validation_auditor.rb
+- lib/validation_auditor/version.rb
+- test/controller_test.rb
+- test/install_generator_test.rb
+- test/model_test.rb
+- test/test_helper.rb
+- validation_auditor.gemspec
+homepage: https://github.com/watu/validation_auditor
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Log validation errors to the database for later inspection.
+test_files:
+- test/controller_test.rb
+- test/install_generator_test.rb
+- test/model_test.rb
+- test/test_helper.rb