rack-params 0.0.1.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a11363a7413ebf028fecf37c8844d0cabfc0db8f
+  data.tar.gz: d45b70dcb3c82d5fae18fcf03f616fea6b5b0ef2
+SHA512:
+  metadata.gz: ea3fa1d609f6e647aae42865ec31fdc6b0d5b4df22164980ef61884f634b205354d2d25c9462b3ebf58b59fab1100238e9f427043cfa531f6a5ca54bae46986c
+  data.tar.gz: 22c7fcef94aa754b701466388c178ac390f66b468287c96a064a17064745c1930bebe5203a25267485f53c72748b06393cc2af01769849d623b0dfc4d4f9b29b

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+spec/examples.txt
+/.byebug_history
+/Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rack-params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Jon Raphaelson
+
+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,135 @@
+# Rack::Params
+[![Build Status](https://travis-ci.org/lygaret/rack-params.svg?branch=master)](https://travis-ci.org/lygaret/rack-params)
+
+`Rack::Request.params` validation and type coercion, on Rack.
+
+```ruby
+# NOTE (to self) - if this changes, update `readme_spec.rb`
+
+class SomeExampleApp
+  include Rack::Params
+
+  # create named validators that can be run at any time
+  
+  validator :document do
+    param :id,      Integer,  required: true
+    param :title,   String,   required: true
+    param :created, DateTime
+    
+    param :tags, Array, sep: " " do
+      every Symbol
+    end
+    
+    param :content, Hash, required: true do
+      param :header, String
+      param :body,   String, required: true
+    end
+  end
+  
+  # run pre-defined or ad-hoc transforms on some hash
+  # only keys in the validator blocks are copied, see #splat
+
+  def call(env)
+    request = Rack::Request.new(env)
+    
+    params = request.params
+    params = validate(request.params, :document)
+    if params.valid?
+      assert params["id"].is_a? Integer
+      assert (not params["content"]["body"].nil?)
+    else
+      assert params.errors.length > 0
+      assert params.invalid?
+    end
+
+    # or
+    params = { "flag" => "f", "some" => "other key", "and" => "one more" }
+    params = validate(params) do
+      param :flag,  :boolean, required: true
+      splat :rest
+    end
+    
+    if params.valid?
+      assert [true, false].include?(params["flag"])
+      assert (["some", "and"] - params["rest"]).empty?
+    end
+
+  end
+end
+
+# if you're using a framework which provides `request` as a getter method
+# include the connector, which provides a `#params` override, and allows
+# defaulting to request.params in validate calls
+
+class FancyApp < Nancy::Base
+  include Rack::Params::Connect
+
+  validator :check do
+    :id, Integer
+  end
+  
+  get "/" do
+    validate :check
+
+    if params.valid?
+      assert params["id"].is_a? Integer
+    else
+      assert params.errors.length > 0
+      assert params.invalid?
+    end
+    
+    "magic 8-ball, how's my params? << uncertan. >>"
+  end
+
+  get "/blow-up-on-failure" do
+    validate! :check
+    assert params.valid?
+
+    "if I'm going down, I'm taking you all with me."
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rack-params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-params
+
+## Usage
+
+**[RDoc @ master - Rack::Params](http://www.rudydoc.info/github/lygaret/master)**
+
+1. Include `Rack::Params` to get the `.validator`, `#validate` and `#validate!` methods.
+2. Call `.validator(name, options = {}, &code)` to register a named validator for use later.
+3. Call `#validate(name = nil, params = request.params, options = {}, &code)` to build a new result, with the results of validation and coercion.
+4. The blocks passed to the validation methods run in the context of `HashContext` and `ArrayContext`, which is where the coercion methods are defined.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/lygaret/rack-params.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Authors
+
+* Jon Raphaelson - https://accidental.cc
+* Based heavily on [`mattt/sinatra-param`](https://github.com/mattt/sinatra-param), though diverging significantly in ways.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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/rack/params/context.rb

@@ -0,0 +1,159 @@
+require 'date'
+
+module Rack
+  module Params
+
+    class Context
+      attr_reader :options
+      attr_reader :params
+      attr_reader :result
+
+      def initialize(params, options = {})
+        @options = options
+        @path    = options[:path]
+
+        @params  = params
+
+        @result = self.class::Result.new
+        @result.extend ::Rack::Params::Result
+        @result.errors = Hash.new { |h, k| h[k] = [] }
+      end
+
+      def exec(&block)
+        instance_exec(&block)
+        @result
+      end
+
+      def _coerce(value, type, options)
+        return nil   if value.nil?
+        return value if value.is_a?(type) rescue false
+
+        return value.to_sym if type == :symbol || type == Symbol
+
+        return Integer(value, options[:base] || 0) if type == ::Integer
+        return Float(value)                        if type == ::Float
+
+        [::Date, ::Time, ::DateTime].each do |klass|
+          return klass.parse(value) if type == klass
+        end
+
+        if type == ::Array
+          sep    = options.fetch(:sep, ',')
+
+          values = value.split(sep)
+          return Array(values)
+        end
+
+        if type == ::Hash
+          esep   = options.fetch(:esep, ',')
+          fsep   = options.fetch(:fsep, ':')
+
+          values = value.split(esep).map { |p| p.split(fsep) }
+          return ::Hash[values]
+        end
+
+        if type == ::TrueClass || type == ::FalseClass || type == :boolean
+          return false if /^(false|f|no|n|0)$/i === value
+          return true  if /^(true|t|yes|y|1)$/i === value
+          raise ArgumentError # otherwise
+        end
+      rescue ArgumentError => ex
+        fail InvalidParameterError, ex.message
+      end
+
+      def _validate(name, value, validation, options)
+        options = {} if options == true
+
+        if validation == :oneOf
+          raise InvalidParameterError, "must be one of #{options}" unless options.include? value
+
+        elsif validation == :uri
+          uri     = URI.parse(value)
+          schemes = options.fetch(:schemes, %w(http https))
+          local   = options.fetch(:local, false)
+
+          unless uri && uri.host && schemes.include?(uri.scheme) && (local || uri.host.include?('.'))
+            raise InvalidParameterError, "must be a #{schemes.join(',')} URI"
+          end
+        end
+      end
+
+      def _recurse(name, type, value, &block)
+        path = [@path, name].reject(&:nil?).join(".")
+
+        if type == Array
+          ArrayContext.new(value, path: path).exec(&block)
+        elsif type == Hash
+          HashContext.new(value, path: path).exec(&block)
+        else
+          fail "can not recurse into #{type}"
+        end
+      end
+    end
+
+    # the DSL when validating a hash parameter (including the top-level params hash)
+
+    class HashContext < Context
+      Result = Hash
+
+      def param(name, type, options = {}, &block)
+        name = name.to_s
+
+        # default and required
+        value = params[name] || options[:default]
+        raise InvalidParameterError, "is required" if options[:required] && value.nil?
+
+        # type cast
+        value = _coerce(value, type, options)
+
+        # validate against rules
+        options.each { |v, vopts| _validate(name, value, v, vopts) }
+
+        # recurse if we've got a block
+        if block_given?
+          value = _recurse(name, type, value, &block)
+          result.errors.merge! value.errors
+        end
+
+        # return - we're good
+        result[name] = value
+      rescue InvalidParameterError => ex
+        path = [@path, name].reject(&:nil?).join(".")
+        result.errors[path] << ex.message
+      end
+
+      def splat(name, options = {}, &block)
+        name = name.to_s
+
+        # every key in params that's not already in results
+        value = params.reject { |k, _| result.keys.include? k }
+        result[name] = value
+      end
+    end
+
+    # the DSL when validating an array parameter
+    class ArrayContext < Context
+      Result = Array
+
+      # validate and coerce every element in the array to the type/options/block given
+      def every(type, options = {}, &block)
+        params.each_with_index do |value, i|
+          begin
+            value = _coerce(value, type, options)
+            options.each { |v, vopts| _validate(i.to_s, value, v, vopts) }
+            if block_given?
+              value = _recurse(i.to_s, type, value, &block)
+              result.errors.merge! value.errors
+            end
+
+            result[i] = value
+          rescue InvalidParameterError => ex
+            path = [@path, i].reject(&:nil?).join(".")
+            result.errors[path] << ex.message
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/rack/params/errors.rb

@@ -0,0 +1,18 @@
+module Rack
+  module Params
+
+    class ParameterValidationError < StandardError
+      attr_accessor :errors
+
+      def initialize(errors)
+        super("parameter validation failed, [#{errors.keys.join(', ')}] invalid.")
+        @errors = errors
+      end
+    end
+
+    class InvalidParameterError < StandardError
+      attr_accessor :name, :type, :options
+    end
+
+  end
+end

data/lib/rack/params/result.rb

@@ -0,0 +1,15 @@
+module Rack
+  module Params
+    module Result
+      attr_accessor :errors
+      
+      def valid?
+        errors.length == 0
+      end
+
+      def invalid?
+        not valid?
+      end
+    end
+  end
+end

data/lib/rack/params/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Params
+    VERSION = "0.0.1.pre1"
+  end
+end

data/lib/rack/params.rb

@@ -0,0 +1,65 @@
+require 'rack/params/context'
+require 'rack/params/errors'
+require 'rack/params/result'
+require 'rack/params/version'
+
+module Rack
+  module Params
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      Validator = Struct.new(:options, :code) do
+        def exec(values)
+          HashContext.new(values, options).exec(&code)
+        end
+      end
+
+      def validators
+        @_rp_validators ||= {}
+      end
+
+      def validator(name, options = {}, &code)
+        validators[name] = Validator.new(options, code)
+      end
+    end
+
+    # validate request.params
+    def validate(name = nil, params = nil, options = {}, &block)
+      if params.nil? && (name.class <= Hash)
+        params = name
+        name   = nil
+      end
+
+      fail ArgumentError, "no parameters provided!" if params.nil?
+      if name.nil?
+        fail ArgumentError, "no validation block was provided!" unless block_given?
+        HashContext.new(params, options).exec(&block)
+      else
+        fail ArgumentError, "no validation is registered under #{name}" unless self.class.validators.key? name
+        self.class.validators[name].exec(params)
+      end
+    end
+
+    def validate!(name = nil, params = nil, options = {}, &block)
+      validate(name, params, options, &block).tap do |res|
+        fail ParameterValidationError, res.errors if res.invalid?
+      end
+    end
+
+    # secondary mixin for frameworks that put `request` in the scope
+
+    module Connector
+      def self.included(base)
+        base.class_eval do
+          attr_reader :params
+        end
+      end
+
+      def validate(name = nil, params = nil, options = {}, &block)
+        super(name, params || request.params, options, &block)
+      end
+    end
+  end
+end

data/rack-params.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rack/params/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-params"
+  spec.version       = Rack::Params::VERSION
+  spec.authors       = ["Jon Raphaelson"]
+  spec.email         = ["jon@accidental.cc"]
+
+  spec.summary       = %q{Rack parameter validation and type coercion.}
+  spec.homepage      = "https://accidental.cc"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "byebug", "~> 9.0"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rack-params
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre1
+platform: ruby
+authors:
+- Jon Raphaelson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: 
+email:
+- jon@accidental.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rack/params.rb
+- lib/rack/params/context.rb
+- lib/rack/params/errors.rb
+- lib/rack/params/result.rb
+- lib/rack/params/version.rb
+- rack-params.gemspec
+homepage: https://accidental.cc
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Rack parameter validation and type coercion.
+test_files: []