sinatra_param_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5e455bde98aa7a56ad0635e5873ed0aca07557dd
+  data.tar.gz: 92336035331401f8057986c48dc73c6846b44c6e
+SHA512:
+  metadata.gz: f5d20f412ce93c00f7f290e26dce783b479ca423a4d84d59462cebbb6594ce4829991dd2686ee973cdd58213f3e395f22c0032f8d3358def598d17755f4e6257
+  data.tar.gz: 6bfd2646ebbb68ab6e70c3b9aa3967bef507201235ac982bbc1041693a69932bf5f08187ee0abebe4b685a0c1e12996d40b5b7a5f74a1ceb4bcb4a4115a1aa1d

data/.gitignore

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

data/.travis.yml

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

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 caojiafeng@sensetime.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 sinatra_param_checker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cao Jiafeng
+
+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,86 @@
+# Sinatra::ParamChecker
+
+Sinatra::ParamChecker is an extension of Sinatra.
+The extension add a before filter for your api to do the param
+validation.
+It supports many kinds of type checking, like Integer's range,
+String's regexp, and delimiter of Array, Hash.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra_param_checker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra_param_checker
+
+## Usage
+
+``` ruby
+require 'sinatra/base'
+class Example < Sinatra::Base
+  register Sinatra::ParamChecker
+
+  api = '/example'
+  params api, methods: [:post] do
+    required :name, type: String
+    optional :gender, type: Boolean, default: false
+  end
+  post api do
+    name = params[:name]
+    gender = params[:gender]
+    # Do your logic
+    'OK'
+  end
+end
+```
+
+## Supported Options
+
+``` ruby
+OPTIONS = [:type, :default, :values, :min, :max, :range, :regexp, :delimiter, :separator]
+```
+
+- every param validation should contain a `:type` option.
+- `:default` option can only be used with `optional`.
+- `:values` cannot be used with `[Array, Hash, File]`.
+- `:min, :max` can only be used with `[Integer, Float]`.
+- `:range` can only be used with `Integer`.
+- `:regexp` can only be used with `String`.
+- `:delimiter` can only be used with `[Array, Hash]`.
+- `:separator` can only be used with `Hash`.
+
+Supported Types:
+
+- TrueClass, FalseClass, ParamChecker::Boolean
+- Integer, Float
+- String ,ParamChecker::UUID(32)
+- Date, Time, DateTime
+- File
+- Array, Hash
+
+If you has more demands, ping me by issues or pull requests!
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lerencao/sinatra_param_checker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,10 @@
+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
+
+task :default => :test

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sinatra/param_checker"
+
+# 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.
+
+require "pry"
+Pry.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/examples/book_app.rb

@@ -0,0 +1,22 @@
+require 'json'
+require 'sinatra/base'
+require 'sinatra/param_checker'
+
+class BookApp < Sinatra::Base
+  register Sinatra::ParamChecker
+
+  params '/books', methods: [:post] do
+    required 'name', type: String
+    optional 'author', type: String, default: 'unknown'
+    required 'publish_date', type: Date
+  end
+  post '/books' do
+    {
+      name: params[:name],
+      author: params[:author],
+      publish_date: params[:publish_date]
+    }.to_json
+  end
+
+  run!
+end

data/lib/sinatra/param_checker.rb

@@ -0,0 +1,242 @@
+require 'sinatra/base'
+
+module Sinatra
+  module ParamChecker
+    Boolean = Class.new
+    UUID = Class.new
+    class InvalidParameterError < StandardError
+      attr_accessor :param, :options
+    end
+    class ParamScope
+      attr_reader :params
+      def initialize
+        @params = []
+      end
+
+      def required(name, options = {})
+        param = [:required, name.to_s, options]
+        validate_opts! param
+        @params << param
+      end
+
+      def optional(name, options = {})
+        param = [:optional, name.to_s, options]
+        validate_opts! param
+        @params << param
+      end
+
+      def validate!(params)
+        validated_params = @params.reduce({}) do |memo, e|
+          type, name, opts = e
+          begin
+            # handle default
+            v = if params[name].nil?
+              case type
+              when :optional
+                (opts[:default].call if opts[:default].respond_to?(:call)) || opts[:default]
+              when :required
+                raise InvalidParameterError, "param #{name} not found"
+              end
+            else
+              params[name]
+            end
+
+            unless v.nil?
+              coerced_value = coerce(v, opts[:type], opts)
+              validate(coerced_value, opts)
+              memo[name] = coerced_value
+            end
+            memo
+          rescue InvalidParameterError => e
+            e.param, e.options = name, opts
+            raise e
+          end
+        end
+
+        validated_params.reduce(params) do |memo, pair|
+          k, v = pair
+          memo[k] = v
+          memo
+        end
+      end
+
+      private
+
+      def coerce(value, type, options = {})
+        return value if value.is_a?(type)
+        case type.name.split('::').last.to_sym
+        when :Integer
+          Integer(value)
+        when :Float
+          Float(value)
+        when :String
+          String(value)
+        when :UUID
+          String(value)
+        when :File
+          if value.is_a?(Hash) && value[:tempfile].is_a?(::Tempfile)
+            value
+          else
+            raise "cannot coerce value to #{type}"
+          end
+        when :Date
+          Date.parse(value)
+        when :Time
+          Time.parse(value)
+        when :DateTime
+          DateTime.parse(value)
+        when :Array
+          delimiter = options[:delimiter] || ','
+          Array(value.split(delimiter))
+        when :Hash
+          delimiter = options[:delimiter] || ','
+          separator = options[:separator] || ':'
+          value.split(delimiter).map do |c|
+            c.split(separator, 2)
+          end.to_h
+        when :TrueClass, :FalseClass, :Boolean
+          if /(false|f|no|n|0)$/i === value.to_s
+            false
+          elsif /(true|t|yes|y|1)$/i === value.to_s
+            true
+          else
+            raise "cannot coerce value to Boolean"
+          end
+        else
+          raise "cannot coerce value to #{type}"
+        end
+      rescue => _e
+        raise InvalidParameterError, "#{type} expected"
+      end
+
+
+      def validate(v, opts)
+        case opts[:type].name.split('::').last.to_sym
+        when :String
+          if opts[:regexp] && !(v =~ opts[:regexp])
+            raise InvalidParameterError, 'wrong format'
+          end
+        when :UUID
+          unless v =~ /\A[a-f0-9]{32}\z/
+            raise InvalidParameterError, 'uuid expected'
+          end
+        when :Integer, :Float
+          if opts[:type] == Integer && opts[:range] && !opts[:range].include?(v)
+            raise InvalidParameterError, "not in range(#{opts[:range]})"
+          end
+          if opts[:max] && v > opts[:max]
+            raise InvalidParameterError, "greater than #{opts[:max]}"
+          end
+          if opts[:min] && v < opts[:min]
+            raise InvalidParameterError, "smaller than #{opts[:min]}"
+          end
+        when :File
+          tf = v[:tempfile] rescue nil
+          raise InvalidParameterError, 'File expected' unless Tempfile === tf
+        end
+
+        unless [Hash, Array, File].include?(opts[:type])
+          if opts[:values] && !opts[:values].include?(v)
+            raise InvalidParameterError, 'invalid enumeration member'
+          end
+        end
+      end
+
+      def syntax_err(msg)
+        fail SyntaxError, "ParamChecker: #{msg}"
+      end
+
+      def check_type(type, value)
+        return value.is_a?(String) if type == UUID
+        return [true, false].include?(value) if [TrueClass, FalseClass, Boolean].include?(type)
+        return true if (value.is_a?(type) rescue false)
+        false
+      end
+
+      OPTIONS = [:type, :default, :values, :min, :max, :range, :regexp, :delimiter, :separator]
+      def validate_opts!(param)
+        type, name, opts = param
+
+        syntax_err "#{name}: missing option :type" unless opts[:type]
+        unless opts[:type].is_a?(Class)
+          syntax_err "#{name}: :type value should be class"
+        end
+
+        prefix = "#{name}(#{opts[:type]})"
+        opts.each do |k, v|
+          syntax_err "#{prefix}: unsupported option :#{k}" unless OPTIONS.include?(k)
+          case k
+          when :default
+            if type == :required
+              syntax_err "#{prefix}: :default can be used only with :optional params"
+            end
+            if [File, Array, Hash].include?(opts[:type])
+              syntax_err "#{prefix}: :default cannot be used with :type File, Array or Hash"
+            end
+
+            unless check_type(opts[:type], v)
+              syntax_err "#{prefix}: :default must be #{opts[:type]}"
+            end
+          when :values
+            if [File, Array, Hash].include?(opts[:type])
+              syntax_err "#{prefix}: :values cannot be used with :type File, Array or Hash"
+            end
+            unless Array === v && v.size > 0
+              syntax_err "#{prefix}: :values must be Array(size > 0)"
+            end
+            v.each do |val|
+               unless check_type(opts[:type], val)
+                 syntax_err "#{prefix}: values in :values must be #{opts[:type]}"
+               end
+            end
+          when :min, :max
+             unless [Integer, Float].include?(opts[:type])
+               syntax_err "#{prefix}: :#{k} can be used only with :type Integer and Float"
+             end
+             unless check_type(opts[:type], v)
+               syntax_err "#{prefix}: :#{k} must be #{opts[:type]}"
+             end
+          when :range
+            unless opts[:type] == Integer
+              syntax_err "#{prefix}: :range can be used only with :type Integer"
+            end
+            unless Range === v && Integer === v.begin
+              syntax_err "#{prefix}: :range must be Range of Integer"
+            end
+          when :regexp
+            unless opts[:type] == String
+              syntax_err "#{prefix}: :regexp can be used only with :type String"
+            end
+            unless Regexp === v
+              syntax_err "#{prefix}: :regexp must be Regexp"
+            end
+          when :delimiter
+            unless [Array, Hash].include?(opts[:type])
+              syntax_err "#{prefix}: :delimiter can be used only with :type Array and Hash"
+            end
+          when :separator
+            unless opts[:type] == Hash
+              syntax_err "#{prefix}: :separator can be used only with :type Hash"
+            end
+          end
+        end
+      end
+    end
+
+    def params(path = nil, options = {}, &block)
+      ps = ParamScope.new
+      ps.instance_eval(&block)
+      methods = options.delete(:methods)
+      if methods.nil?
+        methods = [:post]
+      end
+      before path, options do
+        if methods.include?(self.request.request_method.downcase.to_sym)
+          ps.validate!(self.params)
+        end
+      end
+    end
+  end
+
+  register ParamChecker
+end

data/lib/sinatra/param_checker/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module ParamChecker
+    VERSION = "0.1.0".freeze
+  end
+end

data/sinatra_param_checker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/param_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra_param_checker"
+  spec.version       = Sinatra::ParamChecker::VERSION
+  spec.authors       = ["Cao Jiafeng"]
+  spec.email         = ["funfriendcjf@gmail.com"]
+
+  spec.summary       = %q{Param checker extension of sinatra framework}
+  spec.description   = %q{Param checker adds a before filter for each api to do the validation}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'sinatra', '>= 1.4.7'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'pry', '>= 0.10'
+  spec.add_development_dependency 'thin', '>= 1.7.0'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: sinatra_param_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cao Jiafeng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.7
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: Param checker adds a before filter for each api to do the validation
+email:
+- funfriendcjf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/book_app.rb
+- lib/sinatra/param_checker.rb
+- lib/sinatra/param_checker/version.rb
+- sinatra_param_checker.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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Param checker extension of sinatra framework
+test_files: []
+has_rdoc: