validation_auditor 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e11ee0bdea5ce733ed1a994b32c21c5de80bb239
-  data.tar.gz: 8d2b38478f274fa566e8691514ca701a932caa2e
+  metadata.gz: 411fc2578c6e75c4dd673dcaf450b9d983afee48
+  data.tar.gz: d43b3a6365daf49c9ab70203ea90e5dc4fcaa9b8
 SHA512:
-  metadata.gz: 80d6eaa8a29043d2d7d6b581469535a263efe1066a238094799028bdf5831045599d029b889ca7e717123a45bd1e3227ace941f91335ecd872ec7dc5de4a4c57
-  data.tar.gz: 77ef7c6da46f74b9017d049b7042e245138137c98d879f4fd3c20f54392c135adbd5c0b155096d31154fe686d79167b7ba44b2467c103a4d5ff0b67c8c6a637d
+  metadata.gz: ed77c23dc4170250a96ab8affc6d9893dc7283418d494a21600d567cd9c1fb941364bf5746e9fe57a214c170f9295c95eda7abf269cd524b8451559e95ff519c
+  data.tar.gz: 8e0ccfef2d9faf289a1a896574ae9bf5eb50686f39938478ce1bb55e70e30a14ea2f98d46bfc03e94a50e829f07941e004129abba548b657cb70ae4d5026f747

data/.travis.yml

@@ -2,5 +2,8 @@ language: ruby
 rvm:
   - "1.9.3"
   - "2.0.0"
+  - "2.1.2"
 gemfile:
+  - gemfiles/rails_3_2.Gemfile
   - gemfiles/rails_4_0.Gemfile
+  - gemfiles/rails_4_1.Gemfile

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## validation_auditor 0.1.1 (Jul 23, 2014) ##
+
+* Don't crash in the presence of file uploads when reporting validation errors.
+
+## validation_auditor 0.1.0 (January 8, 2014) ##
+
+* Everything

data/Gemfile

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

data/README.md

@@ -13,9 +13,9 @@ 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.
+This gem supports 
+[Rails 3.2, 4.0 and 4.1 running on Ruby 1.9, 2.0 or 2.1](https://travis-ci.org/watu/validation_auditor) (latest stable
+version of each).
 
 ## Installation
 

data/gemfiles/rails_3_2.Gemfile

@@ -3,14 +3,16 @@
 
 source "https://rubygems.org"
 
+gem "assert_difference"
 gem "bundler", "~> 1.3"
 gem "coveralls", require: false
-gem "minitest", "~> 2.5.1"
+gem "minitest"
 gem "minitest-reporters"
-gem "mocha"
+gem "minitest-rails"
 gem "rake"
 gem "simplecov"
 gem "shoulda"
 gem "sqlite3"
-gem "activesupport", "~> 3.2.0"
 gem "activerecord", "~> 3.2.0"
+gem "actionpack", "~> 3.2.0"
+gem "railties", "~> 3.2.0"

data/gemfiles/rails_4_0.Gemfile

@@ -6,8 +6,9 @@ source "https://rubygems.org"
 gem "assert_difference"
 gem "bundler", "~> 1.3"
 gem "coveralls", require: false
-gem "minitest", "~> 4.7.5"
+gem "minitest"
 gem "minitest-reporters"
+gem "minitest-rails"
 gem "rake"
 gem "simplecov"
 gem "shoulda"

data/gemfiles/rails_4_1.Gemfile

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

data/lib/validation_auditor.rb

@@ -14,10 +14,12 @@ module ValidationAuditor
     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
+
+    if respond_to? :attr_accessible # For Rails < 4 or Rails >= 4 with attr_accessible added by a third party library.
+      begin
+        attr_accessible
+      rescue RuntimeError # Rails 4 raises a RuntimeError when you call attr_accessible, but we still want to call it in case you added attr_accessible gem.
+      end
     end
   end
 
@@ -37,6 +39,21 @@ module ValidationAuditor
     def self.request
       Thread.current[:validation_auditor_request]
     end
+
+    # Clean parameters before storing them in the database.
+    def self.clean_params(params)
+      cleaned_params = {}
+      params.each do |k, v|
+        cleaned_params[k] = if v.is_a? Hash
+                              clean_params(v) # clean params recursively.
+                            elsif v.is_a? ActionDispatch::Http::UploadedFile
+                              v.inspect # UploadedFiles cannot be yaml-serialized, so, we replace them with a string.
+                            else
+                              v
+                            end
+      end
+      cleaned_params
+    end
   end
 
   module Model
@@ -61,7 +78,7 @@ module ValidationAuditor
         end
         if ValidationAuditor::Controller.request.present?
           request = ValidationAuditor::Controller.request
-          va.params = request.params
+          va.params = ValidationAuditor::Controller.clean_params(request.params)
           va.url = request.url
           va.user_agent = request.env["HTTP_USER_AGENT"]
         end

data/lib/validation_auditor/version.rb

@@ -2,5 +2,5 @@
 # Copyright © 2014, Watu
 
 module ValidationAuditor
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/test/controller_test.rb

@@ -21,7 +21,11 @@ class AuditedRecordsController < ActionController::Base
   private
 
   def audited_record_params
-    params.require(:audited_record).permit(:name, :email)
+    if params.respond_to?(:permit) # strong_parameters is present.
+      params.require(:audited_record).permit(:name, :email)
+    else
+      params[:audited_record]
+    end
   end
 end
 
@@ -35,6 +39,12 @@ class ControllerTest < ActionController::TestCase
     AuditedRecordsController.send(:include, @routes.url_helpers)
   end
 
+  should "clean params" do
+    cleaned_params = ValidationAuditor::Controller.clean_params({name: "John Doe", deep: {structure: {with: {file: ActionDispatch::Http::UploadedFile.new(tempfile: Tempfile.new("test.txt"))}}}})
+    assert_equal "John Doe", cleaned_params[:name]
+    assert cleaned_params[:deep][:structure][:with][:file].is_a? String
+  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"}
@@ -53,6 +63,18 @@ class ControllerTest < ActionController::TestCase
     assert_equal ["can't be blank"], audit.failures[:email]
   end
 
+  should "create a validation audit even when an uploaded file is in the params" do
+    assert_difference "ValidationAuditor::ValidationAudit.count" => +1 do
+      post :create, audited_record: {name: "John Doe"}, deep: {structure: {with: {file: ActionDispatch::Http::UploadedFile.new(tempfile: Tempfile.new("test.txt"))}}} # Missing email and a deep structure with a file in it.
+    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")

data/test/test_helper.rb

@@ -29,6 +29,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 
 # Database setup
 require "active_record"
+require "logger"
 ActiveRecord::Base.logger = Logger.new(STDERR)
 ActiveRecord::Base.logger.level = Logger::WARN
 ActiveRecord::Base.configurations = {"sqlite3" => {adapter: "sqlite3", database: ":memory:"}}

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: validation_auditor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - J. Pablo Fernández
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-07-23 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.
@@ -59,14 +59,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - gemfiles/rails_3_2.Gemfile
 - gemfiles/rails_4_0.Gemfile
+- gemfiles/rails_4_1.Gemfile
 - lib/generators/validation_auditor/install_generator.rb
 - lib/generators/validation_auditor/templates/migration.rb
 - lib/validation_auditor.rb
@@ -86,17 +88,17 @@ 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
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Log validation errors to the database for later inspection.