api_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e001388521bb57ebafb2c6fd2f6d0d130af547b
+  data.tar.gz: 38696b838c273fc595523cd55ac31d7aec3e4029
+SHA512:
+  metadata.gz: 59ecdf26a07d570f15006def55a5e4357406ee9e24125f3bce24bbd4979f45000a9e4bb041f304b186abca434391ed44cd53cf6f44a5894ffac29e66da7f4b6d
+  data.tar.gz: 5b604d93767fc676ab63b52055af1d48fe73b3f8aeb478de5a7535ebb1d7aae6d5b0eac81e2430c7bdb99379609d6443096e43c36a4ac2571377ee6e1d42b171

data/.gitignore

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sandipkaranjekar@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sandip Karanjekar
+
+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,79 @@
+# api_validator
+This gem helpful to validate api calls. You need to set rules and messages in yml file and rest of the things are handle by gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_validator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_validator
+
+Also you need to run generator to set the files -
+
+		$ rails g api_validator:install api_validator
+
+Note : Here you can pass any name you want to set for initilizer file and validation yml file, instead of 'api_validator'.
+
+## Usage
+
+Before use of this gem you need to set ```ruby before_filter :request_validation ``` in controller where you want to validate request before reach to controller's method.
+
+Also you need to set rules in the api_validator.yml.erb file. Example are mentioned in yml file.
+
+Sample pattern for validation as follows - 
+
+```yaml
+controller_name:
+   method_name:
+     param1:
+       rules:
+         presence: true
+         integer: true
+         min_length: 5
+         max_length: 15
+         pattern: <%= /\A^[a-zA-Z\s'.-]*$\Z/.source %> 
+       messages:
+         presence: "Param1 must present."
+         integer: "Param1 must contain integer only."
+         min_length: "Param1 must have minimum length of 5."
+         max_length: "Param1 must have maximum length of 15."
+         pattern: "Invalid Param1"
+```
+
+Sample validation for JSON value in request parameter -
+
+```yaml
+ controller_name:
+   method_name:
+     param1:
+       rules:
+         presence: true
+         json_string: true
+       messages:
+         presence: "Param1 must present."
+         json_string: "Invalid json string."
+       paramters:
+         json_1st_param:
+           rules:
+             presence: true
+           messages:
+             presence: "Json first param must prresent."
+         json_2nd_param:
+           rules:
+             integer: true
+           messages:
+             integer: "Json second param must be integer only."
+```
+## 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,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/api_validator.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_validator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_validator"
+  spec.version       = ApiValidator::VERSION
+  spec.authors       = ["sandipkaranjekar"]
+  spec.email         = ["sandipkaranjekar@gmail.com"]
+
+  spec.summary       = %q{RubyGem for API validation}
+  spec.description   = %q{RubyGem for API validation. Here you need to set rules and messages in yml, rest of the things are handle by gem.}
+  spec.homepage      = "https://github.com/sandipkaranjekar/api_validator"
+  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_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_validator"
+
+# 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/setup

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

data/lib/api_validator.rb

@@ -0,0 +1,104 @@
+require "api_validator/version"
+
+module ApiValidator
+	INTEGER_REGEX = /^[1-9]([0-9]*)?$/
+  # request validation method
+  # Input - request params
+  # Process - Validate params with there rules & definition
+  # Output - report error on invalidity
+  def request_validation
+    if is_api_validator_applicable?(params[:controller], params[:action])
+      # validation - parameters defination
+      validation_pd = VALIDATION_CONFIG[params[:controller]][params[:action]]
+      
+      validation_pd.keys.each do |key|
+        next if params.has_key?(key) == false && validation_pd[key]["rules"].has_key?("presence") == false
+        validation_pd[key]["rules"].each do |rule, definition|
+          # when param's value is JSON string then parse it and validate parameters
+          if (rule == "json_string" and definition == true)
+            begin
+              json_data = JSON.parse(params[key])
+              json_data = [json_data] unless json_data.class == Array
+              json_data.each do |data|
+                data.keys.each do |json_data_key|
+                  if validation_pd[key].has_key?("parameters")
+                    next unless validation_pd[key]["parameters"].has_key?(json_data_key)
+                    validation_pd[key]["parameters"][json_data_key]["rules"].each do |json_data_rule, json_data_definition|
+                      #CAUTION: if nested JSON, this should be recursive
+                      return error_response(validation_pd[key]["parameters"][json_data_key]["messages"][json_data_rule]) if validate?(json_data_key, data[json_data_key], json_data_rule, json_data_definition, validation_pd[key]["parameters"][json_data_key])
+                    end
+                  end
+                end
+              end
+            rescue JSON::ParserError => e  
+              return error_response(validation_pd[key]["messages"][rule], 422)
+            end
+          # when param's value is NOT JSON
+          else
+            return error_response(validation_pd[key]["messages"][rule]) if validate?(key, params[key], rule, definition, validation_pd[key])
+          end
+        end # param rule loop end
+      end # params list loop end
+    end # main if end
+  end
+
+  def is_api_validator_applicable?(controller, action)
+  	VALIDATION_CONFIG[controller].present? && VALIDATION_CONFIG[controller][action].present?
+  end
+
+  def error_response(message = nil, status = 400)
+    response = {status: 'error', message: message}
+    render json: response, status: status
+  end
+
+  def is_integer?(value)
+    !!(value =~ INTEGER_REGEX)
+  end
+
+  def is_pattern_match?(value, pattern)
+    !!(value =~ pattern)
+  end
+
+  def validate_array_string?(value, separator)
+    parameter_ids = value.split(separator)
+    parameter_ids.each do |parameter|
+      return false unless !!(parameter =~ INTEGER_REGEX)
+    end
+    return true
+  end
+
+  def validate?(key, value, rule, definition, dtd)
+    is_error_found = false
+    case
+    when (rule == "ignore_if_present" and definition.present?)
+      # return error if not present & defination absence
+      is_error_found = true if value.present? == false and params[definition].present? == false
+    when (rule == "presence" and definition == true)
+      # return error if not present
+      is_error_found = true unless value.present?
+    when (rule == "array_string" and definition.present?)
+      # return error if array string invalid
+      is_error_found = true unless validate_array_string?(value, definition)
+    when (rule == "integer" and definition == true)
+      # return error if not match with integer
+      is_error_found = true unless is_integer?(value)
+    when (rule == "min_length" and definition > 0)
+      # return error if minimum length is not achived
+      is_error_found = true unless value.length >= definition
+    when (rule == "max_length" and definition > 0)
+      # return error if maximum length is not achived
+      is_error_found = true unless value.length <= definition
+    when (rule == "max_value" and definition > 0)
+      # return error if param's value is less or equal to definition
+      is_error_found = true unless value.to_f <= definition
+    when (rule == "pattern" and definition.present?)
+      # return error if pattern doesn't match
+      if dtd["rules"].has_key?("presence") == true || value.present?
+        is_error_found = true unless is_pattern_match?(value, Regexp.new(definition))
+      end
+    end
+    return is_error_found
+  end
+end
+# Require our engine
+require "api_validator/engine"

data/lib/api_validator/engine.rb

@@ -0,0 +1,4 @@
+module ApiValidator
+  class Engine < Rails::Engine
+  end
+end

data/lib/api_validator/version.rb

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

data/lib/generators/api_validator/install/install_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators'
+
+module ApiValidator
+  module Generators
+    class InstallGenerator < Rails::Generators::NamedBase
+    	def self.source_root
+        source_root ||= File.join(File.dirname(__FILE__), 'templates/')
+      end
+
+      def copy_initializer_file
+        create_file "config/initializers/#{file_name}.rb", <<-FILE
+        validation_template = ERB.new(File.new(File.expand_path('../../#{file_name}.yml.erb', __FILE__)).read)
+        VALIDATION_CONFIG = HashWithIndifferentAccess.new(YAML.load(validation_template.result(binding)))
+        FILE
+      end
+
+      def copy_validate_api_yml_file
+      	copy_file "validate_api.yml.erb", "config/#{file_name}.yml.erb"
+      end
+
+      def add_module
+        line = "class ApplicationController < ActionController::Base"
+        gsub_file 'app/controllers/application_controller.rb', /(#{Regexp.escape(line)})/mi do |match|
+          "#{match}\n include ApiValidator\n"
+        end 
+      end
+    end
+  end
+end

data/lib/generators/api_validator/install/templates/validate_api.yml.erb

@@ -0,0 +1,40 @@
+# This yml used to specify your rules ans messages of parameters
+# You need to follow following pattern to make it applicable
+# controller_name:
+#   method_name:
+#     param1:
+#       rules:
+#         presence: true
+#         integer: true
+#         min_length: 5
+#         max_length: 15
+#         pattern: <%#= "/\A^[a-zA-Z\s'.-]*$\Z/".source %> 
+#       messages:
+#         presence: "Param1 must present."
+#         integer: "Param1 must contain integer only."
+#         min_length: "Param1 must have minimum length of 5."
+#         max_length: "Param1 must have maximum length of 15."
+#         pattern: "Invalid Param1"
+#
+# Also if have some paramters which accepts json as value and that json have some 
+# which need to be validate you need to follow following pattern to make it applicable
+# controller_name:
+#   method_name:
+#     param1:
+#       rules:
+#         presence: true
+#         json_string: true
+#       messages:
+#         presence: "Param1 must present."
+#         json_string: "Invalid json string."
+#       paramters:
+#         json_1st_param:
+#           rules:
+#             presence: true
+#           messages:
+#             presence: "Json first param must prresent."
+#         json_2nd_param:
+#           rules:
+#             integer: true
+#           messages:
+#             integer: "Json second param must be integer only."

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: api_validator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sandipkaranjekar
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: RubyGem for API validation. Here you need to set rules and messages in
+  yml, rest of the things are handle by gem.
+email:
+- sandipkaranjekar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_validator.gemspec
+- bin/console
+- bin/setup
+- lib/api_validator.rb
+- lib/api_validator/engine.rb
+- lib/api_validator/version.rb
+- lib/generators/api_validator/install/install_generator.rb
+- lib/generators/api_validator/install/templates/validate_api.yml.erb
+homepage: https://github.com/sandipkaranjekar/api_validator
+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: RubyGem for API validation
+test_files: []