validate-params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 06ea6e17956a26da41257b6ba81a599764e66bc6ea328f25b6d5537a3cd268ff
+  data.tar.gz: f2df924be3a6215c5894766db060b78b0b46cc459fe6ff903274cf5887824927
+SHA512:
+  metadata.gz: 5669fd9d7b7407403c577162809fd6ffba54f2304d3b4902fa27d8ab33376da08b066b44db9c1139c53c25965372a7e3953928ed1457d237bec3a7a6e473a176
+  data.tar.gz: f76f246d4221734df076e605afb3914c6a6e0f497a1c1f3b1f036e6c7c25c6401ecf26678f472050479ca510d06c3f7019ebbd96b461ba16fbff35b20ba23d88

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-10
+
+- Initial release

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in validate_params.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    validate_params (0.1.0)
+      activesupport (~> 7.0.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    loofah (2.20.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    minitest (5.18.0)
+    nokogiri (1.14.3-arm64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+  arm64-darwin-21
+  arm64-darwin-22
+
+DEPENDENCIES
+  actionpack (~> 7.0.4)
+  bundler (~> 2.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  validate_params!
+
+BUNDLED WITH
+   2.3.22

data/README.md

@@ -0,0 +1,46 @@
+# ValidateParams
+
+[![Rspec](https://github.com/peopleforce/validate_params/actions/workflows/rspec.yml/badge.svg)](https://github.com/peopleforce/validate_params/actions/workflows/rspec.yml)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/validate_params`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add validate_params
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install validate_params
+
+## Usage
+
+```ruby
+class TestController < ActionController::Base
+  include ValidateParams::ParamsValidator
+
+  validate_params :index do |p|
+    p.param :id_param, Integer
+    p.param :date_param, Date
+    p.param :datetime_param, DateTime
+  end
+
+  def index
+    ...
+  end
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/validate_params.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/validate_params/params_validator.rb

@@ -0,0 +1,130 @@
+require "active_support/concern"
+
+module ValidateParams
+  module ParamsValidator
+    extend ::ActiveSupport::Concern
+
+    included do
+      before_action :set_params_defaults
+      before_action :perform_validate_params
+    end
+
+    class_methods do
+      attr_accessor :params_validations, :method
+
+      def param(field, type, required = false, default: nil)
+        @params_validations ||= []
+        @params_validations << { field: field, type: type, required: required, default: default }
+      end
+
+      def validate_params(request_action, &block)
+        @request_action = request_action
+
+        yield(self) if block
+      end
+    end
+
+    def params_validations
+      self.class.instance_variable_get(:@params_validations) || []
+    end
+
+    def request_action
+      self.class.instance_variable_get(:@request_action) || nil
+    end
+
+    private
+
+    def build_error_message(field, field_type, field_value)
+      I18n.t("api.public.invalid_parameter", field: field, field_type: field_type, field_value: field_value)
+    end
+
+    def error_param_name(field)
+      case field
+      when Array
+        "#{field[0]}[#{field[1]}]"
+      when Hash
+        field.map { |k, v| "#{k}[#{v}]" }.first
+      else
+        field
+      end
+    end
+
+    def set_params_defaults
+      params_validations.each do |params_validation|
+        next if params_validation[:default].blank?
+
+        params[params_validation[:field]] ||= params_validation[:default]
+      end
+    end
+
+    def perform_validate_params
+      return unless request_action.present? && request_action == action_name.to_sym
+
+      errors = []
+
+      for params_validation in params_validations
+        parameter_value = if params_validation[:field].is_a? Hash
+                            request.params.dig(params_validation[:field].keys.first,
+                                               params_validation[:field][params_validation[:field].keys.first])
+                          else
+                            request.params[params_validation[:field]]
+                          end
+
+        next if parameter_value.blank? && !params_validation[:required]
+
+        case params_validation[:type].to_s
+        when "Date"
+          if invalid_date?(parameter_value)
+            errors << build_error_message(
+              error_param_name(params_validation[:field]),
+              params_validation[:type],
+              parameter_value
+            )
+          end
+        when "DateTime"
+          if invalid_datetime?(parameter_value)
+            errors << build_error_message(
+              error_param_name(params_validation[:field]),
+              params_validation[:type],
+              parameter_value
+            )
+          end
+        when "Integer"
+          if invalid_integer?(parameter_value)
+            errors << build_error_message(
+              error_param_name(params_validation[:field]),
+              params_validation[:type],
+              parameter_value
+            )
+          end
+        end
+      end
+
+      return if errors.empty?
+
+      render json: { success: false, errors: errors }, status: :unprocessable_entity
+    end
+
+    def invalid_date?(value)
+      return true unless /\d{4}-\d{2}-\d{2}/.match?(value)
+
+      parsed_date = begin
+        Date.strptime(value, "%Y-%m-%d")
+      rescue StandardError
+        nil
+      end
+      parsed_date.blank? || parsed_date.year > 9999
+    end
+
+    def invalid_datetime?(value)
+      Time.at(Integer(value))
+      false
+    rescue ArgumentError, TypeError
+      true
+    end
+
+    def invalid_integer?(value)
+      value !~ /\A[-+]?[0-9]+\z/
+    end
+  end
+end

data/lib/validate_params/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ValidateParams
+  VERSION = "0.1.0"
+end

data/lib/validate_params.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "validate_params/version"
+require_relative "validate_params/params_validator"
+
+module ValidateParams
+  class Error < StandardError; end
+end

data/sig/validate_params.rbs

@@ -0,0 +1,4 @@
+module ValidateParams
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/validate_params.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/validate_params/version"
+
+Gem::Specification.new do |spec|
+  spec.license = "MIT"
+  spec.name = "validate-params"
+  spec.version = ValidateParams::VERSION
+  spec.authors = ["dcherevatenko"]
+  spec.email = ["denis.cherevatenko@peopleforce.io "]
+
+  spec.summary = "Gem to validate params in controllers"
+  spec.description = "Provides a clean DSL to validate params for controller actions."
+  spec.required_ruby_version = ">= 2.7.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "actionpack", "~> 7.0.4"
+
+  spec.add_dependency "activesupport", "~> 7.0.4"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: validate-params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dcherevatenko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+description: Provides a clean DSL to validate params for controller actions.
+email:
+- 'denis.cherevatenko@peopleforce.io '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/validate_params.rb
+- lib/validate_params/params_validator.rb
+- lib/validate_params/version.rb
+- sig/validate_params.rbs
+- validate_params.gemspec
+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: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Gem to validate params in controllers
+test_files: []