csv_content_validator 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57fdd22b0982fc3f98f2dc04cf1b71bf28c3328c
+  data.tar.gz: f7b6435615313585e1abdb366e1f20e944c766a9
+SHA512:
+  metadata.gz: 2ae4b7f9fbc88d87f5120189e621a732c6a6edd40c07951a8cea3ea870335435034e854b0b6a44a5cbd544be4bbe3d037da3c83209924c5aac2056d0c1e528c4
+  data.tar.gz: 2ce7d91344b19c02ef3fc981d85d9794654a9e1f545af64a6c46c4ca9a9fd4b23254a3480fd70619990f0088854eacaf12275d18d04076ec05324acd915c2d8e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brian Lam
+
+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,46 @@
+# CsvContentValidator
+
+Ruby gem which will allow authors to validate the content of well-formed CSV files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+gem 'csv_content_validator'
+
+And then execute:
+
+$ bundle
+
+Or install it yourself as:
+
+$ gem install csv_content_validator
+
+## Usage
+
+```ruby
+require 'json'
+require 'validators/recipients_validator.rb'
+
+class RecipientsController < ApplicationController
+  def create
+render validator.render_errors(params[:csv_file].tempfile)
+  end
+
+  def update
+render validator.render_errors(params[:csv_file].tempfile, JSON.parse(params[:corrections]))
+  end
+
+  private
+  def validator
+  @validator ||= RecipientsValidator.new
+  end
+  end
+  ```
+## Contributing
+
+  1. Fork it ( https://github.com/[my-github-username]/csv_content_validator/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,2 @@
+require "bundler/gem_tasks"
+

data/csv_content_validator.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'csv_content_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "csv_content_validator"
+  spec.version       = CsvContentValidator::VERSION
+  spec.authors       = ["Brian Lam"]
+  spec.email         = ["brianlam93@gmail.com"]
+  spec.summary       = 'Validate the content of CSV files'
+  spec.description   = 'Validate the content of well-formed CSV files on server and client side'
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/csv_content_validator.rb

@@ -0,0 +1,117 @@
+require 'csv'
+require 'json'
+
+# Example VALIDATIONS object
+#  VALIDATIONS = 
+#  {
+#    validation_tests: {
+#      "column_name": { 
+#        functions: [:validation_method_1] }
+#        options: [{label: 'English', value: 'en'}, {label: 'German', 'gem'}]
+#    }
+#  }
+
+class Validator 
+  VALIDATIONS = 
+  {
+    validation_tests: { }
+  }
+
+  def validate_fatal_errors(csv_file)
+    fatal_errors = []
+    validations[:validation_tests].keys.each do |required_column|
+      unless csv_file.headers.include?(required_column.to_s) then
+        fatal_errors.push("Uploaded CSV missing required column '#{required_column}'")
+      end
+    end
+    return fatal_errors
+  end
+
+  def render_errors (csv_file, corrections=[])
+    begin
+      rows = validate_file(csv_file, corrections)
+      if rows[:errors] then
+        return {json: {errors:rows[:errors]}, :status => 420}
+      else
+        return {json: {validator: to_json, rows: rows[:rows]}}
+      end
+    rescue
+      puts "rescued!"
+      return {json: {errors: ["CSV file was malformed"]}, :status => 420 }
+    end
+  end
+
+  def validate_file! (csv_file, corrections)
+    csv_rows = CSV.read(csv_file, headers:true)
+
+    # check for fatal errors
+    fatal_errors = validate_fatal_errors(csv_rows)
+    return {errors:fatal_errors} unless fatal_errors.empty?
+    rows = []
+
+    # no fatal errors - validate cells accordingly
+    curr_correction_index = 0
+    CSV.foreach(csv_file, headers:true) do |row|
+      o = {}
+      if corrections[curr_correction_index] && $. === corrections[curr_correction_index]["number"] then
+        o = corrections[curr_correction_index]["row"]
+        curr_correction_index += 1
+      else
+        o = row.to_h
+      end
+      is_valid = true
+      o.keys.each do |column|
+        is_valid = is_valid && is_valid?(column, o[column])
+      end
+      unless is_valid then
+        rows << {number:$., row:o}
+      end
+    end
+
+    return {rows:rows}
+  end
+
+  def validate_file(csv_file, corrections)
+    return validate_file!(csv_file, corrections)
+  end
+
+  def is_valid? (column_name, value)
+    return true unless validations[:validation_tests].has_key?(column_name.to_sym) 
+
+    validation_tests = validations[:validation_tests][column_name.to_sym]
+    # call all methods
+    if validation_tests[:functions] then
+      validation_tests[:functions].each do |function|
+        return false unless send(function, value)
+      end
+    elsif validation_tests[:options] then
+      return true if value === "" && !validation_tests[:required]
+      return validation_tests[:options].any?{|option| option[:value] === value}
+    end
+
+    return true
+  end
+
+  def inspect
+    validations.inspect
+  end
+
+  def to_json
+    validations.to_json;
+  end
+
+  # General Validation Methods
+  def always_true value
+    true
+  end
+
+  def always_false value
+    false
+  end
+
+  private 
+
+  def validations
+    @validations ||= self.class::VALIDATIONS
+  end
+end 

data/lib/csv_content_validator/version.rb

@@ -0,0 +1,3 @@
+module CsvContentValidator
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: csv_content_validator
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brian Lam
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: Validate the content of well-formed CSV files on server and client side
+email:
+- brianlam93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- csv_content_validator.gemspec
+- lib/csv_content_validator.rb
+- lib/csv_content_validator/version.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Validate the content of CSV files
+test_files: []
+has_rdoc: