validaform 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c005a5f1f3f8768545e904ac1ede42b8a6b5d03
+  data.tar.gz: fd1d19204dc5ffb31b88e59aed7a53bde37b0b0b
+SHA512:
+  metadata.gz: ec7c2fb4e6ad31a228a0b4db06be35f27accacb73485b79b56eaad824768f7c8fc881da9d1fcd802761eb18f1f3ac906d967824dbce1f132d16ca7182f337c02
+  data.tar.gz: 84637f5e5ef55e6f4ff3d5652dd4eea47819baae1236e3e1231253c0f134db74af6f75d9f44f384df67a2515f5de536da3a4ae3a22a0b30a689690f3e365cbed

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 poilon
+
+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,28 @@
+# Validaform
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validaform'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install validaform
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Validaform'
+  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", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/validaform/application_controller.rb

@@ -0,0 +1,7 @@
+module Validaform
+  class ApplicationController < ActionController::Base
+
+    protect_from_forgery with: :exception
+
+  end
+end

data/app/controllers/validaform/forms_controller.rb

@@ -0,0 +1,16 @@
+module Validaform
+  class FormsController < Validaform::ApplicationController
+
+    skip_before_action :verify_authenticity_token
+
+    # curl -X POST -H 'Content-Type: application/json' -d \
+    # '{"fields":[{"name":"users/first_name","value":"Asterix"},
+    # {"name":"users/last_name","value":"LeGaulois"}, {"name":"companies/size", "value":"17"}]}' \
+    # http://localhost:3000/validaform/forms/validate
+    def validate
+      validator = Validaform::Base.new(params: params)
+      render json: validator.errors, status: validator.status_code
+    end
+
+  end
+end

data/config/routes.rb

@@ -0,0 +1,9 @@
+Validaform::Engine.routes.draw do
+
+  resources :forms do
+    collection do
+      post 'validate'
+    end
+  end
+
+end

data/lib/validaform.rb

@@ -0,0 +1,128 @@
+require 'validaform/engine'
+
+module Validaform
+  class Base
+
+    attr_reader :fields
+    attr_accessor :status_code
+
+    def initialize(params:)
+      @fields = params.permit(fields: %i[name value]).to_h[:fields]
+      @status_code = 200
+    end
+
+    # fields =>
+    # [
+    #   { name: 'users/first_name', value: 'Asterix' }
+    # ]
+    # errors will return
+    # {
+    #   fields:[
+    #     {
+    #       name: 'users/first_name',
+    #       errors: ['too_short', 'too_long'],
+    #       count: 2
+    #     }
+    #   ],
+    #   count: 2
+    # }
+    def errors
+      errors_hash = { fields: [] }
+      parse_fields.map do |resource, fields|
+        resource_class = resource_class(resource)
+        dev_errors = handle_development_errors(resource, resource_class, fields)
+        return dev_errors if dev_errors.present?
+        generate_errors_hash(resource, resource_class, fields, errors_hash)
+      end
+      errors_hash[:count] = total_errors_count(errors_hash)
+      errors_hash
+    end
+
+    private
+
+    # fields =>
+    # [
+    #   { name: 'users/first_name', value: 'Asterix' },
+    #   { name: 'users/last_name', value: 'LeGaulois' },
+    #   { name: 'companies/name', value: 'PotionCorp' }
+    # ]
+    # parse_field transforms it to
+    #
+    #  {
+    #    users: {
+    #      first_name: 'Asterix',
+    #      last_name: 'LeGaulois'
+    #    },
+    #    companies: { name: 'PotionCorp' }
+    #  }
+    def parse_fields
+      fields.each_with_object({}) do |f, h|
+        h[f[:name].split('/').first] ||= {}
+        h[f[:name].split('/').first][f[:name].split('/').last] = f[:value]
+      end
+    end
+
+    # Count the global errors count
+    def total_errors_count(errors_hash)
+      errors_hash[:fields].map { |h| h[:count] }.reduce(:+) || 0
+    end
+
+    # Get the model class of the given resource
+    # Ex:
+    # $ resource_class('users')
+    # => User
+    def resource_class(resource)
+      resource.classify.constantize
+    rescue NameError
+      nil
+    end
+
+    def generate_errors_hash(resource, resource_class, fields, errors_hash)
+      # Create an instance of it and check if valid with the given attributes
+      fetch_object(fields, resource_class).tap(&:valid?).errors.messages.each do |field, errors|
+        next unless fields.keys.include?(field.to_s)
+        errors_hash[:fields] << {
+          name: "#{resource}/#{field}", errors: errors, count: errors.count
+        }
+      end
+    end
+
+    def fetch_object(fields, resource_class)
+      return resource_class.new(fields) if fields['id'].blank?
+      resource_class.find_by(id: fields['id']).tap { |r| r.attributes = fields }
+    end
+
+    def handle_development_errors(resource, klass, fields)
+      return not_defined_class_error(resource) if klass.nil?
+      return not_db_model_error(resource) unless klass.ancestors.include?(ApplicationRecord)
+      invalid_fields = fields.keys - klass.new.attributes.keys
+      return invalid_fields_error(invalid_fields) if invalid_fields.present?
+      return object_not_found_error(resource) if fields['id'] && !klass.find_by(id: fields['id'])
+      nil
+    end
+
+    def object_not_found_error(resource)
+      @status_code = 400
+      { code: 'RESOURCE NOT FOUND', message: "#{resource} not found on database" }
+    end
+
+    def not_defined_class_error(resource)
+      @status_code = 400
+      { code: 'INVALID RESOURCE', message: "#{resource} is not a valid resource" }
+    end
+
+    def form_errors_handler(resource)
+      @status_code = 400
+      { code: 'NOT A DB MODEL', message: "#{resource} is not a DB model" }
+    end
+
+    def invalid_fields_error(invalid_fields)
+      @status_code = 400
+      {
+        code: 'INVALID FIELDS',
+        message: "\"#{invalid_fields.join(', ')}\" aren't valid model fields"
+      }
+    end
+
+  end
+end

data/lib/validaform/engine.rb

@@ -0,0 +1,5 @@
+module Validaform
+  class Engine < ::Rails::Engine
+    isolate_namespace Validaform
+  end
+end

data/lib/validaform/version.rb

@@ -0,0 +1,3 @@
+module Validaform
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: validaform
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- poilon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+description: Mount to an endpoint of your application, give it forms fields, and it'll
+  return the validations errors/success in JSON. Really usefull when you want to add
+  on-unblur or before-submit validations.
+email:
+- poilon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/validaform/application_controller.rb
+- app/controllers/validaform/forms_controller.rb
+- config/routes.rb
+- lib/validaform.rb
+- lib/validaform/engine.rb
+- lib/validaform/version.rb
+homepage: https://github.com/Poilon/validaform
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Perform a validation for forms via API call
+test_files: []