sealink-param-validation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e5cff0982bbc8a5852373b1ee1f107a75622da013973e92015ebd911217240c
+  data.tar.gz: af56f88956411b92e1e30381c7cf3df60472feb1aa9f790f612c679987b9c9e8
+SHA512:
+  metadata.gz: fc3f83d5da4ba310fe3ec86b8aee1688ac23d7737cda3321da5a2d3629c37a00921d7a4cb687c3d80db9cf41d8683a8bcf6bbb2ef232c6bf1098b80f782094f7
+  data.tar.gz: ed7ceff1bec538adbbf395ba916bff8970a9c62ef913b06466973ff1caa4395e12b0e11a01f53788c71d6e732797011bd5b97427778bc88174a24c1f3e1014fa

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+coverage
+Gemfile.lock
+tmp

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.6
+  - ruby-head
+script: bundle exec rspec
+gemfile:
+  - gemfiles/rails5.gemfile
+  - gemfiles/rails6.gemfile
+notifications:
+  email:
+    - support@travellink.com.au
+sudo: false
+cache: bundler

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Sealink Param Validation
+
+## 0.1.0
+
+* [TT-6430] Extract our param validation from QuickTravel

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,17 @@
+# Sealink Param Validation
+
+This is our gem for validation our params with schemas.
+
+## Development Environment
+
+### Prerequisites
+
+1. Ruby
+
+### General Steps
+
+1. bundle install
+
+### Testing
+
+1. bundle exec rspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/secrets.yml

@@ -0,0 +1,2 @@
+test:
+  secret_key_base: AeQu8kaeshohyedaequei6onei9loh3z

data/gemfiles/rails5.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+gemspec path: '../'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'simplecov'
+  gem 'simplecov-rcov'
+  gem 'rails', '~> 5.0'
+end

data/gemfiles/rails6.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+gemspec path: '../'
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'rspec-rails'
+  gem 'simplecov'
+  gem 'simplecov-rcov'
+  gem 'rails', '~> 6.0'
+end

data/lib/sealink-param-validation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'sealink_param_validation/version'
+require 'sealink_param_validation/error'
+require 'sealink_param_validation/helper'
+require 'sealink_param_validation/concern'
+
+module SealinkParamValidation
+end

data/lib/sealink_param_validation/concern.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module SealinkParamValidation
+  module Concern
+    extend ActiveSupport::Concern
+
+    included do
+      # Accessor for validation results hash
+      attr_reader :validation_result
+      class_attribute :schemas
+      self.schemas = {}
+
+      def self.schema_for(action, schema = nil)
+        schemas[action.to_sym] = schema if schema
+        before_action :ensure_schema
+      end
+    end
+
+    private
+
+    def ensure_schema!
+      @validation_result = schema_for_action.call(params.to_unsafe_h)
+      return if @validation_result.success?
+      error = SealinkParamValidation::Helper.generate_humanized_error_message(@validation_result)
+      fail SealinkParamValidation::InvalidInputError, error
+    end
+
+    def ensure_schema
+      schema = schema_for_action
+      return unless schema.present?
+      @validation_result = schema.call(params.to_unsafe_h)
+      return if @validation_result.success?
+      render json: {error: SealinkParamValidation::Helper.generate_error_message(@validation_result)}, status: 422
+    end
+
+    def action
+      params['action'].to_sym
+    end
+
+    def schema_for_action
+      self.class.schemas[action]
+    end
+  end
+end

data/lib/sealink_param_validation/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module SealinkParamValidation
+  class InvalidInputError < StandardError
+  end
+end

data/lib/sealink_param_validation/helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SealinkParamValidation
+  class Helper
+    def self.generate_error_message(result)
+      result.errors(full: true).to_h.values.map { |v|
+        v.is_a?(Hash) ? v.values : v
+      }.flatten.join(', ')
+    end
+
+    def self.generate_humanized_error_message(result)
+      build_humanized_errors(result.errors.to_h).to_sentence
+    end
+
+    def self.build_humanized_errors(errors, parent = nil)
+      errors.to_h.flat_map { |field, messages|
+        if messages.is_a?(Hash)
+          build_humanized_errors(messages, field)
+        else
+          generate_humanized_error(parent, field, messages)
+        end
+      }
+    end
+    private_class_method :build_humanized_errors
+
+    def self.generate_humanized_error(parent, field, messages)
+      return "#{parent.to_s.humanize}.#{field.to_s.humanize} #{messages.join}" if parent.present?
+      "#{field.to_s.humanize} #{messages.join}"
+    end
+    private_class_method :generate_humanized_error
+  end
+end

data/lib/sealink_param_validation/version.rb

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

data/sealink_param_validation.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sealink_param_validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sealink-param-validation'
+  spec.version       = SealinkParamValidation::VERSION
+  spec.authors       = ['Sean Earle']
+  spec.email         = 'development@travellink.com.au'
+  spec.description   = 'Simple validation of params with a concern'
+  spec.summary       = 'This is some logic we want to use across many projects so we have extracted it into a gem.'
+  spec.homepage      = 'http://github.com/sealink/sealink-param-validation'
+
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rails'
+  spec.add_dependency 'dry-schema', '>= 1.0.0'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'coverage-kit'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'travis'
+end

data/spec/helper_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SealinkParamValidation::Helper do
+  context '.generate_error_message' do
+    let(:errors) { schema.call(params) }
+    subject { SealinkParamValidation::Helper.generate_error_message(errors) }
+
+    context 'flat schema' do
+      let(:schema) {
+        Dry::Schema.Params {
+          required(:id).filled(:integer)
+          required(:name).filled(:string)
+        }
+      }
+      let(:params) { {} }
+      it { is_expected.to eq 'id is missing, name is missing' }
+    end
+
+    context 'nested schema' do
+      let(:schema) {
+        Dry::Schema.Params {
+          required(:id).filled(:integer)
+          required(:type).hash {
+            required(:id).filled(:integer)
+          }
+        }
+      }
+      let(:params) { { type: {} } }
+      it { is_expected.to eq 'id is missing, id is missing' }
+    end
+
+    context 'arrays' do
+      let(:schema) {
+        Dry::Schema.Params {
+          required(:ids).array(:integer)
+        }
+      }
+      let(:params) { { ids: [ 1, 'a', 'b' ] } }
+      it { is_expected.to eq '1 must be an integer, 2 must be an integer' }
+    end
+  end
+
+  context '.generate_humanized_error_message' do
+    let(:errors) { schema.call(params) }
+    subject { SealinkParamValidation::Helper.generate_humanized_error_message(errors) }
+
+    context 'flat schema' do
+      let(:schema) {
+        Dry::Schema.Params {
+          required(:id).filled(:integer)
+          required(:name).filled(:string)
+        }
+      }
+      let(:params) { {} }
+      it { is_expected.to eq 'Id is missing and Name is missing' }
+    end
+
+    context 'nested schema' do
+      let(:schema) {
+        Dry::Schema.Params {
+          required(:id).filled(:integer)
+          required(:type).hash {
+            required(:id).filled(:integer)
+          }
+        }
+      }
+      let(:params) { { type: {} } }
+      it { is_expected.to eq 'Id is missing and Type.Id is missing' }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+require 'rails'
+require 'action_controller/railtie'
+require 'dry-schema'
+require 'rspec/rails'
+require 'sealink-param-validation'
+
+module SealinkParamValidation
+  class Application < Rails::Application
+  end
+end
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.raise_errors_for_deprecations!
+
+  config.order = :random unless ENV.key? 'NO_RANDOM_ORDER'
+
+  config.before :suite do
+    srand RSpec.configuration.seed
+  end
+end

data/spec/validation_spec.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe 'SealinkParamValidation::Concern', type: :controller do
+  before(:all) do
+    class DummyController < ActionController::Base
+      include SealinkParamValidation::Concern
+
+      schema_for :index, Dry::Schema.Params { required(:data).value(eql?: 'text') }
+      def index
+        head :ok
+      end
+
+      def show
+        head :ok
+      end
+
+      schema_for :new, Dry::Schema.Params { required(:key).value(eql?: 'text') }
+      def new
+        head :ok
+      end
+    end
+
+    Rails.application.routes.draw do
+      get 'index' => 'dummy#index'
+      get 'show' => 'dummy#show'
+      get 'new' => 'dummy#new'
+    end
+
+    @controller = DummyController.new
+  end
+
+  describe 'validation' do
+    context 'successful validation' do
+      let(:params) { { 'data' => 'text' } }
+      before { get :index, params: params }
+      it { expect(response.status).to eq 200 }
+    end
+
+    context 'successful validation on second schema' do
+      let(:params) { { 'key' => 'text' } }
+      before { get :new, params: params }
+      it { expect(response.status).to eq 200 }
+    end
+
+    context 'unprotected route' do
+      let(:params) { { 'data1' => 'text' } }
+      before { get :show, params: params }
+      it { expect(response.status).to eq 200 }
+    end
+
+    context 'failed validation' do
+      let(:params) { { 'data1' => 'text1' } }
+      before { get :index, params: params }
+
+      it 'should return a 422' do
+        expect(response.status).to eq 422
+      end
+
+      it 'should return a json body with error' do
+        expect(JSON.parse(response.body)['error']).to eq 'data is missing'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: sealink-param-validation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Earle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: coverage-kit
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  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'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+- !ruby/object:Gem::Dependency
+  name: travis
+  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: Simple validation of params with a concern
+email: development@travellink.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- config/secrets.yml
+- gemfiles/rails5.gemfile
+- gemfiles/rails6.gemfile
+- lib/sealink-param-validation.rb
+- lib/sealink_param_validation/concern.rb
+- lib/sealink_param_validation/error.rb
+- lib/sealink_param_validation/helper.rb
+- lib/sealink_param_validation/version.rb
+- sealink_param_validation.gemspec
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb
+homepage: http://github.com/sealink/sealink-param-validation
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: This is some logic we want to use across many projects so we have extracted
+  it into a gem.
+test_files:
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+- spec/validation_spec.rb